synthetix-subgraph v1.2.1

Synthetix Subgraph

The Graph exposes a GraphQL endpoint to query the events and entities within the Synthetix system.

Synthetix has three bundled subgraps, all generated from this one repository:

1. Minting, Burning and Transferring SNX & Synths: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix
2. Synth Exchange Volume and fees generated: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-exchanges
3. Historical rates on-chain for the various synths to USD: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-rates

Using this as a JS module

Supported queries

1. exchanges.since({ timestampInSecs = 1 day ago }) Get the last N exchanges since the given timestampInSecs (in seconds, so one hour ago is 3600). These are ordered in reverse chronological order.
2. exchanges.total() Get the total exchange volume, total fees and total number of unique exchange addresses.
3. depot.userActions({ user }) Get all depot deposit (sUSD) actions for the given user - deposit, withdrawl, unaccepted, removed.
4. depot.clearedDeposits({ fromAddress, toAddress }) Get all cleared synth deposits (payments of ETH for sUSD) either from a given fromAddress or (and as well as) to a given toAddress

How to query via the npm library (CLE)

# get last 24 hours of exchange activity, ordered from latest to earliest
npx synthetix-subgraph exchanges.since

Use as a node or webpack dependency

const snxData = require('synthetix-subgraph');

snxData.exchanges.since().then(exchanges => console.log(exchanges));

Use in a browser

<script src="//cdn.jsdelivr.net/npm/synthetix-subgraph/index.min.js"></script>
<script>
  window.snxData.exchanges.since().then(console.log);
</script>

Or query the subgraphs without any JS library

In it's simplest version (on a modern browser assuming async await support and fetch):

// Fetch all Exchanges in the last 24hrs s
(async () => {
  const ts = Math.floor(Date.now() / 1e3);
  const oneDayAgo = ts - 3600 * 24;
  const body = JSON.stringify({
    query: `{
      synthExchanges(
        orderBy:timestamp,
        orderDirection:desc,
        where:{timestamp_gt: ${oneDayAgo}}
      )
      {
        fromAmount
        fromAmountInUSD
        fromCurrencyKey
        toCurrencyKey
        block
        timestamp
        toAddress
        toAmount
        toAmountInUSD
        feesInUSD
      }
    }`,
    variables: null,
  });

  const response = await fetch('https://api.thegraph.com/subgraphs/name/synthetixio-team/synthetix-exchanges', {
    method: 'POST',
    body,
  });

  const json = await response.json();
  const { synthExchanges } = json.data;
  // ...
  console.log(synthExchanges);
})();

Note: due to The Graph limitation, only 100 results will be returned (the maximum allowed first amount). The way around this is to use paging (using the skip operator in GraphQL). See the function pageResults in index.js for an example.