Codama IDL generation (#198)

* Codama IDL + clients generation

* Specify toolchain in make generate-clients

* Delete generated clients

* Fix account naming

* Use codama-cli

Author: grod220

.github/workflows/main.yml

@@ -10,6 +10,7 @@ env:
   SBPF_PROGRAM_PACKAGES: "['program', 'pinocchio-program']"
   RUST_PACKAGES: "['interface', 'program', 'mollusk_harness', 'pinocchio-interface', 'pinocchio-program']"
   WASM_PACKAGES: "['interface', 'program']"
+  IDL_PACKAGES: "['pinocchio-interface']"
   MIRI_PACKAGES: "['pinocchio-program']"
 
 jobs:
@@ -20,6 +21,7 @@ jobs:
       SBPF_PROGRAM_PACKAGES: ${{ steps.compute.outputs.SBPF_PROGRAM_PACKAGES }}
       RUST_PACKAGES: ${{ steps.compute.outputs.RUST_PACKAGES }}
       WASM_PACKAGES: ${{ steps.compute.outputs.WASM_PACKAGES }}
+      IDL_PACKAGES: ${{ steps.compute.outputs.IDL_PACKAGES }}
       MIRI_PACKAGES: ${{ steps.compute.outputs.MIRI_PACKAGES }}
       RUST_TOOLCHAIN_NIGHTLY: ${{ steps.compute.outputs.RUST_TOOLCHAIN_NIGHTLY }}
       SOLANA_CLI_VERSION: ${{ steps.compute.outputs.SOLANA_CLI_VERSION }}
@@ -34,6 +36,7 @@ jobs:
           echo "SBPF_PROGRAM_PACKAGES=${{ env.SBPF_PROGRAM_PACKAGES }}" >> $GITHUB_OUTPUT
           echo "RUST_PACKAGES=${{ env.RUST_PACKAGES }}" >> $GITHUB_OUTPUT
           echo "WASM_PACKAGES=${{ env.WASM_PACKAGES }}" >> $GITHUB_OUTPUT
+          echo "IDL_PACKAGES=${{ env.IDL_PACKAGES }}" >> $GITHUB_OUTPUT
           echo "MIRI_PACKAGES=${{ env.MIRI_PACKAGES }}" >> $GITHUB_OUTPUT
           echo "RUST_TOOLCHAIN_NIGHTLY=$(make rust-toolchain-nightly)" >> "$GITHUB_OUTPUT"
           echo "SOLANA_CLI_VERSION=$(make solana-cli-version)" >> "$GITHUB_OUTPUT"
@@ -45,6 +48,7 @@ jobs:
       sbpf-program-packages: ${{ needs.set_env.outputs.SBPF_PROGRAM_PACKAGES }}
       rust-packages: ${{ needs.set_env.outputs.RUST_PACKAGES }}
       wasm-packages: ${{ needs.set_env.outputs.WASM_PACKAGES }}
+      idl-packages: ${{ needs.set_env.outputs.IDL_PACKAGES }}
       rustfmt-toolchain: ${{ needs.set_env.outputs.RUST_TOOLCHAIN_NIGHTLY }}
       clippy-toolchain: ${{ needs.set_env.outputs.RUST_TOOLCHAIN_NIGHTLY }}
       solana-cli-version: ${{ needs.set_env.outputs.SOLANA_CLI_VERSION }}

Cargo.lock

@@ -23,6 +23,10 @@ cargo-nightly:
 generate-clients:
 	@echo "No JavaScript clients to generate"
 
+generate-idl-%:
+	@cargo install --locked --version =0.7.3 codama-cli
+	codama-rs generate-idl $(call make-path,$*) -o $(call make-path,$*)/idl.json --pretty $(ARGS)
+
 audit:
 	cargo audit \
 			--ignore RUSTSEC-2022-0093 \

Makefile

@@ -1,2 +1,2 @@
 # associated-token-account
-The SPL Associated Token Account program and its clients
+The SPL Associated Token Account program

README.md

@@ -10,7 +10,12 @@ edition = "2021"
 [lib]
 crate-type = ["rlib"]
 
+[features]
+codama = ["dep:codama", "dep:codama-macros"]
+
 [dependencies]
+codama = { version = "0.7.3", optional = true }
+codama-macros = { version = "0.7.3", optional = true }
 solana-address = { version = "2.2.0", features = ["decode"] }
 
 [package.metadata.solana]

pinocchio/interface/Cargo.toml

@@ -1,3 +1,19 @@
 # `pinocchio-associated-token-account-interface`
 
 Pinocchio instructions and types for interacting with the Associated Token Account program.
+
+## Codama
+
+This crate includes Codama macros.
+
+Generate the IDL from repo root:
+
+```bash
+make generate-idl-pinocchio-interface
+```
+
+This writes:
+
+```text
+pinocchio/interface/idl.json
+```