For the complete documentation index, see llms.txt. This page is also available as Markdown.

Start local environment

Zeus comes with the ability to easily spawn your own full local testing environment

To start you own network run:

zeus start-localenv
zeus start-localenv

runs eosio node for local development

Options:
  --version                          Show version number               [boolean]
  --storage-path                     path for persistent storage
                                                 [default: "/home/ubuntu/.zeus"]
  --rc-file                          use rc file to load options from
                                     [default: "/home/ubuntu/.zeus/zeusrc.json"]
  --rc-ignore                        ignore rc file             [default: false]
  --verbose, -v                                                 [default: false]
  -h, --help                         Show help                         [boolean]
  --all                              compile all contracts       [default: true]
  --wallet                                                     [default: "zeus"]
  --creator-key [default: "5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"]
  --creator                                                   [default: "eosio"]
  --network                          network to work on [default: "development"]
  --chain                            chain to work on              [default: ""]
  --services                         service APIs to run           [default: ""]
  --stake                            account staking amount     [default: "300"]
  --transfer                         account staking amount    [default: "1000"]
  --multi-evm                        run multiple evm chains    [default: false]
  --kill                             kill all current running nodes and services
                                                                [default: false]
  --enable-features                  enables eosio features      [default: true]
  --enable-features-list             enables eosio features, list:
                                     KV_DATABASE,ACTION_RETURN_VALUE,CONFIGURABL
                                     E_WASM_LIMITS,BLOCKCHAIN_PARAMETERS,ONLY_BI
                                     LL_FIRST_AUTHORIZER,DISALLOW_EMPTY_PRODUCER
                                     _SCHEDULE,ONLY_LINK_TO_EXISTING_PERMISSION,
                                     FIX_LINKAUTH_RESTRICTION,RAM_RESTRICTIONS,R
                                     EPLACE_DEFERRED,NO_DUPLICATE_DEFERRED_ID,RE
                                     STRICT_ACTION_TO_SELF,FORWARD_SETCODE,GET_S
                                     ENDER,WEBAUTHN_KEY,CONFIGURABLE_WASM_LIMITS
                                     2,WTMSIG_BLOCK_SIGNATURES,GET_CODE_HASH,CRY
                                     PTO_PRIMITIVES,GET_BLOCK_NUM  [default: ""]
  --single-chain                     run without LiquidX        [default: false]
  --basic-env, -b                    min needed for EOSIO smart contract test
                                                                [default: false]
  --custom-token                     custom chain token            [default: ""]
  --custom-token-precision           custom chain token permission  [default: 4]
  --evm-host                         custom evm host      [default: "127.0.0.1"]
  --evm-port                         custom evm port             [default: 8545]
  --evm-sister-host                  custom evm sister host
                                                          [default: "127.0.0.1"]
  --evm-sister-port                  custom evm sister port      [default: 8546]
  --external-evm-endpoint            external evm endpoint         [default: ""]
  --external-evm-private-key         external evm private key      [default: ""]
  --external-evm-sister-endpoint     external evm sister endpoint  [default: ""]
  --external-evm-sister-private-key  external evm sister private key
                                                                   [default: ""]
  --phase                            phase of local env step to start
                                                                   [default: ""]

Examples:
  zeus start-localenv

Zeus runs the local environment files within ./zeus_boxes/start-localenv.

You can specify a file there with

zeus start-localenv --phase 02-a-eos-local-nodeos
zeus start-localenv --phase 05-a-eos-local-bios

This will give you a basic chain. You can also run this with the --basic-env flag.

zeus start-localenv --basic-env

If you wish to spawn a fully featured EOSIO network, run with --enable-features

zeus start-localenv --enable-features

Note the logs are in the ./logs directory

Run specific services with the --services flag

zeus start-localenv --services "cron,ipfs,oracle

Run a single chain with (so not to run excess nodeos instances):

zeus start-localenv --single-chain

Specify custom system token/precision

zeus start-localenv --custom-token NAT --custom-token-precision 8

Specify EVM host/port for main EVM chain and side EVM chain

zeus start-localenv  --evm-host 127.0.0.1 --evm-port 8545 --evm-sister-host 127.0.0.1 --evm-sister-port 8546

Last updated

Was this helpful?