Options

• ➤ app-protocol-version <String>
  App protocol version token.
• ➤ genesis-block-path <String>
  Genesis block path of blockchain. Blockchain is recognized by its genesis block.
• ➤ host <String>
  Hostname of this node for another nodes to access. This is not listening host like 0.0.0.0
• ➤ port <UInt16?>
  Port of this node for another nodes to access.
• ➤ swarm-private-key <String>
  The private key used for signing messages and to specify your node. If you leave this null, a randomly generated value will be used.
• ➤ no-miner <Boolean?>
  Disable block mining.
• ➤ miner-count <Int32?>
  The number of miner task(thread).
• ➤ miner-private-key <String>
  The private key used for mining blocks. Must not be null if you want to turn on mining with libplanet-node.
• ➤ miner.block-interval <Int32?>
  The miner's break time after mining a block. The unit is millisecond.
• ➤ store-type <String>
  The type of storage to store blockchain data. If not provided, "LiteDB" will be used as default. Available type: ["rocksdb", "memory"]
• ➤ store-path <String>
  Path of storage. This value is required if you use persistent storage e.g. "rocksdb"
• ➤ no-reduce-store <Boolean?>
  Do not reduce storage. Enabling this option will use enormous disk spaces.
• ➤ ice-server <String[]>
  ICE server to NAT traverse.
• ➤ peer <String[]>
  Seed peer list to communicate to another nodes.
• ➤ trusted-app-protocol-version-signer <String[]>
  Trustworthy signers who claim new app protocol versions
• ➤ rpc-server <Boolean?>
  Use this option if you want to make unity clients to communicate with this server with RPC
• ➤ rpc-listen-host <String>
  RPC listen host
• ➤ rpc-listen-port <Int32?>
  RPC listen port
• ➤ rpc-remote-server <Boolean?>
  Do a role as RPC remote server? If you enable this option, multiple Unity clients can connect to your RPC server.
• ➤ rpc-http-server <Boolean?>
  If you enable this option with "rpcRemoteServer" option at the same time, RPC server will use HTTP/1, not gRPC.
• ➤ graphql-server <Boolean?>
  Use this option if you want to enable GraphQL server to enable querying data.
• ➤ graphql-host <String>
  GraphQL listen host
• ➤ graphql-port <Int32?>
  GraphQL listen port
• ➤ graphql-secret-token-path <String>
  The path to write GraphQL secret token. If you want to protect this headless application, you should use this option and take it into headers.
• ➤ no-cors <Boolean?>
  Run without CORS policy.
• ➤ confirmations <Int32?>
  The number of required confirmations to recognize a block.
• ➤ nonblock-renderer <Boolean?>
  Uses non-blocking renderer, which prevents the blockchain & swarm from waiting slow rendering. Turned off by default.
• ➤ nonblock-renderer-queue <Int32?>
  The size of the queue used by the non-blocking renderer. Ignored if --nonblock-renderer is turned off.
• ➤ strict-rendering <Boolean?>
  Flag to turn on validating action renderer.
• ➤ log-action-renders <Boolean?>
  Log action renders besides block renders. --rpc-server implies this.
• ➤ network-type <String>
  (deprecated) Network type.
• ➤ planet <Planet?>
  Planet
• ➤ tx-life-time <Int32?>
  The lifetime of each transaction, which uses minute as its unit.
• ➤ message-timeout <Int32?>
  The grace period for new messages, which uses second as its unit.
• ➤ tip-timeout <Int32?>
  The grace period for tip update, which uses second as its unit.
• ➤ demand-buffer <Int32?>
  A number of block size that determines how far behind the demand the tip of the chain will publish `NodeException` to GraphQL subscriptions.
• ➤ static-peer <String[]>
  A list of peers that the node will continue to maintain.
• ➤ skip-preload <Boolean?>
  Run node without preloading.
• ➤ minimum-broadcast-target <Int32?>
  Minimum number of peers to broadcast message.
• ➤ bucket-size <Int32?>
  Number of the peers can be stored in each bucket.
• ➤ chain-tip-stale-behavior-type <String>
  Determines behavior when the chain's tip is stale. "reboot" and "preload" is available and "reboot" option is selected by default.
• ➤ tx-quota-per-signer <Int32?>
  The number of maximum transactions can be included in stage per signer.
