Last active
February 13, 2024 10:47
-
-
Save tolbrino/31ec835fdb2be5c88c774ea2fdf2f133 to your computer and use it in GitHub Desktop.
Diff or Hoprd HTTP API v3 Swagger Schema between v2.0.8 and v2.1.0
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- hoprd-http-api-v3-schema-2.0.8.json.new 2024-02-13 11:28:06.214324978 +0100 | |
| +++ hoprd-http-api-v3-schema-2.1.0.json.new 2024-02-13 11:43:56.434889079 +0100 | |
| @@ -1,3369 +1,3055 @@ | |
| { | |
| "openapi": "3.0.3", | |
| - "servers": [ | |
| - { | |
| - "url": "/api/v3" | |
| - } | |
| - ], | |
| "info": { | |
| - "description": "This Rest API enables developers to interact with a hoprd node programatically.", | |
| - "version": "3.0.0", | |
| - "title": "HOPRd Rest API v3", | |
| + "title": "hoprd-api", | |
| + "description": "This Rest API enables developers to interact with a hoprd node programatically through HTTP.", | |
| "contact": { | |
| + "name": "HOPR Association", | |
| "email": "[email protected]" | |
| }, | |
| "license": { | |
| - "name": "GPL-3.0", | |
| - "url": "https://github.com/hoprnet/hoprnet/blob/master/LICENSE" | |
| - } | |
| + "name": "GPL-3.0-only" | |
| + }, | |
| + "version": "3.1.0" | |
| }, | |
| "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.", | |
| + "/api/v3/account/addresses": { | |
| + "get": { | |
| "tags": [ | |
| - "Tokens" | |
| + "Account" | |
| ], | |
| - "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": [] | |
| - } | |
| - } | |
| - } | |
| - } | |
| - }, | |
| + "summary": "Get node's HOPR and native addresses.", | |
| + "description": "Get node's HOPR and native addresses.\n\nHOPR address is represented by the P2P PeerId and can be used by other node owner to interact with this node.", | |
| + "operationId": "addresses", | |
| "responses": { | |
| - "201": { | |
| - "description": "Token succesfully created.", | |
| + "200": { | |
| + "description": "The node's public addresses", | |
| "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." | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/AccountAddressesResponse" | |
| } | |
| } | |
| } | |
| }, | |
| - "400": { | |
| - "description": "Problem with inputs.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_TOKEN_LIFETIME | INVALID_TOKEN_CAPABILITIES" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "403": { | |
| - "description": "Missing capability to access endpoint" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/token": { | |
| - "parameters": [], | |
| + "/api/v3/account/balances": { | |
| "get": { | |
| - "description": "Get the full token information for the token used in authentication.", | |
| "tags": [ | |
| - "Tokens" | |
| + "Account" | |
| ], | |
| - "operationId": "tokensGetToken", | |
| + "summary": "Get node's and associated Safe's HOPR and native balances as the allowance for HOPR", | |
| + "description": "Get node's and associated Safe's HOPR and native balances as the allowance for HOPR\ntokens to be drawn by HoprChannels from Safe.\n\nHOPR tokens from the Safe balance are used to fund the payment channels between this\nnode and other nodes on the network.\nNATIVE balance of the Node is used to pay for the gas fees for the blockchain.", | |
| + "operationId": "balances", | |
| "responses": { | |
| "200": { | |
| - "description": "Token information.", | |
| + "description": "The node's HOPR and Safe balances", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/Token" | |
| + "$ref": "#/components/schemas/AccountBalancesResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "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.", | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "pending": { | |
| - "type": "number", | |
| - "description": "Not used. Always 0." | |
| - }, | |
| - "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." | |
| - }, | |
| - "neglectedValue": { | |
| - "type": "string", | |
| - "description": "Total value of all neglected tickets in Hopr tokens." | |
| - }, | |
| - "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" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/tickets/redeem": { | |
| - "parameters": [], | |
| + "/api/v3/account/withdraw": { | |
| "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" | |
| + "Account" | |
| ], | |
| - "operationId": "ticketsRedeemTickets", | |
| + "summary": "Withdraw funds from this node to the ethereum wallet address.", | |
| + "description": "Withdraw funds from this node to the ethereum wallet address.\n\nBoth NATIVE or HOPR can be withdrawn using this method.", | |
| + "operationId": "withdraw", | |
| + "requestBody": { | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/WithdrawBodyRequest" | |
| + } | |
| + } | |
| + }, | |
| + "required": true | |
| + }, | |
| "responses": { | |
| - "204": { | |
| - "description": "Tickets redeemed succesfully." | |
| + "200": { | |
| + "description": "The node's funds have been withdrawn", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/AccountBalancesResponse" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/tickets/": { | |
| - "parameters": [], | |
| + "/api/v3/aliases": { | |
| "get": { | |
| - "description": "Get all tickets earned by relaying data packets by your node from every channel.", | |
| "tags": [ | |
| - "Tickets" | |
| + "Alias" | |
| ], | |
| - "operationId": "ticketsGetTickets", | |
| + "summary": "Get each previously set alias and its corresponding PeerId", | |
| + "description": "Get each previously set alias and its corresponding PeerId", | |
| + "operationId": "aliases", | |
| "responses": { | |
| "200": { | |
| - "description": "Tickets fetched successfully.", | |
| + "description": "Each alias with its corresponding PeerId", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/Ticket" | |
| + "type": "object", | |
| + "additionalProperties": { | |
| + "type": "string" | |
| } | |
| + }, | |
| + "example": { | |
| + "alice": "12D3KooWPWD5P5ZzMRDckgfVaicY5JNoo7JywGotoAv17d7iKx1z", | |
| + "me": "12D3KooWJmLm8FnBfvYQ5BAZ5qcYBxQFFBzAAEYUBUNJNE8cRsYS" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "422": { | |
| - "description": "Unknown failure.", | |
| + "description": "Invalid authorization token.", | |
| "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - }, | |
| - "/settings/": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "Get all of the node's settings.", | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + }, | |
| + "post": { | |
| "tags": [ | |
| - "Settings" | |
| + "Alias" | |
| ], | |
| - "operationId": "settingsGetSettings", | |
| + "summary": "Set alias for a peer with a specific PeerId.", | |
| + "description": "Set alias for a peer with a specific PeerId.", | |
| + "operationId": "set_alias", | |
| + "requestBody": { | |
| + "description": "Alias name along with the PeerId to be aliased", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/AliasPeerIdBodyRequest" | |
| + } | |
| + } | |
| + }, | |
| + "required": true | |
| + }, | |
| "responses": { | |
| - "200": { | |
| - "description": "Settings fetched succesfully.", | |
| + "201": { | |
| + "description": "Alias set successfully.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/Settings" | |
| + "$ref": "#/components/schemas/PeerIdResponse" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "422": { | |
| - "description": "Unknown failure.", | |
| + "400": { | |
| + "description": "Invalid PeerId: The format or length of the peerId is incorrect.", | |
| "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - } | |
| - }, | |
| - "/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.", | |
| + }, | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "string", | |
| - "description": "Node version.", | |
| - "example": "1.83.5" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/node/peers": { | |
| - "parameters": [], | |
| + "/api/v3/aliases/{alias}": { | |
| "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" | |
| + "Alias" | |
| ], | |
| - "operationId": "nodeGetPeers", | |
| + "summary": "Get alias for the PeerId (Hopr address) that have this alias assigned to it.", | |
| + "description": "Get alias for the PeerId (Hopr address) that have this alias assigned to it.", | |
| + "operationId": "get_alias", | |
| "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.", | |
| + "name": "alias", | |
| + "in": "path", | |
| + "description": "Alias to be shown", | |
| + "required": true, | |
| "schema": { | |
| - "type": "number", | |
| - "example": "0.5" | |
| + "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| - "description": "Peers information fetched successfuly.", | |
| + "description": "Get PeerId for an alias", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "connected": { | |
| - "type": "array", | |
| - "items": { | |
| - "type": "object", | |
| - "properties": { | |
| - "peerId": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - }, | |
| - "peerAddress": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| - }, | |
| - "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)." | |
| - }, | |
| - "reportedVersion": { | |
| - "type": "string", | |
| - "example": "1.92.12", | |
| - "description": "HOPR protocol version as determined from the successful ping in the Major.Minor.Patch format or \"unknown\"" | |
| - } | |
| - } | |
| - } | |
| - }, | |
| - "announced": { | |
| - "type": "array", | |
| - "items": { | |
| - "type": "object", | |
| - "properties": { | |
| - "peerId": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - }, | |
| - "peerAddress": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| - }, | |
| - "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)." | |
| - }, | |
| - "reportedVersion": { | |
| - "type": "string", | |
| - "example": "1.92.12", | |
| - "description": "HOPR protocol version as determined from the successful ping in the Major.Minor.Patch format or \"unknown\"" | |
| - } | |
| - } | |
| - } | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/PeerIdResponse" | |
| } | |
| } | |
| } | |
| }, | |
| - "400": { | |
| - "description": "Invalid input. One of the parameters passed is in an incorrect format.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_QUALITY" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "422": { | |
| - "description": "Unknown failure.", | |
| + "404": { | |
| + "description": "PeerId not found", | |
| "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - }, | |
| - "/node/metrics": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "Retrieve Prometheus metrics from the running node.", | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + }, | |
| + "delete": { | |
| "tags": [ | |
| - "Node" | |
| + "Alias" | |
| + ], | |
| + "summary": "Delete an alias.", | |
| + "description": "Delete an alias.", | |
| + "operationId": "delete_alias", | |
| + "parameters": [ | |
| + { | |
| + "name": "alias", | |
| + "in": "path", | |
| + "description": "Alias to be shown", | |
| + "required": true, | |
| + "schema": { | |
| + "type": "string" | |
| + } | |
| + } | |
| ], | |
| - "operationId": "nodeGetMetrics", | |
| "responses": { | |
| - "200": { | |
| - "description": "Returns the encoded serialized metrics.", | |
| + "204": { | |
| + "description": "Alias removed successfully" | |
| + }, | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| - "text/plain; version=0.0.4": { | |
| + "application/json": { | |
| "schema": { | |
| - "type": "string", | |
| - "description": "Prometheus metrics text format", | |
| - "example": "basic_counter 30" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/node/info": { | |
| - "parameters": [], | |
| + "/api/v3/channels": { | |
| "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" | |
| + "Channels" | |
| + ], | |
| + "summary": "Lists channels opened to/from this node. Alternatively, it can print all", | |
| + "description": "Lists channels opened to/from this node. Alternatively, it can print all\nthe channels in the network as this node sees them.", | |
| + "operationId": "list_channels", | |
| + "parameters": [ | |
| + { | |
| + "name": "includingClosed", | |
| + "in": "query", | |
| + "description": "Should be the closed channels included?", | |
| + "required": false, | |
| + "schema": { | |
| + "type": "boolean" | |
| + } | |
| + }, | |
| + { | |
| + "name": "fullTopology", | |
| + "in": "query", | |
| + "description": "Should all channels (not only the ones concerning this node) be enumerated?", | |
| + "required": false, | |
| + "schema": { | |
| + "type": "boolean" | |
| + } | |
| + } | |
| ], | |
| - "operationId": "nodeGetInfo", | |
| "responses": { | |
| "200": { | |
| - "description": "Node information fetched successfuly.", | |
| + "description": "Channels fetched successfully", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "network": { | |
| - "type": "string", | |
| - "example": "anvil-localhost", | |
| - "description": "Name of the network 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" | |
| - ] | |
| - }, | |
| - "chain": { | |
| - "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 chain." | |
| - }, | |
| - "hoprChannels": { | |
| - "type": "string", | |
| - "example": "0x2a54194c8fe0e3CdeAa39c49B95495aA3b44Db63", | |
| - "description": "Contract address of the HoprChannels smart contract on ethereum chain. 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" | |
| - }, | |
| - "hoprNodeSafeRegistryAddress": { | |
| - "type": "string", | |
| - "example": "0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82", | |
| - "description": "Contract address of the contract that register node and safe pairs" | |
| - }, | |
| - "nodeManagementModule": { | |
| - "type": "string", | |
| - "example": "0x0262496080c3916d9afd5904EA3DFd46DfFBfF3D", | |
| - "description": "Contract address of the Safe module for managing the current hopr node" | |
| - }, | |
| - "nodeSafe": { | |
| - "type": "string", | |
| - "example": "0x8D56Ef78c9dfF0d1446A28476653D979336032f9", | |
| - "description": "Contract address of the safe that holds asset for the current node" | |
| - }, | |
| - "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." | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/NodeChannelsResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - }, | |
| - "/node/entryNodes": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "List all known entry nodes and their multiaddrs and their eligibility state", | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + }, | |
| + "post": { | |
| "tags": [ | |
| - "Node" | |
| + "Channels" | |
| ], | |
| - "operationId": "nodeGetEntryNodes", | |
| + "summary": "Opens a channel to the given on-chain address with the given initial stake of HOPR tokens.", | |
| + "description": "Opens a channel to the given on-chain address with the given initial stake of HOPR tokens.", | |
| + "operationId": "open_channel", | |
| + "requestBody": { | |
| + "description": "Open channel request specification: on-chain address of the counterparty and the initial HOPR token stake.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/OpenChannelBodyRequest" | |
| + } | |
| + } | |
| + }, | |
| + "required": true | |
| + }, | |
| "responses": { | |
| - "200": { | |
| - "description": "Entry node information fetched successfuly.", | |
| + "201": { | |
| + "description": "Channel successfully opened", | |
| "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" | |
| - } | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/OpenChannelResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "422": { | |
| - "description": "Unknown failure.", | |
| + "description": "Failed to open the channel because of insufficient HOPR balance or allowance.", | |
| "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - } | |
| - }, | |
| - "/messages/websocket": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "This is a websocket endpoint which exposes a subset of message functions.\nIncoming messages from other nodes are sent to the websocket client.\nA client may also send message by sending the following data:\n { cmd: \"sendmsg\", args: { peerId: \"SOME_PEER_ID\", path: [], hops: 1} }\nThe command arguments follow the same semantics as in the dedicated API endpoint for sending messages.\n\nThe following messages may be sent by the server over the Websocket connection:\n\n {\n type: \"message\",\n tag: 12,\n body: \"my example message\"\n }\n\n {\n type: \"message-ack\",\n id: \"some challenge id\"\n }\n\n {\n type: \"message-ack-challenge\",\n id: \"some challenge id\"\n }\n 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", | |
| + "409": { | |
| + "description": "Failed to open the channel because the channel between this nodes already exists.", | |
| "content": { | |
| - "application/text": { | |
| + "application/json": { | |
| "schema": { | |
| - "type": "string" | |
| - }, | |
| - "example": "104,101,108,108,111,32,119,111,114,108,100" | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "422": { | |
| + "description": "Unknown failure", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| }, | |
| - "404": { | |
| - "description": "Not found" | |
| + { | |
| + "bearer_token": [] | |
| } | |
| - } | |
| + ] | |
| } | |
| }, | |
| - "/messages/size": { | |
| - "parameters": [], | |
| + "/api/v3/channels/{channelId}": { | |
| "get": { | |
| - "description": "Get size of filtered message inbox.", | |
| "tags": [ | |
| - "Messages" | |
| + "Channels" | |
| ], | |
| - "operationId": "messagesGetSize", | |
| + "summary": "Returns information about the given channel.", | |
| + "description": "Returns information about the given channel.", | |
| + "operationId": "show_channel", | |
| "parameters": [ | |
| { | |
| - "in": "query", | |
| - "name": "tag", | |
| - "description": "Tag used to filter target messages.", | |
| + "name": "channelId", | |
| + "in": "path", | |
| + "description": "ID of the channel.", | |
| "required": true, | |
| "schema": { | |
| - "$ref": "#/components/schemas/MessageTag" | |
| + "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| - "description": "Returns the message inbox size filtered by the given tag.", | |
| + "description": "Channel fetched successfully", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "size": { | |
| - "type": "integer", | |
| - "minimum": 0, | |
| - "example": 1011 | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/ChannelInfoResponse" | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "400": { | |
| + "description": "Invalid channel id.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "Channel not found.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - }, | |
| - "/messages/pop-all": { | |
| - "parameters": [], | |
| - "post": { | |
| - "description": "Get list of messages currently present in the nodes message inbox. The messages are removed from the inbox.", | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + }, | |
| + "delete": { | |
| "tags": [ | |
| - "Messages" | |
| + "Channels" | |
| ], | |
| - "operationId": "messagesPopAllMessage", | |
| - "requestBody": { | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "tag" | |
| - ], | |
| - "properties": { | |
| - "tag": { | |
| - "$ref": "#/components/schemas/MessageTag" | |
| - } | |
| - } | |
| - } | |
| + "summary": "Closes the given channel.", | |
| + "description": "Closes the given channel.\n\nIf the channel is currently `Open`, it will transition it to `PendingToClose`.\nIf the channels is in `PendingToClose` and the channel closure period has elapsed,\nit will transition it to `Closed`.", | |
| + "operationId": "close_channel", | |
| + "parameters": [ | |
| + { | |
| + "name": "channelId", | |
| + "in": "path", | |
| + "description": "ID of the channel.", | |
| + "required": true, | |
| + "schema": { | |
| + "type": "string" | |
| } | |
| } | |
| - }, | |
| + ], | |
| "responses": { | |
| "200": { | |
| - "description": "Returns list of messages.", | |
| + "description": "Channel closed successfully", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "messages" | |
| - ], | |
| - "properties": { | |
| - "messages": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/ReceivedMessage" | |
| - } | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/CloseChannelResponse" | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "400": { | |
| + "description": "Invalid channel id.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "Channel not found.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/messages/pop": { | |
| - "parameters": [], | |
| + "/api/v3/channels/{channelId}/fund": { | |
| "post": { | |
| - "description": "Get oldest message currently present in the nodes message inbox. The message is removed from the inbox.", | |
| "tags": [ | |
| - "Messages" | |
| + "Channels" | |
| + ], | |
| + "summary": "Funds the given channel with the given amount of HOPR tokens.", | |
| + "description": "Funds the given channel with the given amount of HOPR tokens.", | |
| + "operationId": "fund_channel", | |
| + "parameters": [ | |
| + { | |
| + "name": "channelId", | |
| + "in": "path", | |
| + "description": "ID of the channel.", | |
| + "required": true, | |
| + "schema": { | |
| + "type": "string" | |
| + } | |
| + } | |
| ], | |
| - "operationId": "messagesPopMessage", | |
| "requestBody": { | |
| + "description": "Specifies the amount of HOPR tokens to fund a channel with.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "tag" | |
| - ], | |
| - "properties": { | |
| - "tag": { | |
| - "$ref": "#/components/schemas/MessageTag" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/FundBodyRequest" | |
| } | |
| } | |
| - } | |
| + }, | |
| + "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| - "description": "Returns a message.", | |
| + "description": "Channel funded successfully", | |
| + "content": { | |
| + "text/plain": { | |
| + "schema": { | |
| + "type": "string" | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "400": { | |
| + "description": "Invalid channel id.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/ReceivedMessage" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "404": { | |
| - "$ref": "#/components/responses/NotFound" | |
| + "description": "Channel not found.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/messages/": { | |
| - "parameters": [], | |
| - "delete": { | |
| - "description": "Delete messages from nodes message inbox. Does not return any data.", | |
| + "/api/v3/channels/{channelId}/tickets": { | |
| + "get": { | |
| "tags": [ | |
| - "Messages" | |
| + "Channels" | |
| ], | |
| - "operationId": "messagesDeleteMessages", | |
| + "summary": "Lists all tickets for the given channel ID.", | |
| + "description": "Lists all tickets for the given channel ID.", | |
| + "operationId": "show_channel_tickets", | |
| "parameters": [ | |
| { | |
| - "in": "query", | |
| - "name": "tag", | |
| - "description": "Tag used to filter target messages.", | |
| + "name": "channelId", | |
| + "in": "path", | |
| + "description": "ID of the channel.", | |
| "required": true, | |
| "schema": { | |
| - "$ref": "#/components/schemas/MessageTag" | |
| + "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| - "204": { | |
| - "description": "Messages successfully deleted." | |
| - }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - } | |
| - } | |
| - }, | |
| - "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": [ | |
| - "tag", | |
| - "body", | |
| - "peerId" | |
| - ], | |
| - "properties": { | |
| - "tag": { | |
| - "$ref": "#/components/schemas/MessageTag" | |
| - }, | |
| - "body": { | |
| - "$ref": "#/components/schemas/MessageBody" | |
| - }, | |
| - "peerId": { | |
| - "description": "The recipient HOPR peer id, to which the message is sent.", | |
| - "type": "string", | |
| - "format": "peerid", | |
| - "example": "12Diu2HAm2SF8EdwwUaaSoYTiZSddnG4hLVF" | |
| - }, | |
| - "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": 0, | |
| - "maxItems": 3, | |
| - "example": "12Diu2HAm1uV82HyD1iJ5DmwJr4LftmJUeMf" | |
| - } | |
| - }, | |
| - "hops": { | |
| - "description": "Number of required intermediate nodes. This parameter is ignored if path is set.", | |
| - "type": "integer", | |
| - "minimum": 1, | |
| - "maximum": 3, | |
| - "example": 3 | |
| + "200": { | |
| + "description": "Channel funded successfully", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/ChannelTicket" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| - "responses": { | |
| - "202": { | |
| - "description": "The message was sent successfully. NOTE: This does not imply successful delivery.", | |
| + }, | |
| + "400": { | |
| + "description": "Invalid channel id.", | |
| "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" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "Channel not found.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/channels/": { | |
| - "parameters": [], | |
| + "/api/v3/channels/{channelId}/tickets/aggregate": { | |
| "post": { | |
| - "description": "Opens a payment channel between this node and the counter party provided. This channel can be used to send messages between two nodes using other nodes on the network to relay the messages. Each message will deduce its cost from the funded amount to pay other nodes for relaying your messages. Opening a channel can take a little bit of time, because it requires some block confirmations on the blockchain.", | |
| "tags": [ | |
| "Channels" | |
| ], | |
| - "operationId": "channelsOpenChannel", | |
| - "requestBody": { | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "peerAddress", | |
| - "amount" | |
| - ], | |
| - "properties": { | |
| - "peerAddress": { | |
| - "format": "ethereumaddress", | |
| - "type": "string", | |
| - "description": "Peer address that we want to transact with using this channel." | |
| - }, | |
| - "amount": { | |
| - "format": "amount", | |
| - "type": "string", | |
| - "description": "Amount of HOPR tokens to fund the channel. It will be used to pay for sending messages through channel" | |
| - } | |
| - }, | |
| - "example": { | |
| - "peerAddress": "0xf55df5f3ce0ccce707f76ef3e8459adff376ac99", | |
| - "amount": "1000000" | |
| - } | |
| - } | |
| + "summary": "Starts aggregation of tickets in the given channel.", | |
| + "description": "Starts aggregation of tickets in the given channel.", | |
| + "operationId": "aggregate_tickets_in_channel", | |
| + "parameters": [ | |
| + { | |
| + "name": "channelId", | |
| + "in": "path", | |
| + "description": "ID of the channel.", | |
| + "required": true, | |
| + "schema": { | |
| + "type": "string" | |
| } | |
| } | |
| - }, | |
| + ], | |
| "responses": { | |
| - "201": { | |
| - "description": "Channel succesfully opened.", | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "channelId": { | |
| - "$ref": "#/components/schemas/ChannelId" | |
| - }, | |
| - "transactionReceipt": { | |
| - "$ref": "#/components/schemas/TransactionReceipt" | |
| - } | |
| - } | |
| - } | |
| - } | |
| - } | |
| + "204": { | |
| + "description": "Tickets successfully aggregated" | |
| }, | |
| "400": { | |
| - "description": "Problem with inputs.", | |
| + "description": "Invalid channel id.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_AMOUNT | INVALID_ADDRESS" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "description": "Failed to open the channel because of insufficient HOPR balance or allowance.", | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "status": { | |
| - "type": "string", | |
| - "example": "NOT_ENOUGH_BALANCE", | |
| - "description": "Insufficient balance to open channel. Amount passed in request body exeeds current balance." | |
| - } | |
| - } | |
| - }, | |
| - "example": { | |
| - "status": "NOT_ENOUGH_BALANCE" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "409": { | |
| - "description": "Failed to open the channel because the channel between this nodes already exists.", | |
| + "404": { | |
| + "description": "Tickets were not found for that channel. That means that no messages were sent inside this channel yet.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "status": { | |
| - "type": "string", | |
| - "example": "CHANNEL_ALREADY_OPEN", | |
| - "description": "Channel already open. Cannot open more than one channel between two nodes." | |
| - } | |
| - } | |
| - }, | |
| - "example": { | |
| - "status": "CHANNEL_ALREADY_OPEN" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| - "get": { | |
| - "description": "Lists all active channels between this node and other nodes on the Hopr network. By default response will contain all incomming and outgoing channels that are either open, waiting to be opened, or waiting to be closed. If you also want to receive past channels that were closed, you can pass `includingClosed` in the request url query.", | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + } | |
| + }, | |
| + "/api/v3/channels/{channelId}/tickets/redeem": { | |
| + "post": { | |
| "tags": [ | |
| "Channels" | |
| ], | |
| - "operationId": "channelsGetChannels", | |
| + "summary": "Starts redeeming all tickets in the given channel.", | |
| + "description": "Starts redeeming all tickets in the given channel.\n\n**WARNING:** this should almost **never** be used as it can issue a large\nnumber of on-chain transactions. The tickets should almost always be aggregated first.", | |
| + "operationId": "redeem_tickets_in_channel", | |
| "parameters": [ | |
| { | |
| - "in": "query", | |
| - "name": "includingClosed", | |
| - "description": "When includingClosed is passed the response will include closed channels which are ommited by default.", | |
| - "schema": { | |
| - "type": "string", | |
| - "example": "false" | |
| - } | |
| - }, | |
| - { | |
| - "in": "query", | |
| - "name": "fullTopology", | |
| - "description": "Get the full payment channel graph indexed by the node.", | |
| + "name": "channelId", | |
| + "in": "path", | |
| + "description": "ID of the channel.", | |
| + "required": true, | |
| "schema": { | |
| - "type": "string", | |
| - "example": "false" | |
| + "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| - "200": { | |
| - "description": "Channels fetched successfully.", | |
| + "204": { | |
| + "description": "Tickets redeemed successfully." | |
| + }, | |
| + "400": { | |
| + "description": "Invalid channel id.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "incoming": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/Channel" | |
| - }, | |
| - "description": "Incomming channels are the ones that were opened by a different node and this node acts as relay." | |
| - }, | |
| - "outgoing": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/Channel" | |
| - }, | |
| - "description": "Outgoing channels are the ones that were opened by this node and is using other node as relay." | |
| - }, | |
| - "all": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/ChannelTopology" | |
| - }, | |
| - "description": "All the channels indexed by the node in the current network." | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "422": { | |
| - "description": "Unknown failure.", | |
| + "description": "Invalid authorization token.", | |
| "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| - } | |
| - } | |
| - } | |
| - }, | |
| - "/aliases/": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "Get all aliases you set previously and thier corresponding peer IDs.", | |
| - "tags": [ | |
| - "Aliases" | |
| - ], | |
| - "operationId": "aliasesGetAliases", | |
| - "responses": { | |
| - "200": { | |
| - "description": "Returns List of Aliases and corresponding peerIds.", | |
| + }, | |
| + "404": { | |
| + "description": "Tickets were not found for that channel. That means that no messages were sent inside this channel yet.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "alice": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - }, | |
| - "bob": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + } | |
| + }, | |
| + "/api/v3/messages": { | |
| "post": { | |
| - "description": "Instead of using HOPR address, we can assign HOPR address to a specific name called alias. Give an address a more memorable alias and use it instead of Hopr address. Aliases are kept locally and are not saved or shared on the network.", | |
| "tags": [ | |
| - "Aliases" | |
| + "Messages" | |
| ], | |
| - "operationId": "aliasesSetAlias", | |
| + "summary": "Send a message to another peer using the given path.", | |
| + "description": "Send a message to another peer using the given path.\n\nThe message can be sent either over a specified path or using a specified\nnumber of HOPS, if no path is given.", | |
| + "operationId": "send_message", | |
| "requestBody": { | |
| + "description": "Body of a message to send", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "peerId", | |
| - "alias" | |
| - ], | |
| - "properties": { | |
| - "peerId": { | |
| - "format": "peerid", | |
| - "type": "string", | |
| - "description": "PeerId that we want to set alias to." | |
| - }, | |
| - "alias": { | |
| - "type": "string", | |
| - "description": "Alias that we want to attach to peerId." | |
| - } | |
| - }, | |
| - "example": { | |
| - "peerId": "16Uiu2HAmUsJwbECMroQUC29LQZZWsYpYZx1oaM1H9DBoZHLkYn12", | |
| - "alias": "Alice" | |
| - } | |
| + "$ref": "#/components/schemas/SendMessageBodyRequest" | |
| } | |
| } | |
| - } | |
| + }, | |
| + "required": true | |
| }, | |
| "responses": { | |
| - "201": { | |
| - "description": "Alias set succesfully" | |
| - }, | |
| - "400": { | |
| - "description": "Invalid peerId. The format or length of the peerId is incorrect.", | |
| + "202": { | |
| + "description": "The message was sent successfully, DOES NOT imply successful delivery.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_PEERID" | |
| + "$ref": "#/components/schemas/SendMessageResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + }, | |
| + "delete": { | |
| + "tags": [ | |
| + "Messages" | |
| + ], | |
| + "summary": "Delete messages from nodes message inbox.", | |
| + "description": "Delete messages from nodes message inbox.", | |
| + "operationId": "delete_messages", | |
| + "parameters": [ | |
| + { | |
| + "name": "tag", | |
| + "in": "query", | |
| + "required": false, | |
| + "schema": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "nullable": true, | |
| + "minimum": 0 | |
| + } | |
| + } | |
| + ], | |
| + "responses": { | |
| + "204": { | |
| + "description": "Messages successfully deleted." | |
| + }, | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/account/withdraw": { | |
| - "parameters": [], | |
| + "/api/v3/messages/peek": { | |
| "post": { | |
| - "description": "Withdraw funds from this node to your ethereum wallet address. You can choose whitch currency you want to withdraw, NATIVE or HOPR.", | |
| "tags": [ | |
| - "Account" | |
| + "Messages" | |
| ], | |
| - "operationId": "accountWithdraw", | |
| + "summary": "Peek the oldest message currently present in the nodes message inbox.", | |
| + "description": "Peek the oldest message currently present in the nodes message inbox.\n\nThe message is not removed from the inbox.", | |
| + "operationId": "peek", | |
| "requestBody": { | |
| + "description": "Tag of message queue to peek from", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "currency", | |
| - "amount", | |
| - "ethereumAddress" | |
| - ], | |
| - "properties": { | |
| - "currency": { | |
| - "$ref": "#/components/schemas/Currency" | |
| - }, | |
| - "amount": { | |
| - "type": "string", | |
| - "format": "amount", | |
| - "description": "Amount to withdraw in the currency's smallest unit.", | |
| - "example": "1337" | |
| - }, | |
| - "ethereumAddress": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/TagQueryRequest" | |
| } | |
| } | |
| - } | |
| + }, | |
| + "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| - "description": "Withdraw successful. Receipt from this response can be used to check details of the transaction on ethereum chain.", | |
| + "description": "Message successfully peeked at.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "receipt": { | |
| - "type": "string", | |
| - "example": "0x37954ca4a630aa28f045df2e8e604cae22071046042e557355acf00f4ef20d2e", | |
| - "description": "Withdraw txn hash that can be used to check details of the transaction on ethereum chain." | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/MessagePopResponse" | |
| } | |
| } | |
| } | |
| }, | |
| - "400": { | |
| - "description": "Incorrect data in request body. Make sure to provide valid currency ('NATIVE' | 'HOPR') or amount.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_CURRENCY | INVALID_AMOUNT" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "The specified resource was not found." | |
| }, | |
| "422": { | |
| - "description": "Withdraw amount exeeds current balance or unknown error. You can check current balance using /account/balance endpoint.", | |
| + "description": "Unknown failure", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "status": { | |
| - "type": "string", | |
| - "example": "NOT_ENOUGH_BALANCE | UNKNOWN_FAILURE" | |
| - }, | |
| - "error": { | |
| - "type": "string", | |
| - "example": "NOT_ENOUGH_BALANCE" | |
| - } | |
| - } | |
| - }, | |
| - "example": { | |
| - "status": "NOT_ENOUGH_BALANCE" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/account/balances": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "Get node's and associated Safe's HOPR and native balances as well as the allowance for HOPR tokens to be drawn by HoprChannels from Safe. HOPR tokens from the Safe balance is used to fund payment channels between this node and other nodes on the network. NATIVE balance of the Node is used to pay for the gas fees for the blockchain.", | |
| + "/api/v3/messages/peek-all": { | |
| + "post": { | |
| "tags": [ | |
| - "Account" | |
| + "Messages" | |
| ], | |
| - "operationId": "accountGetBalances", | |
| + "summary": "Peek the list of messages currently present in the nodes message inbox, filtered by tag,", | |
| + "description": "Peek the list of messages currently present in the nodes message inbox, filtered by tag,\nand optionally by timestamp (epoch in milliseconds).\nThe messages are not removed from the inbox.", | |
| + "operationId": "peek_all", | |
| + "requestBody": { | |
| + "description": "Tag of message queue and optionally a timestamp since from to start peeking", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/GetMessageBodyRequest" | |
| + } | |
| + } | |
| + }, | |
| + "required": true | |
| + }, | |
| "responses": { | |
| "200": { | |
| - "description": "Balances fetched successfuly.", | |
| + "description": "All messages successfully peeked at.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "native": { | |
| - "$ref": "#/components/schemas/NativeBalance" | |
| - }, | |
| - "hopr": { | |
| - "$ref": "#/components/schemas/HoprBalance" | |
| - }, | |
| - "safeNative": { | |
| - "$ref": "#/components/schemas/NativeBalance" | |
| - }, | |
| - "safeHopr": { | |
| - "$ref": "#/components/schemas/HoprBalance" | |
| - }, | |
| - "safeHoprAllowance": { | |
| - "$ref": "#/components/schemas/HoprBalance" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/MessagePopAllResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "The specified resource was not found." | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/account/addresses": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "Get node's HOPR and native addresses. HOPR address is also called PeerId and can be used by other node owner to interact with this node.", | |
| + "/api/v3/messages/pop": { | |
| + "post": { | |
| "tags": [ | |
| - "Account" | |
| + "Messages" | |
| ], | |
| - "operationId": "accountGetAddresses", | |
| + "summary": "Get the oldest message currently present in the nodes message inbox.", | |
| + "description": "Get the oldest message currently present in the nodes message inbox.\n\nThe message is removed from the inbox.", | |
| + "operationId": "pop", | |
| + "requestBody": { | |
| + "description": "Tag of message queue to pop from", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/TagQueryRequest" | |
| + } | |
| + } | |
| + }, | |
| + "required": true | |
| + }, | |
| "responses": { | |
| "200": { | |
| - "description": "Addresses fetched successfully.", | |
| + "description": "Message successfully extracted.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "native": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| - }, | |
| - "hopr": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/MessagePopResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "The specified resource was not found." | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/account/address": { | |
| - "parameters": [], | |
| - "get": { | |
| - "description": "Get node's HOPR and native addresses. HOPR address is also called PeerId and can be used by other node owner to interact with this node.", | |
| + "/api/v3/messages/pop-all": { | |
| + "post": { | |
| "tags": [ | |
| - "Account" | |
| + "Messages" | |
| ], | |
| - "operationId": "accountGetAddress", | |
| + "summary": "Get the list of messages currently present in the nodes message inbox.", | |
| + "description": "Get the list of messages currently present in the nodes message inbox.\n\nThe messages are removed from the inbox.", | |
| + "operationId": "pop_all", | |
| + "requestBody": { | |
| + "description": "Tag of message queue to pop from", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/TagQueryRequest" | |
| + } | |
| + } | |
| + }, | |
| + "required": true | |
| + }, | |
| "responses": { | |
| "200": { | |
| - "description": "Addresses fetched successfully.", | |
| + "description": "All message successfully extracted.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "native": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| - }, | |
| - "hopr": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/MessagePopAllResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "404": { | |
| + "description": "The specified resource was not found." | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| - "deprecated": true | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/tokens/{id}": { | |
| - "parameters": [], | |
| - "delete": { | |
| - "description": "Deletes a token. Can only be done before the lifetime expired. After the lifetime expired the token is automatically deleted.", | |
| + "/api/v3/messages/size": { | |
| + "get": { | |
| "tags": [ | |
| - "Tokens" | |
| + "Messages" | |
| ], | |
| - "operationId": "tokensDelete", | |
| + "summary": "Get size of filtered message inbox for a specific tag", | |
| + "description": "Get size of filtered message inbox for a specific tag", | |
| + "operationId": "size", | |
| "parameters": [ | |
| { | |
| - "name": "id", | |
| - "in": "path", | |
| - "description": "ID of the token which shall be deleted.", | |
| - "required": true, | |
| + "name": "tag", | |
| + "in": "query", | |
| + "required": false, | |
| "schema": { | |
| - "type": "string", | |
| - "example": "someTOKENid1234" | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "nullable": true, | |
| + "minimum": 0 | |
| } | |
| } | |
| ], | |
| "responses": { | |
| - "204": { | |
| - "description": "Token successfully deleted." | |
| + "200": { | |
| + "description": "Returns the message inbox size filtered by the given tag", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/SizeResponse" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| }, | |
| - "404": { | |
| - "$ref": "#/components/responses/NotFound" | |
| + { | |
| + "bearer_token": [] | |
| } | |
| - } | |
| + ] | |
| } | |
| }, | |
| - "/settings/{setting}": { | |
| - "parameters": [], | |
| - "put": { | |
| - "description": "Change this node's setting value. Check Settings schema to learn more about each setting and the type of value it expects.", | |
| + "/api/v3/network/price": { | |
| + "get": { | |
| "tags": [ | |
| - "Settings" | |
| + "Network" | |
| ], | |
| - "operationId": "settingsSetSetting", | |
| - "parameters": [ | |
| - { | |
| - "in": "path", | |
| - "name": "setting", | |
| - "required": true, | |
| - "schema": { | |
| - "format": "settingKey", | |
| - "type": "string", | |
| - "description": "Name of the setting we want to change.", | |
| - "example": "includeRecipient" | |
| - } | |
| - } | |
| - ], | |
| - "requestBody": { | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "settingValue" | |
| - ], | |
| - "properties": { | |
| - "settingValue": {} | |
| - }, | |
| - "example": { | |
| - "settingValue": true | |
| + "summary": "Obtains the current ticket price.", | |
| + "description": "Obtains the current ticket price.", | |
| + "operationId": "price", | |
| + "responses": { | |
| + "200": { | |
| + "description": "Current ticket price", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/TicketPriceResponse" | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| - "responses": { | |
| - "204": { | |
| - "description": "Setting set succesfully" | |
| }, | |
| - "400": { | |
| - "description": "Invalid input. Either setting with that name doesn't exist or the value is incorrect.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_SETTING | INVALID_SETTING_VALUE" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/peers/{peerid}/ping": { | |
| - "parameters": [], | |
| - "post": { | |
| - "description": "Pings another node to check its availability.", | |
| + "/api/v3/node/entryNodes": { | |
| + "get": { | |
| "tags": [ | |
| - "Peers" | |
| - ], | |
| - "operationId": "peersPingPeer", | |
| - "parameters": [ | |
| - { | |
| - "name": "peerid", | |
| - "in": "path", | |
| - "description": "Peer id that should be pinged", | |
| - "required": true, | |
| - "schema": { | |
| - "format": "peerid", | |
| - "type": "string" | |
| - } | |
| - } | |
| + "Node" | |
| ], | |
| + "summary": "List all known entry nodes with multiaddrs and eligibility.", | |
| + "description": "List all known entry nodes with multiaddrs and eligibility.", | |
| + "operationId": "entry_nodes", | |
| "responses": { | |
| "200": { | |
| - "description": "Ping successful.", | |
| + "description": "Fetched public nodes' information", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| - "properties": { | |
| - "latency": { | |
| - "type": "number", | |
| - "example": 10, | |
| - "description": "Number of milliseconds it took to get the response from the pinged node." | |
| - }, | |
| - "reportedVersion": { | |
| - "type": "string", | |
| - "example": "1.92.12", | |
| - "description": "HOPR protocol version as determined from the successful ping in the Major.Minor.Patch format or \"unknown\"" | |
| - } | |
| + "additionalProperties": { | |
| + "$ref": "#/components/schemas/EntryNode" | |
| + } | |
| + }, | |
| + "example": { | |
| + "0x188c4462b75e46f0c7262d7f48d182447b93a93c": { | |
| + "isElligible": true, | |
| + "multiaddrs": [ | |
| + "/ip4/10.0.2.100/tcp/19091" | |
| + ] | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| - "400": { | |
| - "description": "Invalid peerId.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_PEERID" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "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.", | |
| + "description": "Unknown failure", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "TIMEOUT" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/peers/{peerid}/": { | |
| - "parameters": [], | |
| + "/api/v3/node/info": { | |
| "get": { | |
| - "description": "Get information about this peer.", | |
| "tags": [ | |
| - "PeerInfo" | |
| - ], | |
| - "operationId": "peerInfoGetPeerInfo", | |
| - "parameters": [ | |
| - { | |
| - "in": "path", | |
| - "name": "peerid", | |
| - "required": true, | |
| - "schema": { | |
| - "format": "peerid", | |
| - "type": "string" | |
| - } | |
| - } | |
| + "Node" | |
| ], | |
| + "summary": "Get information about this HOPR Node.", | |
| + "description": "Get information about this HOPR Node.", | |
| + "operationId": "info", | |
| "responses": { | |
| "200": { | |
| - "description": "Peer information fetched successfully.", | |
| + "description": "Fetched node version", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "announced": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/MultiAddress" | |
| - } | |
| - }, | |
| - "observed": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/MultiAddress" | |
| - } | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/NodeInfoResponse" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/channels/{channelid}/tickets/redeem": { | |
| - "parameters": [], | |
| - "post": { | |
| - "description": "Redeems your tickets for this channel. Redeeming will change your tickets into Hopr tokens if they are winning ones. You can check how much tickets given channel has by calling /channels/{channelid}/tickets endpoint. Do this before channel is closed as neglected tickets are no longer valid for redeeming.", | |
| + "/api/v3/node/metrics": { | |
| + "get": { | |
| "tags": [ | |
| - "Channels" | |
| - ], | |
| - "operationId": "channelsRedeemTickets", | |
| - "parameters": [ | |
| - { | |
| - "in": "path", | |
| - "name": "channelid", | |
| - "required": true, | |
| - "schema": { | |
| - "format": "channelid", | |
| - "type": "string" | |
| - } | |
| - } | |
| + "Node" | |
| ], | |
| + "summary": "Retrieve Prometheus metrics from the running node.", | |
| + "description": "Retrieve Prometheus metrics from the running node.", | |
| + "operationId": "metrics", | |
| "responses": { | |
| - "204": { | |
| - "description": "Tickets redeemed successfully." | |
| - }, | |
| - "400": { | |
| - "description": "Invalid channel id.", | |
| + "200": { | |
| + "description": "Fetched node metrics", | |
| "content": { | |
| - "application/json": { | |
| + "text/plain": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_CHANNELID" | |
| + "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "404": { | |
| - "description": "Tickets were not found for that channel. That means that no messages were sent inside this channel yet.", | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "TICKETS_NOT_FOUND" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/channels/{channelid}/tickets/aggregate": { | |
| - "parameters": [], | |
| - "post": { | |
| - "description": "Takes all acknowledged and winning tickets (if any) from the given channel and aggregates them into a single ticket. Requires cooperation of the ticket issuer.", | |
| + "/api/v3/node/peers": { | |
| + "get": { | |
| "tags": [ | |
| - "Channels" | |
| + "Node" | |
| ], | |
| - "operationId": "channelsAggregateTickets", | |
| + "summary": "Lists information for `connected peers` and `announced peers`.", | |
| + "description": "Lists information for `connected peers` and `announced peers`.\n\nConnected peers are nodes which are connected to the node while announced peers are\nnodes which have announced to the network.\n\nOptionally pass `quality` parameter to get only peers with higher or equal quality\nto the specified value.", | |
| + "operationId": "peers", | |
| "parameters": [ | |
| { | |
| - "in": "path", | |
| - "name": "channelid", | |
| - "required": true, | |
| + "name": "quality", | |
| + "in": "query", | |
| + "required": false, | |
| "schema": { | |
| - "format": "channelid", | |
| - "type": "string" | |
| + "type": "number", | |
| + "format": "double", | |
| + "nullable": true | |
| } | |
| } | |
| ], | |
| "responses": { | |
| - "204": { | |
| - "description": "Tickets successfully aggregated" | |
| + "200": { | |
| + "description": "Successfully returned observed peers", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/NodePeersResponse" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "400": { | |
| - "description": "Invalid channel id.", | |
| + "description": "Failed to extract a valid quality parameter", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_CHANNELID" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| }, | |
| - "404": { | |
| - "$ref": "#/components/responses/NotFound" | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| + } | |
| + }, | |
| + "/api/v3/node/version": { | |
| + "get": { | |
| + "tags": [ | |
| + "Node" | |
| + ], | |
| + "summary": "Get release version of the running node.", | |
| + "description": "Get release version of the running node.", | |
| + "operationId": "version", | |
| + "responses": { | |
| + "200": { | |
| + "description": "Fetched node version", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/NodeVersionResponse" | |
| + } | |
| + } | |
| + } | |
| }, | |
| - "422": { | |
| - "description": "Unknown failure.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/channels/{channelid}/tickets": { | |
| - "parameters": [], | |
| + "/api/v3/peers/{peerId}": { | |
| "get": { | |
| - "description": "Get tickets earned by relaying data packets by your node for the particular channel.", | |
| "tags": [ | |
| - "Channels" | |
| + "Peers" | |
| ], | |
| - "operationId": "channelsGetTickets", | |
| + "summary": "Returns transport-related information about the given peer.", | |
| + "description": "Returns transport-related information about the given peer.\n\nThis includes the peer ids that the given peer has `announced` on-chain\nand peer ids that are actually `observed` by the transport layer.", | |
| + "operationId": "show_peer_info", | |
| "parameters": [ | |
| { | |
| + "name": "peerId", | |
| "in": "path", | |
| - "name": "channelid", | |
| + "description": "PeerID of the requested peer", | |
| "required": true, | |
| "schema": { | |
| - "format": "channelid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| - "description": "Tickets fetched successfully.", | |
| + "description": "Peer information fetched successfully.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "array", | |
| - "items": { | |
| - "$ref": "#/components/schemas/Ticket" | |
| - } | |
| + "$ref": "#/components/schemas/NodePeerInfoResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| - "description": "Invalid peerId.", | |
| + "description": "Invalid peer id", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_PEERID" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "404": { | |
| - "description": "Tickets were not found for that channel. That means that no messages were sent inside this channel yet.", | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "TICKETS_NOT_FOUND" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/channels/{channelid}/fund": { | |
| - "parameters": [], | |
| + "/api/v3/peers/{peerId}/ping": { | |
| "post": { | |
| - "description": "Funds an existing channel with the given amount. The channel must be in state OPEN", | |
| "tags": [ | |
| - "Channels" | |
| + "Peers" | |
| ], | |
| - "operationId": "channelsFundChannel", | |
| + "summary": "Directly pings the given peer.", | |
| + "description": "Directly pings the given peer.", | |
| + "operationId": "ping_peer", | |
| "parameters": [ | |
| { | |
| + "name": "peerId", | |
| "in": "path", | |
| - "name": "channelid", | |
| + "description": "PeerID of the requested peer", | |
| "required": true, | |
| "schema": { | |
| - "format": "channelid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| - "requestBody": { | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "amount" | |
| - ], | |
| - "properties": { | |
| - "amount": { | |
| - "format": "amount", | |
| - "type": "string", | |
| - "description": "Amount of weiHOPR tokens to fund the channel. It will be used to pay for sending messages through channel" | |
| - } | |
| - }, | |
| - "example": { | |
| - "amount": "1000000" | |
| - } | |
| - } | |
| - } | |
| - } | |
| - }, | |
| "responses": { | |
| "200": { | |
| - "description": "Channel funded successfully.", | |
| + "description": "Ping successful", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "required": [ | |
| - "receipt" | |
| - ], | |
| - "properties": { | |
| - "receipt": { | |
| - "type": "string", | |
| - "description": "Receipt of the funding transaction", | |
| - "example": "0x37954ca4a630aa28f045df2e8e604cae22071046042e557355acf00f4ef20d2e" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/PingResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| - "description": "Invalid channel id.", | |
| + "description": "Invalid peer id", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_CHANNELID" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "404": { | |
| - "$ref": "#/components/responses/NotFound" | |
| + "description": "Invalid authorization token.", | |
| + "content": { | |
| + "application/json": { | |
| + "schema": { | |
| + "$ref": "#/components/schemas/ApiError" | |
| + } | |
| + } | |
| + } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/channels/{channelid}/": { | |
| - "parameters": [], | |
| - "delete": { | |
| - "description": "Close a opened channel between this node and other node. Once you've initiated channel closure, you have to wait for a specified closure time, it will show you a closure initiation message with cool-off time you need to wait.\n Then you will need to send the same command again to finalize closure. This is a cool down period to give the other party in the channel sufficient time to redeem their tickets.", | |
| + "/api/v3/tickets": { | |
| + "get": { | |
| "tags": [ | |
| - "Channels" | |
| - ], | |
| - "operationId": "channelsCloseChannel", | |
| - "parameters": [ | |
| - { | |
| - "in": "path", | |
| - "name": "channelid", | |
| - "required": true, | |
| - "schema": { | |
| - "format": "channelid", | |
| - "type": "string" | |
| - } | |
| - } | |
| + "Tickets" | |
| ], | |
| + "summary": "Returns all the tickets in all the channels.", | |
| + "description": "Returns all the tickets in all the channels.", | |
| + "operationId": "show_all_tickets", | |
| "responses": { | |
| "200": { | |
| - "description": "Channel closed succesfully.", | |
| + "description": "Channel funded successfully", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "receipt": { | |
| - "type": "string", | |
| - "description": "Receipt of the closing transaction", | |
| - "example": "0x37954ca4a630aa28f045df2e8e604cae22071046042e557355acf00f4ef20d2e" | |
| - }, | |
| - "channelStatus": { | |
| - "type": "string", | |
| - "description": "Current status of the channel", | |
| - "example": "Closed" | |
| - } | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/ChannelTicket" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| - "400": { | |
| - "description": "Invalid channel id.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_CHANNELID" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| - "get": { | |
| - "description": "Returns information about the channel.", | |
| - "tags": [ | |
| - "Channels" | |
| - ], | |
| - "operationId": "channelsGetChannel", | |
| - "parameters": [ | |
| + }, | |
| + "security": [ | |
| { | |
| - "in": "path", | |
| - "name": "channelid", | |
| - "required": true, | |
| - "schema": { | |
| - "$ref": "#/components/schemas/ChannelId" | |
| - } | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| } | |
| + ] | |
| + } | |
| + }, | |
| + "/api/v3/tickets/redeem": { | |
| + "post": { | |
| + "tags": [ | |
| + "Tickets" | |
| ], | |
| + "summary": "Starts redeeming of all tickets in all channels.", | |
| + "description": "Starts redeeming of all tickets in all channels.\n\n**WARNING:** this should almost **never** be used as it can issue a large\nnumber of on-chain transactions. The tickets should almost always be aggregated first.", | |
| + "operationId": "redeem_all_tickets", | |
| "responses": { | |
| - "200": { | |
| - "description": "Channel fetched succesfully.", | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "$ref": "#/components/schemas/ChannelTopology" | |
| - } | |
| - } | |
| - } | |
| + "204": { | |
| + "description": "Tickets redeemed successfully." | |
| }, | |
| - "400": { | |
| - "description": "Invalid channel id.", | |
| + "401": { | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "INVALID_CHANNELID" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "404": { | |
| - "$ref": "#/components/responses/NotFound" | |
| - }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| + }, | |
| + "security": [ | |
| + { | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| + } | |
| + ] | |
| } | |
| }, | |
| - "/aliases/{alias}": { | |
| - "parameters": [], | |
| + "/api/v3/tickets/statistics": { | |
| "get": { | |
| - "description": "Get the PeerId (Hopr address) that have this alias assigned to it.", | |
| "tags": [ | |
| - "Aliases" | |
| - ], | |
| - "operationId": "aliasesGetAlias", | |
| - "parameters": [ | |
| - { | |
| - "name": "alias", | |
| - "in": "path", | |
| - "description": "Alias that we previously assigned to some PeerId.", | |
| - "required": true, | |
| - "schema": { | |
| - "type": "string", | |
| - "example": "Alice" | |
| - } | |
| - } | |
| + "Tickets" | |
| ], | |
| + "summary": "Returns current complete statistics on tickets.", | |
| + "description": "Returns current complete statistics on tickets.", | |
| + "operationId": "show_ticket_statistics", | |
| "responses": { | |
| "200": { | |
| - "description": "HOPR address was found for the provided alias.", | |
| + "description": "Tickets statistics fetched successfully. Check schema for description of every field in the statistics.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "type": "object", | |
| - "properties": { | |
| - "peerId": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| - } | |
| - } | |
| + "$ref": "#/components/schemas/NodeTicketStatisticsResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| - }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| - }, | |
| - "404": { | |
| - "description": "This alias was not assigned to any PeerId before. You can get the list of all PeerId's and thier corresponding aliases using /aliases endpoint.", | |
| + "description": "Invalid authorization token.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| - "$ref": "#/components/schemas/RequestStatus" | |
| - }, | |
| - "example": { | |
| - "status": "PEERID_NOT_FOUND" | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| - "description": "Unknown failure.", | |
| + "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." | |
| + "$ref": "#/components/schemas/ApiError" | |
| } | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| - "delete": { | |
| - "description": "Unassign an alias from a PeerId. You can always assign back alias to that PeerId using /aliases endpoint.", | |
| - "tags": [ | |
| - "Aliases" | |
| - ], | |
| - "operationId": "aliasesRemoveAlias", | |
| - "parameters": [ | |
| + }, | |
| + "security": [ | |
| { | |
| - "name": "alias", | |
| - "in": "path", | |
| - "description": "Alias that we want to remove.", | |
| - "required": true, | |
| - "schema": { | |
| - "type": "string", | |
| - "example": "Alice" | |
| - } | |
| + "api_token": [] | |
| + }, | |
| + { | |
| + "bearer_token": [] | |
| } | |
| + ] | |
| + } | |
| + }, | |
| + "/healthyz": { | |
| + "get": { | |
| + "tags": [ | |
| + "Checks" | |
| ], | |
| + "summary": "Check whether the node is healthy", | |
| + "description": "Check whether the node is healthy", | |
| + "operationId": "healthyz", | |
| "responses": { | |
| - "204": { | |
| - "description": "Alias removed succesfully." | |
| - }, | |
| - "401": { | |
| - "$ref": "#/components/responses/Unauthorized" | |
| + "200": { | |
| + "description": "The node is healthy" | |
| }, | |
| - "403": { | |
| - "$ref": "#/components/responses/Forbidden" | |
| + "412": { | |
| + "description": "The node is not healthy" | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "/readyz": { | |
| + "get": { | |
| + "tags": [ | |
| + "Checks" | |
| + ], | |
| + "summary": "Check whether the node is ready to accept connections.", | |
| + "description": "Check whether the node is ready to accept connections.", | |
| + "operationId": "readyz", | |
| + "responses": { | |
| + "200": { | |
| + "description": "The node is ready to accept connections" | |
| }, | |
| - "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." | |
| - } | |
| - } | |
| - } | |
| + "412": { | |
| + "description": "The node is not ready to accept connections" | |
| } | |
| } | |
| } | |
| - } | |
| - }, | |
| - "security": [ | |
| - { | |
| - "keyScheme": [ | |
| - "write" | |
| - ] | |
| }, | |
| - { | |
| - "passwordScheme": [ | |
| - "write" | |
| - ] | |
| + "/startedz": { | |
| + "get": { | |
| + "tags": [ | |
| + "Checks" | |
| + ], | |
| + "summary": "Check whether the node is started.", | |
| + "description": "Check whether the node is started.", | |
| + "operationId": "startedz", | |
| + "responses": { | |
| + "200": { | |
| + "description": "The node is stared and running" | |
| + }, | |
| + "412": { | |
| + "description": "The node is not started and running" | |
| + } | |
| + } | |
| + } | |
| } | |
| - ], | |
| - "externalDocs": { | |
| - "description": "Find out more about HOPR and HOPRd.", | |
| - "url": "http://docs.hoprnet.org" | |
| }, | |
| "components": { | |
| - "responses": { | |
| - "NotFound": { | |
| - "description": "The specified resource was not found" | |
| - }, | |
| - "Unauthorized": { | |
| - "description": "authentication failed", | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "$ref": "#/components/schemas/Error" | |
| - } | |
| + "schemas": { | |
| + "AccountAddressesResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "native", | |
| + "hopr" | |
| + ], | |
| + "properties": { | |
| + "hopr": { | |
| + "type": "string" | |
| + }, | |
| + "native": { | |
| + "type": "string" | |
| } | |
| + }, | |
| + "example": { | |
| + "hopr": "12D3KooWJmLm8FnBfvYQ5BAZ5qcYBxQFFBzAAEYUBUNJNE8cRsYS", | |
| + "native": "0x07eaf07d6624f741e04f4092a755a9027aaab7f6" | |
| } | |
| }, | |
| - "Forbidden": { | |
| - "description": "authorization failed", | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "$ref": "#/components/schemas/Error" | |
| - } | |
| + "AccountBalancesResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "safeNative", | |
| + "native", | |
| + "safeHopr", | |
| + "hopr", | |
| + "safeHoprAllowance" | |
| + ], | |
| + "properties": { | |
| + "hopr": { | |
| + "type": "string" | |
| + }, | |
| + "native": { | |
| + "type": "string" | |
| + }, | |
| + "safeHopr": { | |
| + "type": "string" | |
| + }, | |
| + "safeHoprAllowance": { | |
| + "type": "string" | |
| + }, | |
| + "safeNative": { | |
| + "type": "string" | |
| } | |
| + }, | |
| + "example": { | |
| + "hopr": "2000000000000000000000", | |
| + "native": "9999563581204904000", | |
| + "safeHopr": "2000000000000000000000", | |
| + "safeHoprAllowance": "115792089237316195423570985008687907853269984665640564039457584007913129639935", | |
| + "safeNative": "10000000000000000000" | |
| } | |
| }, | |
| - "UnknownFailure": { | |
| - "description": "Unknown failure", | |
| - "content": { | |
| - "application/json": { | |
| - "schema": { | |
| - "$ref": "#/components/schemas/Error" | |
| - } | |
| - } | |
| - } | |
| - } | |
| - }, | |
| - "schemas": { | |
| - "Error": { | |
| + "AliasPeerIdBodyRequest": { | |
| "type": "object", | |
| + "required": [ | |
| + "alias", | |
| + "peerId" | |
| + ], | |
| "properties": { | |
| - "status": { | |
| + "alias": { | |
| "type": "string" | |
| }, | |
| - "error": { | |
| + "peerId": { | |
| "type": "string" | |
| } | |
| }, | |
| - "required": [ | |
| - "status", | |
| - "error" | |
| - ] | |
| + "example": { | |
| + "alias": "Alice", | |
| + "peerId": "12D3KooWRWeTozREYHzWTbuCYskdYhED1MXpDwTrmccwzFrd2mEA" | |
| + } | |
| }, | |
| - "RequestStatus": { | |
| + "ApiError": { | |
| "type": "object", | |
| + "required": [ | |
| + "status" | |
| + ], | |
| "properties": { | |
| - "status": { | |
| + "error": { | |
| "type": "string", | |
| - "description": "Status declaring success/failure of the request." | |
| + "nullable": true | |
| + }, | |
| + "status": { | |
| + "type": "string" | |
| } | |
| }, | |
| "example": { | |
| - "status": "success" | |
| + "error": "Invalid value passed in parameter 'XYZ'", | |
| + "status": "INVALID_INPUT" | |
| } | |
| }, | |
| - "Token": { | |
| + "ChannelInfoResponse": { | |
| "type": "object", | |
| "required": [ | |
| - "id", | |
| - "capabilities" | |
| + "channelId", | |
| + "sourceAddress", | |
| + "destinationAddress", | |
| + "sourcePeerId", | |
| + "destinationPeerId", | |
| + "balance", | |
| + "status", | |
| + "ticketIndex", | |
| + "channelEpoch", | |
| + "closureTime" | |
| ], | |
| "properties": { | |
| - "id": { | |
| - "type": "string", | |
| - "description": "Unique ID of the token" | |
| + "balance": { | |
| + "type": "string" | |
| }, | |
| - "description": { | |
| - "type": "string", | |
| - "description": "Some description for the token" | |
| + "channelEpoch": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "minimum": 0 | |
| + }, | |
| + "channelId": { | |
| + "type": "string" | |
| }, | |
| - "valid_until": { | |
| + "closureTime": { | |
| "type": "integer", | |
| - "description": "Seconds since epoch until the token is valid" | |
| + "format": "int64", | |
| + "minimum": 0 | |
| }, | |
| - "capabilities": { | |
| - "type": "array", | |
| - "description": "Array of capabilities associated with the token", | |
| - "minItems": 1, | |
| - "items": { | |
| - "$ref": "#/components/schemas/TokenCapability" | |
| - } | |
| + "destinationAddress": { | |
| + "type": "string" | |
| + }, | |
| + "destinationPeerId": { | |
| + "type": "string" | |
| + }, | |
| + "sourceAddress": { | |
| + "type": "string" | |
| + }, | |
| + "sourcePeerId": { | |
| + "type": "string" | |
| + }, | |
| + "status": { | |
| + "type": "string" | |
| + }, | |
| + "ticketIndex": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "minimum": 0 | |
| } | |
| }, | |
| "example": { | |
| - "id": "someTOKENid1223", | |
| - "description": "this is an interesting token", | |
| - "capabilities": [ | |
| - { | |
| - "endpoint": "tokensGetToken", | |
| - "limits": [ | |
| - { | |
| - "type": "calls", | |
| - "conditions": { | |
| - "max": 100 | |
| - } | |
| - } | |
| - ] | |
| - } | |
| - ] | |
| + "balance": "10000000000000000000", | |
| + "channelEpoch": 1, | |
| + "channelId": "0x04efc1481d3f106b88527b3844ba40042b823218a9cd29d1aa11c2c2ef8f538f", | |
| + "closureTime": 0, | |
| + "destinationAddress": "0x188c4462b75e46f0c7262d7f48d182447b93a93c", | |
| + "destinationPeerId": "12D3KooWPWD5P5ZzMRDckgfVaicY5JNoo7JywGotoAv17d7iKx1z", | |
| + "sourceAddress": "0x07eaf07d6624f741e04f4092a755a9027aaab7f6", | |
| + "sourcePeerId": "12D3KooWJmLm8FnBfvYQ5BAZ5qcYBxQFFBzAAEYUBUNJNE8cRsYS", | |
| + "status": "Open", | |
| + "ticketIndex": 0 | |
| } | |
| }, | |
| - "TokenCapabilityLimit": { | |
| + "ChannelTicket": { | |
| "type": "object", | |
| "required": [ | |
| - "type" | |
| + "channelId", | |
| + "amount", | |
| + "index", | |
| + "indexOffset", | |
| + "winProb", | |
| + "channelEpoch", | |
| + "signature" | |
| ], | |
| "properties": { | |
| - "type": { | |
| - "type": "string", | |
| - "description": "Limit type" | |
| + "amount": { | |
| + "type": "string" | |
| }, | |
| - "conditions": { | |
| - "type": "object", | |
| - "description": "Limit conditions, if any", | |
| - "properties": { | |
| - "max": { | |
| - "type": "integer", | |
| - "description": "Upper ceiling. Applies to limit type calls." | |
| - } | |
| - } | |
| + "channelEpoch": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "minimum": 0 | |
| + }, | |
| + "channelId": { | |
| + "type": "string" | |
| + }, | |
| + "index": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + }, | |
| + "indexOffset": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "minimum": 0 | |
| + }, | |
| + "signature": { | |
| + "type": "string" | |
| + }, | |
| + "winProb": { | |
| + "type": "string" | |
| } | |
| }, | |
| "example": { | |
| - "type": "calls", | |
| - "conditions": { | |
| - "max": 100 | |
| + "amount": "100", | |
| + "channelEpoch": 1, | |
| + "channelId": "0x04efc1481d3f106b88527b3844ba40042b823218a9cd29d1aa11c2c2ef8f538f", | |
| + "index": 0, | |
| + "indexOffset": 1, | |
| + "signature": "0xe445fcf4e90d25fe3c9199ccfaff85e23ecce8773304d85e7120f1f38787f2329822470487a37f1b5408c8c0b73e874ee9f7594a632713b6096e616857999891", | |
| + "winProb": "1" | |
| + } | |
| + }, | |
| + "ChannelsQueryRequest": { | |
| + "type": "object", | |
| + "description": "Parameters for enumerating channels.", | |
| + "properties": { | |
| + "fullTopology": { | |
| + "type": "boolean", | |
| + "description": "Should all channels (not only the ones concerning this node) be enumerated?", | |
| + "default": false | |
| + }, | |
| + "includingClosed": { | |
| + "type": "boolean", | |
| + "description": "Should be the closed channels included?", | |
| + "default": false | |
| } | |
| } | |
| }, | |
| - "TokenCapability": { | |
| + "CloseChannelResponse": { | |
| "type": "object", | |
| "required": [ | |
| - "endpoint" | |
| + "receipt", | |
| + "channelStatus" | |
| ], | |
| "properties": { | |
| - "endpoint": { | |
| + "channelStatus": { | |
| "type": "string", | |
| - "description": "Short reference of the operation this capability is tied to.", | |
| - "enum": [ | |
| - "tokensCreate", | |
| - "tokensGetToken", | |
| - "ticketsGetStatistics", | |
| - "ticketsRedeemTickets", | |
| - "ticketsGetTickets", | |
| - "settingsGetSettings", | |
| - "nodeGetVersion", | |
| - "nodeGetPeers", | |
| - "nodeGetMetrics", | |
| - "nodeGetInfo", | |
| - "nodeGetEntryNodes", | |
| - "messagesWebsocket", | |
| - "messagesGetSize", | |
| - "messagesPopAllMessage", | |
| - "messagesPopMessage", | |
| - "messagesSendMessage", | |
| - "messagesDeleteMessages", | |
| - "channelsOpenChannel", | |
| - "channelsGetChannels", | |
| - "aliasesSetAlias", | |
| - "aliasesGetAliases", | |
| - "accountWithdraw", | |
| - "accountGetBalances", | |
| - "accountGetAddresses", | |
| - "accountGetAddress", | |
| - "tokensDelete", | |
| - "settingsSetSetting", | |
| - "peersPingPeer", | |
| - "peerInfoGetPeerInfo", | |
| - "channelsRedeemTickets", | |
| - "channelsGetTickets", | |
| - "channelsGetChannel", | |
| - "channelsCloseChannel", | |
| - "aliasesGetAlias", | |
| - "aliasesRemoveAlias", | |
| - "nodeStreamWebsocket", | |
| - "nodePing", | |
| - "messagesSign", | |
| - "messageSign", | |
| - "channelsFundChannels" | |
| - ] | |
| + "description": "New status of the channel. Will be one of `Closed` or `PendingToClose`." | |
| }, | |
| - "limits": { | |
| + "receipt": { | |
| + "type": "string", | |
| + "description": "Receipt for the channel close transaction." | |
| + } | |
| + }, | |
| + "example": { | |
| + "channelStatus": "PendingToClose", | |
| + "receipt": "0xd77da7c1821249e663dead1464d185c03223d9663a06bc1d46ed0ad449a07118" | |
| + } | |
| + }, | |
| + "EntryNode": { | |
| + "type": "object", | |
| + "required": [ | |
| + "multiaddrs", | |
| + "isEligible" | |
| + ], | |
| + "properties": { | |
| + "isEligible": { | |
| + "type": "boolean" | |
| + }, | |
| + "multiaddrs": { | |
| "type": "array", | |
| - "minItems": 1, | |
| "items": { | |
| - "$ref": "#/components/schemas/TokenCapabilityLimit" | |
| + "type": "string" | |
| } | |
| } | |
| + } | |
| + }, | |
| + "FundBodyRequest": { | |
| + "type": "object", | |
| + "description": "Specifies the amount of HOPR tokens to fund a channel with.", | |
| + "required": [ | |
| + "amount" | |
| + ], | |
| + "properties": { | |
| + "amount": { | |
| + "type": "string", | |
| + "description": "Amount of HOPR tokens to fund the channel with." | |
| + } | |
| }, | |
| "example": { | |
| - "endpoint": "tokensGetToken", | |
| - "limits": [ | |
| - { | |
| - "type": "calls", | |
| - "conditions": { | |
| - "max": 100 | |
| - } | |
| - } | |
| - ] | |
| + "amount": "1000" | |
| + } | |
| + }, | |
| + "GetMessageBodyRequest": { | |
| + "type": "object", | |
| + "properties": { | |
| + "tag": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "description": "The message tag used to filter messages based on application", | |
| + "nullable": true, | |
| + "minimum": 0 | |
| + }, | |
| + "timestamp": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "description": "Timestamp to filter messages received after this timestamp", | |
| + "minimum": 0 | |
| + } | |
| } | |
| }, | |
| - "Signature": { | |
| - "type": "string", | |
| - "description": "Signature from requested message.", | |
| - "example": 7.115342872866815e+167 | |
| - }, | |
| - "MultiAddress": { | |
| - "type": "string", | |
| - "description": "A multi address is a composable and future-proof network address, usually announced by Public HOPR nodes.", | |
| - "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" | |
| - ] | |
| - }, | |
| - "Currency": { | |
| - "type": "string", | |
| - "enum": [ | |
| - "NATIVE", | |
| - "HOPR" | |
| - ], | |
| - "description": "Supported currencies, NATIVE used for the interacting with blockchain or HOPR used to fund channels.", | |
| - "example": "NATIVE" | |
| - }, | |
| - "MessageTag": { | |
| - "type": "integer", | |
| - "minimum": 0, | |
| - "maximum": 65536, | |
| - "description": "The message tag which can be used to filter messages between apps.", | |
| - "example": 12 | |
| - }, | |
| - "MessageBody": { | |
| - "type": "string", | |
| - "example": "This is a HOPR message." | |
| + "HeartbeatInfo": { | |
| + "type": "object", | |
| + "required": [ | |
| + "sent", | |
| + "success" | |
| + ], | |
| + "properties": { | |
| + "sent": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + }, | |
| + "success": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + } | |
| + } | |
| }, | |
| - "ReceivedMessage": { | |
| + "MessagePopAllResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "messages" | |
| + ], | |
| + "properties": { | |
| + "messages": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/MessagePopResponse" | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "MessagePopResponse": { | |
| "type": "object", | |
| "required": [ | |
| - "body", | |
| "tag", | |
| + "body", | |
| "receivedAt" | |
| ], | |
| "properties": { | |
| - "tag": { | |
| - "$ref": "#/components/schemas/MessageTag" | |
| - }, | |
| "body": { | |
| - "$ref": "#/components/schemas/MessageBody" | |
| + "type": "string" | |
| }, | |
| "receivedAt": { | |
| "type": "integer", | |
| - "example": 1324284684614, | |
| - "description": "Timestamp when the message was received in seconds since epoch." | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + }, | |
| + "tag": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "minimum": 0 | |
| } | |
| + }, | |
| + "example": { | |
| + "body": "Test message 1", | |
| + "receivedAt": 1704453953073, | |
| + "tag": 20 | |
| } | |
| }, | |
| - "NativeAddress": { | |
| - "type": "string", | |
| - "format": "ethereumaddress", | |
| - "description": "Blockchain-native account address. Can be funded from external wallets (starts with **0x...**). It **can't be used** internally to send / receive messages, open / close payment channels.", | |
| - "example": 1.339446426793328e+48 | |
| - }, | |
| - "HoprAddress": { | |
| - "format": "peerid", | |
| - "type": "string", | |
| - "description": "HOPR account address, also called a PeerId. Used to send / receive messages, open / close payment channels.", | |
| - "example": "12Diu2HAmVfV4GKQhdECMqYmUMGLy84RjTJQ" | |
| - }, | |
| - "ChannelId": { | |
| - "format": "string", | |
| - "description": "The unique identifier of a unidirectional HOPR channel.", | |
| - "example": 2.7406162736469732e+76 | |
| - }, | |
| - "ChannelStatus": { | |
| - "type": "string", | |
| - "enum": [ | |
| - "Open", | |
| - "PendingToClose", | |
| - "Closed" | |
| + "NodeChannel": { | |
| + "type": "object", | |
| + "required": [ | |
| + "id", | |
| + "peerAddress", | |
| + "status", | |
| + "balance" | |
| ], | |
| - "description": "Status of the channel can be: Open, PendingToClose, or Closed.", | |
| - "example": "Open" | |
| - }, | |
| - "NativeBalance": { | |
| - "type": "string", | |
| - "example": "1000000000000000000", | |
| - "description": "Amount of NATIVE (ETH) balance in the smallest unit. Used only for gas fees on the blockchain the current release is running on. For example, when you will open or close the payment channel, it will use gas fees to execute this action." | |
| + "properties": { | |
| + "balance": { | |
| + "type": "string" | |
| + }, | |
| + "id": { | |
| + "type": "string" | |
| + }, | |
| + "peerAddress": { | |
| + "type": "string" | |
| + }, | |
| + "status": { | |
| + "type": "string" | |
| + } | |
| + } | |
| }, | |
| - "HoprBalance": { | |
| - "type": "string", | |
| - "example": "10000000000000000000", | |
| - "description": "Amount of HOPR tokens in the smallest unit. Used for funding payment channels." | |
| + "NodeChannelsResponse": { | |
| + "type": "object", | |
| + "description": "Listing of channels.", | |
| + "required": [ | |
| + "incoming", | |
| + "outgoing", | |
| + "all" | |
| + ], | |
| + "properties": { | |
| + "all": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/ChannelInfoResponse" | |
| + }, | |
| + "description": "Complete channel topology as seen by this node." | |
| + }, | |
| + "incoming": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/NodeChannel" | |
| + }, | |
| + "description": "Channels incoming to this node." | |
| + }, | |
| + "outgoing": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/NodeChannel" | |
| + }, | |
| + "description": "Channels outgoing from this node." | |
| + } | |
| + }, | |
| + "example": { | |
| + "all": [], | |
| + "incoming": [], | |
| + "outgoing": [ | |
| + { | |
| + "balance": "10000000000000000010", | |
| + "id": "0x04efc1481d3f106b88527b3844ba40042b823218a9cd29d1aa11c2c2ef8f538f", | |
| + "peerAddress": "0x188c4462b75e46f0c7262d7f48d182447b93a93c", | |
| + "status": "Open" | |
| + } | |
| + ] | |
| + } | |
| }, | |
| - "Channel": { | |
| + "NodeInfoResponse": { | |
| "type": "object", | |
| + "required": [ | |
| + "network", | |
| + "announcedAddress", | |
| + "listeningAddress", | |
| + "chain", | |
| + "hoprToken", | |
| + "hoprChannels", | |
| + "hoprNetworkRegistry", | |
| + "hoprNodeSafeRegistry", | |
| + "hoprManagementModule", | |
| + "hoprNodeSafe", | |
| + "isEligible", | |
| + "connectivityStatus", | |
| + "channelClosurePeriod" | |
| + ], | |
| "properties": { | |
| - "type": { | |
| - "type": "string", | |
| - "enum": [ | |
| - "incoming", | |
| - "outgoing" | |
| - ], | |
| - "description": "Channel can be either incomming or outgoing. Incomming means that other node can send messages using this node as relay. Outgoing means that this node can use other node to send message as realy.", | |
| - "example": "incoming" | |
| + "announcedAddress": { | |
| + "type": "array", | |
| + "items": { | |
| + "type": "string" | |
| + } | |
| }, | |
| - "id": { | |
| - "$ref": "#/components/schemas/ChannelId" | |
| + "chain": { | |
| + "type": "string" | |
| }, | |
| - "peerId": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| + "channelClosurePeriod": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "description": "Channel closure period in seconds", | |
| + "minimum": 0 | |
| }, | |
| - "status": { | |
| - "$ref": "#/components/schemas/ChannelStatus" | |
| + "connectivityStatus": { | |
| + "type": "string" | |
| }, | |
| - "balance": { | |
| - "$ref": "#/components/schemas/HoprBalance" | |
| + "hoprChannels": { | |
| + "type": "string" | |
| + }, | |
| + "hoprManagementModule": { | |
| + "type": "string" | |
| + }, | |
| + "hoprNetworkRegistry": { | |
| + "type": "string" | |
| + }, | |
| + "hoprNodeSafe": { | |
| + "type": "string" | |
| + }, | |
| + "hoprNodeSafeRegistry": { | |
| + "type": "string" | |
| + }, | |
| + "hoprToken": { | |
| + "type": "string" | |
| + }, | |
| + "isEligible": { | |
| + "type": "boolean" | |
| + }, | |
| + "listeningAddress": { | |
| + "type": "array", | |
| + "items": { | |
| + "type": "string" | |
| + } | |
| + }, | |
| + "network": { | |
| + "type": "string" | |
| } | |
| + }, | |
| + "example": { | |
| + "announcedAddress": [ | |
| + "/ip4/10.0.2.100/tcp/19092" | |
| + ], | |
| + "chain": "anvil-localhost", | |
| + "channelClosurePeriod": 15, | |
| + "connectivityStatus": "Green", | |
| + "hoprChannels": "0x9a9f2ccfde556a7e9ff0848998aa4a0cfd8863ae", | |
| + "hoprManagementModule": "0xa51c1fc2f0d1a1b8494ed1fe312d7c3a78ed91c0", | |
| + "hoprNetworkRegistry": "0x3aa5ebb10dc797cac828524e59a333d0a371443c", | |
| + "hoprNodeSafe": "0x42bc901b1d040f984ed626eff550718498a6798a", | |
| + "hoprNodeSageRegistry": "0x0dcd1bf9a1b36ce34237eeafef220932846bcd82", | |
| + "hoprToken": "0x9a676e781a523b5d0c0e43731313a708cb607508", | |
| + "isEligible": true, | |
| + "listeningAddress": [ | |
| + "/ip4/10.0.2.100/tcp/19092" | |
| + ], | |
| + "network": "anvil-localhost" | |
| } | |
| }, | |
| - "ChannelTopology": { | |
| + "NodePeerInfoResponse": { | |
| "type": "object", | |
| + "required": [ | |
| + "announced", | |
| + "observed" | |
| + ], | |
| "properties": { | |
| - "channelId": { | |
| - "$ref": "#/components/schemas/ChannelId" | |
| + "announced": { | |
| + "type": "array", | |
| + "items": { | |
| + "type": "string" | |
| + } | |
| }, | |
| - "sourcePeerId": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| + "observed": { | |
| + "type": "array", | |
| + "items": { | |
| + "type": "string" | |
| + } | |
| + } | |
| + }, | |
| + "example": { | |
| + "announced": [ | |
| + "/ip4/10.0.2.100/tcp/19093" | |
| + ], | |
| + "observed": [ | |
| + "/ip4/10.0.2.100/tcp/19093" | |
| + ] | |
| + } | |
| + }, | |
| + "NodePeersQueryRequest": { | |
| + "type": "object", | |
| + "properties": { | |
| + "quality": { | |
| + "type": "number", | |
| + "format": "double", | |
| + "nullable": true | |
| + } | |
| + } | |
| + }, | |
| + "NodePeersResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "connected", | |
| + "announced" | |
| + ], | |
| + "properties": { | |
| + "announced": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/PeerInfo" | |
| + } | |
| }, | |
| - "destinationPeerId": { | |
| - "$ref": "#/components/schemas/HoprAddress" | |
| + "connected": { | |
| + "type": "array", | |
| + "items": { | |
| + "$ref": "#/components/schemas/PeerInfo" | |
| + } | |
| + } | |
| + } | |
| + }, | |
| + "NodeTicketStatisticsResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "winProportion", | |
| + "unredeemed", | |
| + "unredeemedValue", | |
| + "redeemed", | |
| + "redeemedValue", | |
| + "losingTickets", | |
| + "neglected", | |
| + "neglectedValue", | |
| + "rejected", | |
| + "rejectedValue" | |
| + ], | |
| + "properties": { | |
| + "losingTickets": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| }, | |
| - "sourceAddress": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| + "neglected": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| }, | |
| - "destinationAddress": { | |
| - "$ref": "#/components/schemas/NativeAddress" | |
| + "neglectedValue": { | |
| + "type": "string" | |
| }, | |
| - "balance": { | |
| - "$ref": "#/components/schemas/HoprBalance" | |
| + "redeemed": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| }, | |
| - "status": { | |
| - "$ref": "#/components/schemas/ChannelStatus" | |
| + "redeemedValue": { | |
| + "type": "string" | |
| }, | |
| - "ticketIndex": { | |
| - "type": "string", | |
| - "description": "Each ticket is labeled by an ongoing serial number named ticket index i and its current value is stored in the smart contract." | |
| + "rejected": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| }, | |
| - "channelEpoch": { | |
| + "rejectedValue": { | |
| + "type": "string" | |
| + }, | |
| + "unredeemed": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + }, | |
| + "unredeemedValue": { | |
| + "type": "string" | |
| + }, | |
| + "winProportion": { | |
| + "type": "number", | |
| + "format": "double" | |
| + } | |
| + }, | |
| + "example": { | |
| + "losingTickets": 0, | |
| + "neglected": 0, | |
| + "neglectedValue": "0", | |
| + "redeemed": 1, | |
| + "redeemedValue": "100", | |
| + "rejected": 0, | |
| + "rejectedValue": "0", | |
| + "unredeemed": 2, | |
| + "unredeemedValue": "200", | |
| + "winProportion": 1 | |
| + } | |
| + }, | |
| + "NodeVersionResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "version" | |
| + ], | |
| + "properties": { | |
| + "version": { | |
| + "type": "string" | |
| + } | |
| + }, | |
| + "example": { | |
| + "version": "2.1.0" | |
| + } | |
| + }, | |
| + "OpenChannelBodyRequest": { | |
| + "type": "object", | |
| + "required": [ | |
| + "peerAddress", | |
| + "amount" | |
| + ], | |
| + "properties": { | |
| + "amount": { | |
| "type": "string", | |
| - "description": "Payment channels might run through multiple open and close sequences, this epoch tracks the sequence." | |
| + "description": "Initial amount of stake in HOPR tokens." | |
| }, | |
| - "closureTime": { | |
| + "peerAddress": { | |
| "type": "string", | |
| - "description": "Time when the channel can be closed" | |
| + "description": "On-chain address of the counterparty." | |
| } | |
| + }, | |
| + "example": { | |
| + "amount": "10", | |
| + "peerAddress": "0xa8194d36e322592d4c707b70dbe96121f5c74c64" | |
| } | |
| }, | |
| - "Ticket": { | |
| + "OpenChannelResponse": { | |
| "type": "object", | |
| + "required": [ | |
| + "channelId", | |
| + "transactionReceipt" | |
| + ], | |
| "properties": { | |
| "channelId": { | |
| - "$ref": "#/components/schemas/ChannelId" | |
| + "type": "string", | |
| + "description": "ID of the new channel." | |
| }, | |
| - "amount": { | |
| + "transactionReceipt": { | |
| "type": "string", | |
| - "description": "The ticket's value in HOPR. Only relevant if ticket is a win." | |
| + "description": "Receipt of the channel open transaction." | |
| + } | |
| + }, | |
| + "example": { | |
| + "channelId": "0x04efc1481d3f106b88527b3844ba40042b823218a9cd29d1aa11c2c2ef8f538f", | |
| + "transactionReceipt": "0x5181ac24759b8e01b3c932e4636c3852f386d17517a8dfc640a5ba6f2258f29c" | |
| + } | |
| + }, | |
| + "PeerIdResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "peerId" | |
| + ], | |
| + "properties": { | |
| + "peerId": { | |
| + "type": "string" | |
| + } | |
| + }, | |
| + "example": { | |
| + "peerId": "12D3KooWRWeTozREYHzWTbuCYskdYhED1MXpDwTrmccwzFrd2mEA" | |
| + } | |
| + }, | |
| + "PeerInfo": { | |
| + "type": "object", | |
| + "required": [ | |
| + "peerId", | |
| + "heartbeats", | |
| + "lastSeen", | |
| + "lastSeenLatency", | |
| + "quality", | |
| + "backoff", | |
| + "isNew", | |
| + "reportedVersion" | |
| + ], | |
| + "properties": { | |
| + "backoff": { | |
| + "type": "number", | |
| + "format": "double" | |
| }, | |
| - "index": { | |
| + "heartbeats": { | |
| + "$ref": "#/components/schemas/HeartbeatInfo" | |
| + }, | |
| + "isNew": { | |
| + "type": "boolean" | |
| + }, | |
| + "lastSeen": { | |
| + "type": "integer", | |
| + "minimum": 0 | |
| + }, | |
| + "lastSeenLatency": { | |
| + "type": "integer", | |
| + "minimum": 0 | |
| + }, | |
| + "multiaddr": { | |
| "type": "string", | |
| - "description": "Each ticket is labeled by an ongoing serial number named ticket index i and its current value is stored in the smart contract." | |
| + "nullable": true | |
| }, | |
| - "indexOffset": { | |
| + "peerAddress": { | |
| "type": "string", | |
| - "description": "Offset by which the on-chain stored ticket index gets increased when redeeming the ticket. Used to aggregate tickets." | |
| + "nullable": true | |
| }, | |
| - "channelEpoch": { | |
| + "peerId": { | |
| + "type": "string" | |
| + }, | |
| + "quality": { | |
| + "type": "number", | |
| + "format": "double" | |
| + }, | |
| + "reportedVersion": { | |
| + "type": "string" | |
| + } | |
| + } | |
| + }, | |
| + "PingResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "latency", | |
| + "reportedVersion" | |
| + ], | |
| + "properties": { | |
| + "latency": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + }, | |
| + "reportedVersion": { | |
| + "type": "string" | |
| + } | |
| + }, | |
| + "example": { | |
| + "latency": 200, | |
| + "reportedVersion": "2.1.0" | |
| + } | |
| + }, | |
| + "SendMessageBodyRequest": { | |
| + "type": "object", | |
| + "required": [ | |
| + "tag", | |
| + "body", | |
| + "peerId" | |
| + ], | |
| + "properties": { | |
| + "body": { | |
| "type": "string", | |
| - "description": "Payment channels might run through multiple open and close sequences, this epoch tracks the sequence." | |
| + "description": "Message to be transmitted over the network" | |
| }, | |
| - "winProb": { | |
| + "hops": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "nullable": true, | |
| + "minimum": 0 | |
| + }, | |
| + "path": { | |
| + "type": "array", | |
| + "items": { | |
| + "type": "string" | |
| + }, | |
| + "nullable": true | |
| + }, | |
| + "peerId": { | |
| "type": "string", | |
| - "description": "The ticket's winning probability, going from 0.0 to 1.0 where 0.0 ~= 0% winning probability and 1.0 equals 100% winning probability." | |
| + "description": "The recipient HOPR PeerId" | |
| }, | |
| - "signature": { | |
| - "$ref": "#/components/schemas/Signature" | |
| + "tag": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "description": "The message tag used to filter messages based on application", | |
| + "minimum": 0 | |
| } | |
| + }, | |
| + "example": { | |
| + "body": "Test message", | |
| + "hops": 1, | |
| + "path": [ | |
| + "12D3KooWR4uwjKCDCAY1xsEFB4esuWLF9Q5ijYvCjz5PNkTbnu33" | |
| + ], | |
| + "peerId": "12D3KooWEDc1vGJevww48trVDDf6pr1f6N3F86sGJfQrKCyc8kJ1", | |
| + "tag": 20 | |
| } | |
| }, | |
| - "Settings": { | |
| + "SendMessageResponse": { | |
| "type": "object", | |
| - "description": "Various settings that affects how this node is interacting with the network.", | |
| + "required": [ | |
| + "challenge", | |
| + "timestamp" | |
| + ], | |
| "properties": { | |
| - "includeRecipient": { | |
| - "type": "boolean", | |
| - "description": "Prepends your address to all messages so that receiver of the message can know that you sent that message.", | |
| - "example": true | |
| + "challenge": { | |
| + "type": "string" | |
| }, | |
| - "strategy": { | |
| + "timestamp": { | |
| + "type": "integer", | |
| + "format": "int64", | |
| + "minimum": 0 | |
| + } | |
| + }, | |
| + "example": { | |
| + "challenge": "031916ee5bfc0493f40c353a670fc586a3a28f9fce9cd065ff9d1cbef19b46eeba" | |
| + } | |
| + }, | |
| + "SizeResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "size" | |
| + ], | |
| + "properties": { | |
| + "size": { | |
| + "type": "integer", | |
| + "minimum": 0 | |
| + } | |
| + } | |
| + }, | |
| + "TagQueryRequest": { | |
| + "type": "object", | |
| + "properties": { | |
| + "tag": { | |
| + "type": "integer", | |
| + "format": "int32", | |
| + "nullable": true, | |
| + "minimum": 0 | |
| + } | |
| + } | |
| + }, | |
| + "TicketPriceResponse": { | |
| + "type": "object", | |
| + "required": [ | |
| + "price" | |
| + ], | |
| + "properties": { | |
| + "price": { | |
| "type": "string", | |
| - "enum": [ | |
| - "passive", | |
| - "promiscuous" | |
| - ], | |
| - "example": "passive", | |
| - "description": "By default, hoprd runs in **passive** mode, this means that your node will not attempt to open or close any channels automatically. When you set your strategy to **promiscuous** mode, your node will attempt to open channels to a _randomly_ selected group of nodes which you have a healthy connection to. At the same time, your node will also attempt to close channels that are running low on balance or are unhealthy." | |
| + "description": "Price of the ticket in HOPR tokens." | |
| } | |
| } | |
| }, | |
| - "TransactionReceipt": { | |
| - "type": "string", | |
| - "description": "Receipt identifier for an Ethereum transaction.", | |
| - "example": 2.51409958563871e+76 | |
| + "WithdrawBodyRequest": { | |
| + "type": "object", | |
| + "required": [ | |
| + "currency", | |
| + "amount", | |
| + "address" | |
| + ], | |
| + "properties": { | |
| + "address": { | |
| + "type": "string" | |
| + }, | |
| + "amount": { | |
| + "type": "string" | |
| + }, | |
| + "currency": { | |
| + "type": "string" | |
| + } | |
| + }, | |
| + "example": { | |
| + "address": "0xb4ce7e6e36ac8b01a974725d5ba730af2b156fbe", | |
| + "amount": 20000, | |
| + "currency": "HOPR" | |
| + } | |
| } | |
| }, | |
| "securitySchemes": { | |
| - "keyScheme": { | |
| + "api_token": { | |
| "type": "apiKey", | |
| - "name": "x-auth-token", | |
| "in": "header", | |
| - "description": "A valid API token which had been configured at node startup or through the token API." | |
| + "name": "X-Auth-Token" | |
| }, | |
| - "passwordScheme": { | |
| + "bearer_token": { | |
| "type": "http", | |
| - "scheme": "basic", | |
| - "description": "A valid API token is used as the user which had been configured at node startup. No password is required." | |
| + "scheme": "bearer", | |
| + "bearerFormat": "token" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| { | |
| - "name": "Account" | |
| - }, | |
| - { | |
| - "name": "Aliases" | |
| - }, | |
| - { | |
| - "name": "Channels" | |
| + "name": "Checks", | |
| + "description": "HOPR node functionality checks" | |
| }, | |
| { | |
| - "name": "Messages" | |
| + "name": "Alias", | |
| + "description": "HOPR node internal non-persistent alias endpoints" | |
| }, | |
| { | |
| - "name": "Node" | |
| + "name": "Account", | |
| + "description": "HOPR node account endpoints" | |
| }, | |
| { | |
| - "name": "PeerInfo" | |
| + "name": "Node", | |
| + "description": "HOPR node information endpoints" | |
| }, | |
| { | |
| - "name": "Peers" | |
| + "name": "Tickets", | |
| + "description": "HOPR node ticket management endpoints" | |
| }, | |
| { | |
| - "name": "Settings" | |
| + "name": "Messages", | |
| + "description": "HOPR node message manipulation endpoints" | |
| }, | |
| { | |
| - "name": "Tickets" | |
| + "name": "Channels", | |
| + "description": "HOPR node chain channels manipulation endpoints" | |
| }, | |
| { | |
| - "name": "Tokens" | |
| + "name": "Peers", | |
| + "description": "HOPR node peer manipulation endpoints" | |
| } | |
| ] | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment