Airstack Web SDK

The Airstack Web SDK provides a convenient way for web developers to integrate Airstack's blockchain functionalities into their applications. With the provided hooks and components, you can easily query and fetch data from smart contracts and display NFT assets.

Installation

With NPM

npm install @airstack/airstack-react

With yarn

yarn add @airstack/airstack-react

With pnpm

pnpm install @airstack/airstack-react

Getting started

To use the SDK you will need the Airstack API key, once you have it you can call the init function with the API key or use AirstackProvider.

init must be called before any of the SDK hooks or components are used or you can use AirstackProvider, we recommend using init or AirstackProvider in the App.ts file.

Example with init

import { init, useQuery } from "@airstack/airstack-react";

init("api-key");

const MyComponent = () => {
  const { data, loading, error } = useQuery(query, variables, { cache: false });

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  // Render your component using the data returned by the query
};

Example with AirstackProvider

import { AirstackProvider, useQuery } from "@airstack/airstack-react";


const App () => {
  return (
    <AirstackProvider apiKey={"api-key"}>
      <MyComponent/>
    </AirstackProvider>
  )
}

const MyComponent = () => {
  const { data, loading, error } = useQuery(query, variables, { cache: false });

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  // Render your component using the data returned by the query
};

Hooks

All the hooks can take 3 arguments

Argument	Description	Options
query (required)	The GraphQL query string to be executed.	String
variables	Variables to be used in the GraphQL query.	Record<string, any>
configAndCallbacks	Additional configuration and callback options.	ConfigAndCallbacks

ConfigAndCallbacks Options

Option	Description	Type	Default
onCompleted	A callback function that will be called when the query is successfully completed.	(data: any) => void	-
onError	A callback function that will be called when an error occurs during the query.	(error: any) => void	-
dataFormatter	A function that allows custom formatting of the data before returning it to the user.	(data: any) => any	-
cache	Determines whether to cache the query result.	boolean	true

const { data, loading, error } = useQuery(query, variables, { cache: false });

Query Hooks

useQuery

The useQuery hook loads query data as soon as the component is mounted. It returns an object with the following properties:

data: the data returned by the query.
loading: a boolean indicating whether the query is currently loading.
error: any error that occurred while loading the query.

Example

import { useQuery } from "@airstack/airstack-react";

const MyComponent = () => {
  const { data, loading, error } = useQuery(
    query,
    variables,
    configAndCallbacks
  );

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  // Render your component using the data returned by the query
};

useLazyQuery

The useLazyQuery hook is used when you want to fetch query data manually, instead of automatically when the component mounts. It returns an array with two items:

fetch: a function that can be called to execute the query.
An object with the same properties as the object returned by useQuery: data, loading, and error.

Example

import { useLazyQuery } from "@airstack/airstack-react";

const MyComponent = () => {
  const [fetch, { data, loading, error }] = useLazyQuery(query, variables);

  const handleClick = () => {
    fetch();
  };

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  // Render your component using the data returned by the query
};

Pagination Hooks

Note: pagination hooks only work with queries that have support for pagination.

useQueryWithPagination

The useQueryWithPagination hook provides a simple way to paginate the data returned by a query. It works the same as the useQuery hook, but also returns an object with the following properties:

pagination: an object with the following properties:
- hasNextPage: a boolean indicating whether there is another page of data after the current page.
- hasPrevPage: a boolean indicating whether there is another page of data before the current page.
- getNextPage: a function that can be called to fetch the next page of data.
- getPrevPage: a function that can be called to fetch the previous page of data.

Example

import { useQueryWithPagination } from "@airstack/airstack-react";

const MyComponent = () => {
  const { data, loading, pagination } = useQueryWithPagination(
    query,
    variables,
    configAndCallbacks
  );
  const { hasNextPage, hasPrevPage, getNextPage, getPrevPage } = pagination;

  const handleNextPage = () => {
    getNextPage();
  };

  const handlePrevPage = () => {
    getPrevPage();
  };

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }

  // Render your component using the data returned by the query
};

useLazyQueryWithPagination

The useLazyQueryWithPagination hook is used when you want to manually fetch paginated data. It returns an array with two items:

fetch: a function that can be called to execute the query.
An object with the same properties as the object returned by useQueryWithPagination: data, loading, and pagination.

The fetch function can be called whenever you want to execute the query, for example, in response to a user action like clicking a button to load more data. The hook returns the data, loading, and pagination properties just like useQueryWithPagination.

Here's an example of using useLazyQueryWithPagination:

