Skip to content

Commit 634b4f2

Browse files
committed
feat: add ABI generation guide and type lowering specification
Adds comprehensive documentation for Leo's ABI generation feature: - Create `guides/11_abi.md` covering ABI format, type reference, and lowering specification (optional types, storage vectors, tuples) - Update `guides/00_overview.md` to link new ABI guide - Update `cli/03_build.md` to mention ABI output location
1 parent 5b16c5b commit 634b4f2

File tree

3 files changed

+533
-0
lines changed

3 files changed

+533
-0
lines changed

β€Ždocumentation/cli/03_build.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,11 @@ On invoking the build command, Leo automatically creates a `build/⁠` and `outp
2121
Leo 2 statements after dead code elimination.
2222
Leo The program checksum is: '[...]'.
2323
Leo βœ… Compiled '{PROGRAM_NAME}.aleo' into Aleo instructions.
24+
Leo βœ… Generated ABI at 'build/abi.json'.
2425
```
2526

27+
The build also generates an **ABI file** at `build/abi.json` describing your program's public interface (transitions, mappings, and types). See the [ABI Generation guide](../guides/11_abi.md) for details on the format and type lowering specification.
28+
2629
### Flags:
2730
```
2831
--offline

β€Ždocumentation/guides/00_overview.mdβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ There's a lot to learn about Leo! To help tame the complexity, we've put togethe
3030

3131
- [**Upgrading Programs**](./10_program_upgradability.md) - Coming soon!
3232

33+
- [**ABI Generation**](./11_abi.md) - Learn about the ABI format and type lowering for SDK integration.
34+

0 commit comments

Comments
Β (0)