@codex-data/sdk 0.5.7

package/src/sdk/graphql/OnDetailedStatsUpdated.graphql

@@ -0,0 +1,324 @@
+subscription OnDetailedStatsUpdated($pairId: String, $tokenOfInterest: TokenOfInterest, $statsType: TokenPairStatisticsType) {
+  onDetailedStatsUpdated(pairId: $pairId, tokenOfInterest: $tokenOfInterest, statsType: $statsType) {
+    pairId
+    tokenOfInterest
+    statsType
+    stats_min5 {
+      windowSize
+      timestamp
+      endTimestamp
+      transactions {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      volume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buys {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sells {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      traders {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buckets {
+        start
+        end
+      }
+      
+    }
+    stats_hour1 {
+      windowSize
+      timestamp
+      endTimestamp
+      buckets {
+        start
+        end
+      }
+      transactions {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      volume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buys {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sells {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      traders {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+    }
+    stats_hour4 {
+      windowSize
+      timestamp
+      endTimestamp
+      buckets {
+        start
+        end
+      }
+      transactions {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      volume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buys {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sells {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      traders {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      
+    }
+    stats_hour12 {
+      windowSize
+      timestamp
+      endTimestamp
+      buckets {
+        start
+        end
+      }
+      transactions {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      volume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buys {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sells {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      traders {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+    }
+    stats_day1 {
+      windowSize
+      timestamp
+      endTimestamp
+      buckets {
+        start
+        end
+      }
+      transactions {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      volume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buys {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sells {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellers {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      traders {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      buyVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+      sellVolume {
+        change
+        currentValue
+        previousValue
+        buckets
+      }
+    }
+  }
+}

package/src/sdk/graphql/OnEventsCreated.graphql

@@ -0,0 +1,62 @@
+subscription OnEventsCreated($id: String) {
+  onEventsCreated(id: $id) {
+    events {
+      address
+      baseTokenPrice
+      blockHash
+      blockNumber
+      eventDisplayType
+      eventType
+      logIndex
+      id
+      liquidityToken
+      maker
+      networkId
+      timestamp
+      token0SwapValueUsd
+      token0ValueBase
+      token1SwapValueUsd
+      token1ValueBase
+      transactionHash
+      transactionIndex
+      data {
+        ... on MintEventData {
+          amount0
+          amount1
+          amount0Shifted
+          amount1Shifted
+          tickLower
+          tickUpper
+          type
+        }
+        ... on BurnEventData {
+          amount0
+          amount1
+          amount0Shifted
+          amount1Shifted
+          tickLower
+          tickUpper
+          type
+        }
+        ... on SwapEventData {
+          amount0
+          amount0In
+          amount0Out
+          amount1
+          amount1In
+          amount1Out
+          amountNonLiquidityToken
+          priceBaseToken
+          priceBaseTokenTotal
+          priceUsd
+          priceUsdTotal
+          tick
+          type
+        }
+      }
+    }
+    address
+    id
+    networkId
+  }
+}

package/src/sdk/graphql/OnNftAssetsCreated.graphql

@@ -0,0 +1,29 @@
+
+subscription OnNftAssetsCreated($address: String, $networkId: Int, $tokenId: String) {
+  onNftAssetsCreated(address: $address, networkId: $networkId, tokenId: $tokenId) {
+    id
+    address
+    tokenId
+    networkId
+    media {
+      image
+      thumbSm
+      thumbLg
+      processed
+    }
+    name
+    description
+    originalImage
+    uri
+    attributes {
+      class
+      css
+      displayType
+      maxValue
+      name
+      value
+      valueType
+    }
+    quantity
+  }
+}

package/src/sdk/graphql/OnNftEventsCreated.graphql

@@ -0,0 +1,83 @@
+subscription OnNftEventsCreated($address: String, $networkId: Int) {
+  onNftEventsCreated(address: $address, networkId: $networkId) {
+    address
+    networkId
+    id
+    events {
+      id
+      contractAddress
+      networkId
+      tokenId
+      maker
+      taker
+      totalTradePrice
+      individualTradePrice
+      paymentTokenAddress
+      totalPriceUsd
+      individualPriceUsd
+      totalPriceNetworkBaseToken
+      individualPriceNetworkBaseToken
+      eventType
+      exchangeAddress
+      sortKey
+      blockNumber
+      transactionIndex
+      logIndex
+      transactionHash
+      timestamp
+      numberOfTokens
+      aggregatorAddress
+      poolAddress
+      fillSource
+      priceError
+      tradeOffer {
+        ... on NftEventNftTradeItem {
+          address
+          amount
+          recipient
+          type
+          tokenId
+        }
+        ... on NftEventTokenTradeItem {
+          address
+          amount
+          recipient
+          type
+          isPrice
+          totalTradePrice
+          individualTradePrice
+          totalPriceUsd
+          individualPriceUsd
+          totalPriceNetworkBaseToken
+          individualPriceNetworkBaseToken
+          priceError
+        }
+      }
+      tradeReceived {
+        ... on NftEventNftTradeItem {
+          address
+          amount
+          recipient
+          type
+          tokenId
+          
+        }
+        ... on NftEventTokenTradeItem {
+          address
+          amount
+          recipient
+          type
+          isPrice
+          totalTradePrice
+          individualTradePrice
+          totalPriceUsd
+          individualPriceUsd
+          totalPriceNetworkBaseToken
+          individualPriceNetworkBaseToken
+          priceError
+        }
+      }
+      orderDirection
+    }
+  }
+}

package/src/sdk/graphql/OnPairMetadataUpdated.graphql

@@ -0,0 +1,55 @@
+subscription OnPairMetadataUpdated($id: String, $quoteToken: QuoteToken) {
+  onPairMetadataUpdated(id: $id, quoteToken: $quoteToken) {
+    exchangeId
+    fee
+    highPrice1
+    highPrice1w
+    highPrice4
+    highPrice12
+    highPrice24
+    id
+    liquidity
+    liquidityToken
+    lowPrice1
+    lowPrice1w
+    lowPrice4
+    lowPrice12
+    lowPrice24
+    networkId
+    nonLiquidityToken
+    pairAddress
+    price
+    priceChange1
+    priceChange1w
+    priceChange4
+    priceChange5m
+    priceChange12
+    priceChange24
+    quoteToken
+    statsType
+    tickSpacing
+    token0 {
+      address
+      decimals
+      name
+      networkId
+      pooled
+      price
+      symbol
+    }
+    token1 {
+      address
+      decimals
+      name
+      networkId
+      pooled
+      price
+      symbol
+    }
+    volume1
+    volume1w
+    volume4
+    volume12
+    volume24
+  }
+}

package/src/sdk/graphql/OnPriceUpdated.graphql

@@ -0,0 +1,9 @@
+subscription OnPriceUpdated($address: String, $networkId: Int) {
+  onPriceUpdated(address: $address, networkId: $networkId) {
+    address
+    confidence
+    networkId
+    priceUsd
+    timestamp
+  }
+}

package/src/sdk/index.test.ts

@@ -0,0 +1,78 @@
+import { DocumentNode } from "graphql";
+
+import { Codex } from "./index";
+
+const getNetworksDocument = {
+  kind: "Document",
+  definitions: [
+    {
+      kind: "OperationDefinition",
+      operation: "query",
+      name: { kind: "Name", value: "Networks" },
+      selectionSet: {
+        kind: "SelectionSet",
+        selections: [
+          {
+            kind: "Field",
+            name: { kind: "Name", value: "getNetworks" },
+            selectionSet: {
+              kind: "SelectionSet",
+              selections: [
+                { kind: "Field", name: { kind: "Name", value: "id" } },
+                { kind: "Field", name: { kind: "Name", value: "name" } },
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode;
+
+const getNetworksString = `query GetNetworks { getNetworks { id } }`;
+const subscribePriceUpdatedString = `subscription onPriceUpdated($address: String!, $networkId: Int!) { onPriceUpdated(address: $address, networkId: $networkId) { address networkId priceUsd timestamp } }`;
+
+describe("Codex", () => {
+  let sdk: Codex;
+  beforeEach(() => {
+    sdk = new Codex("dummy-key");
+  });
+
+  describe("query", () => {
+    it("send a fetch request with the correct params", async () => {
+      const fetchSpy = jest
+        .spyOn(sdk["client"], "request")
+        .mockResolvedValue({} as unknown);
+      await sdk.query(getNetworksDocument, {});
+      expect(fetchSpy).toHaveBeenCalledWith(getNetworksDocument, {});
+    });
+  });
+  describe("send", () => {
+    it("should return the results of the query", async () => {
+      const fetchSpy = jest
+        .spyOn(sdk["client"], "request")
+        .mockResolvedValue({} as unknown);
+      await sdk.send(getNetworksString, {});
+      expect(fetchSpy).toHaveBeenCalledWith(getNetworksString, {});
+    });
+  });
+  describe("subscribe", () => {
+    it("should return a cleanup function", () => {
+      const next = jest.fn(),
+        error = jest.fn(),
+        complete = jest.fn();
+      const sink = {
+        next,
+        error,
+        complete,
+      };
+      jest.spyOn(sdk["wsClient"], "subscribe").mockReturnValue(() => {});
+      const cleanup = sdk.subscribe(
+        subscribePriceUpdatedString,
+        { address: "0xtoken", networkId: 1 },
+        sink,
+      );
+      expect(typeof cleanup).toBe("function");
+    });
+  });
+});