-
Notifications
You must be signed in to change notification settings - Fork 211
/
swagger.yaml
6997 lines (6246 loc) · 204 KB
/
swagger.yaml
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
openapi: 3.0.0
info:
title: Cardano Wallet Backend API
version: v2022-01-18
license:
name: Apache-2.0
url: https://raw.githubusercontent.com/input-output-hk/cardano-wallet/master/LICENSE
description: |
<p align="right"><img style="position: relative; top: -10em; margin-bottom: -12em;" width="20%" src="https://cardanodocs.com/img/cardano.png"></img></p>
externalDocs:
description: Need more? Click here to access our API guide and walkthrough.
url: https://input-output-hk.github.io/cardano-wallet/
servers:
- url: https://localhost:8090/v2/
#############################################################################
# #
# FIELDS #
# #
#############################################################################
x-date: &date
type: string
format: iso-8601-date-and-time
example: 2019-02-27T14:46:45Z
x-slotNumber: &slotNumber
type: integer
description: The zero-based slot index within an epoch.
minimum: 0
example: 1337
x-stakePoolsNumber: &stakePoolsNumber
type: integer
minimum: 0
example: 100
x-numberOfSeconds: &numberOfSeconds
type: object
required:
- quantity
- unit
properties:
quantity:
type: number
minimum: 0.0
example: 10.0
unit:
type: string
enum: ["second"]
x-epochNumber: &epochNumber
type: integer
description: An epoch is a time period which is divided into slots.
minimum: 0
example: 14
x-epochInfo: &epochInfo
type: object
required:
- epoch_number
- epoch_start_time
properties:
epoch_number: *epochNumber
epoch_start_time: *date
x-blockId: &blockId
description: The hash of genesis block
type: string
format: hex
maxLength: 64
minLength: 64
example: 3c07030e36bfffe67e2e2ec09e5293d384637cd2f004356ef320f3fe6c52041a
x-absoluteSlot: &absoluteSlot
type: integer
description: The 0-based slot index starting from genesis of the blockchain.
minimum: 0
example: 8086
x-numberOfSlots: &numberOfSlots
type: object
required:
- quantity
- unit
properties:
quantity:
type: integer
minimum: 0
example: 42000
unit:
type: string
enum: ["slot"]
x-numberOfBlocks: &numberOfBlocks
type: object
required:
- quantity
- unit
properties:
quantity:
type: integer
minimum: 0
example: 1337
unit:
type: string
enum:
- block
example: "block"
x-blockReference: &blockReference
description: A reference to a particular time slot, and the block height at that point.
type: object
required:
- absolute_slot_number
- slot_number
- epoch_number
- time
- height
properties:
absolute_slot_number: *absoluteSlot
slot_number: *slotNumber
epoch_number: *epochNumber
time: *date
height: *numberOfBlocks
x-slotId: &slotId
description: A slot identifier, given by epoch number and local slot index.
type: object
required:
- epoch_number
- slot_number
properties:
epoch_number: *epochNumber
slot_number: *slotNumber
x-slotReference: &slotReference
description: A reference to a particular time slot.
type: object
required:
- absolute_slot_number
- slot_number
- epoch_number
- time
properties:
absolute_slot_number: *absoluteSlot
epoch_number: *epochNumber
slot_number: *slotNumber
time: *date
x-genesisBlock: &genesisBlock
description: A reference to a particular block.
type: object
required:
- slot_number
- epoch_number
properties:
slot_number:
<<: *slotNumber
maximum: 0
example: 0
epoch_number:
<<: *epochNumber
maximum: 0
example: 0
x-percentage: &percentage
type: object
required:
- quantity
- unit
properties:
quantity:
type: number
minimum: 0
maximum: 100
example: 42
unit:
type: string
enum:
- percent
x-microseconds: µseconds
type: object
required:
- quantity
- unit
properties:
quantity:
type: number
example: 42
unit:
type: string
enum:
- microsecond
x-syncProgress: &syncProgress
type: object
required:
- status
properties:
status:
type: string
enum:
- ready
- syncing
- not_responding
progress:
<<: *percentage
description: |
<span style="position: relative; left: 35px; top: -21px; vertical-align: middle; background-color: rgba(142, 142, 220, 0.05); color: rgba(50, 50, 159, 0.9); margin: 0 5px; padding: 0 5px; border: 1px solid rgba(50, 50, 159, 0.1); line-height: 20px; font-size: 13px; border-radius: 2px;">
<strong>if:</strong> status == syncing
</span><br/>
example:
status: ready
x-syncClockProgress: &syncClockProgress
type: object
required:
- status
properties:
status:
type: string
enum:
- unavailable
- pending
- available
offset:
<<: *microseconds
description: |
<span style="position: relative; left: 35px; top: -21px; vertical-align: middle; background-color: rgba(142, 142, 220, 0.05); color: rgba(50, 50, 159, 0.9); margin: 0 5px; padding: 0 5px; border: 1px solid rgba(50, 50, 159, 0.1); line-height: 20px; font-size: 13px; border-radius: 2px;">
<strong>if:</strong> status == available
</span><br/>
example:
status: pending
x-amount: &amount
description: Coins, in Lovelace. Only relates to 'Ada'. Refer to `assets` for multi-assets wallets instead.
type: object
required:
- quantity
- unit
properties:
quantity:
type: integer
minimum: 0
example: 42000000
unit:
type: string
enum:
- lovelace
x-stakeAddress: &stakeAddress
type: string
format: bech32
example: stake1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2x
x-addressId: &addressId
type: string
format: base58|bech32
example: addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g
description: |
A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes
which represents an address on the Cardano blockchain.
Sequences in Base58 encoding are expected to be legacy Byron addresses,
whereas sequences in Bech32 encoding correspond to current Shelley addresses.
For more details, see
[CIP-0019 — Cardano addresses](https://github.com/cardano-foundation/CIPs/tree/master/CIP-0019)
.
x-addressState: &addressState
type: string
enum:
- used
- unused
x-txType: &txType
type: string
pattern: "^Tx AlonzoEra$"
x-txDescription: &txDescription
description: A description of transaction
type: string
minLength: 0
maxLength: 256
example: "Asset minting transaction"
x-txInNode: &txInNode
type: string
pattern: "^[0-9abcdef]+#[0-9]+$"
minLength: 66
maxLength: 68
example: 2f8cd2ef706e5500307636b8477198ee2f204c4181b53c507f46d195140493cb#1
x-dataHash: &dataHash
type: string
format: hex
minLength: 64
maxLength: 64
example: ca54c8836c475a77c6914b4fd598080acadb0f0067778773484d2c12ae7dc756
x-stakePoolMetadataUrl: &stakePoolMetadataUrl
description: |
A URL to the stake pool's website.
type: string
format: uri
pattern: "^https://.+"
maxLength: 250
x-stakePoolMetadataHash: &stakePoolMetadataHash
type: string
format: hex
minLength: 64
maxLength: 64
example: ca54c8836c475a77c6914b4fd598080acadb0f0067778773484d2c12ae7dc756
x-stakePoolOwner: &stakePoolOwner
type: string
format: bech32
pattern: "^(ed25519_pk)1[0-9a-z]*$"
x-adaQuantity: &adaQuantity
type: integer
minimum: 0
maximum: 45000000000000000
x-assetQuantity: &assetQuantity
type: integer
description: |
Number of assets for the given `policy_id` and `asset_name`.
minimum: 0
x-assetValueNode: &assetValueNode
description:
Map of asset values along with their quantities.
assetName in field name is expected (max lenght 64-character hex-encoded text)
type: object
additionalProperties: *assetQuantity
# Note: propertyNames pattern not supported in current OpenAPI version.
# propertyNames:
# pattern: '^(assetName)$'
example:
- {"asset1": 12, "asset2": 33}
x-valueNode: &valueNode
nullable: false
oneOf:
- <<: *adaQuantity
title: ada coin
- <<: *assetValueNode
title: asset value
x-valueNodes: &valueNodes
description:
Map of values along with their quantities. Can be lovelace or asset.
In the former case 'lovelace' name is expected.
In the latter case assetPolicyId name is expected (56-character hex-encoded text)
type: object
additionalProperties: *valueNode
# Note: propertyNames pattern not supported in current OpenAPI version.
# propertyNames:
# pattern: '^(lovelace)|(assetPolicyId)$'
example:
- {"lovelace": 1423}
- {"lovelace": 1423, "7191ae0e1286891fe5c027a5dc041b7401689938e18e14ec83cf74fb": {"asset1": 12, "asset2": 33}}
x-stakePoolId: &stakePoolId
type: string
format: hex|bech32
example: pool1wqaz0q0zhtxlgn0ewssevn2mrtm30fgh2g7hr7z9rj5856457mm
description: A unique identifier for the pool.
x-walletAccountXPubkey: &walletAccountXPubkey
description: An extended account public key (public key + chain code)
type: string
format: hex
minLength: 128
maxLength: 128
example: 1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db11423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1
x-cosigner: &cosigner
type: string
pattern: "^(cosigner#)[0-9]+$"
x-cosigners: &cosigners
description: Map of cosigners and their account public keys. Use key as in &cosigner, eg. "cosigner#"
type: object
additionalProperties: *walletAccountXPubkey
# Note: propertyNames pattern not supported in current OpenAPI version.
# propertyNames:
# pattern: '^(cosigner#)[0-9]+$'
example:
- {"cosigner#0": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db11423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1"}
x-self: &self
type: string
enum:
- self
x-accountPubkeyOrSelf: &accountPubkeyOrSelf
nullable: false
oneOf:
- <<: *walletAccountXPubkey
title: public key
- <<: *self
title: self
x-cosignersEntry: &cosignersEntry
description: Map of cosigners and their account public keys. Use key as in &cosigner, eg. "cosigner#"or 'self'
type: object
additionalProperties: *accountPubkeyOrSelf
# Note: propertyNames pattern not supported in current OpenAPI version.
# propertyNames:
# pattern: '^(cosigner#)[0-9]+$'
example:
- {"cosigner#0": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db11423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1"}
- {"cosigner#0": "self"}
x-walletId: &walletId
description: A unique identifier for the wallet
type: string
format: hex
maxLength: 40
minLength: 40
example: 2512a00e9653fe49a44a5886202e24d77eeb998f
x-walletDiscovery: &walletDiscovery
description: Mechanism used for discovering addresses.
type: string
enum:
- random
- sequential
example: sequential
x-walletName: &walletName
type: string
maxLength: 255
minLength: 1
example: Alan's Wallet
x-poolMetadataSource: &poolMetadataSource
description: |
Pool metadata source. This sets the metadata fetching strategy.
Possible values are
* none -> no fetching
* direct -> direct fetching
* uri -> use SMASH server
type: string
pattern: '^(none|direct|https?:\/\/[a-zA-Z0-9-_~.]+(:[0-9]+)?/?)$'
example: https://smash.cardano-mainnet.iohk.io/
x-credentialPubKey: &credentialPubKey
description: A public key (public key without chain code) for credential - 32 bytes
type: string
format: bech32
pattern: "^((addr_vk)|(stake_vk))1[0-9a-z]*$"
example:
- stake_vk16apaenn9ut6s40lcw3l8v68xawlrlq20z2966uzcx8jmv2q9uy7qau558d
- addr_vk16apaenn9ut6s40lcw3l8v68xawlrlq20z2966uzcx8jmv2q9uy7q3yvuv2
x-validationLevel: &validationLevel
description: |
Script validation level. Required validation sifts off scripts that would not
be accepted by the ledger. Recommended level filters out scripts that do not pass
required validation and additionally when:
* 'all' is non-empty
* there are redundant timelocks in a given level
* there are no duplicated verification keys in a given level
* 'at_least' coeffcient is positive
* 'all', 'any' are non-empty and `'at_least' has no less elements in the list
than the coeffcient after timelocks are filtered out.
type: string
enum:
- required
- recommended
x-anyAddress: &anyAddress
description: A Shelley address representing either enterprise, reward account or delegating address
type: string
format: bech32
pattern: "^((addr)|(stake)|(addr_test)|(stake_test))1[0-9a-z]*$"
example:
- stake17xt2z3pa7etaxp7jurdg0m8jhsmtp4r2z56pd3a5q3jhxycdxzmx9
- addr1wy5np0m5x03tax3kcdh6e2cet98qcfs80wtv4cyvl5taclc6dnd8e
- addr1xy5np0m5x03tax3kcdh6e2cet98qcfs80wtv4cyvl5tacluk59zrmajh6vra9cx6slk090pkkr2x59f5zmrmgpr9wvfs37hjk4
x-ScriptValue: &ScriptValue
oneOf:
- title: Key Hash
description: Leaf value for a script designating a required verification key hash.
type: string
format: bech32
pattern: "^((addr_shared_vkh)|(stake_shared_vkh))1[0-9a-z]*$"
- title: All
type: object
required:
- all
properties:
all:
description: Script primitive for which all signing keys corresponding to all list elements' verification keys are expected to make the script valid.
type: array
minItems: 1
items:
$ref: "#/components/schemas/ScriptValue"
- title: Any
type: object
required:
- any
properties:
any:
description: Script primitive for which a signing key corresponding to any of the list elements' verification keys is expected to make the script valid. It is equivalent to `some` with `"at_least"=1`.
type: array
minItems: 1
items:
$ref: "#/components/schemas/ScriptValue"
- title: Some
type: object
required:
- some
properties:
some:
description: Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
type: object
required:
- at_least
- from
properties:
at_least:
type: integer
minimum: 1
maximum: 255
from:
type: array
minItems: 1
items:
$ref: "#/components/schemas/ScriptValue"
- title: Active from slot
type: object
required:
- active_from
properties:
active_from:
description: Transaction is only valid starting at the specified slot number (`≥ active_from`).
type: integer
minimum: 0
- title: Active until slot
type: object
required:
- active_until
properties:
active_until:
description: Transaction is only valid before the specified slot number (`< active_until`).
type: integer
minimum: 0
x-script: &script
<<: *ScriptValue
x-ScriptTemplateValue: &ScriptTemplateValue
oneOf:
- title: Cosigner
description: Leaf value for a script designating a cosigner co-sharing the script.
type: string
pattern: "^(cosigner#)[0-9]*$"
- title: All
type: object
required:
- all
properties:
all:
description: Script primitive for which all signing keys corresponding to all list cosigners' verification keys are expected to make the script valid.
type: array
minItems: 1
items:
$ref: "#/components/schemas/ScriptTemplateValue"
- title: Any
type: object
required:
- any
properties:
any:
description: Script primitive for which a signing key corresponding to any of the list cosigners' verification keys is expected to make the script valid. It is equivalent to `some` with `"at_least"=1`.
type: array
minItems: 1
items:
$ref: "#/components/schemas/ScriptTemplateValue"
- title: Some
type: object
required:
- some
properties:
some:
description: Script primitive for which at least a given number of signing keys corresponding to the list cosigners' verification keys are expected to make the script valid.
type: object
required:
- at_least
- from
properties:
at_least:
type: integer
minimum: 1
maximum: 255
from:
type: array
minItems: 1
items:
$ref: "#/components/schemas/ScriptTemplateValue"
- title: Active from slot
type: object
required:
- active_from
properties:
active_from:
description: Transaction is only valid starting at the specified slot number (`≥ active_from`).
type: integer
minimum: 0
- title: Active until slot
type: object
required:
- active_until
properties:
active_until:
description: Transaction is only valid before the specified slot number (`< active_until`).
type: integer
minimum: 0
x-scriptTemplate: &scriptTemplate
type: object
required:
- cosigners
- template
properties:
cosigners: *cosigners
template: *ScriptTemplateValue
x-scriptTemplateEntry: &scriptTemplateEntry
type: object
required:
- cosigners
- template
properties:
cosigners: *cosignersEntry
template: *ScriptTemplateValue
x-CredentialValue: &CredentialValue
nullable: false
oneOf:
- <<: *credentialPubKey
title: public key
- <<: *script
title: script
example:
any:
- addr_shared_vkh1zxt0uvrza94h3hv4jpv0ttddgnwkvdgeyq8jf9w30mcs6y8w3nq
- stake_shared_vkh1nqc00hvlc6cq0sfhretk0rmzw8dywmusp8retuqnnxzajtzhjg5
- all:
- addr_shared_vkh1zxt0uvrza94h3hv4jpv0ttddgnwkvdgeyq8jf9w30mcs6y8w3nq
- addr_shared_vkh1y3zl4nqgm96ankt96dsdhc86vd5geny0wr7hu8cpzdfcqskq2cp
- any:
- addr_shared_vkh1zxt0uvrza94h3hv4jpv0ttddgnwkvdgeyq8jf9w30mcs6y8w3nq
- all:
- addr_shared_vkh1zxt0uvrza94h3hv4jpv0ttddgnwkvdgeyq8jf9w30mcs6y8w3nq
- addr_shared_vkh1y3zl4nqgm96ankt96dsdhc86vd5geny0wr7hu8cpzdfcqskq2cp
- some:
at_least: 2
from:
- addr_shared_vkh1zxt0uvrza94h3hv4jpv0ttddgnwkvdgeyq8jf9w30mcs6y8w3nq
- addr_shared_vkh1y3zl4nqgm96ankt96dsdhc86vd5geny0wr7hu8cpzdfcqskq2cp
x-settings: &settings
description: Settings
type: object
required:
- pool_metadata_source
properties:
pool_metadata_source:
<<: *poolMetadataSource
description: |
Select stake pool metadata fetching strategy:
- `none` - metadata is not fetched at all,
- `direct` - metadata is fetched directly URLs registered on chain,
- `uri` - metadata is fetched from an external Stake-Pool Metadata Aggregation Server (SMASH)
After update existing metadata will be dropped forcing it to re-sync automatically with the new setting.
x-assetName: &assetName
type: string
description: |
The asset on-chain type which acts as a sub-identifier within a
policy. Although we call it "asset name", the value needn't be
text, and it could even be empty.
For policies with a single fungible asset item, asset name is
typically an empty string.
This value can be up to 32 bytes of arbitrary data (which is 64
hexadecimal digits).
format: hex
maxLength: 64
example: ""
x-assetPolicyId: &assetPolicyId
type: string
description: |
A unique identifier of the asset's monetary policy. The policy
controls how assets of this kind are created and destroyed.
The contents are the blake2b-224 hash of the monetary policy
script, encoded in hexadecimal.
format: hex
minLength: 56
maxLength: 56
example: 65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b
x-assetFingerprint: &assetFingerprint
type: string
description: |
A user-facing short fingerprint which combines the `policy_id` and `asset_name`
to allow for an easier human comparison of assets. Note that it is generally
**not okay** to use this fingerprint as a unique identifier for it is not collision
resistant. Yet within the context of a single wallet, it makes for a (rather)
short user-facing comparison mean.
pattern: "^(asset)1[0-9a-z]*$"
maxLength: 44
minLength: 44
example: asset1rjklcrnsdzqp65wjgrg55sy9723kw09mlgvlc3
x-assetMetadataName: &assetMetadataName
type: string
maxLength: 50
minLength: 1
description: |
A human-readable name for the asset, intended for display in user
interfaces.
example: SwaggerCoin
x-assetMetadataTicker: &assetMetadataTicker
type: string
maxLength: 5
minLength: 2
description: |
An optional human-readable very short name or acronym for the
asset, intended for display in user interfaces. If `ticker` is not
present, then `name` will be used, but it might be truncated to
fit within the available space.
example: SWAG
x-assetMetadataDescription: &assetMetadataDescription
description: |
A human-readable description for the asset. Good for display in
user interfaces.
type: string
maxLength: 500
x-assetMetadataDecimals: &assetMetadataDecimals
type: integer
description: |
Defines a scaling factor for the asset of 10<sup>-n</sup>. The
decimals value _n_ is therefore the number of digits after the
decimal point for quantities of this token.
It is up to API clients to use this metadata field to decimalize
asset quantities before displaying to users. The wallet backend
will always return unscaled token quantities as whole numbers.
minimum: 0
maximum: 255
example: 2
x-assetMetadataUrl: &assetMetadataUrl
description: |
A URL to the policy's owner(s) or the entity website in charge of the asset.
type: string
format: uri
pattern: "^https://.+"
maxLength: 250
x-assetMetadataLogo: &assetMetadataLogo
description: |
A base64-encoded `image/png` for displaying the asset. The end image can be expected
to be smaller than 64KB.
type: string
format: base64
maxLength: 87400
x-assetMetadata: &assetMetadata
title: Native Assets Metadata
description: |
In the Mary era of Cardano, UTxO may contain native assets. These
assets are represented on-chain by opaque identifiers which are
meaningless to end-users. Therefore, user-facing metadata
regarding each token must be stored off-chain, in a metadata
registry.
Token creators may publish metadata into the registry and client
applications can consume these metadata for display to end
users. This will work in a similar way to how it is done for stake
pool metadata.
type: object
additionalProperties: false
required:
- name
- description
properties:
name: *assetMetadataName
description: *assetMetadataDescription
ticker: *assetMetadataTicker
decimals: *assetMetadataDecimals
url: *assetMetadataUrl
logo: *assetMetadataLogo
x-walletMnemonicSentence: &walletMnemonicSentence
description: A list of mnemonic words
type: array
minItems: 15
maxItems: 24
items:
type: string
format: bip-0039-mnemonic-word{english}
example: ["squirrel", "material", "silly", "twice", "direct", "slush", "pistol", "razor", "become", "junk", "kingdom", "flee", "squirrel", "silly", "twice"]
x-walletSecondFactor: &walletSecondFactor
description: An optional passphrase used to encrypt the mnemonic sentence.
type: array
minItems: 9
maxItems: 12
items:
type: string
format: bip-0039-mnemonic-word{english}
example: ["squirrel", "material", "silly", "twice", "direct", "slush", "pistol", "razor", "become"]
x-walletPassphrase: &walletPassphrase
description: A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds)
type: string
minLength: 10
maxLength: 255
example: Secure Passphrase
x-keyExtended: &keyExtended
description: Determines whether extended (with chain code) or normal (without chain code) key is requested
type: string
enum:
- extended
- non_extended
x-lenientPassphrase: &lenientPassphrase
description: A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds)
type: string
minLength: 0
maxLength: 255
example: Secure Passphrase
x-walletPassphraseHash: &walletPassphraseHash
description: |
A hash of master passphrase. The hash should be an output of a Scrypt function with the following parameters:
- logN = 14
- r = 8
- p = 1
type: string
format: hex
example: 31347c387c317c574342652b796362417576356c2b4258676a344a314c6343675375414c2f5653393661364e576a2b7550766655513d3d7c2f376738486c59723174734e394f6e4e753253302b6a65515a6b5437316b45414941366a515867386539493d
x-walletEncryptedRootPrivateKey: &walletEncryptedRootPrivateKey
description: |
A root private key, encrypted using a given passphrase. The underlying key should contain:
- A private key
- A chain code
- A public key
type: string
format: hex
minLength: 256
maxLength: 256
x-walletAddressPoolGap: &walletAddressPoolGap
description: |
Number of consecutive unused addresses allowed.
**IMPORTANT DISCLAIMER:** Using values other than `20` automatically makes your wallet invalid with regards to BIP-44 address discovery. It means that you **will not** be able to fully restore
your wallet in a different software which is strictly following BIP-44.
Beside, using large gaps is **not recommended** as it may induce important performance degradations. Use at your own risks.
**IMPORTANT DISCLAIMER 2:** There is no way to `import` addresses generated outside (e.g. using cardano-addresses) into the wallet.
Wallet only discovers transactions on its used and unused addresses that are within its currently seen `address_pool_gap`.
Transactions on addresses that "belong" to the wallet but happen to be beyond its `address_pool_gap` will not be visible to the wallet.
This is a technical limitation of the industry standard [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki). See also [CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/CIP-1852.md).
type: integer
minimum: 10
maximum: 100000
example: 20
default: 20
x-walletState: &walletState
<<: *syncProgress
description: Whether a wallet is ready to use or still syncing
x-walletBalance: &walletBalance
description: Wallet current Ada balance(s).
type: object
required:
- available
- reward
- total
properties:
available:
<<: *amount
description: Available Ada UTxO balance (funds that can be spent without condition).
reward:
<<: *amount
description: The Ada balance of the reward account for this wallet.
total:
<<: *amount
description: Total Ada balance (available balance plus pending change and reward balance).
x-walletAsset: &walletAsset
description: |
An asset on the Cardano blockchain. An asset is uniquely identified by
its `policy_id` and `asset_name` (together, these form the _asset id_).
Two assets with the same `asset_name` and `policy_id` are
interchangeable. Yet, different assets with a same `policy_id` but
different `asset_name` are treated as separate assets, as are two
assets with the same `asset_name` but different `policy_id`.
type: object
required:
- policy_id
- asset_name
- quantity
properties:
policy_id: *assetPolicyId
asset_name: *assetName
quantity: *assetQuantity
x-walletAssets: &walletAssets
description: A flat list of assets (possibly empty).
type: array
items: *walletAsset
x-assetMint: &assetMint
type: object
required:
- policy_id
- asset_name
- quantity
properties:
policy_id: *assetPolicyId
asset_name: *assetName
fingerprint: *assetFingerprint
quantity:
type: integer
description: |
Positive values mean creation and negative values mean
destruction.
x-assetMintedBurned: &assetMintedBurned
type: object
required:
- policy_id
- asset_name
- quantity
properties:
policy_id: *assetPolicyId
asset_name: *assetName
quantity:
type: integer
minimum: 0
x-walletAssetsBalance: &walletAssetsBalance
description: |
Current non-Ada asset holdings of the wallet.
The amount of assets available to spend may be less than the total
unspent assets due to transaction change amounts which are yet to
be fully confirmed (pending).
type: object
required:
- available
- total
properties:
available:
<<: *walletAssets
description: |