🚪Token Gating

Learn how to enable users to access certain features only if they have a Farcaster account or a combination of Farcaster + other criteria such as a specific POAP or NFT.

Airstack provides easy-to-use APIs for enriching Farcaster applications and for integrating onchain and offchain data with Farcaster.

In this tutorial, you will learn how to build token gating systems in your dapp that grant feature access to Farcaster user(s) based on specific onchain criteria.

In this guide you will learn how to use Airstack to:

• Gating only user(s) that have Farcaster

• Gating only user(s) that have Farcaster and NFT

• Gating only user(s) that have Farcaster and POAP

Pre-requisites

• An Airstack account (free)

• Basic knowledge of GraphQL

Get Started

JavaScript/TypeScript/Python

If you are using JavaScript/TypeScript or Python, Install the Airstack SDK:

npm

React

npm install @airstack/airstack-react

Node

npm install @airstack/node

yarn

React

yarn add @airstack/airstack-react

Node

yarn add @airstack/node

pnpm

React

pnpm install @airstack/airstack-react

Node

pnpm install @airstack/node

pip

pip install airstack asyncio

Then, add the following snippets to your code:

React

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

init("YOUR_AIRSTACK_API_KEY");

const query = "YOUR_QUERY"; // Replace with GraphQL Query

const Component = () => {
  const { data, loading, error } = useQuery(query);

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

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

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

Node

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

init("YOUR_AIRSTACK_API_KEY");

const query = "YOUR_QUERY"; // Replace with GraphQL Query

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

console.log("data:", data);
console.log("error:", error);

Python

import asyncio
from airstack.execute_query import AirstackClient

api_client = AirstackClient(api_key="YOUR_AIRSTACK_API_KEY")

query = "YOUR_QUERY" # Replace with GraphQL Query

async def main():
    execute_query_client = api_client.create_execute_query_object(
        query=query)

    query_response = await execute_query_client.execute_query()
    print(query_response.data)

asyncio.run(main())

Other Programming Languages

To access the Airstack APIs in other languages, you can use https://api.airstack.xyz/gql as your GraphQL endpoint.

🤖 AI Natural Language​

Airstack provides an AI solution for you to build GraphQL queries to fulfill your use case easily. You can find the AI prompt of each query in the demo's caption or title for yourself to try.

Airstack AI (Demo)

Gating only user(s) that have Farcaster

You can implement token gating by checking whether users have Farcaster:

Try Demo

https://app.airstack.xyz/DTyOZg/ZNKiLFepdu

Show Farcaster name and ID of dwr.eth, 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045, and jayden.lens

Code

Query

query GetTokenGatingFarcasters {
  Socials(
    input: {filter: {identity: {_in: ["dwr.eth", "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "jayden.lens"]}, dappName: {_eq: farcaster}}, blockchain: ethereum}
  ) {
    Social {
      profileName
      userId
      userAssociatedAddresses
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "profileName": "dwr.eth",
          "userId": "3",
          "userAssociatedAddresses": [
            "0x74232bf61e994655592747e20bdf6fa9b9476f79",
            "0xb877f7bb52d28f06e60f557c00a56225124b357f",
            "0xa14b4c95b5247199d74c5578531b4887ca5e4909",
            "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
          ]
        }
      ]
    }
  }
}

If the length of the data.Socials.Social array is 0, then it implies that the user has no Farcaster.

Otherwise, the user does and can be given access to a the desired feature.

Gating only user(s) that have Farcaster and NFT

You can implement token gating by checking whether users have both Farcaster and the given NFT:

Try Demo

https://app.airstack.xyz/DTyOZg/EBQKpjUswY

Show NFT balance of 0xfaba1e9ed7f667e8c7a851c9ed15aed99aa80289 on specific NFTs

Code

Query

query MyQuery {
  TokenBalances(
    input: {filter: {tokenAddress: {_in: ["0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D", "0x23581767a106ae21c074b2276D25e5C3e136a68b"]}}, blockchain: ethereum, limit: 200}
  ) {
    TokenBalance {
      owner {
        socials(input: {filter: {dappName: {_eq: farcaster}}}) {
          userId
          profileName
        }
      }
    }
  }
}

Response

{
  "data": {
    "TokenBalances": {
      "TokenBalance": [
        {
          "owner": {
            "socials": [
              {
                "userId": "4353",
                "profileName": "yuko",
                "userAssociatedAddresses": [
                  "0x730db7436791d0baba17b4872c43980366f03e38",
                  "0xadd403e94985eee3108e16987eea30c10e2df2ef",
                  "0xfaba1e9ed7f667e8c7a851c9ed15aed99aa80289"
                ]
              }
            ]
          }
        }
      ]
    }
  }
}

If the length of the data.TokenBalances.TokenBalance array is 0, then it implies that the user has no given NFT held.

Otherwise, the user have at least one of the given NFT and then can have the owner.socials to be checked further to confirm if the user has any Farcaster.

If owner.socials has length 0, then similarly the user has no Farcaster.

Otherwise, the user has Farcaster and can be given access to a the desired feature.

Gating only user(s) that have Farcaster and POAP

You can implement token gating by checking whether users have both Farcaster and the given POAP:

Try Demo

https://app.airstack.xyz/DTyOZg/b7b76BDnX6

Show if 0x4455951fa43b17bd211e0e8ae64d22fb47946ade hold some given specific POAPs

Code

Query

query MyQuery {
  Poaps(
    input: {filter: {eventId: {_in: ["127462", "141910"]}, owner: {_eq: "0x4455951fa43b17bd211e0e8ae64d22fb47946ade"}}, blockchain: ALL}
  ) {
    Poap {
      owner {
        socials(input: {filter: {dappName: {_eq: farcaster}}}) {
          profileName
          userId
          userAssociatedAddresses
        }
      }
    }
  }
}

Response

{
  "data": {
    "Poaps": {
      "Poap": [
        {
          "owner": {
            "socials": [
              {
                "profileName": "megankaspar",
                "userId": "7361",
                "userAssociatedAddresses": [
                  "0xadf37a0d500c748edb1c689a1be26472e583dcb5",
                  "0x4455951fa43b17bd211e0e8ae64d22fb47946ade",
                  "0xfaedb341b0faced023099d7b0ccd23c2ec5ed7a5"
                ]
              }
            ]
          }
        }
      ]
    }
  }
}

If the length of the data.Poaps.Poap array is 0, then it implies that the user has no given POAP held.

Otherwise, the user have at least one of the given POAP and then can have the owner.socials to be checked further to confirm if the user has any Farcaster.

If owner.socials has length 0, then similarly the user has no Farcaster.

Otherwise, the user has Farcaster and can be given access to a the desired feature.

Developer Support

If you have any questions or need help regarding token gating, please join our Airstack's Telegram group.

More Resources

• TokenBalances API Reference

• Socials API Reference

• POAPs API Reference