@nftx/subgraph

@nftx/subgraph

This library contains a few helpers for querying and fetching from the subgraph

Our subgraph urls can be found at @nftx/constants

Usage

API

gql

(s: string) => string;

"Processes" a graphql string. Under the hood this function does nothing :D but most IDEs and editors like VSCode recognize and provide syntax highlighting when they see gql calls.

const query = gql`
  {
    vaults {
      id
      vaultId
    }
  }
`;

querySubgraph

<T>({
  url: string,
  query: string,
  variables?: object
}): Promise<T>

Sends a graphql request to the subgraph.

This uses the global fetch api under the hood so if you're running in a non-browser environment (or aupporting older browsers), you'll need to polyfill fetch

When writing queries for querySubgraph you can pass variables in by prefixing a name with $.

For example:

const query = gql`{
  vaults(
    first: ${LIMIT}
    where: {
      createdAt_gt: $timestamp
    }
  ) {
    id
  }
}`;

For this string, LIMIT is inserted immediately, like a regular string interpoaltion. However $timestamp will later be passed in as a variable into querySubgraph:

querySubgraph({
  url,
  query,
  variables: { timestamp },
});

Variables are all stringified so if you pass in a string, you don't need to wrap it in quotes:

const query = gql`
  {
    vault(id: $id) {
      id
    }
  }
`;
querySubgraph({ url, query, variables: { id: '0x' } });

This would send a request with this query:

{
  vault(id: "0x") {
    id
  }
}

buildWhere

(obj: object) => string;

This helper function lets you build a where clause string. Where a value is null, it filters it out.

const query = gql`{
  vault(where: ${buildWhere({
    id: idOrNull,
    vaultId: vaultIdOrNull,
  })}) {
    id
  }
}`;

Changelog

0.1.1 (2022-12-16)

Note: Version bump only for package nftxjs