TS solana binding generator#502
Merged
Merged
Conversation
…solana-ts-bindings
…solana-ts-bindings
…/cre-cli into feat/solana-ts-bindings
…/cre-cli into feat/solana-ts-bindings
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TypeScript binding generator
cmd/generate-bindings/solana/tsbindgen.go(in the CLI repo) generates two files from an Anchor IDL:<ProgramName>.ts) that:@solana/codecscodec expressions for every IDL type (structs, scalar enums, options, vecs, fixed arrays, all primitive types including pubkeys).writeReport,writeReportFromBorshEncodedVec,writeReportFrom<Struct>, andwriteReportFrom<Struct>smethods for every struct type.decode<Name>Account,decode<Name>Event).<ProgramName>_mock.ts) that wires the binding class againstaddSolanaContractMockfor use in unit tests.For the end user
The binding command will use the path
contracts/solana/src/idl/by default when--idlis not specified. So user workflow directory structure would look like this:Command scans every
*.jsonin the idl directory and generates one binding class per file. You can also pass a single file with--idl path/to/contract.json. Language is auto-detected from whether the project contains.goor.tsfiles, or override with--language typescript.