๐คบToken Gating (Solana)
A guide to start token gating anything in minutes.
Requirements
Before continuing make sure you've followed the setup guide
โ๏ธStart Here: SetupToken Gate Anything
You can use Picket to token gate anything. If you want to authenticate users and verify their token ownership, you can pass the token ownership requirements to the login()
function.
Login User w/ Token Ownership Requirements
Unlike Ethereum, Solana SPL tokens do not have a natural grouping under a single contract address.
Solana and Metaplex are actively working to change this; however, in the meantime, there are several different ways to reference the SPL tokens you want to token gate based off of:
Token IDs (Addresses)
Verified Creator Address
Token Gate on Specific Token IDs
If there are a small number of tokens that you want to token gate based off, you can simply list them out on the the login requirements.
import Picket from "@picketapi/picket-js";
const picket = new Picket('YOUR_PUBLISHABLE_KEY_HERE');
// These requirements are for the Solana Mainnet Beta
const requirements = {
chain: "solana",
// Replace this the tokens you want to verify ownership for
// the token ID is the mint associated with a SPL token
// user needs to own the minTokenBalance of at least one of the listed token
tokenIds: ["78AZe2223PknLYT9mn2VCJPAsdvuB6LzFAhgQeVoxddW", "2dQG4YYunFrbJjzW6UTcUmePs8UDy5jz43H6uSCZSAcS"],
// Replace with minimum balance you want to verify users' currently hold across all token IDs,
// or omit if any number of tokens is sufficient
minTokenBalance: 1
}
const { accessToken, user } = await picket.login(requirements);
console.log(user);
Token Gate on a Verified Creator Address
If you have a large collection of tokens that don't support the upcoming Metaplex Collection Standard, then the best proxy is a verified creator address.
If there are multiple token collections created by the same wallet address, users who own a token from any of the creators collections will be granted access.
import Picket from "@picketapi/picket-js";
const picket = new Picket('YOUR_PUBLISHABLE_KEY_HERE');
// These requirements are for the Solana Mainnet Beta
const requirements = {
chain: "solana",
// Replace this with a verified creatorAddress for your SPL tokens
// If you created the tokens, it will often be your wallet address
creatorAddress: "GcRZfnNriUPJwiE5AvF71R9f5ujGhYiYx7YNeq8wizzt",
// Replace with minimum balance you want to verify users' currently hold across all token IDs,
// or omit if any number of tokens is sufficient
minTokenBalance: 1
}
const { accessToken, user } = await picket.login(requirements);
console.log(user);
Token Gate on a Collection ID
Solana is moving towards the Metaplex Collection Standard. Collections will make referencing a set of SPL tokens as it is on Ethereum. Unfortunately, at the time of writing this the adoption is low, especially for the earlier Solana NFT projects. If you are the creator of the SPL tokens, you can follow the instructions below to create a collection for your SPL tokens.
Create a Collection ID
If you are the creator of the SPL tokens, you can use https://collections.metaplex.com/ to create a collection ID for your tokens
import Picket from "@picketapi/picket-js";
const picket = new Picket('YOUR_PUBLISHABLE_KEY_HERE');
// These requirements are for the Solana Mainnet Beta
const requirements = {
chain: "solana",
// Replace this with your Metaplex Certified Collection ID
collection: "GuPE3LLFtTfWB4BJ6hLbtWHS5gifjZWVduC9AyaPPEWh",
// Replace with minimum balance you want to verify users' currently hold across all token IDs,
// or omit if any number of tokens is sufficient
minTokenBalance: 1
}
const { accessToken, user } = await picket.login(requirements);
console.log(user);
You successfully validated a user's wallet and token ownership!
The returned access token can now act as secure proof of token ownership until expiration. It can be passed server side and verified there in order to restrict resources to authenticated wallets with whichever token ownership requirements you have.
Using Access Tokens
Congrats ๐ your user is now successfully logged in. After authenticated/authorizing a user, you get an access token. You can use this access token to make secure requests to your backend. Read more in the working with access tokens guide.
๐Working with Access TokensLast updated