Communities
Currently only available on Sepolia and Holesky as we roll out the feature
Check availability
Check the availability of a single community cluster
GET
/check/availability/:clusterName/:walletName
Example
Response
Check requirements
Check if the community requirements for a specific wallet has been met for registration
GET
/check/requirements/:clusterName?walletAddress=:walletName
Example
Response
Registration
POST
/v0.1/community/register
Either registers a free community clusters OR returns transaction data for registrations that require payment.
HEADER (bearer) Authorization
clusterName
The cluster name of the community being registered
walletName
The wallet name being registered under the community
chainId
(optional)
If the price of a community cluster is USDC, a chainId should be passed so that the correct contracts are used when returning transaction data. It will default to mainnet.
walletAddress
(optional)
If the registration sign up's are restricted to community owners, a wallet address needs to be included to know who to register the name to.
Example
Response
Transaction Status
Checks the status of a transaction
GET
/v0.1/community/tx/:tx
Example
Response
Last updated