extension

Call Signature

function extension(kind): {
  __kind: "Uninitialized";
};

Parameters

Parameter	Type
`kind`	`"Uninitialized"`

Returns

{
  __kind: "Uninitialized";
}

Name	Type
`__kind`	`"Uninitialized"`

Call Signature

function extension(kind, data): {
  __kind: "TransferFeeConfig";
  newerTransferFee: TransferFeeArgs;
  olderTransferFee: TransferFeeArgs;
  transferFeeConfigAuthority: Address;
  withdrawWithheldAuthority: Address;
  withheldAmount: number | bigint;
};

Parameters

Parameter	Type
`kind`	`"TransferFeeConfig"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TransferFeeConfig"`>

Returns

Name	Type	Description
`__kind`	`"TransferFeeConfig"`	-
`newerTransferFee`	`TransferFeeArgs`	Newer transfer fee, used if the current epoch >= newerTransferFee.epoch.
`olderTransferFee`	`TransferFeeArgs`	Older transfer fee, used if the current epoch < newerTransferFee.epoch.
`transferFeeConfigAuthority`	`Address`	Optional authority to set the fee.
`withdrawWithheldAuthority`	`Address`	Withdraw from mint instructions must be signed by this key.
`withheldAmount`	`number` \| `bigint`	Withheld transfer fee tokens that have been moved to the mint for withdrawal.

Call Signature

function extension(kind, data): {
  __kind: "TransferFeeAmount";
  withheldAmount: number | bigint;
};

Parameters

Parameter	Type
`kind`	`"TransferFeeAmount"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TransferFeeAmount"`>

Returns

Name	Type	Description
`__kind`	`"TransferFeeAmount"`	-
`withheldAmount`	`number` \| `bigint`	Withheld transfer fee tokens that can be claimed by the fee authority.

Call Signature

function extension(kind, data): {
  __kind: "MintCloseAuthority";
  closeAuthority: Address;
};

Parameters

Parameter	Type
`kind`	`"MintCloseAuthority"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"MintCloseAuthority"`>

Returns

{
  __kind: "MintCloseAuthority";
  closeAuthority: Address;
}

Name	Type
`__kind`	`"MintCloseAuthority"`
`closeAuthority`	`Address`

Call Signature

function extension(kind, data): {
  __kind: "ConfidentialTransferMint";
  auditorElgamalPubkey: OptionOrNullable<Address>;
  authority: OptionOrNullable<Address>;
  autoApproveNewAccounts: boolean;
};

Parameters

Parameter	Type
`kind`	`"ConfidentialTransferMint"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"ConfidentialTransferMint"`>

Returns

Name	Type	Description
`__kind`	`"ConfidentialTransferMint"`	-
`auditorElgamalPubkey`	`OptionOrNullable`<`Address`>	Authority to decode any transfer amount in a confidential transfer.
`authority`	`OptionOrNullable`<`Address`>	Authority to modify the `ConfidentialTransferMint` configuration and to approve new accounts (if `auto_approve_new_accounts` is true). The legacy Token Multisig account is not supported as the authority.
`autoApproveNewAccounts`	`boolean`	Indicate if newly configured accounts must be approved by the `authority` before they may be used by the user. * If `true`, no approval is required and new accounts may be used immediately. * If `false`, the authority must approve newly configured accounts (see `ConfidentialTransferInstruction::ConfigureAccount`).

Call Signature

function extension(kind, data): {
  __kind: "ConfidentialTransferAccount";
  actualPendingBalanceCreditCounter: number | bigint;
  allowConfidentialCredits: boolean;
  allowNonConfidentialCredits: boolean;
  approved: boolean;
  availableBalance: ReadonlyUint8Array;
  decryptableAvailableBalance: ReadonlyUint8Array;
  elgamalPubkey: Address;
  expectedPendingBalanceCreditCounter: number | bigint;
  maximumPendingBalanceCreditCounter: number | bigint;
  pendingBalanceCreditCounter: number | bigint;
  pendingBalanceHigh: ReadonlyUint8Array;
  pendingBalanceLow: ReadonlyUint8Array;
};

Parameters

Parameter	Type
`kind`	`"ConfidentialTransferAccount"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"ConfidentialTransferAccount"`>

Returns

