forked from hoprnet/hopr-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rest-api-v2-full-spec.json
2245 lines (2245 loc) · 89.9 KB
/
rest-api-v2-full-spec.json
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.3",
"servers": [{ "url": "/api/v2" }],
"info": {
"description": "This Rest API enables developers to interact with a hoprd node programatically.",
"version": "2.0.0",
"title": "HOPRd Rest API v2",
"contact": { "email": "tech@hoprnet.org" },
"license": { "name": "GPL-3.0", "url": "https://github.com/hoprnet/hoprnet/blob/master/LICENSE" }
},
"paths": {
"/tokens/": {
"parameters": [],
"post": {
"description": "Create a new authentication token based on the given information. The new token is returned as part of the response body and must be stored by the client. It cannot be read again in cleartext and is lost, if the client loses the token. An authentication has a lifetime. It can be unbound, meaning it will not expire. Or it has a limited lifetime after which it expires. The requested limited lifetime is requested by the client in seconds.",
"tags": ["Tokens"],
"operationId": "tokensCreate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["capabilities"],
"properties": {
"capabilities": {
"description": "Capabilities attached to the created token.",
"type": "array",
"format": "tokenCapabilities",
"minItems": 1,
"items": { "$ref": "#/components/schemas/TokenCapability" }
},
"lifetime": {
"type": "integer",
"minimum": 1,
"description": "Lifetime of the token in seconds since creation. Defaults to unlimited lifetime."
},
"description": { "type": "string", "description": "Description associated with the token." }
},
"example": { "description": "my test token", "lifetime": 360, "capabilities": [] }
}
}
}
},
"responses": {
"201": {
"description": "Token succesfully created.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"example": "MYtoken1223",
"description": "The generated token which must be used when authenticating for API calls."
}
}
}
}
}
},
"400": {
"description": "Problem with inputs.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RequestStatus" },
"example": { "status": "INVALID_TOKEN_LIFETIME | INVALID_TOKEN_CAPABILITIES" }
}
}
},
"403": { "description": "Missing capability to access endpoint" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/token": {
"parameters": [],
"get": {
"description": "Get the full token information for the token used in authentication.",
"tags": ["Tokens"],
"operationId": "tokensGetToken",
"responses": {
"200": {
"description": "Token information.",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } }
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"404": { "$ref": "#/components/responses/NotFound" }
}
}
},
"/tickets/statistics": {
"parameters": [],
"get": {
"description": "Get statistics regarding all your tickets. Node gets a ticket everytime it relays data packet in channel.",
"tags": ["Tickets"],
"operationId": "ticketsGetStatistics",
"responses": {
"200": {
"description": "Tickets statistics fetched successfully. Check schema for description of every field in the statistics.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pending": {
"type": "number",
"description": "Number of tickets that other node in the channel earned and didn't redeem yet."
},
"unredeemed": {
"type": "number",
"description": "Number of tickets that wait to be redeemed as for Hopr tokens."
},
"unredeemedValue": {
"type": "string",
"description": "Total value of all unredeemed tickets in Hopr tokens."
},
"redeemed": { "type": "number", "description": "Number of tickets already redeemed on this node." },
"redeemedValue": {
"type": "string",
"description": "Total value of all redeemed tickets in Hopr tokens."
},
"losingTickets": {
"type": "number",
"description": "Number of tickets that didn't win any Hopr tokens. To better understand how tickets work read about probabilistic payments (https://docs.hoprnet.org/core/probabilistic-payments)"
},
"winProportion": {
"type": "number",
"description": "Proportion of number of winning tickets vs loosing tickets, 1 means 100% of tickets won and 0 means that all tickets were losing ones."
},
"neglected": {
"type": "number",
"description": "Number of tickets that were not redeemed in time before channel was closed. Those cannot be redeemed anymore."
},
"rejected": {
"type": "number",
"description": "Number of tickets that were rejected by the network by not passing validation. In other words tickets that look suspicious and are not eligible for redeeming."
},
"rejectedValue": {
"type": "string",
"description": "Total value of rejected tickets in Hopr tokens"
}
}
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/tickets/redeem": {
"parameters": [],
"post": {
"description": "Redeems all tickets from all the channels and exchanges them for Hopr tokens. Every ticket have a chance to be winning one, rewarding you with Hopr tokens.",
"tags": ["Tickets"],
"operationId": "ticketsRedeemTickets",
"responses": {
"204": { "description": "Tickets redeemed succesfully." },
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/tickets/": {
"parameters": [],
"get": {
"description": "Get all tickets earned by relaying data packets by your node from every channel.",
"tags": ["Tickets"],
"operationId": "ticketsGetTickets",
"responses": {
"200": {
"description": "Tickets fetched successfully.",
"content": {
"application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } }
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/settings/": {
"parameters": [],
"get": {
"description": "Get all of the node's settings.",
"tags": ["Settings"],
"operationId": "settingsGetSettings",
"responses": {
"200": {
"description": "Settings fetched succesfully.",
"content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } }
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/node/version": {
"parameters": [],
"get": {
"description": "Get release version of the running node.",
"tags": ["Node"],
"operationId": "nodeGetVersion",
"responses": {
"200": {
"description": "Returns the release version of the running node.",
"content": {
"application/json": {
"schema": { "type": "string", "description": "Node version.", "example": "1.83.5" }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/node/stream/websocket": {
"parameters": [],
"get": {
"description": "This is a websocket endpoint which streams legacy hopr-admin data. Authentication (if enabled) is done via either passing an `apiToken` parameter in the url or cookie `X-Auth-Token`. Connect to the endpoint by using a WS client. No preview available. Example: `ws://127.0.0.1:3001/api/v2/node/stream/websocket/?apiToken=myApiToken`",
"tags": ["Node"],
"operationId": "nodeStreamWebsocket",
"deprecated": true,
"responses": {
"101": { "description": "Switching protocols" },
"206": {
"description": "Incoming data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of data",
"example": ["log", "fatal-error", "status", "connected"]
},
"timestamp": {
"type": "number",
"description": "Timestamp in miliseconds",
"example": 1644587213977
},
"content": { "type": "string", "description": "The text content", "example": "Opening channel..." }
}
},
"example": { "type": "log", "timestamp": 1644587213977, "content": "Opening channel..." }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"404": { "description": "Not found" }
}
}
},
"/node/ping": {
"parameters": [],
"post": {
"description": "Pings another node to check its availability.",
"tags": ["Node"],
"operationId": "nodePing",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["peerId"],
"properties": {
"peerId": {
"format": "peerId",
"type": "string",
"description": "PeerId associated to the other node that we want to ping."
}
},
"example": { "peerId": "16Uiu2HAmUsJwbECMroQUC29LQZZWsYpYZx1oaM1H9DBoZHLkYn12" }
}
}
}
},
"responses": {
"200": {
"description": "Ping successful.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"latency": {
"type": "number",
"example": 10,
"description": "Number of miliseconds it took to get the response from the pinged node."
}
}
}
}
}
},
"400": {
"description": "Invalid peerId.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RequestStatus" },
"example": { "status": "INVALID_PEERID" }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "An error occured (see error details) or timeout - node with specified PeerId didn't respond in time.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RequestStatus" },
"example": { "status": "TIMEOUT" }
}
}
}
}
}
},
"/node/peers": {
"parameters": [],
"get": {
"description": "Lists information for `connected peers` and `announced peers`.\nConnected peers are nodes which are connected to the node while announced peers are nodes which have announced to the network.\nOptionally, you can pass `quality` parameter which would filter out peers with lower quality to the one specified.",
"tags": ["Node"],
"operationId": "nodeGetPeers",
"parameters": [
{
"in": "query",
"name": "quality",
"description": "When quality is passed, the response will only include peers with higher or equal quality to the one specified.",
"schema": { "type": "number", "example": "0.5" }
}
],
"responses": {
"200": {
"description": "Peers information fetched successfuly.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connected": {
"type": "array",
"items": {
"type": "object",
"properties": {
"peerId": { "$ref": "#/components/schemas/HoprAddress" },
"multiAddr": { "$ref": "#/components/schemas/MultiAddress" },
"heartbeats": {
"type": "object",
"properties": {
"sent": { "type": "number", "description": "Heartbeats sent to the node", "example": 10 },
"success": {
"type": "number",
"description": "Successful heartbeats sent to the node",
"example": 8
}
}
},
"lastSeen": {
"type": "number",
"description": "Timestamp on when the node was last seen (in milliseconds)",
"example": 1646410980793
},
"quality": {
"type": "number",
"description": "A float between 0 (completely unreliable) and 1 (completely reliable) estimating the quality of service of a peer's network connection",
"example": 0.8
},
"backoff": { "type": "number" },
"isNew": {
"type": "boolean",
"description": "True if the node is new (no heartbeats sent yet)."
}
}
}
},
"announced": {
"type": "array",
"items": {
"type": "object",
"properties": {
"peerId": { "$ref": "#/components/schemas/HoprAddress" },
"multiAddr": { "$ref": "#/components/schemas/MultiAddress" },
"heartbeats": {
"type": "object",
"properties": {
"sent": { "type": "number", "description": "Heartbeats sent to the node", "example": 10 },
"success": {
"type": "number",
"description": "Successful heartbeats sent to the node",
"example": 8
}
}
},
"lastSeen": {
"type": "number",
"description": "Timestamp on when the node was last seen (in milliseconds)",
"example": 1646410980793
},
"quality": {
"type": "number",
"description": "A float between 0 (completely unreliable) and 1 (completely reliable) estimating the quality of service of a peer's network connection",
"example": 0.8
},
"backoff": { "type": "number" },
"isNew": {
"type": "boolean",
"description": "True if the node is new (no heartbeats sent yet)."
}
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid input. One of the parameters passed is in an incorrect format.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RequestStatus" },
"example": { "status": "INVALID_QUALITY" }
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/node/metrics": {
"parameters": [],
"get": {
"description": "Retrieve Prometheus metrics from the running node.",
"tags": ["Node"],
"operationId": "nodeGetMetrics",
"responses": {
"200": {
"description": "Returns the encoded serialized metrics.",
"content": {
"text/plain; version=0.0.4": {
"schema": {
"type": "string",
"description": "Prometheus metrics text format",
"example": "basic_counter 30"
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/node/info": {
"parameters": [],
"get": {
"description": "Information about the HOPR Node, including any options it started with. See the schema of the response to get more information on each field.",
"tags": ["Node"],
"operationId": "nodeGetInfo",
"responses": {
"200": {
"description": "Node information fetched successfuly.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"environment": {
"type": "string",
"example": "anvil-localhost",
"description": "Name of the enviroment the node is running on."
},
"announcedAddress": {
"type": "array",
"items": {
"type": "string",
"description": "description: Public IP address that the node announced on network when it was launched. Node anouncing means notifying all the other nodes on the network about its presence and readiness to be connected to via websocket."
},
"example": [
"/ip4/128.0.215.32/tcp/9080/p2p/16Uiu2HAm91QFjPepnwjuZWzK5pb5ZS8z8qxQRfKZJNXjkgGNUAit",
"/p2p/16Uiu2HAmLpqczAGfgmJchVgVk233rmB2T3DSn2gPG6JMa5brEHZ1/p2p-circuit/p2p/16Uiu2HAm91QFjPepnwjuZWzK5pb5ZS8z8qxQRfKZJNXjkgGNUAit",
"/ip4/127.0.0.1/tcp/9080/p2p/16Uiu2HAm91QFjPepnwjuZWzK5pb5ZS8z8qxQRfKZJNXjkgGNUAit",
"/ip4/192.168.178.56/tcp/9080/p2p/16Uiu2HAm91QFjPepnwjuZWzK5pb5ZS8z8qxQRfKZJNXjkgGNUAit"
]
},
"listeningAddress": {
"type": "array",
"items": {
"type": "string",
"description": "Other nodes IP address that this node is listening to for websocket events."
},
"example": ["/ip4/0.0.0.0/tcp/9080/p2p/16Uiu2HAm91QFjPepnwjuZWzK5pb5ZS8z8qxQRfKZJNXjkgGNUAit"]
},
"network": {
"type": "string",
"example": "anvil",
"description": "Name of the Hopr network this node connects to."
},
"hoprToken": {
"type": "string",
"example": "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512",
"description": "Contract address of the Hopr token on the ethereum network."
},
"hoprChannels": {
"type": "string",
"example": "0x2a54194c8fe0e3CdeAa39c49B95495aA3b44Db63",
"description": "Contract address of the HoprChannels smart contract on ethereum network. This smart contract is used to open payment channels between nodes on blockchain."
},
"hoprNetworkRegistryAddress": {
"type": "string",
"example": "0xBEE1F5d64b562715E749771408d06D57EE0892A7",
"description": "Contract address of the contract that allows to control the number of nodes in the network"
},
"connectivityStatus": {
"type": "string",
"example": "GREEN",
"description": "Indicates how good is the connectivity of this node to the HOPR network: either RED, ORANGE, YELLOW or GREEN"
},
"isEligible": {
"type": "boolean",
"example": true,
"description": "Determines whether the staking account associated with this node is eligible for accessing the HOPR network. Always true if network registry is disabled."
},
"channelClosurePeriod": {
"type": "number",
"example": 1,
"description": "Time (in minutes) that this node needs in order to clean up before closing the channel. When requesting to close the channel each node needs some time to make sure that channel can be closed securely and cleanly. After this channelClosurePeriod passes the second request for closing channel will close the channel."
}
}
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/node/entryNodes": {
"parameters": [],
"get": {
"description": "List all known entry nodes and their multiaddrs and their eligibility state",
"tags": ["Node"],
"operationId": "nodeGetEntryNodes",
"responses": {
"200": {
"description": "Entry node information fetched successfuly.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"multiaddrs": {
"type": "array",
"items": { "type": "string" },
"description": "Known Multiaddrs of the node"
},
"isEligible": {
"type": "boolean",
"description": "true if peer is allowed to access network, otherwise false"
}
}
}
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/messages/websocket": {
"parameters": [],
"get": {
"description": "This is a websocket endpoint which streams incoming messages from other nodes. Data is streamed in a stringified Uint8Array instance. Authentication (if enabled) is done via either passing an `apiToken` parameter in the url or cookie `X-Auth-Token`. Connect to the endpoint by using a WS client. No preview available. Example: `ws://127.0.0.1:3001/api/v2/messages/websocket/?apiToken=myApiToken`",
"tags": ["Messages"],
"operationId": "messagesWebsocket",
"responses": {
"101": { "description": "Switching protocols" },
"206": {
"description": "Incoming data",
"content": {
"application/text": {
"schema": { "type": "string" },
"example": "104,101,108,108,111,32,119,111,114,108,100"
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"404": { "description": "Not found" }
}
}
},
"/messages/sign": {
"parameters": [],
"post": {
"description": "Signs a message given using the node’s private key. Prefixes messsage with “HOPR Signed Message: ” before signing.",
"tags": ["Messages"],
"operationId": "messagesSign",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["message"],
"properties": { "message": { "description": "The message to be signed.", "type": "string" } }
}
}
}
},
"responses": {
"200": {
"description": "The message was signed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": { "signature": { "$ref": "#/components/schemas/Signature" } }
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/messages/": {
"parameters": [],
"post": {
"description": "Send a message to another peer using a given path (list of node addresses that should relay our message through network). If no path is given, HOPR will attempt to find a path.",
"tags": ["Messages"],
"operationId": "messagesSendMessage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["body", "recipient"],
"properties": {
"body": {
"description": "The message body which should be sent.",
"type": "string",
"example": "Hello"
},
"recipient": {
"description": "The recipient HOPR peer id, to which the message is sent.",
"type": "string",
"format": "peerId",
"example": "16Uiu2HAm2SF8EdwwUaaSoYTiZSddnG4hLVF7dizh32QFTNWMic2b"
},
"path": {
"description": "The path is ordered list of peer ids through which the message should be sent. If no path is provided, a path which covers the nodes minimum required hops will be determined automatically.",
"type": "array",
"items": {
"description": "A valid HOPR peer id",
"type": "string",
"format": "peerId",
"minItems": 1,
"maxItems": 3,
"example": "16Uiu2HAm1uV82HyD1iJ5DmwJr4LftmJUeMfj8zFypBRACmrJc16n"
}
},
"hops": {
"description": "Number of required intermediate nodes. This parameter is ignored if path is set.",
"type": "integer",
"minimum": 1,
"maximum": 3,
"example": 3
}
}
}
}
}
},
"responses": {
"202": {
"description": "The message was sent successfully. NOTE: This does not imply successful delivery.",
"content": {
"application/json": {
"schema": {
"type": "string",
"description": "Challenge token used to poll for the acknowledgment of the sent message by the first hop.",
"example": "e61bbdda74873540c7244fe69c39f54e5270bd46709c1dcb74c8e3afce7b9e616d"
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
}
}
},
"/message/sign": {
"parameters": [],
"post": {
"description": "Signs a message given using the node’s private key. Prefixes messsage with “HOPR Signed Message: ” before signing.",
"tags": ["Messages"],
"operationId": "messageSign",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["message"],
"properties": { "message": { "description": "The message to be signed.", "type": "string" } }
}
}
}
},
"responses": {
"200": {
"description": "The message was signed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": { "signature": { "$ref": "#/components/schemas/Signature" } }
}
}
}
},
"401": { "$ref": "#/components/responses/Unauthorized" },
"403": { "$ref": "#/components/responses/Forbidden" },
"422": {
"description": "Unknown failure.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": { "type": "string", "example": "UNKNOWN_FAILURE" },
"error": { "type": "string", "example": "Full error message." }
}
},
"example": { "status": "UNKNOWN_FAILURE", "error": "Full error message." }
}
}
}
},
"deprecated": true
}
},
"/fundmulti/": {
"parameters": [],
"post": {
"description": "Fund one or two payment channels between this node and the counter party provided.",
"tags": ["Channels"],
"operationId": "channelsFundChannels",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["peerId", "outgoingAmount", "incomingAmount"],
"properties": {
"peerId": {
"format": "peerId",
"type": "string",
"description": "PeerId to fund the outgoing/incoming channels with."
},
"outgoingAmount": {
"format": "amount",
"type": "string",
"description": "Amount of HOPR tokens to fund the outgoing channel (node -> counterparty). It will be used to pay for sending messages through channel"
},
"incomingAmount": {
"format": "amount",
"type": "string",
"description": "Amount of HOPR tokens to fund the incoming channel (counterparty -> node). It will be used to pay for sending messages through channel"
}
},
"example": {
"peerId": "16Uiu2HAmUsJwbECMroQUC29LQZZWsYpYZx1oaM1H9DBoZHLkYn12",
"outgoingAmount": "1000000",
"incomingAmount": "1000000"
}
}
}
}
},
"responses": {
"201": {
"description": "Channels succesfully funded.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"receipt": {
"type": "string",
"example": "0x37954ca4a630aa28f045df2e8e604cae22071046042e557355acf00f4ef20d2e",
"description": "Receipt for fund multi channels transaction. Can be used to check status of the smart contract call on blockchain."
}
}
}
}
}
},
"400": {
"description": "Problem with inputs (invalid peerId or invalid amount).",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/RequestStatus" },
"example": { "status": "INVALID_PEERID | INVALID_AMOUNT" }
}
}
},
"403": {