npm package version 1.1.0, update docs with v2ray, wireguard process,…

… utils methods and websocket client
sentinel-official · May 24, 2024 · 2dbcf16 · 2dbcf16
1 parent 1f14284
commit 2dbcf16
Show file tree

Hide file tree

Showing 215 changed files with 349 additions and 304 deletions.
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/index.SentinelClient.html b/docs/classes/index.SentinelClient.html
diff --git a/docs/classes/index.SentinelWsClient.html b/docs/classes/index.SentinelWsClient.html
diff --git a/docs/classes/index.SigningSentinelClient.html b/docs/classes/index.SigningSentinelClient.html
diff --git a/docs/classes/index.V2Ray.html b/docs/classes/index.V2Ray.html
diff --git a/docs/classes/index.Wireguard.html b/docs/classes/index.Wireguard.html
diff --git a/docs/enums/index.NodeVPNType.html b/docs/enums/index.NodeVPNType.html
diff --git a/docs/enums/index.Status.html b/docs/enums/index.Status.html
diff --git a/docs/functions/index.fetchLocation.html b/docs/functions/index.fetchLocation.html
diff --git a/docs/functions/index.isNodeEventCreateSubscription.html b/docs/functions/index.isNodeEventCreateSubscription.html
diff --git a/docs/functions/index.isNodeEventRegister.html b/docs/functions/index.isNodeEventRegister.html
diff --git a/docs/functions/index.isNodeEventUpdateDetails.html b/docs/functions/index.isNodeEventUpdateDetails.html
diff --git a/docs/functions/index.isNodeEventUpdateStatus.html b/docs/functions/index.isNodeEventUpdateStatus.html
diff --git a/docs/functions/index.isPlanEventCreate.html b/docs/functions/index.isPlanEventCreate.html
diff --git a/docs/functions/index.isPlanEventCreateSubscription.html b/docs/functions/index.isPlanEventCreateSubscription.html
diff --git a/docs/functions/index.isPlanEventLinkNode.html b/docs/functions/index.isPlanEventLinkNode.html
diff --git a/docs/functions/index.isPlanEventUnlinkNode.html b/docs/functions/index.isPlanEventUnlinkNode.html
diff --git a/docs/functions/index.isPlanEventUpdateStatus.html b/docs/functions/index.isPlanEventUpdateStatus.html
diff --git a/docs/functions/index.isProviderEventRegister.html b/docs/functions/index.isProviderEventRegister.html
diff --git a/docs/functions/index.isProviderEventUpdate.html b/docs/functions/index.isProviderEventUpdate.html
diff --git a/docs/functions/index.isSessionEventStart.html b/docs/functions/index.isSessionEventStart.html
diff --git a/docs/functions/index.isSessionEventUpdateDetails.html b/docs/functions/index.isSessionEventUpdateDetails.html
diff --git a/docs/functions/index.isSessionEventUpdateStatus.html b/docs/functions/index.isSessionEventUpdateStatus.html
diff --git a/docs/functions/index.isSubscriptionEventAllocate.html b/docs/functions/index.isSubscriptionEventAllocate.html
diff --git a/docs/functions/index.isSubscriptionEventCreatePayout.html b/docs/functions/index.isSubscriptionEventCreatePayout.html
diff --git a/docs/functions/index.isSubscriptionEventPayForPayout.html b/docs/functions/index.isSubscriptionEventPayForPayout.html
diff --git a/docs/functions/index.isSubscriptionEventPayForPlan.html b/docs/functions/index.isSubscriptionEventPayForPlan.html
diff --git a/docs/functions/index.isSubscriptionEventPayForSession.html b/docs/functions/index.isSubscriptionEventPayForSession.html
diff --git a/docs/functions/index.isSubscriptionEventRefund.html b/docs/functions/index.isSubscriptionEventRefund.html
diff --git a/docs/functions/index.isSubscriptionEventUpdateStatus.html b/docs/functions/index.isSubscriptionEventUpdateStatus.html
diff --git a/docs/functions/index.nodeRegister.html b/docs/functions/index.nodeRegister.html
diff --git a/docs/functions/index.nodeStatus-1.html b/docs/functions/index.nodeStatus-1.html
diff --git a/docs/functions/index.nodeSubscribe.html b/docs/functions/index.nodeSubscribe.html
diff --git a/docs/functions/index.nodeUpdateDetails.html b/docs/functions/index.nodeUpdateDetails.html
diff --git a/docs/functions/index.nodeUpdateStatus.html b/docs/functions/index.nodeUpdateStatus.html
diff --git a/docs/functions/index.parseAttributes.html b/docs/functions/index.parseAttributes.html
diff --git a/docs/functions/index.planCreate.html b/docs/functions/index.planCreate.html
diff --git a/docs/functions/index.planLinkNode.html b/docs/functions/index.planLinkNode.html
diff --git a/docs/functions/index.planSubscribe.html b/docs/functions/index.planSubscribe.html
diff --git a/docs/functions/index.planUnlinkNode.html b/docs/functions/index.planUnlinkNode.html
diff --git a/docs/functions/index.planUpdateStatus.html b/docs/functions/index.planUpdateStatus.html
diff --git a/docs/functions/index.postSession.html b/docs/functions/index.postSession.html
diff --git a/docs/functions/index.privKeyFromMnemonic.html b/docs/functions/index.privKeyFromMnemonic.html
diff --git a/docs/functions/index.providerRegister.html b/docs/functions/index.providerRegister.html
diff --git a/docs/functions/index.providerUpdate.html b/docs/functions/index.providerUpdate.html
diff --git a/docs/functions/index.searchEvent.html b/docs/functions/index.searchEvent.html
diff --git a/docs/functions/index.sessionEnd.html b/docs/functions/index.sessionEnd.html
diff --git a/docs/functions/index.sessionStart.html b/docs/functions/index.sessionStart.html
diff --git a/docs/functions/index.sessionUpdateDetails.html b/docs/functions/index.sessionUpdateDetails.html
diff --git a/docs/functions/index.signSessionId.html b/docs/functions/index.signSessionId.html
diff --git a/docs/functions/index.subscriptionAllocate.html b/docs/functions/index.subscriptionAllocate.html
diff --git a/docs/functions/index.subscriptionCancel.html b/docs/functions/index.subscriptionCancel.html
diff --git a/docs/functions/index.uintArrayTob64.html b/docs/functions/index.uintArrayTob64.html
diff --git a/docs/functions/modules_node.isMsgRegisterEncodeObject.html b/docs/functions/modules_node.isMsgRegisterEncodeObject.html
diff --git a/docs/functions/modules_node.isMsgSubscribeEncodeObject.html b/docs/functions/modules_node.isMsgSubscribeEncodeObject.html
diff --git a/docs/functions/modules_node.isMsgUpdateDetailsEncodeObject.html b/docs/functions/modules_node.isMsgUpdateDetailsEncodeObject.html
diff --git a/docs/functions/modules_node.isMsgUpdateStatusEncodeObject.html b/docs/functions/modules_node.isMsgUpdateStatusEncodeObject.html
diff --git a/docs/functions/modules_node.setupNodeExtension.html b/docs/functions/modules_node.setupNodeExtension.html
diff --git a/docs/functions/modules_plan.isMsgCreateEncodeObject.html b/docs/functions/modules_plan.isMsgCreateEncodeObject.html
diff --git a/docs/functions/modules_plan.isMsgLinkNodeEncodeObject.html b/docs/functions/modules_plan.isMsgLinkNodeEncodeObject.html
diff --git a/docs/functions/modules_plan.isMsgSubscribeEncodeObject.html b/docs/functions/modules_plan.isMsgSubscribeEncodeObject.html
diff --git a/docs/functions/modules_plan.isMsgUnlinkNodeEncodeObject.html b/docs/functions/modules_plan.isMsgUnlinkNodeEncodeObject.html
diff --git a/docs/functions/modules_plan.isMsgUpdateStatusEncodeObject.html b/docs/functions/modules_plan.isMsgUpdateStatusEncodeObject.html
diff --git a/docs/functions/modules_plan.setupPlanExtension.html b/docs/functions/modules_plan.setupPlanExtension.html
diff --git a/docs/functions/modules_provider.isMsgRegisterEncodeObject.html b/docs/functions/modules_provider.isMsgRegisterEncodeObject.html
diff --git a/docs/functions/modules_provider.isMsgUpdateEncodeObject.html b/docs/functions/modules_provider.isMsgUpdateEncodeObject.html
diff --git a/docs/functions/modules_provider.setupProviderExtension.html b/docs/functions/modules_provider.setupProviderExtension.html
diff --git a/docs/functions/modules_queries.buildSentinelQueryClient.html b/docs/functions/modules_queries.buildSentinelQueryClient.html
diff --git a/docs/functions/modules_session.isMsgEndEncodeObject.html b/docs/functions/modules_session.isMsgEndEncodeObject.html
diff --git a/docs/functions/modules_session.isMsgStartEncodeObject.html b/docs/functions/modules_session.isMsgStartEncodeObject.html
diff --git a/docs/functions/modules_session.isMsgUpdateDetailsEncodeObject.html b/docs/functions/modules_session.isMsgUpdateDetailsEncodeObject.html
diff --git a/docs/functions/modules_session.setupSessionExtension.html b/docs/functions/modules_session.setupSessionExtension.html
diff --git a/docs/functions/modules_subscription.isMsgAllocateEncodeObject.html b/docs/functions/modules_subscription.isMsgAllocateEncodeObject.html
diff --git a/docs/functions/modules_subscription.isMsgCancelEncodeObject.html b/docs/functions/modules_subscription.isMsgCancelEncodeObject.html
diff --git a/docs/functions/modules_subscription.setupSubscriptionExtension.html b/docs/functions/modules_subscription.setupSubscriptionExtension.html
diff --git a/docs/index.html b/docs/index.html
@@ -1,4 +1,8 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@sentinel-official/sentinel-js-sdk</title><meta name="description" content="Documentation for @sentinel-official/sentinel-js-sdk"/><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/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><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"><use href="#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">@sentinel-official/sentinel-js-sdk</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"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@sentinel-official/sentinel-js-sdk</h2></div><div class="tsd-panel tsd-typography"><a id="md:sentinel-js-sdk" class="tsd-anchor"></a><h1><a href="#md:sentinel-js-sdk">sentinel-js-sdk</a></h1><p>The Sentinel JS SDK relays on <a href="https://github.com/cosmos/cosmjs">CosmJS</a> and it was developed following the official <a href="https://tutorials.cosmos.network/tutorials/7-cosmjs/">tutorial</a>, it take also inspiration from other open source Cosmos SDK.</p>
+<p><img src="https://img.shields.io/npm/v/%40sentinel-official%2Fsentinel-js-sdk" alt="NPM Version">
+<img src="https://img.shields.io/npm/dm/%40sentinel-official%2Fsentinel-js-sdk" alt="NPM Downloads">
+<img src="https://img.shields.io/github/stars/sentinel-official/sentinel-js-sdk" alt="GitHub Repo stars">
+<img src="https://img.shields.io/github/forks/sentinel-official/sentinel-js-sdk" alt="GitHub forks"></p>
 <p>The SDK exstends the followings:</p>
 <ul>
 <li><a href="https://cosmos.github.io/cosmjs/latest/stargate/classes/StargateClient.html">@cosmjs/stargate/StargateClient</a> as <code>SentinelClient</code></li>
