Skip to main content

kwild start

kwild start​

Start the node

Synopsis​

The start command starts the Kwil DB blockchain node.

kwild start [flags]

Examples​

kwild start -r .testnet

Options​

      --log.level string                             log level possible values: 'debug', 'info', 'warn', and 'error' (default "info")
      --log.format string                            log format possible values: 'json', 'text' (kv), and 'plain' (fmt-style) (default "plain")
      --log.output strings                           output paths for the log (default [stdout,kwild.log])
      --log.file-roll-size int                       threshold in KB at which the log file rolls over and archives the current one (default 10000)
      --log.retain-max-rolls int                     retention limit on the number of archived log files to keep (0 meaning retain all)
      --profile-mode string                          profile mode (http, cpu, mem, mutex, or block)
      --profile-file string                          profile output file path (e.g. cpu.pprof)
      --p2p.listen string                            address in host:port format to listen on for P2P connections (default "0.0.0.0:6600")
      --p2p.pex                                      enable peer exchange (default true)
      --p2p.bootnodes strings                        bootnodes to connect to on startup
      --p2p.private                                  operate in private mode using a node ID whitelist
      --p2p.whitelist strings                        allowed node IDs when in private mode
      --p2p.target-connections int                   target number of connections to maintain (default 20)
      --p2p.external-address string                  external address in host:port format to advertise to the network
      --consensus.propose-timeout duration           minimum duration to wait before proposing a block with transactions (applies to leader). This value should be greater than 500ms. (default 1s)
      --consensus.empty-block-timeout duration       timeout for proposing an empty block. If set to 0, disables empty blocks, leader will wait indefinitely until transactions are available to produce a block. (default 1m0s)
      --consensus.block-proposal-interval duration   interval between block proposal reannouncements by the leader (default 1s)
      --consensus.block-ann-interval duration        interval between block commit reannouncements by the leader, and votes reannouncements by validators (default 3s)
      --mempool.max-size int                         maximum size of the mempool in bytes (default 200000000)
      --db.host string                               postgres host name (IP or UNIX socket path) (default "127.0.0.1")
      --db.port string                               postgres TCP port (leave empty for UNIX socket) (default "5432")
      --db.user string                               postgres role/user name (default "kwild")
      --db.pass string                               postgres password if required for the user and host
      --db.dbname string                             postgres database name (default "kwild")
      --db.read-timeout duration                     timeout on read transactions from user RPC calls and queries (default 45s)
      --db.max-connections uint                      maximum number of DB connections to permit (default 60)
      --store.compression                            compress data when writing new data (default true)
      --rpc.listen string                            address in host:port format on which the RPC server will listen (default "0.0.0.0:8484")
      --rpc.broadcast-tx-timeout duration            duration to wait for a tx to be committed when transactions are authored with --sync flag (default 15s)
      --rpc.timeout duration                         user request duration limit after which it is cancelled (default 20s)
      --rpc.max-req-size int                         largest permissible user request size (default 6000000)
      --rpc.private                                  enable private mode that requires challenge authentication for each call
      --rpc.compression                              use compression in RPC responses
      --rpc.challenge-expiry duration                lifetime of a server-generated challenge (default 30s)
      --rpc.challenge-rate-limit float               maximum number of challenges per second that a user can request (default 10)
      --admin.enable                                 enable the admin RPC service (default true)
      --admin.listen string                          address in host:port format or UNIX socket path on which the admin RPC server will listen (default "/tmp/kwild.socket")
      --admin.pass string                            optional password for the admin service
      --admin.notls                                  disable TLS when the listen address is not a loopback IP or UNIX socket
      --snapshots.enable                             enable creating and providing snapshots for peers using statesync
      --snapshots.recurring-height uint              snapshot creation period in blocks (default 14400)
      --snapshots.max-snapshots uint                 number of snapshots to keep, after the oldest is removed when creating a new one (default 3)
      --state-sync.enable                            enable using statesync rather than blocksync
      --state-sync.trusted-providers strings         trusted snapshot providers in node ID format (see bootnodes)
      --state-sync.discovery-time duration           how long to discover snapshots before selecting one to use (default 15s)
      --state-sync.max-retries uint                  how many times to try after failing to apply a snapshot before switching to blocksync (default 3)
      --genesis-state string                         path to the genesis state file, relative to the root directory
      --migrations.enable                            enable zero downtime migrations
      --migrations.migrate-from string               JSON-RPC listening address of the node to replicate the state from
      --checkpoint.height int                        checkpoint height for the leader. If the leader is behind this height, it will sync to this height before attempting to propose a new block
      --checkpoint.hash string                       checkpoint block hash
  -a, --autogen                                      auto generate private key, genesis file, and config file if not exist
  -d, --db-owner string                              owner of the database. This is either a hex pubkey or an address string
  -h, --help                                         help for start

Options inherited from parent commands​

      --output string   the format for command output - either 'text' or 'json' (default "text")
  -r, --root string     root directory (default "~/.kwild")

SEE ALSO​