SPLToken2022ExtensionsProgram class

Inheritance

• Object
• TransactionInstruction
• SPLToken2022ExtensionsProgram

Constructors

SPLToken2022ExtensionsProgram({required List<AccountMeta> keys, required SolAddress programId, required ProgramLayout layout})

SPLToken2022ExtensionsProgram.execute({required SolAddress mint, required SolAddress source, required SolAddress destination, required SolAddress owner, required SolAddress validateStatePubkey, required SPLToken2022ExecuteLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

factory

SPLToken2022ExtensionsProgram.harvestWithheldTokensToMint({required SolAddress mint, required List<SolAddress> sources, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Permissionless instruction to transfer all withheld tokens to the mint.

factory

SPLToken2022ExtensionsProgram.initializeDefaultAccountState({required SolAddress mint, required SPLToken2022InitializeDefaultAccountStateLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Initialize a new mint with the default state for new Accounts.

factory

SPLToken2022ExtensionsProgram.initializeGroupMemberPointer({required SolAddress mint, required SPLToken2022InitializeGroupMemberPointerLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

factory

SPLToken2022ExtensionsProgram.initializeGroupPointer({required SolAddress mint, required SPLToken2022InitializeGroupPointerLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Initialize GroupPointer instruction

factory

SPLToken2022ExtensionsProgram.initializeInterestBearingMint({required SolAddress mint, required SPLToken2022InterestBearingMintInitializeLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Initialize a new mint with interest accrual.

factory

SPLToken2022ExtensionsProgram.initializeMetadataPointer({required SolAddress mint, required SPLToken2022InitializeMetadataPointerLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Initialize a new mint with a metadata pointer

factory

SPLToken2022ExtensionsProgram.initializeTransferFeeConfig({required SolAddress mint, required SPLToken2022InitializeTransferFeeConfigLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Initialize the transfer fee on a new mint.

factory

SPLToken2022ExtensionsProgram.initializeTransferHook({required SolAddress mint, required SPLToken2022InitializeTransferHookLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId})

Initialize a new mint with a transfer hook program.

factory

SPLToken2022ExtensionsProgram.toggleCpiGuard({required SolAddress account, required SolAddress authority, required SPLToken2022ToggleCpiGuardLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Allow or lock all token operations to happen via CPI as normal.

factory

SPLToken2022ExtensionsProgram.toggleMemoTransfers({required SolAddress account, required SolAddress authority, required SPLToken2022ToggleMemoTransferLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Require memos or Stop requiring memos for transfers into this Account.

factory

SPLToken2022ExtensionsProgram.transferCheckedWithFee({required SolAddress source, required SolAddress mint, required SolAddress destination, required SolAddress authority, required SPLToken2022TransferCheckedWithFeeLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Transfer, providing expected mint information and fees

factory

SPLToken2022ExtensionsProgram.updateDefaultAccountState({required SolAddress mint, required SolAddress freezeAuthority, required SPLToken2022UpdateDefaultAccountStateLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Update the default state for new Accounts. Only supported for mints that include the DefaultAccountState extension.

factory

SPLToken2022ExtensionsProgram.updateGroupMemberPointer({required SolAddress mint, required SolAddress authority, required SPLToken2022UpdateGroupMemberPointerLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

factory

SPLToken2022ExtensionsProgram.updateGroupPointer({required SolAddress mint, required SolAddress authority, required SPLToken2022UpdateGroupPointerLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Update GroupPointer instruction

factory

SPLToken2022ExtensionsProgram.updateMetadataPointer({required SolAddress mint, required SolAddress authority, required SPLToken2022UpdateMetadataPointerLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Update the metadata pointer address. Only supported for mints that include the MetadataPointer extension.

factory

SPLToken2022ExtensionsProgram.updateRateInterestBearingMint({required SolAddress mint, required SolAddress rateAuthority, required SPLToken2022InterestBearingMintUpdateRateLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Update the interest rate. Only supported for mints that include the InterestBearingConfig extension.

factory

SPLToken2022ExtensionsProgram.updateTransferHook({required SolAddress mint, required SolAddress authority, required SPLToken2022UpdateTransferHookLayout layout, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Update the transfer hook program id. Only supported for mints that include the TransferHook extension.

factory

SPLToken2022ExtensionsProgram.withdrawWithheldTokensFromAccounts({required SolAddress mint, required SolAddress destination, required SolAddress authority, required List<SolAddress> sources, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Transfer all withheld tokens to an account. Signed by the mint's withdraw withheld tokens authority.

factory

SPLToken2022ExtensionsProgram.withdrawWithheldTokensFromMint({required SolAddress mint, required SolAddress destination, required SolAddress authority, SolAddress programId = SPLTokenProgramConst.token2022ProgramId, List<SolAddress> multiSigners = const []})

Transfer all withheld tokens in the mint to an account. Signed by the mint's withdraw withheld tokens authority.

factory

Properties

data → List<int>

Program input.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

keys → List<AccountMeta>

Public keys to include in this transaction Boolean represents whether this pubkey needs to sign the transaction

final, inherited

layout → ProgramLayout

Program layout.

final, inherited

programId → SolAddress

Program Id to execute.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited