Codama ➤ Renderers ➤ Web3.js

This package generates TypeScript clients from your Codama IDLs. The generated clients are compatible with @solana/web3.js.

Installation

pnpm install renderers-web3js

Usage

Add the following script to your Codama configuration file.

{
    "scripts": {
        "web3js": {
            "from": "renderers-web3js",
            "args": ["clients/js"]
        }
    }
}

The first argument is the package folder — i.e. where the package.json lives. The generated files will be written to src/generated within that folder by default.

An object can be passed as a second argument to further configure the renderer. See the Options section below for more details.

Options

The renderVisitor accepts the following options.

Name	Type	Default	Description
deleteFolderBeforeRendering	boolean	true	Whether the base directory should be cleaned before generating new files.
formatCode	boolean	true	Whether we should use Oxfmt to format the generated code.
packageFolder	string	'src/generated'	The path to the generated folder relative to the package folder. Pass an empty string to write directly to the first argument.
oxfmtOptions	OxfmtOptions	{}	The options to use when formatting the code using Oxfmt.
customAccountData	CustomDataOptions[]	[]	The names of all AccountNodes whose data should be manually written in TypeScript.
customInstructionData	CustomDataOptions[]	[]	The names of all InstructionNodes whose data should be manually written in TypeScript.
linkOverrides	LinkOverrides	{}	An object that overrides the import path of link nodes. For instance, { definedTypes: { counter: 'hooked' } } uses the hooked folder to import any link node referring to the counter type.
internalNodes	string[]	[]	The names of all nodes that should be generated but not exported by the index.ts files.
renderParentInstructions	boolean	false	When using nested instructions, whether the parent instructions should also be rendered. When set to false (default), only the instruction leaves are being rendered.
dependencyMap	Record<string, string>	{}	A mapping between import aliases and their actual package name or path in TypeScript.
nameTransformers	Partial<NameTransformers>	{}	An object that enables us to override the names of any generated type, constant or function.
asyncResolvers	string[]	[]	The exhaustive list of ResolverValueNode names whose implementation is asynchronous in TypeScript.
syncPackageJson	boolean	true	Whether to update the dependencies of the existing package.json — or create a new package.json when missing — inside the package folder.
dependencyVersions	Record<string, string>	{}	A mapping between external package names — e.g. @solana/web3.js — and the version range we should use for them. The renderer offers default values for all external dependencies it relies on but this option may be used to override some of these values or add new ones.
nonScalarEnums	string[]	[]	The names of enum variants with no data that should be treated as a data union instead of a native enum type. This is only useful if you are referencing an enum value in your Codama IDL.

Credits

This project is based on @pratikbuilds/web3js-legacy by Pratik.