Add optional identifier to PublicKeyValueNode (#147)

metaplex-foundation · Jan 9, 2024 · ceb467a · ceb467a
1 parent a9768f9
commit ceb467a
Show file tree

Hide file tree

Showing 45 changed files with 247 additions and 96 deletions.
diff --git a/.changeset/tame-pillows-complain.md b/.changeset/tame-pillows-complain.md
@@ -0,0 +1,5 @@
+---
+'@metaplex-foundation/kinobi': patch
+---
+
+Add optional identifier to PublicKeyValueNode
diff --git a/src/nodes/valueNodes/PublicKeyValueNode.ts b/src/nodes/valueNodes/PublicKeyValueNode.ts
@@ -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,
+  };
 }
diff --git a/src/renderers/js/renderInstructionDefaults.ts b/src/renderers/js/renderInstructionDefaults.ts
@@ -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`;

diff --git a/src/visitors/getDebugStringVisitor.ts b/src/visitors/getDebugStringVisitor.ts
@@ -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':

diff --git a/src/visitors/setInstructionAccountDefaultValuesVisitor.ts b/src/visitors/setInstructionAccountDefaultValuesVisitor.ts
@@ -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,
     },

diff --git a/test/packages/js/src/generated/instructions/approveCollectionAuthority.ts b/test/packages/js/src/generated/instructions/approveCollectionAuthority.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/approveUseAuthority.ts b/test/packages/js/src/generated/instructions/approveUseAuthority.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/burn.ts b/test/packages/js/src/generated/instructions/burn.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/burnEditionNft.ts b/test/packages/js/src/generated/instructions/burnEditionNft.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/burnNft.ts b/test/packages/js/src/generated/instructions/burnNft.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/closeEscrowAccount.ts b/test/packages/js/src/generated/instructions/closeEscrowAccount.ts
@@ -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(

diff --git a/test/packages/js/src/generated/instructions/createEscrowAccount.ts b/test/packages/js/src/generated/instructions/createEscrowAccount.ts
@@ -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(

diff --git a/test/packages/js/src/generated/instructions/createFrequencyRule.ts b/test/packages/js/src/generated/instructions/createFrequencyRule.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/createMasterEdition.ts b/test/packages/js/src/generated/instructions/createMasterEdition.ts
@@ -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(

diff --git a/test/packages/js/src/generated/instructions/createMasterEditionV3.ts b/test/packages/js/src/generated/instructions/createMasterEditionV3.ts
@@ -13,7 +13,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/createMetadataAccount.ts b/test/packages/js/src/generated/instructions/createMetadataAccount.ts
@@ -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(

diff --git a/test/packages/js/src/generated/instructions/createMetadataAccountV2.ts b/test/packages/js/src/generated/instructions/createMetadataAccountV2.ts
@@ -12,7 +12,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.

diff --git a/test/packages/js/src/generated/instructions/createMetadataAccountV3.ts b/test/packages/js/src/generated/instructions/createMetadataAccountV3.ts
@@ -14,7 +14,6 @@ import {
   PublicKey,
   Signer,
   TransactionBuilder,
-  publicKey,
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import {
@@ -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.