Command Line Interface

This document is a prettier output of the documentation produced by the command man of the different Tezos binaries. You can obtain similar pages using shell commands such as (indicating the appropriate protocol):

tezos-client -protocol <protocol_hash> man -verbosity 3

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

Client manual

Usage

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

To browse the documentation

  • octez-client [global options] man (for a list of commands)
  • octez-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 -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 for managing FA1.2-compatible smart contracts

  • check contract contract implements fa1.2
    Check that a contract is FA1.2-compatible. contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force.
  • from fa1.2 contract contract get balance for from [-G --gas <gas>] [--payer <payer>] [--unparsing-mode <mode>]
    Ask for an address's balance offchain contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. from: name or address of the account to lookup (also the source contract) Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. -G --gas <gas>: Initial quantity of gas for typechecking and execution --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`.
  • from fa1.2 contract contract get allowance on owner as operator [-G --gas <gas>] [--payer <payer>] [--unparsing-mode <mode>]
    Ask for an address's allowance offchain contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. owner: name or address of the account giving the allowance Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. operator: name or address of the account receiving the allowance Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. -G --gas <gas>: Initial quantity of gas for typechecking and execution --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`.
  • from fa1.2 contract contract get total supply [-G --gas <gas>] [--payer <payer>] [--unparsing-mode <mode>]
    Ask for the contract's total token supply offchain contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. -G --gas <gas>: Initial quantity of gas for typechecking and execution --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`.
  • from fa1.2 contract contract get balance for from callback on callback [--callback-entrypoint <name>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Ask for an address's balance using a callback contract contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. from: name or address of the account to lookup (also the source contract) Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. callback: name or address of the callback contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --callback-entrypoint <name>: Entrypoint the view should use to callback to --tez-amount <amount>: amount in ꜩ Defaults to `0`. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • from fa1.2 contract contract get allowance on from as to callback on callback [--callback-entrypoint <name>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Ask for an address's allowance using a callback contract contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. from: name or address of the account giving the allowance Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. to: name or address of the account receiving the allowance Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. callback: name or address of the callback contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --callback-entrypoint <name>: Entrypoint the view should use to callback to --tez-amount <amount>: amount in ꜩ Defaults to `0`. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • from fa1.2 contract contract get total supply as from callback on callback [--callback-entrypoint <name>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Ask for a contract's total token supply using a callback contract contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. from: name or address of the source account Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. callback: name or address of the callback contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --callback-entrypoint <name>: Entrypoint the view should use to callback to --tez-amount <amount>: amount in ꜩ Defaults to `0`. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • from fa1.2 contract contract transfer amount from from to to [--as <as>] [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Transfer tokens between two given accounts contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. amount: number of tokens from: name or address of the sender Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. to: name or address of the receiver Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --as <as>: name or address of the caller of the contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --tez-amount <amount>: amount in ꜩ Defaults to `0`. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • from fa1.2 contract contract as as approve amount from from [--tez-amount <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Allow account to transfer an amount of token contract: name or address of the FA1.2-compatible contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. as: name or address of the sender Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. amount: number of tokens from: name or address to approve withdrawal Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --tez-amount <amount>: amount in ꜩ Defaults to `0`. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • multiple fa1.2 transfers from src using transfers.json [--default-fee <amount>] [--as <as>] [-D --dry-run] [--verbose-signing] [-G --default-gas-limit <amount>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Execute multiple token transfers from a single source account. If one of the token transfers fails, none of them are executed. src: name or address of the source of the transfers Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. transfers.json: List of token transfers to inject from the source contract in JSON format (as a file or string). The JSON must be an array of objects of the form: '[ {"token_contract": address or alias, "destination": address or alias, "amount": non-negative integer (, <field>: <val> ...) } (, ...) ]', where an optional <field> can either be "tez-amount", "fee", "gas-limit" or "storage-limit". The complete schema can be inspected via `tezos-codec describe 014-PtKathma.fa1.2.token_transfer json schema`. --default-fee <amount>: default fee in ꜩ to pay to the baker for each transaction --as <as>: name or address of the caller of the contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --default-gas-limit <amount>: Set the default gas limit for each transaction instead of letting the client decide based on a simulation -S --default-storage-limit <amount>: Set the default storage limit for each transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.

Commands for stress-testing the network

  • stresstest transfer using sources.json [--seed <int>] [--tps <float>] [--fresh-probability <float in [0;1]>] [--smart-contract-parameters <JSON file with smart contract parameters>] [--strategy <fixed:mutez | evaporation:[0;1]>] [--fee <amount>] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [--transfers <integer>] [--single-op-per-pkh-per-block] [--level-limit <integer | +integer>] [-v --verbose] [-V --debug]
    Generate random transactions sources.json: List of accounts from which to perform transfers in JSON format. The input JSON must be an array of objects of the form {"pkh":"<pkh>","pk":"<pk>","sk":"<sk>"} or {"alias":"<alias from wallet>"} or {"pkh":"<pkh from wallet>"} with the pkh, pk and sk encoded in B58 form." --seed <int>: random seed --tps <float>: transactions per seconds target --fresh-probability <float in [0;1]>: Probability for each transaction's destination to be a fresh account. The default value is 0.001. This new account may then be used as source or destination of subsequent transactions, just like the accounts that were initially provided to the command. Note that when [--single-op-per-pkh-per-block] is set, the new account will not be used as source until the head changes. --smart-contract-parameters <JSON file with smart contract parameters>: A JSON object that maps smart contract aliases to objects with three fields: probability in [0;1], invocation_fee, and invocation_gas_limit. --strategy <fixed:mutez | evaporation:[0;1]>: wealth redistribution strategy --fee <amount>: fee in ꜩ to pay to the baker -G --gas-limit <amount>: Set the gas limit of the transaction instead of using the default value of 1600 -S --storage-limit <amount>: Set the storage limit of the transaction instead of using the default value of 0 --transfers <integer>: total number of transfers to perform, unbounded if not specified --single-op-per-pkh-per-block: ensure that the operations are not rejected by limiting the injection to 1 operation per public_key_hash per block. --level-limit <integer | +integer>: Level at which the stresstest will stop (if prefixed by '+', the level is relative to the current head) -v --verbose: Display detailed logs of the injected operations -V --debug: Display debug logs
  • stresstest estimate gas
    Output gas estimations for transactions that stresstest uses

Utility Commands

  • sign message message for src [-b --branch <hash|tag>]
    Sign a message and display it using the failing_noop operation. This operation is not executable in the protocol. Please note that signing/checking an arbitrary message in itself is not sufficient to verify a key ownership message: message to sign src: name of the signer contract Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. -b --branch <hash|tag>: Block hash used to create the no-op operation to sign (possible tags are 'head' and 'genesis'). Defaults to 'genesis'. Note that the the genesis block hash is network-dependent. Defaults to `genesis`.
  • check that message message was signed by signer to produce signature [-b --branch <hash|tag>] [-q --quiet]
    Check the signature of an arbitrary message using the failing_noop operation. Please note that signing/checking an arbitrary message in itself is not sufficient to verify a key ownership. message: signed message signer: name of the signer contract signature: the signature to check -b --branch <hash|tag>: Block hash used to create the no-op operation to sign (possible tags are 'head' and 'genesis'). Defaults to 'genesis'. Note that the the genesis block hash is network-dependent. Defaults to `genesis`. -q --quiet: Use only exit codes
  • sign block unsigned block header for delegate
    Sign an arbitrary unsigned block header for a given delegate and return the signed block. unsigned block header: A hex or JSON encoded unsigned block header delegate: signing delegate 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.

Commands for working with Sapling transactions

  • sapling gen key new [-f --force] [--unencrypted]
    Generate a new sapling key. new: new sapling_key alias -f --force: overwrite existing sapling_key --unencrypted: Do not encrypt the key on-disk (for testing and debugging).
  • sapling use key sapling-key for contract contract [--memo-size <memo-size>]
    Use a sapling key for a contract. sapling-key: Sapling key to use for the contract. contract: Contract the key will be used on. Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --memo-size <memo-size>: Expected length for message of Sapling transaction
  • sapling import key new [-f --force] [--unencrypted] [--mnemonic <mnemonic>]
    Restore a sapling key from mnemonic. new: new sapling_key alias -f --force: overwrite existing sapling_key --unencrypted: Do not encrypt the key on-disk (for testing and debugging). --mnemonic <mnemonic>: Mnemonic as an option, only used for testing and debugging.
  • sapling derive key new from name at index child-index [-f --force] [--for-contract <for-contract>] [--unencrypted] [--memo-size <memo-size>]
    Derive a key from an existing one using zip32. new: new sapling_key alias name: existing sapling_key alias child-index: Index of the child to derive. -f --force: overwrite existing sapling_key --for-contract <for-contract>: name of the contract to associate new key with Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --unencrypted: Do not encrypt the key on-disk (for testing and debugging). --memo-size <memo-size>: Expected length for message of Sapling transaction
  • sapling gen address name [--address-index <idx>]
    Generate an address for a key referenced by alias. name: existing sapling_key alias --address-index <idx>: index of the address to generate
  • sapling export key name in file
    Save a sapling viewing key in a JSON file. name: existing sapling_key alias file: Filename.
  • sapling get balance for sapling-key in contract contract [-v --verbose]
    Get balance associated with given sapling key and contract sapling-key: Sapling key we get balance for. contract: Contract we get balance from. Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. -v --verbose: Print the collection of non-spent inputs.
  • sapling list keys
    List sapling keys.

Commands for managing a multisig smart contract

  • show supported multisig hashes
    Show the hashes of the supported multisig contracts.
  • show multisig script
    Show the script of the recommended multisig contract.
  • deploy multisig new_multisig transferring qty from src with threshold threshold on public keys [key...] [--fee <amount>] [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [--delegate <address>] [-f --force] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--verbose-signing]
    Originate a new multisig contract. new_multisig: name of the new multisig contract qty: amount taken from source in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. src: name of the source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. threshold: Number of required signatures key: Each signer of the multisig contract Can be a public_key name, a file or a raw public_key literal. If the parameter is not the name of an existing public_key, the client will look for a file containing a public_key, and if it does not exist, the argument will be read as a raw public_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation --delegate <address>: delegate of the contract Must be a known address. 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 keys -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --verbose-signing: display extra information before signing the operation
  • sign multisig transaction on multisig transferring qty to dst using secret key key [--arg <data>] [--entrypoint <name>]
    Sign a transaction for a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. qty: amount taken from source in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. dst: name/literal of the destination contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. key: Secret key corresponding to one of the public keys stored on the multisig contract Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --arg <data>: argument passed to the contract's script, if needed --entrypoint <name>: entrypoint of the smart contract
  • sign multisig transaction on multisig running lambda lambda using secret key key
    Sign a lambda for a generic multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. lambda: the lambda to execute, of type lambda unit (list operation) key: Secret key corresponding to one of the public keys stored on the multisig contract Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect.
  • sign multisig transaction on multisig setting delegate to dlgt using secret key key
    Sign a delegate change for a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. dlgt: new delegate of the new multisig contract 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. key: Secret key corresponding to one of the public keys stored on the multisig contract Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect.
  • sign multisig transaction on multisig withdrawing delegate using secret key key
    Sign a delegate withdraw for a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. key: Secret key corresponding to one of the public keys stored on the multisig contract Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect.
  • sign multisig transaction on multisig using secret key key setting threshold to threshold and public keys to [key...]
    Sign a change of public keys and threshold for a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. key: Secret key corresponding to one of the public keys stored on the multisig contract Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. threshold: Number of required signatures key: Each signer of the multisig contract Can be a public_key name, a file or a raw public_key literal. If the parameter is not the name of an existing public_key, the client will look for a file containing a public_key, and if it does not exist, the argument will be read as a raw public_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect.
  • from multisig contract multisig transfer qty to dst on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>]
    Transfer tokens using a multisig contract. multisig: name/literal of the multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. qty: amount taken from the multisig contract in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. dst: name/literal of the destination contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. src: source calling the multisig contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. signature: Each signer of the multisig contract --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction --arg <data>: argument passed to the contract's script, if needed -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --entrypoint <name>: entrypoint of the smart contract
  • from multisig contract multisig run lambda lambda on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Run a lambda on a generic multisig contract. multisig: name/literal of the multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. lambda: the lambda to execute, of type lambda unit (list operation) src: source calling the multisig contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. signature: Each signer of the multisig contract --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • set delegate of multisig contract multisig to dlgt on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Change the delegate of a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. dlgt: new delegate of the new multisig contract 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. src: source calling the multisig contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. signature: Each signer of the multisig contract --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • withdraw delegate of multisig contract multisig on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Withdraw the delegate of a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. src: source calling the multisig contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. signature: Each signer of the multisig contract --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • set threshold of multisig contract multisig to threshold and public keys to [key...] on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Change public keys and threshold for a multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. threshold: Number of required signatures key: Each signer of the multisig contract Can be a public_key name, a file or a raw public_key literal. If the parameter is not the name of an existing public_key, the client will look for a file containing a public_key, and if it does not exist, the argument will be read as a raw public_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. src: source calling the multisig contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. signature: Each signer of the multisig contract --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • run transaction bytes on multisig contract multisig on behalf of src with signatures [signature...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Run a transaction described by a sequence of bytes on a multisig contract. bytes: the sequence of bytes to deserialize as a multisig action, can be obtained by one of the "prepare multisig transaction" commands multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. src: source calling the multisig contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. signature: Each signer of the multisig contract --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • prepare multisig transaction on multisig transferring qty to dst [--bytes-only] [--arg <data>] [--entrypoint <name>]
    Display the threshold, public keys, and byte sequence to sign for a multisigned transfer. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. qty: amount taken from source in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. dst: name/literal of the destination contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --bytes-only: return only the byte sequence to be signed --arg <data>: argument passed to the contract's script, if needed --entrypoint <name>: entrypoint of the smart contract
  • prepare multisig transaction on multisig running lambda lambda [--bytes-only]
    Display the threshold, public keys, and byte sequence to sign for a multisigned lambda execution in a generic multisig contract. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. lambda: the lambda to execute, of type lambda unit (list operation) --bytes-only: return only the byte sequence to be signed
  • prepare multisig transaction on multisig setting delegate to dlgt [--bytes-only]
    Display the threshold, public keys, and byte sequence to sign for a multisigned delegate change. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. dlgt: new delegate of the new multisig contract 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. --bytes-only: return only the byte sequence to be signed
  • prepare multisig transaction on multisig withdrawing delegate [--bytes-only]
    Display the threshold, public keys, and byte sequence to sign for a multisigned delegate withdraw. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --bytes-only: return only the byte sequence to be signed
  • prepare multisig transaction on multisig setting threshold to threshold and public keys to [key...] [--bytes-only]
    Display the threshold, public keys, and byte sequence to sign for a multisigned change of keys and threshold. multisig: name or address of the originated multisig contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. threshold: Number of required signatures key: Each signer of the multisig contract Can be a public_key name, a file or a raw public_key literal. If the parameter is not the name of an existing public_key, the client will look for a file containing a public_key, and if it does not exist, the argument will be read as a raw public_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --bytes-only: return only the byte sequence to be signed

Binary Description

  • describe unsigned block header
    Describe unsigned block header
  • describe unsigned operation
    Describe unsigned operation

Block contextual commands (see option -block)

  • set delegate for src to dlgt [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Set the delegate of a contract. src: source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. dlgt: new delegate of the contract 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. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • withdraw delegate from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Withdraw the delegate from a contract. src: source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • originate contract new transferring qty from src running prg [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [--delegate <address>] [-f --force] [--init <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Launch a smart contract on the blockchain. new: name of the new contract qty: amount taken from source in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. src: name of the source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. prg: script of the account Combine with -init if the storage type is not unit. Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation --delegate <address>: delegate of the contract Must be a known address. 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 keys --init <data>: initial value of the contract's storage Defaults to `Unit`. -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • multiple transfers from src using transfers.json [--default-fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --default-gas-limit <amount>] [-S --default-storage-limit <amount>] [-C --counter <counter>] [--default-arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--default-entrypoint <name>] [--replace]
    Execute multiple transfers from a single source account. If one of the transfers fails, none of them get executed. src: name of the source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. transfers.json: List of operations originating from the source contract in JSON format (from a file or directly inlined). The input JSON must be an array of objects of the form: '[ {"destination": dst, "amount": qty (, <field>: <val> ...) } (, ...) ]', where an optional <field> can either be "fee", "gas-limit", "storage-limit", "arg", or "entrypoint". --default-fee <amount>: default fee in ꜩ to pay to the baker for each transaction -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --force: Inject the operation even if the simulation results in a failure. This switch requires --gas-limit, --storage-limit, and --fee. -G --default-gas-limit <amount>: Set the default gas limit for each transaction instead of letting the client decide based on a simulation -S --default-storage-limit <amount>: Set the default storage limit for each transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction --default-arg <data>: default argument passed to each contract's script, if needed -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --default-entrypoint <name>: default entrypoint of the smart contracts --replace: Replace an existing pending transaction from the same source, if any, with another one with higher fees. There are no guarantees that the first operation will not be included or that the second one will be. But, only one of the operations at most will end in a block (in precheck mode).
  • transfer qty from src to dst [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>] [--replace] [--simulate-successor-level]
    Transfer tokens / call a smart contract. qty: amount taken from source in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. src: name of the source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. dst: name/literal of the destination contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --force: Inject the operation even if the simulation results in a failure. This switch requires --gas-limit, --storage-limit, and --fee. -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction --arg <data>: argument passed to the contract's script, if needed -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --entrypoint <name>: entrypoint of the smart contract --replace: Replace an existing pending transaction from the same source, if any, with another one with higher fees. There are no guarantees that the first operation will not be included or that the second one will be. But, only one of the operations at most will end in a block (in precheck mode). --simulate-successor-level: Make the simulate on the successor level of the current head.
  • register global constant expression from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Register a global constant expression: Michelson expression to register. Note the value is not typechecked before registration. src: name of the account registering the global constant Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • call dst from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--force] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>] [--replace] [--simulate-successor-level]
    Call a smart contract (same as 'transfer 0'). dst: name/literal of the destination contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. src: name of the source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --force: Inject the operation even if the simulation results in a failure. This switch requires --gas-limit, --storage-limit, and --fee. -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction --arg <data>: argument passed to the contract's script, if needed -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --entrypoint <name>: entrypoint of the smart contract --replace: Replace an existing pending transaction from the same source, if any, with another one with higher fees. There are no guarantees that the first operation will not be included or that the second one will be. But, only one of the operations at most will end in a block (in precheck mode). --simulate-successor-level: Make the simulate on the successor level of the current head.
  • reveal key for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Reveal the public key of the contract manager. src: name of the source contract Can be a contract alias or a key alias (autodetected in order). Use 'key:name' to force the later. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • register key mgr as delegate [--fee <amount>] [-D --dry-run] [--verbose-signing] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Register the public key hash as a delegate. mgr: the delegate key 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. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • submit proposals for delegate [proposal...] [-D --dry-run] [--verbose-signing] [--force]
    Submit protocol proposals delegate: the delegate who makes the proposal Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. proposal: the protocol hash proposal to be submitted -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --force: Do not fail when the checks that try to prevent the user from shooting themselves in the foot do fail.
  • submit ballot for delegate proposal ballot [--verbose-signing] [-D --dry-run] [--force]
    Submit a ballot delegate: the delegate who votes Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. proposal: the protocol hash proposal to vote for ballot: the ballot value (yea/yay, nay, or pass) --verbose-signing: display extra information before signing the operation -D --dry-run: don't inject the operation, just display it --force: Do not fail when the checks that try to prevent the user from shooting themselves in the foot do fail.
  • set deposits limit for src to deposits limit [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Set the deposits limit of a registered delegate. src: source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. deposits limit: the maximum amount of frozen deposits in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • unset deposits limit for src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Remove the deposits limit of a registered delegate. src: source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • increase the paid storage of contract by amount bytes from payer [--force] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Increase the paid storage of a smart contract. contract: name of the smart contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. amount: amount of increase in bytes payer: payer of the storage increase 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. --force: Inject the operation even if the simulation results in a failure. This switch requires --gas-limit, --storage-limit, and --fee. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • originate tx rollup tx_rollup from src [--force] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Launch a new transaction rollup. tx_rollup: Fresh name for a transaction rollup src: Account originating the transaction rollup. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --force: Inject the operation even if the simulation results in a failure. This switch requires --gas-limit, --storage-limit, and --fee. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • submit tx rollup batch batch to transaction rollup address from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Submit a batch of transaction rollup operations. batch: Bytes representation (hexadecimal string) of the batch. Must be prefixed by '0x'. transaction rollup address: Tx rollup receiving the batch. Transaction rollup address encoded in a base58 string. src: Account submitting the transaction rollup batches. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • commit to tx rollup transaction rollup address from src for level tx rollup level with inbox hash inbox root hash and messages result hash [message result hash...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [--predecessor-hash <commitment hash>]
    Commit to a transaction rollup for an inbox and level. The provided list of message result hash must be ordered in the same way the messages were ordered in the inbox. transaction rollup address: Transaction rollup address committed to. Transaction rollup address encoded in a base58 string. src: Account committing to the transaction rollup. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. tx rollup level: Level used for the commitment. Transaction rollup level encoded in a non negative int32. inbox root hash: Inbox used for the commitment. Root's hash of a merkelized inbox list, encoded in a base58 string. message result hash: Message result hash of a message from the inbox being committed. Message result hash encoded in a base58 string. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction --predecessor-hash <commitment hash>: Predecessor commitment hash, empty for the first commitment. Commitment hash encoded in a base58 string.
  • finalize commitment of tx rollup transaction rollup address from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [-S --storage-limit <amount>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--simulation] [-C --counter <counter>]
    Finalize a commitment of an transaction rollup. transaction rollup address: Tx rollup that have his commitment finalized. Transaction rollup address encoded in a base58 string. src: Account finalizing the commitment. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --simulation: Simulate the execution of the command, without needing any signatures. -C --counter <counter>: Set the counter to be used by the transaction
  • recover bond of src for tx rollup transaction rollup address [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Recover commitment bond from an transaction rollup. src: Account that owns the bond. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. transaction rollup address: Tx rollup of the bond. Transaction rollup address encoded in a base58 string. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • remove commitment of tx rollup transaction rollup address from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Remove a commitment from an transaction rollup. transaction rollup address: Tx rollup that have his commitment removed. Transaction rollup address encoded in a base58 string. src: name of the account removing the commitment. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • reject commitment of tx rollup transaction rollup address at level tx rollup level with result hash message result hash and result path message result path for message at position message position with content message and path message path with agreed context hash context hash and withdraw list hash withdraw list hash and result path message result path using proof rejection proof from src [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Reject a commitment of an transaction rollup. transaction rollup address: Tx rollup that have one of his commitment rejected. Transaction rollup address encoded in a base58 string. tx rollup level: Level of the commitment disputed. Transaction rollup level encoded in a non negative int32. message result hash: Disputed message result hash. Message result hash encoded in a base58 string. message result path: Disputed message result path. Merkle path (JSON encoded) for a message result hash in a commitment. The JSON should be a list of base58-encoded message result hashes. message position: Position of the message in the inbox with the result being disputed. message: Message content with the result being disputed. Message are encoded in a JSON with one of the following format: {"batch": bytes} or {"deposit": {"sender": <depositer public key hash>; "destination": <layer 2 destination (address or index)>;"ticket_hash": <hash of the tickets> ;"amount": <deposited amount> }}. message path: Path of the message with the result being disputed. Merkle path (JSON encoded) for a message in an inbox. The JSON should be a list of base58-encoded message hashes. context hash: Context hash of the precedent message result in the commitment. This must be the context hash of the last message result agreed on. Context hash encoded in a base58 string. withdraw list hash: Withdraw list hash of the precedent message result in the commitment. This must be the withdraw list hash of the last message result agreed on. Withdraw list hash encoded in a base58 string. message result path: Precedent message result path. Merkle path (JSON encoded) for a message result hash in a commitment. The JSON should be a list of base58-encoded message result hashes. rejection proof: Proof that the disputed message result provided is incorrect. Rejection proof are stream encoded in a JSON. See documentation of transaction rollup for more information. src: Account rejecting the commitment. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • dispatch tickets of tx rollup transaction rollup address from source at level tx rollup level for the message at index message index with the context hash context hash and path message result path and tickets info [tickets information...] [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Dispatch tickets withdrawn from a transaction rollup to owners. The withdrawals are part of a finalized commitment of the transaction rollup. Owners are implicit accounts who can then transfer the tickets to smart contracts using the "transfer tickets" command. See transaction rollups documentation for more information. The provided list of ticket information must be ordered as in withdrawal list computed by the application of the message. transaction rollup address: Tx rollup which have some tickets dispatched. Transaction rollup address encoded in a base58 string. source: Account used to dispatch tickets. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. tx rollup level: Level of the finalized commitment that includes the message result whose withdrawals will be dispatched. Transaction rollup level encoded in a non negative int32. message index: Index of the message whose withdrawals will be dispatched. context hash: Context hash of the message result in the commitment whose withdrawals will be dispatched. Context hash encoded in a base58 string. message result path: Path of the message result whose withdrawals will be dispatched. Merkle path (JSON encoded) for a message result hash in a commitment. The JSON should be a list of base58-encoded message result hashes. tickets information: Information needed to dispatch tickets to its owner. Tickets related information are encoded in a JSON with the following format: {"contents": <tickets content>,"ty": <tickets type>, "ticketer": <ticketer contract address>, "amount": <withdrawn amount>, ""claimer": <new owner's public key hash>} --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • transfer qty tickets from tickets owner to recipient contract with entrypoint entrypoint and contents tickets content and type tickets type and ticketer tickets ticketer [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Transfer tickets from an implicit account to a contract. qty: Amount of tickets to transfer. tickets owner: Implicit account owning the tickets. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. recipient contract: Contract receiving the tickets. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. entrypoint: Entrypoint to use on the receiving contract. tickets content: Content of the tickets. tickets type: Type of the tickets. tickets ticketer: Ticketer contract of the tickets. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • originate sc rollup from src of kind sc_rollup_kind of type parameters_type booting with boot_sector [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Originate a new smart-contract rollup. src: Name of the account originating the smart-contract rollup. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. sc_rollup_kind: Kind of the smart-contract rollup to be originated. parameters_type: The type of parameters that the smart-contract rollup accepts. boot_sector: The initialization state for the smart-contract rollup. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • send sc rollup message messages from src to dst [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Send one or more messages to a smart-contract rollup. messages: The message(s) to be sent to the rollup (syntax: bin:<path_to_binary_file>|text:<json list of string messages>|file:<json_file>). src: Name of the source contract. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. dst: Address of the destination smart-contract rollup. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • cement commitment commitment from src for sc rollup sc_rollup [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [-S --storage-limit <amount>] [-C --counter <counter>] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Cement a commitment for a sc rollup. commitment: The hash of the commitment to be cemented for a sc rollup. src: Name of the source contract. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. sc_rollup: The address of the sc rollup where the commitment will be cemented. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • list sc rollups
    List originated smart-contract rollups.
  • execute outbox message of sc rollup rollup from source for commitment hash cemented commitment for the outbox level outbox level for the message at index message index and inclusion proof inclusion proof and message message [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Execute a message from a smart-contract rollup's outbox of a cemented commitment. rollup: The address of the smart-contract rollup where the message resides. source: The account used for executing the outbox message. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. cemented commitment: The hash of the cemented commitment of the rollup. outbox level: The level of the rollup's outbox. message index: The index of the rollup's outbox containing the message. inclusion proof: The inclusion proof for the message. message: The message to be executed. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • recover bond of src for sc rollup smart contract rollup address [--fee <amount>] [-D --dry-run] [--verbose-signing] [--simulation] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [-S --storage-limit <amount>] [-C --counter <counter>]
    Recover commitment bond from a smart contract rollup. src: The implicit account that owns the frozen bond. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. smart contract rollup address: The address of the smart-contract rollup of the bond. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation --simulation: Simulate the execution of the command, without needing any signatures. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction
  • activate account new with activation_key [-f --force] [--encrypted]
    Register and activate an Alphanet/Zeronet faucet account. new: new secret_key alias activation_key: Activate an Alphanet/Zeronet faucet account from the JSON (file or directly inlined). -f --force: overwrite existing secret_key --encrypted: encrypt the key on-disk
  • get timestamp [-s --seconds]
    Access the timestamp of the block. -s --seconds: output time in seconds
  • list contracts
    Lists all non empty contracts of the block.
  • list cached contracts
    Lists cached contracts and their age in LRU ordering.
  • get cached contract rank for src
    Get the key rank of a cache key. src: contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force.
  • get cache contract size
    Get cache contract size.
  • get cache contract size limit
    Get cache contract size limit.
  • get balance for src
    Get the balance of a contract. src: source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force.
  • get contract storage for src [--unparsing-mode <mode>]
    Get the storage of a contract. src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`.
  • get big map value for key of type type in src
    Get the value associated to a key in the big map storage of a contract (deprecated). key: the key to look for type: type of the key src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force.
  • get element key of big map big_map [--unparsing-mode <mode>]
    Get a value in a big map. key: the key to look for big_map: identifier of the big_map --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`.
  • get contract code for src [--unparsing-mode <mode>] [--normalize-types]
    Get the code of a contract. src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`. --normalize-types: Whether types should be normalized (annotations removed, combs flattened) or kept as they appeared in the original script.
  • get contract script hash for src
    Get the `BLAKE2B` script hash of a contract. src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force.
  • get contract entrypoint type of entrypoint for src [--normalize-types]
    Get the type of an entrypoint of a contract. entrypoint: the entrypoint to describe src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --normalize-types: Whether types should be normalized (annotations removed, combs flattened) or kept as they appeared in the original script.
  • get contract entrypoints for src [--normalize-types]
    Get the entrypoint list of a contract. src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --normalize-types: Whether types should be normalized (annotations removed, combs flattened) or kept as they appeared in the original script.
  • get contract unreachable paths for src
    Get the list of unreachable paths in a contract's parameter type. src: source contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force.
  • get delegate for src
    Get the delegate of a contract. src: source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force.
  • show voting period
    Summarize the current voting period
  • get deposits limit for src
    Get the frozen deposits limit of a delegate. src: source delegate Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force.
  • sapling shield qty from src-tz to dst-sap using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--message <>]
    Shield tokens from an implicit account to a Sapling address. qty: Amount taken from transparent wallet of source. in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. src-tz: Transparent source account. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. dst-sap: Sapling address of destination. sapling contract: Smart contract to submit this transaction to. Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --message <>: Message for Sapling transaction
  • sapling unshield qty from src-sap to dst-tz using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>]
    Unshield tokens from a Sapling address to an implicit account. qty: Amount taken from shielded wallet of source. in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. src-sap: Sapling account of source. dst-tz: Transparent destination account. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. sapling contract: Smart contract to submit this transaction to. Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`.
  • sapling forge transaction qty from src-sap to dst-sap using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--message <>] [--file <sapling_transaction>] [--json]
    Forge a sapling transaction and save it to a file. qty: Amount taken from shielded wallet of source. in ꜩ Text format: `DDDDDDD.DDDDDD`. Tez and mutez and separated by a period sign. Trailing and pending zeroes are allowed. src-sap: Sapling account of source. dst-sap: Sapling address of destination. sapling contract: Smart contract to submit this transaction to. Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --message <>: Message for Sapling transaction --file <sapling_transaction>: file name --json: Use JSON format
  • sapling submit file from alias-tz using sapling contract [--fee <amount>] [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>] [-S --storage-limit <amount>] [-C --counter <counter>] [-q --no-print-source] [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee] [--fee-cap <amount>] [--burn-cap <amount>] [--json]
    Submit a forged sapling transaction. file: Filename of the forged transaction. alias-tz: Transparent account paying the fees. Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. sapling contract: Smart contract to submit this transaction to. Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --fee <amount>: fee in ꜩ to pay to the baker -D --dry-run: don't inject the operation, just display it --verbose-signing: display extra information before signing the operation -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation -C --counter <counter>: Set the counter to be used by the transaction -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --force-low-fee: Don't check that the fee is lower than the estimated default value --fee-cap <amount>: Set the fee cap Defaults to `1.0`. --burn-cap <amount>: Set the burn cap Defaults to `0`. --json: Use JSON format
  • stresstest originate smart contracts from src
    Originate all supported smart contracts for use in the stresstest. src: name of the source contract Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force.

Commands for managing the record of known contracts

  • remember contract new src [-f --force]
    Add a contract to the wallet. new: new contract alias src: source contract Can be a contract name, a file or a raw contract literal. If the parameter is not the name of an existing contract, the client will look for a file containing a contract, and if it does not exist, the argument will be read as a raw contract. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. -f --force: overwrite existing contract
  • forget contract name
    Remove a contract from the wallet. name: existing contract alias
  • list known contracts
    Lists all known contracts in the wallet.
  • forget all contracts [-f --force]
    Forget the entire wallet of known contracts. -f --force: overwrite existing contract
  • show known contract name
    Display a contract from the wallet. name: existing contract alias

Commands for managing the library of known scripts

  • list known scripts
    Lists all scripts in the library.
  • remember script new src [-f --force]
    Add a script to the library. new: new script alias src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. -f --force: overwrite existing script
  • forget script name
    Remove a script from the library. name: existing script alias
  • show known script name
    Display a script from the library. name: existing script alias
  • run script src on storage storage and input input [--trace-stack] [--amount <amount>] [--balance <amount>] [--source <source>] [--payer <payer>] [--self-address <self-address>] [-q --no-print-source] [-G --gas <gas>] [--entrypoint <name>] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>]
    Ask the node to run a script. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. storage: the storage data input: the input data --trace-stack: show the stack after each step --amount <amount>: amount of the transfer in ꜩ Defaults to `0.05`. --balance <amount>: balance of run contract in ꜩ --source <source>: name of the source (i.e. SENDER) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --self-address <self-address>: address of the contract (i.e. SELF_ADDRESS) for the transaction Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. -G --gas <gas>: Initial quantity of gas for typechecking and execution --entrypoint <name>: entrypoint of the smart contract --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`. --now <timestamp>: Set the timestamp to be returned by the NOW instruction. Allowed format are RFC 3339 (YYYY-MM-DDTHH:MM:SSZ) or number of seconds since epoch. --level <level>: Set the level to be returned by the LEVEL instruction
  • compute size for script src on storage storage [--emacs] [-q --no-print-source] [-G --gas <gas>] [--legacy]
    Ask the node to compute the size of a script. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. storage: the storage data --emacs: output in `michelson-mode.el` compatible format -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. -G --gas <gas>: Initial quantity of gas for typechecking and execution --legacy: typecheck in legacy mode as if the data was taken from the chain
  • typecheck script src [-v --details] [--emacs] [-q --no-print-source] [-G --gas <gas>] [--legacy]
    Ask the node to typecheck a script. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. -v --details: show the types of each instruction --emacs: output in `michelson-mode.el` compatible format -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. -G --gas <gas>: Initial quantity of gas for typechecking and execution --legacy: typecheck in legacy mode as if the data was taken from the chain
  • typecheck data data against type type [-q --no-print-source] [-G --gas <gas>] [--legacy]
    Ask the node to typecheck a data expression. data: the data to typecheck type: the expected type -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour. -G --gas <gas>: Initial quantity of gas for typechecking and execution --legacy: typecheck in legacy mode as if the data was taken from the chain
  • hash data data of type type [-G --gas <gas>] [--for-script <FORMAT>]
    Ask the node to pack a data expression. The returned hash is the same as what Michelson instruction `PACK` would have produced. Also displays the result of hashing this packed data with `BLAKE2B`, `SHA256` or `SHA512` instruction. data: the data to hash type: type of the data -G --gas <gas>: Initial quantity of gas for typechecking and execution --for-script <FORMAT>: Make the output script-friendly. Possible values are 'TSV' and 'CSV'.
  • hash script [source...] [--enforce-indentation] [--display-names] [--for-script <FORMAT>]
    Ask the node to hash a Michelson script with `BLAKE2B`. source: literal or a path to a file --enforce-indentation: Check that the Micheline expression passed to this command is well-indented. --display-names: Print names of scripts passed to this command --for-script <FORMAT>: Make the output script-friendly. Possible values are 'TSV' and 'CSV'.
  • unpack michelson data bytes
    Parse a byte sequence (in hexadecimal notation) as a data expression, as per Michelson instruction `UNPACK`. bytes: the packed data to parse
  • normalize script src [--unparsing-mode <mode>]
    Ask the node to normalize a script. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`.
  • normalize data data of type type [--unparsing-mode <mode>] [--legacy]
    Ask the node to normalize a data expression. data: the data expression to normalize type: type of the data expression --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`. --legacy: typecheck in legacy mode as if the data was taken from the chain
  • normalize type typ
    Ask the node to normalize a type. typ: the Michelson type to normalize
  • sign bytes data for src
    Sign a raw sequence of bytes and display it using the format expected by Michelson instruction `CHECK_SIGNATURE`. data: the raw data to sign src: source secret_key Can be a secret_key name, a file or a raw secret_key literal. If the parameter is not the name of an existing secret_key, the client will look for a file containing a secret_key, and if it does not exist, the argument will be read as a raw secret_key. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect.
  • check that bytes bytes were signed by key to produce signature [-q --quiet]
    Check the signature of a byte sequence as per Michelson instruction `CHECK_SIGNATURE`. bytes: the signed data key: existing public_key alias signature: the signature to check -q --quiet: Use only exit codes
  • get script entrypoint type of entrypoint for src [--emacs] [-q --no-print-source]
    Ask the type of an entrypoint of a script. entrypoint: the entrypoint to describe src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --emacs: output in `michelson-mode.el` compatible format -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour.
  • get script entrypoints for src [--emacs] [-q --no-print-source]
    Ask the node to list the entrypoints of a script. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --emacs: output in `michelson-mode.el` compatible format -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour.
  • get script unreachable paths for src [--emacs] [-q --no-print-source]
    Ask the node to list the unreachable paths in a script's parameter type. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect. --emacs: output in `michelson-mode.el` compatible format -q --no-print-source: don't print the source code If an error is encountered, the client will print the contract's source code by default. This option disables this behaviour.
  • expand macros in src
    Ask the node to expand the Michelson macros in a script. src: source script Can be a script name, a file or a raw script literal. If the parameter is not the name of an existing script, the client will look for a file containing a script, and if it does not exist, the argument will be read as a raw script. Use 'alias:name', 'file:path' or 'text:literal' to disable autodetect.
  • run tzip4 view entrypoint on contract contract with input input [--source <source>] [--payer <payer>] [-G --gas <gas>] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>]
    Ask the node to run a TZIP-4 view. entrypoint: the name of the view contract: viewed contract Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. input: the input data --source <source>: name of the source (i.e. SENDER) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. -G --gas <gas>: Initial quantity of gas for typechecking and execution --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`. --now <timestamp>: Set the timestamp to be returned by the NOW instruction. Allowed format are RFC 3339 (YYYY-MM-DDTHH:MM:SSZ) or number of seconds since epoch. --level <level>: Set the level to be returned by the LEVEL instruction
  • run view view on contract contract [--source <source>] [--payer <payer>] [-G --gas <gas>] [--unlimited-gas] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>]
    Ask the node to run a Michelson view with Unit as input. view: the name of the view contract: the contract containing the view Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. --source <source>: name of the source (i.e. SENDER) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. -G --gas <gas>: Initial quantity of gas for typechecking and execution --unlimited-gas: Allows interpretation with virtually unlimited gas --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`. --now <timestamp>: Set the timestamp to be returned by the NOW instruction. Allowed format are RFC 3339 (YYYY-MM-DDTHH:MM:SSZ) or number of seconds since epoch. --level <level>: Set the level to be returned by the LEVEL instruction
  • run view view on contract contract with input input [--source <source>] [--payer <payer>] [-G --gas <gas>] [--unlimited-gas] [--unparsing-mode <mode>] [--now <timestamp>] [--level <level>]
    Ask the node to run a Michelson view. view: the name of the view contract: the contract containing the view Can be a literal or an alias (autodetected in order). Use 'text:literal' or 'alias:name' to force. input: the argument provided to the view --source <source>: name of the source (i.e. SENDER) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction Can be a literal, an alias, or a key (autodetected in order). Use 'text:literal', 'alias:name', 'key:name' to force. -G --gas <gas>: Initial quantity of gas for typechecking and execution --unlimited-gas: Allows interpretation with virtually unlimited gas --unparsing-mode <mode>: Unparsing mode to use One of "Readable", "Optimized", or "Optimized_legacy". This option affects the way the values of the following Michelson types are represented: - timestamp: the Readable representation is a RFC3339 string, the Optimized and Optimized_legacy representations are the number of seconds since Epoch - key, signature, key_hash, address, contract, chain_id: the Readable representation is a Base58Check string, the Optimized and Optimized_legacy representations are byte sequences - nested pairs: in Readable mode, the Pair constructor is used even with arity bigger than 2 such as in Pair 0 1 2; in Optimized_legacy mode, the Pair constructor is always use with arity 2 such as in Pair 0 (Pair 1 2); in Optimized mode, a sequence is used if there are at least 4 elements and the behavior is the same as in Optimized_legacy mode otherwise. Defaults to `Readable`. --now <timestamp>: Set the timestamp to be returned by the NOW instruction. Allowed format are RFC 3339 (YYYY-MM-DDTHH:MM:SSZ) or number of seconds since epoch. --level <level>: Set the level to be returned by the LEVEL instruction

Tenderbake client commands

  • bake for [baker...] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-timestamp] [-f --force] [--operations-pool <file|uri>] [--context <path>] [--ignore-node-mempool]
    Forge and inject block using the delegates' rights. baker: name of the delegate owning the endorsement right 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. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-timestamp: Use the minimal timestamp instead of the current date as timestamp of the baked block. -f --force: disables the node's injection checks Force the injection of branch-invalid operation or force the injection of block without a fitness greater than the current head. --operations-pool <file|uri>: When specified, the baker will try to fetch operations from this file (or uri) and to include retrieved operations in the block. The expected format of the contents is a list of operations [ alpha.operation ]. Environment variable 'TEZOS_CLIENT_REMOTE_OPERATIONS_POOL_HTTP_HEADERS' may also be specified to add headers to the requests (only 'host' headers are supported). If the resource cannot be retrieved, e.g., if the file is absent, unreadable, or the web service returns a 404 error, the resource is simply ignored. --context <path>: When specified, the client will read in the local context at the provided path in order to build the block, instead of relying on the 'preapply' RPC. --ignore-node-mempool: Ignore mempool operations from the node and do not subsequently monitor them. Use in conjunction with --operations option to restrict the observed operations to those of the mempool file.
  • endorse for [baker...] [-f --force]
    Forge and inject an endorsement operation. baker: name of the delegate owning the endorsement right 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: Disable consistency, injection and double signature checks for (pre)endorsements.
  • preendorse for [baker...] [-f --force]
    Forge and inject a preendorsement operation. baker: name of the delegate owning the endorsement right 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: Disable consistency, injection and double signature checks for (pre)endorsements.
  • propose for [baker...] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [--minimal-timestamp] [-f --force] [--operations-pool <file|uri>] [--context <path>]
    Send a Tenderbake proposal baker: name of the delegate owning the endorsement right 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. --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. --minimal-timestamp: Use the minimal timestamp instead of the current date as timestamp of the baked block. -f --force: disables the node's injection checks Force the injection of branch-invalid operation or force the injection of block without a fitness greater than the current head. --operations-pool <file|uri>: When specified, the baker will try to fetch operations from this file (or uri) and to include retrieved operations in the block. The expected format of the contents is a list of operations [ alpha.operation ]. Environment variable 'TEZOS_CLIENT_REMOTE_OPERATIONS_POOL_HTTP_HEADERS' may also be specified to add headers to the requests (only 'host' headers are supported). If the resource cannot be retrieved, e.g., if the file is absent, unreadable, or the web service returns a 404 error, the resource is simply ignored. --context <path>: When specified, the client will read in the local context at the provided path in order to build the block, instead of relying on the 'preapply' RPC.

Commands querying proxy and light mode support

  • list proxy protocols
    List protocols supported by proxy mode
  • list light protocols
    List protocols supported by light mode

Commands for creating mockup environments

  • list mockup protocols
    List available protocols available for mockup construction.
  • migrate mockup to hash
    Migrates an on-disk mockup context from a protocol to another. hash: Protocol hash of the next protocol
  • create mockup [--protocol-constants <path>] [--bootstrap-accounts <path>] [--asynchronous]
    Create a mockup environment. --protocol-constants <path>: a JSON file that contains protocol constants to set. --bootstrap-accounts <path>: a JSON file that contains definitions of bootstrap accounts to create. --asynchronous: put operations in mempool and require baking to include in the chain

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>] [--encrypted]
    Generate a pair of keys. new: new secret_key alias -f --force: overwrite existing secret_key -s --sig <ed25519|secp256k1|p256>: 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

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 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.
  • complete prefix [-u --unique]
    Autocomplete a prefix of Base58Check-encoded hash. This actually works only for blocks, operations, public key and contract identifiers. prefix: the prefix of the hash to complete -u --unique: Fail when there is more than one possible completion.
  • bootstrapped
    Wait for the node to be bootstrapped.
  • compute chain id from block hash hash
    Computes the chain id corresponding to a block hash. hash: the block hash from which to compute the chain id
  • compute chain id from seed string
    Computes a chain id from a seed string: the seed from which to compute the chain id
  • convert script source from input_format to output_format [-z --zero-loc] [--legacy] [--enforce-indentation]
    Conversion of Michelson script from Micheline, JSON or binary to Micheline, JSON, binary or OCaml source: literal or a path to a file input_format: format of the input for conversion output_format: format of the conversion output -z --zero-loc: replace location with "0" --legacy: typecheck in legacy mode as if the data was taken from the chain --enforce-indentation: Check that the Micheline expression passed to this command is well-indented.
  • convert data source from input_format to output_format [-z --zero-loc] [-t --type <unit>]
    Conversion of Micheline expression from Micheline, JSON or binary to Micheline, JSON, binary or OCaml source: literal or a path to a file input_format: format of the input for conversion output_format: format of the conversion output -z --zero-loc: replace location with "0" -t --type <unit>: the given data will be type-checked against this type
  • wait for operation to be included [--confirmations <num_blocks>] [--check-previous <num_blocks>] [--branch <block_hash>]
    Wait until an operation is included in a block operation: Operation to be included --confirmations <num_blocks>: wait until 'N' additional blocks after the operation appears in the considered chain Defaults to `0`. --check-previous <num_blocks>: number of previous blocks to check Defaults to `10`. --branch <block_hash>: hash of the oldest block where we should look for the operation
  • get receipt for operation [--check-previous <num_blocks>]
    Get receipt for past operation operation: Operation to be looked up --check-previous <num_blocks>: number of previous blocks to check Defaults to `10`.

Baker manual

Usage

  • octez-baker-014-PtKathma [global options] command [command options]
  • octez-baker-014-PtKathma --help (for global options)
  • octez-baker-014-PtKathma [global options] command --help (for command options)
  • octez-baker-014-PtKathma --version (for version information)

To browse the documentation

  • octez-baker-014-PtKathma [global options] man (for a list of commands)
  • octez-baker-014-PtKathma [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 -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 baker daemon.

  • run with local node node_data_path [baker...] [-P --pidfile <filename>] [--minimal-fees <amount>] [--minimal-nanotez-per-gas-unit <amount>] [--minimal-nanotez-per-byte <amount>] [-K --keep-alive] [--liquidity-baking-toggle-vote <vote>] [-V --votefile <filename>] [--operations-pool <file|uri>]
    Launch the baker daemon. node_data_path: Path to the node data directory (e.g. $HOME/.tezos-node) baker: name of the delegate owning the endorsement right 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. -P --pidfile <filename>: write process id in file --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez) Defaults to `0.0001`. --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez) Defaults to `100`. --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez) Defaults to `1000`. -K --keep-alive: Keep the daemon process alive: when the connection with the node is lost, the daemon periodically tries to reach it. --liquidity-baking-toggle-vote <vote>: Vote to continue or end the liquidity baking subsidy. The possible values for this option are: "off" to request ending the subsidy, "on" to request continuing or restarting the subsidy, and "pass" to abstain. Note that this "option" is mandatory! -V --votefile <filename>: read per block votes as json file --operations-pool <file|uri>: When specified, the baker will try to fetch operations from this file (or uri) and to include retrieved operations in the block. The expected format of the contents is a list of operations [ alpha.operation ]. Environment variable 'TEZOS_CLIENT_REMOTE_OPERATIONS_POOL_HTTP_HEADERS' may also be specified to add headers to the requests (only 'host' headers are supported). If the resource cannot be retrieved, e.g., if the file is absent, unreadable, or the web service returns a 404 error, the resource is simply ignored.
  • run vdf [-K --keep-alive]
    Launch the VDF daemon -K --keep-alive: Keep the daemon process alive: when the connection with the node is lost, the daemon periodically tries to reach it.

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.

Accuser manual

Usage

  • octez-accuser-014-PtKathma [global options] command [command options]
  • octez-accuser-014-PtKathma --help (for global options)
  • octez-accuser-014-PtKathma [global options] command --help (for command options)
  • octez-accuser-014-PtKathma --version (for version information)

To browse the documentation

  • octez-accuser-014-PtKathma [global options] man (for a list of commands)
  • octez-accuser-014-PtKathma [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 -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 accuser daemon.

  • run [-P --pidfile <filename>] [--preserved-levels <threshold>] [-K --keep-alive]
    Launch the accuser daemon -P --pidfile <filename>: write process id in file --preserved-levels <threshold>: Number of effective levels kept in the accuser's memory Defaults to `200`. -K --keep-alive: Keep the daemon process alive: when the connection with the node is lost, the daemon periodically tries to reach it.

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.