Token Gating Rules
Grant roles to users based on their token and NFT holdings.
Setting up tokens
First thing you have to do when setting up token gating rules in your server is to enter your token or NFT collection details into Flipsuite. To do it, go to the “Gating” tab on your community dashboard and switch to the “Tokens” tab.
Empty gating tokens tab
Click the “Add new token” button to get started, and add your token details. After successfully adding the token details you will get redirected to the panel below:
Token details tab
Perfect! You can now use your token for creating token gating rules in your community. Optionally, you can go to the “Appearance” tab to change your token appearance.
Token appearance tab
Adding staking contracts (optional)
With Flipsuite, you can verify tokens and NFTs even if they are staked or locked in external contracts. To add your staking contract to Flipsuite, go to the “Contracts” tab.
Token contracts tab
Click the “Add staking contract” button and enter your staking contract address. If you’re using Flipsuite for the first time, and your token or collection is on the EVM chain, there is a high chance that your contract isn’t supported yet, like in the image below:
Not supported contract
If that’s the case, please open a ticket in our support server and provide us with your smart contract details:
- Blockchain
- Contract address
- Contract ABI (if your contract isn’t verified on the blockchain explorer)
We’ll do our best to add support for the provided contract as soon as possible. Once we do it, your contract’s status color should change to green:
Supported contract
Now your token gating rules for this token will read users’ staked token balance from the provided smart contract as well.
Adding token gating rules
To add your first token gating rule, go to the “Rules” tab, click the “Create new rule” button, and choose Token Gating Rule to get started.
Empty rules tab
Adding rule for a token
There a couple of settings you can set when creating a token gating rule for a token:
Token Gating Rule form
Adding rule for an NFT collection
When creating a token gating rule for an NFT collection, you get a few more settings to set:
Token Gating Rule form
Attribute-based rules are available only on the Starter plan.
Recipes
Below are some of the most common ways to set token gating rules:
Overlapping roles
The most common approach to structuring your roles is to make them overlap. For example, if you have 3 rules, each representing a different holder tier, you would configure them like this:
@Tier1
- Minimum of1,000
tokens@Tier2
- Minimum of10,000
tokens@Tier3
- Minimum of100,000
tokens
You skip the “Maximum amount” option entirely, so the person who holds at least 100,000
tokens, gets all of the
roles. It makes the server management of roles a lot easier, because channels that are locked to the first tier will
be accessible by the higher tiered roles as well.
Separated roles
This approach, on the other hand, makes it so every person in your server can only have one of the tiers assigned to them at once. All you have to do is extend the example above and set a “Maximum amount” option:
@Tier1
- Minimum of1,000
tokens, maximum of10,000
tokens@Tier2
- Minimum of10,000
tokens, maximum of100,000
tokens@Tier3
- Minimum of100,000
tokens
This way a person who holds 50,000
tokens only gets the @Tier2
role, a person who holds at least 100,000
only gets
the @Tier3
role and so on.
Maximum amount option is exclusive, which means that if you set it to 100,000
, people who hold exactly
100,000
tokens won’t get the @Tier2
role.
Only counting staked tokens
If your token or NFTs can be staked, it’s common to create separate roles for people who stake their tokens. This way you can detect who’s in your project for the long game, and reward them by giving these roles extra perks like access to alpha channels, reward multipliers, access to exclusive battlegrounds and so on - it’s up to you.
Attribute based rules (NFTs only)
If you have an NFT collection, it likely has different attributes/traits, some of them being more common, and some of them being ultra-rare. People love to feel special, and creating extra roles for holding an NFT with a specific attribute or set of attributes will make people in your community feel just like that.
Result
After configuring and adding your token gating rule, your page should look similar to the screenshot below.
Rules tab
You are ready to set up a gating verification message in your server now!