From 2ebd2821dac7ff3599ce98a1ca055d0a0a905197 Mon Sep 17 00:00:00 2001 From: ausias-armesto Date: Tue, 1 Oct 2024 09:16:57 +0200 Subject: [PATCH] Adapt docs --- .github/workflows/gh-pages.yaml | 1 - docs/README.md | 199 -- docs/assets/highlight.css | 92 + docs/assets/icons.js | 15 + docs/assets/icons.svg | 1 + docs/assets/main.js | 59 + docs/assets/navigation.js | 1 + docs/assets/search.js | 1 + docs/assets/style.css | 1412 ++++++++++++ docs/classes/HoprSDK.html | 6 + docs/classes/HoprSDK.md | 59 - docs/classes/utils.sdkApiError.html | 22 + docs/classes/utils.sdkApiError.md | 238 -- docs/functions/api.closeChannel.html | 8 + docs/functions/api.createToken.html | 12 + docs/functions/api.deleteMessages.html | 4 + docs/functions/api.deleteToken.html | 8 + docs/functions/api.fundChannel.html | 5 + docs/functions/api.getAddresses.html | 7 + docs/functions/api.getAlias.html | 7 + docs/functions/api.getAliases.html | 7 + docs/functions/api.getBalances.html | 7 + docs/functions/api.getChannel.html | 4 + docs/functions/api.getChannelTickets.html | 4 + docs/functions/api.getChannels.html | 4 + docs/functions/api.getConfiguration.html | 8 + docs/functions/api.getEntryNodes.html | 4 + docs/functions/api.getHoprAddress.html | 7 + docs/functions/api.getInfo.html | 4 + docs/functions/api.getMessagesSize.html | 4 + docs/functions/api.getMetrics.html | 4 + docs/functions/api.getNativeAddress.html | 7 + docs/functions/api.getNativeBalance.html | 7 + docs/functions/api.getPeer.html | 4 + docs/functions/api.getPeers.html | 4 + docs/functions/api.getTicketPrice.html | 4 + docs/functions/api.getTicketStatistics.html | 4 + docs/functions/api.getToken.html | 7 + docs/functions/api.getVersion.html | 4 + docs/functions/api.isNodeHealthy.html | 7 + docs/functions/api.isNodeReady.html | 7 + docs/functions/api.isNodeStarted.html | 7 + docs/functions/api.openChannel.html | 8 + docs/functions/api.peekAllMessages.html | 10 + docs/functions/api.peekMessage.html | 9 + docs/functions/api.pingPeer.html | 4 + docs/functions/api.popAllMessages.html | 9 + docs/functions/api.popMessage.html | 9 + docs/functions/api.redeemChannelTickets.html | 9 + docs/functions/api.redeemTickets.html | 9 + docs/functions/api.removeAlias.html | 7 + docs/functions/api.sendMessage.html | 8 + docs/functions/api.setAlias.html | 9 + docs/functions/api.websocket.html | 6 + docs/functions/api.withdraw.html | 8 + docs/functions/flows.cashOut.html | 8 + docs/functions/flows.closeEverything.html | 6 + docs/functions/flows.getOutgoingChannels.html | 6 + .../functions/flows.openMultipleChannels.html | 4 + docs/functions/flows.safeSendMessage.html | 7 + docs/functions/utils.createLogger.html | 5 + docs/functions/utils.fetchWithTimeout.html | 1 + docs/functions/utils.getHeaders.html | 4 + docs/index.html | 98 + docs/modules.html | 135 ++ docs/modules.md | 2023 ----------------- docs/modules/api.html | 43 + docs/modules/api.md | 1268 ----------- docs/modules/flows.html | 6 + docs/modules/flows.md | 151 -- docs/modules/utils.html | 5 + docs/modules/utils.md | 87 - docs/modules/web3.html | 18 + docs/modules/web3.md | 210 -- .../AggregateChannelTicketsPayloadType.html | 4 + docs/types/AliasPayloadType.html | 4 + docs/types/ApiErrorResponseType.html | 1 + docs/types/BasePayloadType.html | 5 + docs/types/ChainPayloadType.html | 1 + docs/types/CloseChannelPayloadType.html | 4 + docs/types/CloseChannelResponseType.html | 1 + docs/types/CreateTokenPayloadType.html | 4 + docs/types/CreateTokenResponseType.html | 1 + docs/types/DeleteMessagesPayloadType.html | 4 + docs/types/DeleteTokenPayloadType.html | 4 + docs/types/FundChannelsPayloadType.html | 4 + docs/types/FundChannelsResponseType.html | 1 + docs/types/GetAddressesResponseType.html | 1 + docs/types/GetAliasResponseType.html | 1 + docs/types/GetAliasesResponseType.html | 1 + docs/types/GetBalancesResponseType.html | 1 + docs/types/GetChannelPayloadType.html | 4 + docs/types/GetChannelResponseType.html | 1 + docs/types/GetChannelTicketsPayloadType.html | 4 + docs/types/GetChannelTicketsResponseType.html | 1 + docs/types/GetChannelsPayloadType.html | 4 + docs/types/GetChannelsResponseType.html | 1 + docs/types/GetConfigurationPayloadType.html | 4 + docs/types/GetConfigurationResponseType.html | 1 + docs/types/GetEntryNodesResponseType.html | 1 + docs/types/GetInfoResponseType.html | 1 + docs/types/GetMessagesSizePayloadType.html | 4 + docs/types/GetMessagesSizeResponseType.html | 1 + docs/types/GetPeerPayloadType.html | 4 + docs/types/GetPeerResponseType.html | 1 + docs/types/GetPeersPayloadType.html | 4 + docs/types/GetPeersResponseType.html | 1 + docs/types/GetTicketPricePayloadType.html | 4 + docs/types/GetTicketPriceResponseType.html | 1 + .../GetTicketStatisticsResponseType.html | 1 + docs/types/GetTokenResponseType.html | 1 + docs/types/IsNodeHealthyPayloadType.html | 4 + docs/types/IsNodeHealthyResponseType.html | 1 + docs/types/IsNodeReadyPayloadType.html | 4 + docs/types/IsNodeReadyResponseType.html | 1 + docs/types/IsNodeStartedPayloadType.html | 4 + docs/types/IsNodeStartedResponseType.html | 1 + docs/types/NetworkPayloadType.html | 1 + docs/types/OpenChannelPayloadType.html | 4 + docs/types/OpenChannelResponseType.html | 1 + docs/types/PeekAllMessagesPayloadType.html | 4 + docs/types/PeekAllMessagesResponseType.html | 1 + docs/types/PeekMessagePayloadType.html | 4 + docs/types/PeekMessageResponseType.html | 1 + docs/types/PingPeerPayloadType.html | 4 + docs/types/PingPeerResponseType.html | 1 + docs/types/PopAllMessagesPayloadType.html | 4 + docs/types/PopAllMessagesResponseType.html | 1 + docs/types/PopMessagePayloadType.html | 4 + docs/types/PopMessageResponseType.html | 1 + .../RedeemChannelTicketsPayloadType.html | 4 + .../RemoveBasicAuthenticationPayloadType.html | 3 + docs/types/SendMessagePayloadType.html | 4 + docs/types/SetAliasPayloadType.html | 4 + docs/types/StrategiesPayloadType.html | 1 + docs/types/WithdrawPayloadType.html | 4 + docs/types/createWsUrlType.html | 4 + .../AggregateChannelTicketsPayload.html | 11 + docs/variables/AliasPayload.html | 2 + docs/variables/ApiErrorResponse.html | 1 + docs/variables/BasePayload.html | 2 + docs/variables/Channel.html | 1 + docs/variables/CloseChannelPayload.html | 2 + docs/variables/CloseChannelResponse.html | 1 + docs/variables/CreateTokenPayload.html | 2 + docs/variables/CreateTokenResponse.html | 1 + docs/variables/DeleteMessagesPayload.html | 2 + docs/variables/DeleteTokenPayload.html | 2 + docs/variables/FundChannelsPayload.html | 2 + docs/variables/FundChannelsResponse.html | 1 + docs/variables/GetAddressesResponse.html | 2 + docs/variables/GetAliasResponse.html | 2 + docs/variables/GetAliasesResponse.html | 2 + docs/variables/GetBalancesResponse.html | 2 + docs/variables/GetChannelPayload.html | 2 + docs/variables/GetChannelResponse.html | 1 + docs/variables/GetChannelTicketsPayload.html | 2 + docs/variables/GetChannelTicketsResponse.html | 1 + docs/variables/GetChannelsPayload.html | 2 + docs/variables/GetChannelsResponse.html | 1 + docs/variables/GetConfigurationPayload.html | 2 + docs/variables/GetConfigurationResponse.html | 1 + docs/variables/GetEntryNodesResponse.html | 1 + docs/variables/GetInfoResponse.html | 2 + docs/variables/GetMessagesSizePayload.html | 2 + docs/variables/GetMessagesSizeResponse.html | 1 + docs/variables/GetPeerPayload.html | 2 + docs/variables/GetPeerResponse.html | 1 + docs/variables/GetPeersPayload.html | 2 + docs/variables/GetPeersResponse.html | 1 + docs/variables/GetTicketPricePayload.html | 2 + docs/variables/GetTicketPriceResponse.html | 1 + .../GetTicketStatisticsResponse.html | 2 + docs/variables/GetTokenResponse.html | 2 + docs/variables/IsNodeHealthyPayload.html | 2 + docs/variables/IsNodeHealthyResponse.html | 1 + docs/variables/IsNodeReadyPayload.html | 2 + docs/variables/IsNodeReadyResponse.html | 1 + docs/variables/IsNodeStartedPayload.html | 2 + docs/variables/IsNodeStartedResponse.html | 1 + docs/variables/OpenChannelPayload.html | 2 + docs/variables/OpenChannelResponse.html | 1 + docs/variables/PeekAllMessagesPayload.html | 2 + docs/variables/PeekAllMessagesResponse.html | 1 + docs/variables/PeekMessagePayload.html | 2 + docs/variables/PeekMessageResponse.html | 1 + docs/variables/PeerAnnounced.html | 1 + docs/variables/PeerConnected.html | 1 + docs/variables/PingPeerPayload.html | 2 + docs/variables/PingPeerResponse.html | 1 + docs/variables/PopAllMessagesPayload.html | 2 + docs/variables/PopAllMessagesResponse.html | 1 + docs/variables/PopMessagePayload.html | 2 + docs/variables/PopMessageResponse.html | 1 + docs/variables/ReceivedMessage.html | 2 + .../RedeemChannelTicketsPayload.html | 2 + docs/variables/SendMessagePayload.html | 2 + docs/variables/SetAliasPayload.html | 2 + docs/variables/Ticket.html | 1 + docs/variables/TokenCapability.html | 1 + docs/variables/WithdrawPayload.html | 2 + docs/variables/WithdrawResponse.html | 1 + docs/variables/createWsUrlPayload.html | 2 + docs/variables/web3.DUFOUR.html | 1 + ....HOPR_CHANNELS_SMART_CONTRACT_ADDRESS.html | 1 + docs/variables/web3.erc721ABI.html | 1 + docs/variables/web3.hoprBoostNFTABI.html | 1 + docs/variables/web3.hoprChannelsABI.html | 1 + docs/variables/web3.hoprMultiSendABI.html | 1 + .../web3.hoprNetworkRegistryABI.html | 1 + .../web3.hoprNodeManagementModuleABI.html | 1 + .../web3.hoprNodeSafeRegistryABI.html | 1 + .../web3.hoprNodeStakeFactoryABI.html | 1 + docs/variables/web3.hoprSafeABI.html | 1 + docs/variables/web3.hoprWrapperABI.html | 1 + ...b3.mHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html | 1 + docs/variables/web3.wrapperABI.html | 1 + ...3.wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html | 1 + ...wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS.html | 1 + ...b3.xHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html | 1 + package.json | 2 +- 221 files changed, 2517 insertions(+), 4237 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/icons.js create mode 100644 docs/assets/icons.svg create mode 100644 docs/assets/main.js create mode 100644 docs/assets/navigation.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/classes/HoprSDK.html delete mode 100644 docs/classes/HoprSDK.md create mode 100644 docs/classes/utils.sdkApiError.html delete mode 100644 docs/classes/utils.sdkApiError.md create mode 100644 docs/functions/api.closeChannel.html create mode 100644 docs/functions/api.createToken.html create mode 100644 docs/functions/api.deleteMessages.html create mode 100644 docs/functions/api.deleteToken.html create mode 100644 docs/functions/api.fundChannel.html create mode 100644 docs/functions/api.getAddresses.html create mode 100644 docs/functions/api.getAlias.html create mode 100644 docs/functions/api.getAliases.html create mode 100644 docs/functions/api.getBalances.html create mode 100644 docs/functions/api.getChannel.html create mode 100644 docs/functions/api.getChannelTickets.html create mode 100644 docs/functions/api.getChannels.html create mode 100644 docs/functions/api.getConfiguration.html create mode 100644 docs/functions/api.getEntryNodes.html create mode 100644 docs/functions/api.getHoprAddress.html create mode 100644 docs/functions/api.getInfo.html create mode 100644 docs/functions/api.getMessagesSize.html create mode 100644 docs/functions/api.getMetrics.html create mode 100644 docs/functions/api.getNativeAddress.html create mode 100644 docs/functions/api.getNativeBalance.html create mode 100644 docs/functions/api.getPeer.html create mode 100644 docs/functions/api.getPeers.html create mode 100644 docs/functions/api.getTicketPrice.html create mode 100644 docs/functions/api.getTicketStatistics.html create mode 100644 docs/functions/api.getToken.html create mode 100644 docs/functions/api.getVersion.html create mode 100644 docs/functions/api.isNodeHealthy.html create mode 100644 docs/functions/api.isNodeReady.html create mode 100644 docs/functions/api.isNodeStarted.html create mode 100644 docs/functions/api.openChannel.html create mode 100644 docs/functions/api.peekAllMessages.html create mode 100644 docs/functions/api.peekMessage.html create mode 100644 docs/functions/api.pingPeer.html create mode 100644 docs/functions/api.popAllMessages.html create mode 100644 docs/functions/api.popMessage.html create mode 100644 docs/functions/api.redeemChannelTickets.html create mode 100644 docs/functions/api.redeemTickets.html create mode 100644 docs/functions/api.removeAlias.html create mode 100644 docs/functions/api.sendMessage.html create mode 100644 docs/functions/api.setAlias.html create mode 100644 docs/functions/api.websocket.html create mode 100644 docs/functions/api.withdraw.html create mode 100644 docs/functions/flows.cashOut.html create mode 100644 docs/functions/flows.closeEverything.html create mode 100644 docs/functions/flows.getOutgoingChannels.html create mode 100644 docs/functions/flows.openMultipleChannels.html create mode 100644 docs/functions/flows.safeSendMessage.html create mode 100644 docs/functions/utils.createLogger.html create mode 100644 docs/functions/utils.fetchWithTimeout.html create mode 100644 docs/functions/utils.getHeaders.html create mode 100644 docs/index.html create mode 100644 docs/modules.html delete mode 100644 docs/modules.md create mode 100644 docs/modules/api.html delete mode 100644 docs/modules/api.md create mode 100644 docs/modules/flows.html delete mode 100644 docs/modules/flows.md create mode 100644 docs/modules/utils.html delete mode 100644 docs/modules/utils.md create mode 100644 docs/modules/web3.html delete mode 100644 docs/modules/web3.md create mode 100644 docs/types/AggregateChannelTicketsPayloadType.html create mode 100644 docs/types/AliasPayloadType.html create mode 100644 docs/types/ApiErrorResponseType.html create mode 100644 docs/types/BasePayloadType.html create mode 100644 docs/types/ChainPayloadType.html create mode 100644 docs/types/CloseChannelPayloadType.html create mode 100644 docs/types/CloseChannelResponseType.html create mode 100644 docs/types/CreateTokenPayloadType.html create mode 100644 docs/types/CreateTokenResponseType.html create mode 100644 docs/types/DeleteMessagesPayloadType.html create mode 100644 docs/types/DeleteTokenPayloadType.html create mode 100644 docs/types/FundChannelsPayloadType.html create mode 100644 docs/types/FundChannelsResponseType.html create mode 100644 docs/types/GetAddressesResponseType.html create mode 100644 docs/types/GetAliasResponseType.html create mode 100644 docs/types/GetAliasesResponseType.html create mode 100644 docs/types/GetBalancesResponseType.html create mode 100644 docs/types/GetChannelPayloadType.html create mode 100644 docs/types/GetChannelResponseType.html create mode 100644 docs/types/GetChannelTicketsPayloadType.html create mode 100644 docs/types/GetChannelTicketsResponseType.html create mode 100644 docs/types/GetChannelsPayloadType.html create mode 100644 docs/types/GetChannelsResponseType.html create mode 100644 docs/types/GetConfigurationPayloadType.html create mode 100644 docs/types/GetConfigurationResponseType.html create mode 100644 docs/types/GetEntryNodesResponseType.html create mode 100644 docs/types/GetInfoResponseType.html create mode 100644 docs/types/GetMessagesSizePayloadType.html create mode 100644 docs/types/GetMessagesSizeResponseType.html create mode 100644 docs/types/GetPeerPayloadType.html create mode 100644 docs/types/GetPeerResponseType.html create mode 100644 docs/types/GetPeersPayloadType.html create mode 100644 docs/types/GetPeersResponseType.html create mode 100644 docs/types/GetTicketPricePayloadType.html create mode 100644 docs/types/GetTicketPriceResponseType.html create mode 100644 docs/types/GetTicketStatisticsResponseType.html create mode 100644 docs/types/GetTokenResponseType.html create mode 100644 docs/types/IsNodeHealthyPayloadType.html create mode 100644 docs/types/IsNodeHealthyResponseType.html create mode 100644 docs/types/IsNodeReadyPayloadType.html create mode 100644 docs/types/IsNodeReadyResponseType.html create mode 100644 docs/types/IsNodeStartedPayloadType.html create mode 100644 docs/types/IsNodeStartedResponseType.html create mode 100644 docs/types/NetworkPayloadType.html create mode 100644 docs/types/OpenChannelPayloadType.html create mode 100644 docs/types/OpenChannelResponseType.html create mode 100644 docs/types/PeekAllMessagesPayloadType.html create mode 100644 docs/types/PeekAllMessagesResponseType.html create mode 100644 docs/types/PeekMessagePayloadType.html create mode 100644 docs/types/PeekMessageResponseType.html create mode 100644 docs/types/PingPeerPayloadType.html create mode 100644 docs/types/PingPeerResponseType.html create mode 100644 docs/types/PopAllMessagesPayloadType.html create mode 100644 docs/types/PopAllMessagesResponseType.html create mode 100644 docs/types/PopMessagePayloadType.html create mode 100644 docs/types/PopMessageResponseType.html create mode 100644 docs/types/RedeemChannelTicketsPayloadType.html create mode 100644 docs/types/RemoveBasicAuthenticationPayloadType.html create mode 100644 docs/types/SendMessagePayloadType.html create mode 100644 docs/types/SetAliasPayloadType.html create mode 100644 docs/types/StrategiesPayloadType.html create mode 100644 docs/types/WithdrawPayloadType.html create mode 100644 docs/types/createWsUrlType.html create mode 100644 docs/variables/AggregateChannelTicketsPayload.html create mode 100644 docs/variables/AliasPayload.html create mode 100644 docs/variables/ApiErrorResponse.html create mode 100644 docs/variables/BasePayload.html create mode 100644 docs/variables/Channel.html create mode 100644 docs/variables/CloseChannelPayload.html create mode 100644 docs/variables/CloseChannelResponse.html create mode 100644 docs/variables/CreateTokenPayload.html create mode 100644 docs/variables/CreateTokenResponse.html create mode 100644 docs/variables/DeleteMessagesPayload.html create mode 100644 docs/variables/DeleteTokenPayload.html create mode 100644 docs/variables/FundChannelsPayload.html create mode 100644 docs/variables/FundChannelsResponse.html create mode 100644 docs/variables/GetAddressesResponse.html create mode 100644 docs/variables/GetAliasResponse.html create mode 100644 docs/variables/GetAliasesResponse.html create mode 100644 docs/variables/GetBalancesResponse.html create mode 100644 docs/variables/GetChannelPayload.html create mode 100644 docs/variables/GetChannelResponse.html create mode 100644 docs/variables/GetChannelTicketsPayload.html create mode 100644 docs/variables/GetChannelTicketsResponse.html create mode 100644 docs/variables/GetChannelsPayload.html create mode 100644 docs/variables/GetChannelsResponse.html create mode 100644 docs/variables/GetConfigurationPayload.html create mode 100644 docs/variables/GetConfigurationResponse.html create mode 100644 docs/variables/GetEntryNodesResponse.html create mode 100644 docs/variables/GetInfoResponse.html create mode 100644 docs/variables/GetMessagesSizePayload.html create mode 100644 docs/variables/GetMessagesSizeResponse.html create mode 100644 docs/variables/GetPeerPayload.html create mode 100644 docs/variables/GetPeerResponse.html create mode 100644 docs/variables/GetPeersPayload.html create mode 100644 docs/variables/GetPeersResponse.html create mode 100644 docs/variables/GetTicketPricePayload.html create mode 100644 docs/variables/GetTicketPriceResponse.html create mode 100644 docs/variables/GetTicketStatisticsResponse.html create mode 100644 docs/variables/GetTokenResponse.html create mode 100644 docs/variables/IsNodeHealthyPayload.html create mode 100644 docs/variables/IsNodeHealthyResponse.html create mode 100644 docs/variables/IsNodeReadyPayload.html create mode 100644 docs/variables/IsNodeReadyResponse.html create mode 100644 docs/variables/IsNodeStartedPayload.html create mode 100644 docs/variables/IsNodeStartedResponse.html create mode 100644 docs/variables/OpenChannelPayload.html create mode 100644 docs/variables/OpenChannelResponse.html create mode 100644 docs/variables/PeekAllMessagesPayload.html create mode 100644 docs/variables/PeekAllMessagesResponse.html create mode 100644 docs/variables/PeekMessagePayload.html create mode 100644 docs/variables/PeekMessageResponse.html create mode 100644 docs/variables/PeerAnnounced.html create mode 100644 docs/variables/PeerConnected.html create mode 100644 docs/variables/PingPeerPayload.html create mode 100644 docs/variables/PingPeerResponse.html create mode 100644 docs/variables/PopAllMessagesPayload.html create mode 100644 docs/variables/PopAllMessagesResponse.html create mode 100644 docs/variables/PopMessagePayload.html create mode 100644 docs/variables/PopMessageResponse.html create mode 100644 docs/variables/ReceivedMessage.html create mode 100644 docs/variables/RedeemChannelTicketsPayload.html create mode 100644 docs/variables/SendMessagePayload.html create mode 100644 docs/variables/SetAliasPayload.html create mode 100644 docs/variables/Ticket.html create mode 100644 docs/variables/TokenCapability.html create mode 100644 docs/variables/WithdrawPayload.html create mode 100644 docs/variables/WithdrawResponse.html create mode 100644 docs/variables/createWsUrlPayload.html create mode 100644 docs/variables/web3.DUFOUR.html create mode 100644 docs/variables/web3.HOPR_CHANNELS_SMART_CONTRACT_ADDRESS.html create mode 100644 docs/variables/web3.erc721ABI.html create mode 100644 docs/variables/web3.hoprBoostNFTABI.html create mode 100644 docs/variables/web3.hoprChannelsABI.html create mode 100644 docs/variables/web3.hoprMultiSendABI.html create mode 100644 docs/variables/web3.hoprNetworkRegistryABI.html create mode 100644 docs/variables/web3.hoprNodeManagementModuleABI.html create mode 100644 docs/variables/web3.hoprNodeSafeRegistryABI.html create mode 100644 docs/variables/web3.hoprNodeStakeFactoryABI.html create mode 100644 docs/variables/web3.hoprSafeABI.html create mode 100644 docs/variables/web3.hoprWrapperABI.html create mode 100644 docs/variables/web3.mHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html create mode 100644 docs/variables/web3.wrapperABI.html create mode 100644 docs/variables/web3.wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html create mode 100644 docs/variables/web3.wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS.html create mode 100644 docs/variables/web3.xHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html diff --git a/.github/workflows/gh-pages.yaml b/.github/workflows/gh-pages.yaml index ab02eafa..dadf0207 100644 --- a/.github/workflows/gh-pages.yaml +++ b/.github/workflows/gh-pages.yaml @@ -36,5 +36,4 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_branch: gh-pages publish_dir: docs - cname: hoprnet.org force_orphan: true diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index cabe6cfa..00000000 --- a/docs/README.md +++ /dev/null @@ -1,199 +0,0 @@ -# @hoprnet/hopr-sdk - -## Description - -The `@hoprnet/hopr-sdk` package is a software development kit for interacting with [HOPRd's Rest API functions](https://docs.hoprnet.org/developers/rest-api). -It provides a set of functions that allow developers to interact with the HOPR protocol and perform various actions such as node and account management, messaging, address retrieval, balance retrieval, and withdrawal and other operations. - -## Installation - -To install the `@hoprnet/hopr-sdk` package, follow these steps: - -1. Make sure you have [node.js](https://nodejs.org) >=18 installed on your machine. -2. Open your terminal or command prompt. -3. Navigate to your project directory. -4. Run the following command to install the package using: - -```shell -npm install @hoprnet/hopr-sdk -``` - -or - -```shell -yarn add @hoprnet/hopr-sdk -``` - -## Usage - -You can use the `@hoprnet/hopr-sdk` in two different ways: - -### HoprSDK class - -By creating a new instance of the HoprSDK class. - -1. Import the HoprSDK class from the package: - -```ts -import { HoprSDK } from '@hoprnet/hopr-sdk'; -``` - -2. Create an instance of the HoprSDK class by providing the required parameters: - -```ts -const sdk = new HoprSDK({ - apiEndpoint: 'http://localhost:3001', // Replace with your HOPR API endopoint. - apiToken: 'your-api-token', // Replace with your API token - timeout: 5000 // Optional timeout in milliseconds (defaults to 30000) -}); -``` - -3. You can now use the `sdk` instance to access the available functions. For example, to get the HOPR and native addresses associated with the node: - -```ts -const addresses = await sdk.api.account.getAddresses(); - -console.log(addresses); -``` - -#### HOPR API functions - -By calling directly the rest API functions. - -1. Import the API object from the package: - -```ts -import { api } from '@hoprnet/hopr-sdk'; -``` - -- If your ts config includes `"moduleResolution": "nodenext" or "node16"`, you can import the functions like this: - -```ts -import { getAddresses } from '@hoprnet/hopr-sdk/api'; -``` - -2. Access the desired function, keep in mind that you'll need to provide a **payload object** with the `apiEndpoint` and `apiToken` for each individual function: - -```ts -const addresses = await api.getAddresses({ - apiEndpoint: 'http://localhost:3001', // Replace with your HOPR API endopoint - apiToken: 'your-api-token' // Replace with your API token - timeout: 5000 // Optional timeout in milliseconds (defaults to 30000) -}); - -console.log(addresses); -``` - -#### HOPR Flows functions - -By calling directly the flows functions. - -1. Import the flows object from the package: - -```ts -import { flows } from '@hoprnet/hopr-sdk'; -``` - -- If your ts config includes `"moduleResolution": "nodenext" or "node16"`, you can import the functions like this: - -```ts -import { openMultipleChannels } from '@hoprnet/hopr-sdk/flows'; -``` - -2. Access the desired function, keep in mind that you'll need to provide a **payload object** with the `apiEndpoint` and `apiToken` for each individual function: - -```ts -const res = await flows.openMultipleChannels({ - apiEndpoint: 'http://localhost:3001', // Replace with your HOPR API endopoint - apiToken: 'your-api-token' // Replace with your API token - timeout: 60e3 * 7 // Optional timeout in milliseconds (defaults to 30000) | This function takes really long -}); - -console.log(res); -``` - -## Documentation - -- [HoprSDK Class](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/classes/HoprSDK.md) -- [API functions](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules/api.md) -- [Flows functions](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules/flows.md) -- [Utils](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules/utils.md) -- [Type Aliases and Variables](https://github.com/hoprnet/hopr-sdk/blob/docs/docs/modules.md) - -## Project setup - -Source code resides under `src/` folder. - -- api: the api routes seperated by resource -- ethereum: ethereum ABIs and Addresses that are relevant to Hopr -- flows: common uses of multiple functions in a row -- types: api response and request types using zod -- utils: extras that are used throughout the repo, such as `fetchWithTimeout` - -## API - -### Directory Setup - -The api folder is used to find routes with ease. - -For example if you are looking for `GET /api/v3/node/info` you would go straight -to the node folder and find the file `getInfo.ts` alongside `getInfo.spec.ts` to -understand how this function will react to different responses from the node. - -In a more general sense it looks like this: - -``` -├── api -│ ├── resource (example: node) -│ │ ├── adapter.ts -│ │ ├── getResource.ts -│ │ ├── getResource.spec.ts -``` - -The adapter creates a resource class used by the [sdk class](./sdk.ts) - -#### Adding a new route - -The resource of the route can be seen after the `v3` keyword, for example in this example `/api/v3/node/info` the resource is `node`. - -##### New Resource - -- Create a the resource folder that must contain: adapter.ts and functions with tests. - -##### Exisiting Resource - -- Add the function to the resource folder with tests showing how the route would react to - different status codes - -#### Basic function structure - -```Typescript -async function getResource(payload: ResourcePayloadType) { - const rawResponse = await fetchResource() - - // received unexpected error from server - if (isServerError(rawResponse)) { - throw new Error(); - } - - // received expected response - // this can either be done with a Zod object or a status code - if (receivedExpectedResponse(rawResponse)) { - return parseResponse(rawResponse); - } - - // check if response has the structure of an expected sdk api error - if (isApiErrorResponse(rawResponse)) { - throw new sdkApiError(); - } - - // if we get to this point then we could not parse the response - // and it is not unexpected error - // we probably need to update the zod type - throw new ZodError(parsedRes.error.issues); -} -``` - -## Deployment process - -To contribute to this repository you will need to create a pull request. More information about the existing automated workflows can be found in [GitHub Actions](./.github/workflows/README.md) diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 00000000..677ff218 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,92 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #267F99; + --dark-hl-9: #4EC9B0; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 00000000..b79c9e89 --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 00000000..7dead611 --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 00000000..d6f13886 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 00000000..b2f2ed48 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WbQXPbNhBG/4vOmaZx0qbNTbblOJNY1khKfchkPIgISxxRpIaErLid/veCEmWCwOLbpXuM8fB2ARIkuFC+/TMw+qcZfBiobTp4Ndgqs7L/2BTJLtPVa/vHX1Zmk9mWdZongw/vXg0WqzRLSp0PPnx77rzIikpfrFSe66y1POzyhUmL/Ohxma7093f/vmpVpVZGz4u1jRAztQgQJTrTRt/oqlJLXcVcXYrVwbwcBIhsn4SZKgcBoqU2w8ReiaqKD89lGFWWKqip2wUKnMuRwJpzlal8AT0nBIuYWW4JkWaeLtbaoKy6oEgq0HGiIn9Il7tS1X2RzeWwcpSb8mlcJPAStBCWXRfbsrkFgc2hsO5T/lAAT92MBaelPkv/1kDkYpzQlOkCDa4hsGZsL8yj5meqw0mUzVphlQ2HlROtS2Cqm3kBGt6hHSuO62tipxQNyqEkupmxk1AZfCF9lBGjd8WpHSv+spOBl3VDAE1a1av0WqvMrJ5ipg7EyqZaJYzqgLAiO5Wl0QlWNRCQFVudMw97BwGirdbrYZZxmwYPY4QNhmQNgkRpvkSL79SOFMVWMrYOhXXcyJ4JoCl1ovVG9o6lWFYtckpkm8I+d9EuyUGAqNJ5wkycg0AR3rRV/KZtr39URT3ymOMZQJLUrJJS7aOOpj1QfHd3xVmxd0Zy+gA5/Fn2CaKq1e2OHMhR0gDo06P+Qhk96vLJrOxyAqouiJ/hNuaysBTa8R21BMw89G52mUm3mebdFI3uLfWgZ/hGPXo9EF7jnUkz4hof/iy6xlWyHm7TUVkWznNwkan666bROEhX+ebsj+Ar80uxXNKP1KPMpdAXnTaL1Z29y+fpRhf0PXgU+iSzdbbv0Mhu6ahrGTjvdhG/Dae9/qto1i+/Xt1+nbaCR1Wm6sez4tjcNb09c8Jf306m9xfXw/F49GV2P7sZTuf3F7fj+XR4Mb8fXl5OR7NZ1C7pDGLrcvH+7M3w/FM0wDMBLCv7dXJeFJUZX82Ry+MY42kZckaHY4yHBV6vRk7pgoxzrM2+KNdTvbR73vKJM4c457c7vBuV22fHRufm5nBzskHoPoJIM/u4Eg8l5CURjFrrK7UwhTBCl2ci1Plw1oZhTHel2m51yclaDPg2h1U6v/08Gvdd33xXEHfPj2EvyX//8+UDEPTlI99Nh5PJaPrC2Lg3iP4/hv2CUbuvpLreM7v8HL7Fmwb07h4ul6Ve2hdz90Ngop6yQiXzp62zXTH2X9Vrvkc33tmvf75/85s7U4eNNIrgtbO+Zo8y1dXWvs816SQYznuuKg3S9Jo5m52uNAc6v531OUcASEtjfexoXmMc62+PHVDyJNXDDVOnMc5+2TnkAMlHQVkEbm5oinNftachKPcI1seOpj7Gcf6PzgkM8sc4ib9++HBun5F6+axDSuA+neAwcgoT2PlnDAnJzUzaL3i6fPTPj0TJ93+TBX1lQyFgeSTZWF42CmH+vTN3j8uY9CNo3yjcQGKsIE57WMcEoUFBhPrgjXH7iMDqnsLhixAhe8ZgRhBDBVHq2jwegUcInUzGPiK0MgvWR6RWQbJ97zvnmA/nTIP9IjD5R0hxjPZgURSIxiXRuG0mxXDeT+4JIrgUMa6XHyUfBWURDgeXbP4+1cPN5x5gMntzTsrmHnK9/Hz+BMhFaMqGIPeQ4Jy37ZEv8NJUDzeajwjG2Sfd82WQfZzsGQONAqCSKE0/ZhQh1cPNZU9grL05UEdph4jUChMmGNbbObVHOcfAfhFg/lFSEENws1CQ3Mxk/oI7ZUr8KgHkz+B8tPpHBueqShfDnVnp3G4AuI8USR8urnPICyLRFO82XIGVQFirsd9KepnC9UBCnPmu+UUD8BIIZz2eNt9VX8uMMnrNbIUZ1rxbeVvXxz3AMYJ7YUix0440Xr2bVHkM0Dm1bsrkNANJ8KuyVkD+mqzbOaxjk6IQE0rRTFEc0gZla1IaUDIlTDTEgJSsUFNaEmTF3ASEFFASFWnKSWBCKZpWigNaqvxMaSmO0bqV55jSZQQ6PscuhZV+kTni9DEs5dd9AImETJLyFR8rImOx+KUQLR2L/L3yl2XeK2dhttI8iQpxTEygPeRc2hSL9WFFOOIOQSx2y8ERpYtgGVH+jTgJUq5m8qVQLHc+HyNOh+BVTH4uwsuYZeUiApkgNeGNE1ZyI84QFIuZbAlSog4rttAf4kwQbqvlM0BHlWkpJcVJtShVEmTFblk2bnUpmZLPtIOx0m4JNm7tclItn60HAnFYHqWsISVTokwJDEjpQijlpUm5GuUcQRl5t2AS83YpmZLL1cOwtBzmebGzO+BYii3AiOw2JNcLExc9A0jUrb6Sqi4ikMEJ8xiko6qspJMCxWKYLUliteBG9CGRkMlTfhdO9UKnjzr8bymtz0OgLFqIpcVRHAQJC6KUO6Sg0nAVNw8BsuNAKMexBXWttxIXaqt+pFlqnkhHFwEyr15KyTxEIEP3nc8AnVN5BemFVKD8/h/vm6Rqb0MAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 00000000..a83176d7 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7V9XZPbuLH2f3FuHR3hg6KUO6/jvNk6J7tbtpNcqLZUsoYzw2ONpENRYzup/PeXAAip0ewGSUi6Wq2n0U2iP9B4ugH++021/3Z886flv998LXcPb/6k377ZrV+KN396sz6Ub96+OVXb5vfL/uG0LY7/1fzb5Ll+2TZ/2GzXx2PRDH3z5j9v/ejZZfhTUb97eKgKS+T5PJ52m7rc7xwnSEKwffvmsK6KXd0+Cyflr/tD1bLh5QCidEm/rOvyteiVFZClS/tpvV3vNrHJ8xTXvlHLp++NWrJEad/K+vmhWn9jpPg/p7/Lu225jlma+fOV3KOW7AgSJRzjz3+87vmr4mXfWGREAKBIlLHZ7o/F++f1bldsGSGQJF0TcRkXgqslRJTtKa6W8bncfC3qfkktXaK8hutDfNoARaKM/aHYxWUAimQ7fiiKl0FTR5EmSi2Pv+wfir8W6239/IMRF9BcJedjsX6IS7EUV8n4VK+runiISmlprrDw/e6xfDpVa8M5YuCQLDl67h7+1iy26yduEQMUqetX8eW4N2bELWD+74n8H4ptURftM3JWHRKl68Zz+FT+K7LsQ6pEWYf94d122/NWIVG6pLgJXAhSJRTF1wEvE1JdIavndS4U6XbgAuNvVRnL/gBRuqQPu7r6YeJKZK270KTL+Xn3uOclmL9e4zV1MwmRF2gJ0iX8VhRVhL/9czr3fzSjo7G4JUi12XL3ZJ6QM9j2z9fNTnxyrvWEZtGry2MdVTKmvCqXGZLEXJe9bKpiXRef918LTvGA4qq1KyYDUFyho4gA/+cx3EGCvDUoCEY77L8OxTtMdvu307YuD9sisoFwPCni+JO7J6Q1vD4+/3qi8hInrP17Mv/j+rH4FM2wnBxElyyvUWXzuE/7Jl70TiRBmz6PZnv64bWoftTPDT9+PkO6cfIu4k51ue3anP3XoTbnPPd/9k9PZGB0vCBR/FndEwFJWaZmZ2GrVf3jQGmfEfOH4F/OoyOiQx7By10eSkwlDDxfTpSiRjzSxPNIejD/XszzFVW1H6EZ8vk8j1s9n5xfPPvh67tD+SF4yFZM+4iAYpztZEJezLR55bo6berBYv4QDom9OnwHRgvHZq0+HYeKdtR/FLeS+7n4Xo+T3Y64Uvrz/lA9WIrf1j+2+/XD0IegBo5/lmjwGPsEw8JHwKfzEjcxDu7JJmc2yQ84KpSkPuaQYHLNUzZ7t01VHgLIp+dZwyEJhhZWg4r1A72HcjwuJCPXQpAsFvXm+Z9l/fy5fCn2ZOLlZGHCcRID6El1EgXzj9E8QV0C8F9//e3j6v1f3/3yy4f/+bT69Ld3Hz+v3v/6y+eP795/Xr37858/fvj06SzgdV2V6y9nEUPGxl/MPj75XC+W+edf//vDLyOfqn9k6jN9T36m/pGpz/Qt/aEGDL3yqf758d1vv334mPZc8cGpT/bnv//l179/5ES7v47iHV3MePZ/6Fm2AD0b9nevZbXfvTQDRkqdEEN7H6MnvDf/UnwvqtXRFAdWX7b7zdfV7vTyBWw/+p8ryuTaJ1x3eg76HwiOSZB/nXFcpLecI5ln9zHAszMTssFb6JQnmgAu4x+tR2W7ov62r76uquKpbJL+H9c9KcHt7k+8OlT77zd+7jPPmz99HcBoSQ/rWdx+ZvcPhQkMX4vVq1w9rs0G8NqJZVje6dnXj8WtLJnid/Ondvnkqnw5bAuzVITl2qQH51je3pItMt54SrkpVvtqvdleF3gnNMObP3cTS/fNXsFOzpWBGbO6xbPCHK9aHw5F9e6nn9lE7kyRmq2ZPaYHbyOCENk10mx/Q+NYH1u/6pFKkF8l3UX6ocI71Ne++d/Wu/WTNZi/WUcd8PbEkKvn30Tkv7hoPGT+Q/JrpNvCiylU9IiFdNfIM6bTI6oluUbKP3s9NaS6RtZP+/2x/uUvn3uEAbJUaUW1yaWIyDkTjJIAQXDTGvzpz//dgavaf49iLENRbshrELbtH4pbQEBvNinDESTxDmuhJHdPMpQ/UOjPsFEOA9MX3VJkUU3I6SIXWVzOZ7gxM2seLceQxStwsQ1fi8/BdfuPSnGssFY/7B4O+3JX97CbANI/ihmrip405FCGJXVemKVLl1QjpJQR1JKNksPZ1sfieGgcjUoISbp06/Ic+swL0g1Fbn++dHz2OQskSngZOJx9E0x0YzfRt3UTHbpJflc30cBNUiUNchN9cZMRcmib6nWSgCrVqnodpEM1zj3aVuU+BwnJEl4mZMC+TZfsxm6S3dZNstBN5nd1kwy4SaqkQW6SXdxkhBzOtnodBdGlW1evsxB0Q93Fnu/h3QT+edQLwIHEc+M/39YdxE29QYTOcE9fEMAVUuUER7oYIS3NvTxNXBwtyc/+3/nsXMTJukSjDLQ7nDBTmmiob31qR/PuhShGvQAaSzw9QXFbP8vkTR0tk4GnybtmZ06Y87V0Sb3OZsQYomR/PhRF9fNDnwxH9Ud9R6dupHivHjNfhFsPcOqrXHqAQw925/Frz7AdywC1Cj05U42f7J+aqMUHHvDXUVMMxhGzi/564xz3tiluGGrumuCCQHPP9PbinsOlYP1+tIe+Gz2Wm3en+rkZVW5srY5X+pAhQ1dMfFr4YrD8KWGS0UfirC/vDRHqUd4R4UNOXJT6xkv19LZL9TT0n+yeDuSEtR6UKqltV+lbSqeTM+Ef74nZNILO7jrileDO7empKp7WdTHUyuMDxu3uoqyo/V7vgJua+y1tfRLS3cvKJ4DobvY9gVR3Mu3JhWa8Uf/lculExJIJqlHmS4wnbJahunG6eGOsIgQr7rqDEgCtSBU0LCoLAaJycq72sj8NmD1PdTds5AKOpO2ioFlGdlIUWbKTRHZUHNmN3WQY0lAVm6I89ChATlqyRHTq18ulNXyI6hKNmvzucGLqaaIb77rmN41Pah6CqYu7brzmAE5NlWS24Ph+N0ZYSHqnGGVeylIlI0qDNpPzC4Q7YuZoL4lEKYIq1U8iMYqhurGnLAZ5yrAVTy3AipfcYlGtd8e1PX/2cUBgbGSSI5KAvv4krks0FuzrT+FoohsvTcP0PjiDW4QRcpoaSgalcAsQIVMlDcp6Fpd4kiqn3G22pwdzrYO5baEnY1xMuuQpQh9P2+3n/WG/3T/96JOIaK/ymzhGflViR4yPu879YqYchko1qty/wPs3aF4TQJei6317bUifGECXVjTa9klwJNcYUC8axJEmmlIvAhQjvXFAvm3KKsKU9a4ZqwAZa6qggVvqOUgwUjHVQZH/kkmmJZLOXAgLdn8YWhHo2N+gCItor3OOQdGWoB1cPQGX6fKOT1CNei1iPPFCDNWNixo3dfSw6U3d089By1uqnIH1DODl99wvXlrrRrwPY7oRx6TIko034o4c2W3NdzbIfIdgWrNJNXa7RhnTp/DiG1oSpr0mSxmSnlyXlwxJSO6XiQzT8OBMZBZEqLt25TpZLkSlChqYicxAjEqNhoMykdk5SKW1/14sZlDucGXSMChbuCPing+y3WN/yBD5pPcCtZsYUg4MKbUT7rg/VZvitwHdWc1bhbQp4h6KY13uXLvMIJnUgPT3HAJsn1/0OmgbPPhAqeSIFNFf0MdMGHkXsrQIZPL2n81FNn2CQtIrHOLDYb95HugTnjZJXJMOnarC3FnWKy0gTYux8Pr/eIZAUI6OtgQPJuQylDeGxG7bECDR6YW7Hl+Q8PzCPbcbEpwwGCEHq7+9SIHXepfgxjWjYQli48JlT6nTJlFl+rER9lIxRtrgm8TiYl/d9fKrar176pWJidOKCL3XlTHSoyOTDH391FNSbhLWhib9KFDn4jNGSv9tZx1BCabevatG9XXA9N9lxt4UNvwZht8Phh/qujvBrnjCnpvARj5n5z64EU/WewvcyGep+7s66AepB52au9EdWCOea9zNV2MtjL9fbIx1Db9VbKw2I7dxjdHtiDu4Rj4hfe/WiGcbdttWkl65O+9Gq3boTXdj44ZJiKsXa9G9c4eJk1bM76vDfrstd0+rJpktqtd1vJJqFlBySIrwl/X3dtUflKx0yROT1Pcmr4sUWtCfb5ugDjvM1pvJ6ElLkogcdC4Qp4UMuTe8dyksd6syDsPoCSBLkbItX3umfdKSpM3X4/q0NeFy/1o+9CS2ZtI65EkbiPq5Sc83692q2QKujMC4WIo+1S0fi2J1aFLzp57DuHrSpU6V2SxG+6qsf4wUzgxLeYqd/QTvyiY+K/tvcfEUfYpcc4/bcKld6iQIz0bSug+A0pOAMDHifqqrdd1kQkXsbD1FM6YXAYJJPeUEivQqmKuntMCRDn09/0WGyGthklGvgwdT580IkhvjdINWxgHlEdn3oZCeuBt8BIQWEP/ERw8ca78wGIVhIcVYu4RjaXPEFDdW47Ay12C4NQ/h1tQy1DC4NQdw6z2vfpD5BW5NlfN/p/W2Wff65FzIxhursZQmeO2KDfyS8cVUg78PDWZm0Lt2j8cxPf99xAJgzToe+AOSJMeKB/oOyY1da1gf5qajMZrZBBIm+VRHi4ygM2H69UXmq7Jx5UKKsbqFY2nVYooba3bY4tdftpBy4omSMmAHi/aJuJBdZTZDytaNNII+bY94rItduXsaKJagT03uB6w8cgIJUwV1vuUZkfV+GNAcE4evLB8ilhiTKt7fGT9ELKBNgjFcqCxfm6V0QFOfcUNqRFKB7fhhWz6VX/qnN6C8ogvivWs5+K1ottY9sV1OmDHJOg2v4h+k2s6Qaw1qlPTumCvKqD+Z3XavnkPaK8S9fy42X4+nl4ESAXmyUPvUv1XF6yjZ1KikPOLDrtGR0VlPqtilG5tTdDnQmQVNNyLxxR9Lj78YRz329Tg+9EvGqG/cATKs3WdXPG1t7vuP9fbUx3HSoU4xf/el+YESMXGawP8d/oqYOEXgaTfqHbvkKUK/lTuTpb3vP+gvJoh2fASxh7hfi8532uHVZwHFUD8GH3WP3W6KiUZ5bXc4eccpRXTjY0a3bcnLwpY8eddvNWSgJS9Z0pA7SIW/gzS5hX8dP3jbSGhIkg8jfNk/xBOkhr+huesdjdmlbzFdGes63vNrVOFoEhPLnhttxaSlGR+P/lxsi7po/TUCKpN0o4IHyYGIHyzdbUPIbe+ICK+IuOvdi+CCiHueEr5cD5EspSd8LCaOIikN9/bxqfxXZL2jCcdmqgQLOkllCG8M9d322l2JvlN014t3JfxOUXJY77GrRohZlu7a7Q4+gzTiNXgTjm+5KMprjDi+1eIob2zGwxqZjs1D9PCZtDQJ5an9oTdl7tCMmvjOaGLKSZobN43d9gIOHV7AgVV525ihwQ0cyZKGOLW+3IuRLqcnNhkZTWxK+3TaxVAi4aJLlGiwkSBBE93YZIclaL0TbrOM5NtQe/coDX+7R0ldbap2t/+uxzYXkwtlYhG00dq77bY/1SfpxhpRlwNtRzTdjU3ptof+dXjoH+djN45+4NR/sqRB0e9yFj9dTp8z2uNTYzYUrPnGIyBBeIUBxyMhQ3hjEx7WFPXSPkgPr4mnS40kRfG1P3HqEI1TQWc4Nf0k0Y2n/rafVNLok0p3Pf6r4SeV7rkh0uBTRMly+qKHtNEj7TojYCmx0NGlSjXaWNCgqW5stsNggt5Jd5vp1Hy4P39Sk5bmntmTmgSUaeYzLHkiCUcb0bD0iSW8sSnd9ks1Gn2p5q736Wr4pZp73qerwedjkuX0OePUOmMa4oSspScKXp1B0Tz6rfiOEXFY0XBYDiUmgC4J/nMdDb+ZE7RRALtLl9ZpATnEeiww3Y1hv9vWXSS6m/uulRcJ7+a+Z+1Fgru50zZLoTaHNPQEhFdY2JA2ng7hjTt4hq1X9vB6D6OJJxqvAmsn79eH9ZcyOGYBrssNKYZ2eryvinVd2MGRO2U7RKN02h1OHXQmiW6ry9seBgrPAt0VtgYngVLlDD1mncNj1ulX+nlDLHvWvnyCSNOa6R+L3sOj+QSQ3SvYXk5SjdAT7Y6xe3K7VKkOGbsll6a6rUsOqyX1Xxszn9TjTiug9a1nxjHJ6DWtZ64pkhuvY8OQp567EZSclOlXTQ+OCo0YSJsscGjQa+TBqJfaTPC63pYPq9OuLnsuLpGTkDS11apn3e4SJTRZ9azbNNFtbRd/UybNdsV0knylx+A7nEM44q69nwKgEcnfkBpysfIFjEgrNTfB7Sd3+WrPaQBMNTbK4vF0oKWobmyvw75cYA7s9PCxh3qSw5+7EqRPhKNKFmJuFvtlkKCAMlXUXwdMGqC7Rsy77Xb/rf9q4Ys8OCDJTd75q7niftIhG+soHQa0p5BkN3aVYZWFfldRk+d0jQ9xFDXZjbRdoNt/lvXzQ7X+xq/ViGKURtFYQpkExY0PUdy2kTQLG0nxXQM3PkQBGknTJfV/29PIcd/2TE0wN6eqodv0nHRQE0CXIsZe3lWcXoacTW+kdcnvdsDi0io7RlGEI0YCLCYZCqW1V2703qVzxVU6vTfp3A9qv+3HmGT4NSa8CtwYagffY0qWNOCQVCOnPSR113bxy8eYxrxM11D7b6e55nKa/rtp7tgOPrBHb9iNMbMJJExR6/7Lsahe++UAuoSSbLl7iscfRDGuBBuOpUqvXYobl1yHNfkP7hzQYYpx17MqTlibYqRKGhCCGjltCLrnOcdGynkZTuwfaI0l1jiASJLMNdYqQJDc2GCHrZlVcdhX5qy7+/5BD8tJlzypZLKuexPJRtiFbLyON7Z+8M/j36vIh+C6RKP0DIYTKkZ/vfGO57bhKEPh6K4fos1gOEqV1H9SWduTygOyod/fuutY3vzp3/6bIc1f5URNzMM9lsX2oRm6dJIbZvsXc2XTm9/bv/2jMBefGwpH8l/TN2+X07fNbkHMxe+/v136EfYP9h8sWfNgS/E2m0/kfBGQiYCsCXFLSZHJgKxJxpaKIlMBWWM2S02R6YCsiR3LjCLLArIm01nOKLJZQJY3/5dTZHlA1uyplnOKbB6QNUpZLiiyRTi9ZrbFlJxgpAirCVoVoS7MCcmlILUhQnWY5HgpSIWIUCPm0sulIHUiQqUYYHcpSLWIUC/m25BLQWpGhKoxX+JbClI5ItSO+fL1UpD6EaGChFGEIFUkQh2Z9sKlJHUkQx2ZVuylJHUkkb9Yh6E9JtSRORyylKSOZKgjc4huKUkdyVBHZqe6lKSOZKgjs01YSlJHMtSRuUZ2KUkdyVBHBpZYSlJHMtSRibtLSepIhjoyLUhLRepIhToy1w0tFakjFerIlIOXitSRQmHNxjU6sIU6UkYRitSRCnWkjCIUqSMV6sh8QmupSB2pUEfma0NLRepIhTpSRhGK1JEKdaSMIhSpIxXqyLQ1LzWpIx3qyHSOLjWpIx3qyBwWWWpSRzrUkenPX2pFrXgarT52+aHXn1BHJntdalJHOtSRORK31KSOdKgjc/JoqUkd6VBH5pDxUpM60qGOzNnOpSZ1pEMdZUYRGamjLNSRuRJomYm3Ukz0XIeUoY4yo4iM1FEW6sgg5MtMvdWLyVzMQspQRyazXGakjjKUJNgsIaP0noU6yowistlbnU/UVIWUoY4yo4iM1FEW6igzishIHWWhjrIFP5+hjmZT9jlnoY5mgp3PWaijmdXRguQZ6mhmFDEjLWQW6mhmFDEjvXgW6mhmFDEjLWSGcjmbzJGRdhbqaGYUMSMtZBbqaGYUMSO9eBbqaGYUMaNzyVBHuVHEjE4nQx3lRhEz0kLyUEe5ZC0kD3WUWx0tKJvPQx3lRhE5uQ/IQx3lRhG5IClDHeUz/jlRym1zbknyDHWUG0XkZPTOQx3lRhG5JilDHc2NIvKM8o55qKO5UUQ+o3jOQx3NjSLynKQMdTQ3isjnJGWoo7nVEanNeaijuVHEnNTmPNTR3ChiTvrmPNTR3ChiTvrmHO2M7NaI9M15qKO5UcSc9M15qKOFUcSc9M1FqKOFUcSc9M1FqKOFUcSc9M1FqKOFUcSc9M1FqKOFUcSc3vCFOloYRSzI+LkIdbQwiliQOlqEOloYRSxIHS1CHS3m7Gq4QBtYowjSlBZ4CztlMyv3N0hrVLGgd5xTtI2dGmUs6D3nFG1kp4qNOe5vkNYoZJG9lfOJmOWIFm1mp1ZbM5oWbWenVl+5oc0QJdrOTq2+6F3qFG1op0YtC3qfOkVb2qnd004ZOAGprYUeGEQBgw98ticw/GBBBmZ+MQBhYQZmfjEEYYEGcn4xBOEwiCkNgWAUwsEQU9omMRDhkIgpbZQYi3BgxJTGQjAcIfj8TyBAQljYgZlhBEkICzwwMywxcCS5GUaghLDQQ2PXNMiEFGfRh8awaWKkO+l0RzsHQieEdLqjvQMBFMLCEMwMI4hCWCCCm2GkOQtFcDOMNGfBCCHIuCoQUiEsHkGqAyEVwuIRgkEHFQb9rO4YgBDhFcKiEoLDCJHuLDAhGJgQoRZC8WmiQLiFsOgEow6EXAiLTzDqQNiFsAgFqw6kO+101ySM2UQuEGeEYAjN6g4hGEI73dGuhEAMoZ3uaFfSGLPV/AwjJEPoLPZySHUWshAMzIrwDGFRC8EgrQjSEBa44B4ZKc9CF4xRIFhDWPCCMQoEbIiMVR0CNkTmkHZ6vUXYhrAIhqDRYYHgDWFBDEEDxCLDiLvVHY0RCwRyiCzidgjmEFnE7RDQIbKI2yGoQ1hAo4n8b/V0stAKESPVWUyDVAdCO4TFNASNawsEeIiZ0x1TfkC6m0XSS4R6iFkkvUS4h5hF0ssZrpbMIpOGwA9hIQ560pDeLMQhaOBeIPxDzJziaMdHEIiwQAczaQgEERbqYCYNwSDCgh3MpCEgROQqMmkICxG5c7oFhQgIBIcIC3qQM4zgEGFBD0EXJ0SOK102WtL1CYFAEZFHoiWCRYQFP4QiwRaBkBFh8Q9BVzQEAkeEhUAEXdQQCB8Rcx7EEgghERYHYYwCYSTCIiGMUSCURFgsRNC1FYGAEjGfRYwCYSVizrodwkqERUQEXbURCC4Rc6c72kcRYiIWEbdDmIlYiIh7INhEWHBE0EUhgZATsXClZaa+ipS3cNVl2kMQfiIsSsK9H1Keg1BoC0IYinAgCm1BCEURFish9YxQFGHBEkHXsgRCUqRFSwRdzpIISpEWLhGargwjLEVavETQRS2JwBQZAVMkAlPk1KmOriUjNEVaxETQZTCJ4BRpQRNBV8IkQlSkRU0EXQyTCFKRFjYRdD1MIkxFTvl9uUSQihT8vlwiREUKfl8uEaIi244O0k0lglSkg1QI25QIUJGuqYOu9kmEqci2r4NpbkC6c5gKXfOTCFORDlPJaENGmIp0mApd+ZMIU5ERTEXiJo8IpiJxm0cEU5GdRo+Y7nCvh2R1h3s9HKaS0X6H2z0cppLRfoc7PiS/QZC450PmfFIhcduHdKqjHRp3fljgRNCVU4lQFelQlYx2aISqSMVDmRLhKlLxUKZEsIpUPJQpEaoiHarCGAVCVaTiMk2JIBWpXEcV7dAIU5EWNxF0fVYiUEUqPtOUCFSRFjeh69MSYSrSYSrMRCBMRVrkRNB1YolgFelgFbpULBGsIh2sQleLJYJVpIVOBF0wlghXkQ5XoWvGEuEq0uEqdNlYIlxFOlyFrhxLhKtIi52IGe0hCFiRFjwROW1GCFmRFj0ROW1GCFqRkaYRicAVmUV8D2ErMov4HoJWZMaVESTCVaTDVXLa3hCuIiO4ikS4isxcPyNZMpMIWJEWPKGL+RIBK9IBKzltxwhYkRY+oWv/EkEr0kErOVk4lAhakRY9oVsFJEJWZARZkQhZkRY9YWYNISvSoid0G4BEyIq04AndhiARsCItfEI3DUgErUiLntAlfomQFWnBE7pxQCJgRVrwhG4IkAhYkRY8oVsCJAJWpAVP6DYHiYAV6YCVnI5rCFiRDljJmeZQpLnceR0d1xC2Ih22ktNxDWErMucLQBJBK9LCJ5zBI2xFWviE7p6SCFqRDlqZ08EVQSvSQSt0n4ZE0Iq08ImgWzUkwlakxU8E3a0hEbgiLYAi6IYNidAV6dAVumdDInRFOnSFbtuQCF2RFkMRdOeGRACLdAAL3bwhEcAiHcBC929IBLBIC6IIuoVDIoRFOoSF7uKQCGGRDmGhGzkkQlikQ1joXgqJEBa54EtBEgEs0gEsdP6GABZpQRS6w1AigEVaEEXQDR0SISzS4ihiQVsRAlnkIrLPQxiLmvL7PIUgFjXl93kKISxqytXOFYJX1NQpjm7YRviKcvjKgu7ZRviKcvgK3ViiEL6iHL5Cd5YohK8oC6FIurNEIXxFTfnNgkLwirIQiqS7UBTCV5RwJzHIlVohgEVZEEXSfR0KISzKgiiS7utQCGFRgs9ZFMJYlMNY6KRFIYxFWRhF0g0jCmEsysIokm7BUAhjUcLpjzYjhLEoC6NIugVDIYxFCadA2owQyKLcURr6vJNCKItqT9PQpoFgFuUO1NBNDQrBLMqdqaGbGhRCWpQ7VkM3NSiEtCh3soY+/qQQ0qLc4Rq68q8Q1KLc+Rq68q8Q1KLcERu6QK8Q1KLcKRu6QK/wORuLpki65K3wURsLp0i65K3waRvljkTRGuwcuLEapEveCp+5Ufzip/CpGwupSPoUlcIHbyykIumCs8JnbyykIumCs8LHbyymIumqrMIncCyoIumqrEKIi9JOgbS2EeKiLKgimXNVCHFRFlSRzNEqhLgoHYmhCHBRmq+oK4S3KM1X1BWCW1TbxkL2vCgEtyiLqEgl36om1VEokCO4RVlERSoyL1IIblGuj4XKHBDWoiycIhW5q1UIa1GZ0x1zggzpLnO6o40ToS0qc0cSaeNEcIvKIs6HABdlMRVG0QhvURZTYRSN8BaVcWVZhcAWlc0jWkZoi7KAimROySG0Rc2c7mi/Q3CLmvE4mUJoi5rxOJlCaIua8TiZQmiLsogKNxUIblEzDqNWCGxRFlCRdK1XIbRFWURF0tVTheAWNYuknQhuURZSkXSlVSG8RVlMRdKVVoUAF2VBFUlXWhVCXFTkSI9CiIvK+W4IhQAXlfPdEArhLYptZFEIbFEWT+EsAoEtKneqo8MPQluUBVQkXRhWCG1ROb/bUwhtUfNp5JER2qLmIhK1EdqiLKAiNYnYKYS2KAuoSLo8rRDaoubuHDcdKRDaouZ8N4RCYIua890QCmEtas53QygEtag51w2hEM6i5ouYOpDuLJQi6fK0QjiLslCKpMvTCuEsahFxOwSzKIukyIzecyKYRVkoRdKlbIVwFrVwp/DpSIGAFrXgywsKAS1qwbdtKoSzqAXftqkQzKIWbKKCQBY9jbidRiiLnjrV0ceoEcyiLZgi6VK2RkiLjjSyaAS06GlkudMIaNEWS2EihUZAi57O+EihEdCiHdBCF8k1Alq0BVMkXSTXCGnRkUYWjYAWHWlk0Qhn0ZFGFo1gFi04kEwjjEULFVEHAlm0cG5HH3BHIIt2IAtdJNcIZNGCdzuNMBbtMBY6UmiEsWiHsdDVd40wFu0wFrrwrRHGoiXf/6cRxKIl33arEcKiJd92qxHAotk+Fo3QFe3QFbpMrxG6oh26QpfpNUJXdKSPRSNwRTtwhS7pawSuaAeu0CV9jcAV7cAVuqSvEbiiHbhCl/Q1Ald0pI9FI2xFR/pYNIJWdKSPRSNkRTtkhSx8aYSsaIes0IVsjZAV7ZAVugVBI2RFK257pxGsoh2sQjcraASraAer0OV/je820RGvw7ebWOCEriFrfL+JA1Vy2j/wFScWOJF0+V93bjnhN+Ya33NikRNJV0M1vupEzyKKxredWOSEsSB834lDVeias8ZXnminPdrxELCiHbBC15w1AlZ0pIlFI1xFO1yFmTiEq+iM3+FpBKvojN/haQSr6Izb4WkEqujMuR29kCJURVvsRNKVbI2AFZ3xm3ONcBXtcJU52UCiEa6iHa4yp1ddhKtoi51IuuqtEbCiLXgi6aq3RsiKtuiJpKveGkEr2kErdNVbI2hFWwBF0lVvjdAVPYsseghc0Q5cYaYZgSt6No9NM1KgQ1fo2rtG6Ip26Apde9cIXdF5xPcQuKLzyKKHwBWdRxY9BK7o2DEhjdAVbTEUSTcLaASwaAew0M0CGgEsOmdXPYSuaIeu0G0FGqErOnd3rtEuguAV7eAVuqSvEbyi5xHdIXRFzyO6Q+CKnkd0h7AV7TpZaMhfI2xFz9m4iZAVPXeKo70fQSvawieSrv9rhK3oeSRuInRFO3SFLo9rhK5oh67QjQUaoSvaoSt0Y4FG6Iq2CIqkGws0glf0IrJFR+iKXvB1II3AFb3g60AaYSt6EakDaQSu6AXrdgha0RY+UXTPhEbYirYIiqL7IDSCV7Ipn2xmCF3JLICi6LswMoSuZBZAUXTPRIbQlcwiKIrumcgQvJJZBEXRrQ0ZgleyKQ9qZghdyaY8qJkhcCWb8qBmhrCVzGErdK0ta7EVeyfva2Gumv7Z3c27XJ7vRf73m1V7YW/zJpapubq3SRD/9O//vH3TpDH2v81C5P47c/81t9W4H0L4Hy2puaTC/VCeuMnT2x/z9kfm/zTzfJoltP3haeatTHMcsP2RuR/SSzdHm9wPL92c/XA/lPA/WobSv5T00qWXbvoq3Y+F9j9ahqYVyP0QLbEpxrsf2v9L5v9lJvwPP8rPnMH83Y95+xYGw21/tM+j/Xtp/14GvXE/5NT/8P/iX9Bs3Nof7WNo/6YmZ3U/Zn5U7v80P//wNItWunHO9od91P9c7mk2/2dMbO2/JwUNKAcGlHtVzSTH4umpKp7WdbF5Xu92xba234A+HvwF4xe+5qz8mbFwUzyaIbZ2c6YeMGWfcluug5c013BcxilvmmoRY0C91HQO+Eh2osHwzitMF5DFjGWxDUbp/DLKnFBkRrVfQYIzBsXl3qfnZ8vSHKvLRzcu3EwCcOZmuuJaY2Tn0TNZ+28TQV4zyIt9pZaF+cdg/Byo1HunzFk7O5RwMBjbvsSCfYdDWZxvkL9wWEDznvp5FT78ec83N/q0xuYjrPYxN/P/MvPDvZ+bI+ht9PRRz0+29JzNIbE2MvqQ5EOA8jHFdDa0oe0c0Xz48yZgyjZt2DpHKx9lvAgDEbT24v/FB3rtg2/GW2Uzg1W1r6rz1yaAfS6ARckF69GIRcermk0FYKN4Nu13ioEiYUiZZl6RXgF+Lsx1S60iz+uh17EP2OZejVaR3g7mXrV+lqVfe6U8r3V+QfOzbBqAW0V6/fnVT/nVT3lfNiXTVpF+TfAiDHbeKtLrzy962tuB9qam/UJt0hV6+r64T3cGEz8D0yc1FxG/rI8FFU8FjKeaMyAwuqN4AeObZp98u998Xbmvj4PBcyBeuiWVGrx/+BFELgWMTfn0SJ3XZnYBDj/ADBjOwEsYvLrNDLj52KyPz/YjMRcWGoQjVgvNGlsGtm+ahy8T4OOR6R2OMFiVoQ5hIDanTCJDOSXm4P1lzr62SxHC5Q2kLyLj/L4dudnuj6eqOBRVuQ/XNaGBRmXk9Q2b4rDfPIdOAO2INcJ2OJo+qeEb+CDjUz+Rn1cCHy78GiO9d0uf20odmX0jOsz8QOQ9p9Kznsk/1uv6FOZWGUxNJOdEZu4LSoNQgdzqDQdTYSSDZizY+e9y6VhipiGnIS9DrmpZBueEtSeCTfeJYIBlU07Lqmj2iz/q53L3FIQGYJw69kaNa3QiJIxMkh+93z2W1cvafL49NI4cPn3O+ue+mYJNjZNNYBpqyuVn7djytax/dK3TtO0Dz+byi4bJsa5O5js2we4aqNGnUgt2Euznjrb7p6ciZALiY8Y6qB3cSU40GMs792Us4RymQHzhIdlp7DDBlihhlNNqwNNQriHhhlOr+GQGXDrPAwOYZvdyjtO3xrqp0GEwJqAd1kAvTPBjGOAJcGB9/fxNWPAGC6jenPPth+LLKfDoDLx4xpn0Q/G4Pm3r1aHav5YPoUmak5xgzeZZbIu62Xkdj+snlLHAMMm9cjicMk0Ft4CRNyH4dKxB5ZAXp0jHq+tn0Ci5VQiMpV4mh36mOXPsMunaNfQzNmI8FMdNVR5q+xE6YBsgYPtNn/QwlvaZgmaTlIZtXe5sJCc27eZqCqB4XvNnJuZ7iCjjmcHVWrNaPz3uT4HVwvjDbvSL3WtZ7Xfm3zpgKVzM8vOmiwtBRbXJpWgS9mC3CAxlweVKdqsaKAW8sd/kedRR8mzaDztT4Al8Ds1mzJbDcbPerZqd78p8Ki4IAlAPc85jHot68/ytrJ/Pn6YEEwqeYsYZw+N2/y14eK1g3HazIKacnT+ettt6f9g3C2sQPM1dZgAS44fvHqi0E8I3XOAFY2mIE3i8mHF2RHDp4ppwHzzjYgfkRKadCsKcrFVQbDpPpGBennPR4qmoSVQZDh4wlEwU5mBx0Kx1UWw6EXUOQ/OMU7dhhZFjMDA2B2ZYOANAoZxhXAaSygx2RooLk10mXYhEQkacn3tG9LNAkIwN2ZhF90mgw+jIk7RIUxg2gA77R9K5J8RZMs4/CC5di4KZWxYxDRK0gBWA3qHkhhcCDmxO3+HR3VzC7R2b0l/4kMYxgwCQisxq31YXLidS9U9qGHIUtPL+sdS0Kggmsihyl0nnTeC+TSwi5hoN53ChlNNIIO2N5hrm69N+m2vLcCEP6LtDOVCzDAEJyYLNHKvuu0EbnkaCbciOxm2gBbJ5Acur618wR2FrXIafQVCeTtUa5/MyeKKBDKhZz6GXstsThlMXsYWPxe5RMDe6AgQfbDGWVbcSBJ9sEZmx5n+rH7v9Q7jKwLxHDRpNrjQSvJSKBdYun85aA01AxZ7puVg3G/3gdWBsnkUC2vP+UFH7DDCX/OBy97gP5jDA3OLjyNmbwgILiwojDp15g9COii20Hlo4lv8KOcDNbiQYwPEkzAECnsoirkcw6uIcINyZw92DmJGzDBcpxQL/DKfOc0EIxZyfjnCrq3ITOh3Ud8RKDaTwWhB2Csf3DSeqmBDB44c3m9+nfbl7orIP2J/BYisNDwOHBA8OUauecZRpwbq3ziOmBRh0VLeAqTVbwWuZkKYEuyH0PGJKkEP3OeCOb94zG6H+oatHkhM7kFod4RTIRZ9oblWE0yDZQoHnQq+G0L3ZlgrMohv7oG/HciyXwRwaj0SoNhw/aDhZewhw1ciEdPl0yw8Q7hcRUwe8SGOF+KNm0WuaUfepoO/EFok2VaybGHSscfyDC0TvLF140KkHXH1jyy/HrZuABOE5EmC7uDrUWexR+HIRVNZgFl1MHaophjy8Nl6FUnCVweWbGWoSqBAhgKbv6/qaXRjN+JVfWVbHl3VVr5qEt67Wm3pFrHjQiNm12zK1E7OytAH6C8v2bLA1HL7s98d691hjKByEiEVsWqj1UsI2SMV6MxyOxMMSVvTxHywcT0QnCKKwVQDD4WW9a9If888v+4fTNrQs2FqqJBcqLZtTs188FrsH/CZAE2wHnGGwK+pv++prVTw1DluFpUQIaCs2DhFc8MMAR2H7Oi2bZs+CJwbzAs/Ebuw8r+P6EU0sTCjZrS8cTk8MrDGy/bYUG/w2wOPYXrEzn3r9tXhcm4aCDh/wQOz+1PAxz4LHApNl8Sk79uFr4KvAWdjsxozrRHAJW54Vu4Sbsd+q9eFQVPiRgaOzSFgzPAwPYczlZqlEFViYhfrWSc3WlcvdZnt6MAm9aZ5BGBUE39ne4IbD/gW12wjYiifZfgBLbdsSD1XxunkuNl+Pp5fQcmGIZEFeS11Uq8bimiXDNTruTi9fwn0GRH9856hkd48tT8ssfCS4XZGcIbXD6ZeC5sR2izVhcls+lV9wrIWJiOTsvzwaD3wu1tv6OSwZwiobLxqMJlYNuOMSLChLccFJCdxzCBaUDThRKdICvhWb6pNsOk8E8W8WSnWsqmYfHs5uAJ73jyXPV0DcnG356jLpnrII2gpZO78wIjdj8LiDYOFggkv3eaDVsECw42Q9GffCwZgyZDQ5u9Dg2DZJik33fWD9vMeXWlb0DMPCYo9HIz7dZ4LVRXZft13XuA9LQe1krCduy8dOg6SEgVWzxa9tk1AUu2alIA/CwKDKqmVbvqIEHgLdcy4Qvay/t4tCtd49IRAfFmLY9jPD4bEoVs3SvnpC56pgtijn3JQbDs0uel+V9Q+eFVw25+zDUM1osMqi/IE4zc7kC9gWDdhogVdkd28u/V2VL4etTYc7ZRw41f7EhWRbRhxQGW4n4U565k/q9HBg936wK5eF63bF09Z25b6utyeECEC8jd0TtzuN0NhhYseG1HbkisroISLgz51Ktj8EczL9kN9DfuBdfKOcZJtEWn5sXQxWTDKWSRPNVia9p18QxAN/zEqyTUGOl9lurF7lqt1yBOyAsv0ZFZlzQW7/5VhUr2j1WUB0m93J7Q9NYCXaHYIzm/1jycI8XD5ZhLrLpNvWBJdANmgCRnSfFXwldi9IcOk+D1yz2P224WTRgya8kNWHAN3imLTli3CzAiMBe3DpsK6DAy8ywNv9ObiMzRgPRfF1vd2SwTs4gjVsPIU0w1Moms2CaUYdtBAiQ3roW5HwJWyw0WzbBMOpCzbDZIMNnoZbyyr0Ylic6B9LzjLcgLG7+S6T7gxDA2LRQ8CInl244Wf3YgSX7vPA0hObAZqaC9UVDdEKweYudjR1rFrALZzivbAZT56UETA+KxZyIFqxgzZYfyWBOJ861f6YuD/Gqtlm5UMTWTrFTQi99Q0kq5vQD1msDHHolhWhD7IAq+dCGZqC+1LNFvYwi+5REVgTYFGlw/7ABUsYrdkJDYZT06qDchO36SL5dMv+EKRidwAhL9qXIY7O5hg0o647Q+yYN5z9gYqTsDDCLiTnoeQEwzCZR96lJ0rCdV2xRx4ufOg2D5hxs53cXSbdp4HunLNOgEvJEp4Z0eyM/t9pvW32h2FcgxLZw1lVsSnKQ3jtBWxBEuesnhVuWTRZ77oO3xjG1fONB2xV3nOhjAquvoo9ylcVD0XxEmnChOki/zJdJuTxBThHGee6EW7dYwwwTWd3P44jua2EpsquGG48MTtBaxQXXavif7lNLbQ2thmnKl72r0X3ipkAuYyO/bI+lpv1qX5u/tT8iLVZQtxPsIWMqjjsDTJG1a4hhJmxKZLZi3Yr2HBXwV6244c2YXn/DTdWSYjqaLYB0fCgMA9Y+2evEDKDTVWV8DodHCHhxj989deLBNVheDCUcw5GLvQs9swxGEs2DcL1kD2T2GXSbRiEayHbQXEkDr/Ayl3PMPJyj6Ajn5/COnpfUtB3zkJNndZN2HmiWPDkuD9VG6qhUMyCE66s4drx1BlHaAG89jrn1eE+xN/54tE+qfw6xm6YHMO6+B6sY3BvzJ5VOdbVui6eSjbVE7CSK1msol4/heYHFaH9FSP+yhzl7z5S/pY6Nfe3GM1904y/10j7e5Y0e8CjkY4WTAgrn89cstmLW1UCDjAxlewW3g1c2exnta/Wm7B0CU8e+c2UZDNDx8wNDawKpqZsQCMOasINopj6u0WEv5zI3yQi/PV0Qvsf/lY64a1QzPy1Vf66OOFvIBL+BiLpr0+S0v/wt9rI87V7U38llb8QS50voPH3KCkvQvn77pS/4k/7a1C0F6H9DVvaX9Wg/bUm2l8Qptnmh07jAzQcb5LSv7tmXdryOV/0E7aiwLuSNAt2NX64O6437pADkdnCci+7m62/rw777bbZkDYD66Jqsp3QLYJNDmfUp10kV4O5Mdu0eKpLBFUGm3FmVCOtfFidmvQoeGoJoWzN3kbSpkFUwQsGdbYR/1vxRQUVIBDB2LpAM+i4x7ED5sNscfNbuTOVwQ2+uk9CaFSx+aw5mv1Qrb8FTwweuGcYlXrALiPNrp2IQ/eIJNQ0G+o8F7qtHBa92JjN9B2BtIctcX37Pq4WCCeWnRfHs32qIVzhIWNunkY+KAhedI3w97dvDuWhaCJEQ7T8/T//+f+GjMIhmn4BAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 00000000..778b9492 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1412 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +.tsd-generator { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/classes/HoprSDK.html b/docs/classes/HoprSDK.html new file mode 100644 index 00000000..f5f8286c --- /dev/null +++ b/docs/classes/HoprSDK.html @@ -0,0 +1,6 @@ +HoprSDK | @hoprnet/hopr-sdk