import { useLazyQueryWithPagination } from "@airstack/airstack-react";

function Component() {
  const [fetchData, { data, loading, pagination }] = useLazyQueryWithPagination(
    query,
    variables
  );

  const loadMore = () => {
    if (pagination.hasNextPage) {
      pagination.getNextPage();
    }
  };

  return (
    <div>
      <button onClick={fetchData}>Fetch Data</button>
      <ul>
        {data.map((item) => (
          <li key={item.id}>{item.name}</li>
        ))}
      </ul>
      {pagination.hasNextPage && <button onClick={loadMore}>Load More</button>}
      {loading && <p>Loading...</p>}
    </div>
  );
}

In the example, we define a loadMore function that gets called when a user clicks a "Load More" button. The loadMore function checks if there is a next page using pagination.hasNextPage and calls pagination.getNextPage() to fetch the next page of data.

Note that when using useLazyQueryWithPagination, you will need to handle the fetching of the initial data yourself. In the example, we call the fetchData function to fetch the initial data when the user clicks the "Fetch Data" button.

Components

Asset

The Asset component can be used to load and display NFT assets in your React application.

Props

chain (optional): a string representing the blockchain network to use. Defaults to "ethereum".
address (required): a string representing the contract address of the NFT.
tokenId (required): a string representing the token ID of the NFT.
loading (optional): a React node to show while the asset is loading.
error (optional): a React node to show if there is an error loading the asset.
imgProps (optional): an object of HTML image attributes to pass to the underlying image element.
preset (optional): a string representing the size of the asset image to display. Can be one of "extraSmall", "small", "medium", "large", or "original". Defaults to "medium".

Example

import { Asset } from "@airstack/airstack-react";

function App() {
  return (
    <div>
      <Asset
        chain="ethereum"
        address="0x...",
        tokenId="tokenId"
        loading={<div>Loading...</div>}
        error={<div>Error loading asset.</div>}
        imgProps={{alt: "my asset"}}
        preset="medium"
      />
    </div>
  );
}

fetchQuery

fetchQuery can be used in places where using hooks is not possible. fetchQuery accepts the same parameter as hooks. Note: fetchQuery only accepts config and does not accept callbacks in the third parameter.

fetchQuery returns a promise with an object, which contains the following properties:

data: The response data returned by the server.
error: An error object, if an error occurred during the network request.

Example

import { fetchQuery } from "@airstack/airstack-react";

const { data, error } = await fetchQuery(query, variables, config);

fetchQueryWithPagination

fetchQueryWithPagination takes the same parameter as fetchQuery.

It returns a promise with an object, which contains the following properties:

data: The response data returned by the server.
error: An error object, if an error occurred during the network request.
hasNextPage: A boolean that indicates whether there is a next page of data available.
hasPrevPage: A boolean that indicates whether there is a previous page of data available.
getNextPage(): A function that returns the next page of data. Returns null if there is no next page.
getPrevPage(): A function that returns the pråevious page of data. Returns null if there is no previous page.

Note: fetchQueryWithPagination only works with queries that have support for pagination.

Example

import { fetchQueryWithPagination } from "@airstack/airstack-react";

const { data, error, hasNextPage, hasPrevPage, getNextPage, getPrevPage } =
  await fetchQueryWithPagination(query, variables, config);

Hooks for Popular Queries

`useGetTokenBalances`

Get all tokens(ERC20, ERC721, ERC1155) held by an wallet address

import { useGetTokenBalances } from "@airstack/airstack-react";

const [fetchData, { data, loading, pagination }] = useGetTokenBalances({
  identitity: "vitalik.eth",
  tokenType: ["ERC20", "ERC721", "ERC1155"],
  blockchain: "ethereum",
  limit: 200,
});

`useGetTokenDetails`

Get token details(Name, Symbol, Decimals, TotalSupply) for given contract address

Code

import { useGetTokenDetails } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetTokenDetails({
  address: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  blockchain: "ethereum",
});

`useGetNFTDetails`

Get NFT details (Name, Symbol, Decimals, TotalSupply, Metadata, TokenURI, Images) for a given contract address and tokenId

import { useGetNFTDetails } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetNFTDetails({
  address: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  tokenId: "1751",
  blockchain: "ethereum",
});

`useGetNFTs`

Get all NFTs of an NFT collection

import { useGetNFTs } from "@airstack/airstack-react";

const [fetchData, { data, loading, pagination }] = useGetNFTs({
  blockchain: "ethereum",
  limit: 200,
  address: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
});

