Clusters
  • Introduction
    • Overview
    • Concepts
      • Cluster Name
      • Wallet Name
    • Features
      • Communities
      • Multichain
      • Wallet Bundles
      • Antisquatting
      • Wallet Generation
      • Selective Wallet Sharing
  • Getting started
    • Javascript
      • Authentication
      • Clusters
      • Address → Cluster Name
      • Cluster Name → Address
      • Registration
        • Communities
      • Event Indexing
    • API
      • v1
        • Authentication
        • Clusters
        • Address → Cluster Name
        • Cluster Name → Address
        • Registration
          • Communities
        • Event Indexing
      • v0.1 (Deprecated)
        • Address → Cluster
        • Cluster → Address
        • Cluster → Metadata
        • Registration
        • Managing Wallets
  • Resources
    • Smart Contracts
    • Address Types
    • Using Clusters for ETH->SOL Airdrops
  • Integration Guides
    • Convert hex address to clusters name
    • Registering a name
      • Ethereum Networks
      • Solana
    • Whitelabel Communities Registration Flow
Powered by GitBook
On this page
  • Check name availability
  • Register a community name
  1. Getting started
  2. Javascript
  3. Registration

Communities

Check name availability

Check the availability of a community cluster name

const isAvailable = await clusters.getCommunityNameAvailability("pengu/myname");

Response

{
  "name": "pengu/myname",
  "isAvailable": false
}

Register a community name

Check the availability of one or more clusters

Name
Description

communityName

The name of the community you are registering under

name

The name you want to register

autheToken

Authentication key

walletAddress (optional)

If you are the admin of the community, you can register on behalf of someone. If this is left out the name will be registered to the authenticated wallet

Example

const name = await clusters.registerCommunityCluster(
   "pengu", 
   "myname",
   AUTH_TOKEN
);

Response

{
  "clusterName": "pengu/myname",
  "owner": "0x123"
}
PreviousRegistrationNextEvent Indexing

Last updated 1 month ago