Skip to content

Commit

Permalink
Update Katana CLI arguments (#344)
Browse files Browse the repository at this point in the history
  • Loading branch information
kariy authored Nov 10, 2024
1 parent 1e032c8 commit 5a9d89a
Showing 1 changed file with 73 additions and 36 deletions.
109 changes: 73 additions & 36 deletions docs/pages/toolchain/katana/cli/katana.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,70 +16,107 @@ katana [OPTIONS] [COMMAND]
     Don't print anything on startup.

`--no-mining`
     Disable auto and interval mining, and mine on demand instead.
     Disable auto and interval mining, and mine on demand instead via an endpoint.

`-b, --block-time <MILLISECONDS>`
&nbsp;&nbsp;&nbsp;&nbsp; Block time in milliseconds for interval mining.

`--db-dir <PATH>`
&nbsp;&nbsp;&nbsp;&nbsp; Directory path of the database to initialize from. The path must either be an empty directory or a directory which already contains a previously initialized Katana database.

`--json-log`
&nbsp;&nbsp;&nbsp;&nbsp; Output logs in JSON format.

`--rpc-url <URL>`
&nbsp;&nbsp;&nbsp;&nbsp; The Starknet RPC provider to fork the network from.

`--fork-block-number <BLOCK_NUMBER>`
&nbsp;&nbsp;&nbsp;&nbsp; Fork the network at a specific block.
&nbsp;&nbsp;&nbsp;&nbsp; Directory path of the database to initialize from.

`--messaging <PATH>`
&nbsp;&nbsp;&nbsp;&nbsp; Configure the messaging service to allow Katana to listen/send messages on a settlement chain that can be either Ethereum or another Starknet sequencer (experimental).

`-h, --help`
&nbsp;&nbsp;&nbsp;&nbsp; Print help (see a summary with '-h').
&nbsp;&nbsp;&nbsp;&nbsp; Configure the messaging with an other chain.

`-V, --version`
&nbsp;&nbsp;&nbsp;&nbsp; Print version information.

`-h, --help`
&nbsp;&nbsp;&nbsp;&nbsp; Print help (see more with '--help').

### Server Options

`-p, --port <PORT>`
&nbsp;&nbsp;&nbsp;&nbsp; Port number to listen on. [default: 5050]
`--http.addr <ADDRESS>`
&nbsp;&nbsp;&nbsp;&nbsp; HTTP-RPC server listening interface. [default: 127.0.0.1]

`--host <HOST>`
&nbsp;&nbsp;&nbsp;&nbsp; The IP address the server will listen on.
`--http.port <PORT>`
&nbsp;&nbsp;&nbsp;&nbsp; HTTP-RPC server listening port. [default: 5050]

`--max-connections <MAX_CONNECTIONS>`
`--http.corsdomain <HTTP_CORS_ORIGINS>`
&nbsp;&nbsp;&nbsp;&nbsp; Comma separated list of domains from which to accept cross origin requests.

`--rpc.max-connections <COUNT>`
&nbsp;&nbsp;&nbsp;&nbsp; Maximum number of concurrent connections allowed. [default: 100]

### Starknet Options
### Logging Options

`--seed <SEED>`
&nbsp;&nbsp;&nbsp;&nbsp; Specify the seed for randomness of accounts to be predeployed.
`--log.format <FORMAT>`
&nbsp;&nbsp;&nbsp;&nbsp; Log format to use. [default: full] [possible values: json, full]

`--accounts <NUM>`
&nbsp;&nbsp;&nbsp;&nbsp; Number of pre-funded accounts to generate. [default: 10]
### Metrics Options

`--disable-fee`
&nbsp;&nbsp;&nbsp;&nbsp; Disable charging fee for transactions.
`--metrics`
&nbsp;&nbsp;&nbsp;&nbsp; Enable metrics.

`--disable-validate`
&nbsp;&nbsp;&nbsp;&nbsp; Disable validation when executing transactions. Allowing transaction to be executed even with invalid signature.
`--metrics.addr <ADDRESS>`
&nbsp;&nbsp;&nbsp;&nbsp; The metrics will be served at the given address. [default: 127.0.0.1]

#### Environment Options
`--metrics.port <PORT>`
&nbsp;&nbsp;&nbsp;&nbsp; The metrics will be served at the given port. [default: 9100]

`--chain-id <CHAIN_ID>`
&nbsp;&nbsp;&nbsp;&nbsp; The chain ID. [default: KATANA]
### Environment Options

`--gas-price <GAS_PRICE>`
&nbsp;&nbsp;&nbsp;&nbsp; The gas price.
`--chain-id <CHAIN_ID>`
&nbsp;&nbsp;&nbsp;&nbsp; The chain ID.

`--validate-max-steps <VALIDATE_MAX_STEPS>`
&nbsp;&nbsp;&nbsp;&nbsp; The maximum number of steps available for the account validation logic.
&nbsp;&nbsp;&nbsp;&nbsp; The maximum number of steps available for the account validation logic. [default: 1000000]

`--invoke-max-steps <INVOKE_MAX_STEPS>`
&nbsp;&nbsp;&nbsp;&nbsp; The maximum number of steps available for the account execution logic.
&nbsp;&nbsp;&nbsp;&nbsp; The maximum number of steps available for the account execution logic. [default: 10000000]

`--genesis <GENESIS>`
&nbsp;&nbsp;&nbsp;&nbsp; The genesis configuration file.

### Gas Price Oracle Options

`--gpo.l1-eth-gas-price <WEI>`
&nbsp;&nbsp;&nbsp;&nbsp; The L1 ETH gas price (denominated in wei). [default: 0]

`--gpo.l1-strk-gas-price <FRI>`
&nbsp;&nbsp;&nbsp;&nbsp; The L1 STRK gas price (denominated in fri). [default: 0]

`--gpo.l1-eth-data-gas-price <WEI>`
&nbsp;&nbsp;&nbsp;&nbsp; The L1 ETH data gas price (denominated in wei). [default: 0]

`--gpo.l1-strk-data-gas-price <FRI>`
&nbsp;&nbsp;&nbsp;&nbsp; The L1 STRK data gas price (denominated in fri). [default: 0]

### Forking Options

`--fork.provider <URL>`
&nbsp;&nbsp;&nbsp;&nbsp; The RPC URL of the network to fork from.

`--fork.block <BLOCK>`
&nbsp;&nbsp;&nbsp;&nbsp; Fork the network at a specific block id, can either be a hash (0x-prefixed) or a block number.

### Development Options

`--dev`
&nbsp;&nbsp;&nbsp;&nbsp; Enable development mode.

`--dev.seed <SEED>`
&nbsp;&nbsp;&nbsp;&nbsp; Specify the seed for randomness of accounts to be predeployed. [default: 0]

`--dev.accounts <NUM>`
&nbsp;&nbsp;&nbsp;&nbsp; Number of pre-funded accounts to generate. [default: 10]

`--dev.no-fee`
&nbsp;&nbsp;&nbsp;&nbsp; Disable charging fee when executing transactions.

`--dev.no-account-validation`
&nbsp;&nbsp;&nbsp;&nbsp; Disable account validation when executing transactions.

### Slot Options

`--config <CONFIG>`
&nbsp;&nbsp;&nbsp;&nbsp; Configuration file.

0 comments on commit 5a9d89a

Please sign in to comment.