IDL: update to use codama macros #180

rustopian · 2025-11-14T17:49:32Z

Most of the diff is generated code (clients and lockfiles) - CI demands it

Problem

Client generation uses a lot of fragile manual scripting.

Solution

Update to using Codama macros, including the new Codama support for doc fields and tuples as instruction arguments.

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

grod220

Very cool!

codama.json

grod220 · 2025-11-25T20:49:27Z

interface/src/bin/generate-idl.rs

Relevant feedback from another PR: solana-program/record#130 (comment). The feedback on build.rs, makefile+ci/cd support, and feature flagging is worth including here too.

Nice tip, added all of this

grod220 · 2025-11-25T20:58:15Z

interface/src/instruction.rs

-    Initialize(Authorized, Lockup),
+    #[codama(account(name = "stake", writable, docs = "Uninitialized stake account"))]
+    #[codama(account(name = "rent_sysvar", docs = "Rent sysvar"))]
+    Initialize { arg0: Authorized, arg1: Lockup },


I think we need codama support for the tuple variant as this is a breaking change

PRed upstream at codama-idl/codama-rs#73, and now the tuples are restored in this PR

grod220 · 2025-11-25T21:01:16Z

scripts/generate-clients.mts

    },
    {
      // Use omitted optional account strategy for all instructions.
+      // + fix discriminator u8 -> u32.


What's the story with this?

Why do we have to do this if the macro is

#[codama(enum_discriminator(size = number(u32)))]

Originally fixed at this level in #54

This is still the behavior of things. Despite the macro specifying u32, the IDL ends up with u8 and the clients do as well.

If you remove this tiny fix, all clients will have u8s and U8Decoder etc.

grod220 · 2025-11-25T21:04:01Z

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

-  // Resolve default values.
-  if (!accounts.clockSysvar.value) {
-    accounts.clockSysvar.value =
-      'SysvarC1ock11111111111111111111111111111111' as Address<'SysvarC1ock11111111111111111111111111111111'>;
-  }


I think we can specify default values in the macro like:

#[codama(account( name = "clock_sysvar", docs = "Clock sysvar", default_value = "SysvarC1ock11111111111111111111111111111111" ))]

I've done a visitor here instead since Codama doesn't (yet) handle Pubkey types correctly without custom handling. It should create a publicKeyValueNode but doesn't.

@grod220 I found out that codama does these differently. This works!

default_value = sysvar("clock")

Cf https://github.com/codama-idl/codama-rs/blob/main/codama-attributes/src/codama_directives/value_nodes/sysvar.rs#L5

grod220 · 2025-11-25T21:07:34Z

interface/src/instruction.rs

    }

-    Instruction::new_with_bincode(ID, &StakeInstruction::Withdraw(lamports), account_metas)
+    Instruction::new_with_bincode(ID, &StakeInstruction::Withdraw { lamports }, account_metas)


Think we should keep these fns for forward compatibility (for now) and swap out the innards where the account metas / inputs are manually being written---for the new builders. Given these are used in tests (I think) it will also validate the builders work against test code.

I like this! Will work on this a subsequent PR, if that's okay with you.

grod220 · 2025-11-25T21:09:44Z

codama.json

