Javascript SDK Reference
Ƭ AccountData<
T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
parsed | T |
pubkey | web3.PublicKey |
Defined in
Defined in
Defined in
Defined in
Defined in
Ƭ Namespaces:
Object
Type declaration
Name | Type |
---|---|
accounts | [{ name : "globalContext" ; type : { fields : [{ name : "bump" ; type : "u8" }, { name : "updateAuthority" ; type : "publicKey" }, { name : "rentAuthority" ; type : "publicKey" }, { name : "rentPercentage" ; type : "u64" }] ; kind : "struct" } }, { name : "namespace" ; type : { fields : [{ name : "bump" ; type : "u8" }, { name : "name" ; type : "string" }, { name : "updateAuthority" ; type : "publicKey" }, { name : "rentAuthority" ; type : "publicKey" }, { name : "approveAuthority" ; type : { option : "publicKey" } }, { name : "schema" ; type : "u8" }, { name : "paymentAmountDaily" ; type : "u64" }, { name : "paymentMint" ; type : "publicKey" }, { name : "minRentalSeconds" ; type : "i64" }, { name : "maxRentalSeconds" ; type : { option : "i64" } }, { name : "transferableEntries" ; type : "bool" }] ; kind : "struct" } }, { name : "claimRequest" ; type : { fields : [{ name : "bump" ; type : "u8" }, { name : "requestor" ; type : "publicKey" }, { name : "isApproved" ; type : "bool" }, { name : "namespace" ; type : "publicKey" }, { name : "entryName" ; type : "string" }] ; kind : "struct" } }, { name : "entry" ; type : { fields : [{ name : "bump" ; type : "u8" }, { name : "namespace" ; type : "publicKey" }, { name : "name" ; type : "string" }, { name : "data" ; type : { option : "publicKey" } }, { name : "reverseEntry" ; type : { option : "publicKey" } }, { name : "mint" ; type : "publicKey" }, { name : "isClaimed" ; type : "bool" }] ; kind : "struct" } }, { name : "reverseEntry" ; type : { fields : [{ name : "bump" ; type : "u8" }, { name : "entryName" ; type : "string" }, { name : "namespaceName" ; type : "string" }] ; kind : "struct" } }] |
errors | [{ code : 300 ; msg : "Owner mint is invalid" ; name : "InvalidOwnerMint" }, { code : 301 ; msg : "Entry has not expired" ; name : "EntryNotExpired" }, { code : 302 ; msg : "Rental duration too small try adding more funds" ; name : "RentalDurationTooSmall" }, { code : 303 ; msg : "Rental duration too large try adding less funds" ; name : "RentalDurationTooLarge" }, { code : 304 ; msg : "Namespace requires duration" ; name : "NamespaceRequiresDuration" }, { code : 305 ; msg : "Authority is invalid" ; name : "InvalidAuthority" }, { code : 306 ; msg : "Invalid authorty token account" ; name : "InvalidAuthorityTokenAccount" }, { code : 307 ; msg : "Invalid namespace payment account" ; name : "InvalidNamespacePaymentAccount" }, { code : 308 ; msg : "Invalid global namespace payment account" ; name : "InvalidGlobalNamespacePaymentAccount" }, { code : 309 ; msg : "Invalid namespace" ; name : "InvalidNamespace" }, { code : 310 ; msg : "Invalid entry" ; name : "InvalidEntry" }, { code : 311 ; msg : "Invalid certificate" ; name : "InvalidCertificate" }, { code : 312 ; msg : "Invalid payment mint" ; name : "InvalidPaymentMint" }, { code : 313 ; msg : "Invalid reverse entry" ; name : "InvalidReverseEntry" }, { code : 314 ; msg : "Claim not allowed" ; name : "ClaimNotAllowed" }, { code : 315 ; msg : "Invalid approve authority" ; name : "InvalidApproveAuthority" }, { code : 316 ; msg : "Namespace requires token" ; name : "NamespaceRequiresToken" }] |
instructions | [{ accounts : [{ isMut : true ; isSigner : false ; name : "globalContext" }, { isMut : false ; isSigner : true ; name : "authority" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "ix" ; type : { defined : "InitializeGlobalNamespaceIx" } }] ; name : "init" }, { accounts : [{ isMut : true ; isSigner : false ; name : "globalContext" }, { isMut : false ; isSigner : true ; name : "updateAuthority" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "rentPercentage" ; type : "u64" }] ; name : "setRentPercentage" }, { accounts : [{ isMut : true ; isSigner : false ; name : "globalContext" }, { isMut : false ; isSigner : true ; name : "updateAuthority" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "updateAuthority" ; type : "publicKey" }] ; name : "transferGlobalUpdateAuthority" }, { accounts : [{ isMut : true ; isSigner : false ; name : "globalContext" }, { isMut : false ; isSigner : true ; name : "rentAuthority" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "rentAuthority" ; type : "publicKey" }] ; name : "transferGlobalRentAuthority" }, { accounts : [{ isMut : true ; isSigner : false ; name : "namespace" }, { isMut : false ; isSigner : false ; name : "authority" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "ix" ; type : { defined : "CreateNamespaceIx" } }] ; name : "createNamespace" }, { accounts : [{ isMut : true ; isSigner : false ; name : "namespace" }, { isMut : false ; isSigner : true ; name : "updateAuthority" }] ; args : [{ name : "ix" ; type : { defined : "UpdateNamespaceIx" } }] ; name : "updateNamespace" }, { accounts : [{ isMut : false ; isSigner : false ; name : "globalContext" }, { isMut : true ; isSigner : false ; name : "globalNamespacePaymentAccount" }, { isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "namespacePaymentAccount" }, { isMut : false ; isSigner : true ; name : "rentAuthority" }, { isMut : true ; isSigner : false ; name : "rentAuthorityTokenAccount" }, { isMut : false ; isSigner : false ; name : "tokenProgram" }] ; args : [{ name : "amount" ; type : "u64" }] ; name : "collectNamespaceFunds" }, { accounts : [{ isMut : false ; isSigner : false ; name : "globalContext" }, { isMut : true ; isSigner : false ; name : "globalNamespacePaymentAccount" }, { isMut : false ; isSigner : true ; name : "rentAuthority" }, { isMut : true ; isSigner : false ; name : "authorityTokenAccount" }, { isMut : false ; isSigner : false ; name : "tokenProgram" }] ; args : [{ name : "amount" ; type : "u64" }] ; name : "collectGlobalFunds" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : true ; name : "payer" }, { isMut : true ; isSigner : false ; name : "namespaceCertificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "mintManager" }, { isMut : true ; isSigner : false ; name : "certificateMint" }, { isMut : true ; isSigner : false ; name : "certificateMintMetadata" }, { isMut : false ; isSigner : false ; name : "certificateProgram" }, { isMut : false ; isSigner : false ; name : "tokenMetadataProgram" }, { isMut : false ; isSigner : false ; name : "tokenProgram" }, { isMut : false ; isSigner : false ; name : "associatedToken" }, { isMut : false ; isSigner : false ; name : "rent" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "ix" ; type : { defined : "InitEntryIx" } }] ; name : "initEntry" }, { accounts : [{ isMut : true ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : true ; name : "user" }, { isMut : true ; isSigner : true ; name : "payer" }, { isMut : true ; isSigner : false ; name : "claimRequest" }, { isMut : true ; isSigner : false ; name : "paymentMint" }, { isMut : true ; isSigner : false ; name : "namespaceCertificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "mintManager" }, { isMut : true ; isSigner : false ; name : "certificate" }, { isMut : true ; isSigner : false ; name : "certificateMint" }, { isMut : true ; isSigner : false ; name : "certificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "certificatePaymentTokenAccount" }, { isMut : true ; isSigner : false ; name : "userCertificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "userPaymentTokenAccount" }, { isMut : false ; isSigner : false ; name : "certificateProgram" }, { isMut : false ; isSigner : false ; name : "tokenProgram" }, { isMut : false ; isSigner : false ; name : "associatedToken" }, { isMut : false ; isSigner : false ; name : "rent" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "ix" ; type : { defined : "ClaimEntryIx" } }] ; name : "claimEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : false ; isSigner : false ; name : "userCertificateTokenAccount" }, { isMut : false ; isSigner : false ; name : "certificate" }, { isMut : true ; isSigner : true ; name : "user" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "data" ; type : "publicKey" }] ; name : "setEntryData" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "reverseEntry" }, { isMut : false ; isSigner : false ; name : "userCertificateTokenAccount" }, { isMut : false ; isSigner : false ; name : "certificate" }, { isMut : true ; isSigner : true ; name : "user" }, { isMut : false ; isSigner : true ; name : "payer" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "reverseEntryBump" ; type : "u8" }] ; name : "setReverseEntry" }, { accounts : [{ isMut : true ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "claimRequest" }, { isMut : true ; isSigner : false ; name : "namespaceCertificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "namespacePaymentTokenAccount" }, { isMut : false ; isSigner : true ; name : "invalidator" }, { isMut : true ; isSigner : false ; name : "mintManager" }, { isMut : true ; isSigner : false ; name : "certificate" }, { isMut : true ; isSigner : false ; name : "certificateMint" }, { isMut : true ; isSigner : false ; name : "certificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "certificatePaymentTokenAccount" }, { isMut : true ; isSigner : false ; name : "userCertificateTokenAccount" }, { isMut : true ; isSigner : false ; name : "userPaymentTokenAccount" }, { isMut : false ; isSigner : false ; name : "certificateProgram" }, { isMut : false ; isSigner : false ; name : "tokenProgram" }] ; args : [] ; name : "revokeEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : false ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "reverseEntry" }, { isMut : true ; isSigner : false ; name : "claimRequest" }, { isMut : false ; isSigner : true ; name : "invalidator" }] ; args : [] ; name : "revokeReverseEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "namespaceCertificateTokenAccount" }, { isMut : false ; isSigner : true ; name : "invalidator" }] ; args : [] ; name : "invalidateManagedEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "reverseEntry" }, { isMut : true ; isSigner : false ; name : "namespaceCertificateTokenAccount" }, { isMut : false ; isSigner : true ; name : "invalidator" }] ; args : [] ; name : "invalidateManagedReverseEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : false ; isSigner : false ; name : "certificate" }, { isMut : false ; isSigner : true ; name : "invalidator" }] ; args : [] ; name : "invalidateUnmanagedEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "reverseEntry" }, { isMut : false ; isSigner : false ; name : "certificate" }, { isMut : false ; isSigner : true ; name : "invalidator" }] ; args : [] ; name : "invalidateUnmanagedReverseEntry" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : true ; isSigner : true ; name : "payer" }, { isMut : true ; isSigner : false ; name : "claimRequest" }, { isMut : false ; isSigner : false ; name : "systemProgram" }] ; args : [{ name : "entryName" ; type : "string" }, { name : "claimRequestBump" ; type : "u8" }, { name : "user" ; type : "publicKey" }] ; name : "createClaimRequest" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : false ; isSigner : true ; name : "approveAuthority" }, { isMut : true ; isSigner : false ; name : "rentRequest" }] ; args : [{ name : "isApproved" ; type : "bool" }] ; name : "updateClaimRequest" }, { accounts : [{ isMut : false ; isSigner : false ; name : "namespace" }, { isMut : false ; isSigner : false ; name : "entry" }, { isMut : true ; isSigner : false ; name : "certificateMintMetadata" }, { isMut : false ; isSigner : false ; name : "tokenMetadataProgram" }] ; args : [] ; name : "updateEntryMintMetadata" }] |
name | "namespaces" |
types | [{ name : "ClaimEntryIx" ; type : { fields : [{ name : "duration" ; type : { option : "i64" } }, { name : "certificateBump" ; type : "u8" }] ; kind : "struct" } }, { name : "CreateNamespaceIx" ; type : { fields : [{ name : "bump" ; type : "u8" }, { name : "name" ; type : "string" }, { name : "updateAuthority" ; type : "publicKey" }, { name : "rentAuthority" ; type : "publicKey" }, { name : "approveAuthority" ; type : { option : "publicKey" } }, { name : "schema" ; type : "u8" }, { name : "paymentAmountDaily" ; type : "u64" }, { name : "paymentMint" ; type : "publicKey" }, { name : "minRentalSeconds" ; type : "i64" }, { name : "maxRentalSeconds" ; type : { option : "i64" } }, { name : "transferableEntries" ; type : "bool" }] ; kind : "struct" } }, { name : "InitEntryIx" ; type : { fields : [{ name : "name" ; type : "string" }, { name : "entryBump" ; type : "u8" }, { name : "mintManagerBump" ; type : "u8" }] ; kind : "struct" } }, { name : "InitializeGlobalNamespaceIx" ; type : { fields : [{ name : "rentPercentage" ; type : "u64" }, { name : "bump" ; type : "u8" }] ; kind : "struct" } }, { name : "UpdateNamespaceIx" ; type : { fields : [{ name : "updateAuthority" ; type : "publicKey" }, { name : "rentAuthority" ; type : "publicKey" }, { name : "approveAuthority" ; type : { option : "publicKey" } }, { name : "paymentAmountDaily" ; type : "u64" }, { name : "paymentMint" ; type : "publicKey" }, { name : "minRentalSeconds" ; type : "i64" }, { name : "maxRentalSeconds" ; type : { option : "i64" } }, { name : "transferableEntries" ; type : "bool" }] ; kind : "struct" } }] |
version | "0.0.0" |
Defined in
Defined in
• CLAIM_REQUEST_SEED:
"rent-request"
Defined in
• ENTRY_SEED:
"entry"
Defined in
• GLOBAL_CONTEXT_SEED:
"context"
Defined in
• GLOBAL_RENTAL_PERCENTAGE:
0.2
Defined in
Defined in
Defined in
• NAMESPACES_PROGRAM_ID:
PublicKey
Defined in
• NAMESPACE_SEED:
"namespace"
Defined in
• REVERSE_ENTRY_SEED:
"reverse-entry"
Defined in
▸ breakName(
fullName
): [string
, string
]Parameters
Name | Type |
---|---|
fullName | string |
Returns
[
string
, string
]Defined in
▸ claimRequestId(
namespaceName
, entryName
, user
): Promise
<[PublicKey
, number
]>Parameters
Name | Type |
---|---|
namespaceName | string |
entryName | string |
user | PublicKey |
Returns
Promise
<[PublicKey
, number
]>Defined in
▸ displayAddress(
address
, shorten?
): string
Parameters
Name | Type | Default value |
---|---|---|
address | string | undefined |
shorten | boolean | true |
Returns
string
Defined in
▸ formatName(
namespace
, name
): string
Parameters
Name | Type |
---|---|
namespace | string |
name | string |
Returns
string
Defined in
▸ getClaimRequest(
connection
, namespaceName
, entryName
, requestor
): Promise
<AccountData
<ClaimRequestData
>>Parameters
Name | Type |
---|---|
connection | Connection |
namespaceName | string |
entryName | string |
requestor | PublicKey |
Returns
Defined in
▸ getNameEntries(
connection
, namespaceName
, entryNames
): Promise
<AccountData
<EntryData
> & { name
: string
}[]>Parameters
Name | Type |
---|---|
connection | Connection |
namespaceName | string |
entryNames | string [] |
Returns
Defined in
Parameters
Name | Type |
---|---|
connection | Connection |
namespaceName | string |
entryName | string |
Returns
Defined in
Parameters
Name | Type |
---|---|
connection | Connection |
namespaceName | string |
Returns
Defined in
Parameters
Name | Type |
---|---|
connection | Connection |
Returns
Defined in
Parameters
Name | Type |
---|---|
connection | Connection |
Returns
Defined in
Parameters
Name | Type |
---|---|
connection | Connection |
pubkey | PublicKey |
Returns
Defined in
▸ nameEntryId(
namespaceName
, entryName
): Promise
<[PublicKey
, number
]>Parameters
Name | Type |
---|---|
namespaceName | string |
entryName | string |
Returns
Promise
<[PublicKey
, number
]>Defined in
▸ nameForDisplay(
connection
, pubkey
): Promise
<string
>Parameters
Name | Type |
---|---|
connection | Connection |
pubkey | PublicKey |
Returns
Promise
<string
>Defined in
▸
Const
reverseEntryId(address
): Promise
<[PublicKey
, number
]>Parameters
Name | Type |
---|---|
address | PublicKey |
Returns
Promise
<[PublicKey
, number
]>Defined in
▸ shortenAddress(
address
, chars?
): string
shorten the checksummed version of the input address to have 4 characters at start and end
Parameters
Name | Type | Default value |
---|---|---|
address | string | undefined |
chars | number | 5 |
Returns
string
Defined in