JS Kit SDK API Reference / Bindings
Bindings
High-level builders for SNS transaction instructions.
Interfaces
| Interface | Description |
|---|---|
| BurnDomainParams | Parameters for burning an SNS domain. |
| CreateNameRegistryParams | Parameters for creating a name registry. |
| CreateRecordParams | Parameters for creating a domain record. |
| CreateReverseParams | Parameters for creating a reverse lookup record. |
| CreateSubdomainParams | Parameters for creating an SNS subdomain. |
| DeleteNameRegistryParams | Parameters for deleting a name registry. |
| DeleteRecordParams | Parameters for deleting a domain record. |
| RecordVerificationParams | Accounts and record identity required to build a record-validation instruction. |
| RegisterDomainParams | Parameters for registering an SNS domain. |
| RegisterDomainWithNftParams | Parameters for registering an SNS domain with an NFT. |
| SetPrimaryDomainParams | Input for setting an owner's already-derived SNS primary domain. |
| TransferDomainParams | Parameters for transferring an SNS domain. |
| TransferSubdomainParams | Parameters for transferring an SNS subdomain. |
| UpdateNameRegistryParams | Input for updating bytes in a raw SNS name-registry account. |
| UpdateRecordParams | Parameters for updating a domain record. |
| ValidateRecordRoaEthereumParams | Parameters for validating a record with an Ethereum signature. |
Functions
| Function | Description |
|---|---|
| burnDomain | Builds an instruction to burn a top-level .sns domain. |
| createNameRegistry | Creates a raw SPL Name Registry account with the given rent budget, allocated space, owner, and class. |
| createRecord | Builds an instruction to create a V2 record for a .sns domain or subdomain. |
| createReverse | Creates a raw reverse lookup record for the specified domain account. |
| createSubdomain | Builds the instructions to create a .sns subdomain. |
| deleteNameRegistry | Deletes a raw SPL Name Registry account and refunds the associated rent balance to the specified target. |
| deleteRecord | Builds an instruction to delete a V2 record for a .sns domain or subdomain. |
| registerDomain | Builds the instructions to register a top-level .sns domain. |
| registerDomainWithNft | Builds an instruction to register a top-level .sns domain using a Bonfida Wolves NFT. |
| setPrimaryDomain | Sets the primary domain for the specified owner. |
| setRecordRoaVerifier | Builds an instruction to store the expected Right of Association verifier for a V2 record. |
| setRecordStalenessVerifier | Builds an instruction to write or refresh staleness verifier metadata for a V2 record. |
| transferDomain | Builds an instruction to transfer a top-level .sns domain. |
| transferSubdomain | Builds an instruction to transfer a .sns subdomain. |
| updateNameRegistry | Updates the data of a raw SPL Name Registry account. |
| updateRecord | Builds an instruction to update a V2 record for a .sns domain or subdomain. |
| validateRecordRoa | Builds an instruction to validate a V2 record's Right of Association with a Solana verifier. |
| validateRecordRoaEthereum | Builds an instruction to validate a V2 record's Right of Association with an Ethereum signature. |