+  "$schema": "https://codama.gg/schemas/codama.json",
+  "idls": [
+    {
+      "path": "interface/idl.json",


separately: what's the deal with program/idl.json? Should that be deleted?

Yup, old file. Removed

grod220 · 2025-11-25T21:12:41Z

interface/src/state.rs

 pub enum StakeAuthorize {
    Staker,
    Withdrawer,
 }


Does this need a codama enum attr?

grod220

Amazing work, think we are close!

grod220 · 2025-12-09T16:25:56Z

interface/Cargo.toml

+codama = { version = "0.6.5", git = "https://github.com/rustopian/codama-rs", branch = "custom-tuple-arg-names", optional = true }
+codama-macros = { version = "0.6.5", git = "https://github.com/rustopian/codama-rs", branch = "custom-tuple-arg-names", optional = true }


Any chance a release is coming soon? :)

Yup Loris since published 6.6, will update!

.github/workflows/main.yml

grod220 · 2025-12-09T16:29:36Z

package.json

    "@codama/nodes-from-anchor": "^1.3.6",
    "@codama/renderers-js": "^1.4",
-    "@codama/renderers-rust": "~1.0",
+    "@codama/renderers-rust": "1.2.9",


Probably can go with ^1.2.9 versus being pinned

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

clients/rust/Cargo.toml

grod220 · 2025-12-09T17:36:54Z

program/tests/stake_instruction.rs

We probably need these right?

grod220 · 2025-12-09T17:42:05Z

scripts/generate-clients.mts

+            // Add Epoch type alias
+            c.definedTypeNode({
+              name: 'epoch',
+              type: c.numberTypeNode('u64'),
+            }),
+            // Add UnixTimestamp type alias
+            c.definedTypeNode({
+              name: 'unixTimestamp',
+              type: c.numberTypeNode('i64'),
+            }),
+            ...node.definedTypes,


Any motivation for these?

The clarity of named types (as in the program itself)

grod220 · 2025-12-09T17:43:45Z

scripts/generate-clients.mts

+// Unwrap defined type links used only as instruction args, then flatten them
+codama.update(c.unwrapInstructionArgsDefinedTypesVisitor());
+codama.update(c.flattenInstructionDataArgumentsVisitor());


Sorry, having a hard time understanding this one. Can you give more context?

scripts/generate-clients.mts

grod220 · 2025-12-09T17:44:38Z

scripts/generate-clients.mts

+          arguments: node.arguments.map((arg) =>
+            arg.name === 'discriminator'
+              ? { ...arg, type: c.numberTypeNode('u32') }
+              : arg
+          ),


Is this due to the codama dep bump where discriminators are added?

rustopian added 3 commits November 14, 2025 17:48

update to use codama macros

01a6916

Merge branch 'main' into codama

6b40853

fmt

fb1cc44

rustopian changed the title ~~update to use codama macros~~ [WIP] update to use codama macros Nov 14, 2025

rustopian added 2 commits November 14, 2025 17:55

generated clients

722f30b

fix type collisions

c31a3dd

rustopian requested a review from grod220 November 14, 2025 22:17

restore omitted u32 disc casts

066e986

rustopian changed the title ~~[WIP] update to use codama macros~~ IDL: [WIP] update to use codama macros Nov 14, 2025

rustopian added 3 commits November 14, 2025 22:33

instruction u8->u32 transformer

0e5cbef

re-hide redelegate from client gen

2d3868a

cleanup

c2c1676

rustopian force-pushed the codama branch from 0f9c0bc to c2c1676 Compare November 15, 2025 08:27

rustopian added 2 commits November 18, 2025 11:40

align (un-break) some account and arg names

e2fbb50

explicitly use arg0, arg1 to prevent breaking

154660f

rustopian commented Nov 18, 2025

View reviewed changes

clients/js/src/generated/instructions/authorize.ts Show resolved Hide resolved

rustopian added 5 commits November 18, 2025 13:32

use ugly name (unbreak)

d400f91

fix tests

37f1e09

use codama 0.6.4 docs param

be3521b

properly flatten instruction arguments

fd6e639

rm broken doc link

2b1b4aa

rustopian marked this pull request as ready for review November 24, 2025 11:24

rustopian changed the title ~~IDL: [WIP] update to use codama macros~~ IDL: update to use codama macros Nov 24, 2025

grod220 reviewed Nov 25, 2025

View reviewed changes

rm old idl, update format value, add sysvar defaults

9e5e13f

rustopian force-pushed the codama branch from 7d4f89b to 9e5e13f Compare December 3, 2025 15:09

use codama sysvar() helper for defaults

63b546c

rustopian force-pushed the codama branch from ef0e9e8 to 63b546c Compare December 4, 2025 13:37

rustopian marked this pull request as draft December 4, 2025 13:45

featurize codama

8331188

rustopian added 4 commits December 4, 2025 16:28

spellcheck

3ec54ab

re-sync (#209)

a7e1cf7

update idl after re-sync

f636e75

Merge branch 'main' into codama

a3ee7eb

rustopian marked this pull request as ready for review December 4, 2025 17:00

rustopian requested a review from grod220 December 4, 2025 17:00

rustopian marked this pull request as draft December 4, 2025 17:02

rustopian force-pushed the codama branch 5 times, most recently from a205eed to d2ac5e8 Compare December 4, 2025 18:11

use named tuple fields

3faa2c7

rustopian force-pushed the codama branch from d2ac5e8 to 3faa2c7 Compare December 4, 2025 18:14

rustopian added 2 commits December 4, 2025 18:16

revert changed account name

af32b99

fmt

cdfbd82

rustopian marked this pull request as ready for review December 4, 2025 18:32

update codama renderers-rust ver

acad1ac

rustopian force-pushed the codama branch from b834751 to acad1ac Compare December 9, 2025 07:19

rustopian marked this pull request as draft December 9, 2025 08:20

crate serialization features

8ec4ab8

rustopian marked this pull request as ready for review December 9, 2025 09:50

rustopian mentioned this pull request Dec 9, 2025

tests: Mollusk Initialize tests (1/9) #161

Draft

grod220 reviewed Dec 9, 2025

View reviewed changes

		codama = { version = "0.6.5", git = "https://github.com/rustopian/codama-rs", branch = "custom-tuple-arg-names", optional = true }
		codama-macros = { version = "0.6.5", git = "https://github.com/rustopian/codama-rs", branch = "custom-tuple-arg-names", optional = true }

IDL: update to use codama macros #180

Are you sure you want to change the base?

IDL: update to use codama macros #180

Conversation

rustopian commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Uh oh!

Uh oh!

grod220 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustopian Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustopian Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustopian Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

grod220 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustopian Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

rustopian commented Nov 14, 2025 •

edited

Loading

rustopian Dec 4, 2025 •

edited

Loading

rustopian Dec 4, 2025 •

edited

Loading

rustopian Dec 3, 2025 •

edited

Loading

rustopian Dec 9, 2025 •

edited

Loading