Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lthiery committed Aug 24, 2023
1 parent 0d2dede commit 4037ad1
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# helium-anchor-gen

Generates a Rust CPI client for the Helium Program Library. This is intended to avoid the strict dependencies declared in the solana-program-library that gets inherited by the helium-program-library.

## IDL Updates

The files in the `idl` directory are output from build `helium-program-library`.

With `anchor-cli 0.26`, run `anchor build` in the `helium-program-library`. The output from `target/idl` may be copied over to the `idl` directory here.

## Other notes

The crates under `programs` exist to generate the CPI crates. Do not add code there!

For those programs that benefit from importing of some functions from `helium-program-library`, the CPI types are re-exported and the helpful functions are defined under `src`.

0 comments on commit 4037ad1

Please sign in to comment.