• ➤ maximum-poll-peers <Int32?>
  The maximum number of peers to poll blocks. int.MaxValue by default.
• ➤ consensus-port <UInt16?>
  Port used for communicating consensus related messages. null by default.
• ➤ consensus-private-key <String>
  The private key used for signing consensus messages. Cannot be null.
• ➤ consensus-seed <String[]>
  A list of seed peers to join the block consensus.
• ➤ consensus-target-block-interval <Double?>
  A target block interval used in consensus context. The unit is millisecond.
• ➤ maximum-transaction-per-block <Int32?>
  Maximum transactions allowed in a block. null by default.
• ➤ config <String>
  Default Value : appsettings.json
  Absolute path of "appsettings.json" file to provide headless configurations.
• ➤ sentry-dsn <String>
  Sentry DSN
• ➤ sentry-trace-sample-rate <Double?>
  Trace sample rate for sentry
• ➤ arena-participants-sync-interval <Int32?>
  arena participants list sync interval time
• ➤ arena-participants-sync <Boolean>
  Default Value : True
  arena participants list sync enable

Arguments

• ➤ out_dir String
  Path to output directory.

Arguments

• ➤ address String
  Account address.

Options

• ➤ verbose <Boolean>
  Default Value : False
  Print more logs.
• ➤ store-path <String>
  Path to the chain store.
• ➤ block <String>
  Optional block hash/index offset to query balances at. Tip by default.
• ➤ chain-id <Guid?>
  Optional chain ID. Default is the canonical chain ID.

Arguments

• ➤ private-key String
  A hexadecimal representation of private key to validate.

Arguments

• ➤ public-key String
  A hexadecimal representation of public key to validate.

Arguments

• ➤ store-type enum StoreType (RocksDb, Memory, Default)
  The storage type to store blockchain data. You cannot use "Memory" because it's volatile.
• ➤ store-path String

Arguments

• ➤ store-type enum StoreType (RocksDb, Memory, Default)
  The storage type to store blockchain data. You cannot use "Memory" because it's volatile.
• ➤ store-path String
  Store path to inspect.
• ➤ offset Int32?
  Offset of block index.
• ➤ limit Int32?
  Limit of block count.

Arguments

• ➤ store-type enum StoreType (RocksDb, Memory, Default)
  The storage type to store blockchain data. You cannot use "Memory" because it's volatile.
• ➤ store-path String
  Store path to inspect.
• ➤ blocks-before Int32
  Number of blocks to truncate from the tip

Arguments

• ➤ store-type enum StoreType (RocksDb, Memory, Default)
  Store type of RocksDb.
• ➤ store-path String
  Store path to prune states.

Arguments

• ➤ apv String
  APV to include in the snapshot metadata
• ➤ output-directory String
  Directory path to store the snapshot file
• ➤ store-path String
  Store path of the chain to take a snapshot
• ➤ block-before Int32
  Number of blocks to truncate from the tip
• ➤ snapshot-type enum SnapshotType (Full, Partition, All)
  Type of snapshot to take (full, partition, or all)

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt.
• ➤ json <Boolean>
  Default Value : False
  Print the created private key as Web3 Secret Storage format.
• ➤ dry-run <Boolean>
  Default Value : False
  Do not add to the key store, but only show the created key.

Arguments

• ➤ key-id Guid
  A key UUID to remove.

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt.
• ➤ no-passphrase <Boolean>
  Default Value : False

Arguments

• ➤ private-key String
  A raw private key to import in hexadecimal string.

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt.
• ➤ json <Boolean>
  Default Value : False
  Print the created private key as Web3 Secret Storage format.
• ➤ dry-run <Boolean>
  Default Value : False
  Do not add to the key store, but only show the created key.

Arguments

• ➤ key-id Guid
  A key UUID to export.

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt.
• ➤ public-key <Boolean>
  Default Value : False
  Export a public key instead of private key.
• ➤ bytes <Boolean>
  Default Value : False
  Print raw bytes instead of hexadecimal. No trailing LF appended.

Options

• ➤ no-address <Boolean>
  Default Value : False
  Do not show a derived address.
• ➤ public-key <Boolean>
  Default Value : False
  Show a public key as well.

Arguments

• ➤ key-id Guid
  A key UUID to sign.
• ➤ file String
  A path of the file to sign. If you pass '-' dash character, it will receive the message to sign from stdin.

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt. Mutually exclusive with --passphrase-file option.
• ➤ passphrase-file <String>
  Read passphrase from the specified file instead of taking it through prompt. Mutually exclusive with -p/--passphrase option. For standard input, use a hyphen (`-'). For an actual file named a hyphen, prepend `./', i.e., `./-'. Note that the trailing CR/LF is trimmed.
• ➤ binary-output <String>
  A path of the file to save the signature. If you pass '-' dash character, it will print to stdout as raw bytes not hexadecimal string or else. If this option isn't given, it will print hexadecimal string to stdout as default behaviour.

Arguments

• ➤ key-id Guid
  A key UUID to sign.

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt. Mutually exclusive with --passphrase-file option.
• ➤ passphrase-file <String>
  Read passphrase from the specified file instead of taking it through prompt. Mutually exclusive with -p/--passphrase option. For standard input, use a hyphen (`-'). For an actual file named a hyphen, prepend `./', i.e., `./-'. Note that the trailing CR/LF is trimmed.

Options

• ➤ key-id <Guid>
• ➤ passphrase <String>

Arguments

• ➤ private-key String

Options

• ➤ public-key <Boolean>
  Default Value : False
• ➤ address <Boolean>
  Default Value : False

Arguments

• ➤ key-id Guid
  A private key to use for signing.
• ➤ version Int32
  A version number to sign.

Options

• ➤ passphrase <String>
  Take passphrase through this option instead of prompt. Mutually exclusive with --passphrase-file option.
• ➤ passphrase-file <String>
  Read passphrase from the specified file instead of taking it through prompt. Mutually exclusive with -p/--passphrase option. For standard input, use a hyphen (`-'). For an actual file named a hyphen, prepend `./', i.e., `./-'. Note that the trailing CR/LF is trimmed.
• ➤ extra-file <String>
  Bencodex file to use for extra data. For standard input, use a hyphen (`-'). For an actual file named a hyphen, prepend `./', i.e., `./-'.
• ➤ extra <String[]>
  Set a value to a key on extra Bencodex dictionary. Can be applied multiple times (e.g., `-e foo=1 -e bar=baz'). This option implies the extra data to be a Bencodex dictionary, hence cannot be used together with -E/--extra-file option.

Arguments

• ➤ apv-token String
  An app protocol version token to verify. Read from the standard input if omitted.

Options

• ➤ public-keys <PublicKey[]>
  Public key(s) to be used for verification. Can be applied multiple times.
• ➤ no-key-store <Boolean>
  Default Value : False
  Do not use any keys in the key store, but only -p/--public-key options.

Arguments

• ➤ apv-token String
  An app protocol version token to analyze. Read from the standard input if omitted.

Options

• ➤ json <Boolean>
  Default Value : False
  Print information of given token as JSON.

Arguments

• ➤ target String
  Comma separated peer information({pubkey},{host},{port}) of target node. (E.g., 027bd36895d68681290e570692ad3736750ceaab37be402442ffb203967f98f7b6,9c.planetarium.dev,31236)

Arguments

• ➤ invitation-code String
  An invitation code.
• ➤ nonce String
  A hex-encoded nonce for activation.
• ➤ path String
  A file path of base64 encoded action.

Options

• ➤ exclude-obsolete <Boolean>
  Default Value : False
  If true, filter obsoleted actions since the --block-index option.
• ➤ block-index <Int64>
  Default Value : 0
  The current block index to filter obsoleted actions.

Arguments

• ➤ sender-address String
  A hex-encoded sender address.
• ➤ recipient-address String
  A hex-encoded recipient address.
• ➤ amount String
  The amount of asset to transfer.
• ➤ path String
  A file path of base64 encoded action.
• ➤ memo String
  A memo of asset transfer

Arguments

• ➤ path String
  A file path of base64 encoded action.

Options

• ➤ amount <Int64>

Arguments

• ➤ avatar-address String
  A hex-encoded avatar address.
• ➤ path String
  A file path of base64 encoded action.

Arguments

• ➤ avatar-address String
  A hex-encoded avatar address.
• ➤ path String
  A file path of base64 encoded action.

Options

• ➤ verbose <Boolean>
  Default Value : False
  Print more logs.
• ➤ store-path <String>
  Path to the chain store.
• ➤ chain-id <Guid?>
  Optional chain ID. Default is the canonical chain ID.
• ➤ topmost <String>
  Optional topmost block to execute last. Can be either a block hash or block index. Tip by default.
• ➤ bottommost <String>
  Optional bottommost block to execute first. Can be either a block hash or block index. Genesis by default.
• ➤ bypass-state-root-hash-check <Boolean>
  Default Value : False
  Bypass the state root hash check.
• ➤ use-memory-kv-store <String>
  Use the in-memory key-value state store and dump it to the specified directory path in the end.

Arguments

• ➤ block String
  A block to check. Can be either a block hash or block index. Tip by default.

Options

• ➤ store-path <String>
  Path to the chain store.
• ➤ chain-id <Guid?>
  Optional chain ID. Default is the canonical chain ID.
• ➤ verbose <Boolean>
  Default Value : False
  Print more logs.

Arguments

• ➤ private-key String
  A hex-encoded private key for signing.
• ➤ nonce Int64
  A nonce for new transaction.
• ➤ genesis-hash String
  A hex-encoded genesis block hash.
• ➤ timestamp String
  A datetime for new transaction.

Options

• ➤ action <String[]>
  A path of the file contained base64 encoded actions.
• ➤ bytes <Boolean>
  Default Value : False
  Print raw bytes instead of base64. No trailing LF appended.
• ➤ max-gas-price <Int64?>
  maximum price per gas fee.

Arguments

• ➤ sender String
  An address of sender.
• ➤ recipient String
  An address of recipient.
• ➤ amount Int32
  An amount of gold to transfer.
• ➤ genesis-block String
  A genesis block containing InitializeStates.

Arguments

• ➤ table-path String
  A table file path for patch.

Arguments

• ➤ directory-path String
  path of the directory contained hex-encoded avatar states.
• ➤ output-path String
  path of the output file dumped action.

Arguments

• ➤ table-path String
  A table file path for RedeemCodeListSheet

Arguments

• ➤ csv-path String
  A csv file path for CreatePendingActivations

Arguments

• ➤ new-valid-until Int64

Arguments

• ➤ count Int32
  An amount of pairs

Options

• ➤ verbose <Boolean>
  Default Value : False
  Print more logs.
• ➤ store-path <String>
  Path to the chain store.
• ➤ from <String>
  Optional bottom block hash/index to search. Genesis by default.
• ➤ to <String>
  Optional topmost block hash/index to search. Tip by default.
• ➤ include-fails <Boolean>
  Default Value : False
  Include failed transactions too.
• ➤ item-type <String[]>
  Filter by item type. This implicitly filters out transactions made with Buy. This can be applied multiple times (meaning: match any of them). The list of available types can be found in ItemSubType enum declared in Lib9c/Model/Item/ItemType.cs file.
• ➤ chain-id <Guid?>
  Optional chain ID. Default is the canonical chain ID.

Arguments

• ➤ config String
  JSON config path to mine genesis block

Options

• ➤ tx-path <String>
  A JSON file path of tx.
• ➤ store-path <String>
  An absolute path of block storage.(rocksdb)
• ➤ block-index <Int64>
  Default Value : 1
  Target block height to evaluate tx. Tip as default. (Min: 1)If you set 100, using block 99 as previous state.
• ➤ verbose <Boolean>
  Default Value : False
  Verbose mode.
• ➤ output-path <String>
  An path of output file.

Options

• ➤ store-path <String>
  An absolute path of block storage.(rocksdb)
• ➤ start-index <Int64?>
  Target start block height. Tip as default. (Min: 1)
• ➤ end-index <Int64?>
  Target end block height. Tip as default. (Min: 1)If not set, same as argument "-i".
• ➤ repeat-count <Int32>
  Default Value : 1
  Repeat count. (Min: 1)If not set, default is 1.
• ➤ verbose <Boolean>
  Default Value : False
  Verbose mode.
• ➤ output-path <String>
  The path of output file.

Options

• ➤ tx <String>
  The transaction id
• ➤ endpoint <String>
  GraphQL endpoint to get remote state