Skip to content

Commit

Permalink
Define IDL for initialize permanent delegate instruction (#44)
Browse files Browse the repository at this point in the history
* Added permanent delegate instruction

* Added permanent delegate instruction
  • Loading branch information
0xCipherCoder authored Nov 13, 2024
1 parent 1cbdb4c commit 0c8b0b8
Show file tree
Hide file tree
Showing 6 changed files with 313 additions and 3 deletions.
1 change: 1 addition & 0 deletions clients/js/src/generated/instructions/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ export * from './initializeMintCloseAuthority';
export * from './initializeMultisig';
export * from './initializeMultisig2';
export * from './initializeNonTransferableMint';
export * from './initializePermanentDelegate';
export * from './initializeTokenGroup';
export * from './initializeTokenGroupMember';
export * from './initializeTokenMetadata';
Expand Down
174 changes: 174 additions & 0 deletions clients/js/src/generated/instructions/initializePermanentDelegate.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
/**
* This code was AUTOGENERATED using the codama library.
* Please DO NOT EDIT THIS FILE, instead use visitors
* to add features, then rerun codama to update it.
*
* @see https://github.com/codama-idl/codama
*/

import {
combineCodec,
getAddressDecoder,
getAddressEncoder,
getStructDecoder,
getStructEncoder,
getU8Decoder,
getU8Encoder,
transformEncoder,
type Address,
type Codec,
type Decoder,
type Encoder,
type IAccountMeta,
type IInstruction,
type IInstructionWithAccounts,
type IInstructionWithData,
type WritableAccount,
} from '@solana/web3.js';
import { TOKEN_2022_PROGRAM_ADDRESS } from '../programs';
import { getAccountMetaFactory, type ResolvedAccount } from '../shared';

export const INITIALIZE_PERMANENT_DELEGATE_DISCRIMINATOR = 35;

export function getInitializePermanentDelegateDiscriminatorBytes() {
return getU8Encoder().encode(INITIALIZE_PERMANENT_DELEGATE_DISCRIMINATOR);
}

export type InitializePermanentDelegateInstruction<
TProgram extends string = typeof TOKEN_2022_PROGRAM_ADDRESS,
TAccountMint extends string | IAccountMeta<string> = string,
TRemainingAccounts extends readonly IAccountMeta<string>[] = [],
> = IInstruction<TProgram> &
IInstructionWithData<Uint8Array> &
IInstructionWithAccounts<
[
TAccountMint extends string
? WritableAccount<TAccountMint>
: TAccountMint,
...TRemainingAccounts,
]
>;

export type InitializePermanentDelegateInstructionData = {
discriminator: number;
/** Authority that may sign for `Transfer`s and `Burn`s on any account */
delegate: Address;
};

export type InitializePermanentDelegateInstructionDataArgs = {
/** Authority that may sign for `Transfer`s and `Burn`s on any account */
delegate: Address;
};

export function getInitializePermanentDelegateInstructionDataEncoder(): Encoder<InitializePermanentDelegateInstructionDataArgs> {
return transformEncoder(
getStructEncoder([
['discriminator', getU8Encoder()],
['delegate', getAddressEncoder()],
]),
(value) => ({
...value,
discriminator: INITIALIZE_PERMANENT_DELEGATE_DISCRIMINATOR,
})
);
}

export function getInitializePermanentDelegateInstructionDataDecoder(): Decoder<InitializePermanentDelegateInstructionData> {
return getStructDecoder([
['discriminator', getU8Decoder()],
['delegate', getAddressDecoder()],
]);
}

export function getInitializePermanentDelegateInstructionDataCodec(): Codec<
InitializePermanentDelegateInstructionDataArgs,
InitializePermanentDelegateInstructionData
> {
return combineCodec(
getInitializePermanentDelegateInstructionDataEncoder(),
getInitializePermanentDelegateInstructionDataDecoder()
);
}

export type InitializePermanentDelegateInput<
TAccountMint extends string = string,
> = {
/** The mint to initialize. */
mint: Address<TAccountMint>;
delegate: InitializePermanentDelegateInstructionDataArgs['delegate'];
};

export function getInitializePermanentDelegateInstruction<
TAccountMint extends string,
TProgramAddress extends Address = typeof TOKEN_2022_PROGRAM_ADDRESS,
>(
input: InitializePermanentDelegateInput<TAccountMint>,
config?: { programAddress?: TProgramAddress }
): InitializePermanentDelegateInstruction<TProgramAddress, TAccountMint> {
// Program address.
const programAddress = config?.programAddress ?? TOKEN_2022_PROGRAM_ADDRESS;

// Original accounts.
const originalAccounts = {
mint: { value: input.mint ?? null, isWritable: true },
};
const accounts = originalAccounts as Record<
keyof typeof originalAccounts,
ResolvedAccount
>;

// Original args.
const args = { ...input };

const getAccountMeta = getAccountMetaFactory(programAddress, 'programId');
const instruction = {
accounts: [getAccountMeta(accounts.mint)],
programAddress,
data: getInitializePermanentDelegateInstructionDataEncoder().encode(
args as InitializePermanentDelegateInstructionDataArgs
),
} as InitializePermanentDelegateInstruction<TProgramAddress, TAccountMint>;

return instruction;
}

export type ParsedInitializePermanentDelegateInstruction<
TProgram extends string = typeof TOKEN_2022_PROGRAM_ADDRESS,
TAccountMetas extends readonly IAccountMeta[] = readonly IAccountMeta[],
> = {
programAddress: Address<TProgram>;
accounts: {
/** The mint to initialize. */
mint: TAccountMetas[0];
};
data: InitializePermanentDelegateInstructionData;
};

export function parseInitializePermanentDelegateInstruction<
TProgram extends string,
TAccountMetas extends readonly IAccountMeta[],
>(
instruction: IInstruction<TProgram> &
IInstructionWithAccounts<TAccountMetas> &
IInstructionWithData<Uint8Array>
): ParsedInitializePermanentDelegateInstruction<TProgram, TAccountMetas> {
if (instruction.accounts.length < 1) {
// TODO: Coded error.
throw new Error('Not enough accounts');
}
let accountIndex = 0;
const getNextAccount = () => {
const accountMeta = instruction.accounts![accountIndex]!;
accountIndex += 1;
return accountMeta;
};
return {
programAddress: instruction.programAddress,
accounts: {
mint: getNextAccount(),
},
data: getInitializePermanentDelegateInstructionDataDecoder().decode(
instruction.data
),
};
}
8 changes: 8 additions & 0 deletions clients/js/src/generated/programs/token2022.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ import {
type ParsedInitializeMultisig2Instruction,
type ParsedInitializeMultisigInstruction,
type ParsedInitializeNonTransferableMintInstruction,
type ParsedInitializePermanentDelegateInstruction,
type ParsedInitializeTokenGroupInstruction,
type ParsedInitializeTokenGroupMemberInstruction,
type ParsedInitializeTokenMetadataInstruction,
Expand Down Expand Up @@ -168,6 +169,7 @@ export enum Token2022Instruction {
InitializeNonTransferableMint,
EnableCpiGuard,
DisableCpiGuard,
InitializePermanentDelegate,
InitializeTransferHook,
UpdateTransferHook,
InitializeMetadataPointer,
Expand Down Expand Up @@ -431,6 +433,9 @@ export function identifyToken2022Instruction(
) {
return Token2022Instruction.DisableCpiGuard;
}
if (containsBytes(data, getU8Encoder().encode(35), 0)) {
return Token2022Instruction.InitializePermanentDelegate;
}
if (
containsBytes(data, getU8Encoder().encode(36), 0) &&
containsBytes(data, getU8Encoder().encode(0), 1)
Expand Down Expand Up @@ -722,6 +727,9 @@ export type ParsedToken2022Instruction<
| ({
instructionType: Token2022Instruction.DisableCpiGuard;
} & ParsedDisableCpiGuardInstruction<TProgram>)
| ({
instructionType: Token2022Instruction.InitializePermanentDelegate;
} & ParsedInitializePermanentDelegateInstruction<TProgram>)
| ({
instructionType: Token2022Instruction.InitializeTransferHook;
} & ParsedInitializeTransferHookInstruction<TProgram>)
Expand Down
6 changes: 6 additions & 0 deletions clients/js/src/getInitializeInstructionsForExtensions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {
getInitializeTransferFeeConfigInstruction,
getInitializeNonTransferableMintInstruction,
getInitializeTransferHookInstruction,
getInitializePermanentDelegateInstruction,
} from './generated';

/**
Expand Down Expand Up @@ -94,6 +95,11 @@ export function getPreInitializeInstructionsForMintExtensions(
programId: extension.programId,
}),
];
case 'PermanentDelegate':
return getInitializePermanentDelegateInstruction({
mint,
delegate: extension.delegate,
});
default:
return [];
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import { Account, address, generateKeyPairSigner, some } from '@solana/web3.js';
import test from 'ava';
import {
Mint,
extension,
fetchMint,
getInitializePermanentDelegateInstruction,
} from '../../../src';
import {
createDefaultSolanaClient,
generateKeyPairSignerWithSol,
getCreateMintInstructions,
sendAndConfirmInstructions,
} from '../../_setup';

test('it initializes a mint with permanent delegate', async (t) => {
// Given some signer accounts
const client = createDefaultSolanaClient();
const [authority, mint] = await Promise.all([
generateKeyPairSignerWithSol(client),
generateKeyPairSigner(),
]);

// And a permanent delegate extension
const permanentDelegate = address(
'6sPR6MzvjMMP5LSZzEtTe4ZBVX9rhBmtM1dmfFtkNTbW'
);
const permanentDelegateExtension = extension('PermanentDelegate', {
delegate: permanentDelegate,
});

// When we create and initialize a mint account with this extension
const [createMintInstruction, initMintInstruction] =
await getCreateMintInstructions({
authority: authority.address,
client,
extensions: [permanentDelegateExtension],
mint,
payer: authority,
});

await sendAndConfirmInstructions(client, authority, [
createMintInstruction,
getInitializePermanentDelegateInstruction({
mint: mint.address,
delegate: permanentDelegate,
}),
initMintInstruction,
]);

// Then we expect the mint account to exist with the permanent delegate
const mintAccount = await fetchMint(client.rpc, mint.address);
t.like(mintAccount, <Account<Mint>>{
address: mint.address,
data: {
mintAuthority: some(authority.address),
isInitialized: true,
extensions: some([permanentDelegateExtension]),
},
});
});
66 changes: 63 additions & 3 deletions program/idl.json
Original file line number Diff line number Diff line change
Expand Up @@ -5565,6 +5565,64 @@
}
]
},
{
"kind": "instructionNode",
"name": "initializePermanentDelegate",
"docs": [
"Initialize the permanent delegate on a new mint.",
"",
"Fails if the mint has already been initialized, so must be called before `InitializeMint`.",
"",
"The mint must have exactly enough space allocated for the base mint (82 bytes),",
"plus 83 bytes of padding, 1 byte reserved for the account type,",
"then space required for this extension, plus any others."
],
"optionalAccountStrategy": "programId",
"accounts": [
{
"kind": "instructionAccountNode",
"name": "mint",
"isWritable": true,
"isSigner": false,
"isOptional": false,
"docs": ["The mint to initialize."]
}
],
"arguments": [
{
"kind": "instructionArgumentNode",
"name": "discriminator",
"defaultValueStrategy": "omitted",
"docs": [],
"type": {
"kind": "numberTypeNode",
"format": "u8",
"endian": "le"
},
"defaultValue": {
"kind": "numberValueNode",
"number": 35
}
},
{
"kind": "instructionArgumentNode",
"name": "delegate",
"docs": [
"Authority that may sign for `Transfer`s and `Burn`s on any account"
],
"type": {
"kind": "publicKeyTypeNode"
}
}
],
"discriminators": [
{
"kind": "fieldDiscriminatorNode",
"name": "discriminator",
"offset": 0
}
]
},
{
"kind": "instructionNode",
"name": "initializeTransferHook",
Expand Down Expand Up @@ -5622,7 +5680,9 @@
{
"kind": "instructionArgumentNode",
"name": "authority",
"docs": ["The public key for the account that can update the program id"],
"docs": [
"The public key for the account that can update the program id"
],
"type": {
"kind": "zeroableOptionTypeNode",
"item": {
Expand Down Expand Up @@ -5678,7 +5738,7 @@
"docs": ["The mint."]
},
{
"kind": "instructionAccountNode",
"kind": "instructionAccountNode",
"name": "authority",
"isWritable": false,
"isSigner": "either",
Expand Down Expand Up @@ -5749,7 +5809,7 @@
},
{
"kind": "fieldDiscriminatorNode",
"name": "transferHookDiscriminator",
"name": "transferHookDiscriminator",
"offset": 1
}
]
Expand Down

0 comments on commit 0c8b0b8

Please sign in to comment.