Skip to main content

JavaScript SDK API Reference / Bindings / registerDomain

Function: registerDomain()

registerDomain(domain, space, buyer, buyerTokenAccount, mint?, referrerKey?): Promise<TransactionInstruction[]>

Defined in: bindings/registerDomain.ts:50

Builds the instructions to register a top-level .sns domain.

If a supported referrer is provided and its token account does not exist, the returned instructions include an idempotent associated token account creation instruction before the registration instruction.

Parameters​

domain​

string

Full .sns domain name

space​

number

The number of bytes to allocate for the domain name account

buyer​

PublicKey

Buyer paying for the registration

buyerTokenAccount​

PublicKey

The buyer's token account used to pay for registration

mint?​

PublicKey = USDC_MINT

The token mint used for payment, defaults to USDC

referrerKey?​

PublicKey

Optional public key of the referrer

Returns​

Promise<TransactionInstruction[]>

Transaction instructions.

Example​

const instructions = await registerDomain("example.sns", 1_000, buyer, buyerTokenAccount);