diff --git a/modules.html b/modules.html
index 60e8c962..c93bd4c2 100644
--- a/modules.html
+++ b/modules.html
@@ -1,8 +1,8 @@
-
Type Aliases Issue Parameters Issue
Parameters
: { amount
?: BN ; claimPayment
?: ClaimApproverParams ; customInvalidators
?: PublicKey [] ; invalidationType
?: InvalidationType ; issuerTokenAccountId
: PublicKey ; kind
?: TokenManagerKind ; mint
: PublicKey ; permissionedClaimApprover
?: PublicKey ; receiptOptions
?: { receiptMintKeypair
: Keypair } ; rulesetId
?: PublicKey ; timeInvalidation
?: TimeInvalidationParams ; transferAuthorityInfo
?: { creator
?: PublicKey ; transferAuthorityName
: string } ; useInvalidation
?: UseInvalidationParams ; visibility
?: "private" | "public" | "permissioned" } Type declaration Optional amount?: BN Optional custom Invalidators?: PublicKey [] issuer Token Account Id: PublicKey mint: PublicKey Optional permissioned Claim Approver?: PublicKey Optional receipt Options?: { receiptMintKeypair: Keypair } receipt Mint Keypair: Keypair Optional ruleset Id?: PublicKey Optional transfer Authority Info?: { creator?: PublicKey ; transferAuthorityName: string } Optional creator?: PublicKey transfer Authority Name: string Optional visibility?: "private" | "public" | "permissioned" Functions claim Token claim Token( connection: Connection , wallet: Wallet , tokenManagerId: PublicKey , additionalOptions?: { payer?: PublicKey } ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet tokenManagerId: PublicKey Optional additionalOptions: { payer?: PublicKey } Optional payer?: PublicKey Returns Promise < Transaction > extend Expiration extend Expiration( connection: Connection , wallet: Wallet , tokenManagerId: PublicKey , paymentAmount: number ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet tokenManagerId: PublicKey paymentAmount: number Returns Promise < Transaction > extend Usages extend Usages( connection: Connection , wallet: Wallet , tokenManagerId: PublicKey , usagesToAdd: number ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet tokenManagerId: PublicKey usagesToAdd: number Returns Promise < Transaction > invalidate invalidate( connection: Connection , wallet: Wallet , mintId: PublicKey ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet mintId: PublicKey Returns Promise < Transaction > issue Token issue Token( connection: Connection , wallet: Wallet , rentalParameters: IssueParameters ) : Promise < [ Transaction , PublicKey , undefined | Keypair ] > Parameters connection: Connection wallet: Wallet Returns Promise < [ Transaction , PublicKey , undefined | Keypair ] > release release( connection: Connection , wallet: Wallet , mintId: PublicKey , transferAuthorityId: PublicKey , listerTokenAccountId: PublicKey ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet mintId: PublicKey transferAuthorityId: PublicKey listerTokenAccountId: PublicKey Returns Promise < Transaction > unissue Token unissue Token( connection: Connection , wallet: Wallet , mintId: PublicKey ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet mintId: PublicKey Returns Promise < Transaction > use Transaction use Transaction( connection: Connection , wallet: Wallet , mintId: PublicKey , usages: number , collector?: PublicKey ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet mintId: PublicKey usages: number Optional collector: PublicKey Returns Promise < Transaction > with Accept Listing with Accept Listing( transaction: Transaction , connection: Connection , wallet: Wallet , buyer: PublicKey , mintId: PublicKey , paymentAmount: BN , paymentMint: PublicKey , buySideReceiver?: PublicKey , payer?: PublicKey ) : Promise < Transaction > Parameters transaction: Transaction connection: Connection wallet: Wallet buyer: PublicKey mintId: PublicKey paymentAmount: BN paymentMint: PublicKey Optional buySideReceiver: PublicKey payer: PublicKey = buyer Returns Promise < Transaction > with Accept Transfer with Accept Transfer( transaction: Transaction , connection: Connection , wallet: Wallet , mintId: PublicKey , recipient: PublicKey , holder: PublicKey ) : Promise < Transaction > Parameters transaction: Transaction connection: Connection wallet: Wallet mintId: PublicKey recipient: PublicKey holder: PublicKey Returns Promise < Transaction > with Cancel Transfer with Cancel Transfer( transaction: Transaction , connection: Connection , wallet: Wallet , mintId: PublicKey ) : Promise < Transaction > Parameters transaction: Transaction connection: Connection wallet: Wallet mintId: PublicKey Returns Promise < Transaction > with Claim Token with Claim Token( transaction: Transaction , connection: Connection , wallet: Wallet , tokenManagerId: PublicKey , additionalOptions?: { payer?: PublicKey } , buySideTokenAccountId?: PublicKey ) : Promise < Transaction > Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/modules/claimLinks.html b/modules/claimLinks.html
index f49b1841..8a92606c 100644
--- a/modules/claimLinks.html
+++ b/modules/claimLinks.html
@@ -1 +1 @@
-
claimLinks | @cardinal/token-manager - v4.5.1 Functions claim From Link claim From Link( connection: Connection , wallet: Wallet , tokenManagerId: PublicKey ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet tokenManagerId: PublicKey Returns Promise < Transaction > from Link from Link( link: string ) : [ PublicKey , Keypair ] Parameters Returns [ PublicKey , Keypair ] get Link get Link( tokenManagerId: PublicKey , otp: undefined | Keypair , cluster?: string , baseUrl?: string , collection?: string ) : string Parameters tokenManagerId: PublicKey otp: undefined | Keypair cluster: string = "devnet" baseUrl: string = "https://rent.cardinal.so" collection: string = "claim" Returns string issue Token issue Token( connection: Connection , wallet: Wallet , __namedParameters: { amount?: BN ; invalidationType?: InvalidationType ; issuerTokenAccountId: PublicKey ; kind?: TokenManagerKind ; mint: PublicKey ; useInvalidation?: UseInvalidationParams } ) : Promise < [ Transaction , PublicKey , Keypair ] > Parameters connection: Connection wallet: Wallet __namedParameters: { amount?: BN ; invalidationType?: InvalidationType ; issuerTokenAccountId: PublicKey ; kind?: TokenManagerKind ; mint: PublicKey ; useInvalidation?: UseInvalidationParams } Optional amount?: BN issuer Token Account Id: PublicKey mint: PublicKey Returns Promise < [ Transaction , PublicKey , Keypair ] > Settings Theme OS Light Dark
\ No newline at end of file
+
claimLinks | @cardinal/token-manager - v4.6.0 Functions claim From Link claim From Link( connection: Connection , wallet: Wallet , tokenManagerId: PublicKey ) : Promise < Transaction > Parameters connection: Connection wallet: Wallet tokenManagerId: PublicKey Returns Promise < Transaction > from Link from Link( link: string ) : [ PublicKey , Keypair ] Parameters Returns [ PublicKey , Keypair ] get Link get Link( tokenManagerId: PublicKey , otp: undefined | Keypair , cluster?: string , baseUrl?: string , collection?: string ) : string Parameters tokenManagerId: PublicKey otp: undefined | Keypair cluster: string = "devnet" baseUrl: string = "https://rent.cardinal.so" collection: string = "claim" Returns string issue Token issue Token( connection: Connection , wallet: Wallet , __namedParameters: { amount?: BN ; invalidationType?: InvalidationType ; issuerTokenAccountId: PublicKey ; kind?: TokenManagerKind ; mint: PublicKey ; useInvalidation?: UseInvalidationParams } ) : Promise < [ Transaction , PublicKey , Keypair ] > Parameters connection: Connection wallet: Wallet __namedParameters: { amount?: BN ; invalidationType?: InvalidationType ; issuerTokenAccountId: PublicKey ; kind?: TokenManagerKind ; mint: PublicKey ; useInvalidation?: UseInvalidationParams } Optional amount?: BN issuer Token Account Id: PublicKey mint: PublicKey Returns Promise < [ Transaction , PublicKey , Keypair ] > Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/modules/programs.claimApprover.accounts.html b/modules/programs.claimApprover.accounts.html
index 76c4f312..3ea0beb6 100644
--- a/modules/programs.claimApprover.accounts.html
+++ b/modules/programs.claimApprover.accounts.html
@@ -1 +1 @@
-
accounts | @cardinal/token-manager - v4.5.1 Functions get All Claim Approvers get All Claim Approvers( connection: Connection ) : Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > Parameters Returns Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > get Claim Approver get Claim Approver( connection: Connection , tokenManagerId: PublicKey ) : Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > > Parameters connection: Connection tokenManagerId: PublicKey Returns Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > > get Claim Approvers get Claim Approvers( connection: Connection , claimApproverIds: PublicKey [] ) : Promise < AccountData < null | DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > Parameters connection: Connection claimApproverIds: PublicKey [] Returns Promise < AccountData < null | DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > Settings Theme OS Light Dark
\ No newline at end of file
+
accounts | @cardinal/token-manager - v4.6.0 Functions get All Claim Approvers get All Claim Approvers( connection: Connection ) : Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > Parameters Returns Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > get Claim Approver get Claim Approver( connection: Connection , tokenManagerId: PublicKey ) : Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > > Parameters connection: Connection tokenManagerId: PublicKey Returns Promise < AccountData < DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > > get Claim Approvers get Claim Approvers( connection: Connection , claimApproverIds: PublicKey [] ) : Promise < AccountData < null | DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > Parameters connection: Connection claimApproverIds: PublicKey [] Returns Promise < AccountData < null | DecodeStruct < { fields: [ { name: "bump" ; type: "u8" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentMint" ; type: "publicKey" } , { name: "paymentManager" ; type: "publicKey" } , { name: "tokenManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } , DecodedHelper < [ { name: "InitIx" ; type: { fields: [ { name: "paymentMint" ; type: "publicKey" } , { name: "paymentAmount" ; type: "u64" } , { name: "paymentManager" ; type: "publicKey" } , { name: "collector" ; type: "publicKey" } ] ; kind: "struct" } } ] , EmptyDefined > > > [] > Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/modules/programs.claimApprover.html b/modules/programs.claimApprover.html
index 99a1ce83..0ec317ae 100644
--- a/modules/programs.claimApprover.html
+++ b/modules/programs.claimApprover.html
@@ -1 +1 @@
-
claimApprover | @cardinal/token-manager - v4.5.1 Type Aliases CLAIM_ APPROVER_ PROGRAM CLAIM_ APPROVER_ PROGRAM: CLAIM_APPROVER_TYPES.CardinalPaidClaimApprover
Claim Approver Params Claim Approver Params: { collector?: PublicKey ; paymentAmount: number ; paymentManager?: PublicKey ; paymentMint: PublicKey }
Type declaration Optional collector?: PublicKey payment Amount: number Optional payment Manager?: PublicKey payment Mint: PublicKey Variables Const CLAIM_ APPROVER_ ADDRESSCLAIM_ APPROVER_ ADDRESS: PublicKey = ...
Const CLAIM_ APPROVER_ IDLCLAIM_ APPROVER_ IDL: CardinalPaidClaimApprover = CLAIM_APPROVER_TYPES.IDL
Const CLAIM_ APPROVER_ SEEDCLAIM_ APPROVER_ SEED: "paid-claim-approver" = "paid-claim-approver"
Const default Payment Manager Iddefault Payment Manager Id: PublicKey = ...
Functions claim Approver Program claim Approver Program( connection: Connection , wallet?: Wallet , confirmOptions?: ConfirmOptions ) : Program < CardinalPaidClaimApprover > Parameters connection: Connection Optional wallet: Wallet Optional confirmOptions: ConfirmOptions Returns Program < CardinalPaidClaimApprover > Settings Theme OS Light Dark
\ No newline at end of file
+
claimApprover | @cardinal/token-manager - v4.6.0 Type Aliases CLAIM_ APPROVER_ PROGRAM CLAIM_ APPROVER_ PROGRAM: CLAIM_APPROVER_TYPES.CardinalPaidClaimApprover
Claim Approver Params Claim Approver Params: { collector?: PublicKey ; paymentAmount: number ; paymentManager?: PublicKey ; paymentMint: PublicKey }
Type declaration Optional collector?: PublicKey payment Amount: number Optional payment Manager?: PublicKey payment Mint: PublicKey Variables Const CLAIM_ APPROVER_ ADDRESSCLAIM_ APPROVER_ ADDRESS: PublicKey = ...
Const CLAIM_ APPROVER_ IDLCLAIM_ APPROVER_ IDL: CardinalPaidClaimApprover = CLAIM_APPROVER_TYPES.IDL
Const CLAIM_ APPROVER_ SEEDCLAIM_ APPROVER_ SEED: "paid-claim-approver" = "paid-claim-approver"
Const default Payment Manager Iddefault Payment Manager Id: PublicKey = ...
Functions claim Approver Program claim Approver Program( connection: Connection , wallet?: Wallet , confirmOptions?: ConfirmOptions ) : Program < CardinalPaidClaimApprover > Parameters connection: Connection Optional wallet: Wallet Optional confirmOptions: ConfirmOptions Returns Program < CardinalPaidClaimApprover > Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/modules/programs.claimApprover.pda.html b/modules/programs.claimApprover.pda.html
index 9a28d1cd..50ece10f 100644
--- a/modules/programs.claimApprover.pda.html
+++ b/modules/programs.claimApprover.pda.html
@@ -1,3 +1,3 @@
-
pda | @cardinal/token-manager - v4.5.1 Functions find Claim Approver Address find Claim Approver Address( tokenManagerId: PublicKey ) : PublicKey
- Preparing search index...
- The search index is not available
@cardinal/token-manager - v4.6.0@cardinal/token-manager - v4.6.0
Index
Namespaces
Type Aliases
Functions
Type Aliases
Issue Parameters
Type declaration
Optional amount?: BN
Optional claim Payment?: ClaimApproverParams
Optional custom Invalidators?: PublicKey[]
Optional invalidation Type?: InvalidationType
issuer Token Account Id: PublicKey
Optional kind?: TokenManagerKind
mint: PublicKey
Optional permissioned Claim Approver?: PublicKey
Optional receipt Options?: { receiptMintKeypair: Keypair }
receipt Mint Keypair: Keypair
Optional ruleset Id?: PublicKey
Optional time Invalidation?: TimeInvalidationParams
Optional transfer Authority Info?: { creator?: PublicKey; transferAuthorityName: string }
Optional creator?: PublicKey
transfer Authority Name: string
Optional use Invalidation?: UseInvalidationParams
Optional visibility?: "private" | "public" | "permissioned"
Functions
claim Token
Parameters
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
Optional additionalOptions: { payer?: PublicKey }
Optional payer?: PublicKey
Returns Promise<Transaction>
extend Expiration
Parameters
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
paymentAmount: number
Returns Promise<Transaction>
extend Usages
Parameters
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
usagesToAdd: number
Returns Promise<Transaction>
invalidate
Parameters
connection: Connection
wallet: Wallet
mintId: PublicKey
Returns Promise<Transaction>
issue Token
Parameters
connection: Connection
wallet: Wallet
rentalParameters: IssueParameters
Returns Promise<[Transaction, PublicKey, undefined | Keypair]>
release
Parameters
connection: Connection
wallet: Wallet
mintId: PublicKey
transferAuthorityId: PublicKey
listerTokenAccountId: PublicKey
Returns Promise<Transaction>
unissue Token
Parameters
connection: Connection
wallet: Wallet
mintId: PublicKey
Returns Promise<Transaction>
use Transaction
Parameters
connection: Connection
wallet: Wallet
mintId: PublicKey
usages: number
Optional collector: PublicKey
Returns Promise<Transaction>
with Accept Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
buyer: PublicKey
mintId: PublicKey
paymentAmount: BN
paymentMint: PublicKey
Optional buySideReceiver: PublicKey
payer: PublicKey = buyer
Returns Promise<Transaction>
with Accept Transfer
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
recipient: PublicKey
holder: PublicKey
Returns Promise<Transaction>
with Cancel Transfer
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Returns Promise<Transaction>
with Claim Token
Add claim instructions to a transaction
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
Optional additionalOptions: { payer?: PublicKey }
Optional payer?: PublicKey
Optional buySideTokenAccountId: PublicKey
Returns Promise<Transaction>
Transaction with relevent claim instructions added
-with Create Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
markeptlaceName: string
paymentAmount: BN
paymentMint: PublicKey = PublicKey.default
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey]>
with Delegate
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
recipient: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Extend Expiration
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
secondsToAdd: number
Optional options: { payer?: PublicKey }
Optional payer?: PublicKey
Optional buySideTokenAccountId: PublicKey
Returns Promise<Transaction>
with Extend Usages
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
usagesToAdd: number
Optional options: { payer?: PublicKey }
Optional payer?: PublicKey
Optional buySideTokenAccountId: PublicKey
Returns Promise<Transaction>
with Init Marketplace
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
paymentManagerName: string
Optional paymentMints: PublicKey[]
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey]>
with Init Transfer
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
to: PublicKey
mintId: PublicKey
holderTokenAccountId: PublicKey
payer: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Init Transfer Authority
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
authority: PublicKey = wallet.publicKey
payer: PublicKey = wallet.publicKey
Optional allowedMarketplaces: PublicKey[]
Returns Promise<[Transaction, PublicKey]>
with Invalidate
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
UTCNow: number = ...
Returns Promise<Transaction>
with Issue Token
with Create Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
markeptlaceName: string
paymentAmount: BN
paymentMint: PublicKey = PublicKey.default
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey]>
with Delegate
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
recipient: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Extend Expiration
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
secondsToAdd: number
Optional options: { payer?: PublicKey }
Optional payer?: PublicKey
Optional buySideTokenAccountId: PublicKey
Returns Promise<Transaction>
with Extend Usages
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
usagesToAdd: number
Optional options: { payer?: PublicKey }
Optional payer?: PublicKey
Optional buySideTokenAccountId: PublicKey
Returns Promise<Transaction>
with Init Marketplace
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
paymentManagerName: string
Optional paymentMints: PublicKey[]
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey]>
with Init Transfer
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
to: PublicKey
mintId: PublicKey
holderTokenAccountId: PublicKey
payer: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Init Transfer Authority
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
authority: PublicKey = wallet.publicKey
payer: PublicKey = wallet.publicKey
Optional allowedMarketplaces: PublicKey[]
Returns Promise<[Transaction, PublicKey]>
with Invalidate
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
UTCNow: number = ...
Returns Promise<Transaction>
with Issue Token
Main method for issuing any managed token Allows for optional payment, optional usages or expiration and includes a otp for private links
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
__namedParameters: IssueParameters
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey, undefined | Keypair]>
Transaction, public key for the created token manager and a otp if necessary for private links
-with Release
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
transferAuthorityId: PublicKey
holderTokenAccountId: PublicKey
payer: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Remove Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
listerMintTokenAccountId: PublicKey
Returns Promise<Transaction>
with Replace Invalidator
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
newInvalidator: PublicKey
Returns Promise<Transaction>
with Reset Expiration
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
Returns Promise<Transaction>
with Return
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerData: AccountData<DecodeStruct<{ fields: [{ name: "version"; type: "u8" }, { name: "bump"; type: "u8" }, { name: "count"; type: "u64" }, { name: "numInvalidators"; type: "u8" }, { name: "issuer"; type: "publicKey" }, { name: "mint"; type: "publicKey" }, { name: "amount"; type: "u64" }, { name: "kind"; type: "u8" }]; kind: "struct" }, DecodedHelper<[{ name: "InitIx"; type: { fields: [{ name: "amount"; type: "u64" }, { name: "kind"; type: "u8" }, { name: "invalidationType"; type: "u8" }, { name: "numInvalidators"; type: "u8" }]; kind: "struct" } }, { name: "TokenManagerState"; type: { kind: "enum"; variants: [{ name: "Initialized" }, { name: "Issued" }, { name: "Claimed" }, { name: "Invalidated" }] } }, { name: "TokenManagerKind"; type: { kind: "enum"; variants: [{ name: "Managed" }, { name: "Unmanaged" }, { name: "Edition" }, { name: "Permissioned" }, { name: "Programmable" }] } }, { name: "InvalidationType"; type: { kind: "enum"; variants: [{ name: "Return" }, { name: "Invalidate" }, { name: "Release" }, { name: "Reissue" }, { name: "Vest" }] } }], EmptyDefined>>>
Returns Promise<Transaction>
with Send
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
senderTokenAccountId: PublicKey
target: PublicKey
Returns Promise<Transaction>
with Transfer
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
recipient: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Undelegate
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Optional recipient: PublicKey
Returns Promise<Transaction>
with Unissue Token
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Returns Promise<Transaction>
with Update Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
marketplaceId: PublicKey
paymentAmount: BN
paymentMint: PublicKey
Returns Promise<Transaction>
with Update Marketplace
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
paymentManagerName: string
authority: PublicKey
paymentMints: PublicKey[]
Returns Promise<Transaction>
with Update Max Expiration
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
newMaxExpiration: BN
Returns Promise<Transaction>
with Update Transfer Authority
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
authority: PublicKey
Optional allowedMarketplaces: PublicKey[]
Returns Promise<Transaction>
with Use
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
usages: number
Optional collector: PublicKey
Returns Promise<Transaction>
with Whitelist Marektplaces
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
transferAuthorityName: string
marketplaceNames: string[]
Returns Promise<Transaction>
with Wrap Token
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Optional transferAuthorityInfo: { creator?: PublicKey; transferAuthorityName: string }
Optional creator?: PublicKey
transfer Authority Name: string
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey]>
Generated using TypeDoc
with Release
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
transferAuthorityId: PublicKey
holderTokenAccountId: PublicKey
payer: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Remove Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
listerMintTokenAccountId: PublicKey
Returns Promise<Transaction>
with Replace Invalidator
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
newInvalidator: PublicKey
Returns Promise<Transaction>
with Reset Expiration
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
Returns Promise<Transaction>
with Return
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerData: AccountData<DecodeStruct<{ fields: [{ name: "version"; type: "u8" }, { name: "bump"; type: "u8" }, { name: "count"; type: "u64" }, { name: "numInvalidators"; type: "u8" }, { name: "issuer"; type: "publicKey" }, { name: "mint"; type: "publicKey" }, { name: "amount"; type: "u64" }, { name: "kind"; type: "u8" }]; kind: "struct" }, DecodedHelper<[{ name: "InitIx"; type: { fields: [{ name: "amount"; type: "u64" }, { name: "kind"; type: "u8" }, { name: "invalidationType"; type: "u8" }, { name: "numInvalidators"; type: "u8" }]; kind: "struct" } }, { name: "TokenManagerState"; type: { kind: "enum"; variants: [{ name: "Initialized" }, { name: "Issued" }, { name: "Claimed" }, { name: "Invalidated" }] } }, { name: "TokenManagerKind"; type: { kind: "enum"; variants: [{ name: "Managed" }, { name: "Unmanaged" }, { name: "Edition" }, { name: "Permissioned" }, { name: "Programmable" }] } }, { name: "InvalidationType"; type: { kind: "enum"; variants: [{ name: "Return" }, { name: "Invalidate" }, { name: "Release" }, { name: "Reissue" }, { name: "Vest" }] } }], EmptyDefined>>>
Returns Promise<Transaction>
with Send
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
senderTokenAccountId: PublicKey
target: PublicKey
Returns Promise<Transaction>
with Transfer
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
recipient: PublicKey = wallet.publicKey
Returns Promise<Transaction>
with Undelegate
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Optional recipient: PublicKey
Returns Promise<Transaction>
with Unissue Token
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Returns Promise<Transaction>
with Update Listing
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
marketplaceId: PublicKey
paymentAmount: BN
paymentMint: PublicKey
Returns Promise<Transaction>
with Update Marketplace
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
paymentManagerName: string
authority: PublicKey
paymentMints: PublicKey[]
Returns Promise<Transaction>
with Update Max Expiration
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
tokenManagerId: PublicKey
newMaxExpiration: BN
Returns Promise<Transaction>
with Update Transfer Authority
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
name: string
authority: PublicKey
Optional allowedMarketplaces: PublicKey[]
Returns Promise<Transaction>
with Use
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
usages: number
Optional collector: PublicKey
Returns Promise<Transaction>
with Whitelist Marektplaces
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
transferAuthorityName: string
marketplaceNames: string[]
Returns Promise<Transaction>
with Wrap Token
Parameters
transaction: Transaction
connection: Connection
wallet: Wallet
mintId: PublicKey
Optional transferAuthorityInfo: { creator?: PublicKey; transferAuthorityName: string }
Optional creator?: PublicKey
transfer Authority Name: string
payer: PublicKey = wallet.publicKey
Returns Promise<[Transaction, PublicKey]>