Name	Type	Description
`__kind`	`"ConfidentialTransferAccount"`	-
`actualPendingBalanceCreditCounter`	`number` \| `bigint`	The actual `pending_balance_credit_counter` when the last `ApplyPendingBalance` instruction was executed.
`allowConfidentialCredits`	`boolean`	If `false`, the extended account rejects any incoming confidential transfers.
`allowNonConfidentialCredits`	`boolean`	If `false`, the base account rejects any incoming transfers.
`approved`	`boolean`	`true` if this account has been approved for use. All confidential transfer operations for the account will fail until approval is granted.
`availableBalance`	`ReadonlyUint8Array`	The available balance (encrypted by `encrypiton_pubkey`).
`decryptableAvailableBalance`	`ReadonlyUint8Array`	The decryptable available balance.
`elgamalPubkey`	`Address`	The public key associated with ElGamal encryption.
`expectedPendingBalanceCreditCounter`	`number` \| `bigint`	The `expected_pending_balance_credit_counter` value that was included in the last `ApplyPendingBalance` instruction.
`maximumPendingBalanceCreditCounter`	`number` \| `bigint`	The maximum number of `Deposit` and `Transfer` instructions that can credit `pending_balance` before the `ApplyPendingBalance` instruction is executed.
`pendingBalanceCreditCounter`	`number` \| `bigint`	The total number of `Deposit` and `Transfer` instructions that have credited `pending_balance`.
`pendingBalanceHigh`	`ReadonlyUint8Array`	The high 48 bits of the pending balance (encrypted by `elgamal_pubkey`).
`pendingBalanceLow`	`ReadonlyUint8Array`	The low 16 bits of the pending balance (encrypted by `elgamal_pubkey`).

Call Signature

function extension(kind, data): {
  __kind: "DefaultAccountState";
  state: AccountState;
};

Parameters

Parameter	Type
`kind`	`"DefaultAccountState"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"DefaultAccountState"`>

Returns

{
  __kind: "DefaultAccountState";
  state: AccountState;
}

Name	Type
`__kind`	`"DefaultAccountState"`
`state`	`AccountState`

Call Signature

function extension(kind, data): {
  __kind: "ImmutableOwner";
};

Parameters

Parameter	Type
`kind`	`"ImmutableOwner"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"ImmutableOwner"`>

Returns

{
  __kind: "ImmutableOwner";
}

Name	Type
`__kind`	`"ImmutableOwner"`

Call Signature

function extension(kind, data): {
  __kind: "MemoTransfer";
  requireIncomingTransferMemos: boolean;
};

Parameters

Parameter	Type
`kind`	`"MemoTransfer"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"MemoTransfer"`>

Returns

Name	Type	Description
`__kind`	`"MemoTransfer"`	-
`requireIncomingTransferMemos`	`boolean`	Require transfers into this account to be accompanied by a memo.

Call Signature

function extension(kind, data): {
  __kind: "NonTransferable";
};

Parameters

Parameter	Type
`kind`	`"NonTransferable"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"NonTransferable"`>

Returns

{
  __kind: "NonTransferable";
}

Name	Type
`__kind`	`"NonTransferable"`

Call Signature

function extension(kind, data): {
  __kind: "InterestBearingConfig";
  currentRate: number;
  initializationTimestamp: number | bigint;
  lastUpdateTimestamp: number | bigint;
  preUpdateAverageRate: number;
  rateAuthority: Address;
};

Parameters

Parameter	Type
`kind`	`"InterestBearingConfig"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"InterestBearingConfig"`>

Returns

{
  __kind: "InterestBearingConfig";
  currentRate: number;
  initializationTimestamp: number | bigint;
  lastUpdateTimestamp: number | bigint;
  preUpdateAverageRate: number;
  rateAuthority: Address;
}

Name	Type
`__kind`	`"InterestBearingConfig"`
`currentRate`	`number`
`initializationTimestamp`	`number` \| `bigint`
`lastUpdateTimestamp`	`number` \| `bigint`
`preUpdateAverageRate`	`number`
`rateAuthority`	`Address`

Call Signature

function extension(kind, data): {
  __kind: "CpiGuard";
  lockCpi: boolean;
};

Parameters

Parameter	Type
`kind`	`"CpiGuard"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"CpiGuard"`>

Returns

