Command Line Interface

This document is a prettier output of the documentation produced by the command man of the different Octez binaries. You can obtain similar pages using shell commands such as:

octez-admin-client man -verbosity 3

The rest of this page documents the protocol-independent tools. The protocol-dependent tools are documented here.

Admin-client manual

Usage

  • octez-admin-client [global options] command [command options]
  • octez-admin-client --help (for global options)
  • octez-admin-client [global options] command --help (for command options)
  • octez-admin-client --version (for version information)

To browse the documentation

  • octez-admin-client [global options] man (for a list of commands)
  • octez-admin-client [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: client data directory (absent: TEZOS_CLIENT_DIR env) The directory where the Tezos client will store all its data. If absent, its value is the value of the TEZOS_CLIENT_DIR environment variable. If TEZOS_CLIENT_DIR is itself not specified, defaults to $HOME/.tezos-client -n --no-base-dir-warnings: silence warnings about client data directory -c --config-file <path>: configuration file -t --timings: show RPC request times --chain <hash|tag>: chain on which to apply contextual commands (commands dependent on the context associated with the specified chain). Possible tags are 'main' and 'test'. Defaults to `main`. -b --block <hash|level|tag>: block on which to apply contextual commands (commands dependent on the context associated with the specified block). Possible tags include 'head' and 'genesis' +/- an optional offset (e.g. "octez-client -b head-1 get timestamp"). Note that block queried must exist in node's storage. Defaults to `head`. -w --wait <none|<int>>: how many confirmation blocks are needed before an operation is considered included -p --protocol <hash>: use commands of a specific protocol -l --log-requests: log all requests to the node --better-errors: Error reporting is more detailed. Can be used if a call to an RPC fails or if you don't know the input accepted by the RPC. It may happen that the RPC calls take more time however. -A --addr <IP addr|host>: [DEPRECATED: use --endpoint instead] IP address of the node -P --port <number>: [DEPRECATED: use --endpoint instead] RPC port of the node -S --tls: [DEPRECATED: use --endpoint instead] use TLS to connect to node. -m --media-type <json, binary, any or default>: Sets the "media-type" value for the "accept" header for RPC requests to the node. The media accept header indicates to the node which format of data serialisation is supported. Use the value "json" for serialisation to the JSON format. Use the value "binary" for faster but less human-readable binary serialisation format. -E --endpoint <uri>: HTTP(S) endpoint of the node RPC interface; e.g. 'http://localhost:8732' -s --sources <path>: path to JSON file containing sources for --mode light. Example file content: {"min_agreement": 1.0, "uris": ["http://localhost:8732", "https://localhost:8733"]} -R --remote-signer <uri>: URI of the remote signer -f --password-filename <filename>: path to the password filename -M --mode <client|light|mockup|proxy>: how to interact with the node Defaults to `client`.

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Commands to inspect the event-logging framework

  • query events from Sink-Name [--names <LIST>] [--sections <LIST>] [--since <DATE>] [--until <DATE>] [--as-json] [--dump-unknown] [--for-script <FORMAT>]
    Query the events from an event sink. Sink-Name: The URI of the SINK to query --names <LIST>: Filter on event names --sections <LIST>: Filter on event sections (use '_' for no-section) --since <DATE>: Filter out events before DATE --until <DATE>: Filter out events after DATE --as-json: Display events as JSON instead of pretty-printing them --dump-unknown: Try to display unknown events --for-script <FORMAT>: Make the output script-friendly. Possible values are 'TSV' and 'CSV'.
  • show event-logging
    Display configuration/state information about the internal-event logging framework.
  • output schema of Event-Name to File-path
    Output the JSON schema of an internal-event. Event-Name: Name of the event File-path: Path to a JSON file

Commands for the low level RPC layer

  • rpc list url
    List RPCs under a given URL prefix. Some parts of the RPC service hierarchy depend on parameters, they are marked by a suffix `<dynamic>`. You can list these sub-hierarchies by providing a concrete URL prefix whose arguments are set to a valid value. url: the URL prefix
  • rpc list
    Alias to `rpc list /`.
  • rpc schema HTTP method url
    Get the input and output JSON schemas of an RPC. HTTP method: url: the RPC url
  • rpc format HTTP method url [-b --binary]
    Get the humanoid readable input and output formats of an RPC. HTTP method: url: the RPC URL -b --binary: Binary format
  • rpc get url
    Call an RPC with the GET method. url: the RPC URL
  • rpc post url
    Call an RPC with the POST method. It invokes $EDITOR if input data is needed. url: the RPC URL
  • rpc post url with input
    Call an RPC with the POST method, providing input data via the command line. url: the RPC URL input: the raw JSON input to the RPC For instance, use `{}` to send the empty document. Alternatively, use `file:path` to read the JSON data from a file.
  • rpc patch url
    Call an RPC with the PATCH method. It invokes $EDITOR if input data is needed. url: the RPC URL
  • rpc patch url with input
    Call an RPC with the PATCH method, providing input data via the command line. url: the RPC URL input: the raw JSON input to the RPC For instance, use `{}` to send the empty document. Alternatively, use `file:path` to read the JSON data from a file.
  • rpc put url
    Call an RPC with the PUT method. It invokes $EDITOR if input data is needed. url: the RPC URL
  • rpc put url with input
    Call an RPC with the PUT method, providing input data via the command line. url: the RPC URL input: the raw JSON input to the RPC For instance, use `{}` to send the empty document. Alternatively, use `file:path` to read the JSON data from a file.
  • rpc delete url
    Call an RPC with the DELETE method. url: the RPC URL

Commands for managing protocols

  • list protocols
    List protocols known by the node.
  • inject protocol dir
    Inject a new protocol into the node. dir: directory containing the sources of a protocol
  • dump protocol protocol hash
    Dump a protocol from the node's record of protocol. protocol hash:
  • protocol environment protocol hash
    Show the environment version used by a protocol. protocol hash:
  • fetch protocol protocol hash
    Fetch a protocol from the network. protocol hash:

Commands for monitoring and controlling p2p-layer state

  • p2p stat
    show global network status
  • connect address address
    Connect to a new point. address: <IPv4>:PORT or <IPV6>:PORT address (PORT defaults to 9732).
  • kick peer peer
    Kick a peer. peer: peer network identity
  • ban address address
    Add an IP address and all its ports to the blacklist and kicks it. Remove the address from the whitelist if it was previously in it. address: <IPv4>:PORT or <IPV6>:PORT address (PORT defaults to 9732).
  • unban address address
    Remove an IP address and all its ports from the blacklist. address: <IPv4>:PORT or <IPV6>:PORT address (PORT defaults to 9732).
  • trust address address
    Add an IP address to the whitelist. Remove the address from the blacklist if it was previously in it. address: <IPv4>:PORT or <IPV6>:PORT address (PORT defaults to 9732).
  • untrust address address
    Removes an IP address from the whitelist. address: <IPv4>:PORT or <IPV6>:PORT address (PORT defaults to 9732).
  • is address banned address
    Check if an IP address is banned. address: <IPv4>:PORT or <IPV6>:PORT address (PORT defaults to 9732).
  • is peer banned peer
    Check if a peer ID is banned. peer: peer network identity
  • ban peer peer
    Add a peer ID to the blacklist and kicks it. Remove the peer ID from the blacklist if was previously in it. peer: peer network identity
  • unban peer peer
    Removes a peer ID from the blacklist. peer: peer network identity
  • trust peer peer
    Add a peer ID to the whitelist. Remove the peer ID from the blacklist if it was previously in it. peer: peer network identity
  • untrust peer peer
    Remove a peer ID from the whitelist. peer: peer network identity
  • clear acls
    Clear all access control rules.

Commands to perform privileged operations on the node

  • unmark invalid [block...]
    Make the node forget its decision of rejecting blocks. block: blocks to remove from invalid list
  • unmark all invalid blocks
    Make the node forget every decision of rejecting blocks.
  • show current checkpoint
    Retrieve the current checkpoint and display it in a format compatible with node argument `--checkpoint`.
  • ban operation operation
    Remove an operation from the mempool if present, reverting its effect if it was applied. Add it to the set of banned operations to prevent it from being fetched/processed/injected in the future. Note: If the baker has already received the operation, then it's necessary to restart it to flush the operation from it. operation: hash of operation to ban
  • unban operation operation
    Remove an operation from the set of banned operations (nothing happens if it was not banned). operation: hash of operation to unban
  • unban all operations
    Clear the set of banned operations.

Commands to report the node's status

  • list heads [-o --output <path>]
    The last heads that have been considered by the node. -o --output <path>: write to a file Defaults to `-`.
  • list rejected blocks [-o --output <path>]
    The blocks that have been marked invalid by the node. -o --output <path>: write to a file Defaults to `-`.

Commands for editing and viewing the client's config file

  • config show
    Show the current config (config file content + command line arguments) or the mockup config files if `--mode mockup` is specified.
  • config reset
    Reset the config file to the factory defaults.
  • config update
    Update the config based on the current cli values. Loads the current configuration (default or as specified with `-config-file`), applies alterations from other command line arguments (such as the node's address, etc.), and overwrites the updated configuration file.
  • config init [-o --output <path>] [--bootstrap-accounts <path>] [--protocol-constants <path>]
    Create config file(s) based on the current CLI values. If the `-file` option is not passed, this will initialize the default config file, based on default parameters, altered by other command line options (such as the node's address, etc.). Otherwise, it will create a new config file, based on the default parameters (or the the ones specified with `-config-file`), altered by other command line options. If `-mode mockup` is specified, this will initialize the mockup's default files instead of the config file. Use `-bootstrap-accounts` and `-protocol-constants` to specify custom paths. The command will always fail if file(s) to create exist already -o --output <path>: path at which to create the file Defaults to `$HOME/.tezos-client/config`. --bootstrap-accounts <path>: path at which to create the file Defaults to `$HOME/.tezos-client/bootstrap-accounts.json`. --protocol-constants <path>: path at which to create the file Defaults to `$HOME/.tezos-client/protocol-constants.json`.

Miscellaneous commands

  • list understood protocols
    List the protocol versions that this client understands.

Signer manual

Usage

  • octez-signer [global options] command [command options]
  • octez-signer --help (for global options)
  • octez-signer [global options] command --help (for command options)
  • octez-signer --version (for version information)

To browse the documentation

  • octez-signer [global options] man (for a list of commands)
  • octez-signer [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: signer data directory The directory where the Tezos client will store all its data. By default: '$HOME/.tezos-signer'. -A --require-authentication: Require a signature from the caller to sign. -f --password-filename <filename>: path to the password filename

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Commands specific to the signing daemon

  • launch socket signer [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [-a --address <host|address>] [-p --port <port number>] [-t --timeout <timeout>]
    Launch a signer daemon over a TCP socket. -P --pidfile <filename>: write process id in file -M --magic-bytes <0xHH,0xHH,...>: values allowed for the magic bytes, defaults to any -W --check-high-watermark: high watermark restriction Stores the highest level signed for blocks and attestations for each address, and forbids to sign a level and round that are inferior or equal afterwards, except for the exact same input data. -a --address <host|address>: listening address or host name Defaults to `localhost`. -p --port <port number>: listening TCP port or service name Defaults to `7732`. -t --timeout <timeout>: timeout before the signer closes client connection (in seconds) Defaults to `8`.
  • launch local signer [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [-s --socket <path>]
    Launch a signer daemon over a local Unix socket. -P --pidfile <filename>: write process id in file -M --magic-bytes <0xHH,0xHH,...>: values allowed for the magic bytes, defaults to any -W --check-high-watermark: high watermark restriction Stores the highest level signed for blocks and attestations for each address, and forbids to sign a level and round that are inferior or equal afterwards, except for the exact same input data. -s --socket <path>: path to the local socket file Defaults to `$HOME/.tezos-signer/socket`.
  • launch http signer [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [-a --address <host|address>] [-p --port <port number>]
    Launch a signer daemon over HTTP. -P --pidfile <filename>: write process id in file -M --magic-bytes <0xHH,0xHH,...>: values allowed for the magic bytes, defaults to any -W --check-high-watermark: high watermark restriction Stores the highest level signed for blocks and attestations for each address, and forbids to sign a level and round that are inferior or equal afterwards, except for the exact same input data. -a --address <host|address>: listening address or host name Defaults to `localhost`. -p --port <port number>: listening HTTP port Defaults to `6732`.
  • launch https signer cert key [-P --pidfile <filename>] [-M --magic-bytes <0xHH,0xHH,...>] [-W --check-high-watermark] [-a --address <host|address>] [-p --port <port number>]
    Launch a signer daemon over HTTPS. cert: path to the TLS certificate key: path to the TLS key -P --pidfile <filename>: write process id in file -M --magic-bytes <0xHH,0xHH,...>: values allowed for the magic bytes, defaults to any -W --check-high-watermark: high watermark restriction Stores the highest level signed for blocks and attestations for each address, and forbids to sign a level and round that are inferior or equal afterwards, except for the exact same input data. -a --address <host|address>: listening address or host name Defaults to `localhost`. -p --port <port number>: listening HTTPS port Defaults to `443`.
  • add authorized key pk [-N --name <name>]
    Authorize a given public key to perform signing requests. pk: full public key (Base58 encoded) -N --name <name>: an optional name for the key (defaults to the hash)

Commands for managing the wallet of cryptographic keys

  • stresstest gen keys keys_count [--alias-prefix <PREFIX>]
    Generate an array of accounts for testing purposes. keys_count: How many keys to generate --alias-prefix <PREFIX>: use a custom alias prefix (default: bootstrap). Keys will be generated with alias "PREFIX<ID>" where ID is unique for all key
  • list signing schemes
    List supported signing schemes. Signing schemes are identifiers for signer modules: the built-in signing routines, a hardware wallet, an external agent, etc. Each signer has its own format for describing secret keys, such a raw secret key for the default `unencrypted` scheme, the path on a hardware security module, an alias for an external agent, etc. This command gives the list of signer modules that this version of the tezos client supports.
  • gen keys new [-f --force] [-s --sig <ed25519|secp256k1|p256|bls>] [--encrypted]
    Generate a pair of keys. new: new secret_key alias -f --force: overwrite existing secret_key -s --sig <ed25519|secp256k1|p256|bls>: use custom signature algorithm Defaults to `ed25519`. --encrypted: Encrypt the key on-disk
  • gen vanity keys new matching [words...] [-P --prefix] [-I --ignore-case] [-f --force] [--encrypted]
    Generate keys including the given string. new: new public key hash alias words: string key must contain one of these words -P --prefix: the key must begin with tz1[word] -I --ignore-case: make the pattern case-insensitive -f --force: overwrite existing keys --encrypted: Encrypt the key on-disk
  • encrypt secret key
    Encrypt an unencrypted secret key.
  • import secret key new uri [-f --force]
    Add a secret key to the wallet. new: new secret_key alias uri: secret key Varies from one scheme to the other. Use command `list signing schemes` for more information. -f --force: overwrite existing secret_key
  • import public key new uri [-f --force]
    Add a public key to the wallet. new: new public_key alias uri: public key Varies from one scheme to the other. Use command `list signing schemes` for more information. -f --force: overwrite existing public_key
  • add address new src [-f --force]
    Add an address to the wallet. new: new public key hash alias src: source public key hash Can be a public key hash name, a file or a raw public key hash literal. If the parameter is not the name of an existing public key hash, the client will look for a file containing a public key hash, and if it does not exist, the argument will be read as a raw public key hash. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. -f --force: overwrite existing public_key
  • list known addresses
    List all addresses and associated keys.
  • show address name [-S --show-secret]
    Show the keys associated with an implicit account. name: existing public key hash alias -S --show-secret: show the private key
  • forget address name [-f --force]
    Forget one address. name: existing public key hash alias -f --force: delete associated keys when present
  • forget all keys [-f --force]
    Forget the entire wallet of keys. -f --force: you got to use the force for that
  • generate nonce for name from data
    Compute deterministic nonce. name: existing public key hash alias data: string from which to deterministically generate the nonce
  • generate nonce hash for name from data
    Compute deterministic nonce hash. name: existing public key hash alias data: string from which to deterministically generate the nonce hash
  • import keys from mnemonic new [-f --force] [--encrypt]
    Import a pair of keys to the wallet from a mnemonic phrase. This command uses the BIP39 algorithm, and therefore imports public/secret keys that may be different from a Ledger application, depending on the BIP32 derivation path used in the Ledger. This command also uses the Ed25519 algorithm, which means it generates tz1 public key hashes. new: new secret_key alias -f --force: overwrite existing secret_key --encrypt: encrypt the secret key
  • bls gen keys new [-f --force] [--encrypted]
    Generate a pair of BLS keys. new: new Aggregate_secret_key alias -f --force: overwrite existing Aggregate_secret_key --encrypted: Encrypt the key on-disk
  • bls list keys
    List BlS keys.
  • bls show address name [-S --show-secret]
    Show the keys associated with an rollup account. name: existing Aggregate_public_key_hash alias -S --show-secret: show the private key
  • bls import secret key new uri [-f --force]
    Add a secret key to the wallet. new: new Aggregate_secret_key alias uri: secret key Varies from one scheme to the other. Use command `list signing schemes` for more information. -f --force: overwrite existing Aggregate_secret_key

Commands for managing the connected Ledger Nano devices

  • list connected ledgers
    List supported Ledger Nano devices connected.
  • show ledger account-alias-or-ledger-uri [--test-sign]
    Display version/public-key/address information for a Ledger URI account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path"). --test-sign: Test signing operation
  • get ledger authorized path for account-alias-or-ledger-uri
    Query the path of the authorized key account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
  • authorize ledger to bake for account-alias-or-ledger-uri
    Authorize a Ledger to bake for a key (deprecated, use `setup ledger ...` with recent versions of the Baking app) account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
  • setup ledger to bake for account-alias-or-ledger-uri [--main-chain-id <ID>] [--main-hwm <HWM>] [--test-hwm <HWM>]
    Setup a Ledger to bake for a key account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path"). --main-chain-id <ID>: Use <ID> as main chain-id instead of asking the node. Defaults to `ASK-NODE`. --main-hwm <HWM>: Use <HWM> as main chain high watermark instead of asking the ledger. Defaults to `ASK-LEDGER`. --test-hwm <HWM>: Use <HWM> as test chain high watermark instead of asking the ledger. Defaults to `ASK-LEDGER`.
  • deauthorize ledger baking for account-alias-or-ledger-uri
    Deauthorize Ledger from baking account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
  • get ledger high water mark for account-alias-or-ledger-uri [--no-legacy-instructions]
    Get high water mark of a Ledger account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path"). --no-legacy-instructions: Prevent the fallback to the (deprecated) Ledger instructions (for 1.x.y versions of the Baking app)
  • set ledger high water mark for account-alias-or-ledger-uri to high watermark
    Set high water mark of a Ledger account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path"). high watermark: High watermark
  • get ledger high watermark for account-alias-or-ledger-uri [--no-legacy-instructions]
    Get high water mark of a Ledger (legacy/deprecated spelling) account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path"). --no-legacy-instructions: Prevent the fallback to the (deprecated) Ledger instructions (for 1.x.y versions of the Baking app)
  • set ledger high watermark for account-alias-or-ledger-uri to high watermark
    Set high water mark of a Ledger (legacy/deprecated spelling) account-alias-or-ledger-uri: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path"). high watermark: High watermark

Benchmark tool manual

Usage

  • octez-snoop [global options] command [command options]
  • octez-snoop --help (for global options)
  • octez-snoop [global options] command --help (for command options)
  • octez-snoop --version (for version information)

To browse the documentation

  • octez-snoop [global options] man (for a list of commands)
  • octez-snoop [global options] man -v 3 (for the full manual)

Global options (must come before the command)

--list-solvers: List all available solvers --list-models: List all models

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Command for generating random sapling transactions

  • alpha sapling generate SAPLING-TX-COUNT transactions in SAPLING-TX-FILE [--max-inputs <integer>] [--max-outputs <integer>] [--max-nullifiers <integer>] [--max-additional-commitments <integer>] [--seed <int>]
    Sapling transaction generation SAPLING-TX-COUNT: Number of sapling transactions to generate SAPLING-TX-FILE: File containing sapling transactions --max-inputs <integer>: Maximum number of inputs --max-outputs <integer>: Maximum number of outputs --max-nullifiers <integer>: Maximum number of nullifiers --max-additional-commitments <integer>: Maximum number of additional-commitments --seed <int>: RNG seed

Command for generating random Michelson code and data

  • alpha michelson generate TERMS-COUNT terms of kind {data|code} in FILENAME [--min-size <int>] [--max-size <int>] [--burn-in <int>] [--seed <int>]
    Michelson generation TERMS-COUNT: Number of terms to generate {data|code}: Kind of term to generate FILENAME: File where to save Michelson terms --min-size <int>: Lower bound for target size of terms --max-size <int>: Lower bound for target size of terms --burn-in <int>: Burn-in multiplier --seed <int>: RNG seed
  • alpha michelson concat files FILENAME and FILENAME into FILENAME
    Michelson generation FILENAME: First file FILENAME: Second file FILENAME: Target file

Commands for displaying detailed information for Snoop components

  • display info for benchmark BENCH-NAME
    Display detailed information on the given benchmark BENCH-NAME: Name of the benchmark
  • display info for all benchmarks
    Display detailed information on all the benchmarks
  • display info for model MODEL-NAME
    Display detailed information on the given model MODEL-NAME: Name of the model
  • display info for parameter PARAM-NAME
    Display detailed information on the given parameter PARAM-NAME: Name of the parameter
  • display info for local model LOCAL-MODEL-NAME
    Display detailed information on the given local model LOCAL-MODEL-NAME: Name of the local model

Commands for manipulating workload files

  • workload dump WORKLOAD-FILE [-o --out-file <OUTPUT-FILE>]
    Dump the content of a workload file in JSON format WORKLOAD-FILE: Workload file name -o --out-file <OUTPUT-FILE>: JSON file name to write the content

Commands for manipulating config files

  • config check CONFIG-FILE for BENCH-NAME
    Prints the configuration that would be used for a given benchmark, given a configuration file CONFIG-FILE: Configuration file name BENCH-NAME: Name of the benchmark
  • config generate default in CONFIG-FILE for [BENCH-NAME...]
    Generates a configuration file for the given benchmarks using their default configuration CONFIG-FILE: Configuration file name BENCH-NAME: Name of the benchmark
  • config generate empty in CONFIG-FILE
    Generates an empty configuration file for the given benchmarks CONFIG-FILE: Configuration file name
  • config merge SRC in DST [-d --delete-source]
    Merges multiple configuration files. Fails in case of conflict SRC: Configuration file path source DST: Configuration file path destination -d --delete-source: Deletes the source config file given as argument for merging
  • config edit CONFIG-FILE for BENCH-NAME [-e --use-editor <EDITOR>] [-i --read-stdin] [-f --read-file <FILE>] [-j --read-json <JSON>]
    Edit configuration file at the given point CONFIG-FILE: Configuration file name BENCH-NAME: Name of the benchmark -e --use-editor <EDITOR>: Specify the prefered text editor used for editing the config file -i --read-stdin: Read the standard input for a Json document to edit the config file -f --read-file <FILE>: Use the given Json document to edit the config file -j --read-json <JSON>: Use inlined Json to edit the config file

Commands for displaying lists

  • list all benchmarks [-t --show-tags]
    List all implemented benchmarks -t --show-tags: Show the tags of the benchmarks
  • list all tags
    List all available tags
  • list benchmarks with tags any of [TAG...] [-t --show-tags]
    List all implemented benchmarks containing any of the given tags TAG: Tag of a benchmark -t --show-tags: Show the tags of the benchmarks
  • list benchmarks with tags all of [TAG...] [-t --show-tags]
    List all implemented benchmarks containing all of the given tags TAG: Tag of a benchmark -t --show-tags: Show the tags of the benchmarks
  • list benchmarks with tags exactly [TAG...] [-t --show-tags]
    List all implemented benchmarks containing exactly the given tags TAG: Tag of a benchmark -t --show-tags: Show the tags of the benchmarks
  • list benchmarks in BENCH-NAME [-t --show-tags]
    List all benchmarks in the given namespace BENCH-NAME: Name of the benchmark -t --show-tags: Show the tags of the benchmarks
  • list all parameters
    List all parameters
  • list all models
    List all models
  • list all local models
    List all local models

Command for solution file

  • solution print [SOLUTION-FILE...]
    Print out the given solution file(s) SOLUTION-FILE: File containing solution, as obtained using the --save-solution switch

Command for generating code

  • generate code using solution SOLUTION-FILE and model CODEGEN-MODEL-NAME [--fixed-point <json-config-file>] [--save-to <file>]
    Generate code for a specific model SOLUTION-FILE: File containing solution, as obtained using the --save-solution switch CODEGEN-MODEL-NAME: Name of the codegen model for which to generate code --fixed-point <json-config-file>: Apply fixed-point transform to the model --save-to <file>: Save the output to a file
  • generate code using solution SOLUTION-FILE for all models matching REGEXP [--fixed-point <json-config-file>] [--save-to <file>]
    Generate code for all models matching regexp SOLUTION-FILE: File containing solution, as obtained using the --save-solution switch REGEXP: Regular expression on model names --fixed-point <json-config-file>: Apply fixed-point transform to the model --save-to <file>: Save the output to a file
  • generate code using solution SOLUTION-FILE for inferred models [--fixed-point <json-config-file>] [--save-to <file>]
    Generate code for models inferred from the solution file SOLUTION-FILE: File containing solution, as obtained using the --save-solution switch --fixed-point <json-config-file>: Apply fixed-point transform to the model --save-to <file>: Save the output to a file
  • generate code for solutions [SOLUTION-FILE...] [--fixed-point <json-config-file>] [--save-to <FILE-NAME>] [--split-to <DIR>]
    Generate code for the models inferred from the solution files SOLUTION-FILE: File or Directory containing solutions, as obtained using the --save-solution switch --fixed-point <json-config-file>: Apply fixed-point transform to the model --save-to <FILE-NAME>: Generated code is saved to FILE-NAME. Will also save code for models that dont have a codegen destination --split-to <DIR>: Generated code is saved to DIR/<generated_code_destination>_costs_generated.ml (and __non_fp.ml).
  • check definitions of [MLFILE...]
    Check cost functions defined in the given .ml files MLFILE: File containing cost function definitions
  • generate code for benchmarks [BENCH-NAME...] [--split] [--out-dir <directory>] [--nsamples <strictly positive int>] [--bench-num <strictly positive int>] [--print-problem] [--plot] [--override-csv <filename>] [--full-plot-verbosity] [--plot-raw-workload <directory>] [--empirical-plot <full|q1,...,qn>]
    Auto-perform the benchmarks, inference and codegen for the given benchmarks BENCH-NAME: Name of the benchmark --split: Switch indicating that generated code should be split into submodules defined by Benchmark's generated code destination --out-dir <directory>: Destination directory of the auto-build result --nsamples <strictly positive int>: Number of samples per benchmark --bench-num <strictly positive int>: Number of benchmarks (i.e. random stacks) --print-problem: Prints problem as obtained after applying model to workload data --plot: Plot results of parameter inference --override-csv <filename>: Specify CSV file containing overrided variables for inference --full-plot-verbosity: Produces all (possibly redundant) plots --plot-raw-workload <directory>: For each workload, produces a file containing the plot of the raw data, in the specified directory --empirical-plot <full|q1,...,qn>: Options for plotting empirical data quantiles
  • generate code for models [BENCH-NAME...] [--split] [--out-dir <directory>] [--nsamples <strictly positive int>] [--bench-num <strictly positive int>] [--print-problem] [--plot] [--override-csv <filename>] [--full-plot-verbosity] [--plot-raw-workload <directory>] [--empirical-plot <full|q1,...,qn>]
    Auto-perform the benchmarks, inference and codegen for the given models BENCH-NAME: Name of the benchmark --split: Switch indicating that generated code should be split into submodules defined by Benchmark's generated code destination --out-dir <directory>: Destination directory of the auto-build result --nsamples <strictly positive int>: Number of samples per benchmark --bench-num <strictly positive int>: Number of benchmarks (i.e. random stacks) --print-problem: Prints problem as obtained after applying model to workload data --plot: Plot results of parameter inference --override-csv <filename>: Specify CSV file containing overrided variables for inference --full-plot-verbosity: Produces all (possibly redundant) plots --plot-raw-workload <directory>: For each workload, produces a file containing the plot of the raw data, in the specified directory --empirical-plot <full|q1,...,qn>: Options for plotting empirical data quantiles
  • generate code for parameters [BENCH-NAME...] [--split] [--out-dir <directory>] [--nsamples <strictly positive int>] [--bench-num <strictly positive int>] [--print-problem] [--plot] [--override-csv <filename>] [--full-plot-verbosity] [--plot-raw-workload <directory>] [--empirical-plot <full|q1,...,qn>]
    Auto-perform the benchmarks, inference and codegen for the given parameters BENCH-NAME: Name of the benchmark --split: Switch indicating that generated code should be split into submodules defined by Benchmark's generated code destination --out-dir <directory>: Destination directory of the auto-build result --nsamples <strictly positive int>: Number of samples per benchmark --bench-num <strictly positive int>: Number of benchmarks (i.e. random stacks) --print-problem: Prints problem as obtained after applying model to workload data --plot: Plot results of parameter inference --override-csv <filename>: Specify CSV file containing overrided variables for inference --full-plot-verbosity: Produces all (possibly redundant) plots --plot-raw-workload <directory>: For each workload, produces a file containing the plot of the raw data, in the specified directory --empirical-plot <full|q1,...,qn>: Options for plotting empirical data quantiles

Command for infering parameters of cost models

  • infer parameters for model LOCAL-MODEL-NAME on data WORKLOAD-DATA using REGRESSION-METHOD [--print-problem] [--dump-csv <filename>] [--plot] [--ridge-alpha <positive float>] [--lasso-alpha <positive float>] [--lasso-positive] [--report <filename>] [--override-csv <filename>] [--save-solution <filename>] [--dot-file <filename>] [--full-plot-verbosity] [--plot-raw-workload <directory>] [--empirical-plot <full|q1,...,qn>]
    Perform parameter inference LOCAL-MODEL-NAME: Name of the local model for which to infer parameter WORKLOAD-DATA: File or directory containing workload data REGRESSION-METHOD: Regression method used --print-problem: Prints problem as obtained after applying model to workload data --dump-csv <filename>: Dumps solution of inference to a CSV file --plot: Plot results of parameter inference --ridge-alpha <positive float>: Regularization parameter for ridge regression --lasso-alpha <positive float>: Regularization parameter for lasso regression --lasso-positive: Constrains solution of lasso regression to be positive --report <filename>: Produces a detailed report --override-csv <filename>: Specify CSV file containing overrided variables for inference --save-solution <filename>: Specify file to which inference solution will be saved for code generation --dot-file <filename>: Specify file to which dependency graph will be saved in graphviz format --full-plot-verbosity: Produces all (possibly redundant) plots --plot-raw-workload <directory>: For each workload, produces a file containing the plot of the raw data, in the specified directory --empirical-plot <full|q1,...,qn>: Options for plotting empirical data quantiles
  • infer parameters on data WORKLOAD-DATA using REGRESSION-METHOD [--print-problem] [--dump-csv <filename>] [--plot] [--ridge-alpha <positive float>] [--lasso-alpha <positive float>] [--lasso-positive] [--report <filename>] [--override-csv <filename>] [--save-solution <filename>] [--dot-file <filename>] [--full-plot-verbosity] [--plot-raw-workload <directory>] [--empirical-plot <full|q1,...,qn>]
    Perform parameter inference on data set WORKLOAD-DATA: Directory containing workload data REGRESSION-METHOD: Regression method used --print-problem: Prints problem as obtained after applying model to workload data --dump-csv <filename>: Dumps solution of inference to a CSV file --plot: Plot results of parameter inference --ridge-alpha <positive float>: Regularization parameter for ridge regression --lasso-alpha <positive float>: Regularization parameter for lasso regression --lasso-positive: Constrains solution of lasso regression to be positive --report <filename>: Produces a detailed report --override-csv <filename>: Specify CSV file containing overrided variables for inference --save-solution <filename>: Specify file to which inference solution will be saved for code generation --dot-file <filename>: Specify file to which dependency graph will be saved in graphviz format --full-plot-verbosity: Produces all (possibly redundant) plots --plot-raw-workload <directory>: For each workload, produces a file containing the plot of the raw data, in the specified directory --empirical-plot <full|q1,...,qn>: Options for plotting empirical data quantiles

Commands for benchmarking parts of the protocol

  • benchmark BENCH-NAME and save to FILENAME [--nsamples <strictly positive int>] [--seed <int>] [--bench-num <strictly positive int>] [--minor-heap-size <strictly positive int>] [-c --config-file <file>] [--dump-csv <filename>]
    Runs benchmarks BENCH-NAME: Name of the benchmark FILENAME: Name of the file where to save the workload data --nsamples <strictly positive int>: Number of samples per benchmark --seed <int>: RNG seed --bench-num <strictly positive int>: Number of benchmarks (i.e. random stacks) --minor-heap-size <strictly positive int>: Size of minor heap in words -c --config-file <file>: Specify a benchmark configuration file --dump-csv <filename>: Dumps raw benchmark results to CSV

Miscellaneous commands

  • generate default-config [--save-to <filename>]
    Show the default configurations for fixed-point code generation as json --save-to <filename>: save default config to file

Codec manual

Usage

  • octez-codec [global options] command [command options]
  • octez-codec --help (for global options)
  • octez-codec [global options] command --help (for command options)
  • octez-codec --version (for version information)

To browse the documentation

  • octez-codec [global options] man (for a list of commands)
  • octez-codec [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: data directory The directory where the Tezos codec will output logs. By default: '$HOME/.tezos-client'.

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Commands to handle encodings

  • list encodings
    List the registered encoding in Tezos.
  • dump encodings [--compact]
    Dump a JSON description of all registered encodings. --compact: Output JSON descriptions without extraneous whitespace characters
  • dump encoding id [--compact]
    Dump a JSON description of a given registered encoding. id: Encoding identifier --compact: Output JSON description without extraneous whitespace characters
  • encode id from data
    Encode the given JSON data into binary using the provided encoding identifier. id: Encoding identifier data: JSON file or data
  • decode id from data
    Decode the binary encoded data into JSON using the provided encoding identifier. id: Encoding identifier data: Hex-encoded binary-encoded data or name of file containing the data
  • display id from binary data
    Display the binary encoded data using the provided encoding identifier. id: Encoding identifier data: Hex-encoded binary-encoded data or name of file containing the data
  • display id from json data
    Display the JSON encoded data using the provided encoding identifier. id: Encoding identifier data: JSON file or data
  • describe id binary schema
    Describe the binary schema associated to the provided encoding identifier. id: Encoding identifier
  • describe id json schema
    Describe the JSON schema associated to the provided encoding identifier. id: Encoding identifier
  • slice data
    Attempts to slice an hex-encoded binary value with all known encodings. data: Hex-encoded binary-encoded data or name of file containing the data
  • slice data with encoding id [--format <FORMAT>]
    Slice an hex-encoded binary value with the specified encoding. data: Hex-encoded binary-encoded data or name of file containing the data id: Encoding identifier --format <FORMAT>: The format to print the output in: json, pretty, or waterfall. Defaults to `pretty`.

Node manual

The command line of the Octez node is documented in Unix man format, as shown below. You can also obtain this manual by running octez-node --help.

The manual briefly shows the available node commands. Each command accepts its own set of options and arguments, that you can discover by running octez-node <command> --help. For more details on the node invocation and configuration, see Node Configuration.

NAME

octez-node - The Octez node

SYNOPSIS

octez-node [COMMAND] …

DESCRIPTION

Entry point for initializing, configuring and running a Tezos node.

The identity command is meant to create and manage node identities. An identity uniquely identifies a peer on the network and consists of a cryptographic key pair as well as a proof-of-work stamp that certifies that enough CPU time has been dedicated to produce the identity, to avoid sybil attacks. An identity with enough proof-of-work is required to participate in the Tezos network, therefore this command is necessary to launch Tezos the first time.

The run command is meant to run the Tezos node. Most of its command line arguments corresponds to config file entries, and will have priority over the latter if used.

The replay command is meant to replay a previously validated block for debugging purposes.

The config command is meant to inspect and amend the configuration of the Tezos node. This command is complementary to manually editing the tezos node configuration file. Its arguments are a subset of the run command ones.

The upgrade command is meant to manage upgrades of the node.

The snapshot command is meant to export and import snapshots files.

The reconstruct command is meant to reconstruct the partial storage of a node running in full mode in order to recover a complete archive mode storage.

The storage command provides tools for introspecting and debugging the storage layer.

COMMANDS
config COMMAND …

Manage node configuration

dump-metrics [OPTION]…

Show all the openmetrics collected by the Tezos node

identity COMMAND …

Manage node identities

reconstruct [OPTION]…

Manage storage reconstruction

replay [--strict] [OPTION]… [<level>|<block_hash>|<alias>]…

Replay a set of previously validated blocks

run [OPTION]…

Run the Tezos node

snapshot COMMAND …

Manage snapshots

storage COMMAND …

Query the storage layer (EXPERIMENTAL)

upgrade [--status] [OPTION]… UPGRADE

Manage node upgrades

COMMON OPTIONS
--help[=FMT] (default=auto)

Show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined.

--version

Show version information.

EXIT STATUS

octez-node exits with:

0 on success.

123 on indiscriminate errors reported on standard error.

124 on command line parsing errors.

125 on unexpected internal errors (bugs).

EXAMPLES
Run in sandbox mode listening to RPC commands at localhost port 8732

octez-node run --sandbox=src/proto_alpha/parameters/sandbox-parameters.json --data-dir /custom/data/dir --rpc-addr localhost:8732

Run a node that accepts network connections

octez-node run

Proxy server manual

The command line of the Octez proxy server is documented in Unix man format, as shown below. You can also obtain this manual by running octez-proxy-server --help.

NAME

octez-proxy-server - Launches a server that is a readonly frontend to a Tezos node

SYNOPSIS

octez-proxy-server [OPTION]…

OPTIONS
-c CONFIG, --config=CONFIG

The configuration file. Fields (see corresponding options): endpoint (string), rpc_addr (string), rpc_tls (string), sym_block_caching_time (int), and data_dir (string).

-d DATA_DIR, --data-dir=DATA_DIR

Path to the data-dir of a running octez-node, for reading the `context` subdirectory to obtain data instead of using the ../raw/bytes RPC (hereby reducing the node’s IO).

-E ENDPOINT, --endpoint=ENDPOINT

The node to do requests to for obtaining data when needed.

-l, --log-requests

Log all requests to the node.

--rpc-addr=RPC_ADDR

The TCP socket at which this RPC server instance can be reached.

--rpc-tls=RPC_TLS

Enable TLS for this RPC server with the provided certificate and key.

--sym-block-caching-time=SYM_BLOCK_CACHING_TIME

The duration (in seconds) during which data for a symbolic block identifier (like head) is kept. Smaller values increase the endpoint’s load but give more up-to-date data. If omitted, defaulted to time_between_blocks (and causes extra RPCs to the endpoint to retrieve this value).

COMMON OPTIONS
--help[=FMT] (default=auto)

Show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined.

--version

Show version information.

EXIT STATUS

octez-proxy-server exits with:

0 on success.

123 on indiscriminate errors reported on standard error.

124 on command line parsing errors.

125 on unexpected internal errors (bugs).

BUGS

Report issues to https://gitlab.com/tezos/tezos/-/issues

DAC node manual (Experimental)

Usage

  • octez-dac-node [global options] command [command options]
  • octez-dac-node --help (for global options)
  • octez-dac-node [global options] command --help (for command options)
  • octez-dac-node --version (for version information)

To browse the documentation

  • octez-dac-node [global options] man (for a list of commands)
  • octez-dac-node [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: client data directory (absent: TEZOS_CLIENT_DIR env) The directory where the Tezos client will store all its data. If absent, its value is the value of the TEZOS_CLIENT_DIR environment variable. If TEZOS_CLIENT_DIR is itself not specified, defaults to $HOME/.tezos-client -n --no-base-dir-warnings: silence warnings about client data directory -c --config-file <path>: configuration file -t --timings: show RPC request times --chain <hash|tag>: chain on which to apply contextual commands (commands dependent on the context associated with the specified chain). Possible tags are 'main' and 'test'. Defaults to `main`. -b --block <hash|level|tag>: block on which to apply contextual commands (commands dependent on the context associated with the specified block). Possible tags include 'head' and 'genesis' +/- an optional offset (e.g. "octez-client -b head-1 get timestamp"). Note that block queried must exist in node's storage. Defaults to `head`. -w --wait <none|<int>>: how many confirmation blocks are needed before an operation is considered included -p --protocol <hash>: use commands of a specific protocol -l --log-requests: log all requests to the node --better-errors: Error reporting is more detailed. Can be used if a call to an RPC fails or if you don't know the input accepted by the RPC. It may happen that the RPC calls take more time however. -A --addr <IP addr|host>: [DEPRECATED: use --endpoint instead] IP address of the node -P --port <number>: [DEPRECATED: use --endpoint instead] RPC port of the node -S --tls: [DEPRECATED: use --endpoint instead] use TLS to connect to node. -m --media-type <json, binary, any or default>: Sets the "media-type" value for the "accept" header for RPC requests to the node. The media accept header indicates to the node which format of data serialisation is supported. Use the value "json" for serialisation to the JSON format. Use the value "binary" for faster but less human-readable binary serialisation format. -E --endpoint <uri>: HTTP(S) endpoint of the node RPC interface; e.g. 'http://localhost:8732' -s --sources <path>: path to JSON file containing sources for --mode light. Example file content: {"min_agreement": 1.0, "uris": ["http://localhost:8732", "https://localhost:8733"]} -R --remote-signer <uri>: URI of the remote signer -f --password-filename <filename>: path to the password filename -M --mode <client|light|mockup|proxy>: how to interact with the node Defaults to `client`.

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Commands related to the DAC node

  • run [--data-dir <data-dir>]
    Run the DAC node. Use --endpoint to configure the Octez node to connect to (See Global options). --data-dir <data-dir>: The path to the DAC node data directory. Default value is $HOME/.tezos-dac-node Defaults to `$HOME/.tezos-dac-node`.
  • configure as coordinator with data availability committee members [bls-public-key...] [--data-dir <data-dir>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--reveal-data-dir <reveal-data-dir>] [--allow-v1-api]
    Configure DAC node in coordinator mode. bls-public-key: BLS public key of committee member. A BLS12-381 public key which belongs to a tz4 account. --data-dir <data-dir>: The path to the DAC node data directory. Default value is $HOME/.tezos-dac-node Defaults to `$HOME/.tezos-dac-node`. --rpc-addr <rpc-address|ip>: The address the DAC node listens to. Default value is 127.0.0.1. Defaults to `127.0.0.1`. --rpc-port <rpc-port>: The port the DAC node listens to. Default value is 10832. Defaults to `10832`. --reveal-data-dir <reveal-data-dir>: The directory where reveal preimage pages are saved. Defaults to `$HOME/.tezos-smart-rollup-node/wasm_2_0_0`. --allow-v1-api: Run dac node with both V0 and V1 (WIP) API.
  • configure as committee member with coordinator coordinator-rpc-address and signer bls-public-key-hash [--data-dir <data-dir>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--reveal-data-dir <reveal-data-dir>] [--allow-v1-api]
    Configure DAC node in committee member mode. coordinator-rpc-address: The RPC address of the DAC coordinator in the form of <rpc_address>:<rpc_port>. bls-public-key-hash: BLS public key hash to use as the signer. A tz4 address. --data-dir <data-dir>: The path to the DAC node data directory. Default value is $HOME/.tezos-dac-node Defaults to `$HOME/.tezos-dac-node`. --rpc-addr <rpc-address|ip>: The address the DAC node listens to. Default value is 127.0.0.1. Defaults to `127.0.0.1`. --rpc-port <rpc-port>: The port the DAC node listens to. Default value is 10832. Defaults to `10832`. --reveal-data-dir <reveal-data-dir>: The directory where reveal preimage pages are saved. Defaults to `$HOME/.tezos-smart-rollup-node/wasm_2_0_0`. --allow-v1-api: Run dac node with both V0 and V1 (WIP) API.
  • configure as observer with coordinator coordinator-rpc-address and committee member rpc addresses [committee-member-rpc-address...] [--data-dir <data-dir>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--reveal-data-dir <reveal-data-dir>] [--timeout <timeout>] [--allow-v1-api]
    Configure DAC node in observer mode. coordinator-rpc-address: The RPC address of the DAC coordinator in the form of <rpc_address>:<rpc_port>. committee-member-rpc-address: The RPC address of the DAC committee member in the form of <rpc_address>:<rpc_port>. --data-dir <data-dir>: The path to the DAC node data directory. Default value is $HOME/.tezos-dac-node Defaults to `$HOME/.tezos-dac-node`. --rpc-addr <rpc-address|ip>: The address the DAC node listens to. Default value is 127.0.0.1. Defaults to `127.0.0.1`. --rpc-port <rpc-port>: The port the DAC node listens to. Default value is 10832. Defaults to `10832`. --reveal-data-dir <reveal-data-dir>: The directory where reveal preimage pages are saved. Defaults to `$HOME/.tezos-smart-rollup-node/wasm_2_0_0`. --timeout <timeout>: Timeout, in seconds, when requesting a missing page from Committee Members. Defaults to 6.0 seconds. --allow-v1-api: Run dac node with both V0 and V1 (WIP) API.

Commands for editing and viewing the client's config file

  • config show
    Show the current config (config file content + command line arguments) or the mockup config files if `--mode mockup` is specified.
  • config reset
    Reset the config file to the factory defaults.
  • config update
    Update the config based on the current cli values. Loads the current configuration (default or as specified with `-config-file`), applies alterations from other command line arguments (such as the node's address, etc.), and overwrites the updated configuration file.
  • config init [-o --output <path>] [--bootstrap-accounts <path>] [--protocol-constants <path>]
    Create config file(s) based on the current CLI values. If the `-file` option is not passed, this will initialize the default config file, based on default parameters, altered by other command line options (such as the node's address, etc.). Otherwise, it will create a new config file, based on the default parameters (or the the ones specified with `-config-file`), altered by other command line options. If `-mode mockup` is specified, this will initialize the mockup's default files instead of the config file. Use `-bootstrap-accounts` and `-protocol-constants` to specify custom paths. The command will always fail if file(s) to create exist already -o --output <path>: path at which to create the file Defaults to `$HOME/.tezos-client/config`. --bootstrap-accounts <path>: path at which to create the file Defaults to `$HOME/.tezos-client/bootstrap-accounts.json`. --protocol-constants <path>: path at which to create the file Defaults to `$HOME/.tezos-client/protocol-constants.json`.

Miscellaneous commands

  • list understood protocols
    List the protocol versions that this client understands.

DAC client manual (Experimental)

Usage

  • octez-dac-client [global options] command [command options]
  • octez-dac-client --help (for global options)
  • octez-dac-client [global options] command --help (for command options)
  • octez-dac-client --version (for version information)

To browse the documentation

  • octez-dac-client [global options] man (for a list of commands)
  • octez-dac-client [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: client data directory (absent: TEZOS_CLIENT_DIR env) The directory where the Tezos client will store all its data. If absent, its value is the value of the TEZOS_CLIENT_DIR environment variable. If TEZOS_CLIENT_DIR is itself not specified, defaults to $HOME/.tezos-client -n --no-base-dir-warnings: silence warnings about client data directory -c --config-file <path>: configuration file -t --timings: show RPC request times --chain <hash|tag>: chain on which to apply contextual commands (commands dependent on the context associated with the specified chain). Possible tags are 'main' and 'test'. Defaults to `main`. -b --block <hash|level|tag>: block on which to apply contextual commands (commands dependent on the context associated with the specified block). Possible tags include 'head' and 'genesis' +/- an optional offset (e.g. "octez-client -b head-1 get timestamp"). Note that block queried must exist in node's storage. Defaults to `head`. -w --wait <none|<int>>: how many confirmation blocks are needed before an operation is considered included -p --protocol <hash>: use commands of a specific protocol -l --log-requests: log all requests to the node --better-errors: Error reporting is more detailed. Can be used if a call to an RPC fails or if you don't know the input accepted by the RPC. It may happen that the RPC calls take more time however. -A --addr <IP addr|host>: [DEPRECATED: use --endpoint instead] IP address of the node -P --port <number>: [DEPRECATED: use --endpoint instead] RPC port of the node -S --tls: [DEPRECATED: use --endpoint instead] use TLS to connect to node. -m --media-type <json, binary, any or default>: Sets the "media-type" value for the "accept" header for RPC requests to the node. The media accept header indicates to the node which format of data serialisation is supported. Use the value "json" for serialisation to the JSON format. Use the value "binary" for faster but less human-readable binary serialisation format. -E --endpoint <uri>: HTTP(S) endpoint of the node RPC interface; e.g. 'http://localhost:8732' -s --sources <path>: path to JSON file containing sources for --mode light. Example file content: {"min_agreement": 1.0, "uris": ["http://localhost:8732", "https://localhost:8733"]} -R --remote-signer <uri>: URI of the remote signer -f --password-filename <filename>: path to the password filename -M --mode <client|light|mockup|proxy>: how to interact with the node Defaults to `client`.

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Dac client commands for interacting with a Dac node

  • send payload to coordinator DAC coordinator rpc address parameter with content hex payload [--wait-for-threshold <wait-for-threshold>]
    Send a list of strings to the DAC coordinator DAC coordinator rpc address parameter: The address of the DAC coordinator A http/https url or an address in the form of <ip_addr>:<port>. hex payload: A hex encoded payload A hex encoded string --wait-for-threshold <wait-for-threshold>: The amount of signatures required from a certificate before the client returns
  • send payload to coordinator DAC coordinator rpc address parameter from file payload filename [--wait-for-threshold <wait-for-threshold>]
    Send the contents of a file as payload to the DAC coordinator. DAC coordinator rpc address parameter: The address of the DAC coordinator A http/https url or an address in the form of <ip_addr>:<port>. payload filename: A filename containing a payload Payload must be in binary format --wait-for-threshold <wait-for-threshold>: The amount of signatures required from a certificate before the client returns
  • get certificate from coordinator DAC coordinator rpc address parameter for root hash hex root hash
    Get a certificate from the coordinator DAC coordinator rpc address parameter: The address of the DAC coordinator A http/https url or an address in the form of <ip_addr>:<port>. hex root hash: A hex encoded root hash

Commands for editing and viewing the client's config file

  • config show
    Show the current config (config file content + command line arguments) or the mockup config files if `--mode mockup` is specified.
  • config reset
    Reset the config file to the factory defaults.
  • config update
    Update the config based on the current cli values. Loads the current configuration (default or as specified with `-config-file`), applies alterations from other command line arguments (such as the node's address, etc.), and overwrites the updated configuration file.
  • config init [-o --output <path>] [--bootstrap-accounts <path>] [--protocol-constants <path>]
    Create config file(s) based on the current CLI values. If the `-file` option is not passed, this will initialize the default config file, based on default parameters, altered by other command line options (such as the node's address, etc.). Otherwise, it will create a new config file, based on the default parameters (or the the ones specified with `-config-file`), altered by other command line options. If `-mode mockup` is specified, this will initialize the mockup's default files instead of the config file. Use `-bootstrap-accounts` and `-protocol-constants` to specify custom paths. The command will always fail if file(s) to create exist already -o --output <path>: path at which to create the file Defaults to `$HOME/.tezos-client/config`. --bootstrap-accounts <path>: path at which to create the file Defaults to `$HOME/.tezos-client/bootstrap-accounts.json`. --protocol-constants <path>: path at which to create the file Defaults to `$HOME/.tezos-client/protocol-constants.json`.

Miscellaneous commands

  • list understood protocols
    List the protocol versions that this client understands.

Smart rollup node manual

Usage

  • octez-smart-rollup-node [global options] command [command options]
  • octez-smart-rollup-node --help (for global options)
  • octez-smart-rollup-node [global options] command --help (for command options)
  • octez-smart-rollup-node --version (for version information)

To browse the documentation

  • octez-smart-rollup-node [global options] man (for a list of commands)
  • octez-smart-rollup-node [global options] man -v 3 (for the full manual)

Global options (must come before the command)

-d --base-dir <path>: client data directory (absent: TEZOS_CLIENT_DIR env) The directory where the Tezos client will store all its data. If absent, its value is the value of the TEZOS_CLIENT_DIR environment variable. If TEZOS_CLIENT_DIR is itself not specified, defaults to $HOME/.tezos-client -n --no-base-dir-warnings: silence warnings about client data directory -t --timings: show RPC request times -l --log-requests: log all requests to the node --better-errors: Error reporting is more detailed. Can be used if a call to an RPC fails or if you don't know the input accepted by the RPC. It may happen that the RPC calls take more time however. -A --addr <IP addr|host>: [DEPRECATED: use --endpoint instead] IP address of the node -P --port <number>: [DEPRECATED: use --endpoint instead] RPC port of the node -S --tls: [DEPRECATED: use --endpoint instead] use TLS to connect to node. -E --endpoint <uri>: HTTP(S) endpoint of the node RPC interface; e.g. 'http://localhost:8732' -R --remote-signer <uri>: URI of the remote signer -f --password-filename <filename>: path to the password filename

Access the documentation

  • man [keyword...] [-v --verbosity <0|1|2|3>] [--format <plain|colors|html>]
    Print documentation of commands. Add search keywords to narrow list. Will display only the commands by default, unless [-verbosity <2|3>] is passed or the list of matching commands if less than 3. keyword: keyword to search for If several are given they must all appear in the command. -v --verbosity <0|1|2|3>: level of details 0. Only shows command mnemonics, without documentation. 1. Shows command mnemonics with short descriptions. 2. Show commands and arguments with short descriptions 3. Show everything --format <plain|colors|html>: the manual's output format Defaults to `plain`.

Commands related to the smart rollup node.

  • init mode config for smart-rollup-address with operators [operator...] [--force] [--data-dir <data-dir>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--metrics-addr <ADDR:PORT or :PORT (by default ADDR is localhost and PORT is 9933)>] [--loser-mode <mode>] [--reconnection-delay <delay>] [--dal-node <dal-node-endpoint>] [--dac-observer <dac-observer-endpoint>] [--dac-timeout <seconds>] [--injector-retention-period <blocks>] [--injector-attempts <number>] [--injection-ttl <number>] [--index-buffer-size <<nb_entries>>] [--index-buffer-size <<nb_entries>>] [--log-kernel-debug] [--boot-sector-file <file>]
    Configure the smart rollup node. mode: The mode for the rollup node (observer, accuser, bailout, batcher, maintenance, operator, custom:publish,add_messages,cement,timeout,refute,recover) - observer: Only follows the chain, reconstructs and interprets inboxes - accuser: Only publishes commitments for conflicts and play refutation games - bailout: Only defends and cements, does not publish any new commitments - batcher: Accepts transactions in its queue and batches them on the L1 - maintenance: Follows the chain and publishes commitments, cement and refute - operator: Equivalent to maintenance + batcher - custom:publish,add_messages,cement,timeout,refute,recover: In this mode, the system handles only the specific operation kinds:[publish, add_messages, cement, timeout, refute, recover]. This allows for tailored control and flexibility. smart-rollup-address: The smart rollup address Can be a literal or an alias (autodetected in order). Use 'alias:name' or 'text:literal' to force. operator: Public key hash, or alias, of a smart rollup node operator. An operator can be specialized to a particular purpose by prefixing its key or alias by said purpose, e.g. operating:alias_of_my_operator. The possible purposes are: operatingbatchingcementingrecovering. --force: Overwrites the configuration file when it exists. --data-dir <data-dir>: The path to the smart rollup node data directory. Default value is $HOME/.tezos-smart-rollup-node Defaults to `$HOME/.tezos-smart-rollup-node`. --rpc-addr <rpc-address|ip>: The address the smart rollup node listens to. Default value is 127.0.0.1 --rpc-port <rpc-port>: The port the smart rollup node listens to. Default value is 8932 --metrics-addr <ADDR:PORT or :PORT (by default ADDR is localhost and PORT is 9933)>: The address of the smart rollup node metrics server. --loser-mode <mode>: Set the rollup node failure points (for test only!). --reconnection-delay <delay>: The first reconnection delay, in seconds, to wait before reconnecting to the Tezos node. The default delay is 2.0. The actual delay varies to follow a randomized exponential backoff (capped to 1.5h): [1.5^reconnection_attempt * delay ± 50%]. --dal-node <dal-node-endpoint>: The address of the dal node from which the smart rollup node downloads slots. When not provided, the rollup node will not support the DAL. In production, a DAL node must be provided if DAL is enabled and used in the rollup. --dac-observer <dac-observer-endpoint>: The address of the DAC observer node from which the smart rollup node downloads preimages requested through the reveal channel. --dac-timeout <seconds>: Timeout in seconds for which the DAC observer client will wait for a preimage --injector-retention-period <blocks>: The number of blocks the injector keeps in memory. Decrease to free memory, and increase to be able to query information about included messages for longer. Default value is 2048 --injector-attempts <number>: The number of attempts that the injector will make to inject an operation when it fails. Default value is 100 --injection-ttl <number>: The number of blocks after which an operation that is injected but never included is retried. Default value is 120 --index-buffer-size <<nb_entries>>: The maximum cache size in memory before it is flushed to disk, used for indexes of the store. --index-buffer-size <<nb_entries>>: The maximum cache size in memory before it is flushed to disk, used for indexes of the store. --log-kernel-debug: Log the kernel debug output to kernel.log in the data directory --boot-sector-file <file>: Path to the boot sector. The argument is optional, if the rollup was originated via the smart rollup originate operation, the smart rollup node will fetch the boot sector itself. This argument is required only if it's a bootstrapped smart rollup.
  • run mode for smart-rollup-address with operators [operator...] [--data-dir <data-dir>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--metrics-addr <ADDR:PORT or :PORT (by default ADDR is localhost and PORT is 9933)>] [--loser-mode <mode>] [--reconnection-delay <delay>] [--dal-node <dal-node-endpoint>] [--dac-observer <dac-observer-endpoint>] [--dac-timeout <seconds>] [--injector-retention-period <blocks>] [--injector-attempts <number>] [--injection-ttl <number>] [--index-buffer-size <<nb_entries>>] [--irmin-cache-size <<nb_entries>>] [--log-kernel-debug] [--log-kernel-debug-file <file>] [--boot-sector-file <file>]
    Run the rollup node daemon. Arguments overwrite values provided in the configuration file. mode: The mode for the rollup node (observer, accuser, bailout, batcher, maintenance, operator, custom:publish,add_messages,cement,timeout,refute,recover) - observer: Only follows the chain, reconstructs and interprets inboxes - accuser: Only publishes commitments for conflicts and play refutation games - bailout: Only defends and cements, does not publish any new commitments - batcher: Accepts transactions in its queue and batches them on the L1 - maintenance: Follows the chain and publishes commitments, cement and refute - operator: Equivalent to maintenance + batcher - custom:publish,add_messages,cement,timeout,refute,recover: In this mode, the system handles only the specific operation kinds:[publish, add_messages, cement, timeout, refute, recover]. This allows for tailored control and flexibility. smart-rollup-address: The smart rollup address Can be a literal or an alias (autodetected in order). Use 'alias:name' or 'text:literal' to force. operator: Public key hash, or alias, of a smart rollup node operator. An operator can be specialized to a particular purpose by prefixing its key or alias by said purpose, e.g. operating:alias_of_my_operator. The possible purposes are: operatingbatchingcementingrecovering. --data-dir <data-dir>: The path to the smart rollup node data directory. Default value is $HOME/.tezos-smart-rollup-node Defaults to `$HOME/.tezos-smart-rollup-node`. --rpc-addr <rpc-address|ip>: The address the smart rollup node listens to. Default value is 127.0.0.1 --rpc-port <rpc-port>: The port the smart rollup node listens to. Default value is 8932 --metrics-addr <ADDR:PORT or :PORT (by default ADDR is localhost and PORT is 9933)>: The address of the smart rollup node metrics server. --loser-mode <mode>: Set the rollup node failure points (for test only!). --reconnection-delay <delay>: The first reconnection delay, in seconds, to wait before reconnecting to the Tezos node. The default delay is 2.0. The actual delay varies to follow a randomized exponential backoff (capped to 1.5h): [1.5^reconnection_attempt * delay ± 50%]. --dal-node <dal-node-endpoint>: The address of the dal node from which the smart rollup node downloads slots. When not provided, the rollup node will not support the DAL. In production, a DAL node must be provided if DAL is enabled and used in the rollup. --dac-observer <dac-observer-endpoint>: The address of the DAC observer node from which the smart rollup node downloads preimages requested through the reveal channel. --dac-timeout <seconds>: Timeout in seconds for which the DAC observer client will wait for a preimage --injector-retention-period <blocks>: The number of blocks the injector keeps in memory. Decrease to free memory, and increase to be able to query information about included messages for longer. Default value is 2048 --injector-attempts <number>: The number of attempts that the injector will make to inject an operation when it fails. Default value is 100 --injection-ttl <number>: The number of blocks after which an operation that is injected but never included is retried. Default value is 120 --index-buffer-size <<nb_entries>>: The maximum cache size in memory before it is flushed to disk, used for indexes of the store. --irmin-cache-size <<nb_entries>>: Size of Irmin cache in number of entries --log-kernel-debug: Log the kernel debug output to kernel.log in the data directory --log-kernel-debug-file <file>: --boot-sector-file <file>: Path to the boot sector. The argument is optional, if the rollup was originated via the smart rollup originate operation, the smart rollup node will fetch the boot sector itself. This argument is required only if it's a bootstrapped smart rollup.
  • run [--data-dir <data-dir>] [--mode <mode>] [--rollup <smart-rollup-address>] [--rpc-addr <rpc-address|ip>] [--rpc-port <rpc-port>] [--metrics-addr <ADDR:PORT or :PORT (by default ADDR is localhost and PORT is 9933)>] [--loser-mode <mode>] [--reconnection-delay <delay>] [--dal-node <dal-node-endpoint>] [--dac-observer <dac-observer-endpoint>] [--dac-timeout <seconds>] [--injector-retention-period <blocks>] [--injector-attempts <number>] [--injection-ttl <number>] [--index-buffer-size <<nb_entries>>] [--index-buffer-size <<nb_entries>>] [--log-kernel-debug] [--log-kernel-debug-file <file>] [--boot-sector-file <file>]
    Run the rollup node daemon (deprecated). --data-dir <data-dir>: The path to the smart rollup node data directory. Default value is $HOME/.tezos-smart-rollup-node Defaults to `$HOME/.tezos-smart-rollup-node`. --mode <mode>: The mode for the rollup node (observer, accuser, bailout, batcher, maintenance, operator, custom:publish,add_messages,cement,timeout,refute,recover) - observer: Only follows the chain, reconstructs and interprets inboxes - accuser: Only publishes commitments for conflicts and play refutation games - bailout: Only defends and cements, does not publish any new commitments - batcher: Accepts transactions in its queue and batches them on the L1 - maintenance: Follows the chain and publishes commitments, cement and refute - operator: Equivalent to maintenance + batcher - custom:publish,add_messages,cement,timeout,refute,recover: In this mode, the system handles only the specific operation kinds:[publish, add_messages, cement, timeout, refute, recover]. This allows for tailored control and flexibility. (required when no configuration file exists) --rollup <smart-rollup-address>: The smart rollup address (required when no configuration file exists) --rpc-addr <rpc-address|ip>: The address the smart rollup node listens to. Default value is 127.0.0.1 --rpc-port <rpc-port>: The port the smart rollup node listens to. Default value is 8932 --metrics-addr <ADDR:PORT or :PORT (by default ADDR is localhost and PORT is 9933)>: The address of the smart rollup node metrics server. --loser-mode <mode>: Set the rollup node failure points (for test only!). --reconnection-delay <delay>: The first reconnection delay, in seconds, to wait before reconnecting to the Tezos node. The default delay is 2.0. The actual delay varies to follow a randomized exponential backoff (capped to 1.5h): [1.5^reconnection_attempt * delay ± 50%]. --dal-node <dal-node-endpoint>: The address of the dal node from which the smart rollup node downloads slots. When not provided, the rollup node will not support the DAL. In production, a DAL node must be provided if DAL is enabled and used in the rollup. --dac-observer <dac-observer-endpoint>: The address of the DAC observer node from which the smart rollup node downloads preimages requested through the reveal channel. --dac-timeout <seconds>: Timeout in seconds for which the DAC observer client will wait for a preimage --injector-retention-period <blocks>: The number of blocks the injector keeps in memory. Decrease to free memory, and increase to be able to query information about included messages for longer. Default value is 2048 --injector-attempts <number>: The number of attempts that the injector will make to inject an operation when it fails. Default value is 100 --injection-ttl <number>: The number of blocks after which an operation that is injected but never included is retried. Default value is 120 --index-buffer-size <<nb_entries>>: The maximum cache size in memory before it is flushed to disk, used for indexes of the store. --index-buffer-size <<nb_entries>>: The maximum cache size in memory before it is flushed to disk, used for indexes of the store. --log-kernel-debug: Log the kernel debug output to kernel.log in the data directory --log-kernel-debug-file <file>: --boot-sector-file <file>: Path to the boot sector. The argument is optional, if the rollup was originated via the smart rollup originate operation, the smart rollup node will fetch the boot sector itself. This argument is required only if it's a bootstrapped smart rollup.
  • show supported protocols
    Shows the protocols supported by this rollup node.
  • dump-metrics
    dump the rollup node available metrics in CSV format.