import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

This section details the present commands, command flags in Lyfebloc Network, and how they're used.

Startup Commands ​

server flags ​

seal

Sets the flag indicating that the client should seal blocks. Default: true.

data-dir

Used to specify the data directory used for storing Lyfebloc Network client data. Default: ./test-chain.

jsonrpc

Sets the address and port for the JSON-RPC service address:port.
If only port is defined :10001 it will bind to all interfaces 0.0.0.0:10001.
If omitted the service will bind to the default address:port.
Default address: 0.0.0.0:8545.

grpc

Sets the address and port for the gRPC service address:port. Default address: 127.0.0.1:9632.

libp2p

Sets the address and port for the libp2p service address:port. Default address: 127.0.0.1:1478.

prometheus

Sets the address and port for the prometheus server address:port.
If only port is defined :5001 the service will bind to all interfaces 0.0.0.0:5001.
If omitted the service will not be started.

block-gas-target

Sets the target block gas limit for the chain. Default (not enforced): 0.

A more detailed explanation on the block gas target can be found in the TxPool section.

max-peers

Sets the client's maximum peer count. Default: 40.

Peer limit should be specified either by using max-peers or max-inbound/outbound-peers flag.

max-inbound-peers

Sets the client's maximum inbound peer count. If max-peers is set, max-inbound-peer limit is calculated using the following formulae.

max-inbound-peer = InboundRatio * max-peers, where InboundRatio is 0.8.

max-outbound-peers

Sets the client's maximum outbound peer count. If max-peers is set, max-outbound-peer count is calculated using the following formulae.

max-outbound-peer = OutboundRatio * max-peers, where OutboundRatio is 0.2.

log-level

Sets the log level for console output. Default: INFO.

log-to

Defines log file name that will hold all log output from the server command. By default, all server logs will be outputted to console (stdout), but if the flag is set, there will be no output to the console when running server command.

chain

Specifies the genesis file used for starting the chain. Default: ./genesis.json.

join

Specifies the address of the peer that should be joined.

nat

Sets the external IP address without the port, as it can be seen by peers.

dns

Sets the host DNS address. This can be used to advertise an external DNS. Supports dns,dns4,dns6.

price-limit

Sets minimum gas price limit to enforce for acceptance into the pool. Default: 1.

max-slots

Sets maximum slots in the pool. Default: 4096.

config

Specifies the path to the CLI config. Supports .json.

secrets-config

Sets the path to the SecretsManager config file. Used for Hashicorp Vault, AWS SSM and GCP Secrets Manager. If omitted, the local FS secrets manager is used.

dev

Sets the client to dev mode. Default: false.

dev-interval

Sets the client's dev notification interval in seconds. Default: 0.

no-discover

Prevents the client from discovering other peers. Default: false.

restore

Restore blocks from the specified archive file

block-time

Sets block production time in seconds. Default: 2

ibft-base-timeout

Sets the base value of timeout on IBFT consensus.
IBFT consensus timeout is calculated by BaseTimeout + 2^(round), or BaseTimeout * 30 where round exceeds 8.
It needs to be larger than block time and BlockTime * 5 is set if it's not specified.

access-control-allow-origins

Sets the authorized domains to be able to share responses from JSON-RPC requests.
Add multiple flags --access-control-allow-origins "https://example1.com" --access-control-allow-origins "https://example2.com" to authorize multiple domains.
If omitted Access-Control-Allow-Origins header will be set to * and all domains will be authorized.

genesis flags ​

dir

Sets the directory for Lyfebloc Network genesis data. Default: ./genesis.json.

name

Sets the name for the chain. Default: polyton-edge.

pos

Sets the flag indicating that the client should use Proof of Stake IBFT. Defaults to Proof of Authority if flag is not provided or false.

epoch-size

Sets the epoch size for the chain. Default 100000.

premine

Sets the premined accounts and balances in the format address:amount. The amount can be in either decimal or hex. Default premined balance: 0x3635C9ADC5DEA00000.

chainid

Sets the ID of the chain. Default: 100.

ibft-validators-prefix-path

Prefix path for validator folder directory. Needs to be present if the flag ibft-validator is omitted.

ibft-validator

Sets passed in addresses as IBFT validators. Needs to be present if the flag ibft-validators-prefix-path is omitted.

block-gas-limit

Refers to the maximum amount of gas used by all operations in a block. Default: 5242880.

consensus

Sets consensus protocol. Default: pow.

bootnode

Multiaddr URL for p2p discovery bootstrap. This flag can be used multiple times. Instead of an IP address, the DNS address of the bootnode can be provided.

max-validator-count

The maximum number of stakers able to join the validator set in a PoS consensus. This number cannot exceed the value of MAX_SAFE_INTEGER (2^53 - 2).

min-validator-count

The minimum number of stakers needed to join the validator set in a PoS consensus. This number cannot exceed the value of max-validator-count. Defaults to 1.

Operator Commands ​

Peer Commands ​

peers add flags

addr

Peer's libp2p address in the multiaddr format.

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

peers list flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

peers status flags

peer-id

Libp2p node ID of a specific peer within p2p network.

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

IBFT Commands ​

ibft snapshot flags

number

The block height (number) for the snapshot.

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

ibft candidates flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

ibft propose flags

vote

Proposes a change to the validator set. Possible values: [auth, drop].

