-
Notifications
You must be signed in to change notification settings - Fork 14
/
help.cli
11915 lines (10079 loc) · 713 KB
/
help.cli
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Usage: cardano-cli
( shelley
| allegra
| mary
| alonzo
| babbage
| conway
| latest
| legacy
| Legacy commands
| byron
| hash
| ping
| debug commands
| version
)
Usage: cardano-cli shelley
( address
| key
| genesis
| governance
| node
| query
| stake-address
| stake-pool
| text-view
| transaction
)
Shelley era commands - DEPRECATED - will be removed in the future
Usage: cardano-cli shelley address (key-gen | key-hash | build | info)
Payment address commands.
Usage: cardano-cli shelley address key-gen [--key-output-format STRING]
[ --normal-key
| --extended-key
| --byron-key
]
--verification-key-file FILEPATH
--signing-key-file FILEPATH
Create an address key pair.
Usage: cardano-cli shelley address key-hash
( --payment-verification-key STRING
| --payment-verification-key-file FILEPATH
)
[--out-file FILEPATH]
Print the hash of an address key.
Usage: cardano-cli shelley address build
( --payment-verification-key STRING
| --payment-verification-key-file FILEPATH
| --payment-script-file FILEPATH
)
[ --stake-verification-key STRING
| --stake-verification-key-file FILEPATH
| --stake-key-hash HASH
| --stake-script-file FILEPATH
| --stake-address ADDRESS
]
(--mainnet | --testnet-magic NATURAL)
[--out-file FILEPATH]
Build a Shelley payment address, with optional delegation to a stake address.
Usage: cardano-cli shelley address info --address ADDRESS [--out-file FILEPATH]
Print information about an address.
Usage: cardano-cli shelley key
( verification-key
| non-extended-key
| convert-byron-key
| convert-byron-genesis-vkey
| convert-itn-key
| convert-itn-extended-key
| convert-itn-bip32-key
| convert-cardano-address-key
)
Key utility commands.
Usage: cardano-cli shelley key verification-key --signing-key-file FILEPATH
--verification-key-file FILEPATH
Get a verification key from a signing key. This supports all key types.
Usage: cardano-cli shelley key non-extended-key --extended-verification-key-file FILEPATH
--verification-key-file FILEPATH
Get a non-extended verification key from an extended verification key. This
supports all extended key types.
Usage: cardano-cli shelley key convert-byron-key [--password TEXT]
( --byron-payment-key-type
| --legacy-byron-payment-key-type
| --byron-genesis-key-type
| --legacy-byron-genesis-key-type
| --byron-genesis-delegate-key-type
| --legacy-byron-genesis-delegate-key-type
)
( --byron-signing-key-file FILEPATH
| --byron-verification-key-file FILEPATH
)
--out-file FILEPATH
Convert a Byron payment, genesis or genesis delegate key (signing or
verification) to a corresponding Shelley-format key.
Usage: cardano-cli shelley key convert-byron-genesis-vkey --byron-genesis-verification-key BASE64
--out-file FILEPATH
Convert a Base64-encoded Byron genesis verification key to a Shelley genesis
verification key
Usage: cardano-cli shelley key convert-itn-key
( --itn-signing-key-file FILEPATH
| --itn-verification-key-file FILEPATH
)
--out-file FILEPATH
Convert an Incentivized Testnet (ITN) non-extended (Ed25519) signing or
verification key to a corresponding Shelley stake key
Usage: cardano-cli shelley key convert-itn-extended-key --itn-signing-key-file FILEPATH
--out-file FILEPATH
Convert an Incentivized Testnet (ITN) extended (Ed25519Extended) signing key
to a corresponding Shelley stake signing key
Usage: cardano-cli shelley key convert-itn-bip32-key --itn-signing-key-file FILEPATH
--out-file FILEPATH
Convert an Incentivized Testnet (ITN) BIP32 (Ed25519Bip32) signing key to a
corresponding Shelley stake signing key
Usage: cardano-cli shelley key convert-cardano-address-key
( --cc-cold-key
| --cc-hot-key
| --drep-key
| --shelley-payment-key
| --shelley-stake-key
| --icarus-payment-key
| --byron-payment-key
)
--signing-key-file FILEPATH
--out-file FILEPATH
Convert a cardano-address extended signing key to a corresponding
Shelley-format key.
Usage: cardano-cli shelley genesis
( key-gen-genesis
| key-gen-delegate
| key-gen-utxo
| key-hash
| get-ver-key
| initial-addr
| initial-txin
| create-cardano
| create
| create-staked
| create-testnet-data
| hash
)
Genesis block commands.
Usage: cardano-cli shelley genesis key-gen-genesis --verification-key-file FILEPATH
--signing-key-file FILEPATH
Create a Shelley genesis key pair
Usage: cardano-cli shelley genesis key-gen-delegate --verification-key-file FILEPATH
--signing-key-file FILEPATH
--operational-certificate-issue-counter-file FILEPATH
Create a Shelley genesis delegate key pair
Usage: cardano-cli shelley genesis key-gen-utxo --verification-key-file FILEPATH
--signing-key-file FILEPATH
Create a Shelley genesis UTxO key pair
Usage: cardano-cli shelley genesis key-hash --verification-key-file FILEPATH
Print the identifier (hash) of a public key
Usage: cardano-cli shelley genesis get-ver-key --verification-key-file FILEPATH
--signing-key-file FILEPATH
Derive the verification key from a signing key
Usage: cardano-cli shelley genesis initial-addr --verification-key-file FILEPATH
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Get the address for an initial UTxO based on the verification key
Usage: cardano-cli shelley genesis initial-txin --verification-key-file FILEPATH
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Get the TxIn for an initial UTxO based on the verification key
Usage: cardano-cli shelley genesis create-cardano --genesis-dir DIR
[--gen-genesis-keys INT]
[--gen-utxo-keys INT]
[--start-time UTC-TIME]
[--supply LOVELACE]
[--security-param INT]
[--slot-length INT]
[--slot-coefficient RATIONAL]
( --mainnet
| --testnet-magic NATURAL
)
--byron-template FILEPATH
--shelley-template FILEPATH
--alonzo-template FILEPATH
--conway-template FILEPATH
[--node-config-template FILEPATH]
Create a Byron and Shelley genesis file from a genesis template and
genesis/delegation/spending keys.
Usage: cardano-cli shelley genesis create [--key-output-format STRING]
--genesis-dir DIR
[--gen-genesis-keys INT]
[--gen-utxo-keys INT]
[--start-time UTC-TIME]
[--supply LOVELACE]
( --mainnet
| --testnet-magic NATURAL
)
Create a Shelley genesis file from a genesis template and
genesis/delegation/spending keys.
Usage: cardano-cli shelley genesis create-staked [--key-output-format STRING]
--genesis-dir DIR
[--gen-genesis-keys INT]
[--gen-utxo-keys INT]
[--gen-pools INT]
[--gen-stake-delegs INT]
[--start-time UTC-TIME]
[--supply LOVELACE]
[--supply-delegated LOVELACE]
( --mainnet
| --testnet-magic NATURAL
)
[--bulk-pool-cred-files INT]
[--bulk-pools-per-file INT]
[--num-stuffed-utxo INT]
[--relay-specification-file FILEPATH]
Create a staked Shelley genesis file from a genesis template and
genesis/delegation/spending keys.
Usage: cardano-cli shelley genesis create-testnet-data [--spec-shelley FILEPATH]
[--spec-alonzo FILEPATH]
[--spec-conway FILEPATH]
[--genesis-keys INT]
[--pools INT]
[ --stake-delegators INT
| --transient-stake-delegators INT
]
[ --drep-keys INT
| --transient-drep-keys INT
]
[--stuffed-utxo INT]
[--utxo-keys INT]
[--total-supply LOVELACE]
[--delegated-supply LOVELACE]
[--testnet-magic NATURAL]
[--relays FILEPATH]
[--start-time UTC-TIME]
--out-dir DIR
Create data to use for starting a testnet.
Usage: cardano-cli shelley genesis hash --genesis FILEPATH
Compute the hash of a genesis file
Usage: cardano-cli shelley governance
( create-mir-certificate
| create-genesis-key-delegation-certificate
| action
)
Governance commands.
Usage: cardano-cli shelley governance create-mir-certificate
( ( --reserves
| --treasury
)
(--stake-address ADDRESS)
(--reward LOVELACE)
--out-file FILEPATH
| stake-addresses
| transfer-to-treasury
| transfer-to-rewards
)
Create an MIR (Move Instantaneous Rewards) certificate
Usage: cardano-cli shelley governance create-mir-certificate stake-addresses
( --reserves
| --treasury
)
(--stake-address ADDRESS)
(--reward LOVELACE)
--out-file FILEPATH
Create an MIR certificate to pay stake addresses
Usage: cardano-cli shelley governance create-mir-certificate transfer-to-treasury --transfer LOVELACE
--out-file FILEPATH
Create an MIR certificate to transfer from the reserves pot to the treasury
pot
Usage: cardano-cli shelley governance create-mir-certificate transfer-to-rewards --transfer LOVELACE
--out-file FILEPATH
Create an MIR certificate to transfer from the treasury pot to the reserves
pot
Usage: cardano-cli shelley governance create-genesis-key-delegation-certificate
( --genesis-verification-key STRING
| --genesis-verification-key-file FILEPATH
| --genesis-verification-key-hash STRING
)
( --genesis-delegate-verification-key STRING
| --genesis-delegate-verification-key-file FILEPATH
| --genesis-delegate-verification-key-hash STRING
)
( --vrf-verification-key STRING
| --vrf-verification-key-file FILEPATH
| --vrf-verification-key-hash STRING
)
--out-file FILEPATH
Create a genesis key delegation certificate
Usage: cardano-cli shelley governance action create-protocol-parameters-update
Governance action commands.
Usage: cardano-cli shelley governance action create-protocol-parameters-update --epoch NATURAL
(--genesis-verification-key-file FILEPATH)
[--min-fee-linear LOVELACE]
[--min-fee-constant LOVELACE]
[--max-block-body-size WORD32]
[--max-tx-size WORD32]
[--max-block-header-size WORD16]
[--key-reg-deposit-amt NATURAL]
[--pool-reg-deposit NATURAL]
[--pool-retirement-epoch-interval WORD32]
[--number-of-pools NATURAL]
[--pool-influence RATIONAL]
[--treasury-expansion RATIONAL]
[--monetary-expansion RATIONAL]
[--min-pool-cost NATURAL]
[--min-utxo-value NATURAL]
[--protocol-major-version MAJOR
--protocol-minor-version MINOR]
[ --extra-entropy HEX
| --reset-extra-entropy
]
[--decentralization-parameter RATIONAL]
--out-file FILEPATH
Create a protocol parameters update.
Usage: cardano-cli shelley node
( key-gen
| key-gen-KES
| key-gen-VRF
| key-hash-VRF
| new-counter
| issue-op-cert
)
Node operation commands.
Usage: cardano-cli shelley node key-gen [--key-output-format STRING]
--cold-verification-key-file FILEPATH
--cold-signing-key-file FILEPATH
--operational-certificate-issue-counter-file FILEPATH
Create a key pair for a node operator's offline key and a new certificate
issue counter
Usage: cardano-cli shelley node key-gen-KES [--key-output-format STRING]
--verification-key-file FILEPATH
--signing-key-file FILEPATH
Create a key pair for a node KES operational key
Usage: cardano-cli shelley node key-gen-VRF [--key-output-format STRING]
--verification-key-file FILEPATH
--signing-key-file FILEPATH
Create a key pair for a node VRF operational key
Usage: cardano-cli shelley node key-hash-VRF
( --verification-key STRING
| --verification-key-file FILEPATH
)
[--out-file FILEPATH]
Print hash of a node's operational VRF key.
Usage: cardano-cli shelley node new-counter
( --stake-pool-verification-key STRING
| --genesis-delegate-verification-key STRING
| --cold-verification-key-file FILEPATH
)
--counter-value INT
--operational-certificate-issue-counter-file FILEPATH
Create a new certificate issue counter
Usage: cardano-cli shelley node issue-op-cert
( --kes-verification-key STRING
| --kes-verification-key-file FILEPATH
)
--cold-signing-key-file FILEPATH
--operational-certificate-issue-counter-file FILEPATH
--kes-period NATURAL
--out-file FILEPATH
Issue a node operational certificate
Usage: cardano-cli shelley query
( protocol-parameters
| tip
| stake-pools
| stake-distribution
| stake-address-info
| utxo
| ledger-state
| protocol-state
| stake-snapshot
| leadership-schedule
| kes-period-info
| pool-state
| tx-mempool
| slot-number
| ref-script-size
)
Node query commands. Will query the local node whose Unix domain socket is
obtained from the CARDANO_NODE_SOCKET_PATH environment variable.
Usage: cardano-cli shelley query protocol-parameters --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Get the node's current protocol parameters
Usage: cardano-cli shelley query tip --socket-path SOCKET_PATH
[--cardano-mode [--epoch-slots SLOTS]]
(--mainnet | --testnet-magic NATURAL)
[--out-file FILEPATH]
Get the node's current tip (slot no, hash, block no)
Usage: cardano-cli shelley query stake-pools --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
[--output-json | --output-text]
[--out-file FILEPATH]
Get the node's current set of stake pool ids
Usage: cardano-cli shelley query stake-distribution --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
[ --output-json
| --output-text
]
[--out-file FILEPATH]
Get the node's current aggregated stake distribution
Usage: cardano-cli shelley query stake-address-info --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
--address ADDRESS
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Get the current delegations and reward accounts filtered by stake address.
Usage: cardano-cli shelley query utxo --socket-path SOCKET_PATH
[--cardano-mode [--epoch-slots SLOTS]]
( --whole-utxo
| (--address ADDRESS)
| (--tx-in TX-IN)
)
(--mainnet | --testnet-magic NATURAL)
[--output-json | --output-text]
[--out-file FILEPATH]
Get a portion of the current UTxO: by tx in, by address or the whole.
Usage: cardano-cli shelley query ledger-state --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
command)
Usage: cardano-cli shelley query protocol-state --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Dump the current protocol state of the node (Ledger.ChainDepState -- advanced
command)
Usage: cardano-cli shelley query stake-snapshot --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
( --all-stake-pools
| (--stake-pool-id STAKE_POOL_ID)
)
[--out-file FILEPATH]
Obtain the three stake snapshots for a pool, plus the total active stake
(advanced command)
Usage: cardano-cli shelley query pool-params --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
( --all-stake-pools
| (--stake-pool-id STAKE_POOL_ID)
)
[--out-file FILEPATH]
DEPRECATED. Use query pool-state instead. Dump the pool parameters
(Ledger.NewEpochState.esLState._delegationState._pState._pParams -- advanced
command)
Usage: cardano-cli shelley query leadership-schedule --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
--genesis FILEPATH
( --stake-pool-verification-key STRING
| --cold-verification-key-file FILEPATH
| --stake-pool-id STAKE_POOL_ID
)
--vrf-signing-key-file FILEPATH
(--current | --next)
[ --output-json
| --output-text
]
[--out-file FILEPATH]
Get the slots the node is expected to mint a block in (advanced command)
Usage: cardano-cli shelley query kes-period-info --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
--op-cert-file FILEPATH
[--out-file FILEPATH]
Get information about the current KES period and your node's operational
certificate.
Usage: cardano-cli shelley query pool-state --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
( --all-stake-pools
| (--stake-pool-id STAKE_POOL_ID)
)
[--out-file FILEPATH]
Dump the pool state
Usage: cardano-cli shelley query tx-mempool --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
(info | next-tx | tx-exists)
[--out-file FILEPATH]
Local Mempool info
Usage: cardano-cli shelley query tx-mempool info
Ask the node about the current mempool's capacity and sizes
Usage: cardano-cli shelley query tx-mempool next-tx
Requests the next transaction from the mempool's current list
Usage: cardano-cli shelley query tx-mempool tx-exists TX_ID
Query if a particular transaction exists in the mempool
Usage: cardano-cli shelley query slot-number --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
( --mainnet
| --testnet-magic NATURAL
)
TIMESTAMP
Query slot number for UTC timestamp
Usage: cardano-cli shelley query ref-script-size --socket-path SOCKET_PATH
[--cardano-mode
[--epoch-slots SLOTS]]
(--tx-in TX-IN)
( --mainnet
| --testnet-magic NATURAL
)
[ --output-json
| --output-text
]
[--out-file FILEPATH]
Calculate the reference input scripts size in bytes for provided transaction
inputs.
Usage: cardano-cli shelley stake-address
( key-gen
| key-hash
| build
| registration-certificate
| deregistration-certificate
| stake-delegation-certificate
)
Stake address commands.
Usage: cardano-cli shelley stake-address key-gen [--key-output-format STRING]
--verification-key-file FILEPATH
--signing-key-file FILEPATH
Create a stake address key pair
Usage: cardano-cli shelley stake-address key-hash
( --stake-verification-key STRING
| --stake-verification-key-file FILEPATH
)
[--out-file FILEPATH]
Print the hash of a stake address key
Usage: cardano-cli shelley stake-address build
( --stake-verification-key STRING
| --stake-verification-key-file FILEPATH
| --stake-key-hash HASH
| --stake-script-file FILEPATH
)
( --mainnet
| --testnet-magic NATURAL
)
[--out-file FILEPATH]
Build a stake address
Usage: cardano-cli shelley stake-address registration-certificate
( --stake-verification-key STRING
| --stake-verification-key-file FILEPATH
| --stake-key-hash HASH
| --stake-script-file FILEPATH
| --stake-address ADDRESS
)
--out-file FILEPATH
Create a stake address registration certificate
Usage: cardano-cli shelley stake-address deregistration-certificate
( --stake-verification-key STRING
| --stake-verification-key-file FILEPATH
| --stake-key-hash HASH
| --stake-script-file FILEPATH
| --stake-address ADDRESS
)
--out-file FILEPATH
Create a stake address deregistration certificate
Usage: cardano-cli shelley stake-address stake-delegation-certificate
( --stake-verification-key STRING
| --stake-verification-key-file FILEPATH
| --stake-key-hash HASH
| --stake-script-file FILEPATH
| --stake-address ADDRESS
)
( --stake-pool-verification-key STRING
| --cold-verification-key-file FILEPATH
| --stake-pool-id STAKE_POOL_ID
)
--out-file FILEPATH
Create a stake address stake delegation certificate, which when submitted in a
transaction delegates stake to a stake pool.
Usage: cardano-cli shelley stake-pool
( registration-certificate
| deregistration-certificate
| id
| metadata-hash
)
Stake pool commands.
Usage: cardano-cli shelley stake-pool registration-certificate
( --stake-pool-verification-key STRING
| --cold-verification-key-file FILEPATH
)
( --vrf-verification-key STRING
| --vrf-verification-key-file FILEPATH
)
--pool-pledge LOVELACE
--pool-cost LOVELACE
--pool-margin RATIONAL
( --pool-reward-account-verification-key STRING
| --pool-reward-account-verification-key-file FILEPATH
)
( --pool-owner-verification-key STRING
| --pool-owner-stake-verification-key-file FILEPATH
)
[ [--pool-relay-ipv4 STRING]
[--pool-relay-ipv6 STRING]
--pool-relay-port INT
| --single-host-pool-relay STRING
[--pool-relay-port INT]
| --multi-host-pool-relay STRING
]
[--metadata-url URL
--metadata-hash HASH]
( --mainnet
| --testnet-magic NATURAL
)
--out-file FILEPATH
Create a stake pool registration certificate
Usage: cardano-cli shelley stake-pool deregistration-certificate
( --stake-pool-verification-key STRING
| --cold-verification-key-file FILEPATH
)
--epoch NATURAL
--out-file FILEPATH
Create a stake pool deregistration certificate
Usage: cardano-cli shelley stake-pool id
( --stake-pool-verification-key STRING
| --cold-verification-key-file FILEPATH
)
[--output-format STRING]
[--out-file FILEPATH]
Build pool id from the offline key
Usage: cardano-cli shelley stake-pool metadata-hash --pool-metadata-file FILEPATH
[--out-file FILEPATH]
Print the hash of pool metadata.
Usage: cardano-cli shelley text-view decode-cbor
Commands for dealing with Shelley TextView files. Transactions, addresses etc
are stored on disk as TextView files.
Usage: cardano-cli shelley text-view decode-cbor --in-file FILEPATH
[--out-file FILEPATH]
Print a TextView file as decoded CBOR.
Usage: cardano-cli shelley transaction
( build-raw
| sign
| witness
| assemble
| submit
| policyid
| calculate-min-fee
| calculate-min-required-utxo
| hash-script-data
| txid
| view
)
Transaction commands.
Usage: cardano-cli shelley transaction build-raw
[ --script-valid
| --script-invalid
]
(--tx-in TX-IN
[ --spending-tx-in-reference TX-IN
( --spending-plutus-script-v2
| --spending-plutus-script-v3
)
( --spending-reference-tx-in-datum-cbor-file CBOR_FILE
| --spending-reference-tx-in-datum-file JSON_FILE
| --spending-reference-tx-in-datum-value JSON_VALUE
| --spending-reference-tx-in-inline-datum-present
)
( --spending-reference-tx-in-redeemer-cbor-file CBOR_FILE
| --spending-reference-tx-in-redeemer-file JSON_FILE
| --spending-reference-tx-in-redeemer-value JSON_VALUE
)
--spending-reference-tx-in-execution-units (INT, INT)
| --simple-script-tx-in-reference TX-IN
| --tx-in-script-file FILEPATH
[
( --tx-in-datum-cbor-file CBOR_FILE
| --tx-in-datum-file JSON_FILE
| --tx-in-datum-value JSON_VALUE
| --tx-in-inline-datum-present
)
( --tx-in-redeemer-cbor-file CBOR_FILE
| --tx-in-redeemer-file JSON_FILE
| --tx-in-redeemer-value JSON_VALUE
)
--tx-in-execution-units (INT, INT)]
])
[--read-only-tx-in-reference TX-IN]
[--tx-in-collateral TX-IN]
[--tx-out-return-collateral ADDRESS VALUE]
[--tx-total-collateral INTEGER]
[ --required-signer FILEPATH
| --required-signer-hash HASH
]
[--tx-out ADDRESS VALUE
[ --tx-out-datum-hash HASH
| --tx-out-datum-hash-cbor-file CBOR_FILE
| --tx-out-datum-hash-file JSON_FILE
| --tx-out-datum-hash-value JSON_VALUE
| --tx-out-datum-embed-cbor-file CBOR_FILE
| --tx-out-datum-embed-file JSON_FILE
| --tx-out-datum-embed-value JSON_VALUE
| --tx-out-inline-datum-cbor-file CBOR_FILE
| --tx-out-inline-datum-file JSON_FILE
| --tx-out-inline-datum-value JSON_VALUE
]
[--tx-out-reference-script-file FILEPATH]]
[--mint VALUE
( --mint-script-file FILEPATH
[
( --mint-redeemer-cbor-file CBOR_FILE
| --mint-redeemer-file JSON_FILE
| --mint-redeemer-value JSON_VALUE
)
--mint-execution-units (INT, INT)]
| --simple-minting-script-tx-in-reference TX-IN
--policy-id HASH
| --mint-tx-in-reference TX-IN
( --mint-plutus-script-v2
| --mint-plutus-script-v3
)
( --mint-reference-tx-in-redeemer-cbor-file CBOR_FILE
| --mint-reference-tx-in-redeemer-file JSON_FILE
| --mint-reference-tx-in-redeemer-value JSON_VALUE
)
--mint-reference-tx-in-execution-units (INT, INT)
--policy-id HASH
)]
[--invalid-before SLOT]
[--invalid-hereafter SLOT]
--fee LOVELACE
[--certificate-file FILEPATH
[ --certificate-script-file FILEPATH
[
( --certificate-redeemer-cbor-file CBOR_FILE
| --certificate-redeemer-file JSON_FILE
| --certificate-redeemer-value JSON_VALUE
)
--certificate-execution-units (INT, INT)]
| --certificate-tx-in-reference TX-IN
( --certificate-plutus-script-v2
| --certificate-plutus-script-v3
)
( --certificate-reference-tx-in-redeemer-cbor-file CBOR_FILE
| --certificate-reference-tx-in-redeemer-file JSON_FILE
| --certificate-reference-tx-in-redeemer-value JSON_VALUE
)
--certificate-reference-tx-in-execution-units (INT, INT)
]]
[--withdrawal WITHDRAWAL
[ --withdrawal-script-file FILEPATH
[
( --withdrawal-redeemer-cbor-file CBOR_FILE
| --withdrawal-redeemer-file JSON_FILE
| --withdrawal-redeemer-value JSON_VALUE
)
--withdrawal-execution-units (INT, INT)]
| --withdrawal-tx-in-reference TX-IN
( --withdrawal-plutus-script-v2
| --withdrawal-plutus-script-v3
)
( --withdrawal-reference-tx-in-redeemer-cbor-file CBOR_FILE
| --withdrawal-reference-tx-in-redeemer-file JSON_FILE
| --withdrawal-reference-tx-in-redeemer-value JSON_VALUE
)
--withdrawal-reference-tx-in-execution-units (INT, INT)
]]
[ --json-metadata-no-schema
| --json-metadata-detailed-schema
]
[--auxiliary-script-file FILEPATH]
[ --metadata-json-file FILEPATH
| --metadata-cbor-file FILEPATH
]
[--protocol-params-file FILEPATH]
[--update-proposal-file FILEPATH]
--out-file FILEPATH
Build a transaction (low-level, inconvenient)
Please note the order[93;22;23;24m of some cmd options is crucial. If used incorrectly may produce undesired tx body. See nested [] notation above for details.[0;22;23;24m
Usage: cardano-cli shelley transaction sign
( --tx-body-file FILEPATH
| --tx-file FILEPATH
)
[--signing-key-file FILEPATH
[--address STRING]]
[ --mainnet
| --testnet-magic NATURAL
]
--out-file FILEPATH
Sign a transaction
Usage: cardano-cli shelley transaction witness --tx-body-file FILEPATH
--signing-key-file FILEPATH
[--address STRING]
[ --mainnet
| --testnet-magic NATURAL
]
--out-file FILEPATH
Create a transaction witness
Usage: cardano-cli shelley transaction assemble --tx-body-file FILEPATH
[--witness-file FILEPATH]
--out-file FILEPATH
Assemble a tx body and witness(es) to form a transaction
Usage: cardano-cli shelley transaction sign-witness --tx-body-file FILEPATH
[--witness-file FILEPATH]
--out-file FILEPATH