Upgrade JS client to Kit v3 (#62)

Author: lorisleiva

clients/js/package.json

@@ -42,13 +42,13 @@
   "homepage": "https://github.com/solana-program/config#readme",
   "license": "MIT",
   "peerDependencies": {
-    "@solana/kit": "^2.1.0"
+    "@solana/kit": "^3.0"
   },
   "devDependencies": {
     "@ava/typescript": "^4.1.0",
     "@solana/eslint-config-solana": "^3.0.3",
-    "@solana/kit": "^2.1.0",
-    "@types/node": "^20",
+    "@solana/kit": "^3.0",
+    "@types/node": "^24",
     "@typescript-eslint/eslint-plugin": "^7.16.1",
     "@typescript-eslint/parser": "^7.16.1",
     "ava": "^6.1.3",

clients/js/pnpm-lock.yaml

@@ -13,15 +13,15 @@ import {
   getBytesEncoder,
   getStructDecoder,
   getStructEncoder,
+  type AccountMeta,
+  type AccountSignerMeta,
   type Address,
   type Codec,
   type Decoder,
   type Encoder,
-  type IAccountMeta,
-  type IAccountSignerMeta,
-  type IInstruction,
-  type IInstructionWithAccounts,
-  type IInstructionWithData,
+  type Instruction,
+  type InstructionWithAccounts,
+  type InstructionWithData,
   type ReadonlyUint8Array,
   type TransactionSigner,
   type WritableAccount,
@@ -38,11 +38,11 @@ import {
 
 export type StoreInstruction<
   TProgram extends string = typeof SOLANA_CONFIG_PROGRAM_ADDRESS,
-  TAccountConfigAccount extends string | IAccountMeta<string> = string,
-  TRemainingAccounts extends readonly IAccountMeta<string>[] = [],
-> = IInstruction<TProgram> &
-  IInstructionWithData<Uint8Array> &
-  IInstructionWithAccounts<
+  TAccountConfigAccount extends string | AccountMeta<string> = string,
+  TRemainingAccounts extends readonly AccountMeta<string>[] = [],
+> = Instruction<TProgram> &
+  InstructionWithData<ReadonlyUint8Array> &
+  InstructionWithAccounts<
     [
       TAccountConfigAccount extends string
         ? WritableAccount<TAccountConfigAccount>
@@ -121,7 +121,7 @@ export function getStoreInstruction<
   TProgramAddress,
   (typeof input)['configAccount'] extends TransactionSigner<TAccountConfigAccount>
     ? WritableSignerAccount<TAccountConfigAccount> &
-        IAccountSignerMeta<TAccountConfigAccount>
+        AccountSignerMeta<TAccountConfigAccount>
     : TAccountConfigAccount
 > {
   // Program address.
@@ -141,7 +141,7 @@ export function getStoreInstruction<
   const args = { ...input };
 
   // Remaining accounts.
-  const remainingAccounts: IAccountMeta[] = (args.signers ?? []).map(
+  const remainingAccounts: AccountMeta[] = (args.signers ?? []).map(
     (signer) => ({
       address: signer.address,
       role: AccountRole.READONLY_SIGNER,
@@ -160,7 +160,7 @@ export function getStoreInstruction<
     TProgramAddress,
     (typeof input)['configAccount'] extends TransactionSigner<TAccountConfigAccount>
       ? WritableSignerAccount<TAccountConfigAccount> &
-          IAccountSignerMeta<TAccountConfigAccount>
+          AccountSignerMeta<TAccountConfigAccount>
       : TAccountConfigAccount
   >;
 
@@ -169,7 +169,7 @@ export function getStoreInstruction<
 
 export type ParsedStoreInstruction<
   TProgram extends string = typeof SOLANA_CONFIG_PROGRAM_ADDRESS,
-  TAccountMetas extends readonly IAccountMeta[] = readonly IAccountMeta[],
+  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
 > = {
   programAddress: Address<TProgram>;
   accounts: {
@@ -186,19 +186,19 @@ export type ParsedStoreInstruction<
 
 export function parseStoreInstruction<
   TProgram extends string,
-  TAccountMetas extends readonly IAccountMeta[],
+  TAccountMetas extends readonly AccountMeta[],
 >(
-  instruction: IInstruction<TProgram> &
-    IInstructionWithAccounts<TAccountMetas> &
-    IInstructionWithData<Uint8Array>
+  instruction: Instruction<TProgram> &
+    InstructionWithAccounts<TAccountMetas> &
+    InstructionWithData<ReadonlyUint8Array>
 ): ParsedStoreInstruction<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]!;
+    const accountMeta = (instruction.accounts as TAccountMetas)[accountIndex]!;
     accountIndex += 1;
     return accountMeta;
   };

clients/js/src/generated/instructions/store.ts

@@ -10,9 +10,9 @@ import {
   AccountRole,
   isProgramDerivedAddress,
   isTransactionSigner as kitIsTransactionSigner,
+  type AccountMeta,
+  type AccountSignerMeta,
   type Address,
-  type IAccountMeta,
-  type IAccountSignerMeta,
   type ProgramDerivedAddress,
   type TransactionSigner,
   upgradeRoleToSigner,
@@ -23,7 +23,7 @@ import {
  * @internal
  */
 export function expectSome<T>(value: T | null | undefined): T {
-  if (value == null) {
+  if (value === null || value === undefined) {
     throw new Error('Expected a value but received null or undefined.');
   }
   return value;
@@ -48,7 +48,7 @@ export function expectAddress<T extends string = string>(
     return value.address;
   }
   if (Array.isArray(value)) {
-    return value[0];
+    return value[0] as Address<T>;
   }
   return value as Address<T>;
 }
@@ -113,7 +113,7 @@ export type ResolvedAccount<
  * Defines an instruction that stores additional bytes on-chain.
  * @internal
  */
-export type IInstructionWithByteDelta = {
+export type InstructionWithByteDelta = {
   byteDelta: number;
 };
 
@@ -127,7 +127,7 @@ export function getAccountMetaFactory(
 ) {
   return (
     account: ResolvedAccount
-  ): IAccountMeta | IAccountSignerMeta | undefined => {
+  ): AccountMeta | AccountSignerMeta | undefined => {
     if (!account.value) {
       if (optionalAccountStrategy === 'omitted') return;
       return Object.freeze({

clients/js/src/generated/shared/index.ts

@@ -10,33 +10,32 @@ const { default: prettierOptions } = await import(
 
 export default {
   idl: 'program/idl.json',
-  before: [
-    {
+  before: [],
+  scripts: {
+    js: {
       from: '@codama/renderers-js',
       args: ['clients/js/src/generated', { prettierOptions }],
     },
-    {
-      from: '@codama/visitors-core#deleteNodesVisitor',
-      args: [['[definedTypeNode]configKeys']],
-    },
-  ],
-  scripts: {
-    rust: {
-      from: '@codama/renderers-rust',
-      args: [
-        'clients/rust/src/generated',
-        {
-          anchorTraits: false,
-          crateFolder: 'clients/rust',
-          formatCode: true,
-          linkOverrides: {
-            definedTypes: {
-              configKeys: 'hooked',
+    rust: [
+      {
+        from: '@codama/visitors-core#deleteNodesVisitor',
+        args: [['[definedTypeNode]configKeys']],
+      },
+      {
+        from: '@codama/renderers-rust',
+        args: [
+          'clients/rust/src/generated',
+          {
+            anchorTraits: false,
+            crateFolder: 'clients/rust',
+            formatCode: true,
+            linkOverrides: {
+              definedTypes: { configKeys: 'hooked' },
             },
+            toolchain: `+${process.env.RUST_TOOLCHAIN_NIGHTLY}`,
           },
-          toolchain: `+${process.env.RUST_TOOLCHAIN_NIGHTLY}`,
-        },
-      ],
-    },
+        ],
+      },
+    ],
   },
-};
+};

codama.mjs

@@ -5,10 +5,10 @@
     "generate:clients": "codama run --all"
   },
   "devDependencies": {
-    "@codama/renderers-js": "^1.2.8",
-    "@codama/renderers-rust": "^1.0.17",
+    "@codama/renderers-js": "^1.3",
+    "@codama/renderers-rust": "~1.0",
     "@codama/visitors-core": "^1.2.13",
-    "codama": "^1.2.9",
+    "codama": "^1.3",
     "dotenv": "^16.5.0"
   },
   "engines": {