codama-idl-codama/packages/nodes-from-anchor/README.md

Codama ➤ Nodes From Anchor

This package converts Anchor IDLs from various versions into Codama IDLs.

Installation

pnpm install @codama/nodes-from-anchor

[!NOTE]

• This package is not included in the main codama package.
• If metadata.origin is not set on the IDL, it is assumed to be "anchor". If you are trying to parse a Shank IDL, be sure that origin is set to "shank" so discriminators can be set correctly.

Functions

rootNodeFromAnchor(anchorIdl)

This function takes a valid Anchor IDL and returns a RootNode.

// node ./codama.mjs
import { rootNodeFromAnchor } from '@codama/nodes-from-anchor';
import { createFromRoot } from 'codama';
import { readFileSync } from 'node:fs';
import path from 'path';

// Read the content of your IDL file.
const anchorIdlPath = path.join(__dirname, 'target', 'idl', 'anchor_program.json');
const anchorIdl = JSON.parse(readFileSync(anchorIdlPath, 'utf-8'));

// Parse it into a Codama IDL.
const codama = createFromRoot(rootNodeFromAnchor(anchorIdl));