Name	Type	Description
`__kind`	`"CpiGuard"`	-
`lockCpi`	`boolean`	Lock certain token operations from taking place within CPI for this account.

Call Signature

function extension(kind, data): {
  __kind: "PermanentDelegate";
  delegate: Address;
};

Parameters

Parameter	Type
`kind`	`"PermanentDelegate"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"PermanentDelegate"`>

Returns

{
  __kind: "PermanentDelegate";
  delegate: Address;
}

Name	Type
`__kind`	`"PermanentDelegate"`
`delegate`	`Address`

Call Signature

function extension(kind, data): {
  __kind: "NonTransferableAccount";
};

Parameters

Parameter	Type
`kind`	`"NonTransferableAccount"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"NonTransferableAccount"`>

Returns

{
  __kind: "NonTransferableAccount";
}

Name	Type
`__kind`	`"NonTransferableAccount"`

Call Signature

function extension(kind, data): {
  __kind: "TransferHook";
  authority: Address;
  programId: Address;
};

Parameters

Parameter	Type
`kind`	`"TransferHook"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TransferHook"`>

Returns

Name	Type	Description
`__kind`	`"TransferHook"`	-
`authority`	`Address`	The transfer hook update authority.
`programId`	`Address`	The transfer hook program account.

Call Signature

function extension(kind, data): {
  __kind: "TransferHookAccount";
  transferring: boolean;
};

Parameters

Parameter	Type
`kind`	`"TransferHookAccount"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TransferHookAccount"`>

Returns

Name	Type	Description
`__kind`	`"TransferHookAccount"`	-
`transferring`	`boolean`	Whether or not this account is currently transferring tokens True during the transfer hook cpi, otherwise false.

Call Signature

function extension(kind, data): {
  __kind: "ConfidentialTransferFee";
  authority: OptionOrNullable<Address>;
  elgamalPubkey: Address;
  harvestToMintEnabled: boolean;
  withheldAmount: ReadonlyUint8Array;
};

Parameters

Parameter	Type
`kind`	`"ConfidentialTransferFee"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"ConfidentialTransferFee"`>

Returns

Name	Type	Description
`__kind`	`"ConfidentialTransferFee"`	-
`authority`	`OptionOrNullable`<`Address`>	Optional authority to set the withdraw withheld authority ElGamal key.
`elgamalPubkey`	`Address`	Withheld fees from accounts must be encrypted with this ElGamal key. Note that whoever holds the ElGamal private key for this ElGamal public key has the ability to decode any withheld fee amount that are associated with accounts. When combined with the fee parameters, the withheld fee amounts can reveal information about transfer amounts.
`harvestToMintEnabled`	`boolean`	If `false`, the harvest of withheld tokens to mint is rejected.
`withheldAmount`	`ReadonlyUint8Array`	Withheld confidential transfer fee tokens that have been moved to the mint for withdrawal.

Call Signature

function extension(kind, data): {
  __kind: "ConfidentialTransferFeeAmount";
  withheldAmount: ReadonlyUint8Array;
};

Parameters

Parameter	Type
`kind`	`"ConfidentialTransferFeeAmount"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"ConfidentialTransferFeeAmount"`>

Returns

Name	Type	Description
`__kind`	`"ConfidentialTransferFeeAmount"`	-
`withheldAmount`	`ReadonlyUint8Array`	Amount withheld during confidential transfers, to be harvest to the mint.

Call Signature

function extension(kind, data): {
  __kind: "MetadataPointer";
  authority: OptionOrNullable<Address>;
  metadataAddress: OptionOrNullable<Address>;
};

Parameters

Parameter	Type
`kind`	`"MetadataPointer"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"MetadataPointer"`>

Returns

Name	Type	Description
`__kind`	`"MetadataPointer"`	-
`authority`	`OptionOrNullable`<`Address`>	Optional authority that can set the metadata address.
`metadataAddress`	`OptionOrNullable`<`Address`>	Optional Account Address that holds the metadata.

Call Signature

function extension(kind, data): {
  __kind: "TokenMetadata";
  additionalMetadata: Map<string, string>;
  mint: Address;
  name: string;
  symbol: string;
  updateAuthority: OptionOrNullable<Address>;
  uri: string;
};

Parameters

