Skip to main content

JS Kit SDK API Reference / Bindings / registerDomain

Function: registerDomain()

registerDomain(params): Promise<Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]>

Defined in: bindings/registerDomain.ts:82

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

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

Parameters​

params​

RegisterDomainParams

Registration parameters

Returns​

Promise<Instruction<string, readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[]>[]>

Transaction instructions.

Example​

const instructions = await registerDomain({
  domain: "example.sns",
  space: 1_000,
  buyer,
  buyerTokenAccount,
});