@nadohq/client 0.34.0 → 0.36.0

package/src/context.ts

@@ -33,10 +33,12 @@ export interface NadoClientContext {
   indexerClient: IndexerClient;
   triggerClient: TriggerClient;
   mobileClient: MobileClient;
+  // If provided, identifies the calling client, sent as a header with every request made by the service clients above
+  clientType?: string;
 }
 
 /**
- * Args for creating a context
+ * Args for creating a context with custom endpoints
  */
 interface NadoClientContextOpts {
   contractAddresses: NadoDeploymentAddresses;
@@ -44,6 +46,15 @@ interface NadoClientContextOpts {
   indexerEndpoint: string;
   triggerEndpoint: string;
   mobileEndpoint: string;
+  clientType?: string;
+}
+
+/**
+ * Args for creating a context with the default endpoints of a chain env
+ */
+interface NadoClientContextChainEnvOpts {
+  chainEnv: ChainEnv;
+  clientType?: string;
 }
 
 /**
@@ -54,7 +65,12 @@ export type CreateNadoClientContextAccountOpts = Pick<
   'walletClient' | 'linkedSignerWalletClient' | 'publicClient'
 >;
 
-export type CreateNadoClientContextOpts = NadoClientContextOpts | ChainEnv;
+/**
+ * Args for creating a context, either fully custom endpoints or a chain env with default endpoints.
+ */
+export type CreateNadoClientContextOpts =
+  | NadoClientContextOpts
+  | NadoClientContextChainEnvOpts;
 
 /**
  * Utility function to create client context from options
@@ -72,19 +88,21 @@ export function createClientContext(
     indexerEndpoint,
     triggerEndpoint,
     mobileEndpoint,
+    clientType,
   } = ((): NadoClientContextOpts => {
-    // Custom options
-    if (typeof opts === 'object') {
+    // Custom endpoint options
+    if (!('chainEnv' in opts)) {
       return opts;
     }
 
-    const chainEnv = opts;
+    const { chainEnv, clientType } = opts;
     return {
       contractAddresses: NADO_DEPLOYMENTS[chainEnv],
       engineEndpoint: ENGINE_CLIENT_ENDPOINTS[chainEnv],
       indexerEndpoint: INDEXER_CLIENT_ENDPOINTS[chainEnv],
       triggerEndpoint: TRIGGER_CLIENT_ENDPOINTS[chainEnv],
       mobileEndpoint: MOBILE_CLIENT_ENDPOINTS[chainEnv],
+      clientType,
     };
   })();
   const { publicClient, walletClient, linkedSignerWalletClient } = accountOpts;
@@ -132,25 +150,30 @@ export function createClientContext(
       }),
     },
     contractAddresses,
+    clientType,
     engineClient: new EngineClient({
       url: engineEndpoint,
       walletClient,
       linkedSignerWalletClient,
+      clientType,
     }),
     indexerClient: new IndexerClient({
       url: indexerEndpoint,
       walletClient,
       linkedSignerWalletClient,
+      clientType,
     }),
     triggerClient: new TriggerClient({
       url: triggerEndpoint,
       walletClient,
       linkedSignerWalletClient,
+      clientType,
     }),
     mobileClient: new MobileClient({
       url: mobileEndpoint,
       walletClient,
       linkedSignerWalletClient,
+      clientType,
     }),
   };
 }

package/src/createNadoClient.ts

@@ -9,8 +9,14 @@ import {
  * Creates a Nado client from given options.
  * {@label CLIENT}
  *
- * @param opts
+ * @param opts - A chain env or custom endpoints.
  * @param accountOpts
+ *
+ * @example
+ * const nadoClient = createNadoClient(
+ *   { chainEnv: 'inkMainnet' },
+ *   { publicClient, walletClient },
+ * );
  */
 export function createNadoClient(
   opts: CreateNadoClientContextOpts,

package/dist/PerpExecuteAPI-DcAur1dM.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PerpExecuteAPI-DcAur1dM.d.ts","names":[],"sources":["../src/apis/perp/src/apis/perp/PerpExecuteAPI.ts"],"mappings":";;;cAEa,cAAA,SAAuB,WAAW"}

package/dist/PerpExecuteAPI-bgOnDMQR.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PerpExecuteAPI-bgOnDMQR.d.cts","names":[],"sources":["../src/apis/perp/src/apis/perp/PerpExecuteAPI.ts"],"mappings":";;;cAEa,cAAA,SAAuB,WAAW"}

package/dist/context-CHBPiOx6.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context-CHBPiOx6.d.cts","names":[],"sources":["../src/src/context.ts"],"mappings":";;;;;;;;;;AAwBA;UAAiB,iBAAA;EACf,YAAA,EAAc,YAAA;EACd,YAAA,GAAe,uBAAA;EAEf,wBAAA,GAA2B,uBAAA;EAC3B,SAAA,EAAW,aAAA;EACX,iBAAA,EAAmB,uBAAA;EACnB,YAAA,EAAc,YAAA;EACd,aAAA,EAAe,aAAA;EACf,aAAA,EAAe,aAAA;EACf,YAAA,EAAc,YAAA;AAAA;;;;UAMN,qBAAA;EACR,iBAAA,EAAmB,uBAAuB;EAC1C,cAAA;EACA,eAAA;EACA,eAAA;EACA,cAAA;AAAA;;;;KAMU,kCAAA,GAAqC,IAAI,CACnD,iBAAA;AAAA,KAIU,2BAAA,GAA8B,qBAAA,GAAwB,QAAQ;;;;;;;iBAQ1D,mBAAA,CACd,IAAA,EAAM,2BAAA,EACN,WAAA,EAAa,kCAAA,GACZ,iBAAA"}

package/dist/context-D1xmE2Rd.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"context-D1xmE2Rd.d.ts","names":[],"sources":["../src/src/context.ts"],"mappings":";;;;;;;;;;AAwBA;UAAiB,iBAAA;EACf,YAAA,EAAc,YAAA;EACd,YAAA,GAAe,uBAAA;EAEf,wBAAA,GAA2B,uBAAA;EAC3B,SAAA,EAAW,aAAA;EACX,iBAAA,EAAmB,uBAAA;EACnB,YAAA,EAAc,YAAA;EACd,aAAA,EAAe,aAAA;EACf,aAAA,EAAe,aAAA;EACf,YAAA,EAAc,YAAA;AAAA;;;;UAMN,qBAAA;EACR,iBAAA,EAAmB,uBAAuB;EAC1C,cAAA;EACA,eAAA;EACA,eAAA;EACA,cAAA;AAAA;;;;KAMU,kCAAA,GAAqC,IAAI,CACnD,iBAAA;AAAA,KAIU,2BAAA,GAA8B,qBAAA,GAAwB,QAAQ;;;;;;;iBAQ1D,mBAAA,CACd,IAAA,EAAM,2BAAA,EACN,WAAA,EAAa,kCAAA,GACZ,iBAAA"}

package/dist/index-Bx-PsDsb.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-Bx-PsDsb.d.cts","names":[],"sources":["../src/apis/perp/src/apis/perp/index.ts"],"mappings":";;;;cAE8C,YAAA;cAEjC,OAAA,SAAgB,YAAmC"}

package/dist/index-C-qKYLCR.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-C-qKYLCR.d.ts","names":[],"sources":["../src/apis/spot/src/apis/spot/index.ts"],"mappings":";;;;cAE8C,YAAA;;;AAAA;cAKjC,OAAA,SAAgB,YAAmC"}

package/dist/index-Cn7kpBkt.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-Cn7kpBkt.d.cts","names":[],"sources":["../src/apis/spot/src/apis/spot/index.ts"],"mappings":";;;;cAE8C,YAAA;;;AAAA;cAKjC,OAAA,SAAgB,YAAmC"}

package/dist/index-D2pKqx7b.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-D2pKqx7b.d.cts","names":[],"sources":["../src/apis/market/src/apis/market/index.ts"],"mappings":";;;;cAIwB,cAAA;cAEX,SAAA,SAAkB,cAAuC"}

package/dist/index-DE9RaTAD.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-DE9RaTAD.d.cts","names":[],"sources":["../src/apis/rewards/src/apis/rewards/index.ts"],"mappings":";;;;cAEoD,eAAA;;;AAAA;;cAMvC,UAAA,SAAmB,eAAyC"}

package/dist/index-DIlwbefm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-DIlwbefm.d.ts","names":[],"sources":["../src/apis/perp/src/apis/perp/index.ts"],"mappings":";;;;cAE8C,YAAA;cAEjC,OAAA,SAAgB,YAAmC"}

package/dist/index-Dq_AuvDb.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-Dq_AuvDb.d.ts","names":[],"sources":["../src/apis/rewards/src/apis/rewards/index.ts"],"mappings":";;;;cAEoD,eAAA;;;AAAA;;cAMvC,UAAA,SAAmB,eAAyC"}

package/dist/index-IIzvROYs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-IIzvROYs.d.ts","names":[],"sources":["../src/apis/market/src/apis/market/index.ts"],"mappings":";;;;cAIwB,cAAA;cAEX,SAAA,SAAkB,cAAuC"}