Class HoprSDK

Main SDK class that exposes all functionality of the HOPR SDK.

+

Constructors

constructor +

Properties

api +flows +

Constructors

constructor

  • new HoprSDK(__namedParameters): HoprSDK

  • Creates a new instance of the HOPR SDK.

    +

    Parameters

    • __namedParameters: {
          apiEndpoint: string;
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: string
      • apiToken: string
      • Optional timeout?: number

    Returns HoprSDK

Properties

api

api: ApiAdapter

flows

flows: FlowsAdapter

Settings

Member Visibility

Theme

On This Page

constructorapiflows
\ No newline at end of file diff --git a/docs/classes/HoprSDK.md b/docs/classes/HoprSDK.md deleted file mode 100644 index e9d35dd9..00000000 --- a/docs/classes/HoprSDK.md +++ /dev/null @@ -1,59 +0,0 @@ -# Class: HoprSDK - -Main SDK class that exposes all functionality of the HOPR SDK. - -## Table of contents - -### Constructors - -- [constructor](HoprSDK.md#constructor) - -### Properties - -- [api](HoprSDK.md#api) -- [flows](HoprSDK.md#flows) - -## Constructors - -### constructor - -• **new HoprSDK**(`«destructured»`): [`HoprSDK`](HoprSDK.md) - -Creates a new instance of the HOPR SDK. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Object` | -| › `apiEndpoint` | `string` | -| › `apiToken` | `string` | -| › `timeout?` | `number` | - -#### Returns - -[`HoprSDK`](HoprSDK.md) - -#### Defined in - -[src/sdk.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/sdk.ts#L15) - -## Properties - -### api - -• **api**: `ApiAdapter` - -#### Defined in - -[src/sdk.ts:7](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/sdk.ts#L7) - -___ - -### flows - -• **flows**: `FlowsAdapter` - -#### Defined in - -[src/sdk.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/sdk.ts#L8) diff --git a/docs/classes/utils.sdkApiError.html b/docs/classes/utils.sdkApiError.html new file mode 100644 index 00000000..cad62762 --- /dev/null +++ b/docs/classes/utils.sdkApiError.html @@ -0,0 +1,22 @@ +sdkApiError | @hoprnet/hopr-sdk

Class sdkApiError

Represents an HOPR SDK API error.

+

Hierarchy

  • Error
    • sdkApiError

Constructors

constructor +

Properties

description? +hoprdErrorPayload? +message +name +stack? +status +statusText +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

  • new sdkApiError(customError): sdkApiError

  • Creates a new instance of the APIError class.

    +

    Parameters

    • customError: {
          description?: string;
          hoprdErrorPayload?: {
              error?: string;
              status: string;
          };
          status: number;
          statusText: string;
      }

      An object containing custom error properties.

      +
      • Optional description?: string
      • Optional hoprdErrorPayload?: {
            error?: string;
            status: string;
        }
        • Optional error?: string
        • status: string
      • status: number
      • statusText: string

    Returns sdkApiError

Properties

Optional description

description?: string

Descriton of the error

+

Optional hoprdErrorPayload

hoprdErrorPayload?: {
    error?: string;
    status: string;
}

Error Object

+

Type declaration

  • Optional error?: string
  • status: string

message

message: string

name

name: string

Optional stack

stack?: string

status

status: number

The status code associated with the error

+

statusText

statusText: string

The status message associated with the error.

+

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructordescriptionhoprdErrorPayloadmessagenamestackstatusstatusTextprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/docs/classes/utils.sdkApiError.md b/docs/classes/utils.sdkApiError.md deleted file mode 100644 index 9fd18bca..00000000 --- a/docs/classes/utils.sdkApiError.md +++ /dev/null @@ -1,238 +0,0 @@ -# Class: sdkApiError - -[utils](../modules/utils.md).sdkApiError - -Represents an HOPR SDK API error. - -## Hierarchy - -- `Error` - - ↳ **`sdkApiError`** - -## Table of contents - -### Constructors - -- [constructor](utils.sdkApiError.md#constructor) - -### Properties - -- [description](utils.sdkApiError.md#description) -- [hoprdErrorPayload](utils.sdkApiError.md#hoprderrorpayload) -- [message](utils.sdkApiError.md#message) -- [name](utils.sdkApiError.md#name) -- [stack](utils.sdkApiError.md#stack) -- [status](utils.sdkApiError.md#status) -- [statusText](utils.sdkApiError.md#statustext) -- [prepareStackTrace](utils.sdkApiError.md#preparestacktrace) -- [stackTraceLimit](utils.sdkApiError.md#stacktracelimit) - -### Methods - -- [captureStackTrace](utils.sdkApiError.md#capturestacktrace) - -## Constructors - -### constructor - -• **new sdkApiError**(`customError`): [`sdkApiError`](utils.sdkApiError.md) - -Creates a new instance of the APIError class. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `customError` | `Object` | An object containing custom error properties. | -| `customError.description?` | `string` | - | -| `customError.hoprdErrorPayload?` | `Object` | - | -| `customError.hoprdErrorPayload.error?` | `string` | - | -| `customError.hoprdErrorPayload.status` | `string` | - | -| `customError.status` | `number` | - | -| `customError.statusText` | `string` | - | - -#### Returns - -[`sdkApiError`](utils.sdkApiError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[src/utils/sdkApiError.ts:41](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/sdkApiError.ts#L41) - -## Properties - -### description - -• `Optional` **description**: `string` - -Descriton of the error - -#### Defined in - -[src/utils/sdkApiError.ts:35](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/sdkApiError.ts#L35) - -___ - -### hoprdErrorPayload - -• `Optional` **hoprdErrorPayload**: `Object` - -Error Object - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `error?` | `string` | -| `status` | `string` | - -#### Defined in - -[src/utils/sdkApiError.ts:30](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/sdkApiError.ts#L30) - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1077 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1076 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1078 - -___ - -### status - -• **status**: `number` - -The status code associated with the error - -#### Defined in - -[src/utils/sdkApiError.ts:20](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/sdkApiError.ts#L20) - -___ - -### statusText - -• **statusText**: `string` - -The status message associated with the error. - -#### Defined in - -[src/utils/sdkApiError.ts:25](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/sdkApiError.ts#L25) - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -Optional override for formatting stack traces - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:28 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:30 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:21 diff --git a/docs/functions/api.closeChannel.html b/docs/functions/api.closeChannel.html new file mode 100644 index 00000000..1dadbf8d --- /dev/null +++ b/docs/functions/api.closeChannel.html @@ -0,0 +1,8 @@ +closeChannel | @hoprnet/hopr-sdk

Function closeChannel

  • closeChannel(payload): Promise<{
        channelStatus: "Open" | "PendingToClose" | "Closed";
        receipt: string;
    }>

  • Closes a HOPR channel given a payload that specifies the API endpoint of the HOPR node, the peerId and the direction of the channel.

    +

    This operation may take more than 5 minutes to complete as it involves on-chain operations.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          channelId: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • channelId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        channelStatus: "Open" | "PendingToClose" | "Closed";
        receipt: string;
    }>

    A Promise that resolves with the response of the close channel operation.

    +

    Throws

    APIError - If the operation fails. The error object contains the status code and the error message.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.createToken.html b/docs/functions/api.createToken.html new file mode 100644 index 00000000..26aacf13 --- /dev/null +++ b/docs/functions/api.createToken.html @@ -0,0 +1,12 @@ +createToken | @hoprnet/hopr-sdk

