Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional identifier to PublicKeyValueNode #147

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Add optional identifier to PublicKeyValueNode #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tame-pillows-complain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@metaplex-foundation/kinobi': patch
---

Add optional identifier to PublicKeyValueNode
14 changes: 12 additions & 2 deletions src/nodes/valueNodes/PublicKeyValueNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
import { MainCaseString, mainCase } from '../../shared/utils';

export type PublicKeyValueNode = {
readonly kind: 'publicKeyValueNode';

// Data.
readonly publicKey: string;
readonly identifier?: MainCaseString;
};

export function publicKeyValueNode(publicKey: string): PublicKeyValueNode {
return { kind: 'publicKeyValueNode', publicKey };
export function publicKeyValueNode(
publicKey: string,
identifier?: string
): PublicKeyValueNode {
return {
kind: 'publicKeyValueNode',
publicKey,
identifier: identifier ? mainCase(identifier) : undefined,
};
}
11 changes: 9 additions & 2 deletions src/renderers/js/renderInstructionDefaults.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,15 @@ export function renderInstructionDefaults(
}
return render(`${pdaFunction}(${pdaArgs.join(', ')})`);
case 'publicKeyValueNode':
imports.add('umi', 'publicKey');
return render(`publicKey('${defaultValue.publicKey}')`);
if (!defaultValue.identifier) {
imports.add('umi', 'publicKey');
return render(`publicKey('${defaultValue.publicKey}')`);
}
interfaces.add('programs');
return render(
`context.programs.getPublicKey('${defaultValue.identifier}', '${defaultValue.publicKey}')`,
false
);
case 'programLinkNode':
const importFrom = defaultValue.importFrom ?? 'generatedPrograms';
const functionName = `get${pascalCase(defaultValue.name)}ProgramId`;
Expand Down
5 changes: 4 additions & 1 deletion src/visitors/getDebugStringVisitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,10 @@ function getNodeDetails(node: Node): string[] {
case 'booleanValueNode':
return [node.boolean ? 'true' : 'false'];
case 'publicKeyValueNode':
return [node.publicKey];
return [
...(node.identifier ? [`${node.identifier}`] : []),
node.publicKey,
];
case 'enumValueNode':
return [node.variant];
case 'resolverValueNode':
Expand Down
23 changes: 16 additions & 7 deletions src/visitors/setInstructionAccountDefaultValuesVisitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,49 +47,58 @@ export const DEFAULT_INSTRUCTION_ACCOUNT_DEFAULT_RULES: InstructionAccountDefaul
},
{
account: /^systemProgram|splSystemProgram$/,
defaultValue: publicKeyValueNode('11111111111111111111111111111111'),
defaultValue: publicKeyValueNode(
'11111111111111111111111111111111',
'splSystem'
),
ignoreIfOptional: true,
},
{
account: /^tokenProgram|splTokenProgram$/,
defaultValue: publicKeyValueNode(
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA',
'splToken'
),
ignoreIfOptional: true,
},
{
account: /^ataProgram|splAtaProgram$/,
defaultValue: publicKeyValueNode(
'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'
'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL',
'splAssociatedToken'
),
ignoreIfOptional: true,
},
{
account: /^tokenMetadataProgram|mplTokenMetadataProgram$/,
defaultValue: publicKeyValueNode(
'metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s'
'metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s',
'mplTokenMetadata'
),
ignoreIfOptional: true,
},
{
account:
/^(tokenAuth|mplTokenAuth|authorization|mplAuthorization|auth|mplAuth)RulesProgram$/,
defaultValue: publicKeyValueNode(
'auth9SigNpDKz4sJJ1DfCTuZrZNSAgh9sFD3rboVmgg'
'auth9SigNpDKz4sJJ1DfCTuZrZNSAgh9sFD3rboVmgg',
'mplTokenAuthRules'
),
ignoreIfOptional: true,
},
{
account: /^candyMachineProgram|mplCandyMachineProgram$/,
defaultValue: publicKeyValueNode(
'CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR'
'CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR',
'mplCandyMachine'
),
ignoreIfOptional: true,
},
{
account: /^candyGuardProgram|mplCandyGuardProgram$/,
defaultValue: publicKeyValueNode(
'Guard1JwRhJkVH6XZhzoYxeBVQe872VH6QggF4BWmS9g'
'Guard1JwRhJkVH6XZhzoYxeBVQe872VH6QggF4BWmS9g',
'mplCandyGuard'
),
ignoreIfOptional: true,
},
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/approveCollectionAuthority.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -126,9 +125,11 @@ export function approveCollectionAuthority(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}

// Accounts in order.
Expand Down
9 changes: 6 additions & 3 deletions test/packages/js/src/generated/instructions/approveUseAuthority.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -162,14 +161,18 @@ export function approveUseAuthority(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.tokenProgram.value) {
resolvedAccounts.tokenProgram.value = publicKey(
resolvedAccounts.tokenProgram.value = context.programs.getPublicKey(
'splToken',
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
);
resolvedAccounts.tokenProgram.isWritable = false;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}

// Accounts in order.
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/burn.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -135,9 +134,11 @@ export function burn(

// Default values.
if (!resolvedAccounts.splTokenProgram.value) {
resolvedAccounts.splTokenProgram.value = publicKey(
resolvedAccounts.splTokenProgram.value = context.programs.getPublicKey(
'splToken',
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
);
resolvedAccounts.splTokenProgram.isWritable = false;
}

// Accounts in order.
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/burnEditionNft.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -142,9 +141,11 @@ export function burnEditionNft(

// Default values.
if (!resolvedAccounts.splTokenProgram.value) {
resolvedAccounts.splTokenProgram.value = publicKey(
resolvedAccounts.splTokenProgram.value = context.programs.getPublicKey(
'splToken',
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
);
resolvedAccounts.splTokenProgram.isWritable = false;
}

// Accounts in order.
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/burnNft.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -110,9 +109,11 @@ export function burnNft(

// Default values.
if (!resolvedAccounts.splTokenProgram.value) {
resolvedAccounts.splTokenProgram.value = publicKey(
resolvedAccounts.splTokenProgram.value = context.programs.getPublicKey(
'splToken',
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
);
resolvedAccounts.splTokenProgram.isWritable = false;
}

// Accounts in order.
Expand Down
4 changes: 3 additions & 1 deletion test/packages/js/src/generated/instructions/closeEscrowAccount.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,11 @@ export function closeEscrowAccount(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}
if (!resolvedAccounts.sysvarInstructions.value) {
resolvedAccounts.sysvarInstructions.value = publicKey(
Expand Down
4 changes: 3 additions & 1 deletion test/packages/js/src/generated/instructions/createEscrowAccount.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,11 @@ export function createEscrowAccount(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}
if (!resolvedAccounts.sysvarInstructions.value) {
resolvedAccounts.sysvarInstructions.value = publicKey(
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/createFrequencyRule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -124,9 +123,11 @@ export function createFrequencyRule(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}

// Accounts in order.
Expand Down
8 changes: 6 additions & 2 deletions test/packages/js/src/generated/instructions/createMasterEdition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,18 @@ export function createMasterEdition(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.tokenProgram.value) {
resolvedAccounts.tokenProgram.value = publicKey(
resolvedAccounts.tokenProgram.value = context.programs.getPublicKey(
'splToken',
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
);
resolvedAccounts.tokenProgram.isWritable = false;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}
if (!resolvedAccounts.rent.value) {
resolvedAccounts.rent.value = publicKey(
Expand Down
9 changes: 6 additions & 3 deletions test/packages/js/src/generated/instructions/createMasterEditionV3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -154,14 +153,18 @@ export function createMasterEditionV3(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.tokenProgram.value) {
resolvedAccounts.tokenProgram.value = publicKey(
resolvedAccounts.tokenProgram.value = context.programs.getPublicKey(
'splToken',
'TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA'
);
resolvedAccounts.tokenProgram.isWritable = false;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}

// Accounts in order.
Expand Down
4 changes: 3 additions & 1 deletion test/packages/js/src/generated/instructions/createMetadataAccount.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,11 @@ export function createMetadataAccount(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}
if (!resolvedAccounts.rent.value) {
resolvedAccounts.rent.value = publicKey(
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/createMetadataAccountV2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -138,9 +137,11 @@ export function createMetadataAccountV2(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}

// Accounts in order.
Expand Down
5 changes: 3 additions & 2 deletions test/packages/js/src/generated/instructions/createMetadataAccountV3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import {
PublicKey,
Signer,
TransactionBuilder,
publicKey,
transactionBuilder,
} from '@metaplex-foundation/umi';
import {
Expand Down Expand Up @@ -158,9 +157,11 @@ export function createMetadataAccountV3(
resolvedAccounts.payer.value = context.payer;
}
if (!resolvedAccounts.systemProgram.value) {
resolvedAccounts.systemProgram.value = publicKey(
resolvedAccounts.systemProgram.value = context.programs.getPublicKey(
'splSystem',
'11111111111111111111111111111111'
);
resolvedAccounts.systemProgram.isWritable = false;
}

// Accounts in order.
Expand Down
Loading