@codex-data/sdk 1.0.6 → 1.0.8

package/src/sdk/index.test.ts

@@ -44,7 +44,7 @@ describe("Codex", () => {
         .spyOn(sdk["client"], "request")
         .mockResolvedValue({} as unknown);
       await sdk.query(getNetworksDocument, {});
-      expect(fetchSpy).toHaveBeenCalledWith(getNetworksDocument, {});
+      expect(fetchSpy).toHaveBeenCalledWith(getNetworksDocument, {}, {});
     });
   });
   describe("send", () => {
@@ -53,7 +53,7 @@ describe("Codex", () => {
         .spyOn(sdk["client"], "request")
         .mockResolvedValue({} as unknown);
       await sdk.send(getNetworksString, {});
-      expect(fetchSpy).toHaveBeenCalledWith(getNetworksString, {});
+      expect(fetchSpy).toHaveBeenCalledWith(getNetworksString, {}, {});
     });
   });
   describe("subscribe", () => {
@@ -66,7 +66,7 @@ describe("Codex", () => {
         error,
         complete,
       };
-      jest.spyOn(sdk["wsClient"], "subscribe").mockReturnValue(() => {});
+      jest.spyOn(sdk["wsClient"] as any, "subscribe").mockReturnValue(() => {});
       const cleanup = sdk.subscribe(
         subscribePriceUpdatedString,
         { address: "0xtoken", networkId: 1 },

package/src/sdk/index.ts

@@ -1,6 +1,5 @@
 import { TypedDocumentNode } from "@graphql-typed-document-node/core";
 import { GraphQLClient, Variables } from "graphql-request";
-import { VariablesAndRequestHeadersArgs } from "graphql-request/build/esm/types";
 import {
   Client as GraphQLWsClient,
   createClient,
@@ -16,47 +15,90 @@ import { Subscribe } from "./Subscribe";
 
 export type CleanupFunction = () => void;
 
+export type ApiConfig = {
+  // https://graph.codex.io/graphql
+  apiUrl: string;
+
+  // wss://graph.codex.io/graphql
+  apiRealtimeUrl: string;
+
+  // true if you want to connect a websocket, sometimes useful to turn this off in certain environments
+  ws?: boolean;
+
+  // Add static headers to the http requests
+  headers?: Record<string, string>;
+
+  // Add static headers to the ws requests
+  wsHeaders?: Record<string, string>;
+
+  // Use this to apply dynamic headers to the requests
+  applyHeaders?: () => Promise<Record<string, string>>;
+};
+
+const defaultConfig: ApiConfig = {
+  apiUrl: `https://graph.codex.io/graphql`,
+  apiRealtimeUrl: `wss://graph.codex.io/graphql`,
+  ws: true,
+};
+
 export class Codex {
   private client: GraphQLClient;
-  private wsClient: GraphQLWsClient;
+  private wsClient: GraphQLWsClient | undefined;
   public queries: Query;
   public mutations: Mutation;
   public subscriptions: Subscribe;
 
   constructor(
     private apiKey: string,
-    private apiUrl: string = `https://graph.codex.io/graphql`,
-    private apiRealtimeUrl: string = `wss://graph.codex.io/graphql`,
+    private apiConfig?: Partial<ApiConfig>,
   ) {
     invariant(this.apiKey, "apiKey must be defined");
+    const config = Object.assign({}, defaultConfig, apiConfig);
+
     this.queries = new Query(this);
     this.mutations = new Mutation(this);
     this.subscriptions = new Subscribe(this);
-    this.client = new GraphQLClient(this.apiUrl, {
+    this.client = new GraphQLClient(config.apiUrl, {
       method: "POST",
       headers: new Headers({
         "Content-Type": "application/json",
         Authorization: this.apiKey,
         "X-Apollo-Operation-Name": "query",
+        ...config.headers,
       }),
     });
-    this.wsClient = createClient({
-      webSocketImpl: WebSocket,
-      keepAlive: 10_000, // ping server every 10 seconds
-      url: this.apiRealtimeUrl,
-      connectionParams: {
-        Authorization: this.apiKey,
-      },
-    });
+    this.wsClient = config.ws
+      ? createClient({
+          webSocketImpl: WebSocket,
+          keepAlive: 10_000, // ping server every 10 seconds
+          url: config.apiRealtimeUrl,
+          connectionParams: {
+            Authorization: this.apiKey,
+            ...config.wsHeaders,
+          },
+        })
+      : undefined;
+  }
+
+  private async getRequestHeaders() {
+    // Get any dynamic headers
+    const dynamicHeaders = await this.apiConfig?.applyHeaders?.();
+    const staticHeaders = this.apiConfig?.headers;
+    const headers = {
+      ...staticHeaders,
+      ...dynamicHeaders,
+    };
+    return headers;
   }
 
   public async query<TResults, TVars extends Variables>(
     doc: TypedDocumentNode<TResults, TVars>,
     args: TVars = {} as TVars,
   ) {
-    const res = await this.client.request<typeof doc, TVars>(
+    const res = await this.client.request<typeof doc>(
       doc,
-      ...([args] as unknown as VariablesAndRequestHeadersArgs<TVars>),
+      args,
+      await this.getRequestHeaders(),
     );
     return res as TResults;
   }
@@ -65,9 +107,10 @@ export class Codex {
     doc: TypedDocumentNode<TResults, TVars>,
     args: TVars = {} as TVars,
   ) {
-    const res = await this.client.request<typeof doc, TVars>(
+    const res = await this.client.request<typeof doc>(
       doc,
-      ...([args] as unknown as VariablesAndRequestHeadersArgs<TVars>),
+      args,
+      await this.getRequestHeaders(),
     );
     return res as TResults;
   }
@@ -77,7 +120,11 @@ export class Codex {
     gqlString: string,
     args: V = {} as V,
   ) {
-    const res = await this.client.request<TResults>(gqlString, args);
+    const res = await this.client.request<TResults>(
+      gqlString,
+      args,
+      await this.getRequestHeaders(),
+    );
     return res;
   }
 
@@ -89,6 +136,10 @@ export class Codex {
     args: TVars,
     sink: Sink<ExecutionResult<TResults>>,
   ): CleanupFunction {
+    if (!this.wsClient) {
+      throw new Error("Websocket is not enabled in the config");
+    }
+
     const cleanup = this.wsClient.subscribe<TResults>(
       {
         query: doc,

package/dist/resources/generated_mutations/CreateApiTokens.graphql

@@ -1,9 +0,0 @@
-mutation CreateApiTokens($input: CreateApiTokensInput!) {
-  createApiTokens(input: $input) {
-    expiresTimeString
-    id
-    remaining
-    requestLimit
-    token
-  }
-}

package/dist/resources/generated_mutations/CreateWebhooks.graphql

@@ -1,472 +0,0 @@
-mutation CreateWebhooks($input: CreateWebhooksInput!) {
-  createWebhooks(input: $input) {
-    nftEventWebhooks {
-      alertRecurrence
-      bucketId
-      bucketSortkey
-      callbackUrl
-      conditions {
-        ... on NftEventWebhookCondition {
-          contractAddress {
-            eq
-          }
-          eventType {
-            eq
-          }
-          exchangeAddress {
-            eq
-          }
-          fillSource {
-            oneOf
-          }
-          ignoreTransfers
-          individualBaseTokenPrice {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          nftTokenAddress: tokenAddress {
-            eq
-          }
-          tokenId {
-            eq
-          }
-        }
-        ... on PriceEventWebhookCondition {
-          priceNetworkId: networkId {
-            eq
-          }
-          priceUsd {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          priceTokenAddress: tokenAddress {
-            eq
-          }
-        }
-        ... on RawTransactionWebhookCondition {
-          from {
-            eq
-          }
-          ignoreNftEvents
-          ignoreTokenPairEvents
-          input {
-            contains
-            notContains
-          }
-          networkId {
-            oneOf
-          }
-          to {
-            eq
-          }
-          toOrFrom {
-            eq
-          }
-        }
-        ... on TokenPairEventWebhookCondition {
-          eventType {
-            oneOf
-          }
-          exchangeAddress {
-            eq
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          pairAddress {
-            eq
-          }
-          swapValue {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          tokenAddress {
-            eq
-          }
-        }
-      }
-      created
-      groupId
-      id
-      name
-      publishingType
-      retrySettings {
-        maxRetries
-        maxRetryDelay
-        maxTimeElapsed
-        minRetryDelay
-      }
-      status
-      webhookType
-    }
-    priceWebhooks {
-      alertRecurrence
-      bucketId
-      bucketSortkey
-      callbackUrl
-      conditions {
-        ... on NftEventWebhookCondition {
-          contractAddress {
-            eq
-          }
-          eventType {
-            eq
-          }
-          exchangeAddress {
-            eq
-          }
-          fillSource {
-            oneOf
-          }
-          ignoreTransfers
-          individualBaseTokenPrice {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          nftTokenAddress: tokenAddress {
-            eq
-          }
-          tokenId {
-            eq
-          }
-        }
-        ... on PriceEventWebhookCondition {
-          priceNetworkId: networkId {
-            eq
-          }
-          priceUsd {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          priceTokenAddress: tokenAddress {
-            eq
-          }
-        }
-        ... on RawTransactionWebhookCondition {
-          from {
-            eq
-          }
-          ignoreNftEvents
-          ignoreTokenPairEvents
-          input {
-            contains
-            notContains
-          }
-          networkId {
-            oneOf
-          }
-          to {
-            eq
-          }
-          toOrFrom {
-            eq
-          }
-        }
-        ... on TokenPairEventWebhookCondition {
-          eventType {
-            oneOf
-          }
-          exchangeAddress {
-            eq
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          pairAddress {
-            eq
-          }
-          swapValue {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          tokenAddress {
-            eq
-          }
-        }
-      }
-      created
-      groupId
-      id
-      name
-      publishingType
-      retrySettings {
-        maxRetries
-        maxRetryDelay
-        maxTimeElapsed
-        minRetryDelay
-      }
-      status
-      webhookType
-    }
-    rawTransactionWebhooks {
-      alertRecurrence
-      bucketId
-      bucketSortkey
-      callbackUrl
-      conditions {
-        ... on NftEventWebhookCondition {
-          contractAddress {
-            eq
-          }
-          eventType {
-            eq
-          }
-          exchangeAddress {
-            eq
-          }
-          fillSource {
-            oneOf
-          }
-          ignoreTransfers
-          individualBaseTokenPrice {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          tokenAddress {
-            eq
-          }
-          tokenId {
-            eq
-          }
-        }
-        ... on PriceEventWebhookCondition {
-          priceEventNetworkId: networkId {
-            eq
-          }
-          priceUsd {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          priceEventTokenAddress: tokenAddress {
-            eq
-          }
-        }
-        ... on RawTransactionWebhookCondition {
-          from {
-            eq
-          }
-          ignoreNftEvents
-          ignoreTokenPairEvents
-          input {
-            contains
-            notContains
-          }
-          networkId {
-            oneOf
-          }
-          to {
-            eq
-          }
-          toOrFrom {
-            eq
-          }
-        }
-        ... on TokenPairEventWebhookCondition {
-          eventType {
-            oneOf
-          }
-          exchangeAddress {
-            eq
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          pairAddress {
-            eq
-          }
-          swapValue {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          tokenAddress {
-            eq
-          }
-        }
-      }
-      created
-      groupId
-      id
-      name
-      publishingType
-      retrySettings {
-        maxRetries
-        maxRetryDelay
-        maxTimeElapsed
-        minRetryDelay
-      }
-      status
-      webhookType
-    }
-    tokenPairEventWebhooks {
-      alertRecurrence
-      bucketId
-      bucketSortkey
-      callbackUrl
-      conditions {
-        ... on NftEventWebhookCondition {
-          contractAddress {
-            eq
-          }
-          eventType {
-            eq
-          }
-          exchangeAddress {
-            eq
-          }
-          fillSource {
-            oneOf
-          }
-          ignoreTransfers
-          individualBaseTokenPrice {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          tokenAddress {
-            eq
-          }
-          tokenId {
-            eq
-          }
-        }
-        ... on PriceEventWebhookCondition {
-          priceEventNetworkId: networkId {
-            eq
-          }
-          priceUsd {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          priceEventTokenAddress: tokenAddress {
-            eq
-          }
-        }
-        ... on RawTransactionWebhookCondition {
-          from {
-            eq
-          }
-          ignoreNftEvents
-          ignoreTokenPairEvents
-          input {
-            contains
-            notContains
-          }
-          networkId {
-            oneOf
-          }
-          to {
-            eq
-          }
-          toOrFrom {
-            eq
-          }
-        }
-        ... on TokenPairEventWebhookCondition {
-          eventType {
-            oneOf
-          }
-          exchangeAddress {
-            eq
-          }
-          maker {
-            eq
-          }
-          networkId {
-            oneOf
-          }
-          pairAddress {
-            eq
-          }
-          swapValue {
-            eq
-            gt
-            gte
-            lt
-            lte
-          }
-          tokenAddress {
-            eq
-          }
-        }
-      }
-      created
-      groupId
-      id
-      name
-      publishingType
-      retrySettings {
-        maxRetries
-        maxRetryDelay
-        maxTimeElapsed
-        minRetryDelay
-      }
-      status
-      webhookType
-    }
-  }
-}

package/dist/resources/generated_mutations/DeleteApiToken.graphql

@@ -1,3 +0,0 @@
-mutation DeleteApiToken($id: String!) {
-  deleteApiToken(id: $id)
-}

package/dist/resources/generated_mutations/DeleteWebhooks.graphql

@@ -1,5 +0,0 @@
-mutation DeleteWebhooks($input: DeleteWebhooksInput!) {
-  deleteWebhooks(input: $input) {
-    deletedIds
-  }
-}

package/dist/resources/generated_queries/ApiToken.graphql

@@ -1,9 +0,0 @@
-query ApiToken($token: String!) {
-  apiToken(token: $token) {
-    expiresTimeString
-    id
-    remaining
-    requestLimit
-    token
-  }
-}

package/dist/resources/generated_queries/ApiTokens.graphql

@@ -1,9 +0,0 @@
-query ApiTokens {
-  apiTokens {
-    expiresTimeString
-    id
-    remaining
-    requestLimit
-    token
-  }
-}

package/dist/resources/generated_queries/Balances.graphql

@@ -1,15 +0,0 @@
-query Balances($input: BalancesInput!) {
-  balances(input: $input) {
-    cursor
-    items {
-      address
-      balance
-      firstHeldTimestamp
-      networkId
-      shiftedBalance
-      tokenAddress
-      tokenId
-      walletId
-    }
-  }
-}

package/dist/resources/generated_queries/ChartUrls.graphql

@@ -1,7 +0,0 @@
-query ChartUrls($input: ChartInput!) {
-  chartUrls(input: $input) {
-    pair {
-      url
-    }
-  }
-}