Function createToken

  • createToken(payload): Promise<{
        token: string;
    }>

  • 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.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          capabilities: {
              endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
              limits: {
                  conditions?: {
                      max?: number;
                  };
                  type: string;
              }[];
          }[];
          description: string;
          lifetime: number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • capabilities: {
            endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
            limits: {
                conditions?: {
                    max?: number;
                };
                type: string;
            }[];
        }[]
      • description: string
      • lifetime: number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        token: string;
    }>

    A Promise that resolves to the generated token which must be used when authenticating for API calls.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.deleteMessages.html b/docs/functions/api.deleteMessages.html new file mode 100644 index 00000000..bfbbd81f --- /dev/null +++ b/docs/functions/api.deleteMessages.html @@ -0,0 +1,4 @@ +deleteMessages | @hoprnet/hopr-sdk

Function deleteMessages

  • deleteMessages(payload): Promise<boolean>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          tag?: number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional tag?: number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.deleteToken.html b/docs/functions/api.deleteToken.html new file mode 100644 index 00000000..8d93e340 --- /dev/null +++ b/docs/functions/api.deleteToken.html @@ -0,0 +1,8 @@ +deleteToken | @hoprnet/hopr-sdk

Function deleteToken

  • deleteToken(payload): Promise<boolean>

  • Deletes a token. Can only be done before the lifetime expired. +After the lifetime expired the token is automatically deleted.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          id: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • id: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to true if successful.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.fundChannel.html b/docs/functions/api.fundChannel.html new file mode 100644 index 00000000..d59a0bf8 --- /dev/null +++ b/docs/functions/api.fundChannel.html @@ -0,0 +1,5 @@ +fundChannel | @hoprnet/hopr-sdk

Function fundChannel

  • fundChannel(payload): Promise<{
        receipt: string;
    }>

  • Funds an existing channel with the given amount. The channel must be in state OPEN

    +

    Parameters

    • payload: {
          amount: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          channelId: string;
          timeout?: number;
      }
      • amount: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • channelId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        receipt: string;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getAddresses.html b/docs/functions/api.getAddresses.html new file mode 100644 index 00000000..1467bd80 --- /dev/null +++ b/docs/functions/api.getAddresses.html @@ -0,0 +1,7 @@ +getAddresses | @hoprnet/hopr-sdk

Function getAddresses

  • getAddresses(payload): Promise<{
        hopr: string;
        native: string;
    }>

  • Gets the HOPR and native addresses associated to the node.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        hopr: string;
        native: string;
    }>

    A promise that resolves with an object containing the HOPR and native addresses.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getAlias.html b/docs/functions/api.getAlias.html new file mode 100644 index 00000000..c308696a --- /dev/null +++ b/docs/functions/api.getAlias.html @@ -0,0 +1,7 @@ +getAlias | @hoprnet/hopr-sdk

Function getAlias

  • getAlias(payload): Promise<string>

  • Get the PeerId (Hopr address) that have this alias assigned to it.

    +

    Parameters

    • payload: {
          alias: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • alias: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

    A promise that resolves to the peer ID associated with the alias.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getAliases.html b/docs/functions/api.getAliases.html new file mode 100644 index 00000000..4bcf5980 --- /dev/null +++ b/docs/functions/api.getAliases.html @@ -0,0 +1,7 @@ +getAliases | @hoprnet/hopr-sdk

Function getAliases

  • getAliases(payload): Promise<Record<string, string>>

  • Get all aliases you set previously and their corresponding peer IDs.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<Record<string, string>>

    An object with alias names as keys and the peerId associated with the alias.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getBalances.html b/docs/functions/api.getBalances.html new file mode 100644 index 00000000..fb341498 --- /dev/null +++ b/docs/functions/api.getBalances.html @@ -0,0 +1,7 @@ +getBalances | @hoprnet/hopr-sdk

Function getBalances

  • getBalances(payload): Promise<{
        hopr: string;
        native: string;
        safeHopr: string;
        safeHoprAllowance: string;
        safeNative: string;
    }>

  • Fetches the HOPR and native balances of the node.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        hopr: string;
        native: string;
        safeHopr: string;
        safeHoprAllowance: string;
        safeNative: string;
    }>

    A Promise that resolves with an object containing the HOPR and native balances.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getChannel.html b/docs/functions/api.getChannel.html new file mode 100644 index 00000000..ee83379b --- /dev/null +++ b/docs/functions/api.getChannel.html @@ -0,0 +1,4 @@ +getChannel | @hoprnet/hopr-sdk

Function getChannel

  • getChannel(payload): Promise<{
        balance: string;
        channelEpoch: number;
        channelId: string;
        closureTime: number;
        destinationAddress: string;
        destinationPeerId: string;
        sourceAddress: string;
        sourcePeerId: string;
        status: "Open" | "PendingToClose" | "Closed";
        ticketIndex: string;
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          channelId: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • channelId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        balance: string;
        channelEpoch: number;
        channelId: string;
        closureTime: number;
        destinationAddress: string;
        destinationPeerId: string;
        sourceAddress: string;
        sourcePeerId: string;
        status: "Open" | "PendingToClose" | "Closed";
        ticketIndex: string;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getChannelTickets.html b/docs/functions/api.getChannelTickets.html new file mode 100644 index 00000000..a9cd09d0 --- /dev/null +++ b/docs/functions/api.getChannelTickets.html @@ -0,0 +1,4 @@ +getChannelTickets | @hoprnet/hopr-sdk

Function getChannelTickets

  • getChannelTickets(payload): Promise<{
        amount: string;
        channelEpoch: number;
        channelId: string;
        index: number;
        indexOffset: number;
        signature: string;
        winProb: string;
    }[]>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          channelId: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • channelId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        amount: string;
        channelEpoch: number;
        channelId: string;
        index: number;
        indexOffset: number;
        signature: string;
        winProb: string;
    }[]>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getChannels.html b/docs/functions/api.getChannels.html new file mode 100644 index 00000000..590405b6 --- /dev/null +++ b/docs/functions/api.getChannels.html @@ -0,0 +1,4 @@ +getChannels | @hoprnet/hopr-sdk

Function getChannels

  • getChannels(payload): Promise<{
        all: {
            balance: string;
            channelEpoch: number;
            channelId: string;
            closureTime: number;
            destinationAddress: string;
            destinationPeerId: string;
            sourceAddress: string;
            sourcePeerId: string;
            status: "Open" | "PendingToClose" | "Closed";
            ticketIndex: string;
        }[];
        incoming: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
        outgoing: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          fullTopology?: boolean;
          includingClosed?: boolean;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional fullTopology?: boolean
      • Optional includingClosed?: boolean
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        all: {
            balance: string;
            channelEpoch: number;
            channelId: string;
            closureTime: number;
            destinationAddress: string;
            destinationPeerId: string;
            sourceAddress: string;
            sourcePeerId: string;
            status: "Open" | "PendingToClose" | "Closed";
            ticketIndex: string;
        }[];
        incoming: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
        outgoing: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getConfiguration.html b/docs/functions/api.getConfiguration.html new file mode 100644 index 00000000..f7f58359 --- /dev/null +++ b/docs/functions/api.getConfiguration.html @@ -0,0 +1,8 @@ +getConfiguration | @hoprnet/hopr-sdk

Function getConfiguration

  • getConfiguration(payload): Promise<any>

  • Get the configuration of your node. +Configuration is not type safe

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<any>

    An object with configuration of your node.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getEntryNodes.html b/docs/functions/api.getEntryNodes.html new file mode 100644 index 00000000..7ec79eac --- /dev/null +++ b/docs/functions/api.getEntryNodes.html @@ -0,0 +1,4 @@ +getEntryNodes | @hoprnet/hopr-sdk

Function getEntryNodes

  • getEntryNodes(payload): Promise<Record<string, {
        isEligible: boolean;
        multiaddrs: string[];
    }>>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<Record<string, {
        isEligible: boolean;
        multiaddrs: string[];
    }>>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getHoprAddress.html b/docs/functions/api.getHoprAddress.html new file mode 100644 index 00000000..c593153e --- /dev/null +++ b/docs/functions/api.getHoprAddress.html @@ -0,0 +1,7 @@ +getHoprAddress | @hoprnet/hopr-sdk

Function getHoprAddress

  • getHoprAddress(payload): Promise<string>

  • Get the HOPR address of the node.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

    A Promise that resolves to the HOPR address.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getInfo.html b/docs/functions/api.getInfo.html new file mode 100644 index 00000000..e494e7e6 --- /dev/null +++ b/docs/functions/api.getInfo.html @@ -0,0 +1,4 @@ +getInfo | @hoprnet/hopr-sdk

Function getInfo

  • getInfo(payload): Promise<{
        announcedAddress: string[];
        chain: string;
        channelClosurePeriod: number;
        connectivityStatus: "Unknown" | "Red" | "Orange" | "Yellow" | "Green";
        hoprChannels: string;
        hoprManagementModule: string;
        hoprNetworkRegistry?: string;
        hoprNodeSafe: string;
        hoprNodeSafeRegistry?: string;
        hoprToken: string;
        indexBlockPrevChecksum?: number;
        indexerBlock?: number;
        indexerChecksum?: string;
        isEligible: boolean;
        listeningAddress: string[];
        network: string;
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        announcedAddress: string[];
        chain: string;
        channelClosurePeriod: number;
        connectivityStatus: "Unknown" | "Red" | "Orange" | "Yellow" | "Green";
        hoprChannels: string;
        hoprManagementModule: string;
        hoprNetworkRegistry?: string;
        hoprNodeSafe: string;
        hoprNodeSafeRegistry?: string;
        hoprToken: string;
        indexBlockPrevChecksum?: number;
        indexerBlock?: number;
        indexerChecksum?: string;
        isEligible: boolean;
        listeningAddress: string[];
        network: string;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getMessagesSize.html b/docs/functions/api.getMessagesSize.html new file mode 100644 index 00000000..d5bb7c4c --- /dev/null +++ b/docs/functions/api.getMessagesSize.html @@ -0,0 +1,4 @@ +getMessagesSize | @hoprnet/hopr-sdk

Function getMessagesSize

  • getMessagesSize(payload): Promise<{
        size: number;
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          tag: number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • tag: number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        size: number;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getMetrics.html b/docs/functions/api.getMetrics.html new file mode 100644 index 00000000..dc29c0a3 --- /dev/null +++ b/docs/functions/api.getMetrics.html @@ -0,0 +1,4 @@ +getMetrics | @hoprnet/hopr-sdk

Function getMetrics

  • getMetrics(payload): Promise<string>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getNativeAddress.html b/docs/functions/api.getNativeAddress.html new file mode 100644 index 00000000..0d1494f8 --- /dev/null +++ b/docs/functions/api.getNativeAddress.html @@ -0,0 +1,7 @@ +getNativeAddress | @hoprnet/hopr-sdk

Function getNativeAddress

  • getNativeAddress(payload): Promise<string>

  • Get the native address of the node.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

    A Promise that resolves to the native address.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getNativeBalance.html b/docs/functions/api.getNativeBalance.html new file mode 100644 index 00000000..72d7fcd1 --- /dev/null +++ b/docs/functions/api.getNativeBalance.html @@ -0,0 +1,7 @@ +getNativeBalance | @hoprnet/hopr-sdk

Function getNativeBalance

  • getNativeBalance(payload): Promise<string>

  • Get the native balance of the node.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

    A Promise that resolves with a string representing the native balance.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getPeer.html b/docs/functions/api.getPeer.html new file mode 100644 index 00000000..ed81e174 --- /dev/null +++ b/docs/functions/api.getPeer.html @@ -0,0 +1,4 @@ +getPeer | @hoprnet/hopr-sdk

Function getPeer

  • getPeer(payload): Promise<{
        announced: string[];
        observed: string[];
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          peerId: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • peerId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        announced: string[];
        observed: string[];
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getPeers.html b/docs/functions/api.getPeers.html new file mode 100644 index 00000000..2917923b --- /dev/null +++ b/docs/functions/api.getPeers.html @@ -0,0 +1,4 @@ +getPeers | @hoprnet/hopr-sdk

Function getPeers

  • getPeers(payload): Promise<{
        announced: {
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
        }[];
        connected: {
            backoff: number;
            heartbeats: {
                sent: number;
                success: number;
            };
            isNew: boolean;
            lastSeen: number;
            lastSeenLatency: number;
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
            quality: number;
            reportedVersion: string;
        }[];
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          quality?: number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional quality?: number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        announced: {
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
        }[];
        connected: {
            backoff: number;
            heartbeats: {
                sent: number;
                success: number;
            };
            isNew: boolean;
            lastSeen: number;
            lastSeenLatency: number;
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
            quality: number;
            reportedVersion: string;
        }[];
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getTicketPrice.html b/docs/functions/api.getTicketPrice.html new file mode 100644 index 00000000..9cdd5915 --- /dev/null +++ b/docs/functions/api.getTicketPrice.html @@ -0,0 +1,4 @@ +getTicketPrice | @hoprnet/hopr-sdk

Function getTicketPrice

  • getTicketPrice(payload): Promise<{
        price: string;
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        price: string;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getTicketStatistics.html b/docs/functions/api.getTicketStatistics.html new file mode 100644 index 00000000..54f1216c --- /dev/null +++ b/docs/functions/api.getTicketStatistics.html @@ -0,0 +1,4 @@ +getTicketStatistics | @hoprnet/hopr-sdk

Function getTicketStatistics

  • getTicketStatistics(payload): Promise<{
        neglectedValue: string;
        redeemedValue: string;
        rejectedValue: string;
        unredeemedValue: string;
        winningCount: number;
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        neglectedValue: string;
        redeemedValue: string;
        rejectedValue: string;
        unredeemedValue: string;
        winningCount: number;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getToken.html b/docs/functions/api.getToken.html new file mode 100644 index 00000000..e1f55a0d --- /dev/null +++ b/docs/functions/api.getToken.html @@ -0,0 +1,7 @@ +getToken | @hoprnet/hopr-sdk

Function getToken

  • getToken(payload): Promise<{
        capabilities: {
            endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
            limits: {
                conditions?: {
                    max?: number;
                };
                type: string;
            }[];
        }[];
        description?: string;
        id: string;
        valid_until?: number;
    }>

  • Get the full token information for the token used in authentication.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        capabilities: {
            endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
            limits: {
                conditions?: {
                    max?: number;
                };
                type: string;
            }[];
        }[];
        description?: string;
        id: string;
        valid_until?: number;
    }>

    A Promise that resolves to an object with the token info.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.getVersion.html b/docs/functions/api.getVersion.html new file mode 100644 index 00000000..fcc29ce2 --- /dev/null +++ b/docs/functions/api.getVersion.html @@ -0,0 +1,4 @@ +getVersion | @hoprnet/hopr-sdk

Function getVersion

  • getVersion(payload): Promise<string>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.isNodeHealthy.html b/docs/functions/api.isNodeHealthy.html new file mode 100644 index 00000000..f08913ac --- /dev/null +++ b/docs/functions/api.isNodeHealthy.html @@ -0,0 +1,7 @@ +isNodeHealthy | @hoprnet/hopr-sdk

Function isNodeHealthy

  • isNodeHealthy(payload): Promise<boolean>

  • Check whether the node is healthy.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to a boolean stating that the node is healthy or not.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.isNodeReady.html b/docs/functions/api.isNodeReady.html new file mode 100644 index 00000000..993c0865 --- /dev/null +++ b/docs/functions/api.isNodeReady.html @@ -0,0 +1,7 @@ +isNodeReady | @hoprnet/hopr-sdk

Function isNodeReady

  • isNodeReady(payload): Promise<boolean>

  • Check whether the node is healthy.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to a boolean stating that the node is healthy or not.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.isNodeStarted.html b/docs/functions/api.isNodeStarted.html new file mode 100644 index 00000000..83b761cf --- /dev/null +++ b/docs/functions/api.isNodeStarted.html @@ -0,0 +1,7 @@ +isNodeStarted | @hoprnet/hopr-sdk

Function isNodeStarted

  • isNodeStarted(payload): Promise<boolean>

  • Check whether the node is healthy.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to a boolean stating that the node is healthy or not.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.openChannel.html b/docs/functions/api.openChannel.html new file mode 100644 index 00000000..50261198 --- /dev/null +++ b/docs/functions/api.openChannel.html @@ -0,0 +1,8 @@ +openChannel | @hoprnet/hopr-sdk

Function openChannel

  • openChannel(payload): Promise<{
        channelId: string;
        transactionReceipt: string;
    }>

  • Opens a HOPR channel given a payload that specifies the API endpoint of the HOPR node, the peerId, and the amount of HOPR tokens to be staked in the channel.

    +

    This operation may take more than 5 minutes to complete as it involves on-chain operations.

    +

    Parameters

    • payload: {
          amount: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          peerAddress: string;
          timeout?: number;
      }
      • amount: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • peerAddress: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        channelId: string;
        transactionReceipt: string;
    }>

    A Promise that resolves with the response of the open channel operation.

    +

    Throws

    APIError - If the operation fails. The error object contains the status code and the error message.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.peekAllMessages.html b/docs/functions/api.peekAllMessages.html new file mode 100644 index 00000000..7f677c2d --- /dev/null +++ b/docs/functions/api.peekAllMessages.html @@ -0,0 +1,10 @@ +peekAllMessages | @hoprnet/hopr-sdk

Function peekAllMessages

  • peekAllMessages(payload): Promise<{
        messages: {
            body: string;
            receivedAt: number;
            tag: number;
        }[];
    }>

  • Peek the list of messages currently present in the nodes message inbox, +filtered by tag, and optionally by timestamp (epoch in milliseconds). +The messages are not removed from the inbox.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          tag?: null | number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional tag?: null | number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        messages: {
            body: string;
            receivedAt: number;
            tag: number;
        }[];
    }>

      +
    • A promise that resolves to the list of messages currently present in the nodes message inbox.
      • +
    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.peekMessage.html b/docs/functions/api.peekMessage.html new file mode 100644 index 00000000..d7e17aa6 --- /dev/null +++ b/docs/functions/api.peekMessage.html @@ -0,0 +1,9 @@ +peekMessage | @hoprnet/hopr-sdk

Function peekMessage

  • peekMessage(payload): Promise<{
        body: string;
        receivedAt: number;
        tag: number;
    }>

  • Peek the oldest message currently present in the nodes message inbox. +The message is not removed from the inbox.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          tag?: null | number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional tag?: null | number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        body: string;
        receivedAt: number;
        tag: number;
    }>

      +
    • A promise that resolves to the oldest message currently present in the nodes message inbox.
      • +
    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.pingPeer.html b/docs/functions/api.pingPeer.html new file mode 100644 index 00000000..a80a9ed8 --- /dev/null +++ b/docs/functions/api.pingPeer.html @@ -0,0 +1,4 @@ +pingPeer | @hoprnet/hopr-sdk

Function pingPeer

  • pingPeer(payload): Promise<{
        latency: number;
        reportedVersion: string;
    }>

  • Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          peerId: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • peerId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        latency: number;
        reportedVersion: string;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.popAllMessages.html b/docs/functions/api.popAllMessages.html new file mode 100644 index 00000000..0e14b707 --- /dev/null +++ b/docs/functions/api.popAllMessages.html @@ -0,0 +1,9 @@ +popAllMessages | @hoprnet/hopr-sdk

Function popAllMessages

  • popAllMessages(payload): Promise<{
        messages: {
            body: string;
            receivedAt: number;
            tag: number;
        }[];
    }>

  • Get the list of messages currently present in the nodes message inbox. +The messages are removed from the inbox.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          tag?: null | number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional tag?: null | number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        messages: {
            body: string;
            receivedAt: number;
            tag: number;
        }[];
    }>

      +
    • A promise that resolves to the list of messages currently present in the nodes message inbox.
      • +
    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.popMessage.html b/docs/functions/api.popMessage.html new file mode 100644 index 00000000..668e510f --- /dev/null +++ b/docs/functions/api.popMessage.html @@ -0,0 +1,9 @@ +popMessage | @hoprnet/hopr-sdk

Function popMessage

  • popMessage(payload): Promise<{
        body: string;
        receivedAt: number;
        tag: number;
    }>

  • Get the oldest message currently present in the nodes message inbox. +The message is removed from the inbox.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          tag?: null | number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional tag?: null | number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        body: string;
        receivedAt: number;
        tag: number;
    }>

      +
    • A promise that resolves to the oldest message currently present in the nodes message inbox.
      • +
    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.redeemChannelTickets.html b/docs/functions/api.redeemChannelTickets.html new file mode 100644 index 00000000..99fa666b --- /dev/null +++ b/docs/functions/api.redeemChannelTickets.html @@ -0,0 +1,9 @@ +redeemChannelTickets | @hoprnet/hopr-sdk

Function redeemChannelTickets

  • redeemChannelTickets(payload): Promise<boolean>

  • Redeems all the unredeemed HOPR tickets in a channel.

    +

    This operation may take more than 5 minutes to complete as it involves on-chain operations.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          channelId: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • channelId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to a boolean indicating the success of the operation. +True if the operation is successful, false otherwise.

    +

    Throws

    APIError - If the operation fails. The error object contains the status code and the error message.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.redeemTickets.html b/docs/functions/api.redeemTickets.html new file mode 100644 index 00000000..9f62a91f --- /dev/null +++ b/docs/functions/api.redeemTickets.html @@ -0,0 +1,9 @@ +redeemTickets | @hoprnet/hopr-sdk

Function redeemTickets

  • redeemTickets(payload): Promise<boolean>

  • Redeems all the unredeemed HOPR tickets owned by the HOPR node.

    +

    This operation may take more than 5 minutes to complete as it involves on-chain operations.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to a boolean indicating the success of the operation. +True if the operation is successful, false otherwise.

    +

    Throws

    APIError - If the operation fails. The error object contains the status code and the error message.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.removeAlias.html b/docs/functions/api.removeAlias.html new file mode 100644 index 00000000..064ade63 --- /dev/null +++ b/docs/functions/api.removeAlias.html @@ -0,0 +1,7 @@ +removeAlias | @hoprnet/hopr-sdk

Function removeAlias

  • removeAlias(payload): Promise<boolean>

  • Unassign an alias from a PeerId.

    +

    Parameters

    • payload: {
          alias: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • alias: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to true if the alias was successfully removed.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.sendMessage.html b/docs/functions/api.sendMessage.html new file mode 100644 index 00000000..03571c34 --- /dev/null +++ b/docs/functions/api.sendMessage.html @@ -0,0 +1,8 @@ +sendMessage | @hoprnet/hopr-sdk

Function sendMessage

  • sendMessage(payload): Promise<string>

  • 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.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          body: string;
          hops?: number;
          path?: string[];
          peerId: string;
          tag: number;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • body: string
      • Optional hops?: number
      • Optional path?: string[]
      • peerId: string
      • tag: number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

      +
    • A promise that resolves to the sent message.
      • +
    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.setAlias.html b/docs/functions/api.setAlias.html new file mode 100644 index 00000000..64fec56d --- /dev/null +++ b/docs/functions/api.setAlias.html @@ -0,0 +1,9 @@ +setAlias | @hoprnet/hopr-sdk

Function setAlias

  • setAlias(payload): Promise<boolean>

  • 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.

    +

    Parameters

    • payload: {
          alias: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          peerId: string;
          timeout?: number;
      }
      • alias: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • peerId: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<boolean>

    A Promise that resolves to true if alias successfully linked to peerId.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.websocket.html b/docs/functions/api.websocket.html new file mode 100644 index 00000000..a930922a --- /dev/null +++ b/docs/functions/api.websocket.html @@ -0,0 +1,6 @@ +websocket | @hoprnet/hopr-sdk

Function websocket

  • websocket(payload): WebSocket

  • Creates a WebSocket instance with the specified IP and API token.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns WebSocket

    A WebSocket instance.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/api.withdraw.html b/docs/functions/api.withdraw.html new file mode 100644 index 00000000..7fb6fb09 --- /dev/null +++ b/docs/functions/api.withdraw.html @@ -0,0 +1,8 @@ +withdraw | @hoprnet/hopr-sdk

Function withdraw

  • withdraw(payload): Promise<string>

  • Withdraw the given currency amount to the specified recipient address. +This operation may take more than 5 minutes to complete as it involves on-chain operations.

    +

    Parameters

    • payload: {
          amount: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          currency: "NATIVE" | "HOPR";
          ethereumAddress: string;
          timeout?: number;
      }
      • amount: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • currency: "NATIVE" | "HOPR"
      • ethereumAddress: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<string>

    A Promise that resolves to the transaction receipt.

    +

    Throws

    An error that occurred while processing the request.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/flows.cashOut.html b/docs/functions/flows.cashOut.html new file mode 100644 index 00000000..a931da75 --- /dev/null +++ b/docs/functions/flows.cashOut.html @@ -0,0 +1,8 @@ +cashOut | @hoprnet/hopr-sdk

Function cashOut

  • cashOut(payload): Promise<{
        hopr?: string;
        native?: string;
    }>

  • Withdraw all funds from the node. +Does not include funds locked in open channels. +This is a long running function and may take a more than 5 minutes to run

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          ethereumAddress: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • ethereumAddress: string
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        hopr?: string;
        native?: string;
    }>

    The transaction receipts for the cash out transactions.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/flows.closeEverything.html b/docs/functions/flows.closeEverything.html new file mode 100644 index 00000000..cd942534 --- /dev/null +++ b/docs/functions/flows.closeEverything.html @@ -0,0 +1,6 @@ +closeEverything | @hoprnet/hopr-sdk

Function closeEverything

  • closeEverything(payload): Promise<{
        closedChannels: {
            channelStatus: "Open" | "PendingToClose" | "Closed";
            receipt: string;
        }[];
        redeemedTickets: boolean;
    }>

  • Closes all open outgoing channels and redeems any pending tickets. +This is a long running function and may take a more than 5 minutes to run

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        closedChannels: {
            channelStatus: "Open" | "PendingToClose" | "Closed";
            receipt: string;
        }[];
        redeemedTickets: boolean;
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/flows.getOutgoingChannels.html b/docs/functions/flows.getOutgoingChannels.html new file mode 100644 index 00000000..5e2920f7 --- /dev/null +++ b/docs/functions/flows.getOutgoingChannels.html @@ -0,0 +1,6 @@ +getOutgoingChannels | @hoprnet/hopr-sdk

Function getOutgoingChannels

  • getOutgoingChannels(payload): Promise<{
        balance: string;
        id: string;
        peerAddress: string;
        status: "Open" | "PendingToClose" | "Closed";
    }[]>

  • Gets the outgoing channels with optional status filter.

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          status?: "Open" | "PendingToClose" | "Closed" | "WaitingForCommitment";
          timeout?: number;
      }
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • Optional status?: "Open" | "PendingToClose" | "Closed" | "WaitingForCommitment"
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<{
        balance: string;
        id: string;
        peerAddress: string;
        status: "Open" | "PendingToClose" | "Closed";
    }[]>

    An array of outgoing channels matching the status filter.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/flows.openMultipleChannels.html b/docs/functions/flows.openMultipleChannels.html new file mode 100644 index 00000000..0cfe4882 --- /dev/null +++ b/docs/functions/flows.openMultipleChannels.html @@ -0,0 +1,4 @@ +openMultipleChannels | @hoprnet/hopr-sdk

