From ddb4fea980eb9352e47b2d7cb1fc92ff6fc8c0bc Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Tue, 11 Jan 2022 09:45:15 +0100 Subject: [PATCH 1/5] Proto/Params: set block times to 20s and update related constants --- .../lib_parameters/default_parameters.ml | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/proto_alpha/lib_parameters/default_parameters.ml b/src/proto_alpha/lib_parameters/default_parameters.ml index 8c14b1415089..c380db5a157e 100644 --- a/src/proto_alpha/lib_parameters/default_parameters.ml +++ b/src/proto_alpha/lib_parameters/default_parameters.ml @@ -78,7 +78,7 @@ let default_dal = let constants_mainnet = let consensus_committee_size = 7000 in - let block_time = 30 in + let block_time = 20 in let Constants.Generated. { consensus_threshold; @@ -94,12 +94,12 @@ let constants_mainnet = { Constants.Parametric.preserved_cycles = 5; blocks_per_cycle = 8192l; - blocks_per_commitment = 64l; - nonce_revelation_threshold = 256l; - blocks_per_stake_snapshot = 512l; + blocks_per_cycle = 12288l; + blocks_per_commitment = 96l; + blocks_per_stake_snapshot = 768l; cycles_per_voting_period = 5l; hard_gas_limit_per_operation = Gas.Arith.(integral_of_int_exn 1_040_000); - hard_gas_limit_per_block = Gas.Arith.(integral_of_int_exn 5_200_000); + hard_gas_limit_per_block = Gas.Arith.(integral_of_int_exn 3_466_666); proof_of_work_threshold = Int64.(sub (shift_left 1L 46) 1L); minimal_stake = Tez.(mul_exn one 6_000); (* VDF's difficulty must be a multiple of `nonce_revelation_threshold` times @@ -113,29 +113,29 @@ let constants_mainnet = seed_nonce_revelation_tip = (match Tez.(one /? 8L) with Ok c -> c | Error _ -> assert false); origination_size = 257; - baking_reward_fixed_portion (* 10_000_000 mutez *); - baking_reward_bonus_per_slot (* 4_286 mutez *); - endorsing_reward_per_slot (* 2_857 mutez *); + baking_reward_fixed_portion (* 6_666_666 mutez *); + baking_reward_bonus_per_slot (* 2_857 mutez *); + endorsing_reward_per_slot (* 1_904 mutez *); hard_storage_limit_per_operation = Z.of_int 60_000; cost_per_byte = Tez.of_mutez_exn 250L; quorum_min = 20_00l; quorum_max = 70_00l; min_proposal_quorum = 5_00l; (* liquidity_baking_subsidy is 1/16th of maximum total rewards for a block *) - liquidity_baking_subsidy (* 2_500_000 mutez *); - (* 1/2 window size of 2000 blocks with precision of 1_000_000 + liquidity_baking_subsidy (* 1_666_666 mutez *); + (* 1/3 window size of 2000 blocks with precision of 1_000_000 for integer computation *) - liquidity_baking_toggle_ema_threshold = 1_000_000_000l; + liquidity_baking_escape_ema_threshold = 666_666_667l; (* The rationale behind the value of this constant is that an operation should be considered alive for about one hour: - minimal_block_delay context * max_operations_ttl = 3600 + minimal_block_delay * max_operations_time_to_live = 3600 The unit for this value is a block. *) - max_operations_time_to_live = 120; + max_operations_time_to_live = 180; minimal_block_delay = Period.of_seconds_exn (Int64.of_int block_time); - delay_increment_per_round = Period.of_seconds_exn 15L; + delay_increment_per_round = Period.of_seconds_exn 10L; consensus_committee_size; consensus_threshold; (* 4667 slots *) -- GitLab From 6b0c23c68e6addf53e48d4c5b1a140c28d86a554 Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Fri, 10 Dec 2021 15:35:33 +0100 Subject: [PATCH 2/5] Proto: set block times to 20s and update related constants --- .../lib_parameters/default_parameters.ml | 4 +- src/proto_alpha/lib_protocol/raw_context.ml | 92 ++++++++++++++++--- 2 files changed, 82 insertions(+), 14 deletions(-) diff --git a/src/proto_alpha/lib_parameters/default_parameters.ml b/src/proto_alpha/lib_parameters/default_parameters.ml index c380db5a157e..3484d94b8daa 100644 --- a/src/proto_alpha/lib_parameters/default_parameters.ml +++ b/src/proto_alpha/lib_parameters/default_parameters.ml @@ -93,9 +93,9 @@ let constants_mainnet = in { Constants.Parametric.preserved_cycles = 5; - blocks_per_cycle = 8192l; blocks_per_cycle = 12288l; blocks_per_commitment = 96l; + nonce_revelation_threshold = 0l; blocks_per_stake_snapshot = 768l; cycles_per_voting_period = 5l; hard_gas_limit_per_operation = Gas.Arith.(integral_of_int_exn 1_040_000); @@ -125,7 +125,7 @@ let constants_mainnet = liquidity_baking_subsidy (* 1_666_666 mutez *); (* 1/3 window size of 2000 blocks with precision of 1_000_000 for integer computation *) - liquidity_baking_escape_ema_threshold = 666_666_667l; + liquidity_baking_toggle_ema_threshold = 666_666_667l; (* The rationale behind the value of this constant is that an operation should be considered alive for about one hour: diff --git a/src/proto_alpha/lib_protocol/raw_context.ml b/src/proto_alpha/lib_protocol/raw_context.ml index ef4e6137aad9..06e8d02f3967 100644 --- a/src/proto_alpha/lib_protocol/raw_context.ml +++ b/src/proto_alpha/lib_protocol/raw_context.ml @@ -973,39 +973,107 @@ let prepare_first_block ~level ~timestamp ctxt = min_pending_to_process = c.zk_rollup.min_pending_to_process; } in + let block_time_is_30s = + Compare.Int64.(Period_repr.to_seconds c.minimal_block_delay = 30L) + in + let minimal_block_delay, delay_increment_per_round = + if block_time_is_30s then + (Period_repr.of_seconds_exn 20L, Period_repr.of_seconds_exn 10L) + else (c.minimal_block_delay, c.delay_increment_per_round) + in + let hard_gas_limit_per_block = + if block_time_is_30s then + Gas_limit_repr.Arith.(integral_of_int_exn 3_466_666) + else c.hard_gas_limit_per_block + in + let Constants_repr.Generated. + { + consensus_threshold; + baking_reward_fixed_portion; + baking_reward_bonus_per_slot; + endorsing_reward_per_slot; + liquidity_baking_subsidy; + } = + Constants_repr.Generated.generate + ~consensus_committee_size:c.consensus_committee_size + ~blocks_per_minute: + { + numerator = 60; + denominator = + minimal_block_delay |> Period_repr.to_seconds |> Int64.to_int; + } + in + let increase x = Int32.div (Int32.mul x 3l) 2l in + let ( blocks_per_cycle, + blocks_per_commitment, + blocks_per_stake_snapshot, + max_operations_time_to_live ) = + if block_time_is_30s then + ( increase c.blocks_per_cycle, + increase c.blocks_per_commitment, + increase c.blocks_per_stake_snapshot, + 3 * c.max_operations_time_to_live / 2 ) + else + ( c.blocks_per_cycle, + c.blocks_per_commitment, + c.blocks_per_stake_snapshot, + c.max_operations_time_to_live ) + in + get_cycle_eras ctxt >>=? fun cycle_eras -> + let current_era = Level_repr.current_era cycle_eras in + let current_cycle = + let level_position = + Int32.sub level (Raw_level_repr.to_int32 current_era.first_level) + in + Cycle_repr.add + current_era.first_cycle + (Int32.to_int (Int32.div level_position c.blocks_per_cycle)) + in + let new_cycle_era = + Level_repr. + { + first_level = Raw_level_repr.of_int32_exn (Int32.succ level); + first_cycle = Cycle_repr.succ current_cycle; + blocks_per_cycle; + blocks_per_commitment; + } + in + Level_repr.add_cycle_era new_cycle_era cycle_eras + >>?= fun new_cycle_eras -> + set_cycle_eras ctxt new_cycle_eras >>=? fun ctxt -> let constants = Constants_parametric_repr. { preserved_cycles = c.preserved_cycles; - blocks_per_cycle = c.blocks_per_cycle; - blocks_per_commitment = c.blocks_per_commitment; + blocks_per_cycle; + blocks_per_commitment; nonce_revelation_threshold = c.nonce_revelation_threshold; - blocks_per_stake_snapshot = c.blocks_per_stake_snapshot; + blocks_per_stake_snapshot; cycles_per_voting_period = c.cycles_per_voting_period; hard_gas_limit_per_operation = c.hard_gas_limit_per_operation; - hard_gas_limit_per_block = c.hard_gas_limit_per_block; + hard_gas_limit_per_block; proof_of_work_threshold = c.proof_of_work_threshold; minimal_stake = c.minimal_stake; vdf_difficulty = c.vdf_difficulty; seed_nonce_revelation_tip = c.seed_nonce_revelation_tip; origination_size = c.origination_size; - max_operations_time_to_live = c.max_operations_time_to_live; - baking_reward_fixed_portion = c.baking_reward_fixed_portion; - baking_reward_bonus_per_slot = c.baking_reward_bonus_per_slot; - endorsing_reward_per_slot = c.endorsing_reward_per_slot; + max_operations_time_to_live; + baking_reward_fixed_portion; + baking_reward_bonus_per_slot; + endorsing_reward_per_slot; cost_per_byte = c.cost_per_byte; hard_storage_limit_per_operation = c.hard_storage_limit_per_operation; quorum_min = c.quorum_min; quorum_max = c.quorum_max; min_proposal_quorum = c.min_proposal_quorum; - liquidity_baking_subsidy = c.liquidity_baking_subsidy; + liquidity_baking_subsidy; liquidity_baking_toggle_ema_threshold = c.liquidity_baking_toggle_ema_threshold; - minimal_block_delay = c.minimal_block_delay; - delay_increment_per_round = c.delay_increment_per_round; + minimal_block_delay; + delay_increment_per_round; consensus_committee_size = c.consensus_committee_size; - consensus_threshold = c.consensus_threshold; + consensus_threshold (* same as c.consensus_threshold *); minimal_participation_ratio = c.minimal_participation_ratio; max_slashing_period = c.max_slashing_period; frozen_deposits_percentage = c.frozen_deposits_percentage; -- GitLab From 1e49768240f8daf10ed6f45cd6b56541c9cfe22f Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Wed, 12 Jan 2022 10:39:44 +0100 Subject: [PATCH 3/5] Proto/Tests: adapt gas_levels test to new block gas limit --- .../lib_protocol/test/integration/gas/test_gas_levels.ml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/proto_alpha/lib_protocol/test/integration/gas/test_gas_levels.ml b/src/proto_alpha/lib_protocol/test/integration/gas/test_gas_levels.ml index 78100c3c5f81..c7f7a9bc56c8 100644 --- a/src/proto_alpha/lib_protocol/test/integration/gas/test_gas_levels.ml +++ b/src/proto_alpha/lib_protocol/test/integration/gas/test_gas_levels.ml @@ -408,10 +408,12 @@ let test_consume_exactly_all_block_gas () = block_with_one_origination number_of_ops nil_contract >>=? fun (block, src_list, dst) -> (* assumptions: - hard gas limit per operation = 1040000 - hard gas limit per block = 5200000 + hard gas limit per operation = 1_040_000 + hard gas limit per block = 2 * 5_200_000 / 3 = 3_466_666 *) let lld = + (* TODO!!! [(dst, Alpha_context.Gas.Arith.integral_of_int_exn (1040000 / 3))] + * :: *) List.map (fun src -> [(src, dst, Alpha_context.Gas.Arith.integral_of_int_exn 1040000)]) -- GitLab From 08c51712eccb9069461075bfdc6fbd18039c4e1e Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Tue, 18 Jan 2022 18:35:25 +0100 Subject: [PATCH 4/5] Docs/Protocols: update changelog for Alpha --- docs/alpha/octez-accuser.html | 167 ++ docs/alpha/octez-baker.html | 188 ++ docs/alpha/octez-client.html | 3685 +++++++++++++++++++++++++++++ docs/api/octez-admin-client.html | 497 ++++ docs/api/octez-codec.html | 155 ++ docs/api/octez-signer.html | 409 ++++ docs/api/octez-snoop.html | 288 +++ docs/kathmandu/active | 1 + docs/kathmandu/kathmandu | 1 + docs/kathmandu/octez-accuser.html | 0 docs/kathmandu/octez-baker.html | 0 docs/kathmandu/octez-client.html | 3399 ++++++++++++++++++++++++++ docs/lima/octez-accuser.html | 0 docs/lima/octez-baker.html | 0 docs/lima/octez-client.html | 3672 ++++++++++++++++++++++++++++ docs/protocols/alpha.rst | 65 + 16 files changed, 12527 insertions(+) create mode 100644 docs/alpha/octez-accuser.html create mode 100644 docs/alpha/octez-baker.html create mode 100644 docs/alpha/octez-client.html create mode 100644 docs/api/octez-admin-client.html create mode 100644 docs/api/octez-codec.html create mode 100644 docs/api/octez-signer.html create mode 100644 docs/api/octez-snoop.html create mode 120000 docs/kathmandu/active create mode 120000 docs/kathmandu/kathmandu create mode 100644 docs/kathmandu/octez-accuser.html create mode 100644 docs/kathmandu/octez-baker.html create mode 100644 docs/kathmandu/octez-client.html create mode 100644 docs/lima/octez-accuser.html create mode 100644 docs/lima/octez-baker.html create mode 100644 docs/lima/octez-client.html diff --git a/docs/alpha/octez-accuser.html b/docs/alpha/octez-accuser.html new file mode 100644 index 000000000000..d6bd6fe387f7 --- /dev/null +++ b/docs/alpha/octez-accuser.html @@ -0,0 +1,167 @@ + +

Usage

+ +
    +
  • +
    octez-accuser-alpha [global options] command [command options]
    +
    • + +
  • +
    octez-accuser-alpha --help (for global options)
    +
    • + +
  • +
    octez-accuser-alpha [global options] command --help (for command options)
    +
    • + +
  • +
    octez-accuser-alpha --version (for version information)
    +
    • +
+ + +

To browse the documentation

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

Global options (must come before the command)

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

Access the documentation

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

Commands related to the 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.
    +
    • +
+ diff --git a/docs/alpha/octez-baker.html b/docs/alpha/octez-baker.html new file mode 100644 index 000000000000..999cf2526588 --- /dev/null +++ b/docs/alpha/octez-baker.html @@ -0,0 +1,188 @@ + +

Usage

+ +
    +
  • +
    octez-baker-alpha [global options] command [command options]
    +
    • + +
  • +
    octez-baker-alpha --help (for global options)
    +
    • + +
  • +
    octez-baker-alpha [global options] command --help (for command options)
    +
    • + +
  • +
    octez-baker-alpha --version (for version information)
    +
    • +
+ + +

To browse the documentation

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

Global options (must come before the command)

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

Access the documentation

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

Commands related to the 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/baking right or name of the consensus key signing on the delegate's behalf + 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.
    +
    • +
+ diff --git a/docs/alpha/octez-client.html b/docs/alpha/octez-client.html new file mode 100644 index 000000000000..b5960e619725 --- /dev/null +++ b/docs/alpha/octez-client.html @@ -0,0 +1,3685 @@ + +

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

Access the documentation

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

Commands 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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 alpha.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`.
    +
    • +
+ + +

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 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. +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 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`. +-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 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`.
    +
    • + +
  • +
    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`.
    +
    • + +
  • +
    register key mgr as delegate with consensus key key [--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. +key: the consensus key + 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 +--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`.
    +
    • + +
  • +
    set consensus key for mgr to key [--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>]
    + +
    Update the consensus key of 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. +key: the consensus key + 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 +--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`.
    +
    • + +
  • +
    drain delegate mgr to key [-D --dry-run] [--verbose-signing]
    + +
    Drain all funds from 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. +key: the consensus 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. +-D --dry-run: don't inject the operation, just display it +--verbose-signing: display extra information before signing the operation
    +
    • + +
  • +
    drain delegate mgr to key with key [-D --dry-run] [--verbose-signing]
    + +
    Drain all funds from 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. +key: the destination 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. +key: the consensus 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. +-D --dry-run: don't inject the operation, just display it +--verbose-signing: display extra information before signing the operation
    +
    • + +
  • +
    submit proposals for delegate [proposal...] [-D --dry-run] [--verbose-signing] [--force]
    + +
    Submit protocol proposals +delegate: the delegate who makes the proposal + 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. +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 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. +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 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`. +-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 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`. +-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 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. +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 a transaction rollup. +transaction rollup address: Tx rollup that have its commitment finalized. + Transaction rollup address encoded in a base58 string. +src: Account finalizing the commitment. + 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 +-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 a transaction rollup. +src: Account that owns the bond. + 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. +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 a transaction rollup. +transaction rollup address: Tx rollup that have its commitment removed. + Transaction rollup address encoded in a base58 string. +src: name of the account removing the commitment. + 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`. +-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 a transaction rollup. +transaction rollup address: Tx rollup that have one of its 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 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`. +-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 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. +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 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. +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 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. +sc_rollup_kind: Kind of the smart-contract rollup to be originated. +parameters_type: The interface of the smart-contract rollup including its entrypoints and their signatures. +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 [--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 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`. +-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
    +
    • + +
  • +
    publish commitment from src for sc rollup sc_rollup with compressed state compressed_state at inbox level inbox_level and predecessor predecessor and number of ticks number_of_ticks [--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>]
    + +
    Publish a commitment for a sc rollup +src: Name of the source 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. +sc_rollup: The address of the sc rollup where the commitment will be published. +compressed_state: The compressed state of the sc rollup for the commitment. +inbox_level: The inbox level for the commitment. +predecessor: The hash of the commitment's predecessor +number_of_ticks: The number of ticks for the commitment. +--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`.
    +
    • + +
  • +
    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 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. +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`.
    +
    • + +
  • +
    timeout dispute on sc rollup sc_rollup with staker from src [--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>]
    + +
    Timeout a staker from dispute on a smart-contract rollup. +sc_rollup: The address of the smart-contract rollup where the staker of the dispute has timed-out. +staker: One of the players involved in the dispute. + 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: Name of the source 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. +-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 and output proof output proof [--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 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. +cemented commitment: The hash of the cemented commitment of the rollup. +output proof: The output proof containing the outbox level, index and message. +--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 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. +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 fundraiser account name with code [-D --dry-run]
    + +
    Activate a fundraiser account. +name: existing public key hash alias +code: Activation code obtained from the Tezos foundation. +-D --dry-run: don't inject the operation, just display it
    +
    • + +
  • +
    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 contract used storage space for src
    + +
    Get the used storage space 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 paid storage space for src
    + +
    Get the paid storage space 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 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.
    +
    • + +
  • +
    get ticket balance for src with ticketer ticketer and type ticket content type and content ticket content
    + +
    Get contract's balance of ticket with specified ticketer, content type, and content. +src: Source contract. + Can be a literal, an alias, or a key (autodetected in order). + Use 'text:literal', 'alias:name', 'key:name' to force. +ticketer: Ticketer contract of the ticket. + Can be a literal, an alias, or a key (autodetected in order). + Use 'text:literal', 'alias:name', 'key:name' to force. +ticket content type: Type of the content of the ticket. +ticket content: Content of the ticket.
    +
    • + +
  • +
    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
    +
    • +
+ + +

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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 <src>] [-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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +-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 <src>] [-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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +-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 <src>] [-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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +-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/baking right or name of the consensus key signing on the delegate's behalf + 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/baking right or name of the consensus key signing on the delegate's behalf + 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/baking right or name of the consensus key signing on the delegate's behalf + 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/baking right or name of the consensus key signing on the delegate's behalf + 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>]
    + +
    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`.
    +
    • + +
  • +
    gen vanity keys new matching [words...] [-P --prefix] [-I --ignore-case] [-f --force]
    + +
    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
    +
    • + +
  • +
    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 fundraiser secret key new [-f --force]
    + +
    Add a fundraiser secret key to the wallet. +new: new secret_key alias +-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]
    + +
    Generate a pair of BLS keys. +new: new Aggregate_secret_key alias +-f --force: overwrite existing Aggregate_secret_key
    +
    • + +
  • +
    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`.
    +
    • +
+ diff --git a/docs/api/octez-admin-client.html b/docs/api/octez-admin-client.html new file mode 100644 index 000000000000..4e530bee4b5b --- /dev/null +++ b/docs/api/octez-admin-client.html @@ -0,0 +1,497 @@ + +

Usage

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

To browse the documentation

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

Global options (must come before the command)

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

Access the documentation

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

Commands to inspect the event-logging framework

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

Commands for the low level RPC layer

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

Commands for managing protocols

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

Commands for monitoring and controlling p2p-layer state

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

Commands to perform privileged operations on the node

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

Commands to report the node's status

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

Commands for editing and viewing the client's config file

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

Miscellaneous commands

+ +
    +
  • +
    list understood protocols
    + +
    List the protocol versions that this client understands.
    +
    • +
+ diff --git a/docs/api/octez-codec.html b/docs/api/octez-codec.html new file mode 100644 index 000000000000..c84773076334 --- /dev/null +++ b/docs/api/octez-codec.html @@ -0,0 +1,155 @@ + +

Usage

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

To browse the documentation

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

Global options (must come before the command)

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

Access the documentation

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

Commands to handle encodings

+ +
    +
  • +
    list encodings
    + +
    List the registered encoding in Tezos.
    +
    • + +
  • +
    dump encodings [--compact]
    + +
    Dump a JSON description of all registered encodings. +--compact: Output JSON descriptions without extraneous whitespace characters
    +
    • + +
  • +
    dump encoding id [--compact]
    + +
    Dump a JSON description of a given registered encoding. +id: Encoding identifier +--compact: Output JSON description without extraneous whitespace characters
    +
    • + +
  • +
    encode id from data
    + +
    Encode the given JSON data into binary using the provided encoding identifier. +id: Encoding identifier +data: JSON file or data
    +
    • + +
  • +
    decode id from data
    + +
    Decode the binary encoded data into JSON using the provided encoding identifier. +id: Encoding identifier +data: Hex-encoded binary-encoded data or name of file containing the data
    +
    • + +
  • +
    display id from binary data
    + +
    Display the binary encoded data using the provided encoding identifier. +id: Encoding identifier +data: Hex-encoded binary-encoded data or name of file containing the data
    +
    • + +
  • +
    display id from json data
    + +
    Display the JSON encoded data using the provided encoding identifier. +id: Encoding identifier +data: JSON file or data
    +
    • + +
  • +
    describe id binary schema
    + +
    Describe the binary schema associated to the provided encoding identifier. +id: Encoding identifier +
    +
    • + +
  • +
    describe id json schema
    + +
    Describe the JSON schema associated to the provided encoding identifier. +id: Encoding identifier +
    +
    • + +
  • +
    slice data
    + +
    Attempts to slice an hex-encoded binary value with all known encodings. +data: Hex-encoded binary-encoded data or name of file containing the data
    +
    • + +
  • +
    slice data with encoding id [--format <FORMAT>]
    + +
    Slice an hex-encoded binary value with the specified encoding. +data: Hex-encoded binary-encoded data or name of file containing the data +id: Encoding identifier +--format <FORMAT>: The format to print the output in: json, pretty, or waterfall. + Defaults to `pretty`.
    +
    • +
+ diff --git a/docs/api/octez-signer.html b/docs/api/octez-signer.html new file mode 100644 index 000000000000..2d7896e78e06 --- /dev/null +++ b/docs/api/octez-signer.html @@ -0,0 +1,409 @@ + +

Usage

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

To browse the documentation

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

Global options (must come before the command)

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

Access the documentation

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

Commands specific to the signing daemon

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

Commands for managing the wallet of cryptographic keys

+ +
    +
  • +
    stresstest gen keys keys_count [--alias-prefix <PREFIX>]
    + +
    Generate an array of accounts for testing purposes. +keys_count: How many keys to generate +--alias-prefix <PREFIX>: use a custom alias prefix (default: bootstrap). Keys will be generated with alias "PREFIX<ID>" where ID is unique for all key
    +
    • + +
  • +
    list signing schemes
    + +
    List supported signing schemes. + Signing schemes are identifiers for signer modules: the built-in signing + routines, a hardware wallet, an external agent, etc. + Each signer has its own format for describing secret keys, such a raw + secret key for the default `unencrypted` scheme, the path on a hardware + security module, an alias for an external agent, etc. + This command gives the list of signer modules that this version of the + tezos client supports.
    +
    • + +
  • +
    gen keys new [-f --force] [-s --sig <ed25519|secp256k1|p256>] [--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
    +
    • +
+ diff --git a/docs/api/octez-snoop.html b/docs/api/octez-snoop.html new file mode 100644 index 000000000000..a0762cb6dc81 --- /dev/null +++ b/docs/api/octez-snoop.html @@ -0,0 +1,288 @@ + +

Usage

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

To browse the documentation

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

Global options (must come before the command)

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

Access the documentation

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

Command for generating random sapling transactions

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

Command for generating random Michelson code and data

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

Commands for manipulating config files

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

Commands for displaying lists

+ +
    +
  • +
    list all benchmarks [-t --show-tags]
    + +
    List all implemented benchmarks +-t --show-tags: Show the tags of the benchmarks
    +
    • + +
  • +
    list all tags
    + +
    List all available tags
    +
    • + +
  • +
    list benchmarks with tags any of [TAG...] [-t --show-tags]
    + +
    List all implemented benchmarks containing any of the given tags +TAG: Tag of a benchmark +-t --show-tags: Show the tags of the benchmarks
    +
    • + +
  • +
    list benchmarks with tags all of [TAG...] [-t --show-tags]
    + +
    List all implemented benchmarks containing all of the given tags +TAG: Tag of a benchmark +-t --show-tags: Show the tags of the benchmarks
    +
    • + +
  • +
    list benchmarks with tags exactly [TAG...] [-t --show-tags]
    + +
    List all implemented benchmarks containing exactly the given tags +TAG: Tag of a benchmark +-t --show-tags: Show the tags of the benchmarks
    +
    • + +
  • +
    list benchmarks in NAMESPACE [-t --show-tags]
    + +
    List all benchmarks in the given namespace +NAMESPACE: Namespace of a set of benchmarks +-t --show-tags: Show the tags of the benchmarks
    +
    • +
+ + +

Command for generating code

+ +
    +
  • +
    generate code using solution SOLUTION-FILE and model MODEL-NAME [--fixed-point <json-config-file>]
    + +
    Generate code for a specific model +SOLUTION-FILE: File containing solution, as obtained using the --save-solution switch +MODEL-NAME: Name of the model for which to generate code +--fixed-point <json-config-file>: Apply fixed-point transform to the model
    +
    • + +
  • +
    generate code using solution SOLUTION-FILE for all models matching REGEXP [--fixed-point <json-config-file>]
    + +
    Generate code for all models matching regexp +SOLUTION-FILE: File containing solution, as obtained using the --save-solution switch +REGEXP: Regular expression on model names +--fixed-point <json-config-file>: Apply fixed-point transform to the model
    +
    • +
+ + +

Command for infering parameters of cost models

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

Commands for benchmarking parts of the protocol

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

Miscellaneous commands

+ +
    +
  • +
    generate default-config [--save-to <filename>]
    + +
    Show the default configurations for fixed-point code generation as json +--save-to <filename>: save default config to file
    +
    • +
+ diff --git a/docs/kathmandu/active b/docs/kathmandu/active new file mode 120000 index 000000000000..6811ae8d9ee2 --- /dev/null +++ b/docs/kathmandu/active @@ -0,0 +1 @@ +active \ No newline at end of file diff --git a/docs/kathmandu/kathmandu b/docs/kathmandu/kathmandu new file mode 120000 index 000000000000..cfa46ad6f0a2 --- /dev/null +++ b/docs/kathmandu/kathmandu @@ -0,0 +1 @@ +kathmandu \ No newline at end of file diff --git a/docs/kathmandu/octez-accuser.html b/docs/kathmandu/octez-accuser.html new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/kathmandu/octez-baker.html b/docs/kathmandu/octez-baker.html new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/kathmandu/octez-client.html b/docs/kathmandu/octez-client.html new file mode 100644 index 000000000000..20015b29578a --- /dev/null +++ b/docs/kathmandu/octez-client.html @@ -0,0 +1,3399 @@ + +

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

Access the documentation

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

Commands 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`.
    +
    • +
+ + +

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 fundraiser account name with code [-D --dry-run]
    + +
    Activate a fundraiser account. +name: existing public key hash alias +code: Activation code obtained from the Tezos foundation. +-D --dry-run: don't inject the operation, just display it
    +
    • + +
  • +
    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
    +
    • +
+ + +

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>]
    + +
    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`.
    +
    • + +
  • +
    gen vanity keys new matching [words...] [-P --prefix] [-I --ignore-case] [-f --force]
    + +
    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
    +
    • + +
  • +
    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 fundraiser secret key new [-f --force]
    + +
    Add a fundraiser secret key to the wallet. +new: new secret_key alias +-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]
    + +
    Generate a pair of BLS keys. +new: new Aggregate_secret_key alias +-f --force: overwrite existing Aggregate_secret_key
    +
    • + +
  • +
    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`.
    +
    • +
+ diff --git a/docs/lima/octez-accuser.html b/docs/lima/octez-accuser.html new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/lima/octez-baker.html b/docs/lima/octez-baker.html new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/lima/octez-client.html b/docs/lima/octez-client.html new file mode 100644 index 000000000000..664bd0cd8c51 --- /dev/null +++ b/docs/lima/octez-client.html @@ -0,0 +1,3672 @@ + +

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

Access the documentation

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

Commands 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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 015-PtLimaPt.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`.
    +
    • +
+ + +

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 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. +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 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`. +-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 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`.
    +
    • + +
  • +
    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`.
    +
    • + +
  • +
    register key mgr as delegate with consensus key key [--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. +key: the consensus key + 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 +--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`.
    +
    • + +
  • +
    set consensus key for mgr to key [--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>]
    + +
    Update the consensus key of 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. +key: the consensus key + 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 +--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`.
    +
    • + +
  • +
    drain delegate mgr to key [-D --dry-run] [--verbose-signing]
    + +
    Drain all funds from 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. +key: the consensus 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. +-D --dry-run: don't inject the operation, just display it +--verbose-signing: display extra information before signing the operation
    +
    • + +
  • +
    drain delegate mgr to key with key [-D --dry-run] [--verbose-signing]
    + +
    Drain all funds from 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. +key: the destination 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. +key: the consensus 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. +-D --dry-run: don't inject the operation, just display it +--verbose-signing: display extra information before signing the operation
    +
    • + +
  • +
    submit proposals for delegate [proposal...] [-D --dry-run] [--verbose-signing] [--force]
    + +
    Submit protocol proposals +delegate: the delegate who makes the proposal + 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. +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 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. +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 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`. +-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 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`. +-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 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. +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 a transaction rollup. +transaction rollup address: Tx rollup that have its commitment finalized. + Transaction rollup address encoded in a base58 string. +src: Account finalizing the commitment. + 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 +-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 a transaction rollup. +src: Account that owns the bond. + 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. +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 a transaction rollup. +transaction rollup address: Tx rollup that have its commitment removed. + Transaction rollup address encoded in a base58 string. +src: name of the account removing the commitment. + 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`. +-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 a transaction rollup. +transaction rollup address: Tx rollup that have one of its 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 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`. +-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 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. +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 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. +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 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. +sc_rollup_kind: Kind of the smart-contract rollup to be originated. +parameters_type: The interface of the smart-contract rollup including its entrypoints and their signatures. +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 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. +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
    +
    • + +
  • +
    publish commitment from src for sc rollup sc_rollup with compressed state compressed_state at inbox level inbox_level and predecessor predecessor and number of ticks number_of_ticks [--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>]
    + +
    Publish a commitment for a sc rollup +src: Name of the source 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. +sc_rollup: The address of the sc rollup where the commitment will be published. +compressed_state: The compressed state of the sc rollup for the commitment. +inbox_level: The inbox level for the commitment. +predecessor: The hash of the commitment's predecessor +number_of_ticks: The number of ticks for the commitment. +--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`.
    +
    • + +
  • +
    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 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. +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`.
    +
    • + +
  • +
    timeout dispute on sc rollup sc_rollup with staker from src [--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>]
    + +
    Timeout a staker from dispute on a smart-contract rollup. +sc_rollup: The address of the smart-contract rollup where the staker of the dispute has timed-out. +staker: One of the players involved in the dispute. + 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: Name of the source 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. +-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 and output proof output proof [--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 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. +cemented commitment: The hash of the cemented commitment of the rollup. +output proof: The output proof containing the outbox level, index and message. +--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 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. +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 fundraiser account name with code [-D --dry-run]
    + +
    Activate a fundraiser account. +name: existing public key hash alias +code: Activation code obtained from the Tezos foundation. +-D --dry-run: don't inject the operation, just display it
    +
    • + +
  • +
    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 contract used storage space for src
    + +
    Get the used storage space 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 paid storage space for src
    + +
    Get the paid storage space 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 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
    +
    • +
+ + +

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 <src>] [--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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +--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 <src>] [-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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +-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 <src>] [-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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +-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 <src>] [-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 <src>: name of the payer (i.e. SOURCE) contract for the transaction + 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. +-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/baking right or name of the consensus key signing on the delegate's behalf + 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/baking right or name of the consensus key signing on the delegate's behalf + 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/baking right or name of the consensus key signing on the delegate's behalf + 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/baking right or name of the consensus key signing on the delegate's behalf + 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>]
    + +
    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`.
    +
    • + +
  • +
    gen vanity keys new matching [words...] [-P --prefix] [-I --ignore-case] [-f --force]
    + +
    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
    +
    • + +
  • +
    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 fundraiser secret key new [-f --force]
    + +
    Add a fundraiser secret key to the wallet. +new: new secret_key alias +-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]
    + +
    Generate a pair of BLS keys. +new: new Aggregate_secret_key alias +-f --force: overwrite existing Aggregate_secret_key
    +
    • + +
  • +
    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`.
    +
    • +
+ diff --git a/docs/protocols/alpha.rst b/docs/protocols/alpha.rst index 776f36c96d5a..ba1b3e99b0e6 100644 --- a/docs/protocols/alpha.rst +++ b/docs/protocols/alpha.rst @@ -71,6 +71,71 @@ Cryptography Bug Fixes --------- +20s Block Times (MR :gl:`!4163`) +-------------------------------- + +Blocks times have been reduced from 30 seconds to 20 seconds. +That is, a block can be produced with a delay of 20 seconds with respect to the previous block, if both blocks have round 0. +This change comes with updating many related protocol parameters in order to match the reduced block times. +In particular, the following quantities are kept the same: + +- the minimal time period of a cycle (namely, 2 days, 20 hours, and 16 minutes), +- TODO: nonce_revelation_threshold +- the number of nonce commitments per cycle (namely, 128), +- the number of stake snapshots per cycle (namely, 16), +- the maximum rewards per minute (namely 80 tez), and therefore roughly the same inflation, +- the minimal "time to live" of an operation (namely, 1 hour), +- the block gas limit per minute (namely 10400000 gas), +- the ratio between the liquidity baking subsidy and the maximum rewards per block (namely, 1/16). + +.. list-table:: TODO Changes to protocol parameters + :widths: 50 25 25 + :header-rows: 1 + + * - Parameter (unit) + - Old (Ithaca) value + - New value + * - ``minimal_block_delay`` (seconds) + - ``30`` + - ``20`` + * - ``delay_increment_per_round`` (seconds) + - ``15`` + - ``10`` + * - ``blocks_per_cycle`` (blocks) + - ``8192`` + - ``12288`` + * - ``blocks_per_commitment`` (blocks) + - ``64`` + - ``96`` + * - ``blocks_per_stake_snapshot`` (blocks) + - ``512`` + - ``768`` + * - ``blocks_per_voting_period`` (blocks) + - ``40960`` + - ``61440`` + * - ``max_operations_time_to_live`` (blocks) + - ``120`` + - ``180`` + * - ``hard_gas_limit_per_block`` (gas unit) + - ``5200000`` + - ``3466666`` + * - ``baking_reward_fixed_portion`` (mutez) + - ``10000000`` + - ``6666666`` + * - ``baking_reward_bonus_per_slot`` (mutez) + - ``4286`` + - ``2857`` + * - ``endorsing_reward_per_slot`` (mutez) + - ``2857`` + - ``1904`` + * - ``liquidity_baking_subsidy`` (mutez) + - ``2500000`` + - ``1666666`` + * - ``liquidity_baking_sunset_level`` (level) + - ``3063809`` + - H activation level + 15 voting periods + + Minor Changes ------------- -- GitLab From 28493652b78a5a3837527eb846403dc08f736570 Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Wed, 26 Jan 2022 11:11:01 +0100 Subject: [PATCH 5/5] Docs/Alpha: update values of parameters --- docs/alpha/consensus.rst | 10 +++++----- docs/alpha/liquidity_baking.rst | 2 +- docs/alpha/proof_of_stake.rst | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/alpha/consensus.rst b/docs/alpha/consensus.rst index 7dbc919a1bf1..c6626b41ffd9 100644 --- a/docs/alpha/consensus.rst +++ b/docs/alpha/consensus.rst @@ -414,9 +414,9 @@ Consensus related protocol parameters * - ``CONSENSUS_THRESHOLD`` - ``ceil(2 * CONSENSUS_COMMITTEE_SIZE / 3)`` = 4667 * - ``MINIMAL_BLOCK_DELAY`` - - 30s + - 20s * - ``DELAY_INCREMENT_PER_ROUND`` - - 15s + - 10s * - ``MINIMAL_PARTICIPATION_RATIO`` - 2/3 * - ``FROZEN_DEPOSITS_PERCENTAGE`` @@ -428,11 +428,11 @@ Consensus related protocol parameters * - ``RATIO_OF_FROZEN_DEPOSITS_SLASHED_PER_DOUBLE_ENDORSEMENT`` - 1/2 * - ``BAKING_REWARD_FIXED_PORTION`` - - 10 tez + - 6.666666 tez * - ``BAKING_REWARD_BONUS_PER_SLOT`` - - ``bonus / (CONSENSUS_COMMITTEE_SIZE / 3)`` = 0.004286 tez + - ``bonus / (CONSENSUS_COMMITTEE_SIZE / 3)`` = 0.002857 tez * - ``ENDORSING_REWARD_PER_SLOT`` - - ``endorsing_reward / CONSENSUS_COMMITTEE_SIZE`` = 0.002857 tez + - ``endorsing_reward / CONSENSUS_COMMITTEE_SIZE`` = 0.001904 tez These are a subset of the :ref:`protocol constants `. diff --git a/docs/alpha/liquidity_baking.rst b/docs/alpha/liquidity_baking.rst index 19f4bd704f37..dc66151965c7 100644 --- a/docs/alpha/liquidity_baking.rst +++ b/docs/alpha/liquidity_baking.rst @@ -26,7 +26,7 @@ The LIGO and Michelson code for these contracts, as well as detailed documentati Subsidy ~~~~~~~ -At every block in the chain, a small amount of tez is minted and credited to the CPMM contract, and the CPMM's ``%default`` entrypoint is called to update the ``xtz_pool`` balance in its storage. The amount that is minted and sent to the CPMM contract is 1/16th of the rewards for a block; currently these rewards are 40 tez per block so the amount that is sent to the CPMM contract is 2.5 tez per block. +At every block in the chain, a small amount of tez is minted and credited to the CPMM contract, and the CPMM's ``%default`` entrypoint is called to update the ``xtz_pool`` balance in its storage. The amount that is minted and sent to the CPMM contract is 1/16th of the rewards for a block of round 0 with all endorsements; currently these rewards are 80 tez per minute so the amount that is sent to the CPMM contract is 1.666666 tez per block. So the credits to the CPMM contract can be accounted for by indexers, they are included in block metadata as a balance update with a new constructor for ``update_origin``, ``Subsidy``. diff --git a/docs/alpha/proof_of_stake.rst b/docs/alpha/proof_of_stake.rst index 450f9e9d2696..b38a29be7a54 100644 --- a/docs/alpha/proof_of_stake.rst +++ b/docs/alpha/proof_of_stake.rst @@ -149,13 +149,13 @@ Proof-of-stake parameters * - Parameter name - Parameter value * - ``BLOCKS_PER_CYCLE`` - - 8192 blocks + - 12288 blocks * - ``PRESERVED_CYCLES`` - 5 cycles * - ``TOKENS_PER_ROLL`` - 6,000 ꜩ * - ``BLOCKS_PER_STAKE_SNAPSHOT`` - - 512 blocks + - 768 blocks Further External Resources -- GitLab