Parameter	Type
`kind`	`"TokenMetadata"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TokenMetadata"`>

Returns

Name	Type	Description
`__kind`	`"TokenMetadata"`	-
`additionalMetadata`	`Map`<`string`, `string`>	Any additional metadata about the token as key-value pairs.
`mint`	`Address`	The associated mint, used to counter spoofing to be sure that metadata belongs to a particular mint.
`name`	`string`	The longer name of the token.
`symbol`	`string`	The shortened symbol for the token.
`updateAuthority`	`OptionOrNullable`<`Address`>	The authority that can sign to update the metadata.
`uri`	`string`	The URI pointing to richer metadata.

Call Signature

function extension(kind, data): {
  __kind: "GroupPointer";
  authority: OptionOrNullable<Address>;
  groupAddress: OptionOrNullable<Address>;
};

Parameters

Parameter	Type
`kind`	`"GroupPointer"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"GroupPointer"`>

Returns

Name	Type	Description
`__kind`	`"GroupPointer"`	-
`authority`	`OptionOrNullable`<`Address`>	Optional authority that can set the group address.
`groupAddress`	`OptionOrNullable`<`Address`>	Optional account address that holds the group.

Call Signature

function extension(kind, data): {
  __kind: "TokenGroup";
  maxSize: number | bigint;
  mint: Address;
  size: number | bigint;
  updateAuthority: OptionOrNullable<Address>;
};

Parameters

Parameter	Type
`kind`	`"TokenGroup"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TokenGroup"`>

Returns

Name	Type	Description
`__kind`	`"TokenGroup"`	-
`maxSize`	`number` \| `bigint`	The maximum number of group members.
`mint`	`Address`	The associated mint, used to counter spoofing to be sure that group belongs to a particular mint.
`size`	`number` \| `bigint`	The current number of group members.
`updateAuthority`	`OptionOrNullable`<`Address`>	The authority that can sign to update the group.

Call Signature

function extension(kind, data): {
  __kind: "GroupMemberPointer";
  authority: OptionOrNullable<Address>;
  memberAddress: OptionOrNullable<Address>;
};

Parameters

Parameter	Type
`kind`	`"GroupMemberPointer"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"GroupMemberPointer"`>

Returns

Name	Type	Description
`__kind`	`"GroupMemberPointer"`	-
`authority`	`OptionOrNullable`<`Address`>	Optional authority that can set the member address.
`memberAddress`	`OptionOrNullable`<`Address`>	Optional account address that holds the member.

Call Signature

function extension(kind, data): {
  __kind: "TokenGroupMember";
  group: Address;
  memberNumber: number | bigint;
  mint: Address;
};

Parameters

Parameter	Type
`kind`	`"TokenGroupMember"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"TokenGroupMember"`>

Returns

Name	Type	Description
`__kind`	`"TokenGroupMember"`	-
`group`	`Address`	The pubkey of the `TokenGroup`.
`memberNumber`	`number` \| `bigint`	The member number.
`mint`	`Address`	The associated mint, used to counter spoofing to be sure that member belongs to a particular mint.

Call Signature

function extension(kind): {
  __kind: "ConfidentialMintBurn";
};

Parameters

Parameter	Type
`kind`	`"ConfidentialMintBurn"`

Returns

{
  __kind: "ConfidentialMintBurn";
}

Name	Type
`__kind`	`"ConfidentialMintBurn"`

Call Signature

function extension(kind, data): {
  __kind: "ScaledUiAmountConfig";
  authority: Address;
  multiplier: number;
  newMultiplier: number;
  newMultiplierEffectiveTimestamp: number | bigint;
};

Parameters

Parameter	Type
`kind`	`"ScaledUiAmountConfig"`
`data`	`GetDiscriminatedUnionVariantContent`<`ExtensionArgs`, `"__kind"`, `"ScaledUiAmountConfig"`>

Returns

{
  __kind: "ScaledUiAmountConfig";
  authority: Address;
  multiplier: number;
  newMultiplier: number;
  newMultiplierEffectiveTimestamp: number | bigint;
}

Name	Type
`__kind`	`"ScaledUiAmountConfig"`
`authority`	`Address`
`multiplier`	`number`
`newMultiplier`	`number`
`newMultiplierEffectiveTimestamp`	`number` \| `bigint`

On this page