Function openMultipleChannels

  • openMultipleChannels(payload): Promise<undefined | {
        [peerId: string]: {
            channelId: string;
            transactionReceipt: string;
        };
    }>

  • Parameters

    • payload: {
          amount: string;
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          peerAddresses: string[];
          timeout?: number;
      }
      • amount: string
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • peerAddresses: string[]
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<undefined | {
        [peerId: string]: {
            channelId: string;
            transactionReceipt: string;
        };
    }>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/flows.safeSendMessage.html b/docs/functions/flows.safeSendMessage.html new file mode 100644 index 00000000..31ee7c08 --- /dev/null +++ b/docs/functions/flows.safeSendMessage.html @@ -0,0 +1,7 @@ +safeSendMessage | @hoprnet/hopr-sdk

Function safeSendMessage

  • safeSendMessage(payload): Promise<undefined | string>

  • Safely send a message through the network. Checks if node has at least +one open outgoing channel

    +

    Parameters

    • payload: {
          apiEndpoint: (string | URL) & (undefined | string | URL);
          apiToken: string;
          body: string;
          hops?: number;
          path?: string[];
          peerId: string;
          tag: number;
          timeout?: number;
      }

      The payload of the message.

      +
      • apiEndpoint: (string | URL) & (undefined | string | URL)

        The API endpoint for authentication.

        +
      • apiToken: string

        The API token for authentication.

        +
      • body: string
      • Optional hops?: number
      • Optional path?: string[]
      • peerId: string
      • tag: number
      • Optional timeout?: number

        optional timeout for the requests

        +

    Returns Promise<undefined | string>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createLogger.html b/docs/functions/utils.createLogger.html new file mode 100644 index 00000000..b4d091bb --- /dev/null +++ b/docs/functions/utils.createLogger.html @@ -0,0 +1,5 @@ +createLogger | @hoprnet/hopr-sdk

Function createLogger

  • createLogger(suffix, extraInfo?): {
        debug: Debugger;
        error: Debugger;
    }

  • Creates a a custom logger

    +

    Parameters

    • suffix: string

      name of the module you are working on

      +
    • Optional extraInfo: string

      any other key that can help distinguish where this +log is coming from

      +

    Returns {
        debug: Debugger;
        error: Debugger;
    }

    • debug: Debugger
    • error: Debugger

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.fetchWithTimeout.html b/docs/functions/utils.fetchWithTimeout.html new file mode 100644 index 00000000..d81e32a5 --- /dev/null +++ b/docs/functions/utils.fetchWithTimeout.html @@ -0,0 +1 @@ +fetchWithTimeout | @hoprnet/hopr-sdk

Function fetchWithTimeout

  • fetchWithTimeout(apiEndpoint, options?, ms?): Promise<Response>

  • Parameters

    • apiEndpoint: URL | RequestInfo
    • Optional options: RequestInit
    • ms: number = 30000

    Returns Promise<Response>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.getHeaders.html b/docs/functions/utils.getHeaders.html new file mode 100644 index 00000000..2d946b82 --- /dev/null +++ b/docs/functions/utils.getHeaders.html @@ -0,0 +1,4 @@ +getHeaders | @hoprnet/hopr-sdk

Function getHeaders

  • getHeaders(apiToken): Headers

  • Generates the headers needed for making API requests.

    +

    Parameters

    • apiToken: string

      The API token to include in the headers.

      +

    Returns Headers

    The headers for making API requests.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..9e2da9a1 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,98 @@ +@hoprnet/hopr-sdk

@hoprnet/hopr-sdk

@hoprnet/hopr-sdk

Description

The @hoprnet/hopr-sdk package is a software development kit for interacting with HOPRd's Rest API functions. +It provides a set of functions that allow developers to interact with the HOPR protocol and perform various actions such as node and account management, messaging, address retrieval, balance retrieval, and withdrawal and other operations.

+

Installation

To install the @hoprnet/hopr-sdk package, follow these steps:

+
    +
  1. Make sure you have node.js >=18 installed on your machine.
    2. +
  2. Open your terminal or command prompt.
    3. +
  3. Navigate to your project directory.
    4. +
  4. Run the following command to install the package using:
    5. +
+
npm install @hoprnet/hopr-sdk
+
+

or

+
yarn add @hoprnet/hopr-sdk
+
+

Usage

You can use the @hoprnet/hopr-sdk in two different ways:

+

HoprSDK class

By creating a new instance of the HoprSDK class.

+
    +
  1. Import the HoprSDK class from the package:
    2. +
+
import { HoprSDK } from '@hoprnet/hopr-sdk';
+
+
    +
  1. Create an instance of the HoprSDK class by providing the required parameters:
    2. +
+
const sdk = new HoprSDK({
  apiEndpoint: 'http://localhost:3001', // Replace with your HOPR API endopoint.
  apiToken: 'your-api-token', // Replace with your API token
  timeout: 5000 // Optional timeout in milliseconds (defaults to 30000)
});
+
+
    +
  1. You can now use the sdk instance to access the available functions. For example, to get the HOPR and native addresses associated with the node:
    2. +
+
const addresses = await sdk.api.account.getAddresses();

console.log(addresses);
+
+

HOPR API functions

By calling directly the rest API functions.

+
    +
  1. Import the API object from the package:
    2. +
+
import { api } from '@hoprnet/hopr-sdk';
+
+
    +
  • If your ts config includes "moduleResolution": "nodenext" or "node16", you can import the functions like this:
    • +
+
import { getAddresses } from '@hoprnet/hopr-sdk/api';
+
+
    +
  1. Access the desired function, keep in mind that you'll need to provide a payload object with the apiEndpoint and apiToken for each individual function:
    2. +
+
const addresses = await api.getAddresses({
  apiEndpoint: 'http://localhost:3001', // Replace with your HOPR API endopoint
  apiToken: 'your-api-token' // Replace with your API token
  timeout: 5000 // Optional timeout in milliseconds (defaults to 30000)
});

console.log(addresses);
+
+

HOPR Flows functions

By calling directly the flows functions.

+
    +
  1. Import the flows object from the package:
    2. +
+
import { flows } from '@hoprnet/hopr-sdk';
+
+
    +
  • If your ts config includes "moduleResolution": "nodenext" or "node16", you can import the functions like this:
    • +
+
import { openMultipleChannels } from '@hoprnet/hopr-sdk/flows';
+
+
    +
  1. Access the desired function, keep in mind that you'll need to provide a payload object with the apiEndpoint and apiToken for each individual function:
    2. +
+
const res = await flows.openMultipleChannels({
  apiEndpoint: 'http://localhost:3001', // Replace with your HOPR API endopoint
  apiToken: 'your-api-token' // Replace with your API token
  timeout: 60e3 * 7 // Optional timeout in milliseconds (defaults to 30000) | This function takes really long
});

console.log(res);
+
+

Documentation

+

Project setup

Source code resides under src/ folder.

+
    +
  • api: the api routes seperated by resource
    • +
  • ethereum: ethereum ABIs and Addresses that are relevant to Hopr
    • +
  • flows: common uses of multiple functions in a row
    • +
  • types: api response and request types using zod
    • +
  • utils: extras that are used throughout the repo, such as fetchWithTimeout
    • +
+

API

Directory Setup

The api folder is used to find routes with ease.

+

For example if you are looking for GET /api/v3/node/info you would go straight +to the node folder and find the file getInfo.ts alongside getInfo.spec.ts to +understand how this function will react to different responses from the node.

+

In a more general sense it looks like this:

+
├── api
│   ├── resource (example: node)
│   │   ├── adapter.ts
│   │   ├── getResource.ts
│   │   ├── getResource.spec.ts
+
+

The adapter creates a resource class used by the sdk class

+

Adding a new route

The resource of the route can be seen after the v3 keyword, for example in this example /api/v3/node/info the resource is node.

+
New Resource
    +
  • Create a the resource folder that must contain: adapter.ts and functions with tests.
    • +
+
Exisiting Resource
    +
  • Add the function to the resource folder with tests showing how the route would react to +different status codes
    • +
+

Basic function structure

async function getResource(payload: ResourcePayloadType) {
    const rawResponse = await fetchResource()

    // received unexpected error from server
    if (isServerError(rawResponse)) {
     throw new Error();
    }

    // received expected response
    // this can either be done with a Zod object or a status code
    if (receivedExpectedResponse(rawResponse)) {
        return parseResponse(rawResponse);
    }

    // check if response has the structure of an expected sdk api error
    if (isApiErrorResponse(rawResponse)) {
        throw new sdkApiError();
    }

    // if we get to this point then we could not parse the response
    // and it is not unexpected error
    // we probably need to update the zod type
    throw new ZodError(parsedRes.error.issues);
}
+
+

Deployment process

To contribute to this repository you will need to create a pull request. More information about the existing automated workflows can be found in GitHub Actions

+

Settings

Member Visibility

Theme

On This Page

@hoprnet/hopr-sdk
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 00000000..5c1f4c61 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,135 @@ +@hoprnet/hopr-sdk

@hoprnet/hopr-sdk

Index

Namespaces

api +flows +utils +web3 +

Classes

HoprSDK +

Type Aliases

AggregateChannelTicketsPayloadType +AliasPayloadType +ApiErrorResponseType +BasePayloadType +ChainPayloadType +CloseChannelPayloadType +CloseChannelResponseType +CreateTokenPayloadType +CreateTokenResponseType +DeleteMessagesPayloadType +DeleteTokenPayloadType +FundChannelsPayloadType +FundChannelsResponseType +GetAddressesResponseType +GetAliasResponseType +GetAliasesResponseType +GetBalancesResponseType +GetChannelPayloadType +GetChannelResponseType +GetChannelTicketsPayloadType +GetChannelTicketsResponseType +GetChannelsPayloadType +GetChannelsResponseType +GetConfigurationPayloadType +GetConfigurationResponseType +GetEntryNodesResponseType +GetInfoResponseType +GetMessagesSizePayloadType +GetMessagesSizeResponseType +GetPeerPayloadType +GetPeerResponseType +GetPeersPayloadType +GetPeersResponseType +GetTicketPricePayloadType +GetTicketPriceResponseType +GetTicketStatisticsResponseType +GetTokenResponseType +IsNodeHealthyPayloadType +IsNodeHealthyResponseType +IsNodeReadyPayloadType +IsNodeReadyResponseType +IsNodeStartedPayloadType +IsNodeStartedResponseType +NetworkPayloadType +OpenChannelPayloadType +OpenChannelResponseType +PeekAllMessagesPayloadType +PeekAllMessagesResponseType +PeekMessagePayloadType +PeekMessageResponseType +PingPeerPayloadType +PingPeerResponseType +PopAllMessagesPayloadType +PopAllMessagesResponseType +PopMessagePayloadType +PopMessageResponseType +RedeemChannelTicketsPayloadType +RemoveBasicAuthenticationPayloadType +SendMessagePayloadType +SetAliasPayloadType +StrategiesPayloadType +WithdrawPayloadType +createWsUrlType +

Variables

AggregateChannelTicketsPayload +AliasPayload +ApiErrorResponse +BasePayload +Channel +CloseChannelPayload +CloseChannelResponse +CreateTokenPayload +CreateTokenResponse +DeleteMessagesPayload +DeleteTokenPayload +FundChannelsPayload +FundChannelsResponse +GetAddressesResponse +GetAliasResponse +GetAliasesResponse +GetBalancesResponse +GetChannelPayload +GetChannelResponse +GetChannelTicketsPayload +GetChannelTicketsResponse +GetChannelsPayload +GetChannelsResponse +GetConfigurationPayload +GetConfigurationResponse +GetEntryNodesResponse +GetInfoResponse +GetMessagesSizePayload +GetMessagesSizeResponse +GetPeerPayload +GetPeerResponse +GetPeersPayload +GetPeersResponse +GetTicketPricePayload +GetTicketPriceResponse +GetTicketStatisticsResponse +GetTokenResponse +IsNodeHealthyPayload +IsNodeHealthyResponse +IsNodeReadyPayload +IsNodeReadyResponse +IsNodeStartedPayload +IsNodeStartedResponse +OpenChannelPayload +OpenChannelResponse +PeekAllMessagesPayload +PeekAllMessagesResponse +PeekMessagePayload +PeekMessageResponse +PeerAnnounced +PeerConnected +PingPeerPayload +PingPeerResponse +PopAllMessagesPayload +PopAllMessagesResponse +PopMessagePayload +PopMessageResponse +ReceivedMessage +RedeemChannelTicketsPayload +SendMessagePayload +SetAliasPayload +Ticket +TokenCapability +WithdrawPayload +WithdrawResponse +createWsUrlPayload +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules.md b/docs/modules.md deleted file mode 100644 index 17d1c550..00000000 --- a/docs/modules.md +++ /dev/null @@ -1,2023 +0,0 @@ -# @hoprnet/hopr-sdk - -## Table of contents - -### Namespaces - -- [api](modules/api.md) -- [flows](modules/flows.md) -- [utils](modules/utils.md) -- [web3](modules/web3.md) - -### Classes - -- [HoprSDK](classes/HoprSDK.md) - -### Type Aliases - -- [AggregateChannelTicketsPayloadType](modules.md#aggregatechannelticketspayloadtype) -- [AliasPayloadType](modules.md#aliaspayloadtype) -- [ApiErrorResponseType](modules.md#apierrorresponsetype) -- [BasePayloadType](modules.md#basepayloadtype) -- [ChainPayloadType](modules.md#chainpayloadtype) -- [CloseChannelPayloadType](modules.md#closechannelpayloadtype) -- [CloseChannelResponseType](modules.md#closechannelresponsetype) -- [CreateTokenPayloadType](modules.md#createtokenpayloadtype) -- [CreateTokenResponseType](modules.md#createtokenresponsetype) -- [DeleteMessagesPayloadType](modules.md#deletemessagespayloadtype) -- [DeleteTokenPayloadType](modules.md#deletetokenpayloadtype) -- [FundChannelsPayloadType](modules.md#fundchannelspayloadtype) -- [FundChannelsResponseType](modules.md#fundchannelsresponsetype) -- [GetAddressesResponseType](modules.md#getaddressesresponsetype) -- [GetAliasResponseType](modules.md#getaliasresponsetype) -- [GetAliasesResponseType](modules.md#getaliasesresponsetype) -- [GetBalancesResponseType](modules.md#getbalancesresponsetype) -- [GetChannelPayloadType](modules.md#getchannelpayloadtype) -- [GetChannelResponseType](modules.md#getchannelresponsetype) -- [GetChannelTicketsPayloadType](modules.md#getchannelticketspayloadtype) -- [GetChannelTicketsResponseType](modules.md#getchannelticketsresponsetype) -- [GetChannelsPayloadType](modules.md#getchannelspayloadtype) -- [GetChannelsResponseType](modules.md#getchannelsresponsetype) -- [GetConfigurationPayloadType](modules.md#getconfigurationpayloadtype) -- [GetConfigurationResponseType](modules.md#getconfigurationresponsetype) -- [GetEntryNodesResponseType](modules.md#getentrynodesresponsetype) -- [GetInfoResponseType](modules.md#getinforesponsetype) -- [GetMessagesSizePayloadType](modules.md#getmessagessizepayloadtype) -- [GetMessagesSizeResponseType](modules.md#getmessagessizeresponsetype) -- [GetPeerPayloadType](modules.md#getpeerpayloadtype) -- [GetPeerResponseType](modules.md#getpeerresponsetype) -- [GetPeersPayloadType](modules.md#getpeerspayloadtype) -- [GetPeersResponseType](modules.md#getpeersresponsetype) -- [GetTicketPricePayloadType](modules.md#getticketpricepayloadtype) -- [GetTicketPriceResponseType](modules.md#getticketpriceresponsetype) -- [GetTicketStatisticsResponseType](modules.md#getticketstatisticsresponsetype) -- [GetTokenResponseType](modules.md#gettokenresponsetype) -- [IsNodeHealthyPayloadType](modules.md#isnodehealthypayloadtype) -- [IsNodeHealthyResponseType](modules.md#isnodehealthyresponsetype) -- [IsNodeReadyPayloadType](modules.md#isnodereadypayloadtype) -- [IsNodeReadyResponseType](modules.md#isnodereadyresponsetype) -- [IsNodeStartedPayloadType](modules.md#isnodestartedpayloadtype) -- [IsNodeStartedResponseType](modules.md#isnodestartedresponsetype) -- [NetworkPayloadType](modules.md#networkpayloadtype) -- [OpenChannelPayloadType](modules.md#openchannelpayloadtype) -- [OpenChannelResponseType](modules.md#openchannelresponsetype) -- [PeekAllMessagesPayloadType](modules.md#peekallmessagespayloadtype) -- [PeekAllMessagesResponseType](modules.md#peekallmessagesresponsetype) -- [PeekMessagePayloadType](modules.md#peekmessagepayloadtype) -- [PeekMessageResponseType](modules.md#peekmessageresponsetype) -- [PingPeerPayloadType](modules.md#pingpeerpayloadtype) -- [PingPeerResponseType](modules.md#pingpeerresponsetype) -- [PopAllMessagesPayloadType](modules.md#popallmessagespayloadtype) -- [PopAllMessagesResponseType](modules.md#popallmessagesresponsetype) -- [PopMessagePayloadType](modules.md#popmessagepayloadtype) -- [PopMessageResponseType](modules.md#popmessageresponsetype) -- [RedeemChannelTicketsPayloadType](modules.md#redeemchannelticketspayloadtype) -- [RemoveBasicAuthenticationPayloadType](modules.md#removebasicauthenticationpayloadtype) -- [SendMessagePayloadType](modules.md#sendmessagepayloadtype) -- [SetAliasPayloadType](modules.md#setaliaspayloadtype) -- [StrategiesPayloadType](modules.md#strategiespayloadtype) -- [WithdrawPayloadType](modules.md#withdrawpayloadtype) -- [createWsUrlType](modules.md#createwsurltype) - -### Variables - -- [AggregateChannelTicketsPayload](modules.md#aggregatechannelticketspayload) -- [AliasPayload](modules.md#aliaspayload) -- [ApiErrorResponse](modules.md#apierrorresponse) -- [BasePayload](modules.md#basepayload) -- [Channel](modules.md#channel) -- [CloseChannelPayload](modules.md#closechannelpayload) -- [CloseChannelResponse](modules.md#closechannelresponse) -- [CreateTokenPayload](modules.md#createtokenpayload) -- [CreateTokenResponse](modules.md#createtokenresponse) -- [DeleteMessagesPayload](modules.md#deletemessagespayload) -- [DeleteTokenPayload](modules.md#deletetokenpayload) -- [FundChannelsPayload](modules.md#fundchannelspayload) -- [FundChannelsResponse](modules.md#fundchannelsresponse) -- [GetAddressesResponse](modules.md#getaddressesresponse) -- [GetAliasResponse](modules.md#getaliasresponse) -- [GetAliasesResponse](modules.md#getaliasesresponse) -- [GetBalancesResponse](modules.md#getbalancesresponse) -- [GetChannelPayload](modules.md#getchannelpayload) -- [GetChannelResponse](modules.md#getchannelresponse) -- [GetChannelTicketsPayload](modules.md#getchannelticketspayload) -- [GetChannelTicketsResponse](modules.md#getchannelticketsresponse) -- [GetChannelsPayload](modules.md#getchannelspayload) -- [GetChannelsResponse](modules.md#getchannelsresponse) -- [GetConfigurationPayload](modules.md#getconfigurationpayload) -- [GetConfigurationResponse](modules.md#getconfigurationresponse) -- [GetEntryNodesResponse](modules.md#getentrynodesresponse) -- [GetInfoResponse](modules.md#getinforesponse) -- [GetMessagesSizePayload](modules.md#getmessagessizepayload) -- [GetMessagesSizeResponse](modules.md#getmessagessizeresponse) -- [GetPeerPayload](modules.md#getpeerpayload) -- [GetPeerResponse](modules.md#getpeerresponse) -- [GetPeersPayload](modules.md#getpeerspayload) -- [GetPeersResponse](modules.md#getpeersresponse) -- [GetTicketPricePayload](modules.md#getticketpricepayload) -- [GetTicketPriceResponse](modules.md#getticketpriceresponse) -- [GetTicketStatisticsResponse](modules.md#getticketstatisticsresponse) -- [GetTokenResponse](modules.md#gettokenresponse) -- [IsNodeHealthyPayload](modules.md#isnodehealthypayload) -- [IsNodeHealthyResponse](modules.md#isnodehealthyresponse) -- [IsNodeReadyPayload](modules.md#isnodereadypayload) -- [IsNodeReadyResponse](modules.md#isnodereadyresponse) -- [IsNodeStartedPayload](modules.md#isnodestartedpayload) -- [IsNodeStartedResponse](modules.md#isnodestartedresponse) -- [OpenChannelPayload](modules.md#openchannelpayload) -- [OpenChannelResponse](modules.md#openchannelresponse) -- [PeekAllMessagesPayload](modules.md#peekallmessagespayload) -- [PeekAllMessagesResponse](modules.md#peekallmessagesresponse) -- [PeekMessagePayload](modules.md#peekmessagepayload) -- [PeekMessageResponse](modules.md#peekmessageresponse) -- [PeerAnnounced](modules.md#peerannounced) -- [PeerConnected](modules.md#peerconnected) -- [PingPeerPayload](modules.md#pingpeerpayload) -- [PingPeerResponse](modules.md#pingpeerresponse) -- [PopAllMessagesPayload](modules.md#popallmessagespayload) -- [PopAllMessagesResponse](modules.md#popallmessagesresponse) -- [PopMessagePayload](modules.md#popmessagepayload) -- [PopMessageResponse](modules.md#popmessageresponse) -- [ReceivedMessage](modules.md#receivedmessage) -- [RedeemChannelTicketsPayload](modules.md#redeemchannelticketspayload) -- [SendMessagePayload](modules.md#sendmessagepayload) -- [SetAliasPayload](modules.md#setaliaspayload) -- [Ticket](modules.md#ticket) -- [TokenCapability](modules.md#tokencapability) -- [WithdrawPayload](modules.md#withdrawpayload) -- [WithdrawResponse](modules.md#withdrawresponse) -- [createWsUrlPayload](modules.md#createwsurlpayload) - -## Type Aliases - -### AggregateChannelTicketsPayloadType - -Ƭ **AggregateChannelTicketsPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `channelId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:48](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L48) - -___ - -### AliasPayloadType - -Ƭ **AliasPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `alias` | `string` | - | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/aliases.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L12) - -___ - -### ApiErrorResponseType - -Ƭ **ApiErrorResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `error?` | `string` | -| `status` | `string` | - -#### Defined in - -[src/types/ApiErrorResponse.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/ApiErrorResponse.ts#L8) - -___ - -### BasePayloadType - -Ƭ **BasePayloadType**: `Object` - -Represents the inferred TypeScript type from BasicAuthenticationPayload. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/general.ts:26](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/general.ts#L26) - -___ - -### ChainPayloadType - -Ƭ **ChainPayloadType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `block_time` | ``null`` \| `number` | -| `chain_id` | `number` | -| `default_provider` | ``null`` \| `string` | -| `description` | ``null`` \| `string` | -| `etherscan_api_url` | ``null`` \| `string` | -| `hopr_token_name` | ``null`` \| `string` | -| `live` | `boolean` | -| `max_fee_per_gas` | ``null`` \| `string` | -| `max_priority_fee_per_gas` | ``null`` \| `string` | -| `native_token_name` | ``null`` \| `string` | -| `tags` | ``null`` \| `string`[] | - -#### Defined in - -[src/types/configuration.ts:53](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L53) - -___ - -### CloseChannelPayloadType - -Ƭ **CloseChannelPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `channelId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:134](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L134) - -___ - -### CloseChannelResponseType - -Ƭ **CloseChannelResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `channelStatus` | ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` | -| `receipt` | `string` | - -#### Defined in - -[src/types/channels.ts:141](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L141) - -___ - -### CreateTokenPayloadType - -Ƭ **CreateTokenPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `capabilities` | \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }[] | - | -| `description` | `string` | - | -| `lifetime` | `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/tokens.ts:77](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L77) - -___ - -### CreateTokenResponseType - -Ƭ **CreateTokenResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `token` | `string` | - -#### Defined in - -[src/types/tokens.ts:83](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L83) - -___ - -### DeleteMessagesPayloadType - -Ƭ **DeleteMessagesPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `tag?` | `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:34](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L34) - -___ - -### DeleteTokenPayloadType - -Ƭ **DeleteTokenPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `id` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/tokens.ts:106](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L106) - -___ - -### FundChannelsPayloadType - -Ƭ **FundChannelsPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `string` | - | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `channelId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:61](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L61) - -___ - -### FundChannelsResponseType - -Ƭ **FundChannelsResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipt` | `string` | - -#### Defined in - -[src/types/channels.ts:67](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L67) - -___ - -### GetAddressesResponseType - -Ƭ **GetAddressesResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `hopr` | `string` | -| `native` | `string` | - -#### Defined in - -[src/types/account.ts:27](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L27) - -___ - -### GetAliasResponseType - -Ƭ **GetAliasResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | - -#### Defined in - -[src/types/aliases.ts:39](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L39) - -___ - -### GetAliasesResponseType - -Ƭ **GetAliasesResponseType**: `Record`\<`string`, `string`\> - -#### Defined in - -[src/types/aliases.ts:20](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L20) - -___ - -### GetBalancesResponseType - -Ƭ **GetBalancesResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `hopr` | `string` | -| `native` | `string` | -| `safeHopr` | `string` | -| `safeHoprAllowance` | `string` | -| `safeNative` | `string` | - -#### Defined in - -[src/types/account.ts:16](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L16) - -___ - -### GetChannelPayloadType - -Ƭ **GetChannelPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `channelId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:149](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L149) - -___ - -### GetChannelResponseType - -Ƭ **GetChannelResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `balance` | `string` | -| `channelEpoch` | `number` | -| `channelId` | `string` | -| `closureTime` | `number` | -| `destinationAddress` | `string` | -| `destinationPeerId` | `string` | -| `sourceAddress` | `string` | -| `sourcePeerId` | `string` | -| `status` | ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` | -| `ticketIndex` | `string` | - -#### Defined in - -[src/types/channels.ts:153](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L153) - -___ - -### GetChannelTicketsPayloadType - -Ƭ **GetChannelTicketsPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `channelId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:108](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L108) - -___ - -### GetChannelTicketsResponseType - -Ƭ **GetChannelTicketsResponseType**: \{ `amount`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `index`: `number` ; `indexOffset`: `number` ; `signature`: `string` ; `winProb`: `string` }[] - -#### Defined in - -[src/types/channels.ts:124](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L124) - -___ - -### GetChannelsPayloadType - -Ƭ **GetChannelsPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `fullTopology?` | `boolean` | - | -| `includingClosed?` | `boolean` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:92](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L92) - -___ - -### GetChannelsResponseType - -Ƭ **GetChannelsResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `all` | \{ `balance`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `closureTime`: `number` ; `destinationAddress`: `string` ; `destinationPeerId`: `string` ; `sourceAddress`: `string` ; `sourcePeerId`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `ticketIndex`: `string` }[] | -| `incoming` | \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[] | -| `outgoing` | \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[] | - -#### Defined in - -[src/types/channels.ts:100](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L100) - -___ - -### GetConfigurationPayloadType - -Ƭ **GetConfigurationPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/configuration.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L10) - -___ - -### GetConfigurationResponseType - -Ƭ **GetConfigurationResponseType**: `any` - -#### Defined in - -[src/types/configuration.ts:164](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L164) - -___ - -### GetEntryNodesResponseType - -Ƭ **GetEntryNodesResponseType**: `Record`\<`string`, \{ `isEligible`: `boolean` ; `multiaddrs`: `string`[] }\> - -#### Defined in - -[src/types/node.ts:79](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L79) - -___ - -### GetInfoResponseType - -Ƭ **GetInfoResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `announcedAddress` | `string`[] | -| `chain` | `string` | -| `channelClosurePeriod` | `number` | -| `connectivityStatus` | ``"Unknown"`` \| ``"Red"`` \| ``"Orange"`` \| ``"Yellow"`` \| ``"Green"`` | -| `hoprChannels` | `string` | -| `hoprManagementModule` | `string` | -| `hoprNetworkRegistry?` | `string` | -| `hoprNodeSafe` | `string` | -| `hoprNodeSafeRegistry?` | `string` | -| `hoprToken` | `string` | -| `indexBlockPrevChecksum?` | `number` | -| `indexerBlock?` | `number` | -| `indexerChecksum?` | `string` | -| `isEligible` | `boolean` | -| `listeningAddress` | `string`[] | -| `network` | `string` | - -#### Defined in - -[src/types/node.ts:66](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L66) - -___ - -### GetMessagesSizePayloadType - -Ƭ **GetMessagesSizePayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `tag` | `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:42](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L42) - -___ - -### GetMessagesSizeResponseType - -Ƭ **GetMessagesSizeResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `size` | `number` | - -#### Defined in - -[src/types/messages.ts:48](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L48) - -___ - -### GetPeerPayloadType - -Ƭ **GetPeerPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `peerId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/peers.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L12) - -___ - -### GetPeerResponseType - -Ƭ **GetPeerResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `announced` | `string`[] | -| `observed` | `string`[] | - -#### Defined in - -[src/types/peers.ts:19](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L19) - -___ - -### GetPeersPayloadType - -Ƭ **GetPeersPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `quality?` | `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/node.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L12) - -___ - -### GetPeersResponseType - -Ƭ **GetPeersResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `announced` | \{ `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` }[] | -| `connected` | \{ `backoff`: `number` ; `heartbeats`: \{ `sent`: `number` ; `success`: `number` } ; `isNew`: `boolean` ; `lastSeen`: `number` ; `lastSeenLatency`: `number` ; `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` ; `quality`: `number` ; `reportedVersion`: `string` }[] | - -#### Defined in - -[src/types/node.ts:41](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L41) - -___ - -### GetTicketPricePayloadType - -Ƭ **GetTicketPricePayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/network.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/network.ts#L10) - -___ - -### GetTicketPriceResponseType - -Ƭ **GetTicketPriceResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `price` | `string` | - -#### Defined in - -[src/types/network.ts:16](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/network.ts#L16) - -___ - -### GetTicketStatisticsResponseType - -Ƭ **GetTicketStatisticsResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `neglectedValue` | `string` | -| `redeemedValue` | `string` | -| `rejectedValue` | `string` | -| `unredeemedValue` | `string` | -| `winningCount` | `number` | - -#### Defined in - -[src/types/tickets.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tickets.ts#L15) - -___ - -### GetTokenResponseType - -Ƭ **GetTokenResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `capabilities` | \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }[] | -| `description?` | `string` | -| `id` | `string` | -| `valid_until?` | `number` | - -#### Defined in - -[src/types/tokens.ts:96](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L96) - -___ - -### IsNodeHealthyPayloadType - -Ƭ **IsNodeHealthyPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/checks.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L10) - -___ - -### IsNodeHealthyResponseType - -Ƭ **IsNodeHealthyResponseType**: `boolean` - -#### Defined in - -[src/types/checks.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L14) - -___ - -### IsNodeReadyPayloadType - -Ƭ **IsNodeReadyPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/checks.ts:22](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L22) - -___ - -### IsNodeReadyResponseType - -Ƭ **IsNodeReadyResponseType**: `boolean` - -#### Defined in - -[src/types/checks.ts:26](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L26) - -___ - -### IsNodeStartedPayloadType - -Ƭ **IsNodeStartedPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/checks.ts:34](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L34) - -___ - -### IsNodeStartedResponseType - -Ƭ **IsNodeStartedResponseType**: `boolean` - -#### Defined in - -[src/types/checks.ts:38](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L38) - -___ - -### NetworkPayloadType - -Ƭ **NetworkPayloadType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addresses` | \{ `announcements`: `string` ; `channels`: `string` ; `module_implementation`: `string` ; `network_registry`: `string` ; `network_registry_proxy`: `string` ; `node_safe_registry`: `string` ; `node_stake_v2_factory`: `string` ; `ticket_price_oracle`: `string` ; `token`: `string` } | -| `addresses.announcements` | `string` | -| `addresses.channels` | `string` | -| `addresses.module_implementation` | `string` | -| `addresses.network_registry` | `string` | -| `addresses.network_registry_proxy` | `string` | -| `addresses.node_safe_registry` | `string` | -| `addresses.node_stake_v2_factory` | `string` | -| `addresses.ticket_price_oracle` | `string` | -| `addresses.token` | `string` | -| `chain` | `string` | -| `confirmations` | `number` | -| `environment_type` | `string` | -| `indexer_start_block_number` | `number` | -| `max_block_range` | `number` | -| `tags` | ``null`` \| `string`[] | -| `tx_polling_interval` | `number` | -| `version_range` | `string` | - -#### Defined in - -[src/types/configuration.ts:36](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L36) - -___ - -### OpenChannelPayloadType - -Ƭ **OpenChannelPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `string` | - | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `peerAddress` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:76](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L76) - -___ - -### OpenChannelResponseType - -Ƭ **OpenChannelResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `channelId` | `string` | -| `transactionReceipt` | `string` | - -#### Defined in - -[src/types/channels.ts:83](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L83) - -___ - -### PeekAllMessagesPayloadType - -Ƭ **PeekAllMessagesPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `tag?` | ``null`` \| `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:96](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L96) - -___ - -### PeekAllMessagesResponseType - -Ƭ **PeekAllMessagesResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages` | \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }[] | - -#### Defined in - -[src/types/messages.ts:102](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L102) - -___ - -### PeekMessagePayloadType - -Ƭ **PeekMessagePayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `tag?` | ``null`` \| `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:84](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L84) - -___ - -### PeekMessageResponseType - -Ƭ **PeekMessageResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `body` | `string` | -| `receivedAt` | `number` | -| `tag` | `number` | - -#### Defined in - -[src/types/messages.ts:88](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L88) - -___ - -### PingPeerPayloadType - -Ƭ **PingPeerPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `peerId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/peers.ts:29](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L29) - -___ - -### PingPeerResponseType - -Ƭ **PingPeerResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `latency` | `number` | -| `reportedVersion` | `string` | - -#### Defined in - -[src/types/peers.ts:36](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L36) - -___ - -### PopAllMessagesPayloadType - -Ƭ **PopAllMessagesPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `tag?` | ``null`` \| `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:70](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L70) - -___ - -### PopAllMessagesResponseType - -Ƭ **PopAllMessagesResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages` | \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }[] | - -#### Defined in - -[src/types/messages.ts:76](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L76) - -___ - -### PopMessagePayloadType - -Ƭ **PopMessagePayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `tag?` | ``null`` \| `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:58](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L58) - -___ - -### PopMessageResponseType - -Ƭ **PopMessageResponseType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `body` | `string` | -| `receivedAt` | `number` | -| `tag` | `number` | - -#### Defined in - -[src/types/messages.ts:62](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L62) - -___ - -### RedeemChannelTicketsPayloadType - -Ƭ **RedeemChannelTicketsPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `channelId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/channels.ts:36](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L36) - -___ - -### RemoveBasicAuthenticationPayloadType - -Ƭ **RemoveBasicAuthenticationPayloadType**\<`T`\>: `Pick`\<`T`, `Exclude`\\> - -Removes the basic authentication properties from a payload type. - -**`Typeparam`** - -T - The payload type from which to remove the properties. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`BasePayloadType`](modules.md#basepayloadtype) | - -#### Defined in - -[src/types/general.ts:32](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/general.ts#L32) - -___ - -### SendMessagePayloadType - -Ƭ **SendMessagePayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `body` | `string` | - | -| `hops?` | `number` | - | -| `path?` | `string`[] | - | -| `peerId` | `string` | - | -| `tag` | `number` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/messages.ts:26](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L26) - -___ - -### SetAliasPayloadType - -Ƭ **SetAliasPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `alias` | `string` | - | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `peerId` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/aliases.ts:31](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L31) - -___ - -### StrategiesPayloadType - -Ƭ **StrategiesPayloadType**: `Record`\<`string`, `Record`\<`string`, `string` \| `number` \| `boolean`\>\> - -#### Defined in - -[src/types/configuration.ts:61](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L61) - -___ - -### WithdrawPayloadType - -Ƭ **WithdrawPayloadType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `string` | - | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `currency` | ``"NATIVE"`` \| ``"HOPR"`` | - | -| `ethereumAddress` | `string` | - | -| `timeout?` | `number` | optional timeout for the requests | - -#### Defined in - -[src/types/account.ts:39](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L39) - -___ - -### createWsUrlType - -Ƭ **createWsUrlType**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `apiToken` | `string` | The API token for authentication. | -| `path?` | `string` | optional path for the websocker | - -#### Defined in - -[src/types/websocket.ts:24](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/websocket.ts#L24) - -## Variables - -### AggregateChannelTicketsPayload - -• `Const` **AggregateChannelTicketsPayload**: `ZodObject`\<\{ `apiEndpoint`: `ZodUnion`\<[`ZodString`, `ZodType`\<`URL`, `ZodTypeDef`, `URL`\>]\> ; `apiToken`: `ZodString` ; `channelId`: `ZodString` ; `timeout`: `ZodOptional`\<`ZodNumber`\> }, ``"strip"``, `ZodTypeAny`, \{ `apiEndpoint`: `string` \| `URL` & `undefined` \| `string` \| `URL` ; `apiToken`: `string` ; `channelId`: `string` ; `timeout?`: `number` }, \{ `apiEndpoint`: `string` \| `URL` & `undefined` \| `string` \| `URL` ; `apiToken`: `string` ; `channelId`: `string` ; `timeout?`: `number` }\> - -Aggregate channel tickets - -#### Defined in - -[src/types/channels.ts:44](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L44) - -___ - -### AliasPayload - -• `Const` **AliasPayload**: `ZodObject`\<[`AliasPayloadType`](modules.md#aliaspayloadtype)\> - -General - -#### Defined in - -[src/types/aliases.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L8) - -___ - -### ApiErrorResponse - -• `Const` **ApiErrorResponse**: `ZodObject`\<[`ApiErrorResponseType`](modules.md#apierrorresponsetype)\> - -#### Defined in - -[src/types/ApiErrorResponse.ts:3](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/ApiErrorResponse.ts#L3) - -___ - -### BasePayload - -• `Const` **BasePayload**: `ZodObject`\<[`BasePayloadType`](modules.md#basepayloadtype)\> - -Represents the minimum payload needed to interact with hoprd node. - -#### Defined in - -[src/types/general.ts:6](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/general.ts#L6) - -___ - -### Channel - -• `Const` **Channel**: `ZodObject`\<\{ `balance`: `ZodString` ; `id`: `ZodString` ; `peerAddress`: `ZodString` ; `status`: `ZodEnum`\<[``"Open"``, ``"PendingToClose"``, ``"Closed"``]\> = ChannelStatus }, ``"strip"``, `ZodTypeAny`, \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }, \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }\> - -#### Defined in - -[src/types/channels.ts:21](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L21) - -___ - -### CloseChannelPayload - -• `Const` **CloseChannelPayload**: `ZodObject`\<[`CloseChannelPayloadType`](modules.md#closechannelpayloadtype)\> - -Close channel - -#### Defined in - -[src/types/channels.ts:130](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L130) - -___ - -### CloseChannelResponse - -• `Const` **CloseChannelResponse**: `ZodObject`\<[`CloseChannelResponseType`](modules.md#closechannelresponsetype)\> - -#### Defined in - -[src/types/channels.ts:136](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L136) - -___ - -### CreateTokenPayload - -• `Const` **CreateTokenPayload**: `ZodObject`\<[`CreateTokenPayloadType`](modules.md#createtokenpayloadtype)\> - -createToken - -#### Defined in - -[src/types/tokens.ts:71](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L71) - -___ - -### CreateTokenResponse - -• `Const` **CreateTokenResponse**: `ZodObject`\<[`CreateTokenResponseType`](modules.md#createtokenresponsetype)\> - -#### Defined in - -[src/types/tokens.ts:79](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L79) - -___ - -### DeleteMessagesPayload - -• `Const` **DeleteMessagesPayload**: `ZodObject`\<[`DeleteMessagesPayloadType`](modules.md#deletemessagespayloadtype)\> - -Delete Messages - -#### Defined in - -[src/types/messages.ts:30](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L30) - -___ - -### DeleteTokenPayload - -• `Const` **DeleteTokenPayload**: `ZodObject`\<[`DeleteTokenPayloadType`](modules.md#deletetokenpayloadtype)\> - -deleteToken - -#### Defined in - -[src/types/tokens.ts:102](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L102) - -___ - -### FundChannelsPayload - -• `Const` **FundChannelsPayload**: `ZodObject`\<[`FundChannelsPayloadType`](modules.md#fundchannelspayloadtype)\> - -Fund channel - -#### Defined in - -[src/types/channels.ts:56](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L56) - -___ - -### FundChannelsResponse - -• `Const` **FundChannelsResponse**: `ZodObject`\<[`FundChannelsResponseType`](modules.md#fundchannelsresponsetype)\> - -#### Defined in - -[src/types/channels.ts:63](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L63) - -___ - -### GetAddressesResponse - -• `Const` **GetAddressesResponse**: `ZodObject`\<[`GetAddressesResponseType`](modules.md#getaddressesresponsetype)\> - -addresses - -#### Defined in - -[src/types/account.ts:22](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L22) - -___ - -### GetAliasResponse - -• `Const` **GetAliasResponse**: `ZodObject`\<[`GetAliasResponseType`](modules.md#getaliasresponsetype)\> - -getAlias - -#### Defined in - -[src/types/aliases.ts:37](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L37) - -___ - -### GetAliasesResponse - -• `Const` **GetAliasesResponse**: `ZodRecord`\<[`GetAliasesResponseType`](modules.md#getaliasesresponsetype)\> - -getAliases - -#### Defined in - -[src/types/aliases.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L18) - -___ - -### GetBalancesResponse - -• `Const` **GetBalancesResponse**: `ZodObject`\<[`GetBalancesResponseType`](modules.md#getbalancesresponsetype)\> - -balances - -#### Defined in - -[src/types/account.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L8) - -___ - -### GetChannelPayload - -• `Const` **GetChannelPayload**: `ZodObject`\<[`GetChannelPayloadType`](modules.md#getchannelpayloadtype)\> - -Get channel - -#### Defined in - -[src/types/channels.ts:145](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L145) - -___ - -### GetChannelResponse - -• `Const` **GetChannelResponse**: `ZodObject`\<[`GetChannelResponseType`](modules.md#getchannelresponsetype)\> = `TopologyChannel` - -#### Defined in - -[src/types/channels.ts:151](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L151) - -___ - -### GetChannelTicketsPayload - -• `Const` **GetChannelTicketsPayload**: `ZodObject`\<[`GetChannelTicketsPayloadType`](modules.md#getchannelticketspayloadtype)\> - -Get channel tickets - -#### Defined in - -[src/types/channels.ts:104](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L104) - -___ - -### GetChannelTicketsResponse - -• `Const` **GetChannelTicketsResponse**: `ZodArray`\<[`GetChannelTicketsResponseType`](modules.md#getchannelticketsresponsetype)\> - -#### Defined in - -[src/types/channels.ts:122](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L122) - -___ - -### GetChannelsPayload - -• `Const` **GetChannelsPayload**: `ZodObject`\<[`GetChannelsPayloadType`](modules.md#getchannelspayloadtype)\> - -Get channels - -#### Defined in - -[src/types/channels.ts:87](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L87) - -___ - -### GetChannelsResponse - -• `Const` **GetChannelsResponse**: `ZodObject`\<[`GetChannelsResponseType`](modules.md#getchannelsresponsetype)\> - -#### Defined in - -[src/types/channels.ts:94](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L94) - -___ - -### GetConfigurationPayload - -• `Const` **GetConfigurationPayload**: `ZodObject`\<[`GetConfigurationPayloadType`](modules.md#getconfigurationpayloadtype)\> = `BasePayload` - -Get node configuration - -#### Defined in - -[src/types/configuration.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L8) - -___ - -### GetConfigurationResponse - -• `Const` **GetConfigurationResponse**: `ZodAny`\<[`GetConfigurationResponseType`](modules.md#getconfigurationresponsetype)\> - -#### Defined in - -[src/types/configuration.ts:63](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/configuration.ts#L63) - -___ - -### GetEntryNodesResponse - -• `Const` **GetEntryNodesResponse**: `ZodRecord`\<[`GetEntryNodesResponseType`](modules.md#getentrynodesresponsetype)\> - -#### Defined in - -[src/types/node.ts:77](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L77) - -___ - -### GetInfoResponse - -• `Const` **GetInfoResponse**: `ZodObject`\<[`GetInfoResponseType`](modules.md#getinforesponsetype)\> - -Get Info - -#### Defined in - -[src/types/node.ts:47](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L47) - -___ - -### GetMessagesSizePayload - -• `Const` **GetMessagesSizePayload**: `ZodObject`\<[`GetMessagesSizePayloadType`](modules.md#getmessagessizepayloadtype)\> - -Get Messages Size - -#### Defined in - -[src/types/messages.ts:38](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L38) - -___ - -### GetMessagesSizeResponse - -• `Const` **GetMessagesSizeResponse**: `ZodObject`\<[`GetMessagesSizeResponseType`](modules.md#getmessagessizeresponsetype)\> - -#### Defined in - -[src/types/messages.ts:44](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L44) - -___ - -### GetPeerPayload - -• `Const` **GetPeerPayload**: `ZodObject`\<[`GetPeerPayloadType`](modules.md#getpeerpayloadtype)\> - -Get peer - -#### Defined in - -[src/types/peers.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L8) - -___ - -### GetPeerResponse - -• `Const` **GetPeerResponse**: `ZodObject`\<[`GetPeerResponseType`](modules.md#getpeerresponsetype)\> - -#### Defined in - -[src/types/peers.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L14) - -___ - -### GetPeersPayload - -• `Const` **GetPeersPayload**: `ZodObject`\<[`GetPeersPayloadType`](modules.md#getpeerspayloadtype)\> - -Get peers - -#### Defined in - -[src/types/node.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L8) - -___ - -### GetPeersResponse - -• `Const` **GetPeersResponse**: `ZodObject`\<[`GetPeersResponseType`](modules.md#getpeersresponsetype)\> - -#### Defined in - -[src/types/node.ts:36](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L36) - -___ - -### GetTicketPricePayload - -• `Const` **GetTicketPricePayload**: `ZodObject`\<[`GetTicketPricePayloadType`](modules.md#getticketpricepayloadtype)\> = `BasePayload` - -Get network price - -#### Defined in - -[src/types/network.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/network.ts#L8) - -___ - -### GetTicketPriceResponse - -• `Const` **GetTicketPriceResponse**: `ZodObject`\<[`GetTicketPriceResponseType`](modules.md#getticketpriceresponsetype)\> - -#### Defined in - -[src/types/network.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/network.ts#L12) - -___ - -### GetTicketStatisticsResponse - -• `Const` **GetTicketStatisticsResponse**: `ZodObject`\<[`GetTicketStatisticsResponseType`](modules.md#getticketstatisticsresponsetype)\> - -Get statistics - -#### Defined in - -[src/types/tickets.ts:7](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tickets.ts#L7) - -___ - -### GetTokenResponse - -• `Const` **GetTokenResponse**: `ZodObject`\<[`GetTokenResponseType`](modules.md#gettokenresponsetype)\> - -getToken - -#### Defined in - -[src/types/tokens.ts:89](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L89) - -___ - -### IsNodeHealthyPayload - -• `Const` **IsNodeHealthyPayload**: `ZodObject`\<[`IsNodeHealthyPayloadType`](modules.md#isnodehealthypayloadtype)\> = `BasePayload` - -Check whether the node is healthy - -#### Defined in - -[src/types/checks.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L8) - -___ - -### IsNodeHealthyResponse - -• `Const` **IsNodeHealthyResponse**: `ZodBoolean`\<[`IsNodeHealthyResponseType`](modules.md#isnodehealthyresponsetype)\> - -#### Defined in - -[src/types/checks.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L12) - -___ - -### IsNodeReadyPayload - -• `Const` **IsNodeReadyPayload**: `ZodObject`\<[`IsNodeReadyPayloadType`](modules.md#isnodereadypayloadtype)\> = `BasePayload` - -Check whether the node is ready to accept connections. - -#### Defined in - -[src/types/checks.ts:20](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L20) - -___ - -### IsNodeReadyResponse - -• `Const` **IsNodeReadyResponse**: `ZodBoolean`\<[`IsNodeReadyResponseType`](modules.md#isnodereadyresponsetype)\> - -#### Defined in - -[src/types/checks.ts:24](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L24) - -___ - -### IsNodeStartedPayload - -• `Const` **IsNodeStartedPayload**: `ZodObject`\<[`IsNodeStartedPayloadType`](modules.md#isnodestartedpayloadtype)\> = `BasePayload` - -Check whether the node is ready to accept connections. - -#### Defined in - -[src/types/checks.ts:32](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L32) - -___ - -### IsNodeStartedResponse - -• `Const` **IsNodeStartedResponse**: `ZodBoolean`\<[`IsNodeStartedResponseType`](modules.md#isnodestartedresponsetype)\> - -#### Defined in - -[src/types/checks.ts:36](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/checks.ts#L36) - -___ - -### OpenChannelPayload - -• `Const` **OpenChannelPayload**: `ZodObject`\<[`OpenChannelPayloadType`](modules.md#openchannelpayloadtype)\> - -Open channel - -#### Defined in - -[src/types/channels.ts:71](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L71) - -___ - -### OpenChannelResponse - -• `Const` **OpenChannelResponse**: `ZodObject`\<[`OpenChannelResponseType`](modules.md#openchannelresponsetype)\> - -#### Defined in - -[src/types/channels.ts:78](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L78) - -___ - -### PeekAllMessagesPayload - -• `Const` **PeekAllMessagesPayload**: `ZodObject`\<[`PeekAllMessagesPayloadType`](modules.md#peekallmessagespayloadtype)\> - -Peek all messages - -#### Defined in - -[src/types/messages.ts:92](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L92) - -___ - -### PeekAllMessagesResponse - -• `Const` **PeekAllMessagesResponse**: `ZodObject`\<[`PeekAllMessagesResponseType`](modules.md#peekallmessagesresponsetype)\> - -#### Defined in - -[src/types/messages.ts:98](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L98) - -___ - -### PeekMessagePayload - -• `Const` **PeekMessagePayload**: `ZodObject`\<[`PeekMessagePayloadType`](modules.md#peekmessagepayloadtype)\> - -Peek message - -#### Defined in - -[src/types/messages.ts:80](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L80) - -___ - -### PeekMessageResponse - -• `Const` **PeekMessageResponse**: `ZodObject`\<[`PeekMessageResponseType`](modules.md#peekmessageresponsetype)\> = `ReceivedMessage` - -#### Defined in - -[src/types/messages.ts:86](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L86) - -___ - -### PeerAnnounced - -• `Const` **PeerAnnounced**: `ZodObject`\<\{ `multiaddr`: `ZodNullable`\<`ZodString`\> ; `peerAddress`: `ZodString` ; `peerId`: `ZodString` }, ``"strip"``, `ZodTypeAny`, \{ `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` }, \{ `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` }\> - -#### Defined in - -[src/types/node.ts:30](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L30) - -___ - -### PeerConnected - -• `Const` **PeerConnected**: `ZodObject`\<\{ `backoff`: `ZodNumber` ; `heartbeats`: `ZodObject`\<\{ `sent`: `ZodNumber` ; `success`: `ZodNumber` }, ``"strip"``, `ZodTypeAny`, \{ `sent`: `number` ; `success`: `number` }, \{ `sent`: `number` ; `success`: `number` }\> ; `isNew`: `ZodBoolean` ; `lastSeen`: `ZodNumber` ; `lastSeenLatency`: `ZodNumber` ; `multiaddr`: `ZodNullable`\<`ZodString`\> ; `peerAddress`: `ZodString` ; `peerId`: `ZodString` ; `quality`: `ZodNumber` ; `reportedVersion`: `ZodString` }, ``"strip"``, `ZodTypeAny`, \{ `backoff`: `number` ; `heartbeats`: \{ `sent`: `number` ; `success`: `number` } ; `isNew`: `boolean` ; `lastSeen`: `number` ; `lastSeenLatency`: `number` ; `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` ; `quality`: `number` ; `reportedVersion`: `string` }, \{ `backoff`: `number` ; `heartbeats`: \{ `sent`: `number` ; `success`: `number` } ; `isNew`: `boolean` ; `lastSeen`: `number` ; `lastSeenLatency`: `number` ; `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` ; `quality`: `number` ; `reportedVersion`: `string` }\> - -#### Defined in - -[src/types/node.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/node.ts#L14) - -___ - -### PingPeerPayload - -• `Const` **PingPeerPayload**: `ZodObject`\<[`PingPeerPayloadType`](modules.md#pingpeerpayloadtype)\> - -Ping peer - -#### Defined in - -[src/types/peers.ts:25](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L25) - -___ - -### PingPeerResponse - -• `Const` **PingPeerResponse**: `ZodObject`\<[`PingPeerResponseType`](modules.md#pingpeerresponsetype)\> - -#### Defined in - -[src/types/peers.ts:31](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/peers.ts#L31) - -___ - -### PopAllMessagesPayload - -• `Const` **PopAllMessagesPayload**: `ZodObject`\<[`PopAllMessagesPayloadType`](modules.md#popallmessagespayloadtype)\> - -Pop all messages - -#### Defined in - -[src/types/messages.ts:66](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L66) - -___ - -### PopAllMessagesResponse - -• `Const` **PopAllMessagesResponse**: `ZodObject`\<[`PopAllMessagesResponseType`](modules.md#popallmessagesresponsetype)\> - -#### Defined in - -[src/types/messages.ts:72](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L72) - -___ - -### PopMessagePayload - -• `Const` **PopMessagePayload**: `ZodObject`\<[`PopMessagePayloadType`](modules.md#popmessagepayloadtype)\> - -Pop message - -#### Defined in - -[src/types/messages.ts:54](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L54) - -___ - -### PopMessageResponse - -• `Const` **PopMessageResponse**: `ZodObject`\<[`PopMessageResponseType`](modules.md#popmessageresponsetype)\> = `ReceivedMessage` - -#### Defined in - -[src/types/messages.ts:60](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L60) - -___ - -### ReceivedMessage - -• `Const` **ReceivedMessage**: `ZodObject`\<\{ `body`: `ZodString` ; `receivedAt`: `ZodNumber` ; `tag`: `ZodNumber` }, ``"strip"``, `ZodTypeAny`, \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }, \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }\> - -General - -#### Defined in - -[src/types/messages.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L8) - -___ - -### RedeemChannelTicketsPayload - -• `Const` **RedeemChannelTicketsPayload**: `ZodObject`\<[`AggregateChannelTicketsPayloadType`](modules.md#aggregatechannelticketspayloadtype)\> - -Redeem channel tickets - -#### Defined in - -[src/types/channels.ts:32](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L32) - -___ - -### SendMessagePayload - -• `Const` **SendMessagePayload**: `ZodObject`\<[`SendMessagePayloadType`](modules.md#sendmessagepayloadtype)\> - -Send Message - -#### Defined in - -[src/types/messages.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/messages.ts#L18) - -___ - -### SetAliasPayload - -• `Const` **SetAliasPayload**: `ZodObject`\<[`SetAliasPayloadType`](modules.md#setaliaspayloadtype)\> - -setAlias - -#### Defined in - -[src/types/aliases.ts:26](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/aliases.ts#L26) - -___ - -### Ticket - -• `Const` **Ticket**: `ZodObject`\<\{ `amount`: `ZodString` ; `channelEpoch`: `ZodNumber` ; `channelId`: `ZodString` ; `index`: `ZodNumber` ; `indexOffset`: `ZodNumber` ; `signature`: `ZodString` ; `winProb`: `ZodString` }, ``"strip"``, `ZodTypeAny`, \{ `amount`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `index`: `number` ; `indexOffset`: `number` ; `signature`: `string` ; `winProb`: `string` }, \{ `amount`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `index`: `number` ; `indexOffset`: `number` ; `signature`: `string` ; `winProb`: `string` }\> - -#### Defined in - -[src/types/channels.ts:112](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/channels.ts#L112) - -___ - -### TokenCapability - -• `Const` **TokenCapability**: `ZodObject`\<\{ `endpoint`: `ZodEnum`\<[``"accountWithdraw"``, ``"accountGetBalances"``, ``"accountGetAddresses"``, ``"aliasesGetAliases"``, ``"aliasesSetAlias"``, ``"aliasesGetAlias"``, ``"aliasesRemoveAlias"``, ``"channelsFundChannels"``, ``"channelsOpenChannel"``, ``"channelsGetChannels"``]\> ; `limits`: `ZodArray`\<`ZodObject`\<\{ `conditions`: `ZodOptional`\<`ZodObject`\<\{ `max`: `ZodOptional`\<`ZodNumber`\> }, ``"strip"``, `ZodTypeAny`, \{ `max?`: `number` }, \{ `max?`: `number` }\>\> ; `type`: `ZodString` }, ``"strip"``, `ZodTypeAny`, \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }, \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }\>, ``"many"``\> }, ``"strip"``, `ZodTypeAny`, \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }, \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }\> - -#### Defined in - -[src/types/tokens.ts:55](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/tokens.ts#L55) - -___ - -### WithdrawPayload - -• `Const` **WithdrawPayload**: `ZodObject`\<[`WithdrawPayloadType`](modules.md#withdrawpayloadtype)\> - -withdraw - -#### Defined in - -[src/types/account.ts:33](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L33) - -___ - -### WithdrawResponse - -• `Const` **WithdrawResponse**: `ZodObject`\<\{ `receipt`: `ZodString` }, ``"strip"``, `ZodTypeAny`, \{ `receipt`: `string` }, \{ `receipt`: `string` }\> - -#### Defined in - -[src/types/account.ts:41](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/account.ts#L41) - -___ - -### createWsUrlPayload - -• `Const` **createWsUrlPayload**: `ZodObject`\<[`createWsUrlType`](modules.md#createwsurltype)\> - -createWsUrl - -#### Defined in - -[src/types/websocket.ts:7](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/types/websocket.ts#L7) diff --git a/docs/modules/api.html b/docs/modules/api.html new file mode 100644 index 00000000..559a73be --- /dev/null +++ b/docs/modules/api.html @@ -0,0 +1,43 @@ +api | @hoprnet/hopr-sdk

Namespace api

Index

Functions

closeChannel +createToken +deleteMessages +deleteToken +fundChannel +getAddresses +getAlias +getAliases +getBalances +getChannel +getChannelTickets +getChannels +getConfiguration +getEntryNodes +getHoprAddress +getInfo +getMessagesSize +getMetrics +getNativeAddress +getNativeBalance +getPeer +getPeers +getTicketPrice +getTicketStatistics +getToken +getVersion +isNodeHealthy +isNodeReady +isNodeStarted +openChannel +peekAllMessages +peekMessage +pingPeer +popAllMessages +popMessage +redeemChannelTickets +redeemTickets +removeAlias +sendMessage +setAlias +websocket +withdraw +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/api.md b/docs/modules/api.md deleted file mode 100644 index a2774e71..00000000 --- a/docs/modules/api.md +++ /dev/null @@ -1,1268 +0,0 @@ -# Namespace: api - -## Table of contents - -### Functions - -- [closeChannel](api.md#closechannel) -- [createToken](api.md#createtoken) -- [deleteMessages](api.md#deletemessages) -- [deleteToken](api.md#deletetoken) -- [fundChannel](api.md#fundchannel) -- [getAddresses](api.md#getaddresses) -- [getAlias](api.md#getalias) -- [getAliases](api.md#getaliases) -- [getBalances](api.md#getbalances) -- [getChannel](api.md#getchannel) -- [getChannelTickets](api.md#getchanneltickets) -- [getChannels](api.md#getchannels) -- [getConfiguration](api.md#getconfiguration) -- [getEntryNodes](api.md#getentrynodes) -- [getHoprAddress](api.md#gethopraddress) -- [getInfo](api.md#getinfo) -- [getMessagesSize](api.md#getmessagessize) -- [getMetrics](api.md#getmetrics) -- [getNativeAddress](api.md#getnativeaddress) -- [getNativeBalance](api.md#getnativebalance) -- [getPeer](api.md#getpeer) -- [getPeers](api.md#getpeers) -- [getTicketPrice](api.md#getticketprice) -- [getTicketStatistics](api.md#getticketstatistics) -- [getToken](api.md#gettoken) -- [getVersion](api.md#getversion) -- [isNodeHealthy](api.md#isnodehealthy) -- [isNodeReady](api.md#isnodeready) -- [isNodeStarted](api.md#isnodestarted) -- [openChannel](api.md#openchannel) -- [peekAllMessages](api.md#peekallmessages) -- [peekMessage](api.md#peekmessage) -- [pingPeer](api.md#pingpeer) -- [popAllMessages](api.md#popallmessages) -- [popMessage](api.md#popmessage) -- [redeemChannelTickets](api.md#redeemchanneltickets) -- [redeemTickets](api.md#redeemtickets) -- [removeAlias](api.md#removealias) -- [sendMessage](api.md#sendmessage) -- [setAlias](api.md#setalias) -- [websocket](api.md#websocket) -- [withdraw](api.md#withdraw) - -## Functions - -### closeChannel - -▸ **closeChannel**(`payload`): `Promise`\<\{ `channelStatus`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `receipt`: `string` }\> - -Closes a HOPR channel given a payload that specifies the API endpoint of the HOPR node, the peerId and the direction of the channel. - -This operation may take more than 5 minutes to complete as it involves on-chain operations. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.channelId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `channelStatus`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `receipt`: `string` }\> - -A Promise that resolves with the response of the close channel operation. - -**`Throws`** - -APIError - If the operation fails. The error object contains the status code and the error message. - -#### Defined in - -[src/api/channels/closeChannel.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/closeChannel.ts#L18) - -___ - -### createToken - -▸ **createToken**(`payload`): `Promise`\<\{ `token`: `string` }\> - -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. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.capabilities` | \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }[] | - | -| `payload.description` | `string` | - | -| `payload.lifetime` | `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `token`: `string` }\> - -A Promise that resolves to the generated token which must be used when authenticating for API calls. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/tokens/createToken.ts:22](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/tokens/createToken.ts#L22) - -___ - -### deleteMessages - -▸ **deleteMessages**(`payload`): `Promise`\<`boolean`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.tag?` | `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[src/api/messages/deleteMessages.ts:5](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/deleteMessages.ts#L5) - -___ - -### deleteToken - -▸ **deleteToken**(`payload`): `Promise`\<`boolean`\> - -Deletes a token. Can only be done before the lifetime expired. -After the lifetime expired the token is automatically deleted. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.id` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to true if successful. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/tokens/deleteToken.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/tokens/deleteToken.ts#L15) - -___ - -### fundChannel - -▸ **fundChannel**(`payload`): `Promise`\<\{ `receipt`: `string` }\> - -Funds an existing channel with the given amount. The channel must be in state OPEN - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.amount` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.channelId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `receipt`: `string` }\> - -#### Defined in - -[src/api/channels/fundChannel.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/fundChannel.ts#L14) - -___ - -### getAddresses - -▸ **getAddresses**(`payload`): `Promise`\<\{ `hopr`: `string` ; `native`: `string` }\> - -Gets the HOPR and native addresses associated to the node. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `hopr`: `string` ; `native`: `string` }\> - -A promise that resolves with an object containing the HOPR and native addresses. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/account/getAddresses.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/account/getAddresses.ts#L18) - -___ - -### getAlias - -▸ **getAlias**(`payload`): `Promise`\<`string`\> - -Get the PeerId (Hopr address) that have this alias assigned to it. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.alias` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the peer ID associated with the alias. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/aliases/getAlias.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/aliases/getAlias.ts#L18) - -___ - -### getAliases - -▸ **getAliases**(`payload`): `Promise`\<`Record`\<`string`, `string`\>\> - -Get all aliases you set previously and their corresponding peer IDs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`Record`\<`string`, `string`\>\> - -An object with alias names as keys and the peerId associated with the alias. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/aliases/getAliases.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/aliases/getAliases.ts#L18) - -___ - -### getBalances - -▸ **getBalances**(`payload`): `Promise`\<\{ `hopr`: `string` ; `native`: `string` ; `safeHopr`: `string` ; `safeHoprAllowance`: `string` ; `safeNative`: `string` }\> - -Fetches the HOPR and native balances of the node. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `hopr`: `string` ; `native`: `string` ; `safeHopr`: `string` ; `safeHoprAllowance`: `string` ; `safeNative`: `string` }\> - -A Promise that resolves with an object containing the HOPR and native balances. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/account/getBalances.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/account/getBalances.ts#L18) - -___ - -### getChannel - -▸ **getChannel**(`payload`): `Promise`\<\{ `balance`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `closureTime`: `number` ; `destinationAddress`: `string` ; `destinationPeerId`: `string` ; `sourceAddress`: `string` ; `sourcePeerId`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `ticketIndex`: `string` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.channelId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `balance`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `closureTime`: `number` ; `destinationAddress`: `string` ; `destinationPeerId`: `string` ; `sourceAddress`: `string` ; `sourcePeerId`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `ticketIndex`: `string` }\> - -#### Defined in - -[src/api/channels/getChannel.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/getChannel.ts#L10) - -___ - -### getChannelTickets - -▸ **getChannelTickets**(`payload`): `Promise`\<\{ `amount`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `index`: `number` ; `indexOffset`: `number` ; `signature`: `string` ; `winProb`: `string` }[]\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.channelId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `amount`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `index`: `number` ; `indexOffset`: `number` ; `signature`: `string` ; `winProb`: `string` }[]\> - -#### Defined in - -[src/api/channels/getChannelTickets.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/getChannelTickets.ts#L10) - -___ - -### getChannels - -▸ **getChannels**(`payload`): `Promise`\<\{ `all`: \{ `balance`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `closureTime`: `number` ; `destinationAddress`: `string` ; `destinationPeerId`: `string` ; `sourceAddress`: `string` ; `sourcePeerId`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `ticketIndex`: `string` }[] ; `incoming`: \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[] ; `outgoing`: \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[] }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.fullTopology?` | `boolean` | - | -| `payload.includingClosed?` | `boolean` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `all`: \{ `balance`: `string` ; `channelEpoch`: `number` ; `channelId`: `string` ; `closureTime`: `number` ; `destinationAddress`: `string` ; `destinationPeerId`: `string` ; `sourceAddress`: `string` ; `sourcePeerId`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `ticketIndex`: `string` }[] ; `incoming`: \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[] ; `outgoing`: \{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[] }\> - -#### Defined in - -[src/api/channels/getChannels.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/getChannels.ts#L10) - -___ - -### getConfiguration - -▸ **getConfiguration**(`payload`): `Promise`\<`any`\> - -Get the configuration of your node. -Configuration is not type safe - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`any`\> - -An object with configuration of your node. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/configuration/getConfiguration.ts:19](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/configuration/getConfiguration.ts#L19) - -___ - -### getEntryNodes - -▸ **getEntryNodes**(`payload`): `Promise`\<`Record`\<`string`, \{ `isEligible`: `boolean` ; `multiaddrs`: `string`[] }\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `isEligible`: `boolean` ; `multiaddrs`: `string`[] }\>\> - -#### Defined in - -[src/api/node/getEntryNodes.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/node/getEntryNodes.ts#L10) - -___ - -### getHoprAddress - -▸ **getHoprAddress**(`payload`): `Promise`\<`string`\> - -Get the HOPR address of the node. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -A Promise that resolves to the HOPR address. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/account/getHoprAddress.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/account/getHoprAddress.ts#L12) - -___ - -### getInfo - -▸ **getInfo**(`payload`): `Promise`\<\{ `announcedAddress`: `string`[] ; `chain`: `string` ; `channelClosurePeriod`: `number` ; `connectivityStatus`: ``"Unknown"`` \| ``"Red"`` \| ``"Orange"`` \| ``"Yellow"`` \| ``"Green"`` ; `hoprChannels`: `string` ; `hoprManagementModule`: `string` ; `hoprNetworkRegistry?`: `string` ; `hoprNodeSafe`: `string` ; `hoprNodeSafeRegistry?`: `string` ; `hoprToken`: `string` ; `indexBlockPrevChecksum?`: `number` ; `indexerBlock?`: `number` ; `indexerChecksum?`: `string` ; `isEligible`: `boolean` ; `listeningAddress`: `string`[] ; `network`: `string` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `announcedAddress`: `string`[] ; `chain`: `string` ; `channelClosurePeriod`: `number` ; `connectivityStatus`: ``"Unknown"`` \| ``"Red"`` \| ``"Orange"`` \| ``"Yellow"`` \| ``"Green"`` ; `hoprChannels`: `string` ; `hoprManagementModule`: `string` ; `hoprNetworkRegistry?`: `string` ; `hoprNodeSafe`: `string` ; `hoprNodeSafeRegistry?`: `string` ; `hoprToken`: `string` ; `indexBlockPrevChecksum?`: `number` ; `indexerBlock?`: `number` ; `indexerChecksum?`: `string` ; `isEligible`: `boolean` ; `listeningAddress`: `string`[] ; `network`: `string` }\> - -#### Defined in - -[src/api/node/getInfo.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/node/getInfo.ts#L10) - -___ - -### getMessagesSize - -▸ **getMessagesSize**(`payload`): `Promise`\<\{ `size`: `number` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.tag` | `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `size`: `number` }\> - -#### Defined in - -[src/api/messages/getMessagesSize.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/getMessagesSize.ts#L10) - -___ - -### getMetrics - -▸ **getMetrics**(`payload`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/api/node/getMetrics.ts:5](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/node/getMetrics.ts#L5) - -___ - -### getNativeAddress - -▸ **getNativeAddress**(`payload`): `Promise`\<`string`\> - -Get the native address of the node. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -A Promise that resolves to the native address. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/account/getNativeAddress.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/account/getNativeAddress.ts#L12) - -___ - -### getNativeBalance - -▸ **getNativeBalance**(`payload`): `Promise`\<`string`\> - -Get the native balance of the node. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -A Promise that resolves with a string representing the native balance. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/account/getNativeBalance.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/account/getNativeBalance.ts#L12) - -___ - -### getPeer - -▸ **getPeer**(`payload`): `Promise`\<\{ `announced`: `string`[] ; `observed`: `string`[] }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.peerId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `announced`: `string`[] ; `observed`: `string`[] }\> - -#### Defined in - -[src/api/peers/getPeer.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/peers/getPeer.ts#L10) - -___ - -### getPeers - -▸ **getPeers**(`payload`): `Promise`\<\{ `announced`: \{ `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` }[] ; `connected`: \{ `backoff`: `number` ; `heartbeats`: \{ `sent`: `number` ; `success`: `number` } ; `isNew`: `boolean` ; `lastSeen`: `number` ; `lastSeenLatency`: `number` ; `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` ; `quality`: `number` ; `reportedVersion`: `string` }[] }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.quality?` | `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `announced`: \{ `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` }[] ; `connected`: \{ `backoff`: `number` ; `heartbeats`: \{ `sent`: `number` ; `success`: `number` } ; `isNew`: `boolean` ; `lastSeen`: `number` ; `lastSeenLatency`: `number` ; `multiaddr`: ``null`` \| `string` ; `peerAddress`: `string` ; `peerId`: `string` ; `quality`: `number` ; `reportedVersion`: `string` }[] }\> - -#### Defined in - -[src/api/node/getPeers.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/node/getPeers.ts#L10) - -___ - -### getTicketPrice - -▸ **getTicketPrice**(`payload`): `Promise`\<\{ `price`: `string` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `price`: `string` }\> - -#### Defined in - -[src/api/network/getTicketPrice.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/network/getTicketPrice.ts#L10) - -___ - -### getTicketStatistics - -▸ **getTicketStatistics**(`payload`): `Promise`\<\{ `neglectedValue`: `string` ; `redeemedValue`: `string` ; `rejectedValue`: `string` ; `unredeemedValue`: `string` ; `winningCount`: `number` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `neglectedValue`: `string` ; `redeemedValue`: `string` ; `rejectedValue`: `string` ; `unredeemedValue`: `string` ; `winningCount`: `number` }\> - -#### Defined in - -[src/api/tickets/getTicketStatistics.ts:9](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/tickets/getTicketStatistics.ts#L9) - -___ - -### getToken - -▸ **getToken**(`payload`): `Promise`\<\{ `capabilities`: \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }[] ; `description?`: `string` ; `id`: `string` ; `valid_until?`: `number` }\> - -Get the full token information for the token used in authentication. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `capabilities`: \{ `endpoint`: ``"accountWithdraw"`` \| ``"accountGetBalances"`` \| ``"accountGetAddresses"`` \| ``"aliasesGetAliases"`` \| ``"aliasesSetAlias"`` \| ``"aliasesGetAlias"`` \| ``"aliasesRemoveAlias"`` \| ``"channelsFundChannels"`` \| ``"channelsOpenChannel"`` \| ``"channelsGetChannels"`` \| ``"channelsRedeemTickets"`` \| ``"channelsGetTickets"`` \| ``"channelsGetChannel"`` \| ``"channelsCloseChannel"`` \| ``"messagesWebsocket"`` \| ``"messagesSign"`` \| ``"messagesSendMessage"`` \| ``"nodeGetVersion"`` \| ``"nodeStreamWebsocket"`` \| ``"nodePing"`` \| ``"nodeGetPeers"`` \| ``"nodeGetMetrics"`` \| ``"nodeGetInfo"`` \| ``"nodeGetEntryNodes"`` \| ``"peerInfoGetPeerInfo"`` \| ``"settingsGetSettings"`` \| ``"settingsSetSetting"`` \| ``"ticketsGetStatistics"`` \| ``"ticketsRedeemTickets"`` \| ``"ticketsGetTickets"`` \| ``"tokensCreate"`` \| ``"tokensGetToken"`` \| ``"tokensDelete"`` ; `limits`: \{ `conditions?`: \{ `max?`: `number` } ; `type`: `string` }[] }[] ; `description?`: `string` ; `id`: `string` ; `valid_until?`: `number` }\> - -A Promise that resolves to an object with the token info. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/tokens/getToken.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/tokens/getToken.ts#L18) - -___ - -### getVersion - -▸ **getVersion**(`payload`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/api/node/getVersion.ts:5](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/node/getVersion.ts#L5) - -___ - -### isNodeHealthy - -▸ **isNodeHealthy**(`payload`): `Promise`\<`boolean`\> - -Check whether the node is healthy. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to a boolean stating that the node is healthy or not. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/checks/isNodeHealthy.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/checks/isNodeHealthy.ts#L15) - -___ - -### isNodeReady - -▸ **isNodeReady**(`payload`): `Promise`\<`boolean`\> - -Check whether the node is healthy. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to a boolean stating that the node is healthy or not. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/checks/isNodeReady.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/checks/isNodeReady.ts#L15) - -___ - -### isNodeStarted - -▸ **isNodeStarted**(`payload`): `Promise`\<`boolean`\> - -Check whether the node is healthy. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to a boolean stating that the node is healthy or not. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/checks/isNodeStarted.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/checks/isNodeStarted.ts#L15) - -___ - -### openChannel - -▸ **openChannel**(`payload`): `Promise`\<\{ `channelId`: `string` ; `transactionReceipt`: `string` }\> - -Opens a HOPR channel given a payload that specifies the API endpoint of the HOPR node, the peerId, and the amount of HOPR tokens to be staked in the channel. - -This operation may take more than 5 minutes to complete as it involves on-chain operations. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.amount` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.peerAddress` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `channelId`: `string` ; `transactionReceipt`: `string` }\> - -A Promise that resolves with the response of the open channel operation. - -**`Throws`** - -APIError - If the operation fails. The error object contains the status code and the error message. - -#### Defined in - -[src/api/channels/openChannel.ts:19](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/openChannel.ts#L19) - -___ - -### peekAllMessages - -▸ **peekAllMessages**(`payload`): `Promise`\<\{ `messages`: \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }[] }\> - -Peek the list of messages currently present in the nodes message inbox, -filtered by tag, and optionally by timestamp (epoch in milliseconds). -The messages are not removed from the inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.tag?` | ``null`` \| `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `messages`: \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }[] }\> - -- A promise that resolves to the list of messages currently present in the nodes message inbox. - -#### Defined in - -[src/api/messages/peekAllMessages.ts:17](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/peekAllMessages.ts#L17) - -___ - -### peekMessage - -▸ **peekMessage**(`payload`): `Promise`\<\{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }\> - -Peek the oldest message currently present in the nodes message inbox. -The message is not removed from the inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.tag?` | ``null`` \| `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }\> - -- A promise that resolves to the oldest message currently present in the nodes message inbox. - -#### Defined in - -[src/api/messages/peekMessage.ts:16](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/peekMessage.ts#L16) - -___ - -### pingPeer - -▸ **pingPeer**(`payload`): `Promise`\<\{ `latency`: `number` ; `reportedVersion`: `string` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.peerId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `latency`: `number` ; `reportedVersion`: `string` }\> - -#### Defined in - -[src/api/peers/pingPeer.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/peers/pingPeer.ts#L10) - -___ - -### popAllMessages - -▸ **popAllMessages**(`payload`): `Promise`\<\{ `messages`: \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }[] }\> - -Get the list of messages currently present in the nodes message inbox. -The messages are removed from the inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.tag?` | ``null`` \| `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `messages`: \{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }[] }\> - -- A promise that resolves to the list of messages currently present in the nodes message inbox. - -#### Defined in - -[src/api/messages/popAllMessages.ts:16](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/popAllMessages.ts#L16) - -___ - -### popMessage - -▸ **popMessage**(`payload`): `Promise`\<\{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }\> - -Get the oldest message currently present in the nodes message inbox. -The message is removed from the inbox. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.tag?` | ``null`` \| `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `body`: `string` ; `receivedAt`: `number` ; `tag`: `number` }\> - -- A promise that resolves to the oldest message currently present in the nodes message inbox. - -#### Defined in - -[src/api/messages/popMessage.ts:16](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/popMessage.ts#L16) - -___ - -### redeemChannelTickets - -▸ **redeemChannelTickets**(`payload`): `Promise`\<`boolean`\> - -Redeems all the unredeemed HOPR tickets in a channel. - -This operation may take more than 5 minutes to complete as it involves on-chain operations. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.channelId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to a boolean indicating the success of the operation. -True if the operation is successful, false otherwise. - -**`Throws`** - -APIError - If the operation fails. The error object contains the status code and the error message. - -#### Defined in - -[src/api/channels/redeemChannelTickets.ts:18](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/channels/redeemChannelTickets.ts#L18) - -___ - -### redeemTickets - -▸ **redeemTickets**(`payload`): `Promise`\<`boolean`\> - -Redeems all the unredeemed HOPR tickets owned by the HOPR node. - -This operation may take more than 5 minutes to complete as it involves on-chain operations. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to a boolean indicating the success of the operation. -True if the operation is successful, false otherwise. - -**`Throws`** - -APIError - If the operation fails. The error object contains the status code and the error message. - -#### Defined in - -[src/api/tickets/redeemTickets.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/tickets/redeemTickets.ts#L14) - -___ - -### removeAlias - -▸ **removeAlias**(`payload`): `Promise`\<`boolean`\> - -Unassign an alias from a PeerId. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.alias` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to true if the alias was successfully removed. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/aliases/removeAlias.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/aliases/removeAlias.ts#L14) - -___ - -### sendMessage - -▸ **sendMessage**(`payload`): `Promise`\<`string`\> - -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. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.body` | `string` | - | -| `payload.hops?` | `number` | - | -| `payload.path?` | `string`[] | - | -| `payload.peerId` | `string` | - | -| `payload.tag` | `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -- A promise that resolves to the sent message. - -#### Defined in - -[src/api/messages/sendMessage.ts:13](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/sendMessage.ts#L13) - -___ - -### setAlias - -▸ **setAlias**(`payload`): `Promise`\<`boolean`\> - -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. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.alias` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.peerId` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`boolean`\> - -A Promise that resolves to true if alias successfully linked to peerId. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/aliases/setAlias.ts:20](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/aliases/setAlias.ts#L20) - -___ - -### websocket - -▸ **websocket**(`payload`): `WebSocket` - -Creates a WebSocket instance with the specified IP and API token. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`WebSocket` - -A WebSocket instance. - -#### Defined in - -[src/api/messages/websocket.ts:14](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/messages/websocket.ts#L14) - -___ - -### withdraw - -▸ **withdraw**(`payload`): `Promise`\<`string`\> - -Withdraw the given currency amount to the specified recipient address. -This operation may take more than 5 minutes to complete as it involves on-chain operations. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.amount` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.currency` | ``"NATIVE"`` \| ``"HOPR"`` | - | -| `payload.ethereumAddress` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`string`\> - -A Promise that resolves to the transaction receipt. - -**`Throws`** - -An error that occurred while processing the request. - -#### Defined in - -[src/api/account/withdraw.ts:16](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/api/account/withdraw.ts#L16) diff --git a/docs/modules/flows.html b/docs/modules/flows.html new file mode 100644 index 00000000..dbcef0d4 --- /dev/null +++ b/docs/modules/flows.html @@ -0,0 +1,6 @@ +flows | @hoprnet/hopr-sdk

