NineChronicles Headless
Run
$ dotnet run --project ./NineChronicles.Headless.Executable/ -- --help
Usage: NineChronicles.Headless.Executable [--no-miner] [--app-protocol-version <String>] [--genesis-block-path <String>] [--host <String>] [--port <Nullable`1>] [--minimum-difficulty <Int32>] [--private-key <String>] [--store-type <String>] [--st
ore-path <String>] [--ice-server <String>...] [--peer <String>...] [--no-trusted-state-validators] [--trusted-app-protocol-version-signer <String>...] [--rpc-server] [--rpc-listen-host <String>] [--rpc-listen-port <Nullable`1>] [--graphql-server] [
--graphql-host <String>] [--graphql-port <Nullable`1>] [--libplanet-node] [--workers <Int32>] [--confirmations <Int32>] [--max-transactions <Int32>] [--strict-rendering] [--dev] [--dev.block-interval <Int32>] [--dev.reorg-interval <Int32>] [--log-m
inimum-level <String>] [--aws-cognito-identity <String>] [--aws-access-key <String>] [--aws-secret-key <String>] [--aws-region <String>] [--help] [--version]
Run standalone application with options.
Options:
--no-miner
-V, --app-protocol-version <String> App protocol version token (Default: )
-G, --genesis-block-path <String> (Default: )
-H, --host <String> (Default: )
-P, --port <Nullable`1> (Default: )
-D, --minimum-difficulty <Int32> (Default: 5000000)
--private-key <String> (Default: )
--store-type <String> (Default: )
--store-path <String> (Default: )
-I, --ice-server <String>... (Default: )
--peer <String>... (Default: )
--no-trusted-state-validators
-T, --trusted-app-protocol-version-signer <String>... Trustworthy signers who claim new app protocol versions (Default: )
--rpc-server
--rpc-listen-host <String> (Default: 0.0.0.0)
--rpc-listen-port <Nullable`1> (Default: )
--graphql-server
--graphql-host <String> (Default: 0.0.0.0)
--graphql-port <Nullable`1> (Default: )
--libplanet-node
--workers <Int32> Number of workers to use in Swarm (Default: 5)
--confirmations <Int32> The number of required confirmations to recognize a block. 0 by default. (Default: 0)
--max-transactions <Int32> The number of maximum transactions can be included in a single block. Unlimited if the value is less then or equal to 0. 100 by default. (Default: 100)
--strict-rendering Flag to turn on validating action renderer.
--dev Flag to turn on the dev mode. false by default.
--dev.block-interval <Int32> The time interval between blocks. It's unit is milliseconds. Works only when dev mode is on. 10000 (ms) by default. (Default: 10000)
--dev.reorg-interval <Int32> The size of reorg interval. Works only when dev mode is on. 0 by default. (Default: 0)
--log-minimum-level <String> The log minimum level during standalone execution. (Default: debug)
--aws-cognito-identity <String> The Cognito identity for AWS CloudWatch logging. (Default: )
--aws-access-key <String> The access key for AWS CloudWatch logging. (Default: )
--aws-secret-key <String> The secret key for AWS CloudWatch logging. (Default: )
--aws-region <String> The AWS region for AWS CloudWatch (e.g., us-east-1, ap-northeast-2). (Default: )
-h, --help Show help message
--version Show version
Docker Build
A Standalone image can be created by running the command below in the directory where the solution is located.
$ docker build . -t <IMAGE_TAG> --build-arg COMMIT=<VERSION_SUFFIX>
- Nine Chronicles Team uses <VERSION_SUFFIX> to build an image with the latest git commit and push to the official Docker Hub repository. However, if you want to build and push to your own Docker Hub account, <VERSION_SUFFIX> can be any value.
Command Line Options
-H,--host: Specifies the host name.-P,--port: Specifies the port number.--private-key: Specifies the private Key.--no-miner: Disables mining.--no-trusted-state-validators: Calculates all states directly without receiving calculated states from specified peers.--store-path: Specifies the path for storing data.-I,--ice-server: Specifies the TURN server info used for NAT Traversal. If there are multiple servers, they can be added by typing:--ice-server serverA --ice-server serverB ....--peer: Adds a peer and if there are multiple peers, they can be added by typing:--peer peerA --peer peerB ....-G,--genesis-block-path: Specifies the path of the genesis block.-V,--app-protocol-version: Specifies the value ofSwarm<T>.AppProtocolVersion.--rpc-server: Starts with RPC server mode. Must specify--rpc-listen-portto use this mode.--rpc-listen-host: Host name for RPC server mode.--rpc-listen-port: Port number for RPC server mode.--graphql-server: Turn on graphQL controller.--graphql-host: Host name for graphQL controller.--graphql-port: Port number for graphQL controller.--libplanet-node: Run with formal Libplanet node. One of this orgraphql-servermust be set.--workers: Number of workers to use in Swarm.--confirmations: Specifies the number of required confirmations to recognize a block.--max-transactions: Specifies the number of maximum transactions can be included in a single block. Unlimited if the value is less then or equal to 0.--dev: Flag to turn on the dev mode.--dev.block-interval: Specifies the time interval between blocks by milliseconds in dev mode.--dev.reorg-interval: Specifies the size of reorg interval in dev mode.
Format
Formatting for PrivateKey or Peer follows the format in [Nekoyume Project README][../README.md].
How to run NineChronicles Headless on AWS EC2 instance using Docker
On Your AWS EC2 Instance
Pre-requisites
- Docker environment: Docker Installation Guide
- AWS EC2 instance: AWS EC2 Guide
1. Pull ninechronicles-headless Docker image to your AWS EC2 instance from the official Docker Hub repository.
- If you would like to build your own Docker image from your local, refer to the appendix
$ docker pull planetariumhq/ninechronicles-headless:latest
Usage: docker pull [<DOCKER_HUB_ACCOUNT>/<IMAGE_NAME>] : [<TAGNAME>]
2. Create a Docker volume for blockchain data persistance
$ docker volume create 9c-volume
Usage: docker volume create [<VOLUME_NAME>]
3. Run your Docker image with your Docker volume mounted (use -d for detached mode)
$ docker run \ --detach \ --publish [HOST_PORT]:[CONTAINER_PORT] \ --volume 9c-volume:/app/data \ planetariumhq/ninechronicles-headless \ [NineChronicles Standalone Options]
Note)
- Instead of including the "--ice-server" option, allocate an Elastic IP to your instance and include it as the "--host" option and after adding an inbound port, include it as the "--port" option. Refer to these official docs on Elastic IP allocation and editing inbound rules for more information.
- For mining, make sure to include "--private-key" option with your private key. Also, include "--libplanet-node" to run the default libplanet node.
Appendix) Building Your Own Docker Image from Your Local
Pre-requisites
- Docker environment: Docker Installation Guide
- Docker Hub account: Docker Hub Guide
1. Build Docker image with the tag name in [<DOCKER_HUB_ACCOUNT>/<IMAGE_NAME>] format.
$ docker build . --tag 9c/9c-headless --build-arg COMMIT=9c-1
Usage: docker build . --tag [<DOCKER_HUB_ACCOUNT>/<IMAGE_NAME>] : [<TAGNAME>] --build-arg COMMIT=[<VERSION_SUFFIX>]
2. Push your Docker image to your Docker Hub account.
$ docker push 9c/9c-headless:latest
Usage: docker push [<DOCKER_HUB_ACCOUNT>/<IMAGE_NAME>] : [<TAGNAME>]
