@n1xyz/nord-ts 0.0.14 → 0.0.16-29f6652
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.prettierignore +1 -0
- package/README.md +9 -6
- package/dist/bridge/client.d.ts +8 -7
- package/dist/bridge/client.js +39 -37
- package/dist/bridge/index.d.ts +1 -2
- package/dist/bridge/index.js +2 -2
- package/dist/bridge/types.d.ts +7 -3
- package/dist/bridge/types.js +3 -1
- package/dist/gen/common.js +1 -1
- package/dist/gen/nord.d.ts +74 -25
- package/dist/gen/nord.js +498 -78
- package/dist/idl/bridge.json +1493 -0
- package/dist/idl/index.d.ts +585 -0
- package/dist/idl/index.js +8 -0
- package/dist/nord/api/core.js +7 -5
- package/dist/nord/api/metrics.js +7 -4
- package/dist/nord/client/Nord.d.ts +19 -5
- package/dist/nord/client/Nord.js +50 -23
- package/dist/nord/client/NordUser.d.ts +1 -1
- package/dist/nord/client/NordUser.js +19 -16
- package/dist/types.d.ts +3 -3
- package/dist/websocket/NordWebSocketClient.js +0 -2
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/Nord.html +99 -100
- package/docs/classes/NordError.html +6 -6
- package/docs/classes/NordUser.html +49 -54
- package/docs/classes/NordWebSocketClient.html +6 -11
- package/docs/classes/SolanaBridgeClient.html +32 -27
- package/docs/classes/Subscriber.html +3 -3
- package/docs/enums/FillMode.html +2 -2
- package/docs/enums/KeyType.html +2 -2
- package/docs/enums/MetricPeriod.html +2 -2
- package/docs/enums/PdaSeedType.html +5 -3
- package/docs/enums/PeakTpsPeriodUnit.html +2 -2
- package/docs/enums/Side.html +2 -2
- package/docs/enums/WebSocketMessageType.html +3 -3
- package/docs/functions/actionQueryRollman.html +1 -1
- package/docs/functions/actionsQueryRollman.html +1 -1
- package/docs/functions/aggregateMetrics-1.html +1 -1
- package/docs/functions/assert.html +1 -1
- package/docs/functions/bigIntToProtoU128.html +1 -1
- package/docs/functions/bridgeToBN.html +1 -1
- package/docs/functions/bufferToHex.html +1 -1
- package/docs/functions/cancelOrder.html +1 -1
- package/docs/functions/checkPubKeyLength.html +1 -1
- package/docs/functions/checkedFetch.html +1 -1
- package/docs/functions/createSession.html +1 -1
- package/docs/functions/decodeLengthDelimited.html +1 -1
- package/docs/functions/encodeLengthDelimited.html +1 -1
- package/docs/functions/fillModeToProtoFillMode.html +1 -1
- package/docs/functions/findMarket.html +1 -1
- package/docs/functions/findPda.html +1 -1
- package/docs/functions/findToken.html +1 -1
- package/docs/functions/fromBN.html +1 -1
- package/docs/functions/getAccount.html +1 -1
- package/docs/functions/getActionNonce.html +1 -1
- package/docs/functions/getCurrentTps.html +1 -1
- package/docs/functions/getInfo.html +1 -1
- package/docs/functions/{queryLastNBlocks.html → getLastActionId.html} +3 -3
- package/docs/functions/getMedianLatency.html +1 -1
- package/docs/functions/getOrderbook.html +1 -1
- package/docs/functions/getPeakTps.html +1 -1
- package/docs/functions/getTimestamp.html +1 -1
- package/docs/functions/getTotalTransactions.html +1 -1
- package/docs/functions/getTrades.html +1 -1
- package/docs/functions/getUserAccountIds.html +1 -1
- package/docs/functions/hexToBuffer.html +1 -1
- package/docs/functions/initWebSocketClient.html +9 -9
- package/docs/functions/keypairFromPrivateKey.html +1 -1
- package/docs/functions/makeSigningFunction.html +1 -1
- package/docs/functions/makeWalletSignFn.html +1 -1
- package/docs/functions/marketsStats.html +1 -1
- package/docs/functions/optExpect.html +1 -1
- package/docs/functions/optMap.html +1 -1
- package/docs/functions/optUnwrap.html +1 -1
- package/docs/functions/panic.html +1 -1
- package/docs/functions/placeOrder.html +1 -1
- package/docs/functions/queryAction.html +1 -1
- package/docs/functions/queryPrometheus.html +1 -1
- package/docs/functions/queryRecentActions.html +4 -3
- package/docs/functions/revokeSession.html +1 -1
- package/docs/functions/shortenPublicKey.html +1 -1
- package/docs/functions/signAction.html +1 -1
- package/docs/functions/toBN.html +1 -1
- package/docs/functions/toScaledU128.html +1 -1
- package/docs/functions/toScaledU64.html +1 -1
- package/docs/functions/transfer.html +1 -1
- package/docs/functions/withdraw.html +1 -1
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +2 -2
- package/docs/interfaces/Account.html +2 -2
- package/docs/interfaces/ActionInfo.html +2 -2
- package/docs/interfaces/ActionNonceResponse.html +2 -2
- package/docs/interfaces/ActionQuery.html +2 -2
- package/docs/interfaces/ActionResponse.html +2 -2
- package/docs/interfaces/ActionsExtendedInfo.html +2 -2
- package/docs/interfaces/ActionsQuery.html +2 -2
- package/docs/interfaces/ActionsResponse.html +2 -2
- package/docs/interfaces/AggregateMetrics.html +2 -2
- package/docs/interfaces/BlockFacts.html +5 -5
- package/docs/interfaces/BlockQuery.html +2 -2
- package/docs/interfaces/BlockResponse.html +2 -2
- package/docs/interfaces/BlockSummary.html +2 -2
- package/docs/interfaces/BlockSummaryResponse.html +2 -2
- package/docs/interfaces/DeltaEvent.html +2 -2
- package/docs/interfaces/DepositSplParams.html +6 -6
- package/docs/interfaces/Info.html +2 -2
- package/docs/interfaces/Market.html +2 -2
- package/docs/interfaces/MarketStats.html +2 -2
- package/docs/interfaces/MarketsStatsResponse.html +2 -2
- package/docs/interfaces/NordConfig.html +19 -9
- package/docs/interfaces/NordWebSocketClientEvents.html +2 -2
- package/docs/interfaces/NordWebSocketEvents.html +3 -3
- package/docs/interfaces/Order.html +2 -2
- package/docs/interfaces/OrderInfo.html +2 -2
- package/docs/interfaces/OrderbookEntry.html +2 -2
- package/docs/interfaces/OrderbookQuery.html +2 -2
- package/docs/interfaces/OrderbookResponse.html +2 -2
- package/docs/interfaces/OrderbookSubscription.html +5 -5
- package/docs/interfaces/PerpMarketStats.html +2 -2
- package/docs/interfaces/RollmanActionExtendedInfo.html +2 -2
- package/docs/interfaces/RollmanActionInfo.html +2 -2
- package/docs/interfaces/RollmanActionResponse.html +2 -2
- package/docs/interfaces/RollmanActionsResponse.html +2 -2
- package/docs/interfaces/RollmanBlockResponse.html +2 -2
- package/docs/interfaces/SPLTokenInfo.html +5 -5
- package/docs/interfaces/SolanaBridgeConfig.html +8 -6
- package/docs/interfaces/StateFacts.html +5 -5
- package/docs/interfaces/SubscriberConfig.html +2 -2
- package/docs/interfaces/TimestampResponse.html +2 -2
- package/docs/interfaces/Token.html +2 -2
- package/docs/interfaces/TokenInfo.html +3 -2
- package/docs/interfaces/Trade.html +2 -2
- package/docs/interfaces/TradeSubscription.html +5 -5
- package/docs/interfaces/Trades.html +2 -2
- package/docs/interfaces/TradesQuery.html +2 -2
- package/docs/interfaces/TradesResponse.html +2 -2
- package/docs/interfaces/TransferParams.html +4 -4
- package/docs/interfaces/UserAccountIdsQuery.html +2 -2
- package/docs/interfaces/UserAccountIdsResponse.html +2 -2
- package/docs/interfaces/WebSocketAccountUpdate.html +6 -0
- package/docs/interfaces/WebSocketDeltaUpdate.html +3 -3
- package/docs/interfaces/WebSocketSubscription.html +3 -3
- package/docs/interfaces/WebSocketTradeUpdate.html +3 -3
- package/docs/interfaces/WithdrawalClaim.html +7 -7
- package/docs/interfaces/WithdrawalParams.html +4 -4
- package/docs/modules.html +1 -1
- package/docs/types/BigIntValue.html +1 -1
- package/docs/types/SubscriptionPattern.html +4 -0
- package/docs/types/SubscriptionType.html +2 -0
- package/docs/types/WebSocketMessage.html +1 -1
- package/docs/variables/DEBUG_KEYS.html +1 -1
- package/docs/variables/DEFAULT_FUNDING_AMOUNTS.html +1 -1
- package/docs/variables/DEV_TOKEN_INFOS.html +1 -1
- package/docs/variables/DEV_URL.html +1 -1
- package/docs/variables/MAX_BUFFER_LEN.html +1 -1
- package/docs/variables/SESSION_TTL.html +1 -1
- package/docs/variables/WEBSERVER_DEV_URL.html +1 -1
- package/docs/variables/ZERO_DECIMAL.html +1 -1
- package/docs/variables/_private.html +1 -1
- package/idl-generate.sh +4 -0
- package/package.json +6 -3
- package/src/bridge/client.ts +55 -43
- package/src/bridge/index.ts +1 -2
- package/src/bridge/types.ts +7 -3
- package/src/gen/common.ts +1 -1
- package/src/gen/nord.ts +567 -75
- package/src/idl/bridge.json +1493 -0
- package/src/idl/index.ts +2 -0
- package/src/nord/api/core.ts +1 -3
- package/src/nord/api/metrics.ts +2 -0
- package/src/nord/client/Nord.ts +49 -13
- package/src/nord/client/NordUser.ts +52 -59
- package/src/types.ts +2 -2
- package/src/websocket/NordWebSocketClient.ts +0 -2
- package/tsconfig.json +1 -1
- package/dist/idl/bridge.d.ts +0 -2
- package/dist/idl/bridge.js +0 -930
- package/docs/functions/blockQueryRollman.html +0 -6
- package/docs/functions/blockSummaryQueryRollman.html +0 -6
- package/docs/functions/queryBlock.html +0 -6
- package/docs/functions/queryRecentBlocks.html +0 -6
- package/docs/interfaces/WebSocketUserUpdate.html +0 -6
- package/src/idl/bridge.ts +0 -929
package/docs/classes/Nord.html
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Nord | @n1xyz/nord-ts</title><meta name="description" content="Documentation for @n1xyz/nord-ts"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@n1xyz/nord-ts</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@n1xyz/nord-ts</a></li><li><a href="Nord.html">Nord</a></li></ul><h1>Class Nord</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Main Nord client class for interacting with the Nord API</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Nord.html#
|
|
4
|
-
<a href="Nord.html#
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L55">src/nord/client/Nord.ts:55</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Nord.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Nord.html#bridgevk" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bridge<wbr/>Vk</span></a>
|
|
4
|
+
<a href="Nord.html#markets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markets</span></a>
|
|
5
5
|
<a href="Nord.html#solanaurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>solana<wbr/>Url</span></a>
|
|
6
6
|
<a href="Nord.html#tokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tokens</span></a>
|
|
7
7
|
<a href="Nord.html#webserverurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Server<wbr/>Url</span></a>
|
|
@@ -9,182 +9,181 @@
|
|
|
9
9
|
<a href="Nord.html#actionqueryrollman" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action<wbr/>Query<wbr/>Rollman</span></a>
|
|
10
10
|
<a href="Nord.html#actionsqueryrollman" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>actions<wbr/>Query<wbr/>Rollman</span></a>
|
|
11
11
|
<a href="Nord.html#aggregatemetrics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aggregate<wbr/>Metrics</span></a>
|
|
12
|
-
<a href="Nord.html#
|
|
13
|
-
<a href="Nord.html#blocksummaryqueryrollman" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>block<wbr/>Summary<wbr/>Query<wbr/>Rollman</span></a>
|
|
12
|
+
<a href="Nord.html#createwebsocketclient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Web<wbr/>Socket<wbr/>Client</span></a>
|
|
14
13
|
<a href="Nord.html#fetchnordinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Nord<wbr/>Info</span></a>
|
|
15
14
|
<a href="Nord.html#getaccount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Account</span></a>
|
|
16
15
|
<a href="Nord.html#getactionnonce" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Nonce</span></a>
|
|
17
16
|
<a href="Nord.html#getcurrenttps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Tps</span></a>
|
|
18
|
-
<a href="Nord.html#getdeltaswebsocketclient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Deltas<wbr/>Web<wbr/>Socket<wbr/>Client</span></a>
|
|
19
17
|
<a href="Nord.html#getinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Info</span></a>
|
|
18
|
+
<a href="Nord.html#getlastactionid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Last<wbr/>Action<wbr/>Id</span></a>
|
|
20
19
|
<a href="Nord.html#getmarketstats" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Market<wbr/>Stats</span></a>
|
|
21
20
|
<a href="Nord.html#getmedianlatency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Median<wbr/>Latency</span></a>
|
|
22
21
|
<a href="Nord.html#getorderbook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Orderbook</span></a>
|
|
23
22
|
<a href="Nord.html#getpeaktps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peak<wbr/>Tps</span></a>
|
|
23
|
+
<a href="Nord.html#getsolanaprogramid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Solana<wbr/>Program<wbr/>Id</span></a>
|
|
24
24
|
<a href="Nord.html#gettimestamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Timestamp</span></a>
|
|
25
25
|
<a href="Nord.html#gettotaltransactions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Transactions</span></a>
|
|
26
26
|
<a href="Nord.html#gettrades" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trades</span></a>
|
|
27
|
-
<a href="Nord.html#gettradeswebsocketclient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trades<wbr/>Web<wbr/>Socket<wbr/>Client</span></a>
|
|
28
27
|
<a href="Nord.html#getuseraccountids" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Account<wbr/>Ids</span></a>
|
|
29
|
-
<a href="Nord.html#getuserwebsocketclient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Web<wbr/>Socket<wbr/>Client</span></a>
|
|
30
|
-
<a href="Nord.html#getwebsocketclient" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Web<wbr/>Socket<wbr/>Client</span></a>
|
|
31
|
-
<a href="Nord.html#initializewebsockets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initialize<wbr/>Web<wbr/>Sockets</span></a>
|
|
32
28
|
<a href="Nord.html#marketsstats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>markets<wbr/>Stats</span></a>
|
|
33
29
|
<a href="Nord.html#queryaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Action</span></a>
|
|
34
|
-
<a href="Nord.html#queryblock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Block</span></a>
|
|
35
|
-
<a href="Nord.html#querylastnblocks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>LastNBlocks</span></a>
|
|
36
30
|
<a href="Nord.html#queryprometheus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Prometheus</span></a>
|
|
37
31
|
<a href="Nord.html#queryrecentactions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Recent<wbr/>Actions</span></a>
|
|
38
|
-
<a href="Nord.html#
|
|
32
|
+
<a href="Nord.html#subscribeaccount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Account</span></a>
|
|
39
33
|
<a href="Nord.html#subscribeorderbook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Orderbook</span></a>
|
|
40
34
|
<a href="Nord.html#subscribetrades" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Trades</span></a>
|
|
41
35
|
<a href="Nord.html#initnord" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Nord</span></a>
|
|
42
36
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructornord" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Nord</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/NordConfig.html" class="tsd-signature-type tsd-kind-interface">NordConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="Nord.html" class="tsd-signature-type tsd-kind-class">Nord</a><a href="#constructornord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a new Nord client</p>
|
|
43
37
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <a href="../interfaces/NordConfig.html" class="tsd-signature-type tsd-kind-interface">NordConfig</a></span><div class="tsd-comment tsd-typography"><p>Configuration options for the Nord client</p>
|
|
44
38
|
</div><div class="tsd-comment tsd-typography"></div><div class="tsd-comment tsd-typography"><p>Configuration options for the Nord client</p>
|
|
45
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><
|
|
39
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">bridgeVk</span><a id="bridgevk" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Bridge verification key</p>
|
|
40
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">deltasSubscriptions</span><a id="deltassubscriptions" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Initial subscriptions for the deltas WebSocket
|
|
41
|
+
Supports both formats:</p>
|
|
42
|
+
<ul>
|
|
43
|
+
<li>Legacy format: ["BTCUSDC", "ETHUSDC"]</li>
|
|
44
|
+
<li>New format: ["deltas@BTCUSDC", "deltas@ETHUSDC"]</li>
|
|
45
|
+
</ul>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">initWebSockets</span><a id="initwebsockets" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to initialize WebSockets on creation, defaults to true</p>
|
|
47
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">solanaProgramId</span><a id="solanaprogramid" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Solana program ID</p>
|
|
48
47
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">solanaUrl</span><a id="solanaurl" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Solana cluster URL</p>
|
|
49
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">tradesSubscriptions</span><a id="tradessubscriptions" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Initial subscriptions for the trades WebSocket
|
|
48
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">tradesSubscriptions</span><a id="tradessubscriptions" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Initial subscriptions for the trades WebSocket
|
|
49
|
+
Supports both formats:</p>
|
|
50
|
+
<ul>
|
|
51
|
+
<li>Legacy format: ["BTCUSDC", "ETHUSDC"]</li>
|
|
52
|
+
<li>New format: ["trades@BTCUSDC", "trades@ETHUSDC"]</li>
|
|
53
|
+
</ul>
|
|
50
54
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">webServerUrl</span><a id="webserverurl" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Base URL for the Nord web server</p>
|
|
51
55
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Nord.html" class="tsd-signature-type tsd-kind-class">Nord</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If required configuration is missing</p>
|
|
52
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
53
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
54
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
55
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
56
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
57
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
56
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L86">src/nord/client/Nord.ts:86</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="bridgevk" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>bridge<wbr/>Vk</span><a href="#bridgevk" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bridgeVk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Bridge verification key</p>
|
|
57
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L60">src/nord/client/Nord.ts:60</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="markets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>markets</span><a href="#markets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">markets</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Market.html" class="tsd-signature-type tsd-kind-interface">Market</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Available markets</p>
|
|
58
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L69">src/nord/client/Nord.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="solanaurl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>solana<wbr/>Url</span><a href="#solanaurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">solanaUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Solana RPC URL</p>
|
|
59
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L66">src/nord/client/Nord.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tokens</span><a href="#tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tokens</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Token.html" class="tsd-signature-type tsd-kind-interface">Token</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Available tokens</p>
|
|
60
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L72">src/nord/client/Nord.ts:72</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="webserverurl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>web<wbr/>Server<wbr/>Url</span><a href="#webserverurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">webServerUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Base URL for the Nord web server</p>
|
|
61
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L57">src/nord/client/Nord.ts:57</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="accountexists" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>account<wbr/>Exists</span><a href="#accountexists" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="accountexists-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">accountExists</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#accountexists-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if an account exists for the given address</p>
|
|
58
62
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">address</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The public key address to check</p>
|
|
59
63
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>True if the account exists, false otherwise</p>
|
|
60
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
64
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L601">src/nord/client/Nord.ts:601</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="actionqueryrollman" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>action<wbr/>Query<wbr/>Rollman</span><a href="#actionqueryrollman" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="actionqueryrollman-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">actionQueryRollman</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RollmanActionResponse.html" class="tsd-signature-type tsd-kind-interface">RollmanActionResponse</a><span class="tsd-signature-symbol">></span><a href="#actionqueryrollman-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query an action from Rollman</p>
|
|
61
65
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a></span><div class="tsd-comment tsd-typography"><p>Action query parameters</p>
|
|
62
66
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RollmanActionResponse.html" class="tsd-signature-type tsd-kind-interface">RollmanActionResponse</a><span class="tsd-signature-symbol">></span></h4><p>Rollman action response</p>
|
|
63
67
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-1" class="tsd-anchor"></a>Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
64
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
68
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L366">src/nord/client/Nord.ts:366</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="actionsqueryrollman" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>actions<wbr/>Query<wbr/>Rollman</span><a href="#actionsqueryrollman" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="actionsqueryrollman-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">actionsQueryRollman</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">last_n</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RollmanActionsResponse.html" class="tsd-signature-type tsd-kind-interface">RollmanActionsResponse</a><span class="tsd-signature-symbol">></span><a href="#actionsqueryrollman-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query actions from Rollman</p>
|
|
65
69
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">last_n</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Number of recent actions to query</p>
|
|
66
70
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/RollmanActionsResponse.html" class="tsd-signature-type tsd-kind-interface">RollmanActionsResponse</a><span class="tsd-signature-symbol">></span></h4><p>Rollman actions response</p>
|
|
67
71
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-2" class="tsd-anchor"></a>Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
68
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
72
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L377">src/nord/client/Nord.ts:377</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="aggregatemetrics" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>aggregate<wbr/>Metrics</span><a href="#aggregatemetrics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="aggregatemetrics-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">aggregateMetrics</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">txPeakTpsPeriod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">txPeakTpsPeriodUnit</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/PeakTpsPeriodUnit.html" class="tsd-signature-type tsd-kind-enum">PeakTpsPeriodUnit</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AggregateMetrics.html" class="tsd-signature-type tsd-kind-interface">AggregateMetrics</a><span class="tsd-signature-symbol">></span><a href="#aggregatemetrics-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch aggregate metrics from the Nord API</p>
|
|
69
73
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">txPeakTpsPeriod</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span><div class="tsd-comment tsd-typography"><p>Period for peak TPS calculation</p>
|
|
70
74
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">txPeakTpsPeriodUnit</span>: <a href="../enums/PeakTpsPeriodUnit.html" class="tsd-signature-type tsd-kind-enum">PeakTpsPeriodUnit</a><span class="tsd-signature-symbol"> = PeakTpsPeriodUnit.Day</span></span><div class="tsd-comment tsd-typography"><p>Unit for peak TPS period</p>
|
|
71
75
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AggregateMetrics.html" class="tsd-signature-type tsd-kind-interface">AggregateMetrics</a><span class="tsd-signature-symbol">></span></h4><p>Aggregate metrics</p>
|
|
72
76
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-3" class="tsd-anchor"></a>Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
73
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
74
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">
|
|
75
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <
|
|
76
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-4" class="tsd-anchor"></a>Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If
|
|
77
|
-
</div
|
|
78
|
-
</
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
</
|
|
82
|
-
|
|
83
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
77
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L305">src/nord/client/Nord.ts:305</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="createwebsocketclient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Web<wbr/>Socket<wbr/>Client</span><a href="#createwebsocketclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="createwebsocketclient-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createWebSocketClient</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebSocketSubscriptionOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a><a href="#createwebsocketclient-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a WebSocket client with specific subscriptions</p>
|
|
78
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">WebSocketSubscriptionOptions</span></span><div class="tsd-comment tsd-typography"><p>Subscription options that specify which data streams to subscribe to</p>
|
|
79
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a></h4><p>A new WebSocket client with the requested subscriptions</p>
|
|
80
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-4" class="tsd-anchor"></a>Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If invalid subscription options are provided</p>
|
|
81
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// Create a client for trades and deltas from one market and an account</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">wsClient</span><span class="hl-2"> = </span><span class="hl-5">nord</span><span class="hl-2">.</span><span class="hl-1">createWebSocketClient</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-5">trades:</span><span class="hl-2"> [</span><span class="hl-3">"BTCUSDC"</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-5">deltas:</span><span class="hl-2"> [</span><span class="hl-3">"BTCUSDC"</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-5">accounts:</span><span class="hl-2"> [</span><span class="hl-8">123</span><span class="hl-2">]</span><br/><span class="hl-2">});</span>
|
|
82
|
+
</code><button type="button">Copy</button></pre>
|
|
83
|
+
|
|
84
|
+
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-1" class="tsd-anchor"></a>Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// Create a client for trades from multiple markets</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">tradesClient</span><span class="hl-2"> = </span><span class="hl-5">nord</span><span class="hl-2">.</span><span class="hl-1">createWebSocketClient</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-5">trades:</span><span class="hl-2"> [</span><span class="hl-3">"BTCUSDC"</span><span class="hl-2">, </span><span class="hl-3">"ETHUSDC"</span><span class="hl-2">]</span><br/><span class="hl-2">});</span>
|
|
85
|
+
</code><button type="button">Copy</button></pre>
|
|
86
|
+
|
|
87
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L125">src/nord/client/Nord.ts:125</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchnordinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Nord<wbr/>Info</span><a href="#fetchnordinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="fetchnordinfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetchNordInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#fetchnordinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch information about Nord markets and tokens</p>
|
|
88
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-5" class="tsd-anchor"></a>Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
89
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L190">src/nord/client/Nord.ts:190</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getaccount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Account</span><a href="#getaccount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getaccount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAccount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">accountId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Account.html" class="tsd-signature-type tsd-kind-interface">Account</a><span class="tsd-signature-symbol">></span><a href="#getaccount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get account information</p>
|
|
84
90
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">accountId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Account ID to get information for</p>
|
|
85
91
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Account.html" class="tsd-signature-type tsd-kind-interface">Account</a><span class="tsd-signature-symbol">></span></h4><p>Account information</p>
|
|
86
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
87
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
92
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-6" class="tsd-anchor"></a>Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
93
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L581">src/nord/client/Nord.ts:581</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getactionnonce" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Action<wbr/>Nonce</span><a href="#getactionnonce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getactionnonce-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getActionNonce</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getactionnonce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the next action nonce from the Nord server</p>
|
|
88
94
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Next action nonce</p>
|
|
89
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
90
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
95
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-7" class="tsd-anchor"></a>Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
96
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L181">src/nord/client/Nord.ts:181</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getcurrenttps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Current<wbr/>Tps</span><a href="#getcurrenttps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getcurrenttps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getCurrentTps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">period</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getcurrenttps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get current transactions per second</p>
|
|
91
97
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">period</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "1m"</span></span><div class="tsd-comment tsd-typography"><p>Time period for the query</p>
|
|
92
98
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Current TPS value</p>
|
|
93
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
94
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
95
|
-
If not already initialized, it will be created</p>
|
|
96
|
-
</div><h4 class="tsd-returns-title">Returns <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a></h4><p>WebSocket client for orderbook deltas</p>
|
|
97
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L448">src/nord/client/Nord.ts:448</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Info</span><a href="#getinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getinfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Info.html" class="tsd-signature-type tsd-kind-interface">Info</a><span class="tsd-signature-symbol">></span><a href="#getinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get information about the Nord server</p>
|
|
99
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-8" class="tsd-anchor"></a>Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
100
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L323">src/nord/client/Nord.ts:323</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Info</span><a href="#getinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getinfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Info.html" class="tsd-signature-type tsd-kind-interface">Info</a><span class="tsd-signature-symbol">></span><a href="#getinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get information about the Nord server</p>
|
|
98
101
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Info.html" class="tsd-signature-type tsd-kind-interface">Info</a><span class="tsd-signature-symbol">></span></h4><p>Information about markets and tokens</p>
|
|
102
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-9" class="tsd-anchor"></a>Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
103
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L570">src/nord/client/Nord.ts:570</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getlastactionid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Last<wbr/>Action<wbr/>Id</span><a href="#getlastactionid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getlastactionid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getLastActionId</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getlastactionid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the last action ID</p>
|
|
104
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Last action ID</p>
|
|
99
105
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-10" class="tsd-anchor"></a>Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
100
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
106
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L293">src/nord/client/Nord.ts:293</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getmarketstats" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">get<wbr/>Market<wbr/>Stats</span><a href="#getmarketstats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getmarketstats-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getMarketStats</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MarketsStatsResponse.html" class="tsd-signature-type tsd-kind-interface">MarketsStatsResponse</a><span class="tsd-signature-symbol">></span><a href="#getmarketstats-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get market statistics (alias for marketsStats for backward compatibility)</p>
|
|
101
107
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MarketsStatsResponse.html" class="tsd-signature-type tsd-kind-interface">MarketsStatsResponse</a><span class="tsd-signature-symbol">></span></h4><p>Market statistics response</p>
|
|
102
108
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use marketsStats instead</p>
|
|
103
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
109
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L591">src/nord/client/Nord.ts:591</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getmedianlatency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Median<wbr/>Latency</span><a href="#getmedianlatency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getmedianlatency-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getMedianLatency</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">period</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getmedianlatency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get median transaction latency</p>
|
|
104
110
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">period</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "1m"</span></span><div class="tsd-comment tsd-typography"><p>Time period for the query</p>
|
|
105
111
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Median latency in milliseconds</p>
|
|
106
112
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-11" class="tsd-anchor"></a>Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
107
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
113
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L345">src/nord/client/Nord.ts:345</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getorderbook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Orderbook</span><a href="#getorderbook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getorderbook-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getOrderbook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/OrderbookQuery.html" class="tsd-signature-type tsd-kind-interface">OrderbookQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/OrderbookResponse.html" class="tsd-signature-type tsd-kind-interface">OrderbookResponse</a><span class="tsd-signature-symbol">></span><a href="#getorderbook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get orderbook for a market</p>
|
|
108
114
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="../interfaces/OrderbookQuery.html" class="tsd-signature-type tsd-kind-interface">OrderbookQuery</a></span><div class="tsd-comment tsd-typography"><p>Orderbook query parameters (either market_id or symbol must be provided)</p>
|
|
109
115
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/OrderbookResponse.html" class="tsd-signature-type tsd-kind-interface">OrderbookResponse</a><span class="tsd-signature-symbol">></span></h4><p>Orderbook response</p>
|
|
110
116
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-12" class="tsd-anchor"></a>Throws<a href="#throws-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails or if the market symbol is unknown</p>
|
|
111
117
|
</div><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link"><a id="remarks" class="tsd-anchor"></a>Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>It's recommended to initialize the Nord client using the static <code>initNord</code> method
|
|
112
118
|
to ensure market information is properly loaded before calling this method.</p>
|
|
113
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
119
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L545">src/nord/client/Nord.ts:545</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getpeaktps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Peak<wbr/>Tps</span><a href="#getpeaktps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getpeaktps-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getPeakTps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">period</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#getpeaktps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get peak transactions per second</p>
|
|
114
120
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">period</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "24h"</span></span><div class="tsd-comment tsd-typography"><p>Time period for the query</p>
|
|
115
121
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Peak TPS value</p>
|
|
116
122
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-13" class="tsd-anchor"></a>Throws<a href="#throws-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
117
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
123
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L334">src/nord/client/Nord.ts:334</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getsolanaprogramid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Solana<wbr/>Program<wbr/>Id</span><a href="#getsolanaprogramid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getsolanaprogramid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSolanaProgramId</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getsolanaprogramid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the Solana program ID derived from bridge VK</p>
|
|
124
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Program ID string</p>
|
|
125
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-14" class="tsd-anchor"></a>Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If program ID hasn't been initialized</p>
|
|
126
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L245">src/nord/client/Nord.ts:245</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="gettimestamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Timestamp</span><a href="#gettimestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="gettimestamp-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTimestamp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">></span><a href="#gettimestamp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the current timestamp from the Nord server</p>
|
|
118
127
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">></span></h4><p>Current timestamp as a bigint</p>
|
|
119
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-14" class="tsd-anchor"></a>Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
120
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L179">src/nord/client/Nord.ts:179</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="gettotaltransactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Total<wbr/>Transactions</span><a href="#gettotaltransactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="gettotaltransactions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTotalTransactions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#gettotaltransactions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get total transaction count</p>
|
|
121
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Total transaction count</p>
|
|
122
128
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-15" class="tsd-anchor"></a>Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
123
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
129
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L171">src/nord/client/Nord.ts:171</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="gettotaltransactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Total<wbr/>Transactions</span><a href="#gettotaltransactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="gettotaltransactions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTotalTransactions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#gettotaltransactions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get total transaction count</p>
|
|
130
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Total transaction count</p>
|
|
131
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-16" class="tsd-anchor"></a>Throws<a href="#throws-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
132
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L355">src/nord/client/Nord.ts:355</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="gettrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trades</span><a href="#gettrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="gettrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTrades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TradesQuery.html" class="tsd-signature-type tsd-kind-interface">TradesQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TradesResponse.html" class="tsd-signature-type tsd-kind-interface">TradesResponse</a><span class="tsd-signature-symbol">></span><a href="#gettrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get trades for a market</p>
|
|
124
133
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="../interfaces/TradesQuery.html" class="tsd-signature-type tsd-kind-interface">TradesQuery</a></span><div class="tsd-comment tsd-typography"><p>Trades query parameters</p>
|
|
125
134
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/TradesResponse.html" class="tsd-signature-type tsd-kind-interface">TradesResponse</a><span class="tsd-signature-symbol">></span></h4><p>Trades response</p>
|
|
126
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
127
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
128
|
-
If not already initialized, it will be created</p>
|
|
129
|
-
</div><h4 class="tsd-returns-title">Returns <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a></h4><p>WebSocket client for trades</p>
|
|
130
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L435">src/nord/client/Nord.ts:435</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getuseraccountids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Account<wbr/>Ids</span><a href="#getuseraccountids" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getuseraccountids-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getUserAccountIds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UserAccountIdsQuery.html" class="tsd-signature-type tsd-kind-interface">UserAccountIdsQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UserAccountIdsResponse.html" class="tsd-signature-type tsd-kind-interface">UserAccountIdsResponse</a><span class="tsd-signature-symbol">></span><a href="#getuseraccountids-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get user account IDs</p>
|
|
135
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-17" class="tsd-anchor"></a>Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
136
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L519">src/nord/client/Nord.ts:519</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getuseraccountids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Account<wbr/>Ids</span><a href="#getuseraccountids" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getuseraccountids-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getUserAccountIds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UserAccountIdsQuery.html" class="tsd-signature-type tsd-kind-interface">UserAccountIdsQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UserAccountIdsResponse.html" class="tsd-signature-type tsd-kind-interface">UserAccountIdsResponse</a><span class="tsd-signature-symbol">></span><a href="#getuseraccountids-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get user account IDs</p>
|
|
131
137
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="../interfaces/UserAccountIdsQuery.html" class="tsd-signature-type tsd-kind-interface">UserAccountIdsQuery</a></span><div class="tsd-comment tsd-typography"><p>User account IDs query parameters</p>
|
|
132
138
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UserAccountIdsResponse.html" class="tsd-signature-type tsd-kind-interface">UserAccountIdsResponse</a><span class="tsd-signature-symbol">></span></h4><p>User account IDs response</p>
|
|
133
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-17" class="tsd-anchor"></a>Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
134
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L568">src/nord/client/Nord.ts:568</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getuserwebsocketclient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Web<wbr/>Socket<wbr/>Client</span><a href="#getuserwebsocketclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getuserwebsocketclient-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getUserWebSocketClient</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a><a href="#getuserwebsocketclient-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the user WebSocket client
|
|
135
|
-
If not already initialized, it will be created</p>
|
|
136
|
-
</div><h4 class="tsd-returns-title">Returns <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a></h4><p>WebSocket client for user updates</p>
|
|
137
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L461">src/nord/client/Nord.ts:461</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getwebsocketclient" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Web<wbr/>Socket<wbr/>Client</span><a href="#getwebsocketclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getwebsocketclient-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getWebSocketClient</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a><a href="#getwebsocketclient-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the trades WebSocket client (default)
|
|
138
|
-
If not already initialized, it will be created</p>
|
|
139
|
-
</div><h4 class="tsd-returns-title">Returns <a href="NordWebSocketClient.html" class="tsd-signature-type tsd-kind-class">NordWebSocketClient</a></h4><p>WebSocket client for trades</p>
|
|
140
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L422">src/nord/client/Nord.ts:422</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="initializewebsockets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>initialize<wbr/>Web<wbr/>Sockets</span><a href="#initializewebsockets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="initializewebsockets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">initializeWebSockets</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">tradesSubscriptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">deltasSubscriptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#initializewebsockets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initialize WebSocket clients for trades and deltas</p>
|
|
141
|
-
<p>This method can be called manually if websockets were not initialized during construction
|
|
142
|
-
(i.e., if initWebSockets was set to false in the constructor).</p>
|
|
143
|
-
<p>It initializes the trades and deltas WebSocket clients. The user WebSocket client
|
|
144
|
-
is initialized on demand when needed.</p>
|
|
145
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">tradesSubscriptions</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional array of trades subscriptions to initialize with</p>
|
|
146
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deltasSubscriptions</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional array of deltas subscriptions to initialize with</p>
|
|
147
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L152">src/nord/client/Nord.ts:152</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="marketsstats" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>markets<wbr/>Stats</span><a href="#marketsstats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="marketsstats-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">marketsStats</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MarketsStatsResponse.html" class="tsd-signature-type tsd-kind-interface">MarketsStatsResponse</a><span class="tsd-signature-symbol">></span><a href="#marketsstats-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get market statistics</p>
|
|
148
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MarketsStatsResponse.html" class="tsd-signature-type tsd-kind-interface">MarketsStatsResponse</a><span class="tsd-signature-symbol">></span></h4><p>Market statistics response</p>
|
|
149
139
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-18" class="tsd-anchor"></a>Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
150
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
140
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L530">src/nord/client/Nord.ts:530</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="marketsstats" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>markets<wbr/>Stats</span><a href="#marketsstats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="marketsstats-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">marketsStats</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MarketsStatsResponse.html" class="tsd-signature-type tsd-kind-interface">MarketsStatsResponse</a><span class="tsd-signature-symbol">></span><a href="#marketsstats-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get market statistics</p>
|
|
141
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/MarketsStatsResponse.html" class="tsd-signature-type tsd-kind-interface">MarketsStatsResponse</a><span class="tsd-signature-symbol">></span></h4><p>Market statistics response</p>
|
|
142
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-19" class="tsd-anchor"></a>Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
143
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L260">src/nord/client/Nord.ts:260</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="queryaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Action</span><a href="#queryaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="queryaction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryAction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">></span><a href="#queryaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query a specific action</p>
|
|
151
144
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="../interfaces/ActionQuery.html" class="tsd-signature-type tsd-kind-interface">ActionQuery</a></span><div class="tsd-comment tsd-typography"><p>Action query parameters</p>
|
|
152
145
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ActionResponse.html" class="tsd-signature-type tsd-kind-interface">ActionResponse</a><span class="tsd-signature-symbol">></span></h4><p>Action response</p>
|
|
153
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-19" class="tsd-anchor"></a>Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
154
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L282">src/nord/client/Nord.ts:282</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="queryblock" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Block</span><a href="#queryblock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="queryblock-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryBlock</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/BlockQuery.html" class="tsd-signature-type tsd-kind-interface">BlockQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BlockResponse.html" class="tsd-signature-type tsd-kind-interface">BlockResponse</a><span class="tsd-signature-symbol">></span><a href="#queryblock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query a specific block</p>
|
|
155
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <a href="../interfaces/BlockQuery.html" class="tsd-signature-type tsd-kind-interface">BlockQuery</a></span><div class="tsd-comment tsd-typography"><p>Block query parameters</p>
|
|
156
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BlockResponse.html" class="tsd-signature-type tsd-kind-interface">BlockResponse</a><span class="tsd-signature-symbol">></span></h4><p>Block response</p>
|
|
157
146
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-20" class="tsd-anchor"></a>Throws<a href="#throws-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
158
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
159
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BlockResponse.html" class="tsd-signature-type tsd-kind-interface">BlockResponse</a><span class="tsd-signature-symbol">></span></h4><p>Block response for the last N blocks</p>
|
|
160
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-21" class="tsd-anchor"></a>Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
161
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L260">src/nord/client/Nord.ts:260</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="queryprometheus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Prometheus</span><a href="#queryprometheus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="queryprometheus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryPrometheus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#queryprometheus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query Prometheus metrics</p>
|
|
147
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L271">src/nord/client/Nord.ts:271</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="queryprometheus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Prometheus</span><a href="#queryprometheus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="queryprometheus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryPrometheus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#queryprometheus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query Prometheus metrics</p>
|
|
162
148
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Prometheus query parameters</p>
|
|
163
149
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>Query result as a number</p>
|
|
164
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
165
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
166
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">
|
|
150
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-21" class="tsd-anchor"></a>Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
151
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L388">src/nord/client/Nord.ts:388</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="queryrecentactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>query<wbr/>Recent<wbr/>Actions</span><a href="#queryrecentactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="queryrecentactions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryRecentActions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">to</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ActionsResponse.html" class="tsd-signature-type tsd-kind-interface">ActionsResponse</a><span class="tsd-signature-symbol">></span><a href="#queryrecentactions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query recent actions</p>
|
|
152
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">from</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Starting action index</p>
|
|
153
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">to</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Ending action index</p>
|
|
167
154
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ActionsResponse.html" class="tsd-signature-type tsd-kind-interface">ActionsResponse</a><span class="tsd-signature-symbol">></span></h4><p>Actions response</p>
|
|
168
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
169
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
170
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">
|
|
171
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
|
172
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
173
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord
|
|
155
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-22" class="tsd-anchor"></a>Throws<a href="#throws-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the request fails</p>
|
|
156
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L283">src/nord/client/Nord.ts:283</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribeaccount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe<wbr/>Account</span><a href="#subscribeaccount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="subscribeaccount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribeAccount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">accountId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UserSubscription</span><a href="#subscribeaccount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to account updates</p>
|
|
157
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">accountId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Account ID to subscribe to</p>
|
|
158
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UserSubscription</span></h4><p>User subscription</p>
|
|
159
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-23" class="tsd-anchor"></a>Throws<a href="#throws-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If accountId is invalid</p>
|
|
160
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L483">src/nord/client/Nord.ts:483</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribeorderbook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe<wbr/>Orderbook</span><a href="#subscribeorderbook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="subscribeorderbook-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribeOrderbook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/OrderbookSubscription.html" class="tsd-signature-type tsd-kind-interface">OrderbookSubscription</a><a href="#subscribeorderbook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to orderbook updates for a market</p>
|
|
174
161
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">symbol</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Market symbol</p>
|
|
175
162
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/OrderbookSubscription.html" class="tsd-signature-type tsd-kind-interface">OrderbookSubscription</a></h4><p>Orderbook subscription</p>
|
|
176
|
-
<div class="tsd-comment tsd-typography"
|
|
163
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-24" class="tsd-anchor"></a>Throws<a href="#throws-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If symbol is invalid</p>
|
|
164
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L399">src/nord/client/Nord.ts:399</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="subscribetrades" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subscribe<wbr/>Trades</span><a href="#subscribetrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="subscribetrades-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subscribeTrades</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/TradeSubscription.html" class="tsd-signature-type tsd-kind-interface">TradeSubscription</a><a href="#subscribetrades-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to trade updates for a market</p>
|
|
177
165
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">symbol</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Market symbol</p>
|
|
178
166
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/TradeSubscription.html" class="tsd-signature-type tsd-kind-interface">TradeSubscription</a></h4><p>Trade subscription</p>
|
|
179
|
-
<div class="tsd-comment tsd-typography"
|
|
167
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-25" class="tsd-anchor"></a>Throws<a href="#throws-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If symbol is invalid</p>
|
|
168
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L439">src/nord/client/Nord.ts:439</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="initnord" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>init<wbr/>Nord</span><a href="#initnord" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="initnord-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">initNord</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nordConfig</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/NordConfig.html" class="tsd-signature-type tsd-kind-interface">NordConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Nord.html" class="tsd-signature-type tsd-kind-class">Nord</a><span class="tsd-signature-symbol">></span><a href="#initnord-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initialize a new Nord client</p>
|
|
180
169
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nordConfig</span>: <a href="../interfaces/NordConfig.html" class="tsd-signature-type tsd-kind-interface">NordConfig</a></span><div class="tsd-comment tsd-typography"><p>Configuration options for the Nord client</p>
|
|
181
170
|
</div><div class="tsd-comment tsd-typography"></div><div class="tsd-comment tsd-typography"><p>Configuration options for the Nord client</p>
|
|
182
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><
|
|
171
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">bridgeVk</span><a id="bridgevk" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Bridge verification key</p>
|
|
172
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">deltasSubscriptions</span><a id="deltassubscriptions" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Initial subscriptions for the deltas WebSocket
|
|
173
|
+
Supports both formats:</p>
|
|
174
|
+
<ul>
|
|
175
|
+
<li>Legacy format: ["BTCUSDC", "ETHUSDC"]</li>
|
|
176
|
+
<li>New format: ["deltas@BTCUSDC", "deltas@ETHUSDC"]</li>
|
|
177
|
+
</ul>
|
|
183
178
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">initWebSockets</span><a id="initwebsockets" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to initialize WebSockets on creation, defaults to true</p>
|
|
184
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">solanaProgramId</span><a id="solanaprogramid" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Solana program ID</p>
|
|
185
179
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">solanaUrl</span><a id="solanaurl" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Solana cluster URL</p>
|
|
186
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">tradesSubscriptions</span><a id="tradessubscriptions" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Initial subscriptions for the trades WebSocket
|
|
180
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">tradesSubscriptions</span><a id="tradessubscriptions" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Initial subscriptions for the trades WebSocket
|
|
181
|
+
Supports both formats:</p>
|
|
182
|
+
<ul>
|
|
183
|
+
<li>Legacy format: ["BTCUSDC", "ETHUSDC"]</li>
|
|
184
|
+
<li>New format: ["trades@BTCUSDC", "trades@ETHUSDC"]</li>
|
|
185
|
+
</ul>
|
|
187
186
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">webServerUrl</span><a id="webserverurl" class="tsd-anchor"></a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Base URL for the Nord web server</p>
|
|
188
187
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Nord.html" class="tsd-signature-type tsd-kind-class">Nord</a><span class="tsd-signature-symbol">></span></h4><p>Initialized Nord client</p>
|
|
189
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-
|
|
190
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord-ts/blob/f2620fa3c3fd6c29fd140ee792bf23daeed79f91/src/nord/client/Nord.ts#L227">src/nord/client/Nord.ts:227</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#markets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markets</span></a><a href="#solanaprogramid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>solana<wbr/>Program<wbr/>Id</span></a><a href="#solanaurl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>solana<wbr/>Url</span></a><a href="#tokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tokens</span></a><a href="#webserverurl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Server<wbr/>Url</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#accountexists" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>account<wbr/>Exists</span></a><a href="#actionqueryrollman" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action<wbr/>Query<wbr/>Rollman</span></a><a href="#actionsqueryrollman" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>actions<wbr/>Query<wbr/>Rollman</span></a><a href="#aggregatemetrics" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aggregate<wbr/>Metrics</span></a><a href="#blockqueryrollman" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>block<wbr/>Query<wbr/>Rollman</span></a><a href="#blocksummaryqueryrollman" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>block<wbr/>Summary<wbr/>Query<wbr/>Rollman</span></a><a href="#fetchnordinfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Nord<wbr/>Info</span></a><a href="#getaccount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Account</span></a><a href="#getactionnonce" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Nonce</span></a><a href="#getcurrenttps" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Tps</span></a><a href="#getdeltaswebsocketclient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Deltas<wbr/>Web<wbr/>Socket<wbr/>Client</span></a><a href="#getinfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Info</span></a><a href="#getmarketstats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Market<wbr/>Stats</span></a><a href="#getmedianlatency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Median<wbr/>Latency</span></a><a href="#getorderbook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Orderbook</span></a><a href="#getpeaktps" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peak<wbr/>Tps</span></a><a href="#gettimestamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Timestamp</span></a><a href="#gettotaltransactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Transactions</span></a><a href="#gettrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trades</span></a><a href="#gettradeswebsocketclient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trades<wbr/>Web<wbr/>Socket<wbr/>Client</span></a><a href="#getuseraccountids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Account<wbr/>Ids</span></a><a href="#getuserwebsocketclient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Web<wbr/>Socket<wbr/>Client</span></a><a href="#getwebsocketclient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Web<wbr/>Socket<wbr/>Client</span></a><a href="#initializewebsockets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>initialize<wbr/>Web<wbr/>Sockets</span></a><a href="#marketsstats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>markets<wbr/>Stats</span></a><a href="#queryaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Action</span></a><a href="#queryblock" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Block</span></a><a href="#querylastnblocks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>LastNBlocks</span></a><a href="#queryprometheus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Prometheus</span></a><a href="#queryrecentactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Recent<wbr/>Actions</span></a><a href="#queryrecentblocks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Recent<wbr/>Blocks</span></a><a href="#subscribeorderbook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Orderbook</span></a><a href="#subscribetrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Trades</span></a><a href="#initnord" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Nord</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@n1xyz/nord-ts</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
188
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-26" class="tsd-anchor"></a>Throws<a href="#throws-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If initialization fails</p>
|
|
189
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/n1xyz/nord/blob/29f6652df129a33b0ab106107649be2a93372fff/ts/src/nord/client/Nord.ts#L216">src/nord/client/Nord.ts:216</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#bridgevk" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bridge<wbr/>Vk</span></a><a href="#markets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>markets</span></a><a href="#solanaurl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>solana<wbr/>Url</span></a><a href="#tokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tokens</span></a><a href="#webserverurl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Server<wbr/>Url</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#accountexists" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>account<wbr/>Exists</span></a><a href="#actionqueryrollman" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action<wbr/>Query<wbr/>Rollman</span></a><a href="#actionsqueryrollman" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>actions<wbr/>Query<wbr/>Rollman</span></a><a href="#aggregatemetrics" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aggregate<wbr/>Metrics</span></a><a href="#createwebsocketclient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Web<wbr/>Socket<wbr/>Client</span></a><a href="#fetchnordinfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Nord<wbr/>Info</span></a><a href="#getaccount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Account</span></a><a href="#getactionnonce" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Action<wbr/>Nonce</span></a><a href="#getcurrenttps" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Tps</span></a><a href="#getinfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Info</span></a><a href="#getlastactionid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Last<wbr/>Action<wbr/>Id</span></a><a href="#getmarketstats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Market<wbr/>Stats</span></a><a href="#getmedianlatency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Median<wbr/>Latency</span></a><a href="#getorderbook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Orderbook</span></a><a href="#getpeaktps" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peak<wbr/>Tps</span></a><a href="#getsolanaprogramid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Solana<wbr/>Program<wbr/>Id</span></a><a href="#gettimestamp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Timestamp</span></a><a href="#gettotaltransactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Transactions</span></a><a href="#gettrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trades</span></a><a href="#getuseraccountids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Account<wbr/>Ids</span></a><a href="#marketsstats" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>markets<wbr/>Stats</span></a><a href="#queryaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Action</span></a><a href="#queryprometheus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Prometheus</span></a><a href="#queryrecentactions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Recent<wbr/>Actions</span></a><a href="#subscribeaccount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Account</span></a><a href="#subscribeorderbook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Orderbook</span></a><a href="#subscribetrades" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subscribe<wbr/>Trades</span></a><a href="#initnord" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Nord</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@n1xyz/nord-ts</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|