Namespace flows

Index

Functions

cashOut +closeEverything +getOutgoingChannels +openMultipleChannels +safeSendMessage +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/flows.md b/docs/modules/flows.md deleted file mode 100644 index f7affbfc..00000000 --- a/docs/modules/flows.md +++ /dev/null @@ -1,151 +0,0 @@ -# Namespace: flows - -## Table of contents - -### Functions - -- [cashOut](flows.md#cashout) -- [closeEverything](flows.md#closeeverything) -- [getOutgoingChannels](flows.md#getoutgoingchannels) -- [openMultipleChannels](flows.md#openmultiplechannels) -- [safeSendMessage](flows.md#safesendmessage) - -## Functions - -### cashOut - -▸ **cashOut**(`payload`): `Promise`\<\{ `hopr?`: `string` ; `native?`: `string` }\> - -Withdraw all funds from the node. -Does not include funds locked in open channels. -This is a long running function and may take a more than 5 minutes to run - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.ethereumAddress` | `string` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `hopr?`: `string` ; `native?`: `string` }\> - -The transaction receipts for the cash out transactions. - -#### Defined in - -[src/flows/cashOut.ts:11](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/flows/cashOut.ts#L11) - -___ - -### closeEverything - -▸ **closeEverything**(`payload`): `Promise`\<\{ `closedChannels`: \{ `channelStatus`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `receipt`: `string` }[] ; `redeemedTickets`: `boolean` = ticketsHaveBeenRedeemed }\> - -Closes all open outgoing channels and redeems any pending tickets. -This is a long running function and may take a more than 5 minutes to run - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `closedChannels`: \{ `channelStatus`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus; `receipt`: `string` }[] ; `redeemedTickets`: `boolean` = ticketsHaveBeenRedeemed }\> - -#### Defined in - -[src/flows/closeEverything.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/flows/closeEverything.ts#L10) - -___ - -### getOutgoingChannels - -▸ **getOutgoingChannels**(`payload`): `Promise`\<\{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[]\> - -Gets the outgoing channels with optional status filter. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.status?` | ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` \| ``"WaitingForCommitment"`` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<\{ `balance`: `string` ; `id`: `string` ; `peerAddress`: `string` ; `status`: ``"Open"`` \| ``"PendingToClose"`` \| ``"Closed"`` = ChannelStatus }[]\> - -An array of outgoing channels matching the status filter. - -#### Defined in - -[src/flows/getOutgoingChannels.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/flows/getOutgoingChannels.ts#L10) - -___ - -### openMultipleChannels - -▸ **openMultipleChannels**(`payload`): `Promise`\<`undefined` \| \{ `[peerId: string]`: \{ `channelId`: `string` ; `transactionReceipt`: `string` }; }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | - | -| `payload.amount` | `string` | - | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.peerAddresses` | `string`[] | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`undefined` \| \{ `[peerId: string]`: \{ `channelId`: `string` ; `transactionReceipt`: `string` }; }\> - -#### Defined in - -[src/flows/openMultipleChannels.ts:13](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/flows/openMultipleChannels.ts#L13) - -___ - -### safeSendMessage - -▸ **safeSendMessage**(`payload`): `Promise`\<`undefined` \| `string`\> - -Safely send a message through the network. Checks if node has at least -one open outgoing channel - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | `Object` | The payload of the message. | -| `payload.apiEndpoint` | `string` \| `URL` & `undefined` \| `string` \| `URL` | The API endpoint for authentication. | -| `payload.apiToken` | `string` | The API token for authentication. | -| `payload.body` | `string` | - | -| `payload.hops?` | `number` | - | -| `payload.path?` | `string`[] | - | -| `payload.peerId` | `string` | - | -| `payload.tag` | `number` | - | -| `payload.timeout?` | `number` | optional timeout for the requests | - -#### Returns - -`Promise`\<`undefined` \| `string`\> - -#### Defined in - -[src/flows/safeSendMessage.ts:13](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/flows/safeSendMessage.ts#L13) diff --git a/docs/modules/utils.html b/docs/modules/utils.html new file mode 100644 index 00000000..915deaa5 --- /dev/null +++ b/docs/modules/utils.html @@ -0,0 +1,5 @@ +utils | @hoprnet/hopr-sdk

Namespace utils

Index

Classes

sdkApiError +

Functions

createLogger +fetchWithTimeout +getHeaders +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/utils.md b/docs/modules/utils.md deleted file mode 100644 index 9ece049a..00000000 --- a/docs/modules/utils.md +++ /dev/null @@ -1,87 +0,0 @@ -# Namespace: utils - -## Table of contents - -### Classes - -- [sdkApiError](../classes/utils.sdkApiError.md) - -### Functions - -- [createLogger](utils.md#createlogger) -- [fetchWithTimeout](utils.md#fetchwithtimeout) -- [getHeaders](utils.md#getheaders) - -## Functions - -### createLogger - -▸ **createLogger**(`suffix`, `extraInfo?`): `Object` - -Creates a a custom logger - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `suffix` | `string` | name of the module you are working on | -| `extraInfo?` | `string` | any other key that can help distinguish where this log is coming from | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `debug` | `Debugger` | -| `error` | `Debugger` | - -#### Defined in - -[src/utils/log.ts:15](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/log.ts#L15) - -___ - -### fetchWithTimeout - -▸ **fetchWithTimeout**(`apiEndpoint`, `options?`, `ms?`): `Promise`\<`Response`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `apiEndpoint` | `URL` \| `RequestInfo` | `undefined` | -| `options?` | `RequestInit` | `undefined` | -| `ms` | `number` | `30000` | - -#### Returns - -`Promise`\<`Response`\> - -#### Defined in - -[src/utils/fetchWithTimeout.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/fetchWithTimeout.ts#L1) - -___ - -### getHeaders - -▸ **getHeaders**(`apiToken`): `Headers` - -Generates the headers needed for making API requests. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiToken` | `string` | The API token to include in the headers. | - -#### Returns - -`Headers` - -The headers for making API requests. - -#### Defined in - -[src/utils/headers.ts:7](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/utils/headers.ts#L7) diff --git a/docs/modules/web3.html b/docs/modules/web3.html new file mode 100644 index 00000000..282b3262 --- /dev/null +++ b/docs/modules/web3.html @@ -0,0 +1,18 @@ +web3 | @hoprnet/hopr-sdk

Namespace web3

Index

Variables

DUFOUR +HOPR_CHANNELS_SMART_CONTRACT_ADDRESS +erc721ABI +hoprBoostNFTABI +hoprChannelsABI +hoprMultiSendABI +hoprNetworkRegistryABI +hoprNodeManagementModuleABI +hoprNodeSafeRegistryABI +hoprNodeStakeFactoryABI +hoprSafeABI +hoprWrapperABI +mHOPR_TOKEN_SMART_CONTRACT_ADDRESS +wrapperABI +wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS +wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS +xHOPR_TOKEN_SMART_CONTRACT_ADDRESS +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/web3.md b/docs/modules/web3.md deleted file mode 100644 index 53aeb990..00000000 --- a/docs/modules/web3.md +++ /dev/null @@ -1,210 +0,0 @@ -# Namespace: web3 - -## Table of contents - -### Variables - -- [DUFOUR](web3.md#dufour) -- [HOPR\_CHANNELS\_SMART\_CONTRACT\_ADDRESS](web3.md#hopr_channels_smart_contract_address) -- [erc721ABI](web3.md#erc721abi) -- [hoprBoostNFTABI](web3.md#hoprboostnftabi) -- [hoprChannelsABI](web3.md#hoprchannelsabi) -- [hoprMultiSendABI](web3.md#hoprmultisendabi) -- [hoprNetworkRegistryABI](web3.md#hoprnetworkregistryabi) -- [hoprNodeManagementModuleABI](web3.md#hoprnodemanagementmoduleabi) -- [hoprNodeSafeRegistryABI](web3.md#hoprnodesaferegistryabi) -- [hoprNodeStakeFactoryABI](web3.md#hoprnodestakefactoryabi) -- [hoprSafeABI](web3.md#hoprsafeabi) -- [hoprWrapperABI](web3.md#hoprwrapperabi) -- [mHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS](web3.md#mhopr_token_smart_contract_address) -- [wrapperABI](web3.md#wrapperabi) -- [wxHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS](web3.md#wxhopr_token_smart_contract_address) -- [wxHOPR\_WRAPPER\_SMART\_CONTRACT\_ADDRESS](web3.md#wxhopr_wrapper_smart_contract_address) -- [xHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS](web3.md#xhopr_token_smart_contract_address) - -## Variables - -### DUFOUR - -• `Const` **DUFOUR**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `addresses` | \{ `announcements`: `string` = '0x619eabE23FD0E2291B50a507719aa633fE6069b8'; `channels`: `string` = '0x693Bac5ce61c720dDC68533991Ceb41199D8F8ae'; `module_implementation`: `string` = '0xB7397C218766eBe6A1A634df523A1a7e412e67eA'; `network_registry`: `string` = '0x582b4b586168621dAf83bEb2AeADb5fb20F8d50d'; `network_registry_proxy`: `string` = '0x2bc6b78B0aA892e97714F0e3b1c74487f92C5884'; `node_safe_registry`: `string` = '0xe15C24a0910311c83aC78B5930d771089E93077b'; `node_stake_v2_factory`: `string` = '0x098B275485c406573D042848D66eb9d63fca311C'; `ticket_price_oracle`: `string` = '0xcA5656Fe6F2d847ACA32cf5f38E51D2054cA1273'; `token`: `string` = '0xD4fdec44DB9D44B8f2b6d529620f9C0C7066A2c1' } | -| `addresses.announcements` | `string` | -| `addresses.channels` | `string` | -| `addresses.module_implementation` | `string` | -| `addresses.network_registry` | `string` | -| `addresses.network_registry_proxy` | `string` | -| `addresses.node_safe_registry` | `string` | -| `addresses.node_stake_v2_factory` | `string` | -| `addresses.ticket_price_oracle` | `string` | -| `addresses.token` | `string` | -| `environment_type` | `string` | -| `indexer_start_block_number` | `number` | - -#### Defined in - -[src/ethereum/smartContractAddresses.ts:12](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/smartContractAddresses.ts#L12) - -___ - -### HOPR\_CHANNELS\_SMART\_CONTRACT\_ADDRESS - -• `Const` **HOPR\_CHANNELS\_SMART\_CONTRACT\_ADDRESS**: ``"0xfabee463f31e39ec8952bbfb4490c41103bf573e"`` - -#### Defined in - -[src/ethereum/smartContractAddresses.ts:2](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/smartContractAddresses.ts#L2) - -___ - -### erc721ABI - -• `Const` **erc721ABI**: (\{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = true; `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'Approval'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'balanceOf'; `outputs`: \{ `internalType`: `string` = 'uint256'; `name`: `string` = 'balance'; `type`: `string` = 'uint256' }[] ; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/erc721ABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/erc721ABI.ts#L1) - -___ - -### hoprBoostNFTABI - -• `Const` **hoprBoostNFTABI**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'newAdmin'; `type`: `string` = 'address' }[] ; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = true; `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'Approval'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'balanceOf'; `outputs`: \{ `internalType`: `string` = 'uint256'; `name`: `string` = ''; `type`: `string` = 'uint256' }[] ; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprBoostNFTABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprBoostNFTABI.ts#L1) - -___ - -### hoprChannelsABI - -• `Const` **hoprChannelsABI**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = '\_token'; `type`: `string` = 'address' }[] ; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'string'; `name`: `string` = 'reason'; `type`: `string` = 'string' }[] ; `name`: `string` = 'WrongChannelState'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'error' } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = true; `internalType`: `string` = 'bytes32'; `name`: `string` = 'channelId'; `type`: `string` = 'bytes32' }[] ; `name`: `string` = 'ChannelBalanceDecreased'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: (\{ `components?`: `undefined` ; `internalType`: `string` = 'bytes32'; `name`: `string` = 'ticketHash'; `type`: `string` = 'bytes32' } \| \{ `components`: (\{ `components`: \{ `internalType`: ... = 'bytes32'; `name`: ... = 'channelId'; `type`: ... = 'bytes32' }[] ; `internalType`: `string` = 'struct HoprChannels.TicketData'; `name`: `string` = 'data'; `type`: `string` = 'tuple' } \| \{ `components?`: `undefined` ; `internalType`: `string` = 'uint256'; `name`: `string` = 'porSecret'; `type`: `string` = 'uint256' })[] ; `internalType`: `string` = 'struct HoprChannels.RedeemableTicket'; `name`: `string` = 'redeemable'; `type`: `string` = 'tuple' })[] ; `name`: `string` = '\_isWinningTicket'; `outputs`: \{ `internalType`: `string` = 'bool'; `name`: `string` = ''; `type`: `string` = 'bool' }[] ; `stateMutability`: `string` = 'pure'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprChannelsABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprChannelsABI.ts#L1) - -___ - -### hoprMultiSendABI - -• `Const` **hoprMultiSendABI**: (\{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = true; `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'Approval'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'balanceOf'; `outputs`: \{ `internalType`: `string` = 'uint256'; `name`: `string` = 'balance'; `type`: `string` = 'uint256' }[] ; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprMultiSendABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprMultiSendABI.ts#L1) - -___ - -### hoprNetworkRegistryABI - -• `Const` **hoprNetworkRegistryABI**: (\{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = '\_requirementImplementation'; `type`: `string` = 'address' }[] ; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'nodeAddress'; `type`: `string` = 'address' }[] ; `name`: `string` = 'CannotOperateForNode'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'error' } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = true; `internalType`: `string` = 'address'; `name`: `string` = 'stakingAccount'; `type`: `string` = 'address' }[] ; `name`: `string` = 'Deregistered'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = ''; `type`: `string` = 'address' }[] ; `name`: `string` = 'countRegisterdNodesPerAccount'; `outputs`: \{ `internalType`: `string` = 'uint256'; `name`: `string` = ''; `type`: `string` = 'uint256' }[] ; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprNetworkRegistryABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprNetworkRegistryABI.ts#L1) - -___ - -### hoprNodeManagementModuleABI - -• `Const` **hoprNodeManagementModuleABI**: (\{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = 'AddressIsZero'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'error' } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = 'address'; `name`: `string` = 'previousAdmin'; `type`: `string` = 'address' }[] ; `name`: `string` = 'AdminChanged'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'bytes32'; `name`: `string` = 'encoded'; `type`: `string` = 'bytes32' }[] ; `name`: `string` = 'decodeFunctionSigsAndPermissions'; `outputs`: \{ `internalType`: `string` = 'bytes4[]'; `name`: `string` = 'functionSigs'; `type`: `string` = 'bytes4[]' }[] ; `stateMutability`: `string` = 'pure'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprNodeModuleABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprNodeModuleABI.ts#L1) - -___ - -### hoprNodeSafeRegistryABI - -• `Const` **hoprNodeSafeRegistryABI**: (\{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = 'NodeAddressZero'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'error' } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = true; `internalType`: `string` = 'address'; `name`: `string` = 'safeAddress'; `type`: `string` = 'address' }[] ; `name`: `string` = 'DergisteredNodeSafe'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `components`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'safeAddress'; `type`: `string` = 'address' }[] ; `internalType`: `string` = 'struct HoprNodeSafeRegistry.NodeSafe'; `name`: `string` = 'nodeSafe'; `type`: `string` = 'tuple' }[] ; `name`: `string` = 'isNodeSafeRegistered'; `outputs`: \{ `internalType`: `string` = 'bool'; `name`: `string` = ''; `type`: `string` = 'bool' }[] ; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = ''; `type`: `string` = 'address' }[] ; `name`: `string` = 'nodeToSafe'; `outputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = ''; `type`: `string` = 'address' }[] ; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' } \| \{ `anonymous?`: `undefined` = false; `inputs`: (\{ `components`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'safeAddress'; `type`: `string` = 'address' }[] ; `internalType`: `string` = 'struct HoprNodeSafeRegistry.NodeSafe'; `name`: `string` = 'nodeSafe'; `type`: `string` = 'tuple' } \| \{ `components?`: `undefined` ; `internalType`: `string` = 'bytes'; `name`: `string` = 'sig'; `type`: `string` = 'bytes' })[] ; `name`: `string` = 'registerSafeWithNodeSig'; `outputs`: `never`[] = []; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprNodeSafeRegistryABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprNodeSafeRegistryABI.ts#L1) - -___ - -### hoprNodeStakeFactoryABI - -• `Const` **hoprNodeStakeFactoryABI**: (\{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous?`: `undefined` = false; `inputs`: `never`[] = []; `name`: `string` = 'TooFewOwners'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'error' } \| \{ `anonymous`: `boolean` = false; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = 'address'; `name`: `string` = 'instance'; `type`: `string` = 'address' }[] ; `name`: `string` = 'NewHoprNodeStakeModule'; `outputs?`: `undefined` ; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = 'moduleSingletonAddress'; `type`: `string` = 'address' }[] ; `name`: `string` = 'clone'; `outputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = ''; `type`: `string` = 'address' }[] ; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprNodeStakeFactoryABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprNodeStakeFactoryABI.ts#L1) - -___ - -### hoprSafeABI - -• `Const` **hoprSafeABI**: (\{ `anonymous?`: `undefined` = false; `constant?`: `undefined` = true; `inputs`: `never`[] = []; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `payable`: `boolean` = false; `stateMutability`: `string` = 'nonpayable'; `type`: `string` = 'constructor' } \| \{ `anonymous`: `boolean` = false; `constant?`: `undefined` = true; `inputs`: \{ `indexed`: `boolean` = false; `internalType`: `string` = 'address'; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'AddedOwner'; `outputs?`: `undefined` ; `payable?`: `undefined` = true; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' } \| \{ `anonymous?`: `undefined` = false; `constant?`: `undefined` = true; `inputs?`: `undefined` ; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `payable`: `boolean` = true; `stateMutability`: `string` = 'payable'; `type`: `string` = 'fallback' } \| \{ `anonymous?`: `undefined` = false; `constant`: `boolean` = true; `inputs`: \{ `internalType`: `string` = 'address'; `name`: `string` = ''; `type`: `string` = 'address' }[] ; `name`: `string` = 'approvedHashes'; `outputs`: \{ `internalType`: `string` = 'uint256'; `name`: `string` = ''; `type`: `string` = 'uint256' }[] ; `payable`: `boolean` = false; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprSafeABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprSafeABI.ts#L1) - -___ - -### hoprWrapperABI - -• `Const` **hoprWrapperABI**: (\{ `anonymous?`: `undefined` = false; `constant`: `boolean` = true; `inputs`: \{ `name`: `string` = '\_owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'balanceOf'; `outputs`: \{ `name`: `string` = 'balance'; `type`: `string` = 'uint256' }[] ; `payable`: `boolean` = false; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' } \| \{ `anonymous?`: `undefined` = false; `constant?`: `undefined` = true; `inputs?`: `undefined` ; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `payable`: `boolean` = true; `stateMutability`: `string` = 'payable'; `type`: `string` = 'fallback' } \| \{ `anonymous`: `boolean` = false; `constant?`: `undefined` = true; `inputs`: \{ `indexed`: `boolean` = true; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'Approval'; `outputs?`: `undefined` ; `payable?`: `undefined` = true; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' })[] - -#### Defined in - -[src/ethereum/stakingV2/hoprWrapperABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/stakingV2/hoprWrapperABI.ts#L1) - -___ - -### mHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS - -• `Const` **mHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS**: ``"0x66225dE86Cac02b32f34992eb3410F59DE416698"`` - -#### Defined in - -[src/ethereum/smartContractAddresses.ts:4](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/smartContractAddresses.ts#L4) - -___ - -### wrapperABI - -• `Const` **wrapperABI**: (\{ `anonymous?`: `undefined` = false; `constant`: `boolean` = true; `inputs`: \{ `name`: `string` = '\_owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'balanceOf'; `outputs`: \{ `name`: `string` = 'balance'; `type`: `string` = 'uint256' }[] ; `payable`: `boolean` = false; `stateMutability`: `string` = 'view'; `type`: `string` = 'function' } \| \{ `anonymous?`: `undefined` = false; `constant?`: `undefined` = true; `inputs?`: `undefined` ; `name?`: `undefined` = 'Approval'; `outputs?`: `undefined` ; `payable`: `boolean` = true; `stateMutability`: `string` = 'payable'; `type`: `string` = 'fallback' } \| \{ `anonymous`: `boolean` = false; `constant?`: `undefined` = true; `inputs`: \{ `indexed`: `boolean` = true; `name`: `string` = 'owner'; `type`: `string` = 'address' }[] ; `name`: `string` = 'Approval'; `outputs?`: `undefined` ; `payable?`: `undefined` = true; `stateMutability?`: `undefined` = 'payable'; `type`: `string` = 'event' })[] - -#### Defined in - -[src/ethereum/wrapperABI.ts:1](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/wrapperABI.ts#L1) - -___ - -### wxHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS - -• `Const` **wxHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS**: ``"0xD4fdec44DB9D44B8f2b6d529620f9C0C7066A2c1"`` - -#### Defined in - -[src/ethereum/smartContractAddresses.ts:8](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/smartContractAddresses.ts#L8) - -___ - -### wxHOPR\_WRAPPER\_SMART\_CONTRACT\_ADDRESS - -• `Const` **wxHOPR\_WRAPPER\_SMART\_CONTRACT\_ADDRESS**: ``"0x097707143e01318734535676cfe2e5cF8b656ae8"`` - -#### Defined in - -[src/ethereum/smartContractAddresses.ts:10](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/smartContractAddresses.ts#L10) - -___ - -### xHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS - -• `Const` **xHOPR\_TOKEN\_SMART\_CONTRACT\_ADDRESS**: ``"0xD057604A14982FE8D88c5fC25Aac3267eA142a08"`` - -#### Defined in - -[src/ethereum/smartContractAddresses.ts:6](https://github.com/hoprnet/hopr-sdk/blob/7b4777d5661880e8518778cfcfa0ac332679e349/src/ethereum/smartContractAddresses.ts#L6) diff --git a/docs/types/AggregateChannelTicketsPayloadType.html b/docs/types/AggregateChannelTicketsPayloadType.html new file mode 100644 index 00000000..05a33ad1 --- /dev/null +++ b/docs/types/AggregateChannelTicketsPayloadType.html @@ -0,0 +1,4 @@ +AggregateChannelTicketsPayloadType | @hoprnet/hopr-sdk

Type alias AggregateChannelTicketsPayloadType

AggregateChannelTicketsPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AliasPayloadType.html b/docs/types/AliasPayloadType.html new file mode 100644 index 00000000..999bc1e1 --- /dev/null +++ b/docs/types/AliasPayloadType.html @@ -0,0 +1,4 @@ +AliasPayloadType | @hoprnet/hopr-sdk

Type alias AliasPayloadType

