https://github.com/marcusmolchany/tokengate
js module for token gating on ethereum
https://github.com/marcusmolchany/tokengate
crypto ethereum ethers gate token tokengate web3
Last synced: 10 months ago
JSON representation
js module for token gating on ethereum
- Host: GitHub
- URL: https://github.com/marcusmolchany/tokengate
- Owner: marcusmolchany
- License: mit
- Created: 2022-02-02T00:56:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-25T16:56:46.000Z (about 4 years ago)
- Last Synced: 2025-08-05T06:18:38.322Z (11 months ago)
- Topics: crypto, ethereum, ethers, gate, token, tokengate, web3
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/tokengate
- Size: 169 KB
- Stars: 29
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Token Gate
[![NPM version][npm-image]][npm-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
js module for token gating on ethereum
## Usage
Exported methods
```ts
// unsecure client-side method to check if an address meets a token threshold.
// example usage: enable/disable a button based on a connected wallet's address.
async unsecureClientSideTokenGate({
balanceOfThreshold, // {number} balance of tokens that define token gate threshold
contractAddress, // {string} erc20, erc721, or erc1155 contract address
signerOrProvider, // {Provider} wallet web3 provider
userAddress, // {string} user address
});
// sign an arbitrary message with a connected wallet
async clientSideSignMessage({
messageToSign, // {string} text message to be signed by user's connected wallet
signer, // {Signer} wallet web3 signer
});
// THIS IS NOT DEFINED YET. IT WILL ERROR IF YOU TRY TO USE IT.
async clientSideSignTypedData({});
// server-side code for a secure client-side/server-side token gate flow.
// takes a message signed by a client, recovers the address, and checks
// if that address meets a token threshold.
async secureServerSideTokenGate({
address, // {string} address to compare to address recovered from signedMessage
balanceOfThreshold, // {number} balance of tokens that define token gate threshold
contractAddress, // {string} erc20, erc721, or erc1155 contract address
message, // {string} clear text message that was signed by user's wallet
provider, // {Provider} server-side web3 provider
signedMessage, // {string} signed message by user's wallet
});
```
Client-side / Server-side example for erc20/721/777
```ts
////////////////////////////////////////////////////////////////////
//////////////////////// client-side react /////////////////////////
////////////////////////////////////////////////////////////////////
import axios from "axios";
import { useEffect, useState } from "react";
import { clientSideSignMessage, unsecureClientSideTokenGate } from "tokengate";
const balanceOfThreshold = 1; /* require 1 blitmap nft */
const contractAddress =
"0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63"; /* blitmap */
// this must match the message that is signed on the server-side.
// ideally the server-side issues this message as a challange.
const message = "sign this secret message";
function TokenGateButton({ signer }) {
const [isAllowed, setIsAllowed] = useState(false);
useEffect(() => {
const asyncEffect = async () => {
const userAddress = await signer.getAddress();
const _isAllowed = await unsecureClientSideTokenGate({
balanceOfThreshold,
contractAddress,
signerOrProvider: signer,
userAddress,
});
setIsAllowed(_isAllowed);
};
asyncEffect();
}, [signer]);
const onClick = async () => {
const userAddress = await signer.getAddress();
const signedMessage = await clientSideSignMessage({
messageToSign: message,
signer,
});
try {
const resp = await axios.post("/api/token-gate", {
address: userAddress,
signedMessage,
});
setIsAllowed(resp.data.isAllowed);
} catch (e) {
console.error("something went wrong");
setIsAllowed(false);
}
};
return (
Access token gated content
);
}
////////////////////////////////////////////////////////////////////
///////////////////////// server-side api //////////////////////////
////////////////////////////////////////////////////////////////////
import { ethers } from "ethers";
import { secureServerSideTokenGate } from "tokengate";
const balanceOfThreshold = 1; /* require 1 blitmap nft */
const contractAddress =
"0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63"; /* blitmap */
// this must match the message that is signed on the client-side.
// ideally the backend issues this message as a challange including a
// human-readable message, nonce, timestamp, domain and chain information.
const message = "sign this secret message";
app.post("/api/token-gate", (req, res) => {
// optional `networkId` param so that you can use other networks.
// defaults to `1` which is mainnet
const { address, networkId = 1, signedMessage } = req.body;
// create a web3 provider
const provider = new ethers.providers.InfuraProvider(networkId);
const isAllowed = await secureServerSideTokenGate({
address,
balanceOfThreshold,
contractAddress,
message,
provider,
signedMessage,
});
// handle the success/failure case however you want
return res.json({ isAllowed });
});
```
Client-side / Server-side example for erc1555
```ts
// the balanceOf method for erc1155 has a different api than other tokens. it allows you to
// check the balance of a particular user for a particular token id. for tokengate, you must
// provide two new arguments: `tokenId`, and `tokenStandard`.
// `tokenId` will be the number id of the token you are checking the balance of
// `tokenStandard` will be `erc1155`
// client-side
// pass `tokenId` and `tokenStandard` when doing a client-side token gate check
const _isAllowed = await unsecureClientSideTokenGate({
balanceOfThreshold,
contractAddress,
signerOrProvider: signer,
tokenId: 2,
tokenStandard: "erc1155",
userAddress,
});
// server-side
// pass `tokenId` and `tokenStandard` to your api handler
const isAllowed = await secureServerSideTokenGate({
address,
balanceOfThreshold,
contractAddress,
message,
provider,
signedMessage,
tokenId: 2,
tokenStandard: "erc1155",
});
```
[npm-image]: https://img.shields.io/npm/v/tokengate.svg?style=for-the-badge&labelColor=161c22
[npm-url]: https://www.npmjs.com/package/tokengate
[license-image]: https://img.shields.io/npm/l/tokengate.svg?style=for-the-badge&labelColor=161c22
[license-url]: /LICENSE
[downloads-image]: https://img.shields.io/npm/dm/tokengate.svg?style=for-the-badge&labelColor=161c22
[downloads-url]: https://www.npmjs.com/package/tokengate