addr

Address of the account to be voted for.

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

ibft status flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

ibft switch flags

chain

Specifies the genesis file to update. Default: test.

type

Specifies the IBFT type to switch. Possible values: [PoA, PoS].

deployment

Specifies the height of contract deployment. Only available with PoS.

from

max-validator-count

The maximum number of stakers able to join the validator set in a PoS consensus. This number cannot exceed the value of MAX_SAFE_INTEGER (2^53 - 2).

min-validator-count

The minimum number of stakers needed to join the validator set in a PoS consensus. This number cannot exceed the value of max-validator-count. Defaults to 1.

Specifies the beginning height of the fork.

Transaction Pool Commands ​

txpool status flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

txpool subscribe flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

promoted

Subscribes for promoted tx events in the TxPool.

dropped

Subscribes for dropped tx events in the TxPool.

demoted

Subscribes for demoted tx events in the TxPool.

added

Subscribes for added tx events to the TxPool.

enqueued

Subscribes for enqueued tx events in the account queues.

Blockchain commands ​

status flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

monitor flags

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

Secrets Commands ​

secrets init flags ​

config

Sets the path to the SecretsManager config file. Used for Hashicorp Vault. If omitted, the local FS secrets manager is used.

data-dir

Sets the directory for Lyfebloc Network data if the local FS is used.

secrets generate flags ​

dir

Sets the directory for the secrets manager configuration file Default: ./secretsManagerConfig.json

type

Specifies the type of the secrets manager [hashicorp-vault]. Default: hashicorp-vault

token

Specifies the access token for the service

server-url

Specifies the server URL for the service

name

Specifies the name of the node for on-service record keeping. Default: lyfebloc-core-node

namespace

Specifies the namespace used for the Hashicorp Vault secrets manager. Default: admin

Responses ​

Status Response ​

The response object is defined using Protocol Buffers.

message ServerStatus {
    int64 network = 1;

    string genesis = 2;

    Block current = 3;

    string p2pAddr = 4;

    message Block {
        int64 number = 1;
        string hash = 2;
    }
}

message ServerStatus {
    int64 network = 1;

    string genesis = 2;

    Block current = 3;

    string p2pAddr = 4;

    message Block {
        int64 number = 1;
        string hash = 2;
    }
}

Monitor Response ​

message BlockchainEvent {
    // The "repeated" keyword indicates an array
    repeated Header added = 1;
    repeated Header removed = 2;

    message Header {
        int64 number = 1;
        string hash = 2;
    }
}

message BlockchainEvent {
    // The "repeated" keyword indicates an array
    repeated Header added = 1;
    repeated Header removed = 2;

    message Header {
        int64 number = 1;
        string hash = 2;
    }
}

Utilities ​

loadbot flags ​

tps

The number of transactions per second to send. Default: 100.

mode

Sets the loadbot run mode [transfer, deploy]. Default: transfer.

chain-id

Sets the network chain ID for transactions. Default: 100.

gas-price

The gas price that should be used for the transactions. If omitted, the average gas price is fetched from the network.

gas-limit

The gas limit that should be used for the transactions. If omitted, the gas limit is estimated before starting the loadbot.

grpc-address

The GRPC endpoint used to send transactions

detailed

Flag indicating if the error logs should be shown. Default: false.

contract

The path to the contract JSON artifact containing the bytecode. If omitted, a default contract is used.

sender

Address of the sender account.

receiver

Address of the receiver account.

jsonrpc

A JSON RPC endpoint used to send transactions.

count

The total number of transactions to send. Default: 1000.

value

The value to send in each transaction.

max-conns

Sets the maximum no.of connections allowed per host. Default: 2*tps.

backup flags ​

grpc-address

Address of the gRPC API. Default: 127.0.0.1:9632.

out

Path of archive file to save.

from

The beginning height of blocks in archive. Default: 0.

to

The end height of blocks in archive.

Genesis Template ​

The genesis file should be used to set the initial state of the blockchain (ex. if some accounts should have a starting balance).

The following ./genesis.json file is generated:

{
    "name": "example",
    "genesis": {
        "nonce": "0x0000000000000000",
        "gasLimit": "0x0000000000001388",
        "difficulty": "0x0000000000000001",
        "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "coinbase": "0x0000000000000000000000000000000000000000",
        "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000"
    },
    "params": {
        "forks": {},
        "chainID": 100,
        "engine": {
            "pow": {}
        }
    },
    "bootnodes": []
}

{
    "name": "example",
    "genesis": {
        "nonce": "0x0000000000000000",
        "gasLimit": "0x0000000000001388",
        "difficulty": "0x0000000000000001",
        "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "coinbase": "0x0000000000000000000000000000000000000000",
        "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000"
    },
    "params": {
        "forks": {},
        "chainID": 100,
        "engine": {
            "pow": {}
        }
    },
    "bootnodes": []
}

Data Directory ​

When executing the data-dir flag, a test-chain folder is generated. The folder structure consists of the following sub-folders:

• blockchain - Stores the LevelDB for blockchain objects
• trie - Stores the LevelDB for the Merkle tries
• keystore - Stores private keys for the client. This includes the libp2p private key and the sealing/validator private key
• consensus - Stores any consensus information that the client might need while working

Resources ​

• Protocol Buffers