-
Notifications
You must be signed in to change notification settings - Fork 36
/
openapi.yml
1582 lines (1580 loc) · 46.1 KB
/
openapi.yml
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: Flow Wallet API
description: A REST HTTP service that allows a developer to integrate wallet functionality into a larger Flow application infrastructure
version: 0.9.0
contact:
url: 'https://github.com/orgs/flow-hydraulics/teams/wallet'
servers:
- url: 'http://localhost:3000/v1'
tags:
- name: Debugging
description: View useful debugging information about the Wallet API.
- name: System
description: Get and set system wide settings (maintenance mode for example).
- name: Healthcheck
description: Healthcheck endpoints.
- name: Accounts
description: Create and lists accounts managed by this Wallet API.
- name: Account Transactions
description: 'Send, list and get transactions for an account.'
- name: Account Fungible Tokens
description: Manage fungible tokens for an account.
- name: Account Non-Fungible Tokens
description: Manage fungible tokens for an account.
- name: Transactions
description: Manage transactions sent by the Wallet API.
- name: Scripts
description: Run zero-cost Cadence scripts to read on-chain data.
- name: Fungible Tokens
description: 'Initialize tokens, withdraw funds and detect deposits of fungible tokens.'
- name: Non-Fungible Tokens
description: 'Initialize non-fungible tokens, transfer NFTs and detect deposits of NFTs.'
- name: Jobs
description: View the status of asynchronous tasks being completed by the Wallet API.
- name: Watchlist
description: View info for non-custodial accounts of interest.
- name: Ops
description: System operations and admin jobs.
paths:
/debug:
get:
summary: Get debug information about the running instance.
operationId: getInstanceDebugInfo
tags:
- Debugging
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/debugInfo'
/system/settings:
get:
summary: Get system settings
tags:
- System
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
description: ''
type: object
properties:
maintenanceMode:
type: boolean
required:
- maintenanceMode
x-examples:
example-1:
maintenanceMode: false
examples:
example-1:
value:
maintenanceMode: true
operationId: get-system-settings
description: Get system wide settings.
post:
summary: Set system settings
operationId: post-system-settings
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
maintenanceMode:
type: boolean
required:
- maintenanceMode
x-examples:
example-1:
maintenanceMode: false
'400':
description: Bad Request
content:
application/json:
schema:
type: string
description: Set system wide settings.
tags:
- System
requestBody:
content:
application/json:
schema:
description: ''
type: object
properties:
maintenanceMode:
type: boolean
x-examples:
example-1:
maintenanceMode: false
examples:
example-1:
value:
maintenanceMode: true
description: Post only fields you want to be changed.
parameters:
- $ref: '#/components/parameters/idempotencyKey'
/system/sync-account-key-count:
post:
summary: Sync key count for existing accounts
tags:
- System
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/job'
operationId: post-system-sync-account-key-count
parameters:
- $ref: '#/components/parameters/idempotencyKey'
requestBody:
content:
application/json:
schema:
type: object
properties:
address:
type: string
examples:
example-1:
value:
address: '0xf669cb8d41ce0c74'
/health/ready:
get:
summary: Healthcheck ready
tags:
- Healthcheck
responses:
'200':
description: OK
operationId: get-health-ready
description: Always responds with 200 OK when the service is running
/health/liveness:
get:
summary: Healthcheck liveness
tags:
- Healthcheck
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
jobsInit:
type: number
jobsNotAccepted:
type: number
jobsAccepted:
type: number
jobsErrored:
type: number
jobsFailed:
type: number
jobsCompleted:
type: number
poolCapacity:
type: number
workerCount:
type: number
required:
- jobsInit
- jobsNotAccepted
- jobsAccepted
- jobsErrored
- jobsFailed
- jobsCompleted
- poolCapacity
- workerCount
x-examples:
example-1:
jobsInit: 0
jobsNotAccepted: 0
jobsAccepted: 0
jobsErrored: 0
jobsFailed: 0
jobsCompleted: 0
poolCapacity: 1000
workerCount: 100
examples:
example-1:
value:
jobsInit: 0
jobsNotAccepted: 3
jobsAccepted: 0
jobsErrored: 1
jobsFailed: 2
jobsCompleted: 10
poolCapacity: 1000
workerCount: 100
operationId: get-health-liveness
description: Get basic job queue statistics.
/tokens:
get:
summary: List enabled tokens
description: List all tokens (fungible and non-fungible) that are enabled in this instance.
operationId: listEnabledTokens
tags:
- Fungible Tokens
- Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
oneOf:
- $ref: '#/components/schemas/fungibleToken'
- $ref: '#/components/schemas/nonFungibleToken'
post:
summary: Enable a new token
description: 'Enable a new token by sending its name, address and required Cadence transaction codes'
operationId: enableNewToken
tags:
- Fungible Tokens
- Non-Fungible Tokens
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/fungibleTokenEnable'
- $ref: '#/components/schemas/nonFungibleTokenEnable'
responses:
'201':
description: OK
parameters:
- $ref: '#/components/parameters/idempotencyKey'
'/tokens/{id_or_name}':
parameters:
- name: id_or_name
in: path
required: true
schema:
oneOf:
- type: number
example: 1
- type: string
example: FlowToken
get:
summary: Get enabled token details
operationId: getEnabledTokenDetails
tags:
- Fungible Tokens
- Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/fungibleTokenDetails'
- $ref: '#/components/schemas/nonFungibleTokenDetails'
'/tokens/{id}':
parameters:
- name: id
in: path
required: true
schema:
type: number
example: 1
delete:
summary: Remove a token from the service
description: 'Remove a token, disabling functionality regarding it. Won''t affect accounts.'
operationId: removeToken
tags:
- Fungible Tokens
- Non-Fungible Tokens
responses:
'200':
description: Removal OK.
content:
application/json:
schema:
type: integer
/fungible-tokens:
get:
summary: List enabled fungible tokens
description: List all fungible tokens that are enabled in this instance.
operationId: listEnabledFungibleTokens
tags:
- Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/fungibleToken'
/non-fungible-tokens:
get:
summary: List enabled non-fungible tokens
description: List all non-fungible tokens that are enabled in this instance.
operationId: listEnabledNonFungibleTokens
tags:
- Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/nonFungibleToken'
/transactions:
get:
summary: List all transactions
description: Get a list of all transactions sent from this service.
operationId: listTransactions
tags:
- Transactions
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/transaction'
'/transactions/{transactionId}':
parameters:
- $ref: '#/components/parameters/transactionId'
get:
summary: Get a transaction
description: |-
Get the details of a transaction sent by this service.
NOTE: Will include possible transaction events.
operationId: getTransactionDetails
tags:
- Transactions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/transactionWithEvents'
/scripts:
post:
summary: Execute a script on chain
operationId: executeScriptOnChain
tags:
- Scripts
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/script'
- example:
code: 'pub fun main(): Int { return 1 }'
arguments: []
responses:
'200':
description: Ok
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/cadenceValue'
- $ref: '#/components/schemas/plainValue'
/jobs:
get:
summary: List all jobs
operationId: listAllJobs
tags:
- Jobs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/job'
'/jobs/{jobId}':
parameters:
- $ref: '#/components/parameters/jobId'
get:
summary: Get job details
operationId: getJobDetails
tags:
- Jobs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/job'
/accounts:
get:
summary: List accounts
description: Get a list of all accounts managed by the wallet service.
operationId: listAllAccounts
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/account'
post:
summary: Create an account
description: Create a new account that will be managed by the wallet service. Returns a job.
operationId: createAccount
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/sync'
- $ref: '#/components/parameters/idempotencyKey'
responses:
'201':
description: Created
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/job'
- $ref: '#/components/schemas/account'
'/accounts/{address}':
parameters:
- $ref: '#/components/parameters/address'
get:
summary: Get an account
description: Get the details of a specific account.
operationId: getAccountDetails
tags:
- Accounts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/account'
'/accounts/{address}/sign':
post:
summary: Sign a raw transaction
description: 'Sign a transaction with custodial account keys, without sending it. Signed transaction is returned in response (with signatures).'
operationId: signRawTransaction
tags:
- Account Transactions
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/idempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/script'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/signedTransaction'
'/accounts/{address}/transactions':
parameters:
- $ref: '#/components/parameters/address'
get:
summary: List account raw transactions
description: Get a list of all transactions sent by an account.
operationId: listAccountRawTransactions
tags:
- Account Transactions
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/transaction'
post:
summary: Send a raw transaction
description: |-
Send a transaction from an account. Returns a job, or the account information when synchronous mode is enabled.
NOTE: The transaction code should require _exactly_ one AuthAccount and is assumed to be the account sending the transaction.
operationId: sendRawTransaction
tags:
- Account Transactions
parameters:
- $ref: '#/components/parameters/sync'
- $ref: '#/components/parameters/idempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/script'
responses:
'201':
description: Created
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/job'
- $ref: '#/components/schemas/transactionWithEvents'
'/accounts/{address}/transactions/{transactionId}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/transactionId'
get:
summary: Get a raw transaction
description: Get the details of a raw transaction sent by an account.
operationId: getRawTransactionDetails
tags:
- Account Transactions
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/transaction'
'/accounts/{address}/fungible-tokens':
parameters:
- $ref: '#/components/parameters/address'
get:
summary: List account fungible tokens
description: List fungible tokens that are enabled for an account.
operationId: listAccountFungibleTokens
tags:
- Account Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/accountFungibleToken'
'/accounts/{address}/fungible-tokens/{tokenName}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/fungibleTokenName'
get:
summary: Get account fungible tokens details
description: Get details (balance) regarding a fungible token for an account.
operationId: getAccountFungibleTokenDetails
tags:
- Account Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/accountFungibleTokenDetails'
post:
summary: Enable a fungible token for an account
operationId: enableFungibleTokenForAccount
tags:
- Account Fungible Tokens
parameters:
- $ref: '#/components/parameters/sync'
- $ref: '#/components/parameters/idempotencyKey'
responses:
'201':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/job'
- $ref: '#/components/schemas/transactionWithEvents'
'/accounts/{address}/fungible-tokens/{tokenName}/withdrawals':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/fungibleTokenName'
get:
summary: List accounts withdrawals of a fungible token
operationId: listAccountFungibleTokenWithdrawals
tags:
- Account Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/fungibleTokenWithdrawal'
post:
summary: Create a fungible token withdrawal
operationId: createFungibleTokenWithdrawal
tags:
- Account Fungible Tokens
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/fungibleTokenWithdrawalRequest'
parameters:
- $ref: '#/components/parameters/sync'
- $ref: '#/components/parameters/idempotencyKey'
responses:
'201':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/job'
- $ref: '#/components/schemas/transactionWithEvents'
'/accounts/{address}/fungible-tokens/{tokenName}/withdrawals/{transactionId}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/fungibleTokenName'
- $ref: '#/components/parameters/transactionId'
get:
summary: Get details of a fungible token withdrawal
operationId: getFungibleTokenWithdrawalDetails
tags:
- Account Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/fungibleTokenWithdrawal'
'/accounts/{address}/fungible-tokens/{tokenName}/deposits':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/fungibleTokenName'
get:
summary: List accounts deposits of a fungible token
operationId: listAccountFungibleTokenDeposits
tags:
- Account Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/fungibleTokenDeposit'
'/accounts/{address}/fungible-tokens/{tokenName}/deposits/{transactionId}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/fungibleTokenName'
- $ref: '#/components/parameters/transactionId'
get:
summary: Get details of a fungible token deposit
operationId: getFungibleTokenDepositDetails
tags:
- Account Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/fungibleTokenDeposit'
'/accounts/{address}/non-fungible-tokens':
parameters:
- $ref: '#/components/parameters/address'
get:
summary: List accounts non-fungible tokens
description: List all non-fungible tokens that are enabled for an account.
operationId: listAccountNonFungibleTokens
tags:
- Account Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/accountNonFungibleToken'
'/accounts/{address}/non-fungible-tokens/{tokenName}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/nonFungibleTokenName'
get:
summary: Get account non-fungible token details
description: Get details (balance) regarding a non-fungible token for an account.
operationId: GetAccountNonFungibleTokenDetails
tags:
- Account Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/accountNonFungibleTokenDetails'
post:
summary: Enable a non-fungible token for an account
operationId: enableNonFungibleTokenForAccount
tags:
- Account Non-Fungible Tokens
parameters:
- $ref: '#/components/parameters/sync'
- $ref: '#/components/parameters/idempotencyKey'
responses:
'201':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/job'
- $ref: '#/components/schemas/transactionWithEvents'
'/accounts/{address}/non-fungible-tokens/{tokenName}/withdrawals':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/nonFungibleTokenName'
get:
summary: List withdrawals of a non-fungible token
operationId: listNonFungibleTokenWithdrawals
tags:
- Account Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/nonFungibleTokenWithdrawal'
post:
summary: Create a non-fungible token withdrawal
operationId: createNonFungibleTokenWithdrawal
tags:
- Account Non-Fungible Tokens
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/nonFungibleTokenWithdrawalRequest'
parameters:
- $ref: '#/components/parameters/sync'
- $ref: '#/components/parameters/idempotencyKey'
responses:
'201':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/job'
- $ref: '#/components/schemas/transactionWithEvents'
'/accounts/{address}/non-fungible-tokens/{tokenName}/withdrawals/{transactionId}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/nonFungibleTokenName'
- $ref: '#/components/parameters/transactionId'
get:
summary: Get details of a non-fungible token withdrawal
operationId: getNonFungibleTokenWithdrawalDetails
tags:
- Account Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/nonFungibleTokenWithdrawal'
'/accounts/{address}/non-fungible-tokens/{tokenName}/deposits':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/nonFungibleTokenName'
get:
summary: List deposits of a non-fungible token
operationId: listNonFungibleTokenDeposits
tags:
- Account Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/nonFungibleTokenDeposit'
'/accounts/{address}/non-fungible-tokens/{tokenName}/deposits/{transactionId}':
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/nonFungibleTokenName'
- $ref: '#/components/parameters/transactionId'
get:
summary: Get details of a non-fungible token deposit
operationId: getNonFungibleTokenDepositDetails
tags:
- Account Non-Fungible Tokens
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/nonFungibleTokenDeposit'
/watchlist/accounts:
post:
summary: Add a non-custodial account to watchlist.
description: Add a non-custodial account to watchlist so that deposits to them can be tracked.
operationId: addWatchlistAccount
tags:
- Watchlist
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/account'
- example:
address: '0xf8d6e0586b0a20c7'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/account'
parameters:
- $ref: '#/components/parameters/idempotencyKey'
'/watchlist/accounts/{address}':
parameters:
- $ref: '#/components/parameters/address'
delete:
summary: Remove a non-custodial account from watchlist.
description: Remove an account from a watchlist of non-custodial accounts' deposits.
operationId: removeWatchlistAccount
tags:
- Watchlist
responses:
'200':
description: OK
'/ops/missing-fungible-token-vaults/stats':
get:
summary: Returns number of uninitialized accounts per enabled fungible token.
description: Returns number of uninitialized accounts per enabled fungible token based on the database. You can also use this endpoint to check the init job progress.
operationId: getMissingFungibleTokenVaults
tags:
- Ops
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/tokenCount'
'/ops/missing-fungible-token-vaults/start':
get:
summary: Starts the fungible token vault initialization job.
description: Starts the fungible token vault initialization job. The job is singleton.
operationId: initMissingFungibleTokenVaults
tags:
- Ops
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
components:
schemas:
jobState:
type: string
example: ACCEPTED
enum:
- INIT
- ACCEPTED
- NO_AVAILABLE_WORKERS
- ERROR
- COMPLETE
- FAILED
debugInfo:
type: string
example: |
url: GET /v1/debug
Headers:
User-Agent: vscode-restclient
Content-Type: application/json
Connection: close
ver: https://github.com/flow-hydraulics/flow-wallet-api/commit/
built on:
api version called: v1
account:
description: 'Response data for account info, private key NOT included'
type: object
x-examples:
example-1:
address: '0x179b6b1cb6755e31'
keys:
- index: 0
type: local
publicKey: '0xc885376ff315cc26e9740e5f5418c1e515cf690e590433a4774c2b9f4c522e7dbbb720b5049bed79820c66c8e6555997900579e6885b131180bb844cd87f4c62'
signAlgo: ECDSA_P256
hashAlgo: SHA3_256
createdAt: '2021-11-18T13:08:04.4236649+02:00'
updatedAt: '2021-11-18T13:08:04.4236649+02:00'
type: custodial
createdAt: '2021-11-18T13:08:04.4230401+02:00'
updatedAt: '2021-11-18T13:08:04.4230401+02:00'
properties:
address:
type: string
example: '0xf8d6e0586b0a20c7'
keys:
type: array
items:
$ref: '#/components/schemas/key'
type:
type: string
example: custodial
createdAt:
type: string
minLength: 1
example: '2021-04-27T05:49:53.211+00:00'
format: date-time
updatedAt:
type: string
example: '2021-04-27T05:49:54.211+00:00'
format: date-time
transactionEvent:
type: object
properties:
Type:
type: string
example: A.0ae53cb6e3f42a79.FlowToken.TokensWithdrawn