Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace tokenManager

Index

Namespaces

Enumerations

Type Aliases

Variables

Functions

Type Aliases

MintCounterData

MintCounterData: ParsedIdlAccountData<"mintCounter", TOKEN_MANAGER_PROGRAM>

MintManagerData

MintManagerData: ParsedIdlAccountData<"mintManager", TOKEN_MANAGER_PROGRAM>

TOKEN_MANAGER_PROGRAM

TOKEN_MANAGER_PROGRAM: TOKEN_MANAGER_TYPES.CardinalTokenManager

TokenManagerData

TokenManagerData: ParsedIdlAccountData<"tokenManager", TOKEN_MANAGER_PROGRAM>

TransferReceiptData

TransferReceiptData: ParsedIdlAccountData<"transferReceipt", TOKEN_MANAGER_PROGRAM>

Variables

Const CLAIM_RECEIPT_SEED

CLAIM_RECEIPT_SEED: "claim-receipt" = "claim-receipt"

Const CRANK_KEY

CRANK_KEY: PublicKey = ...

Const MINT_COUNTER_SEED

MINT_COUNTER_SEED: "mint-counter" = "mint-counter"

Const MINT_MANAGER_SEED

MINT_MANAGER_SEED: "mint-manager" = "mint-manager"

Const RECEIPT_MINT_MANAGER_SEED

RECEIPT_MINT_MANAGER_SEED: "receipt-mint-manager" = "receipt-mint-manager"

Const TOKEN_MANAGER_ADDRESS

TOKEN_MANAGER_ADDRESS: PublicKey = ...

Const TOKEN_MANAGER_IDL

TOKEN_MANAGER_IDL: CardinalTokenManager = TOKEN_MANAGER_TYPES.IDL

Const TOKEN_MANAGER_SEED

TOKEN_MANAGER_SEED: "token-manager" = "token-manager"

Const TRANSFER_RECEIPT_SEED

TRANSFER_RECEIPT_SEED: "transfer-receipt" = "transfer-receipt"

Functions

findRuleSetId

  • findRuleSetId(authority: PublicKey, name: string): PublicKey

findTokenRecordId

  • findTokenRecordId(mint: PublicKey, token: PublicKey): PublicKey

getRemainingAccountsForClaim

  • getRemainingAccountsForClaim(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>>>, recipientTokenAccountId: PublicKey, metadata: null | Metadata, claimReceiptId?: PublicKey): AccountMeta[]

  • Parameters

    • 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>>>
    • recipientTokenAccountId: PublicKey
    • metadata: null | Metadata
    • Optional claimReceiptId: PublicKey

    Returns AccountMeta[]

getRemainingAccountsForInvalidate

  • getRemainingAccountsForInvalidate(connection: Connection, wallet: Wallet, mintId: PublicKey): Promise<AccountMeta[]>

  • Convenience method to get remaining accounts for invalidation NOTE: This ignores token account creation and assumes that is handled outside. Use withRemainingAccountsForInvalidate to include token account creation in the current transaction

    Parameters

    • connection: Connection
    • wallet: Wallet
    • mintId: PublicKey

    Returns Promise<AccountMeta[]>

getRemainingAccountsForIssue

  • getRemainingAccountsForIssue(tokenManagerKind: TokenManagerKind, mintId: PublicKey, issuerTokenAccountId: PublicKey, tokenManagerTokenAccountId: PublicKey, rulesetId?: PublicKey): AccountMeta[]

getRemainingAccountsForKind

  • getRemainingAccountsForKind(mintId: PublicKey, tokenManagerKind: TokenManagerKind): AccountMeta[]

getRemainingAccountsForTransfer

  • getRemainingAccountsForTransfer(transferAuthority: null | PublicKey, tokenManagerId: PublicKey): AccountMeta[]

getRemainingAccountsForUnissue

  • getRemainingAccountsForUnissue(tokenManagerId: PublicKey, tokenManagerData: 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>>, metadata: null | Metadata): AccountMeta[]

  • Parameters

    • tokenManagerId: PublicKey
    • tokenManagerData: 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>>
    • metadata: null | Metadata

    Returns AccountMeta[]

remainingAccountForProgrammable

  • remainingAccountForProgrammable(mintId: PublicKey, fromTokenAccountId: PublicKey, toTokenAccountId: PublicKey, rulesetId: undefined | null | PublicKey): AccountMeta[]

  • Parameters

    • mintId: PublicKey
    • fromTokenAccountId: PublicKey
    • toTokenAccountId: PublicKey
    • rulesetId: undefined | null | PublicKey

    Returns AccountMeta[]

remainingAccountForProgrammableUnlockAndTransfer

  • remainingAccountForProgrammableUnlockAndTransfer(recipient: PublicKey, payer: PublicKey, mintId: PublicKey, fromTokenAccountId: PublicKey, rulesetId?: null | PublicKey): AccountMeta[]

  • Parameters

    • recipient: PublicKey
    • payer: PublicKey
    • mintId: PublicKey
    • fromTokenAccountId: PublicKey
    • Optional rulesetId: null | PublicKey

    Returns AccountMeta[]

tokenManagerProgram

  • tokenManagerProgram(connection: Connection, wallet?: Wallet, confirmOptions?: ConfirmOptions): Program<CardinalTokenManager>

withRemainingAccountsForInvalidate

  • withRemainingAccountsForInvalidate(transaction: Transaction, connection: Connection, wallet: Wallet, mintId: PublicKey, 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>>>, recipientTokenAccountOwnerId: PublicKey, metadata: null | Metadata): Promise<AccountMeta[]>

  • Parameters

    • transaction: Transaction
    • connection: Connection
    • wallet: Wallet
    • mintId: PublicKey
    • 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>>>
    • recipientTokenAccountOwnerId: PublicKey
    • metadata: null | Metadata

    Returns Promise<AccountMeta[]>

withRemainingAccountsForReturn

  • withRemainingAccountsForReturn(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>>>, recipientTokenAccountOwnerId?: PublicKey, rulesetId?: PublicKey): Promise<AccountMeta[]>

  • 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>>>
    • Optional recipientTokenAccountOwnerId: PublicKey
    • Optional rulesetId: PublicKey

    Returns Promise<AccountMeta[]>

Generated using TypeDoc