Move generated IDL to ts directory (#437)

* Move generated IDL to ts directory

* update github action with new idl path

* Update to use the ts exported IDL instead of the json

* rebase and regenerate bindings

* remove generics from generated idl

* add generic stripper to makefile, use ts IDL for binding loader

Author: barnjamin

.github/workflows/solana.yml

@@ -144,7 +144,7 @@ jobs:
           shell: bash
         - name: Check idl
           run: |
-            git diff --exit-code idl
+            git diff --exit-code ts/idl
         - name: Run tests
           run: anchor test
           shell: bash

solana/Makefile

@@ -1,5 +1,5 @@
 .PHONY: build
-build: _anchor-build target/idl/example_native_token_transfers.json idl
+build: _anchor-build target/idl/example_native_token_transfers.json
 
 # remove the generics from the idl file. This is necessary as of anchor 0.29.0, because
 # the javascript library does not support generics yet, and just panics
@@ -12,15 +12,20 @@ target/idl/example_native_token_transfers.json: _anchor-build
 _anchor-build:
 	@anchor build --arch sbf
 
-anchor-test: build target/idl/example_native_token_transfers.json sdk
+anchor-test: build idl sdk
 	anchor test --skip-build
 
 .PHONY: idl
 idl: target/idl/example_native_token_transfers.json
-	@ mkdir -p $@/json
-	@ mkdir -p $@/ts
-	@ cp -r target/idl/* $@/json/
-	@ cp -r target/types/* $@/ts/
+	$(eval VERSION=$(shell grep "const VERSION" programs/example-native-token-transfers/src/lib.rs | cut -d'"' -f2 | sed 's/\./_/g'))
+	@echo "IDL Version: $(VERSION)"
+	@ mkdir -p ts/idl/$(VERSION)/json
+	@ mkdir -p ts/idl/$(VERSION)/ts
+	@ cp -r target/idl/* ts/idl/$(VERSION)/json/
+	@for jsonfile in ts/idl/$(VERSION)/json/*.json; do \
+	    tsfile=$$(echo $$jsonfile | sed 's/json\/\(.*\)\.json/ts\/\1.ts/'); \
+	    tsx scripts/regenerateIdl.ts $$jsonfile > $$tsfile; \
+	done
 
 sdk: build
 	@echo "Building SDK"

solana/idl/ts/wormhole_governance.ts

@@ -39,9 +39,6 @@
     "rebuild": "npm run clean && npm run build",
     "clean": "rm -rf ./dist",
     "test:ci": "jest --config ./jest.config.ts",
-    "generate": "export IDL_VERSION=`tsx scripts/readVersion.ts` && mkdir -p ./ts/sdk/anchor-idl/$IDL_VERSION && npm run copy:idl && npm run copy:types",
-    "copy:idl": "cp ./target/idl/*.json ./ts/sdk/anchor-idl/$IDL_VERSION/",
-    "copy:types": "cp ./target/types/*.ts ./ts/sdk/anchor-idl/$IDL_VERSION/",
     "build:contracts": "make build"
   },
   "devDependencies": {

solana/package.json

@@ -0,0 +1,35 @@
+import { type Idl } from "@coral-xyz/anchor";
+import fs from "fs";
+
+const jsonPath = process.argv[2];
+if (jsonPath === undefined) {
+  console.error(`Usage:\
+${process.argv[0]} ${process.argv[1]} <idl.json>`);
+  process.exit(1);
+}
+
+// snake to title case
+const titleCase = (str: string) =>
+  str
+    .split("_")
+    .map((word) => word[0].toUpperCase() + word.slice(1).toLowerCase())
+    .join("");
+
+const idl: Idl = JSON.parse(fs.readFileSync(jsonPath, "utf8"));
+
+const name = titleCase(idl["name"]);
+
+idl.accounts?.forEach((account) => {
+  account.name = account.name.replace(/^[A-Z]+/, (match) =>
+    match.toLowerCase()
+  );
+});
+
+// heredoc
+const ts = `\
+export type ${name} = ${JSON.stringify(idl, null, 2)}\
+
+export const IDL: ${name} = ${JSON.stringify(idl, null, 2)}
+`;
+
+console.log(ts);

solana/scripts/regenerateIdl.ts

@@ -12,8 +12,8 @@ import {
   serialize,
   serializePayload,
   signSendWait as ssw,
-  testing,
 } from "@wormhole-foundation/sdk-connect";
+import * as testing from "@wormhole-foundation/sdk-definitions/testing";
 import {
   SolanaAddress,
   SolanaPlatform,
@@ -24,7 +24,7 @@ import * as fs from "fs";
 
 import { PublicKey, SystemProgram, Transaction } from "@solana/web3.js";
 import { AccountAddress } from "@wormhole-foundation/sdk";
-import { DummyTransferHook } from "../ts/sdk/anchor-idl/1_0_0/dummy_transfer_hook.js";
+import { DummyTransferHook } from "../ts/idl/1_0_0/ts/dummy_transfer_hook.js";
 import { SolanaNtt } from "../ts/sdk/index.js";
 
 const solanaRootDir = `${__dirname}/../`;

solana/tests/anchor.test.ts

@@ -107,8 +107,7 @@ export type DummyTransferHook = {
       }
     }
   ]
-};
-
+}
 export const IDL: DummyTransferHook = {
   "version": "2.0.0",
   "name": "dummy_transfer_hook",
@@ -218,4 +217,5 @@ export const IDL: DummyTransferHook = {
       }
     }
   ]
-};
+}
+