codama-renderers-dart 0.4.0 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codama-renderers-dart",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Codama renderer for generating Dart code targeting the solana_kit SDK",
   "exports": {
     "node": {

package/src/fragments/instructionPage.ts

@@ -1,4 +1,4 @@
-import type {
+import {
   InstructionAccountNode,
   InstructionArgumentNode,
   InstructionNode,
@@ -16,6 +16,7 @@ import {
 import type { RenderScope } from "../utils/options.js";
 import { camelCase, pascalCase } from "../utils/nameTransformers.js";
 import { getDiscriminatorConstantsFragment } from "./discriminatorConstants.js";
+import { WELL_KNOWN_ADDRESSES } from "../utils/wellKnownAddresses.js";
 
 /**
  * Generate a full Dart file for an instruction.
@@ -338,8 +339,14 @@ function getDefaultValue(arg: InstructionArgumentNode): string {
       return String(dv.boolean);
     case "stringValueNode":
       return `'${dv.string}'`;
-    case "publicKeyValueNode":
+    case "publicKeyValueNode": {
+      const wellKnownName = WELL_KNOWN_ADDRESSES.get(dv.publicKey);
+      if (wellKnownName) {
+        use(wellKnownName, "solanaAddresses");
+        return wellKnownName;
+      }
       return `Address('${dv.publicKey}')`;
+    }
     case "noneValueNode":
       return "null";
     case "bytesValueNode": {

package/src/fragments/pdaPage.ts

@@ -10,6 +10,7 @@ import {
 } from "../utils/fragment.js";
 import type { RenderScope } from "../utils/options.js";
 import { camelCase, pascalCase } from "../utils/nameTransformers.js";
+import { WELL_KNOWN_ADDRESSES } from "../utils/wellKnownAddresses.js";
 
 /**
  * Generate a full Dart file for a PDA.
@@ -64,9 +65,17 @@ export function getPdaPageFragment(
       } else if (seed.value.kind === "stringValueNode") {
         seedValues.push(`    '${seed.value.string}',`);
       } else if (seed.value.kind === "publicKeyValueNode") {
-        seedValues.push(
-          `    getAddressEncoder().encode(Address('${seed.value.publicKey}')),`,
-        );
+        const wellKnownSeedName = WELL_KNOWN_ADDRESSES.get(seed.value.publicKey);
+        if (wellKnownSeedName) {
+          use(wellKnownSeedName, "solanaAddresses");
+          seedValues.push(
+            `    getAddressEncoder().encode(${wellKnownSeedName}),`,
+          );
+        } else {
+          seedValues.push(
+            `    getAddressEncoder().encode(Address('${seed.value.publicKey}')),`,
+          );
+        }
       } else if (seed.value.kind === "numberValueNode") {
         const manifest = visit(seed.type, scope.typeManifestVisitor);
         seedValues.push(`    ${manifest.encoder.content}.encode(${seed.value.number}),`);
@@ -80,8 +89,16 @@ export function getPdaPageFragment(
   }
 
   // Program address parameter
+  const wellKnownProgramName = node.programId
+    ? WELL_KNOWN_ADDRESSES.get(node.programId)
+    : undefined;
+  if (wellKnownProgramName) {
+    use(wellKnownProgramName, "solanaAddresses");
+  }
   const programIdParam = node.programId
-    ? `Address programAddress = const Address('${node.programId}')`
+    ? wellKnownProgramName
+      ? `Address programAddress = ${wellKnownProgramName}`
+      : `Address programAddress = const Address('${node.programId}')`
     : "required Address programAddress";
 
   const typedDataImport = hasByteSeeds

package/src/fragments/programPage.ts

@@ -10,6 +10,7 @@ import {
 } from "../utils/fragment.js";
 import type { RenderScope } from "../utils/options.js";
 import { camelCase, pascalCase } from "../utils/nameTransformers.js";
+import { WELL_KNOWN_ADDRESSES } from "../utils/wellKnownAddresses.js";
 
 /**
  * Generate a full Dart file for a program.
@@ -21,15 +22,36 @@ export function getProgramPageFragment(
   const name = node.name as string;
   const addressConstName = scope.nameApi.programAddressConstant(name);
 
-  const parts: Fragment[] = [
-    fragment`// Auto-generated. Do not edit.
+  const wellKnownName = WELL_KNOWN_ADDRESSES.get(node.publicKey);
+
+  // For well-known addresses, export and alias the canonical constant from
+  // solana_kit_addresses instead of hardcoding the address string.
+  // When the generated name matches the canonical name, a simple export suffices.
+  // When they differ, we also need a local const alias.
+  // For unknown addresses, fall back to the original Address('...') pattern.
+  const addressDeclaration: Fragment = wellKnownName
+    ? addressConstName === wellKnownName
+      ? fragment`// Auto-generated. Do not edit.
+// ignore_for_file: type=lint
+
+/// The address of the ${fragmentFromString(pascalCase(name))} program.
+export 'package:solana_kit_addresses/solana_kit_addresses.dart' show ${fragmentFromString(wellKnownName)};`
+      : fragment`${use(wellKnownName, "solanaAddresses")}
+
+// Auto-generated. Do not edit.
+// ignore_for_file: type=lint
+
+/// The address of the ${fragmentFromString(pascalCase(name))} program.
+const ${fragmentFromString(addressConstName)} = ${fragmentFromString(wellKnownName)};`
+    : fragment`// Auto-generated. Do not edit.
 // ignore_for_file: type=lint
 
 ${use("Address", "solanaAddresses")}
 
 /// The address of the ${fragmentFromString(pascalCase(name))} program.
-const ${fragmentFromString(addressConstName)} = Address('${fragmentFromString(node.publicKey)}');`,
-  ];
+const ${fragmentFromString(addressConstName)} = Address('${fragmentFromString(node.publicKey)}');`;
+
+  const parts: Fragment[] = [addressDeclaration];
 
   // Account identifier enum
   const accounts = node.accounts ?? [];
@@ -60,4 +82,4 @@ ${fragmentFromString(instrVariants)}
   }
 
   return mergeFragments(parts, (cs) => cs.join("\n"));
-}
+}

package/src/utils/index.ts

@@ -5,3 +5,4 @@ export * from "./importMap.js";
 export * from "./nameTransformers.js";
 export * from "./options.js";
 export * from "./typeManifest.js";
+export * from "./wellKnownAddresses.js";

package/src/utils/wellKnownAddresses.ts

@@ -0,0 +1,64 @@
+/**
+ * Maps well-known Solana public keys to their canonical Dart constant names
+ * in `package:solana_kit_addresses`. When the renderer encounters a known
+ * address, it emits a re-export from that package instead of hardcoding the
+ * address string.
+ *
+ * The keys are the base-58 public key strings as they appear in IDL/Codama nodes.
+ * The values are the Dart constant names exported by `solana_kit_addresses`.
+ */
+export const WELL_KNOWN_ADDRESSES: ReadonlyMap<string, string> = new Map([
+  // Agave / Solana native programs
+  ['11111111111111111111111111111111', 'systemProgramAddress'],
+  ['AddressLookupTab1e1111111111111111111111111', 'addressLookupTableProgramAddress'],
+  ['BPFLoader2111111111111111111111111111111111', 'bpfLoaderProgramAddress'],
+  ['BPFLoader1111111111111111111111111111111111', 'bpfLoaderDeprecatedProgramAddress'],
+  ['BPFLoaderUpgradeab1e11111111111111111111111', 'bpfLoaderUpgradeableProgramAddress'],
+  ['ComputeBudget111111111111111111111111111111', 'computeBudgetProgramAddress'],
+  ['Config1111111111111111111111111111111111111', 'configProgramAddress'],
+  ['Ed25519SigVerify111111111111111111111111111', 'ed25519ProgramAddress'],
+  ['Feature111111111111111111111111111111111111', 'featureProgramAddress'],
+  ['1nc1nerator11111111111111111111111111111111', 'incineratorAddress'],
+  ['LoaderV411111111111111111111111111111111111', 'loaderV4ProgramAddress'],
+  ['NativeLoader1111111111111111111111111111', 'nativeLoaderProgramAddress'],
+  ['KeccakSecp256k11111111111111111111111111111', 'secp256k1ProgramAddress'],
+  ['Secp256r1SigVerify1111111111111111111111111', 'secp256r1ProgramAddress'],
+  ['Stake11111111111111111111111111111111111111', 'stakeProgramAddress'],
+  ['StakeConfig1111111111111111111111111111', 'stakeConfigAddress'],
+  ['Vote111111111111111111111111111111111111111', 'voteProgramAddress'],
+  ['ZkTokenProof1111111111111111111111111111111', 'zkTokenProofProgramAddress'],
+  ['ZkE1Gama1Proof11111111111111111111111111111', 'zkElgamalProofProgramAddress'],
+
+  // Sysvars
+  ['SysvarC1ock11111111111111111111111111111111', 'sysvarClockAddress'],
+  ['Rent11111111111111111111111111111111111111', 'sysvarRentAddress'],
+  ['11111111111111111111111111111111111111111111', 'sysvarRecentBlockhashesAddress'], // note: 44 chars
+  ['SysvarFees1111111111111111111111111111111111', 'sysvarFeesAddress'],
+  ['Sysvar1nstruct1ons11111111111111111111111111', 'sysvarInstructionsAddress'],
+  ['SysvarEpochSchedu1e111111111111111111111111', 'sysvarEpochScheduleAddress'],
+  ['SysvarRewards111111111111111111111111111111', 'sysvarRewardsAddress'],
+  ['SysvarStakeHistory1111111111111111111111111', 'sysvarStakeHistoryAddress'],
+  ['SysvarS1otHashes111111111111111111111111111', 'sysvarSlotHashesAddress'],
+  ['SysvarS1otHistory11111111111111111111111111', 'sysvarSlotHistoryAddress'],
+  ['Sysvar1111111111111111111111111111111111111', 'sysvarOwnerAddress'],
+
+  // SPL programs
+  ['TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA', 'tokenProgramAddress'],
+  ['TokenzQdBNb4qyze1S1U9AHB8MGXmNK1REkTPT5Z3Y', 'token2022ProgramAddress'],
+  ['ATokenGPvbdGVxr1b2hvZbsiqW5xWH25ef7s3c8BnQKu', 'associatedTokenProgramAddress'],
+  ['Memo1UhkJRfRhVq1sR7Y7Nto1s3J2mXTT3L6Wk4K2m6', 'memoProgramAddress'],
+  ['MemoSq4gqABXKKYWVqKkV3m3kb1cTR7F2UMy9r6kFNK', 'memoLegacyProgramAddress'],
+
+  // Metaplex programs
+  ['metaqbxxU9qX8rZXkmUJ7haCrXXz2W1PSUq1Rn3E1od', 'tokenMetadataProgramAddress'],
+  ['BGUMAp9V1mQ2KV8t34L5u3gZsXYZaYDBdKkc1xYk1qA1', 'mplBubblegumProgramAddress'],
+  ['auth9SigNpDKz4s8cHr3MFBPS1phbRKLSCN3aBe9sS', 'authRulesProgramAddress'],
+  ['CoREENxT6tW1Ho6BW6W5Z4N41ci5Xz2mmrR2kErmM5TR', 'metaplexCoreProgramAddress'],
+  ['cmtMqR4bPM9sEV3bPnJQq5s2EnYw4N5vQ8hWhEd1xzS', 'splAccountCompressionProgramAddress'],
+  ['noopb9skMVngR5Qi4sczwFr1jU4V4F7nm8xzFQK9C', 'noopProgramAddress'],
+
+  // Well-known mints
+  ['So11111111111111111111111111111111111111112', 'wrappedSolAddress'],
+  ['EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v', 'usdcAddress'],
+  ['Es9vMFrzaCERm6YKXx6bqKr1Rmd9b5v3J8rM5e4rfF4', 'usdtAddress'],
+]);