@quicknode/sdk

QuickNode SDK

A SDK from QuickNode making it easy for developers to interact with QuickNode's services.

QuickNode's SDK is a JavaScript and TypeScript framework-agnostic library that supports both CommonJS and ES module systems.

Currently the SDK makes it even easier to use the QuickNode Graph API to query market insights, trading data, transactions by wallets and contracts, cached NFT images, and more!

:grey_question: We want to hear from you! Please take a few minutes to fill out our QuickNode SDK feedback form and let us know what you currently think about the SDK. This helps us further improve the SDK.

Getting Started

Installation

• Requires Node.js v16 or higher
• npm install @quicknode/sdk or yarn add @quicknode/sdk

Quickstart

import QuickNode from '@quicknode/sdk';

const qn = new QuickNode.API({ graphApiKey: 'my-api-key' });

qn.nfts
  .getByWallet({
    address: 'quicknode.eth',
    first: 5,
  })
  .then((response) => console.log(response));

Full example app implementation here

Documentation

Please see the official QuickNode SDK documentation for the full documentation of SDK functions.

Contributing corner

Issues

Please submit any issues or feature requests as an issue in Github.

Development

We recommend using the example application to develop

1. In qn-oss monorepo root directory, run yarn install
2. cd packages/apps/examples/sdk-api from qn-oss monorepo root
3. cp .env.example .env and add api key
4. nx serve apps-examples-sdk-api
5. Then you can send requests to the API, for example: curl http://localhost:3333/api/nftsByAddress/0xbc08dadccc79c00587d7e6a75bb68ff5fd30f9e0

Running tests

Run nx test libs-sdk to execute the tests via Jest.

API responses are recorded using polly.js. You can re-record live requests by passing in an API key, copy .env.test.example to .env.test and fill out with your API key.

Running linting

Run nx lint libs-sdk to execute the lint via ESLint.

Generate graphql codegen typings

Generate graphql typings via Codegen.

1. navigate to packages/libs/sdk from qn-oss monorepo root
2. cp .env.example .env and add api key
3. run yarn run codegen