@@ -12,6 +16,9 @@
 <pre><code class="language-javascript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">SigningSentinelClient</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@sentinel-official/sentinel-js-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">DirectSecp256k1HdWallet</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@cosmjs/proto-signing&quot;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">GasPrice</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@cosmjs/stargate&quot;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">wallet</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">DirectSecp256k1HdWallet</span><span class="hl-1">.</span><span class="hl-6">fromMnemonic</span><span class="hl-1">(</span><span class="hl-2">mnemonic</span><span class="hl-1">, { </span><span class="hl-2">prefix:</span><span class="hl-1"> </span><span class="hl-3">&quot;sent&quot;</span><span class="hl-1"> });</span><br/><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-5">account</span><span class="hl-1">] = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">wallet</span><span class="hl-1">.</span><span class="hl-6">getAccounts</span><span class="hl-1">();</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">rpc</span><span class="hl-1"> = </span><span class="hl-3">&quot;https://rpc.sentinel.co:443&quot;</span><br/><br/><span class="hl-7">// With a default GasPrice:</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">customDenom</span><span class="hl-1"> = </span><span class="hl-3">&quot;udvpn&quot;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">gasPrice</span><span class="hl-1"> = </span><span class="hl-2">GasPrice</span><span class="hl-1">.</span><span class="hl-6">fromString</span><span class="hl-1">(</span><span class="hl-3">`0.2</span><span class="hl-4">${</span><span class="hl-2">customDenom</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">SigningSentinelClient</span><span class="hl-1">.</span><span class="hl-6">connectWithSigner</span><span class="hl-1">(</span><span class="hl-2">rpc</span><span class="hl-1">, </span><span class="hl-2">wallet</span><span class="hl-1">, {</span><br/><span class="hl-1">    </span><span class="hl-2">gasPrice:</span><span class="hl-1"> </span><span class="hl-2">gasPrice</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-7">// Without a default GasPrice:</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">SigningSentinelClient</span><span class="hl-1">.</span><span class="hl-6">connectWithSigner</span><span class="hl-1">(</span><span class="hl-2">rpc</span><span class="hl-1">, </span><span class="hl-2">wallet</span><span class="hl-1">)</span>
 </code><button>Copy</button></pre>
 <p>You can also set other default parameters: <a href="https://cosmos.github.io/cosmjs/latest/stargate/interfaces/SigningStargateClientOptions.html">https://cosmos.github.io/cosmjs/latest/stargate/interfaces/SigningStargateClientOptions.html</a>.</p>
+<p>In order to subscribe to chain events you need a websocket client</p>
+<pre><code class="language-javascript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">SentinelWsClient</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@sentinel-official/sentinel-js-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">SentinelWsClient</span><span class="hl-1">(</span><span class="hl-3">&quot;wss://rpc.sentinel.quokkastake.io&quot;</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">stream</span><span class="hl-1"> = </span><span class="hl-2">client</span><span class="hl-1">.</span><span class="hl-6">subscribe</span><span class="hl-1">(</span><span class="hl-3">&quot;tm.event=&#39;NewBlock&#39;&quot;</span><span class="hl-1">)</span><br/><span class="hl-2">stream</span><span class="hl-1">.</span><span class="hl-6">addListener</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-6">next</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-2">data</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">),</span><br/><span class="hl-1">    </span><span class="hl-6">error</span><span class="hl-2">:</span><span class="hl-1"> </span><span class="hl-2">err</span><span class="hl-1"> </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">error</span><span class="hl-1">(</span><span class="hl-2">err</span><span class="hl-1">),</span><br/><span class="hl-1">    </span><span class="hl-6">complete</span><span class="hl-2">:</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-3">&#39;completed&#39;</span><span class="hl-1">),</span><br/><span class="hl-1">});</span>
+</code><button>Copy</button></pre>
 <a id="md:query" class="tsd-anchor"></a><h2><a href="#md:query">query</a></h2><pre><code class="language-javascript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Status</span><span class="hl-1">, </span><span class="hl-2">PageRequest</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@sentinel-official/sentinel-js-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">nodes</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1">.</span><span class="hl-2">sentinelQuery</span><span class="hl-1">?.</span><span class="hl-2">node</span><span class="hl-1">.</span><span class="hl-6">nodes</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-2">Status</span><span class="hl-1">.</span><span class="hl-5">STATUS_ACTIVE</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">PageRequest</span><span class="hl-1">.</span><span class="hl-6">fromPartial</span><span class="hl-1">({</span><br/><span class="hl-1">        </span><span class="hl-2">limit:</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1">,</span><br/><span class="hl-1">        </span><span class="hl-2">countTotal:</span><span class="hl-1"> </span><span class="hl-4">true</span><br/><span class="hl-1">    })</span><br/><span class="hl-1">)</span>
 </code><button>Copy</button></pre>
 <p>For pagination please follow:</p>