`useGetNFTImages`

Get images of an NFT

import { useGetNFTImages } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetNFTImages({
  address: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  tokenId: "1751",
  blockchain: "ethereum",
});

`useGetWalletENSAndSocial`

Get all social profiles and ENS names of a wallet

import { useGetWalletENSAndSocial } from "@airstack/airstack-react";

const [fetchData, { data, loading, pagination }] = useGetWalletENSAndSocial({
  identity: "vitalik.eth",
  blockchain: "ethereum",
});

`useGetWalletENS`

Get the ENS name of a wallet address

import { useGetWalletENS } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetWalletENS({
  identity: "vitalik.eth",
  blockchain: "ethereum",
});

`useGetBalanceOfToken`

Get the balance of a given wallet address for a particular token

import { useGetBalanceOfToken } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetBalanceOfToken({
  blockchain: "ethereum",
  tokenAddress: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  owner: "vitalik.eth",
});

`useGetHoldersOfCollection`

Get all owners of a token collection

import { useGetHoldersOfCollection } from "@airstack/airstack-react";

const [fetchData, { data, loading, pagination }] = useGetHoldersOfCollection({
  tokenAddress: ["0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D"],
  blockchain: "ethereum",
  limit: 200,
});

`useGetHoldersOfNFT`

Get all the owner(s) of the NFT

import { useGetHoldersOfNFT } from "@airstack/airstack-react";

const [fetchData, { data, loading, pagination }] = useGetHoldersOfNFT({
  tokenAddress: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  tokenId: "1751",
  blockchain: "ethereum",
});

`useGetPrimaryENS`

Get the primary domain for an address

import { useGetPrimaryENS } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetPrimaryENS({
  identity: "vitalik.eth",
  blockchain: "ethereum",
});

`useGetENSSubDomains`

Get all the ENS subdomains owned by an address

import { useGetENSSubDomains } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetENSSubDomains({
  owner: "vitalik.eth",
  blockchain: "ethereum",
});

`useGetTokenTransfers`

Get all transfers of a token

import { useGetTokenTransfers } from "@airstack/airstack-react";

const { data, loading, pagination } = useGetTokenTransfers({
  address: "vitalik.eth",
  blockchain: "ethereum",
});

`useGetNFTTransfers`

Get all transfers of a token NFT

import { useGetNFTTransfers } from "@airstack/airstack-react";

const [fetchData, { data, loading, pagination }] = useGetNFTTransfers({
  tokenAddress: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
  tokenId: "1751",
  blockchain: "ethereum",
  limit: 200,
});

Name		Name	Last commit message	Last commit date
Latest commit History 182 Commits
.github/workflows		.github/workflows
src		src
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.npmrc		.npmrc
README.md		README.md
index.html		index.html
package-lock.json		package-lock.json
package.json		package.json
setupTests.js		setupTests.js
tsconfig.json		tsconfig.json
tsconfig.node.json		tsconfig.node.json
vite.config.ts		vite.config.ts
vite.static.config.ts		vite.static.config.ts

Airstack-xyz/airstack-web-sdk

Folders and files

Latest commit

History

Repository files navigation

Airstack Web SDK

Table of Contents

Installation

With NPM

With yarn

With pnpm

Getting started

Hooks

Query Hooks

useQuery

Example

useLazyQuery

Example

Pagination Hooks

useQueryWithPagination

Example

useLazyQueryWithPagination

Components

Asset

Props

Example

fetchQuery

Example

fetchQueryWithPagination

Example

Hooks for Popular Queries

useGetTokenBalances

useGetTokenDetails

Code

useGetNFTDetails

useGetNFTs

useGetNFTImages

useGetWalletENSAndSocial

useGetWalletENS

useGetBalanceOfToken

useGetHoldersOfCollection

useGetHoldersOfNFT

useGetPrimaryENS

useGetENSSubDomains

useGetTokenTransfers

useGetNFTTransfers

About

Resources

Stars

Watchers

Forks

Releases 6

Packages 0

Contributors 7

Languages

`useGetTokenBalances`

`useGetTokenDetails`

`useGetNFTDetails`

`useGetNFTs`

`useGetNFTImages`

`useGetWalletENSAndSocial`

`useGetWalletENS`

`useGetBalanceOfToken`

`useGetHoldersOfCollection`

`useGetHoldersOfNFT`

`useGetPrimaryENS`

`useGetENSSubDomains`

`useGetTokenTransfers`

`useGetNFTTransfers`

Packages