AliasPayloadType: {
    alias: string;
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Type declaration

  • alias: string
  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/ApiErrorResponseType.html b/docs/types/ApiErrorResponseType.html new file mode 100644 index 00000000..f0c7336c --- /dev/null +++ b/docs/types/ApiErrorResponseType.html @@ -0,0 +1 @@ +ApiErrorResponseType | @hoprnet/hopr-sdk

Type alias ApiErrorResponseType

ApiErrorResponseType: {
    error?: string;
    status: string;
}

Type declaration

  • Optional error?: string
  • status: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/BasePayloadType.html b/docs/types/BasePayloadType.html new file mode 100644 index 00000000..9c166285 --- /dev/null +++ b/docs/types/BasePayloadType.html @@ -0,0 +1,5 @@ +BasePayloadType | @hoprnet/hopr-sdk

Type alias BasePayloadType

BasePayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Represents the inferred TypeScript type from BasicAuthenticationPayload.

+

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/ChainPayloadType.html b/docs/types/ChainPayloadType.html new file mode 100644 index 00000000..ed1c8327 --- /dev/null +++ b/docs/types/ChainPayloadType.html @@ -0,0 +1 @@ +ChainPayloadType | @hoprnet/hopr-sdk

Type alias ChainPayloadType

ChainPayloadType: {
    block_time: null | number;
    chain_id: number;
    default_provider: null | string;
    description: null | string;
    etherscan_api_url: null | string;
    hopr_token_name: null | string;
    live: boolean;
    max_fee_per_gas: null | string;
    max_priority_fee_per_gas: null | string;
    native_token_name: null | string;
    tags: null | string[];
}

Type declaration

  • block_time: null | number
  • chain_id: number
  • default_provider: null | string
  • description: null | string
  • etherscan_api_url: null | string
  • hopr_token_name: null | string
  • live: boolean
  • max_fee_per_gas: null | string
  • max_priority_fee_per_gas: null | string
  • native_token_name: null | string
  • tags: null | string[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/CloseChannelPayloadType.html b/docs/types/CloseChannelPayloadType.html new file mode 100644 index 00000000..19efb388 --- /dev/null +++ b/docs/types/CloseChannelPayloadType.html @@ -0,0 +1,4 @@ +CloseChannelPayloadType | @hoprnet/hopr-sdk

Type alias CloseChannelPayloadType

CloseChannelPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/CloseChannelResponseType.html b/docs/types/CloseChannelResponseType.html new file mode 100644 index 00000000..44dd6956 --- /dev/null +++ b/docs/types/CloseChannelResponseType.html @@ -0,0 +1 @@ +CloseChannelResponseType | @hoprnet/hopr-sdk

Type alias CloseChannelResponseType

CloseChannelResponseType: {
    channelStatus: "Open" | "PendingToClose" | "Closed";
    receipt: string;
}

Type declaration

  • channelStatus: "Open" | "PendingToClose" | "Closed"
  • receipt: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/CreateTokenPayloadType.html b/docs/types/CreateTokenPayloadType.html new file mode 100644 index 00000000..ef636b61 --- /dev/null +++ b/docs/types/CreateTokenPayloadType.html @@ -0,0 +1,4 @@ +CreateTokenPayloadType | @hoprnet/hopr-sdk

Type alias CreateTokenPayloadType

CreateTokenPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    capabilities: {
        endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
        limits: {
            conditions?: {
                max?: number;
            };
            type: string;
        }[];
    }[];
    description: string;
    lifetime: number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • capabilities: {
        endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
        limits: {
            conditions?: {
                max?: number;
            };
            type: string;
        }[];
    }[]
  • description: string
  • lifetime: number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/CreateTokenResponseType.html b/docs/types/CreateTokenResponseType.html new file mode 100644 index 00000000..551f353d --- /dev/null +++ b/docs/types/CreateTokenResponseType.html @@ -0,0 +1 @@ +CreateTokenResponseType | @hoprnet/hopr-sdk

Type alias CreateTokenResponseType

CreateTokenResponseType: {
    token: string;
}

Type declaration

  • token: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/DeleteMessagesPayloadType.html b/docs/types/DeleteMessagesPayloadType.html new file mode 100644 index 00000000..db5bfee9 --- /dev/null +++ b/docs/types/DeleteMessagesPayloadType.html @@ -0,0 +1,4 @@ +DeleteMessagesPayloadType | @hoprnet/hopr-sdk

Type alias DeleteMessagesPayloadType

DeleteMessagesPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    tag?: number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional tag?: number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/DeleteTokenPayloadType.html b/docs/types/DeleteTokenPayloadType.html new file mode 100644 index 00000000..fead67f6 --- /dev/null +++ b/docs/types/DeleteTokenPayloadType.html @@ -0,0 +1,4 @@ +DeleteTokenPayloadType | @hoprnet/hopr-sdk

Type alias DeleteTokenPayloadType

DeleteTokenPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    id: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • id: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/FundChannelsPayloadType.html b/docs/types/FundChannelsPayloadType.html new file mode 100644 index 00000000..ab6b6845 --- /dev/null +++ b/docs/types/FundChannelsPayloadType.html @@ -0,0 +1,4 @@ +FundChannelsPayloadType | @hoprnet/hopr-sdk

Type alias FundChannelsPayloadType

FundChannelsPayloadType: {
    amount: string;
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}

Type declaration

  • amount: string
  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/FundChannelsResponseType.html b/docs/types/FundChannelsResponseType.html new file mode 100644 index 00000000..55ff40a4 --- /dev/null +++ b/docs/types/FundChannelsResponseType.html @@ -0,0 +1 @@ +FundChannelsResponseType | @hoprnet/hopr-sdk

Type alias FundChannelsResponseType

FundChannelsResponseType: {
    receipt: string;
}

Type declaration

  • receipt: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetAddressesResponseType.html b/docs/types/GetAddressesResponseType.html new file mode 100644 index 00000000..6540f7aa --- /dev/null +++ b/docs/types/GetAddressesResponseType.html @@ -0,0 +1 @@ +GetAddressesResponseType | @hoprnet/hopr-sdk

Type alias GetAddressesResponseType

GetAddressesResponseType: {
    hopr: string;
    native: string;
}

Type declaration

  • hopr: string
  • native: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetAliasResponseType.html b/docs/types/GetAliasResponseType.html new file mode 100644 index 00000000..4d368750 --- /dev/null +++ b/docs/types/GetAliasResponseType.html @@ -0,0 +1 @@ +GetAliasResponseType | @hoprnet/hopr-sdk

Type alias GetAliasResponseType

GetAliasResponseType: {
    peerId: string;
}

Type declaration

  • peerId: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetAliasesResponseType.html b/docs/types/GetAliasesResponseType.html new file mode 100644 index 00000000..dee93aaa --- /dev/null +++ b/docs/types/GetAliasesResponseType.html @@ -0,0 +1 @@ +GetAliasesResponseType | @hoprnet/hopr-sdk

Type alias GetAliasesResponseType

GetAliasesResponseType: Record<string, string>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetBalancesResponseType.html b/docs/types/GetBalancesResponseType.html new file mode 100644 index 00000000..b19aef06 --- /dev/null +++ b/docs/types/GetBalancesResponseType.html @@ -0,0 +1 @@ +GetBalancesResponseType | @hoprnet/hopr-sdk

Type alias GetBalancesResponseType

GetBalancesResponseType: {
    hopr: string;
    native: string;
    safeHopr: string;
    safeHoprAllowance: string;
    safeNative: string;
}

Type declaration

  • hopr: string
  • native: string
  • safeHopr: string
  • safeHoprAllowance: string
  • safeNative: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetChannelPayloadType.html b/docs/types/GetChannelPayloadType.html new file mode 100644 index 00000000..9f37f7ae --- /dev/null +++ b/docs/types/GetChannelPayloadType.html @@ -0,0 +1,4 @@ +GetChannelPayloadType | @hoprnet/hopr-sdk

Type alias GetChannelPayloadType

GetChannelPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetChannelResponseType.html b/docs/types/GetChannelResponseType.html new file mode 100644 index 00000000..78d133bd --- /dev/null +++ b/docs/types/GetChannelResponseType.html @@ -0,0 +1 @@ +GetChannelResponseType | @hoprnet/hopr-sdk

Type alias GetChannelResponseType

GetChannelResponseType: {
    balance: string;
    channelEpoch: number;
    channelId: string;
    closureTime: number;
    destinationAddress: string;
    destinationPeerId: string;
    sourceAddress: string;
    sourcePeerId: string;
    status: "Open" | "PendingToClose" | "Closed";
    ticketIndex: string;
}

Type declaration

  • balance: string
  • channelEpoch: number
  • channelId: string
  • closureTime: number
  • destinationAddress: string
  • destinationPeerId: string
  • sourceAddress: string
  • sourcePeerId: string
  • status: "Open" | "PendingToClose" | "Closed"
  • ticketIndex: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetChannelTicketsPayloadType.html b/docs/types/GetChannelTicketsPayloadType.html new file mode 100644 index 00000000..d474fd85 --- /dev/null +++ b/docs/types/GetChannelTicketsPayloadType.html @@ -0,0 +1,4 @@ +GetChannelTicketsPayloadType | @hoprnet/hopr-sdk

Type alias GetChannelTicketsPayloadType

GetChannelTicketsPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetChannelTicketsResponseType.html b/docs/types/GetChannelTicketsResponseType.html new file mode 100644 index 00000000..98dc7338 --- /dev/null +++ b/docs/types/GetChannelTicketsResponseType.html @@ -0,0 +1 @@ +GetChannelTicketsResponseType | @hoprnet/hopr-sdk

Type alias GetChannelTicketsResponseType

GetChannelTicketsResponseType: {
    amount: string;
    channelEpoch: number;
    channelId: string;
    index: number;
    indexOffset: number;
    signature: string;
    winProb: string;
}[]

Type declaration

  • amount: string
  • channelEpoch: number
  • channelId: string
  • index: number
  • indexOffset: number
  • signature: string
  • winProb: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetChannelsPayloadType.html b/docs/types/GetChannelsPayloadType.html new file mode 100644 index 00000000..e0887821 --- /dev/null +++ b/docs/types/GetChannelsPayloadType.html @@ -0,0 +1,4 @@ +GetChannelsPayloadType | @hoprnet/hopr-sdk

Type alias GetChannelsPayloadType

GetChannelsPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    fullTopology?: boolean;
    includingClosed?: boolean;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional fullTopology?: boolean
  • Optional includingClosed?: boolean
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetChannelsResponseType.html b/docs/types/GetChannelsResponseType.html new file mode 100644 index 00000000..9f2ed256 --- /dev/null +++ b/docs/types/GetChannelsResponseType.html @@ -0,0 +1 @@ +GetChannelsResponseType | @hoprnet/hopr-sdk

Type alias GetChannelsResponseType

GetChannelsResponseType: {
    all: {
        balance: string;
        channelEpoch: number;
        channelId: string;
        closureTime: number;
        destinationAddress: string;
        destinationPeerId: string;
        sourceAddress: string;
        sourcePeerId: string;
        status: "Open" | "PendingToClose" | "Closed";
        ticketIndex: string;
    }[];
    incoming: {
        balance: string;
        id: string;
        peerAddress: string;
        status: "Open" | "PendingToClose" | "Closed";
    }[];
    outgoing: {
        balance: string;
        id: string;
        peerAddress: string;
        status: "Open" | "PendingToClose" | "Closed";
    }[];
}

Type declaration

  • all: {
        balance: string;
        channelEpoch: number;
        channelId: string;
        closureTime: number;
        destinationAddress: string;
        destinationPeerId: string;
        sourceAddress: string;
        sourcePeerId: string;
        status: "Open" | "PendingToClose" | "Closed";
        ticketIndex: string;
    }[]
  • incoming: {
        balance: string;
        id: string;
        peerAddress: string;
        status: "Open" | "PendingToClose" | "Closed";
    }[]
  • outgoing: {
        balance: string;
        id: string;
        peerAddress: string;
        status: "Open" | "PendingToClose" | "Closed";
    }[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetConfigurationPayloadType.html b/docs/types/GetConfigurationPayloadType.html new file mode 100644 index 00000000..a0636e85 --- /dev/null +++ b/docs/types/GetConfigurationPayloadType.html @@ -0,0 +1,4 @@ +GetConfigurationPayloadType | @hoprnet/hopr-sdk

Type alias GetConfigurationPayloadType

GetConfigurationPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetConfigurationResponseType.html b/docs/types/GetConfigurationResponseType.html new file mode 100644 index 00000000..ad4a6324 --- /dev/null +++ b/docs/types/GetConfigurationResponseType.html @@ -0,0 +1 @@ +GetConfigurationResponseType | @hoprnet/hopr-sdk

Type alias GetConfigurationResponseType

GetConfigurationResponseType: any

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetEntryNodesResponseType.html b/docs/types/GetEntryNodesResponseType.html new file mode 100644 index 00000000..989728a3 --- /dev/null +++ b/docs/types/GetEntryNodesResponseType.html @@ -0,0 +1 @@ +GetEntryNodesResponseType | @hoprnet/hopr-sdk

Type alias GetEntryNodesResponseType

GetEntryNodesResponseType: Record<string, {
    isEligible: boolean;
    multiaddrs: string[];
}>

Type declaration

  • isEligible: boolean
  • multiaddrs: string[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetInfoResponseType.html b/docs/types/GetInfoResponseType.html new file mode 100644 index 00000000..88909b03 --- /dev/null +++ b/docs/types/GetInfoResponseType.html @@ -0,0 +1 @@ +GetInfoResponseType | @hoprnet/hopr-sdk

Type alias GetInfoResponseType

GetInfoResponseType: {
    announcedAddress: string[];
    chain: string;
    channelClosurePeriod: number;
    connectivityStatus: "Unknown" | "Red" | "Orange" | "Yellow" | "Green";
    hoprChannels: string;
    hoprManagementModule: string;
    hoprNetworkRegistry?: string;
    hoprNodeSafe: string;
    hoprNodeSafeRegistry?: string;
    hoprToken: string;
    indexBlockPrevChecksum?: number;
    indexerBlock?: number;
    indexerChecksum?: string;
    isEligible: boolean;
    listeningAddress: string[];
    network: string;
}

Type declaration

  • announcedAddress: string[]
  • chain: string
  • channelClosurePeriod: number
  • connectivityStatus: "Unknown" | "Red" | "Orange" | "Yellow" | "Green"
  • hoprChannels: string
  • hoprManagementModule: string
  • Optional hoprNetworkRegistry?: string
  • hoprNodeSafe: string
  • Optional hoprNodeSafeRegistry?: string
  • hoprToken: string
  • Optional indexBlockPrevChecksum?: number
  • Optional indexerBlock?: number
  • Optional indexerChecksum?: string
  • isEligible: boolean
  • listeningAddress: string[]
  • network: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetMessagesSizePayloadType.html b/docs/types/GetMessagesSizePayloadType.html new file mode 100644 index 00000000..ab5309cd --- /dev/null +++ b/docs/types/GetMessagesSizePayloadType.html @@ -0,0 +1,4 @@ +GetMessagesSizePayloadType | @hoprnet/hopr-sdk

Type alias GetMessagesSizePayloadType

GetMessagesSizePayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    tag: number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • tag: number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetMessagesSizeResponseType.html b/docs/types/GetMessagesSizeResponseType.html new file mode 100644 index 00000000..d2779ce9 --- /dev/null +++ b/docs/types/GetMessagesSizeResponseType.html @@ -0,0 +1 @@ +GetMessagesSizeResponseType | @hoprnet/hopr-sdk

Type alias GetMessagesSizeResponseType

GetMessagesSizeResponseType: {
    size: number;
}

Type declaration

  • size: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetPeerPayloadType.html b/docs/types/GetPeerPayloadType.html new file mode 100644 index 00000000..ea65c735 --- /dev/null +++ b/docs/types/GetPeerPayloadType.html @@ -0,0 +1,4 @@ +GetPeerPayloadType | @hoprnet/hopr-sdk

Type alias GetPeerPayloadType

GetPeerPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    peerId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • peerId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetPeerResponseType.html b/docs/types/GetPeerResponseType.html new file mode 100644 index 00000000..02161b1a --- /dev/null +++ b/docs/types/GetPeerResponseType.html @@ -0,0 +1 @@ +GetPeerResponseType | @hoprnet/hopr-sdk

Type alias GetPeerResponseType

GetPeerResponseType: {
    announced: string[];
    observed: string[];
}

Type declaration

  • announced: string[]
  • observed: string[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetPeersPayloadType.html b/docs/types/GetPeersPayloadType.html new file mode 100644 index 00000000..c1291da2 --- /dev/null +++ b/docs/types/GetPeersPayloadType.html @@ -0,0 +1,4 @@ +GetPeersPayloadType | @hoprnet/hopr-sdk

Type alias GetPeersPayloadType

GetPeersPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    quality?: number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional quality?: number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetPeersResponseType.html b/docs/types/GetPeersResponseType.html new file mode 100644 index 00000000..357aba7a --- /dev/null +++ b/docs/types/GetPeersResponseType.html @@ -0,0 +1 @@ +GetPeersResponseType | @hoprnet/hopr-sdk

Type alias GetPeersResponseType

GetPeersResponseType: {
    announced: {
        multiaddr: null | string;
        peerAddress: string;
        peerId: string;
    }[];
    connected: {
        backoff: number;
        heartbeats: {
            sent: number;
            success: number;
        };
        isNew: boolean;
        lastSeen: number;
        lastSeenLatency: number;
        multiaddr: null | string;
        peerAddress: string;
        peerId: string;
        quality: number;
        reportedVersion: string;
    }[];
}

Type declaration

  • announced: {
        multiaddr: null | string;
        peerAddress: string;
        peerId: string;
    }[]
  • connected: {
        backoff: number;
        heartbeats: {
            sent: number;
            success: number;
        };
        isNew: boolean;
        lastSeen: number;
        lastSeenLatency: number;
        multiaddr: null | string;
        peerAddress: string;
        peerId: string;
        quality: number;
        reportedVersion: string;
    }[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetTicketPricePayloadType.html b/docs/types/GetTicketPricePayloadType.html new file mode 100644 index 00000000..c31d8141 --- /dev/null +++ b/docs/types/GetTicketPricePayloadType.html @@ -0,0 +1,4 @@ +GetTicketPricePayloadType | @hoprnet/hopr-sdk

Type alias GetTicketPricePayloadType

GetTicketPricePayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetTicketPriceResponseType.html b/docs/types/GetTicketPriceResponseType.html new file mode 100644 index 00000000..8012f761 --- /dev/null +++ b/docs/types/GetTicketPriceResponseType.html @@ -0,0 +1 @@ +GetTicketPriceResponseType | @hoprnet/hopr-sdk

Type alias GetTicketPriceResponseType

GetTicketPriceResponseType: {
    price: string;
}

Type declaration

  • price: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetTicketStatisticsResponseType.html b/docs/types/GetTicketStatisticsResponseType.html new file mode 100644 index 00000000..b6043ef1 --- /dev/null +++ b/docs/types/GetTicketStatisticsResponseType.html @@ -0,0 +1 @@ +GetTicketStatisticsResponseType | @hoprnet/hopr-sdk

Type alias GetTicketStatisticsResponseType

GetTicketStatisticsResponseType: {
    neglectedValue: string;
    redeemedValue: string;
    rejectedValue: string;
    unredeemedValue: string;
    winningCount: number;
}

Type declaration

  • neglectedValue: string
  • redeemedValue: string
  • rejectedValue: string
  • unredeemedValue: string
  • winningCount: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/GetTokenResponseType.html b/docs/types/GetTokenResponseType.html new file mode 100644 index 00000000..cbea1cbd --- /dev/null +++ b/docs/types/GetTokenResponseType.html @@ -0,0 +1 @@ +GetTokenResponseType | @hoprnet/hopr-sdk

Type alias GetTokenResponseType

GetTokenResponseType: {
    capabilities: {
        endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
        limits: {
            conditions?: {
                max?: number;
            };
            type: string;
        }[];
    }[];
    description?: string;
    id: string;
    valid_until?: number;
}

Type declaration

  • capabilities: {
        endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
        limits: {
            conditions?: {
                max?: number;
            };
            type: string;
        }[];
    }[]
  • Optional description?: string
  • id: string
  • Optional valid_until?: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/IsNodeHealthyPayloadType.html b/docs/types/IsNodeHealthyPayloadType.html new file mode 100644 index 00000000..d462e43f --- /dev/null +++ b/docs/types/IsNodeHealthyPayloadType.html @@ -0,0 +1,4 @@ +IsNodeHealthyPayloadType | @hoprnet/hopr-sdk

Type alias IsNodeHealthyPayloadType

IsNodeHealthyPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/IsNodeHealthyResponseType.html b/docs/types/IsNodeHealthyResponseType.html new file mode 100644 index 00000000..e3792a4a --- /dev/null +++ b/docs/types/IsNodeHealthyResponseType.html @@ -0,0 +1 @@ +IsNodeHealthyResponseType | @hoprnet/hopr-sdk

Type alias IsNodeHealthyResponseType

IsNodeHealthyResponseType: boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/IsNodeReadyPayloadType.html b/docs/types/IsNodeReadyPayloadType.html new file mode 100644 index 00000000..49689dea --- /dev/null +++ b/docs/types/IsNodeReadyPayloadType.html @@ -0,0 +1,4 @@ +IsNodeReadyPayloadType | @hoprnet/hopr-sdk

Type alias IsNodeReadyPayloadType

IsNodeReadyPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/IsNodeReadyResponseType.html b/docs/types/IsNodeReadyResponseType.html new file mode 100644 index 00000000..d9bbd5b0 --- /dev/null +++ b/docs/types/IsNodeReadyResponseType.html @@ -0,0 +1 @@ +IsNodeReadyResponseType | @hoprnet/hopr-sdk

Type alias IsNodeReadyResponseType

IsNodeReadyResponseType: boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/IsNodeStartedPayloadType.html b/docs/types/IsNodeStartedPayloadType.html new file mode 100644 index 00000000..3e7e30b5 --- /dev/null +++ b/docs/types/IsNodeStartedPayloadType.html @@ -0,0 +1,4 @@ +IsNodeStartedPayloadType | @hoprnet/hopr-sdk

Type alias IsNodeStartedPayloadType

IsNodeStartedPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/IsNodeStartedResponseType.html b/docs/types/IsNodeStartedResponseType.html new file mode 100644 index 00000000..26170861 --- /dev/null +++ b/docs/types/IsNodeStartedResponseType.html @@ -0,0 +1 @@ +IsNodeStartedResponseType | @hoprnet/hopr-sdk

Type alias IsNodeStartedResponseType

IsNodeStartedResponseType: boolean

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/NetworkPayloadType.html b/docs/types/NetworkPayloadType.html new file mode 100644 index 00000000..fb689b92 --- /dev/null +++ b/docs/types/NetworkPayloadType.html @@ -0,0 +1 @@ +NetworkPayloadType | @hoprnet/hopr-sdk

Type alias NetworkPayloadType

NetworkPayloadType: {
    addresses: {
        announcements: string;
        channels: string;
        module_implementation: string;
        network_registry: string;
        network_registry_proxy: string;
        node_safe_registry: string;
        node_stake_v2_factory: string;
        ticket_price_oracle: string;
        token: string;
    };
    chain: string;
    confirmations: number;
    environment_type: string;
    indexer_start_block_number: number;
    max_block_range: number;
    tags: null | string[];
    tx_polling_interval: number;
    version_range: string;
}

Type declaration

  • addresses: {
        announcements: string;
        channels: string;
        module_implementation: string;
        network_registry: string;
        network_registry_proxy: string;
        node_safe_registry: string;
        node_stake_v2_factory: string;
        ticket_price_oracle: string;
        token: string;
    }
    • announcements: string
    • channels: string
    • module_implementation: string
    • network_registry: string
    • network_registry_proxy: string
    • node_safe_registry: string
    • node_stake_v2_factory: string
    • ticket_price_oracle: string
    • token: string
  • chain: string
  • confirmations: number
  • environment_type: string
  • indexer_start_block_number: number
  • max_block_range: number
  • tags: null | string[]
  • tx_polling_interval: number
  • version_range: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/OpenChannelPayloadType.html b/docs/types/OpenChannelPayloadType.html new file mode 100644 index 00000000..671e1e83 --- /dev/null +++ b/docs/types/OpenChannelPayloadType.html @@ -0,0 +1,4 @@ +OpenChannelPayloadType | @hoprnet/hopr-sdk

Type alias OpenChannelPayloadType

OpenChannelPayloadType: {
    amount: string;
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    peerAddress: string;
    timeout?: number;
}

Type declaration

  • amount: string
  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • peerAddress: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/OpenChannelResponseType.html b/docs/types/OpenChannelResponseType.html new file mode 100644 index 00000000..4a14e6d6 --- /dev/null +++ b/docs/types/OpenChannelResponseType.html @@ -0,0 +1 @@ +OpenChannelResponseType | @hoprnet/hopr-sdk

Type alias OpenChannelResponseType

OpenChannelResponseType: {
    channelId: string;
    transactionReceipt: string;
}

Type declaration

  • channelId: string
  • transactionReceipt: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PeekAllMessagesPayloadType.html b/docs/types/PeekAllMessagesPayloadType.html new file mode 100644 index 00000000..21584395 --- /dev/null +++ b/docs/types/PeekAllMessagesPayloadType.html @@ -0,0 +1,4 @@ +PeekAllMessagesPayloadType | @hoprnet/hopr-sdk

Type alias PeekAllMessagesPayloadType

PeekAllMessagesPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    tag?: null | number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional tag?: null | number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PeekAllMessagesResponseType.html b/docs/types/PeekAllMessagesResponseType.html new file mode 100644 index 00000000..fb4f05c6 --- /dev/null +++ b/docs/types/PeekAllMessagesResponseType.html @@ -0,0 +1 @@ +PeekAllMessagesResponseType | @hoprnet/hopr-sdk

Type alias PeekAllMessagesResponseType

PeekAllMessagesResponseType: {
    messages: {
        body: string;
        receivedAt: number;
        tag: number;
    }[];
}

Type declaration

  • messages: {
        body: string;
        receivedAt: number;
        tag: number;
    }[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PeekMessagePayloadType.html b/docs/types/PeekMessagePayloadType.html new file mode 100644 index 00000000..db1d8195 --- /dev/null +++ b/docs/types/PeekMessagePayloadType.html @@ -0,0 +1,4 @@ +PeekMessagePayloadType | @hoprnet/hopr-sdk

Type alias PeekMessagePayloadType

PeekMessagePayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    tag?: null | number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional tag?: null | number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PeekMessageResponseType.html b/docs/types/PeekMessageResponseType.html new file mode 100644 index 00000000..ae3031fa --- /dev/null +++ b/docs/types/PeekMessageResponseType.html @@ -0,0 +1 @@ +PeekMessageResponseType | @hoprnet/hopr-sdk

Type alias PeekMessageResponseType

PeekMessageResponseType: {
    body: string;
    receivedAt: number;
    tag: number;
}

Type declaration

  • body: string
  • receivedAt: number
  • tag: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PingPeerPayloadType.html b/docs/types/PingPeerPayloadType.html new file mode 100644 index 00000000..03de8705 --- /dev/null +++ b/docs/types/PingPeerPayloadType.html @@ -0,0 +1,4 @@ +PingPeerPayloadType | @hoprnet/hopr-sdk

Type alias PingPeerPayloadType

PingPeerPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    peerId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • peerId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PingPeerResponseType.html b/docs/types/PingPeerResponseType.html new file mode 100644 index 00000000..ff3c84dc --- /dev/null +++ b/docs/types/PingPeerResponseType.html @@ -0,0 +1 @@ +PingPeerResponseType | @hoprnet/hopr-sdk

Type alias PingPeerResponseType

PingPeerResponseType: {
    latency: number;
    reportedVersion: string;
}

Type declaration

  • latency: number
  • reportedVersion: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PopAllMessagesPayloadType.html b/docs/types/PopAllMessagesPayloadType.html new file mode 100644 index 00000000..0f36d109 --- /dev/null +++ b/docs/types/PopAllMessagesPayloadType.html @@ -0,0 +1,4 @@ +PopAllMessagesPayloadType | @hoprnet/hopr-sdk

Type alias PopAllMessagesPayloadType

PopAllMessagesPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    tag?: null | number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional tag?: null | number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PopAllMessagesResponseType.html b/docs/types/PopAllMessagesResponseType.html new file mode 100644 index 00000000..d3311242 --- /dev/null +++ b/docs/types/PopAllMessagesResponseType.html @@ -0,0 +1 @@ +PopAllMessagesResponseType | @hoprnet/hopr-sdk

Type alias PopAllMessagesResponseType

PopAllMessagesResponseType: {
    messages: {
        body: string;
        receivedAt: number;
        tag: number;
    }[];
}

Type declaration

  • messages: {
        body: string;
        receivedAt: number;
        tag: number;
    }[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PopMessagePayloadType.html b/docs/types/PopMessagePayloadType.html new file mode 100644 index 00000000..8721827a --- /dev/null +++ b/docs/types/PopMessagePayloadType.html @@ -0,0 +1,4 @@ +PopMessagePayloadType | @hoprnet/hopr-sdk

Type alias PopMessagePayloadType

PopMessagePayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    tag?: null | number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional tag?: null | number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/PopMessageResponseType.html b/docs/types/PopMessageResponseType.html new file mode 100644 index 00000000..464c708f --- /dev/null +++ b/docs/types/PopMessageResponseType.html @@ -0,0 +1 @@ +PopMessageResponseType | @hoprnet/hopr-sdk

Type alias PopMessageResponseType

PopMessageResponseType: {
    body: string;
    receivedAt: number;
    tag: number;
}

Type declaration

  • body: string
  • receivedAt: number
  • tag: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/RedeemChannelTicketsPayloadType.html b/docs/types/RedeemChannelTicketsPayloadType.html new file mode 100644 index 00000000..b7d4cca7 --- /dev/null +++ b/docs/types/RedeemChannelTicketsPayloadType.html @@ -0,0 +1,4 @@ +RedeemChannelTicketsPayloadType | @hoprnet/hopr-sdk

Type alias RedeemChannelTicketsPayloadType

RedeemChannelTicketsPayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/RemoveBasicAuthenticationPayloadType.html b/docs/types/RemoveBasicAuthenticationPayloadType.html new file mode 100644 index 00000000..78606ad6 --- /dev/null +++ b/docs/types/RemoveBasicAuthenticationPayloadType.html @@ -0,0 +1,3 @@ +RemoveBasicAuthenticationPayloadType | @hoprnet/hopr-sdk

Type alias RemoveBasicAuthenticationPayloadType<T>

RemoveBasicAuthenticationPayloadType<T>: Pick<T, Exclude<keyof T, "apiEndpoint" | "apiToken">>

Removes the basic authentication properties from a payload type.

+

Type Parameters

Typeparam

T - The payload type from which to remove the properties.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/SendMessagePayloadType.html b/docs/types/SendMessagePayloadType.html new file mode 100644 index 00000000..a3341181 --- /dev/null +++ b/docs/types/SendMessagePayloadType.html @@ -0,0 +1,4 @@ +SendMessagePayloadType | @hoprnet/hopr-sdk

Type alias SendMessagePayloadType

SendMessagePayloadType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    body: string;
    hops?: number;
    path?: string[];
    peerId: string;
    tag: number;
    timeout?: number;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • body: string
  • Optional hops?: number
  • Optional path?: string[]
  • peerId: string
  • tag: number
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/SetAliasPayloadType.html b/docs/types/SetAliasPayloadType.html new file mode 100644 index 00000000..8a84bebd --- /dev/null +++ b/docs/types/SetAliasPayloadType.html @@ -0,0 +1,4 @@ +SetAliasPayloadType | @hoprnet/hopr-sdk

Type alias SetAliasPayloadType

SetAliasPayloadType: {
    alias: string;
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    peerId: string;
    timeout?: number;
}

Type declaration

  • alias: string
  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • peerId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/StrategiesPayloadType.html b/docs/types/StrategiesPayloadType.html new file mode 100644 index 00000000..9c77bbe4 --- /dev/null +++ b/docs/types/StrategiesPayloadType.html @@ -0,0 +1 @@ +StrategiesPayloadType | @hoprnet/hopr-sdk

Type alias StrategiesPayloadType

StrategiesPayloadType: Record<string, Record<string, string | number | boolean>>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/WithdrawPayloadType.html b/docs/types/WithdrawPayloadType.html new file mode 100644 index 00000000..7eee71c0 --- /dev/null +++ b/docs/types/WithdrawPayloadType.html @@ -0,0 +1,4 @@ +WithdrawPayloadType | @hoprnet/hopr-sdk

Type alias WithdrawPayloadType

WithdrawPayloadType: {
    amount: string;
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    currency: "NATIVE" | "HOPR";
    ethereumAddress: string;
    timeout?: number;
}

Type declaration

  • amount: string
  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • currency: "NATIVE" | "HOPR"
  • ethereumAddress: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/createWsUrlType.html b/docs/types/createWsUrlType.html new file mode 100644 index 00000000..eff0d771 --- /dev/null +++ b/docs/types/createWsUrlType.html @@ -0,0 +1,4 @@ +createWsUrlType | @hoprnet/hopr-sdk

Type alias createWsUrlType

createWsUrlType: {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    path?: string;
}

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • Optional path?: string

    optional path for the websocker

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/AggregateChannelTicketsPayload.html b/docs/variables/AggregateChannelTicketsPayload.html new file mode 100644 index 00000000..3ad4cee4 --- /dev/null +++ b/docs/variables/AggregateChannelTicketsPayload.html @@ -0,0 +1,11 @@ +AggregateChannelTicketsPayload | @hoprnet/hopr-sdk

Variable AggregateChannelTicketsPayloadConst

AggregateChannelTicketsPayload: ZodObject<{
    apiEndpoint: ZodUnion<[ZodString, ZodType<URL, ZodTypeDef, URL>]>;
    apiToken: ZodString;
    channelId: ZodString;
    timeout: ZodOptional<ZodNumber>;
}, "strip", ZodTypeAny, {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}, {
    apiEndpoint: (string | URL) & (undefined | string | URL);
    apiToken: string;
    channelId: string;
    timeout?: number;
}> = ...

Aggregate channel tickets

+

Type declaration

  • apiEndpoint: ZodUnion<[ZodString, ZodType<URL, ZodTypeDef, URL>]>

    The API endpoint for authentication.

    +
  • apiToken: ZodString

    The API token for authentication.

    +
  • channelId: ZodString
  • timeout: ZodOptional<ZodNumber>

    optional timeout for the requests

    +

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Type declaration

  • apiEndpoint: (string | URL) & (undefined | string | URL)

    The API endpoint for authentication.

    +
  • apiToken: string

    The API token for authentication.

    +
  • channelId: string
  • Optional timeout?: number

    optional timeout for the requests

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/AliasPayload.html b/docs/variables/AliasPayload.html new file mode 100644 index 00000000..77e107f0 --- /dev/null +++ b/docs/variables/AliasPayload.html @@ -0,0 +1,2 @@ +AliasPayload | @hoprnet/hopr-sdk

Variable AliasPayloadConst

AliasPayload: ZodObject<AliasPayloadType> = ...

General

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/ApiErrorResponse.html b/docs/variables/ApiErrorResponse.html new file mode 100644 index 00000000..c384b3ab --- /dev/null +++ b/docs/variables/ApiErrorResponse.html @@ -0,0 +1 @@ +ApiErrorResponse | @hoprnet/hopr-sdk

Variable ApiErrorResponseConst

ApiErrorResponse: ZodObject<ApiErrorResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/BasePayload.html b/docs/variables/BasePayload.html new file mode 100644 index 00000000..7f667b6b --- /dev/null +++ b/docs/variables/BasePayload.html @@ -0,0 +1,2 @@ +BasePayload | @hoprnet/hopr-sdk

Variable BasePayloadConst

BasePayload: ZodObject<BasePayloadType> = ...

Represents the minimum payload needed to interact with hoprd node.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/Channel.html b/docs/variables/Channel.html new file mode 100644 index 00000000..51c8747a --- /dev/null +++ b/docs/variables/Channel.html @@ -0,0 +1 @@ +Channel | @hoprnet/hopr-sdk

Variable ChannelConst

Channel: ZodObject<{
    balance: ZodString;
    id: ZodString;
    peerAddress: ZodString;
    status: ZodEnum<["Open", "PendingToClose", "Closed"]>;
}, "strip", ZodTypeAny, {
    balance: string;
    id: string;
    peerAddress: string;
    status: "Open" | "PendingToClose" | "Closed";
}, {
    balance: string;
    id: string;
    peerAddress: string;
    status: "Open" | "PendingToClose" | "Closed";
}> = ...

Type declaration

  • balance: ZodString
  • id: ZodString
  • peerAddress: ZodString
  • status: ZodEnum<["Open", "PendingToClose", "Closed"]>

Type declaration

  • balance: string
  • id: string
  • peerAddress: string
  • status: "Open" | "PendingToClose" | "Closed"

Type declaration

  • balance: string
  • id: string
  • peerAddress: string
  • status: "Open" | "PendingToClose" | "Closed"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/CloseChannelPayload.html b/docs/variables/CloseChannelPayload.html new file mode 100644 index 00000000..f78dada5 --- /dev/null +++ b/docs/variables/CloseChannelPayload.html @@ -0,0 +1,2 @@ +CloseChannelPayload | @hoprnet/hopr-sdk

Variable CloseChannelPayloadConst

CloseChannelPayload: ZodObject<CloseChannelPayloadType> = ...

Close channel

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/CloseChannelResponse.html b/docs/variables/CloseChannelResponse.html new file mode 100644 index 00000000..42a38c3e --- /dev/null +++ b/docs/variables/CloseChannelResponse.html @@ -0,0 +1 @@ +CloseChannelResponse | @hoprnet/hopr-sdk

Variable CloseChannelResponseConst

CloseChannelResponse: ZodObject<CloseChannelResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/CreateTokenPayload.html b/docs/variables/CreateTokenPayload.html new file mode 100644 index 00000000..20b30fd5 --- /dev/null +++ b/docs/variables/CreateTokenPayload.html @@ -0,0 +1,2 @@ +CreateTokenPayload | @hoprnet/hopr-sdk

Variable CreateTokenPayloadConst

CreateTokenPayload: ZodObject<CreateTokenPayloadType> = ...

createToken

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/CreateTokenResponse.html b/docs/variables/CreateTokenResponse.html new file mode 100644 index 00000000..3c282796 --- /dev/null +++ b/docs/variables/CreateTokenResponse.html @@ -0,0 +1 @@ +CreateTokenResponse | @hoprnet/hopr-sdk

Variable CreateTokenResponseConst

CreateTokenResponse: ZodObject<CreateTokenResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/DeleteMessagesPayload.html b/docs/variables/DeleteMessagesPayload.html new file mode 100644 index 00000000..92e3fd50 --- /dev/null +++ b/docs/variables/DeleteMessagesPayload.html @@ -0,0 +1,2 @@ +DeleteMessagesPayload | @hoprnet/hopr-sdk

Variable DeleteMessagesPayloadConst

DeleteMessagesPayload: ZodObject<DeleteMessagesPayloadType> = ...

Delete Messages

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/DeleteTokenPayload.html b/docs/variables/DeleteTokenPayload.html new file mode 100644 index 00000000..8b2ba21e --- /dev/null +++ b/docs/variables/DeleteTokenPayload.html @@ -0,0 +1,2 @@ +DeleteTokenPayload | @hoprnet/hopr-sdk

Variable DeleteTokenPayloadConst

DeleteTokenPayload: ZodObject<DeleteTokenPayloadType> = ...

deleteToken

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/FundChannelsPayload.html b/docs/variables/FundChannelsPayload.html new file mode 100644 index 00000000..160739b0 --- /dev/null +++ b/docs/variables/FundChannelsPayload.html @@ -0,0 +1,2 @@ +FundChannelsPayload | @hoprnet/hopr-sdk

Variable FundChannelsPayloadConst

FundChannelsPayload: ZodObject<FundChannelsPayloadType> = ...

Fund channel

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/FundChannelsResponse.html b/docs/variables/FundChannelsResponse.html new file mode 100644 index 00000000..87442e97 --- /dev/null +++ b/docs/variables/FundChannelsResponse.html @@ -0,0 +1 @@ +FundChannelsResponse | @hoprnet/hopr-sdk

Variable FundChannelsResponseConst

FundChannelsResponse: ZodObject<FundChannelsResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetAddressesResponse.html b/docs/variables/GetAddressesResponse.html new file mode 100644 index 00000000..850790da --- /dev/null +++ b/docs/variables/GetAddressesResponse.html @@ -0,0 +1,2 @@ +GetAddressesResponse | @hoprnet/hopr-sdk

Variable GetAddressesResponseConst

GetAddressesResponse: ZodObject<GetAddressesResponseType> = ...

addresses

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetAliasResponse.html b/docs/variables/GetAliasResponse.html new file mode 100644 index 00000000..7b964343 --- /dev/null +++ b/docs/variables/GetAliasResponse.html @@ -0,0 +1,2 @@ +GetAliasResponse | @hoprnet/hopr-sdk

Variable GetAliasResponseConst

GetAliasResponse: ZodObject<GetAliasResponseType> = ...

getAlias

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetAliasesResponse.html b/docs/variables/GetAliasesResponse.html new file mode 100644 index 00000000..13296b51 --- /dev/null +++ b/docs/variables/GetAliasesResponse.html @@ -0,0 +1,2 @@ +GetAliasesResponse | @hoprnet/hopr-sdk

Variable GetAliasesResponseConst

GetAliasesResponse: ZodRecord<GetAliasesResponseType> = ...

getAliases

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetBalancesResponse.html b/docs/variables/GetBalancesResponse.html new file mode 100644 index 00000000..f1df95ea --- /dev/null +++ b/docs/variables/GetBalancesResponse.html @@ -0,0 +1,2 @@ +GetBalancesResponse | @hoprnet/hopr-sdk

Variable GetBalancesResponseConst

GetBalancesResponse: ZodObject<GetBalancesResponseType> = ...

balances

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetChannelPayload.html b/docs/variables/GetChannelPayload.html new file mode 100644 index 00000000..d6459020 --- /dev/null +++ b/docs/variables/GetChannelPayload.html @@ -0,0 +1,2 @@ +GetChannelPayload | @hoprnet/hopr-sdk

Variable GetChannelPayloadConst

GetChannelPayload: ZodObject<GetChannelPayloadType> = ...

Get channel

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetChannelResponse.html b/docs/variables/GetChannelResponse.html new file mode 100644 index 00000000..45b8196e --- /dev/null +++ b/docs/variables/GetChannelResponse.html @@ -0,0 +1 @@ +GetChannelResponse | @hoprnet/hopr-sdk

Variable GetChannelResponseConst

GetChannelResponse: ZodObject<GetChannelResponseType> = TopologyChannel

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetChannelTicketsPayload.html b/docs/variables/GetChannelTicketsPayload.html new file mode 100644 index 00000000..b6cf1856 --- /dev/null +++ b/docs/variables/GetChannelTicketsPayload.html @@ -0,0 +1,2 @@ +GetChannelTicketsPayload | @hoprnet/hopr-sdk

Variable GetChannelTicketsPayloadConst

GetChannelTicketsPayload: ZodObject<GetChannelTicketsPayloadType> = ...

Get channel tickets

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetChannelTicketsResponse.html b/docs/variables/GetChannelTicketsResponse.html new file mode 100644 index 00000000..ac775097 --- /dev/null +++ b/docs/variables/GetChannelTicketsResponse.html @@ -0,0 +1 @@ +GetChannelTicketsResponse | @hoprnet/hopr-sdk

Variable GetChannelTicketsResponseConst

GetChannelTicketsResponse: ZodArray<GetChannelTicketsResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetChannelsPayload.html b/docs/variables/GetChannelsPayload.html new file mode 100644 index 00000000..5471c848 --- /dev/null +++ b/docs/variables/GetChannelsPayload.html @@ -0,0 +1,2 @@ +GetChannelsPayload | @hoprnet/hopr-sdk

Variable GetChannelsPayloadConst

GetChannelsPayload: ZodObject<GetChannelsPayloadType> = ...

Get channels

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetChannelsResponse.html b/docs/variables/GetChannelsResponse.html new file mode 100644 index 00000000..20fc7ab8 --- /dev/null +++ b/docs/variables/GetChannelsResponse.html @@ -0,0 +1 @@ +GetChannelsResponse | @hoprnet/hopr-sdk

Variable GetChannelsResponseConst

GetChannelsResponse: ZodObject<GetChannelsResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetConfigurationPayload.html b/docs/variables/GetConfigurationPayload.html new file mode 100644 index 00000000..e01f8aad --- /dev/null +++ b/docs/variables/GetConfigurationPayload.html @@ -0,0 +1,2 @@ +GetConfigurationPayload | @hoprnet/hopr-sdk

Variable GetConfigurationPayloadConst

GetConfigurationPayload: ZodObject<GetConfigurationPayloadType> = BasePayload

Get node configuration

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetConfigurationResponse.html b/docs/variables/GetConfigurationResponse.html new file mode 100644 index 00000000..1d90d843 --- /dev/null +++ b/docs/variables/GetConfigurationResponse.html @@ -0,0 +1 @@ +GetConfigurationResponse | @hoprnet/hopr-sdk

Variable GetConfigurationResponseConst

GetConfigurationResponse: ZodAny<GetConfigurationResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetEntryNodesResponse.html b/docs/variables/GetEntryNodesResponse.html new file mode 100644 index 00000000..68457597 --- /dev/null +++ b/docs/variables/GetEntryNodesResponse.html @@ -0,0 +1 @@ +GetEntryNodesResponse | @hoprnet/hopr-sdk

Variable GetEntryNodesResponseConst

GetEntryNodesResponse: ZodRecord<GetEntryNodesResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetInfoResponse.html b/docs/variables/GetInfoResponse.html new file mode 100644 index 00000000..5e3d599d --- /dev/null +++ b/docs/variables/GetInfoResponse.html @@ -0,0 +1,2 @@ +GetInfoResponse | @hoprnet/hopr-sdk

Variable GetInfoResponseConst

GetInfoResponse: ZodObject<GetInfoResponseType> = ...

Get Info

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetMessagesSizePayload.html b/docs/variables/GetMessagesSizePayload.html new file mode 100644 index 00000000..e4ac2988 --- /dev/null +++ b/docs/variables/GetMessagesSizePayload.html @@ -0,0 +1,2 @@ +GetMessagesSizePayload | @hoprnet/hopr-sdk

Variable GetMessagesSizePayloadConst

GetMessagesSizePayload: ZodObject<GetMessagesSizePayloadType> = ...

Get Messages Size

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetMessagesSizeResponse.html b/docs/variables/GetMessagesSizeResponse.html new file mode 100644 index 00000000..2ebb1686 --- /dev/null +++ b/docs/variables/GetMessagesSizeResponse.html @@ -0,0 +1 @@ +GetMessagesSizeResponse | @hoprnet/hopr-sdk

Variable GetMessagesSizeResponseConst

GetMessagesSizeResponse: ZodObject<GetMessagesSizeResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetPeerPayload.html b/docs/variables/GetPeerPayload.html new file mode 100644 index 00000000..02665d9f --- /dev/null +++ b/docs/variables/GetPeerPayload.html @@ -0,0 +1,2 @@ +GetPeerPayload | @hoprnet/hopr-sdk

Variable GetPeerPayloadConst

GetPeerPayload: ZodObject<GetPeerPayloadType> = ...

Get peer

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetPeerResponse.html b/docs/variables/GetPeerResponse.html new file mode 100644 index 00000000..d5aed21e --- /dev/null +++ b/docs/variables/GetPeerResponse.html @@ -0,0 +1 @@ +GetPeerResponse | @hoprnet/hopr-sdk

Variable GetPeerResponseConst

GetPeerResponse: ZodObject<GetPeerResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetPeersPayload.html b/docs/variables/GetPeersPayload.html new file mode 100644 index 00000000..2bc8d299 --- /dev/null +++ b/docs/variables/GetPeersPayload.html @@ -0,0 +1,2 @@ +GetPeersPayload | @hoprnet/hopr-sdk

Variable GetPeersPayloadConst

GetPeersPayload: ZodObject<GetPeersPayloadType> = ...

Get peers

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetPeersResponse.html b/docs/variables/GetPeersResponse.html new file mode 100644 index 00000000..bb30019a --- /dev/null +++ b/docs/variables/GetPeersResponse.html @@ -0,0 +1 @@ +GetPeersResponse | @hoprnet/hopr-sdk

Variable GetPeersResponseConst

GetPeersResponse: ZodObject<GetPeersResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetTicketPricePayload.html b/docs/variables/GetTicketPricePayload.html new file mode 100644 index 00000000..1d5cdac2 --- /dev/null +++ b/docs/variables/GetTicketPricePayload.html @@ -0,0 +1,2 @@ +GetTicketPricePayload | @hoprnet/hopr-sdk

Variable GetTicketPricePayloadConst

GetTicketPricePayload: ZodObject<GetTicketPricePayloadType> = BasePayload

Get network price

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetTicketPriceResponse.html b/docs/variables/GetTicketPriceResponse.html new file mode 100644 index 00000000..87960d73 --- /dev/null +++ b/docs/variables/GetTicketPriceResponse.html @@ -0,0 +1 @@ +GetTicketPriceResponse | @hoprnet/hopr-sdk

Variable GetTicketPriceResponseConst

GetTicketPriceResponse: ZodObject<GetTicketPriceResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetTicketStatisticsResponse.html b/docs/variables/GetTicketStatisticsResponse.html new file mode 100644 index 00000000..ddebb329 --- /dev/null +++ b/docs/variables/GetTicketStatisticsResponse.html @@ -0,0 +1,2 @@ +GetTicketStatisticsResponse | @hoprnet/hopr-sdk

Variable GetTicketStatisticsResponseConst

GetTicketStatisticsResponse: ZodObject<GetTicketStatisticsResponseType> = ...

Get statistics

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/GetTokenResponse.html b/docs/variables/GetTokenResponse.html new file mode 100644 index 00000000..016d6512 --- /dev/null +++ b/docs/variables/GetTokenResponse.html @@ -0,0 +1,2 @@ +GetTokenResponse | @hoprnet/hopr-sdk

Variable GetTokenResponseConst

GetTokenResponse: ZodObject<GetTokenResponseType> = ...

getToken

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/IsNodeHealthyPayload.html b/docs/variables/IsNodeHealthyPayload.html new file mode 100644 index 00000000..0b1519bf --- /dev/null +++ b/docs/variables/IsNodeHealthyPayload.html @@ -0,0 +1,2 @@ +IsNodeHealthyPayload | @hoprnet/hopr-sdk

Variable IsNodeHealthyPayloadConst

IsNodeHealthyPayload: ZodObject<IsNodeHealthyPayloadType> = BasePayload

Check whether the node is healthy

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/IsNodeHealthyResponse.html b/docs/variables/IsNodeHealthyResponse.html new file mode 100644 index 00000000..b9c8b88d --- /dev/null +++ b/docs/variables/IsNodeHealthyResponse.html @@ -0,0 +1 @@ +IsNodeHealthyResponse | @hoprnet/hopr-sdk

Variable IsNodeHealthyResponseConst

IsNodeHealthyResponse: ZodBoolean<IsNodeHealthyResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/IsNodeReadyPayload.html b/docs/variables/IsNodeReadyPayload.html new file mode 100644 index 00000000..afa7e97a --- /dev/null +++ b/docs/variables/IsNodeReadyPayload.html @@ -0,0 +1,2 @@ +IsNodeReadyPayload | @hoprnet/hopr-sdk

Variable IsNodeReadyPayloadConst

IsNodeReadyPayload: ZodObject<IsNodeReadyPayloadType> = BasePayload

Check whether the node is ready to accept connections.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/IsNodeReadyResponse.html b/docs/variables/IsNodeReadyResponse.html new file mode 100644 index 00000000..2bf96791 --- /dev/null +++ b/docs/variables/IsNodeReadyResponse.html @@ -0,0 +1 @@ +IsNodeReadyResponse | @hoprnet/hopr-sdk

Variable IsNodeReadyResponseConst

IsNodeReadyResponse: ZodBoolean<IsNodeReadyResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/IsNodeStartedPayload.html b/docs/variables/IsNodeStartedPayload.html new file mode 100644 index 00000000..a606016f --- /dev/null +++ b/docs/variables/IsNodeStartedPayload.html @@ -0,0 +1,2 @@ +IsNodeStartedPayload | @hoprnet/hopr-sdk

Variable IsNodeStartedPayloadConst

IsNodeStartedPayload: ZodObject<IsNodeStartedPayloadType> = BasePayload

Check whether the node is ready to accept connections.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/IsNodeStartedResponse.html b/docs/variables/IsNodeStartedResponse.html new file mode 100644 index 00000000..0ff8e6f9 --- /dev/null +++ b/docs/variables/IsNodeStartedResponse.html @@ -0,0 +1 @@ +IsNodeStartedResponse | @hoprnet/hopr-sdk

Variable IsNodeStartedResponseConst

IsNodeStartedResponse: ZodBoolean<IsNodeStartedResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/OpenChannelPayload.html b/docs/variables/OpenChannelPayload.html new file mode 100644 index 00000000..514f2495 --- /dev/null +++ b/docs/variables/OpenChannelPayload.html @@ -0,0 +1,2 @@ +OpenChannelPayload | @hoprnet/hopr-sdk

Variable OpenChannelPayloadConst

OpenChannelPayload: ZodObject<OpenChannelPayloadType> = ...

Open channel

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/OpenChannelResponse.html b/docs/variables/OpenChannelResponse.html new file mode 100644 index 00000000..dd898b42 --- /dev/null +++ b/docs/variables/OpenChannelResponse.html @@ -0,0 +1 @@ +OpenChannelResponse | @hoprnet/hopr-sdk

Variable OpenChannelResponseConst

OpenChannelResponse: ZodObject<OpenChannelResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PeekAllMessagesPayload.html b/docs/variables/PeekAllMessagesPayload.html new file mode 100644 index 00000000..93a4f6d0 --- /dev/null +++ b/docs/variables/PeekAllMessagesPayload.html @@ -0,0 +1,2 @@ +PeekAllMessagesPayload | @hoprnet/hopr-sdk

Variable PeekAllMessagesPayloadConst

PeekAllMessagesPayload: ZodObject<PeekAllMessagesPayloadType> = ...

Peek all messages

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PeekAllMessagesResponse.html b/docs/variables/PeekAllMessagesResponse.html new file mode 100644 index 00000000..a6093dc2 --- /dev/null +++ b/docs/variables/PeekAllMessagesResponse.html @@ -0,0 +1 @@ +PeekAllMessagesResponse | @hoprnet/hopr-sdk

Variable PeekAllMessagesResponseConst

PeekAllMessagesResponse: ZodObject<PeekAllMessagesResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PeekMessagePayload.html b/docs/variables/PeekMessagePayload.html new file mode 100644 index 00000000..4774d56c --- /dev/null +++ b/docs/variables/PeekMessagePayload.html @@ -0,0 +1,2 @@ +PeekMessagePayload | @hoprnet/hopr-sdk

Variable PeekMessagePayloadConst

PeekMessagePayload: ZodObject<PeekMessagePayloadType> = ...

Peek message

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PeekMessageResponse.html b/docs/variables/PeekMessageResponse.html new file mode 100644 index 00000000..1730be84 --- /dev/null +++ b/docs/variables/PeekMessageResponse.html @@ -0,0 +1 @@ +PeekMessageResponse | @hoprnet/hopr-sdk

Variable PeekMessageResponseConst

PeekMessageResponse: ZodObject<PeekMessageResponseType> = ReceivedMessage

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PeerAnnounced.html b/docs/variables/PeerAnnounced.html new file mode 100644 index 00000000..d1ef3442 --- /dev/null +++ b/docs/variables/PeerAnnounced.html @@ -0,0 +1 @@ +PeerAnnounced | @hoprnet/hopr-sdk

Variable PeerAnnouncedConst

PeerAnnounced: ZodObject<{
    multiaddr: ZodNullable<ZodString>;
    peerAddress: ZodString;
    peerId: ZodString;
}, "strip", ZodTypeAny, {
    multiaddr: null | string;
    peerAddress: string;
    peerId: string;
}, {
    multiaddr: null | string;
    peerAddress: string;
    peerId: string;
}> = ...

Type declaration

  • multiaddr: ZodNullable<ZodString>
  • peerAddress: ZodString
  • peerId: ZodString

Type declaration

  • multiaddr: null | string
  • peerAddress: string
  • peerId: string

Type declaration

  • multiaddr: null | string
  • peerAddress: string
  • peerId: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PeerConnected.html b/docs/variables/PeerConnected.html new file mode 100644 index 00000000..af8112d5 --- /dev/null +++ b/docs/variables/PeerConnected.html @@ -0,0 +1 @@ +PeerConnected | @hoprnet/hopr-sdk

Variable PeerConnectedConst

PeerConnected: ZodObject<{
    backoff: ZodNumber;
    heartbeats: ZodObject<{
        sent: ZodNumber;
        success: ZodNumber;
    }, "strip", ZodTypeAny, {
        sent: number;
        success: number;
    }, {
        sent: number;
        success: number;
    }>;
    isNew: ZodBoolean;
    lastSeen: ZodNumber;
    lastSeenLatency: ZodNumber;
    multiaddr: ZodNullable<ZodString>;
    peerAddress: ZodString;
    peerId: ZodString;
    quality: ZodNumber;
    reportedVersion: ZodString;
}, "strip", ZodTypeAny, {
    backoff: number;
    heartbeats: {
        sent: number;
        success: number;
    };
    isNew: boolean;
    lastSeen: number;
    lastSeenLatency: number;
    multiaddr: null | string;
    peerAddress: string;
    peerId: string;
    quality: number;
    reportedVersion: string;
}, {
    backoff: number;
    heartbeats: {
        sent: number;
        success: number;
    };
    isNew: boolean;
    lastSeen: number;
    lastSeenLatency: number;
    multiaddr: null | string;
    peerAddress: string;
    peerId: string;
    quality: number;
    reportedVersion: string;
}> = ...

Type declaration

  • backoff: ZodNumber
  • heartbeats: ZodObject<{
        sent: ZodNumber;
        success: ZodNumber;
    }, "strip", ZodTypeAny, {
        sent: number;
        success: number;
    }, {
        sent: number;
        success: number;
    }>
  • isNew: ZodBoolean
  • lastSeen: ZodNumber
  • lastSeenLatency: ZodNumber
  • multiaddr: ZodNullable<ZodString>
  • peerAddress: ZodString
  • peerId: ZodString
  • quality: ZodNumber
  • reportedVersion: ZodString

Type declaration

  • backoff: number
  • heartbeats: {
        sent: number;
        success: number;
    }
    • sent: number
    • success: number
  • isNew: boolean
  • lastSeen: number
  • lastSeenLatency: number
  • multiaddr: null | string
  • peerAddress: string
  • peerId: string
  • quality: number
  • reportedVersion: string

Type declaration

  • backoff: number
  • heartbeats: {
        sent: number;
        success: number;
    }
    • sent: number
    • success: number
  • isNew: boolean
  • lastSeen: number
  • lastSeenLatency: number
  • multiaddr: null | string
  • peerAddress: string
  • peerId: string
  • quality: number
  • reportedVersion: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PingPeerPayload.html b/docs/variables/PingPeerPayload.html new file mode 100644 index 00000000..a1035560 --- /dev/null +++ b/docs/variables/PingPeerPayload.html @@ -0,0 +1,2 @@ +PingPeerPayload | @hoprnet/hopr-sdk

Variable PingPeerPayloadConst

PingPeerPayload: ZodObject<PingPeerPayloadType> = ...

Ping peer

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PingPeerResponse.html b/docs/variables/PingPeerResponse.html new file mode 100644 index 00000000..e2955d1b --- /dev/null +++ b/docs/variables/PingPeerResponse.html @@ -0,0 +1 @@ +PingPeerResponse | @hoprnet/hopr-sdk

Variable PingPeerResponseConst

PingPeerResponse: ZodObject<PingPeerResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PopAllMessagesPayload.html b/docs/variables/PopAllMessagesPayload.html new file mode 100644 index 00000000..1c2aad52 --- /dev/null +++ b/docs/variables/PopAllMessagesPayload.html @@ -0,0 +1,2 @@ +PopAllMessagesPayload | @hoprnet/hopr-sdk

Variable PopAllMessagesPayloadConst

PopAllMessagesPayload: ZodObject<PopAllMessagesPayloadType> = ...

Pop all messages

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PopAllMessagesResponse.html b/docs/variables/PopAllMessagesResponse.html new file mode 100644 index 00000000..c560ee0b --- /dev/null +++ b/docs/variables/PopAllMessagesResponse.html @@ -0,0 +1 @@ +PopAllMessagesResponse | @hoprnet/hopr-sdk

Variable PopAllMessagesResponseConst

PopAllMessagesResponse: ZodObject<PopAllMessagesResponseType> = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PopMessagePayload.html b/docs/variables/PopMessagePayload.html new file mode 100644 index 00000000..e1fa80f5 --- /dev/null +++ b/docs/variables/PopMessagePayload.html @@ -0,0 +1,2 @@ +PopMessagePayload | @hoprnet/hopr-sdk

Variable PopMessagePayloadConst

PopMessagePayload: ZodObject<PopMessagePayloadType> = ...

Pop message

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/PopMessageResponse.html b/docs/variables/PopMessageResponse.html new file mode 100644 index 00000000..4d326d77 --- /dev/null +++ b/docs/variables/PopMessageResponse.html @@ -0,0 +1 @@ +PopMessageResponse | @hoprnet/hopr-sdk

Variable PopMessageResponseConst

PopMessageResponse: ZodObject<PopMessageResponseType> = ReceivedMessage

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/ReceivedMessage.html b/docs/variables/ReceivedMessage.html new file mode 100644 index 00000000..6b6d1cdf --- /dev/null +++ b/docs/variables/ReceivedMessage.html @@ -0,0 +1,2 @@ +ReceivedMessage | @hoprnet/hopr-sdk

Variable ReceivedMessageConst

ReceivedMessage: ZodObject<{
    body: ZodString;
    receivedAt: ZodNumber;
    tag: ZodNumber;
}, "strip", ZodTypeAny, {
    body: string;
    receivedAt: number;
    tag: number;
}, {
    body: string;
    receivedAt: number;
    tag: number;
}> = ...

General

+

Type declaration

  • body: ZodString
  • receivedAt: ZodNumber
  • tag: ZodNumber

Type declaration

  • body: string
  • receivedAt: number
  • tag: number

Type declaration

  • body: string
  • receivedAt: number
  • tag: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/RedeemChannelTicketsPayload.html b/docs/variables/RedeemChannelTicketsPayload.html new file mode 100644 index 00000000..a7635d77 --- /dev/null +++ b/docs/variables/RedeemChannelTicketsPayload.html @@ -0,0 +1,2 @@ +RedeemChannelTicketsPayload | @hoprnet/hopr-sdk

Variable RedeemChannelTicketsPayloadConst

RedeemChannelTicketsPayload: ZodObject<AggregateChannelTicketsPayloadType> = ...

Redeem channel tickets

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/SendMessagePayload.html b/docs/variables/SendMessagePayload.html new file mode 100644 index 00000000..f8a7333f --- /dev/null +++ b/docs/variables/SendMessagePayload.html @@ -0,0 +1,2 @@ +SendMessagePayload | @hoprnet/hopr-sdk

Variable SendMessagePayloadConst

SendMessagePayload: ZodObject<SendMessagePayloadType> = ...

Send Message

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/SetAliasPayload.html b/docs/variables/SetAliasPayload.html new file mode 100644 index 00000000..be16384d --- /dev/null +++ b/docs/variables/SetAliasPayload.html @@ -0,0 +1,2 @@ +SetAliasPayload | @hoprnet/hopr-sdk

Variable SetAliasPayloadConst

SetAliasPayload: ZodObject<SetAliasPayloadType> = ...

setAlias

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/Ticket.html b/docs/variables/Ticket.html new file mode 100644 index 00000000..8a6ca134 --- /dev/null +++ b/docs/variables/Ticket.html @@ -0,0 +1 @@ +Ticket | @hoprnet/hopr-sdk

Variable TicketConst

Ticket: ZodObject<{
    amount: ZodString;
    channelEpoch: ZodNumber;
    channelId: ZodString;
    index: ZodNumber;
    indexOffset: ZodNumber;
    signature: ZodString;
    winProb: ZodString;
}, "strip", ZodTypeAny, {
    amount: string;
    channelEpoch: number;
    channelId: string;
    index: number;
    indexOffset: number;
    signature: string;
    winProb: string;
}, {
    amount: string;
    channelEpoch: number;
    channelId: string;
    index: number;
    indexOffset: number;
    signature: string;
    winProb: string;
}> = ...

Type declaration

  • amount: ZodString
  • channelEpoch: ZodNumber
  • channelId: ZodString
  • index: ZodNumber
  • indexOffset: ZodNumber
  • signature: ZodString
  • winProb: ZodString

Type declaration

  • amount: string
  • channelEpoch: number
  • channelId: string
  • index: number
  • indexOffset: number
  • signature: string
  • winProb: string

Type declaration

  • amount: string
  • channelEpoch: number
  • channelId: string
  • index: number
  • indexOffset: number
  • signature: string
  • winProb: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/TokenCapability.html b/docs/variables/TokenCapability.html new file mode 100644 index 00000000..4d7084c0 --- /dev/null +++ b/docs/variables/TokenCapability.html @@ -0,0 +1 @@ +TokenCapability | @hoprnet/hopr-sdk

Variable TokenCapabilityConst

TokenCapability: ZodObject<{
    endpoint: ZodEnum<["accountWithdraw", "accountGetBalances", "accountGetAddresses", "aliasesGetAliases", "aliasesSetAlias", "aliasesGetAlias", "aliasesRemoveAlias", "channelsFundChannels", "channelsOpenChannel", "channelsGetChannels"]>;
    limits: ZodArray<ZodObject<{
        conditions: ZodOptional<ZodObject<{
            max: ZodOptional<ZodNumber>;
        }, "strip", ZodTypeAny, {
            max?: number;
        }, {
            max?: number;
        }>>;
        type: ZodString;
    }, "strip", ZodTypeAny, {
        conditions?: {
            max?: number;
        };
        type: string;
    }, {
        conditions?: {
            max?: number;
        };
        type: string;
    }>, "many">;
}, "strip", ZodTypeAny, {
    endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
    limits: {
        conditions?: {
            max?: number;
        };
        type: string;
    }[];
}, {
    endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete";
    limits: {
        conditions?: {
            max?: number;
        };
        type: string;
    }[];
}> = ...

Type declaration

  • endpoint: ZodEnum<["accountWithdraw", "accountGetBalances", "accountGetAddresses", "aliasesGetAliases", "aliasesSetAlias", "aliasesGetAlias", "aliasesRemoveAlias", "channelsFundChannels", "channelsOpenChannel", "channelsGetChannels"]>
  • limits: ZodArray<ZodObject<{
        conditions: ZodOptional<ZodObject<{
            max: ZodOptional<ZodNumber>;
        }, "strip", ZodTypeAny, {
            max?: number;
        }, {
            max?: number;
        }>>;
        type: ZodString;
    }, "strip", ZodTypeAny, {
        conditions?: {
            max?: number;
        };
        type: string;
    }, {
        conditions?: {
            max?: number;
        };
        type: string;
    }>, "many">

Type declaration

  • endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete"
  • limits: {
        conditions?: {
            max?: number;
        };
        type: string;
    }[]

Type declaration

  • endpoint: "accountWithdraw" | "accountGetBalances" | "accountGetAddresses" | "aliasesGetAliases" | "aliasesSetAlias" | "aliasesGetAlias" | "aliasesRemoveAlias" | "channelsFundChannels" | "channelsOpenChannel" | "channelsGetChannels" | "channelsRedeemTickets" | "channelsGetTickets" | "channelsGetChannel" | "channelsCloseChannel" | "messagesWebsocket" | "messagesSign" | "messagesSendMessage" | "nodeGetVersion" | "nodeStreamWebsocket" | "nodePing" | "nodeGetPeers" | "nodeGetMetrics" | "nodeGetInfo" | "nodeGetEntryNodes" | "peerInfoGetPeerInfo" | "settingsGetSettings" | "settingsSetSetting" | "ticketsGetStatistics" | "ticketsRedeemTickets" | "ticketsGetTickets" | "tokensCreate" | "tokensGetToken" | "tokensDelete"
  • limits: {
        conditions?: {
            max?: number;
        };
        type: string;
    }[]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/WithdrawPayload.html b/docs/variables/WithdrawPayload.html new file mode 100644 index 00000000..4f41e9ca --- /dev/null +++ b/docs/variables/WithdrawPayload.html @@ -0,0 +1,2 @@ +WithdrawPayload | @hoprnet/hopr-sdk

Variable WithdrawPayloadConst

WithdrawPayload: ZodObject<WithdrawPayloadType> = ...

withdraw

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/WithdrawResponse.html b/docs/variables/WithdrawResponse.html new file mode 100644 index 00000000..2228d6cc --- /dev/null +++ b/docs/variables/WithdrawResponse.html @@ -0,0 +1 @@ +WithdrawResponse | @hoprnet/hopr-sdk

Variable WithdrawResponseConst

WithdrawResponse: ZodObject<{
    receipt: ZodString;
}, "strip", ZodTypeAny, {
    receipt: string;
}, {
    receipt: string;
}> = ...

Type declaration

  • receipt: ZodString

Type declaration

  • receipt: string

Type declaration

  • receipt: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/createWsUrlPayload.html b/docs/variables/createWsUrlPayload.html new file mode 100644 index 00000000..d416d176 --- /dev/null +++ b/docs/variables/createWsUrlPayload.html @@ -0,0 +1,2 @@ +createWsUrlPayload | @hoprnet/hopr-sdk

Variable createWsUrlPayloadConst

createWsUrlPayload: ZodObject<createWsUrlType> = ...

createWsUrl

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.DUFOUR.html b/docs/variables/web3.DUFOUR.html new file mode 100644 index 00000000..bea37478 --- /dev/null +++ b/docs/variables/web3.DUFOUR.html @@ -0,0 +1 @@ +DUFOUR | @hoprnet/hopr-sdk

Variable DUFOURConst

DUFOUR: {
    addresses: {
        announcements: string;
        channels: string;
        module_implementation: string;
        network_registry: string;
        network_registry_proxy: string;
        node_safe_registry: string;
        node_stake_v2_factory: string;
        ticket_price_oracle: string;
        token: string;
    };
    environment_type: string;
    indexer_start_block_number: number;
} = ...

Type declaration

  • addresses: {
        announcements: string;
        channels: string;
        module_implementation: string;
        network_registry: string;
        network_registry_proxy: string;
        node_safe_registry: string;
        node_stake_v2_factory: string;
        ticket_price_oracle: string;
        token: string;
    }
    • announcements: string
    • channels: string
    • module_implementation: string
    • network_registry: string
    • network_registry_proxy: string
    • node_safe_registry: string
    • node_stake_v2_factory: string
    • ticket_price_oracle: string
    • token: string
  • environment_type: string
  • indexer_start_block_number: number

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.HOPR_CHANNELS_SMART_CONTRACT_ADDRESS.html b/docs/variables/web3.HOPR_CHANNELS_SMART_CONTRACT_ADDRESS.html new file mode 100644 index 00000000..c3981f69 --- /dev/null +++ b/docs/variables/web3.HOPR_CHANNELS_SMART_CONTRACT_ADDRESS.html @@ -0,0 +1 @@ +HOPR_CHANNELS_SMART_CONTRACT_ADDRESS | @hoprnet/hopr-sdk

Variable HOPR_CHANNELS_SMART_CONTRACT_ADDRESSConst

HOPR_CHANNELS_SMART_CONTRACT_ADDRESS: "0xfabee463f31e39ec8952bbfb4490c41103bf573e" = '0xfabee463f31e39ec8952bbfb4490c41103bf573e'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.erc721ABI.html b/docs/variables/web3.erc721ABI.html new file mode 100644 index 00000000..58a11eda --- /dev/null +++ b/docs/variables/web3.erc721ABI.html @@ -0,0 +1 @@ +erc721ABI | @hoprnet/hopr-sdk

Variable erc721ABIConst

erc721ABI: ({
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprBoostNFTABI.html b/docs/variables/web3.hoprBoostNFTABI.html new file mode 100644 index 00000000..66f60047 --- /dev/null +++ b/docs/variables/web3.hoprBoostNFTABI.html @@ -0,0 +1 @@ +hoprBoostNFTABI | @hoprnet/hopr-sdk

Variable hoprBoostNFTABIConst

hoprBoostNFTABI: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprChannelsABI.html b/docs/variables/web3.hoprChannelsABI.html new file mode 100644 index 00000000..d898cefe --- /dev/null +++ b/docs/variables/web3.hoprChannelsABI.html @@ -0,0 +1 @@ +hoprChannelsABI | @hoprnet/hopr-sdk

Variable hoprChannelsABIConst

hoprChannelsABI: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    } | {
        components: ({
            components: {
                internalType: ...;
                name: ...;
                type: ...;
            }[];
            internalType: string;
            name: string;
            type: string;
        } | {
            components?: undefined;
            internalType: string;
            name: string;
            type: string;
        })[];
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprMultiSendABI.html b/docs/variables/web3.hoprMultiSendABI.html new file mode 100644 index 00000000..53e09b24 --- /dev/null +++ b/docs/variables/web3.hoprMultiSendABI.html @@ -0,0 +1 @@ +hoprMultiSendABI | @hoprnet/hopr-sdk

Variable hoprMultiSendABIConst

hoprMultiSendABI: ({
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprNetworkRegistryABI.html b/docs/variables/web3.hoprNetworkRegistryABI.html new file mode 100644 index 00000000..f23ba7c1 --- /dev/null +++ b/docs/variables/web3.hoprNetworkRegistryABI.html @@ -0,0 +1 @@ +hoprNetworkRegistryABI | @hoprnet/hopr-sdk

Variable hoprNetworkRegistryABIConst

hoprNetworkRegistryABI: ({
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprNodeManagementModuleABI.html b/docs/variables/web3.hoprNodeManagementModuleABI.html new file mode 100644 index 00000000..8adacebe --- /dev/null +++ b/docs/variables/web3.hoprNodeManagementModuleABI.html @@ -0,0 +1 @@ +hoprNodeManagementModuleABI | @hoprnet/hopr-sdk

Variable hoprNodeManagementModuleABIConst

hoprNodeManagementModuleABI: ({
    anonymous?: undefined;
    inputs: never[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprNodeSafeRegistryABI.html b/docs/variables/web3.hoprNodeSafeRegistryABI.html new file mode 100644 index 00000000..248f94aa --- /dev/null +++ b/docs/variables/web3.hoprNodeSafeRegistryABI.html @@ -0,0 +1 @@ +hoprNodeSafeRegistryABI | @hoprnet/hopr-sdk

Variable hoprNodeSafeRegistryABIConst

hoprNodeSafeRegistryABI: ({
    anonymous?: undefined;
    inputs: never[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: ({
        components: {
            internalType: string;
            name: string;
            type: string;
        }[];
        internalType: string;
        name: string;
        type: string;
    } | {
        components?: undefined;
        internalType: string;
        name: string;
        type: string;
    })[];
    name: string;
    outputs: never[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprNodeStakeFactoryABI.html b/docs/variables/web3.hoprNodeStakeFactoryABI.html new file mode 100644 index 00000000..4bc2b4c1 --- /dev/null +++ b/docs/variables/web3.hoprNodeStakeFactoryABI.html @@ -0,0 +1 @@ +hoprNodeStakeFactoryABI | @hoprnet/hopr-sdk

Variable hoprNodeStakeFactoryABIConst

hoprNodeStakeFactoryABI: ({
    anonymous?: undefined;
    inputs: never[];
    name?: undefined;
    outputs?: undefined;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    inputs: never[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous: boolean;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprSafeABI.html b/docs/variables/web3.hoprSafeABI.html new file mode 100644 index 00000000..3f53cc37 --- /dev/null +++ b/docs/variables/web3.hoprSafeABI.html @@ -0,0 +1 @@ +hoprSafeABI | @hoprnet/hopr-sdk

Variable hoprSafeABIConst

hoprSafeABI: ({
    anonymous?: undefined;
    constant?: undefined;
    inputs: never[];
    name?: undefined;
    outputs?: undefined;
    payable: boolean;
    stateMutability: string;
    type: string;
} | {
    anonymous: boolean;
    constant?: undefined;
    inputs: {
        indexed: boolean;
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    payable?: undefined;
    stateMutability?: undefined;
    type: string;
} | {
    anonymous?: undefined;
    constant?: undefined;
    inputs?: undefined;
    name?: undefined;
    outputs?: undefined;
    payable: boolean;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    constant: boolean;
    inputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        internalType: string;
        name: string;
        type: string;
    }[];
    payable: boolean;
    stateMutability: string;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.hoprWrapperABI.html b/docs/variables/web3.hoprWrapperABI.html new file mode 100644 index 00000000..092bf11c --- /dev/null +++ b/docs/variables/web3.hoprWrapperABI.html @@ -0,0 +1 @@ +hoprWrapperABI | @hoprnet/hopr-sdk

Variable hoprWrapperABIConst

hoprWrapperABI: ({
    anonymous?: undefined;
    constant: boolean;
    inputs: {
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        name: string;
        type: string;
    }[];
    payable: boolean;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    constant?: undefined;
    inputs?: undefined;
    name?: undefined;
    outputs?: undefined;
    payable: boolean;
    stateMutability: string;
    type: string;
} | {
    anonymous: boolean;
    constant?: undefined;
    inputs: {
        indexed: boolean;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    payable?: undefined;
    stateMutability?: undefined;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.mHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html b/docs/variables/web3.mHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html new file mode 100644 index 00000000..4b4ffe8b --- /dev/null +++ b/docs/variables/web3.mHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html @@ -0,0 +1 @@ +mHOPR_TOKEN_SMART_CONTRACT_ADDRESS | @hoprnet/hopr-sdk

Variable mHOPR_TOKEN_SMART_CONTRACT_ADDRESSConst

mHOPR_TOKEN_SMART_CONTRACT_ADDRESS: "0x66225dE86Cac02b32f34992eb3410F59DE416698" = '0x66225dE86Cac02b32f34992eb3410F59DE416698'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.wrapperABI.html b/docs/variables/web3.wrapperABI.html new file mode 100644 index 00000000..7989bff0 --- /dev/null +++ b/docs/variables/web3.wrapperABI.html @@ -0,0 +1 @@ +wrapperABI | @hoprnet/hopr-sdk

Variable wrapperABIConst

wrapperABI: ({
    anonymous?: undefined;
    constant: boolean;
    inputs: {
        name: string;
        type: string;
    }[];
    name: string;
    outputs: {
        name: string;
        type: string;
    }[];
    payable: boolean;
    stateMutability: string;
    type: string;
} | {
    anonymous?: undefined;
    constant?: undefined;
    inputs?: undefined;
    name?: undefined;
    outputs?: undefined;
    payable: boolean;
    stateMutability: string;
    type: string;
} | {
    anonymous: boolean;
    constant?: undefined;
    inputs: {
        indexed: boolean;
        name: string;
        type: string;
    }[];
    name: string;
    outputs?: undefined;
    payable?: undefined;
    stateMutability?: undefined;
    type: string;
})[] = ...

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html b/docs/variables/web3.wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html new file mode 100644 index 00000000..964d23c6 --- /dev/null +++ b/docs/variables/web3.wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html @@ -0,0 +1 @@ +wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS | @hoprnet/hopr-sdk

Variable wxHOPR_TOKEN_SMART_CONTRACT_ADDRESSConst

wxHOPR_TOKEN_SMART_CONTRACT_ADDRESS: "0xD4fdec44DB9D44B8f2b6d529620f9C0C7066A2c1" = '0xD4fdec44DB9D44B8f2b6d529620f9C0C7066A2c1'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS.html b/docs/variables/web3.wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS.html new file mode 100644 index 00000000..e2b41e64 --- /dev/null +++ b/docs/variables/web3.wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS.html @@ -0,0 +1 @@ +wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS | @hoprnet/hopr-sdk

Variable wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESSConst

wxHOPR_WRAPPER_SMART_CONTRACT_ADDRESS: "0x097707143e01318734535676cfe2e5cF8b656ae8" = '0x097707143e01318734535676cfe2e5cF8b656ae8'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/web3.xHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html b/docs/variables/web3.xHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html new file mode 100644 index 00000000..e9b9c467 --- /dev/null +++ b/docs/variables/web3.xHOPR_TOKEN_SMART_CONTRACT_ADDRESS.html @@ -0,0 +1 @@ +xHOPR_TOKEN_SMART_CONTRACT_ADDRESS | @hoprnet/hopr-sdk

Variable xHOPR_TOKEN_SMART_CONTRACT_ADDRESSConst

xHOPR_TOKEN_SMART_CONTRACT_ADDRESS: "0xD057604A14982FE8D88c5fC25Aac3267eA142a08" = '0xD057604A14982FE8D88c5fC25Aac3267eA142a08'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/package.json b/package.json index 8e0db055..87c811cc 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ "format:ci": "prettier --check src/ e2e/ .github/ *.js *.ts *.json *.md", "test": "jest --coverage src/", "test:e2e": "bash e2e/start.sh", - "docs": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-zod --hideBreadcrumbs" + "docs": "typedoc --plugin typedoc-plugin-zod" }, "devDependencies": { "@types/debug": "^4.1.12",