· 5 years ago · Nov 27, 2019, 09:58 PM
1./tezos-client man
2
3Usage:
4 tezos-client [global options] command [command options]
5 tezos-client --help (for global options)
6 tezos-client [global options] command --help (for command options)
7
8To browse the documentation:
9 tezos-client [global options] man (for a list of commands)
10 tezos-client [global options] man -v 3 (for the full manual)
11
12Global options (must come before the command):
13 -d --base-dir <path>: client data directory
14 -c --config-file <path>: configuration file
15 -t --timings: show RPC request times
16 --chain <hash|tag>: chain on which to apply contextual commands (possible tags are 'main' and 'test')
17 -b --block <hash|tag>: block on which to apply contextual commands (possible tags are 'head' and 'genesis')
18 -w --wait <none|<int>>: how many confirmation blocks before to consider an operation as included
19 -p --protocol <hash>: use commands of a specific protocol
20 -l --log-requests: log all requests to the node
21 -A --addr <IP addr|host>: IP address of the node
22 -P --port <number>: RPC port of the node
23 -S --tls: use TLS to connect to node.
24 -R --remote-signer <uri>: URI of the remote signer
25 -f --password-filename <filename>: path to the password filename
26
27Access the documentation:
28 man [<keyword>...] [-v --verbosity <0|1|2|3>]
29 [--format <plain|colors|html>]
30 Print documentation of commands.
31 <keyword>: keyword to search for
32 -v --verbosity <0|1|2|3>: level of details
33 --format <plain|colors|html>: the manual's output format
34
35Commands for managing a multisig smart contract:
36 deploy multisig <new_multisig> transferring <qty> from <src> with threshold <threshold> on public keys [<key>...] [--fee <amount>]
37 [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
38 [--delegate <address>] [-f --force] [-q --no-print-source]
39 [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>]
40 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
41 [--fee-cap <amount>] [--burn-cap <amount>]
42 Originate a new multisig contract.
43 <new_multisig>: name of the new multisig contract
44 <qty>: amount taken from source in ꜩ
45 <src>: name of the source contract
46 <threshold>: Number of required signatures
47 <key>: Each signer of the multisig contract
48 --fee <amount>: fee in ꜩ to pay to the baker
49 -D --dry-run: don't inject the operation, just display it
50 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
51 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
52 --delegate <address>: delegate of the contract
53 -f --force: overwrite existing keys
54 -q --no-print-source: don't print the source code
55 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
56 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
57 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
58 --force-low-fee: Don't check that the fee is lower than the estimated default value
59 --fee-cap <amount>: Set the fee cap
60 --burn-cap <amount>: Set the burn cap
61 prepare multisig transaction on <multisig> transferring <qty> to <dst> [--bytes-only]
62 Display the threshold, public keys, and byte sequence to sign for a multisigned transfer.
63 <multisig>: name of the originated multisig contract
64 <qty>: amount taken from source in ꜩ
65 <dst>: name/literal of the destination contract
66 --bytes-only: return only the byte sequence to be signed
67 prepare multisig transaction on <multisig> setting delegate to <dlgt> [--bytes-only]
68 Display the threshold, public keys, and byte sequence to sign for a multisigned delegate change.
69 <multisig>: name of the originated multisig contract
70 <dlgt>: new delegate of the new multisig contract
71 --bytes-only: return only the byte sequence to be signed
72 prepare multisig transaction on <multisig> withdrawing delegate [--bytes-only]
73 Display the threshold, public keys, and byte sequence to sign for a multisigned delegate withdraw.
74 <multisig>: name of the originated multisig contract
75 --bytes-only: return only the byte sequence to be signed
76 prepare multisig transaction on <multisig> setting threshold to <threshold> and public keys to [<key>...] [--bytes-only]
77 Display the threshold, public keys, and byte sequence to sign for a multisigned change of keys and threshold.
78 <multisig>: name of the originated multisig contract
79 <threshold>: Number of required signatures
80 <key>: Each signer of the multisig contract
81 --bytes-only: return only the byte sequence to be signed
82 sign multisig transaction on <multisig> transferring <qty> to <dst> using secret key <key>
83 Sign a transaction for a multisig contract.
84 <multisig>: name of the originated multisig contract
85 <qty>: amount taken from source in ꜩ
86 <dst>: name/literal of the destination contract
87 <key>: Secret key corresponding to one of the public keys stored on the multisig contract
88 sign multisig transaction on <multisig> setting delegate to <dlgt> using secret key <key>
89 Sign a delegate change for a multisig contract.
90 <multisig>: name of the originated multisig contract
91 <dlgt>: new delegate of the new multisig contract
92 <key>: Secret key corresponding to one of the public keys stored on the multisig contract
93 sign multisig transaction on <multisig> withdrawing delegate using secret key <key>
94 Sign a delegate withdraw for a multisig contract.
95 <multisig>: name of the originated multisig contract
96 <key>: Secret key corresponding to one of the public keys stored on the multisig contract
97 sign multisig transaction on <multisig> using secret key <key> setting threshold to <threshold> and public keys to [<key>...]
98 Sign a change of public keys and threshold for a multisig contract.
99 <multisig>: name of the originated multisig contract
100 <key>: Secret key corresponding to one of the public keys stored on the multisig contract
101 <threshold>: Number of required signatures
102 <key>: Each signer of the multisig contract
103 from multisig contract <multisig> transfer <qty> to <dst> on behalf of <src> with signatures [<signature>...] [--fee <amount>]
104 [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
105 [-C --counter <counter>] [-q --no-print-source]
106 [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>]
107 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
108 [--fee-cap <amount>] [--burn-cap <amount>]
109 Transfer tokens using a multisig contract.
110 <multisig>: name/literal of the multisig contract
111 <qty>: amount taken from the multisig contract in ꜩ
112 <dst>: name/literal of the destination contract
113 <src>: source calling the multisig contract
114 <signature>: Each signer of the multisig contract
115 --fee <amount>: fee in ꜩ to pay to the baker
116 -D --dry-run: don't inject the operation, just display it
117 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
118 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
119 -C --counter <counter>: Set the counter to be used by the transaction
120 -q --no-print-source: don't print the source code
121 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
122 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
123 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
124 --force-low-fee: Don't check that the fee is lower than the estimated default value
125 --fee-cap <amount>: Set the fee cap
126 --burn-cap <amount>: Set the burn cap
127 set delegate of multisig contract <multisig> to <dlgt> on behalf of <src> with signatures [<signature>...] [--fee <amount>]
128 [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
129 [-C --counter <counter>] [-q --no-print-source]
130 [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>]
131 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
132 [--fee-cap <amount>] [--burn-cap <amount>]
133 Change the delegate of a multisig contract.
134 <multisig>: name of the originated multisig contract
135 <dlgt>: new delegate of the new multisig contract
136 <src>: source calling the multisig contract
137 <signature>: Each signer of the multisig contract
138 --fee <amount>: fee in ꜩ to pay to the baker
139 -D --dry-run: don't inject the operation, just display it
140 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
141 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
142 -C --counter <counter>: Set the counter to be used by the transaction
143 -q --no-print-source: don't print the source code
144 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
145 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
146 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
147 --force-low-fee: Don't check that the fee is lower than the estimated default value
148 --fee-cap <amount>: Set the fee cap
149 --burn-cap <amount>: Set the burn cap
150 withdraw delegate of multisig contract <multisig> on behalf of <src> with signatures [<signature>...] [--fee <amount>]
151 [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
152 [-C --counter <counter>] [-q --no-print-source]
153 [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>]
154 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
155 [--fee-cap <amount>] [--burn-cap <amount>]
156 Withdrow the delegate of a multisig contract.
157 <multisig>: name of the originated multisig contract
158 <src>: source calling the multisig contract
159 <signature>: Each signer of the multisig contract
160 --fee <amount>: fee in ꜩ to pay to the baker
161 -D --dry-run: don't inject the operation, just display it
162 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
163 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
164 -C --counter <counter>: Set the counter to be used by the transaction
165 -q --no-print-source: don't print the source code
166 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
167 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
168 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
169 --force-low-fee: Don't check that the fee is lower than the estimated default value
170 --fee-cap <amount>: Set the fee cap
171 --burn-cap <amount>: Set the burn cap
172 run transaction <bytes> on multisig contract <multisig> on behalf of <src> with signatures [<signature>...] [--fee <amount>]
173 [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
174 [-C --counter <counter>] [-q --no-print-source]
175 [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>]
176 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
177 [--fee-cap <amount>] [--burn-cap <amount>]
178 Run a transaction described by a sequence of bytes on a multisig contract.
179 <bytes>: the sequence of bytes to deserialize as a multisig action, can be obtained by one of the "prepare multisig transaction" commands
180 <multisig>: name of the originated multisig contract
181 <src>: source calling the multisig contract
182 <signature>: Each signer of the multisig contract
183 --fee <amount>: fee in ꜩ to pay to the baker
184 -D --dry-run: don't inject the operation, just display it
185 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
186 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
187 -C --counter <counter>: Set the counter to be used by the transaction
188 -q --no-print-source: don't print the source code
189 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
190 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
191 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
192 --force-low-fee: Don't check that the fee is lower than the estimated default value
193 --fee-cap <amount>: Set the fee cap
194 --burn-cap <amount>: Set the burn cap
195 show supported multisig hashes
196 Show the hashes of the supported multisig contracts.
197
198Binary Description:
199 describe unsigned block header
200 Describe unsigned block header
201 describe unsigned operation
202 Describe unsigned block header
203
204Block contextual commands (see option -block):
205 get timestamp [-s --seconds]
206 Access the timestamp of the block.
207 -s --seconds: output time in seconds
208 list contracts
209 Lists all non empty contracts of the block.
210 get balance for <src>
211 Get the balance of a contract.
212 <src>: source contract
213 get contract storage for <src>
214 Get the storage of a contract.
215 <src>: source contract
216 get big map value for <key> of type <type> in <src>
217 Get the value associated to a key in the big map storage of a contract (deprecated).
218 <key>: the key to look for
219 <type>: type of the key
220 <src>: source contract
221 get element <key> of big map <big_map>
222 Get a value in a big map.
223 <key>: the key to look for
224 <big_map>: identifier of the big_map
225 get contract code for <src>
226 Get the code of a contract.
227 <src>: source contract
228 get contract entrypoint type of <entrypoint> for <src>
229 Get the type of an entrypoint of a contract.
230 <entrypoint>: the entrypoint to describe
231 <src>: source contract
232 get contract entrypoints for <src>
233 Get the entrypoint list of a contract.
234 <src>: source contract
235 get contract unreachable paths for <src>
236 Get the list of unreachable pathsin a contract's parameter type.
237 <src>: source contract
238 get delegate for <src>
239 Get the delegate of a contract.
240 <src>: source contract
241 set delegate for <src> to <mgr> [--fee <amount>] [-D --dry-run]
242 [--verbose-signing] [--minimal-fees <amount>]
243 [--minimal-nanotez-per-byte <amount>]
244 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
245 [--fee-cap <amount>] [--burn-cap <amount>]
246 Set the delegate of a contract.
247 <src>: source contract
248 <mgr>: new delegate of the contract
249 --fee <amount>: fee in ꜩ to pay to the baker
250 -D --dry-run: don't inject the operation, just display it
251 --verbose-signing: display extra information before signing the operation
252 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
253 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
254 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
255 --force-low-fee: Don't check that the fee is lower than the estimated default value
256 --fee-cap <amount>: Set the fee cap
257 --burn-cap <amount>: Set the burn cap
258 withdraw delegate from <src> [--fee <amount>] [-D --dry-run]
259 [--verbose-signing] [--minimal-fees <amount>]
260 [--minimal-nanotez-per-byte <amount>]
261 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
262 [--fee-cap <amount>] [--burn-cap <amount>]
263 Withdraw the delegate from a contract.
264 <src>: source contract
265 --fee <amount>: fee in ꜩ to pay to the baker
266 -D --dry-run: don't inject the operation, just display it
267 --verbose-signing: display extra information before signing the operation
268 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
269 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
270 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
271 --force-low-fee: Don't check that the fee is lower than the estimated default value
272 --fee-cap <amount>: Set the fee cap
273 --burn-cap <amount>: Set the burn cap
274 originate contract <new> transferring <qty> from <src> running <prg> [--fee <amount>]
275 [-D --dry-run] [--verbose-signing] [-G --gas-limit <amount>]
276 [-S --storage-limit <amount>] [--delegate <address>] [-f --force]
277 [--init <data>] [-q --no-print-source] [--minimal-fees <amount>]
278 [--minimal-nanotez-per-byte <amount>]
279 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
280 [--fee-cap <amount>] [--burn-cap <amount>]
281 Launch a smart contract on the blockchain.
282 <new>: name of the new contract
283 <qty>: amount taken from source in ꜩ
284 <src>: name of the source contract
285 <prg>: script of the account
286 --fee <amount>: fee in ꜩ to pay to the baker
287 -D --dry-run: don't inject the operation, just display it
288 --verbose-signing: display extra information before signing the operation
289 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
290 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
291 --delegate <address>: delegate of the contract
292 -f --force: overwrite existing keys
293 --init <data>: initial value of the contract's storage
294 -q --no-print-source: don't print the source code
295 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
296 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
297 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
298 --force-low-fee: Don't check that the fee is lower than the estimated default value
299 --fee-cap <amount>: Set the fee cap
300 --burn-cap <amount>: Set the burn cap
301 transfer <qty> from <src> to <dst> [--fee <amount>] [-D --dry-run]
302 [--verbose-signing] [-G --gas-limit <amount>]
303 [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>]
304 [-q --no-print-source] [--minimal-fees <amount>]
305 [--minimal-nanotez-per-byte <amount>]
306 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
307 [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>]
308 Transfer tokens / call a smart contract.
309 <qty>: amount taken from source in ꜩ
310 <src>: name of the source contract
311 <dst>: name/literal of the destination contract
312 --fee <amount>: fee in ꜩ to pay to the baker
313 -D --dry-run: don't inject the operation, just display it
314 --verbose-signing: display extra information before signing the operation
315 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
316 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
317 -C --counter <counter>: Set the counter to be used by the transaction
318 --arg <data>: argument passed to the contract's script, if needed
319 -q --no-print-source: don't print the source code
320 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
321 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
322 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
323 --force-low-fee: Don't check that the fee is lower than the estimated default value
324 --fee-cap <amount>: Set the fee cap
325 --burn-cap <amount>: Set the burn cap
326 --entrypoint <name>: entrypoint of the smart contract
327 call from <src> to <dst> [--fee <amount>] [-D --dry-run]
328 [--verbose-signing] [-G --gas-limit <amount>]
329 [-S --storage-limit <amount>] [-C --counter <counter>] [--arg <data>]
330 [-q --no-print-source] [--minimal-fees <amount>]
331 [--minimal-nanotez-per-byte <amount>]
332 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
333 [--fee-cap <amount>] [--burn-cap <amount>] [--entrypoint <name>]
334 Call a smart contract (same as 'transfer 0').
335 <src>: name of the source contract
336 <dst>: name/literal of the destination contract
337 --fee <amount>: fee in ꜩ to pay to the baker
338 -D --dry-run: don't inject the operation, just display it
339 --verbose-signing: display extra information before signing the operation
340 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
341 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
342 -C --counter <counter>: Set the counter to be used by the transaction
343 --arg <data>: argument passed to the contract's script, if needed
344 -q --no-print-source: don't print the source code
345 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
346 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
347 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
348 --force-low-fee: Don't check that the fee is lower than the estimated default value
349 --fee-cap <amount>: Set the fee cap
350 --burn-cap <amount>: Set the burn cap
351 --entrypoint <name>: entrypoint of the smart contract
352 reveal key for <src> [--fee <amount>] [-D --dry-run] [--verbose-signing]
353 [--minimal-fees <amount>] [--minimal-nanotez-per-byte <amount>]
354 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
355 [--fee-cap <amount>] [--burn-cap <amount>]
356 Reveal the public key of the contract manager.
357 <src>: name of the source contract
358 --fee <amount>: fee in ꜩ to pay to the baker
359 -D --dry-run: don't inject the operation, just display it
360 --verbose-signing: display extra information before signing the operation
361 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
362 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
363 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
364 --force-low-fee: Don't check that the fee is lower than the estimated default value
365 --fee-cap <amount>: Set the fee cap
366 --burn-cap <amount>: Set the burn cap
367 register key <mgr> as delegate [--fee <amount>] [-D --dry-run]
368 [--verbose-signing] [--minimal-fees <amount>]
369 [--minimal-nanotez-per-byte <amount>]
370 [--minimal-nanotez-per-gas-unit <amount>] [--force-low-fee]
371 [--fee-cap <amount>] [--burn-cap <amount>]
372 Register the public key hash as a delegate.
373 <mgr>: the delegate key
374 --fee <amount>: fee in ꜩ to pay to the baker
375 -D --dry-run: don't inject the operation, just display it
376 --verbose-signing: display extra information before signing the operation
377 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
378 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
379 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
380 --force-low-fee: Don't check that the fee is lower than the estimated default value
381 --fee-cap <amount>: Set the fee cap
382 --burn-cap <amount>: Set the burn cap
383 activate fundraiser account <name> with <code> [-D --dry-run]
384 Activate a fundraiser account.
385 <name>: existing public key hash alias
386 <code>: Activation code obtained from the Tezos foundation.
387 -D --dry-run: don't inject the operation, just display it
388 submit proposals for <delegate> [<proposal>...] [-D --dry-run]
389 [--verbose-signing] [--force]
390 Submit protocol proposals
391 <delegate>: the delegate who makes the proposal
392 <proposal>: the protocol hash proposal to be submitted
393 -D --dry-run: don't inject the operation, just display it
394 --verbose-signing: display extra information before signing the operation
395 --force: Do not fail when the checks that try to prevent the user from shooting themselves in the foot do.
396 submit ballot for <delegate> <proposal> <ballot> [-D --dry-run]
397 Submit a ballot
398 <delegate>: the delegate who votes
399 <proposal>: the protocol hash proposal to vote for
400 <ballot>: the ballot value (yea/yay, nay, or pass)
401 -D --dry-run: don't inject the operation, just display it
402 show voting period
403 Summarize the current voting period
404
405Commands for managing the record of known contracts:
406 remember contract <new> <src> [-f --force]
407 Add a contract to the wallet.
408 <new>: new contract alias
409 <src>: source contract
410 -f --force: overwrite existing contract
411 forget contract <name>
412 Remove a contract from the wallet.
413 <name>: existing contract alias
414 list known contracts
415 Lists all known contracts in the wallet.
416 forget all contracts [-f --force]
417 Forget the entire wallet of known contracts.
418 -f --force: overwrite existing contract
419 show known contract <name>
420 Display a contract from the wallet.
421 <name>: existing contract alias
422
423Commands for managing the library of known scripts:
424 list known scripts
425 Lists all scripts in the library.
426 remember script <new> <src> [-f --force]
427 Add a script to the library.
428 <new>: new script alias
429 <src>: source script
430 -f --force: overwrite existing script
431 forget script <name>
432 Remove a script from the library.
433 <name>: existing script alias
434 show known script <name>
435 Display a script from the library.
436 <name>: existing script alias
437 run script <src> on storage <storage> and input <input> [--trace-stack]
438 [--amount <amount>] [--source <source>] [--payer <payer>]
439 [-q --no-print-source] [-G --gas <gas>] [--entrypoint <name>]
440 Ask the node to run a script.
441 <src>: source script
442 <storage>: the storage data
443 <input>: the input data
444 --trace-stack: show the stack after each step
445 --amount <amount>: amount of the transfer in ꜩ
446 --source <source>: name of the source (i.e. SENDER) contract for the transaction
447 --payer <payer>: name of the payer (i.e. SOURCE) contract for the transaction
448 -q --no-print-source: don't print the source code
449 -G --gas <gas>: Initial quantity of gas for typechecking and execution
450 --entrypoint <name>: entrypoint of the smart contract
451 typecheck script <src> [-v --details] [--emacs] [-q --no-print-source]
452 [-G --gas <gas>]
453 Ask the node to typecheck a script.
454 <src>: source script
455 -v --details: show the types of each instruction
456 --emacs: output in `michelson-mode.el` compatible format
457 -q --no-print-source: don't print the source code
458 -G --gas <gas>: Initial quantity of gas for typechecking and execution
459 typecheck data <data> against type <type> [-q --no-print-source]
460 [-G --gas <gas>]
461 Ask the node to typecheck a data expression.
462 <data>: the data to typecheck
463 <type>: the expected type
464 -q --no-print-source: don't print the source code
465 -G --gas <gas>: Initial quantity of gas for typechecking and execution
466 hash data <data> of type <type> [-G --gas <gas>]
467 Ask the node to pack a data expression.
468 <data>: the data to hash
469 <type>: type of the data
470 -G --gas <gas>: Initial quantity of gas for typechecking and execution
471 unpack michelson data <bytes>
472 Parse a byte sequence (in hexadecimal notation) as a data expression, as per Michelson instruction `UNPACK`.
473 <bytes>: the packed data to parse
474 sign bytes <data> for <src>
475 Sign a raw sequence of bytes and display it using the format expected by Michelson instruction `CHECK_SIGNATURE`.
476 <data>: the raw data to sign
477 <src>: source secret_key
478 check that <bytes> was signed by <key> to produce <signature> [-q --quiet]
479 Check the signature of a byte sequence as per Michelson instruction `CHECK_SIGNATURE`.
480 <bytes>: the signed data
481 <key>: existing public_key alias
482 <signature>: the signature to check
483 -q --quiet: Use only exit codes
484 get script entrypoint type of <entrypoint> for <src> [--emacs]
485 [-q --no-print-source]
486 Ask the type of an entrypoint of a script.
487 <entrypoint>: the entrypoint to describe
488 <src>: source script
489 --emacs: output in `michelson-mode.el` compatible format
490 -q --no-print-source: don't print the source code
491 get script entrypoints for <src> [--emacs] [-q --no-print-source]
492 Ask the node to list the entrypoints of a script.
493 <src>: source script
494 --emacs: output in `michelson-mode.el` compatible format
495 -q --no-print-source: don't print the source code
496 get script unreachable paths for <src> [--emacs] [-q --no-print-source]
497 Ask the node to list the unreachable pathsin a script's parameter type.
498 <src>: source script
499 --emacs: output in `michelson-mode.el` compatible format
500 -q --no-print-source: don't print the source code
501
502Commands related to delegate operations.:
503 bake for <baker> [--max-priority <slot>] [--minimal-fees <amount>]
504 [--minimal-nanotez-per-gas-unit <amount>]
505 [--minimal-nanotez-per-byte <amount>] [-f --force]
506 [--minimal-timestamp] [--mempool <file>] [--context <path>]
507 Forge and inject block using the delegate rights.
508 <baker>: name of the delegate owning the baking right
509 --max-priority <slot>: maximum allowed baking slot
510 --minimal-fees <amount>: exclude operations with fees lower than this threshold (in tez)
511 --minimal-nanotez-per-gas-unit <amount>: exclude operations with fees per gas lower than this threshold (in nanotez)
512 --minimal-nanotez-per-byte <amount>: exclude operations with fees per byte lower than this threshold (in nanotez)
513 -f --force: disables the node's injection checks
514 --minimal-timestamp: Use the minimal timestamp instead of the current date as timestamp of the baked block.
515 --mempool <file>: When used the client will read the mempool in the provided file instead of querying the node through an RPC (useful for debugging only).
516 --context <path>: When use 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.
517 reveal nonce for [<block_hash>...]
518 Forge and inject a seed-nonce revelation operation.
519 <block_hash>: A block identifier
520 reveal nonces
521 Forge and inject all the possible seed-nonce revelation operations.
522 endorse for <baker>
523 Forge and inject an endorsement operation.
524 <baker>: name of the delegate owning the endorsement right
525 filter orphan nonces
526 Clear the nonces file by removing the nonces which blocks cannot be found on the chain.
527 list orphan nonces
528 List orphan nonces.
529
530Commands for managing the wallet of cryptographic keys:
531 list signing schemes
532 List supported signing schemes.
533 gen keys <new> [-f --force] [-s --sig <ed25519|secp256k1|p256>]
534 Generate a pair of keys.
535 <new>: new secret_key alias
536 -f --force: overwrite existing secret_key
537 -s --sig <ed25519|secp256k1|p256>: use custom signature algorithm
538 gen vanity keys <new> matching [<words>...] [-P --prefix] [-f --force]
539 Generate keys including the given string.
540 <new>: new public key hash alias
541 <words>: string key must contain one of these words
542 -P --prefix: the key must begin with tz1[word]
543 -f --force: overwrite existing keys
544 encrypt secret key
545 Encrypt an unencrypted secret key.
546 import secret key <new> <uri> [-f --force]
547 Add a secret key to the wallet.
548 <new>: new secret_key alias
549 <uri>: secret key
550 -f --force: overwrite existing secret_key
551 import fundraiser secret key <new> [-f --force]
552 Add a fundraiser secret key to the wallet.
553 <new>: new secret_key alias
554 -f --force: overwrite existing secret_key
555 import public key <new> <uri> [-f --force]
556 Add a public key to the wallet.
557 <new>: new public_key alias
558 <uri>: public key
559 -f --force: overwrite existing public_key
560 add address <new> <src> [-f --force]
561 Add an address to the wallet.
562 <new>: new public key hash alias
563 <src>: source public key hash
564 -f --force: overwrite existing public_key
565 list known addresses
566 List all addresses and associated keys.
567 show address <name> [-S --show-secret]
568 Show the keys associated with an implicit account.
569 <name>: existing public key hash alias
570 -S --show-secret: show the private key
571 forget address <name> [-f --force]
572 Forget one address.
573 <name>: existing public key hash alias
574 -f --force: delete associated keys when present
575 forget all keys [-f --force]
576 Forget the entire wallet of keys.
577 -f --force: you got to use the force for that
578 generate nonce for <name> from <data>
579 Compute deterministic nonce.
580 <name>: existing public key hash alias
581 <data>: string from which to deterministically generate the nonce
582 generate nonce hash for <name> from <data>
583 Compute deterministic nonce hash.
584 <name>: existing public key hash alias
585 <data>: string from which to deterministically generate the nonce hash
586
587Commands for managing the connected Ledger Nano devices:
588 list connected ledgers
589 List supported Ledger Nano devices connected.
590 show ledger <account-alias-or-ledger-uri> [--test-sign]
591 Display version/public-key/address information for a Ledger URI
592 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
593 --test-sign: Test signing operation
594 get ledger authorized path for <account-alias-or-ledger-uri>
595 Query the path of the authorized key
596 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
597 authorize ledger to bake for <account-alias-or-ledger-uri>
598 Authorize a Ledger to bake for a key (deprecated, use `setup ledger ...` with recent versions of the Baking app)
599 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
600 setup ledger to bake for <account-alias-or-ledger-uri> [--main-chain-id <ID>]
601 [--main-hwm <HWM>] [--test-hwm <HWM>]
602 Setup a Ledger to bake for a key
603 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
604 --main-chain-id <ID>: Use <ID> as main chain-id instead of asking the node.
605 --main-hwm <HWM>: Use <HWM> as main chain high watermark instead of asking the ledger.
606 --test-hwm <HWM>: Use <HWM> as test chain high watermark instead of asking the ledger.
607 deauthorize ledger baking for <account-alias-or-ledger-uri>
608 Deauthorize Ledger from baking
609 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
610 get ledger high water mark for <account-alias-or-ledger-uri> [--no-legacy-instructions]
611 Get high water mark of a Ledger
612 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
613 --no-legacy-instructions: Prevent the fallback to the (deprecated) Ledger instructions (for 1.x.y versions of the Baking app)
614 set ledger high water mark for <account-alias-or-ledger-uri> to <high watermark>
615 Set high water mark of a Ledger
616 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
617 <high watermark>: High watermark
618 get ledger high watermark for <account-alias-or-ledger-uri> [--no-legacy-instructions]
619 Get high water mark of a Ledger (legacy/deprecated spelling)
620 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
621 --no-legacy-instructions: Prevent the fallback to the (deprecated) Ledger instructions (for 1.x.y versions of the Baking app)
622 set ledger high watermark for <account-alias-or-ledger-uri> to <high watermark>
623 Set high water mark of a Ledger (legacy/deprecated spelling)
624 <account-alias-or-ledger-uri>: An imported ledger alias or a ledger URI (e.g. "ledger://animal/curve/path").
625 <high watermark>: High watermark
626
627Commands for the low level RPC layer:
628 rpc list <url>
629 List RPCs under a given URL prefix.
630 <url>: the URL prefix
631 rpc list
632 Alias to `rpc list /`.
633 rpc schema <HTTP method> <url>
634 Get the input and output JSON schemas of an RPC.
635 <HTTP method>:
636 <url>: the RPC url
637 rpc format <HTTP method> <url> [-b --binary]
638 Get the humanoid readable input and output formats of an RPC.
639 <HTTP method>:
640 <url>: the RPC URL
641 -b --binary: Binary format
642 rpc get <url>
643 Call an RPC with the GET method.
644 <url>: the RPC URL
645 rpc post <url>
646 Call an RPC with the POST method.
647 <url>: the RPC URL
648 rpc post <url> with <input>
649 Call an RPC with the POST method, providing input data via the command line.
650 <url>: the RPC URL
651 <input>: the raw JSON input to the RPC
652 rpc put <url>
653 Call an RPC with the PUT method.
654 <url>: the RPC URL
655 rpc put <url> with <input>
656 Call an RPC with the PUT method, providing input data via the command line.
657 <url>: the RPC URL
658 <input>: the raw JSON input to the RPC
659 rpc delete <url>
660 Call an RPC with the DELETE method.
661 <url>: the RPC URL
662
663Commands for editing and viewing the client's config file:
664 config show
665 Show the config file.
666 config reset
667 Reset the config file to the factory defaults.
668 config update
669 Update the config based on the current cli values.
670 config init [-o --output <path>]
671 Create a config file based on the current CLI values.
672 -o --output <path>: path at which to create the file
673
674Miscellaneous commands:
675 list understood protocols
676 List the protocol versions that this client understands.
677 complete <prefix> [-u --unique]
678 Autocomplete a prefix of Base58Check-encoded hash.
679 <prefix>: the prefix of the hash to complete
680 -u --unique: Fail when there is more than one possible completion.
681 bootstrapped
682 Wait for the node to be bootstrapped.
683 wait for <operation> to be included [--confirmations <num_blocks>]
684 [--check-previous <num_blocks>] [--branch <block_hash>]
685 Wait until an operation is included in a block
686 <operation>: Operation to be included
687 --confirmations <num_blocks>: wait until 'N' additional blocks after the operation appears in the considered chain
688 --check-previous <num_blocks>: number of previous blocks to check
689 --branch <block_hash>: hash of the oldest block where we should look for the operation
690 get receipt for <operation> [--check-previous <num_blocks>]
691 Get receipt for past operation
692 <operation>: Operation to be looked up
693 --check-previous <num_blocks>: number of previous blocks to check