Skip to content
This repository was archived by the owner on May 4, 2026. It is now read-only.

Commit c9f3e9b

Browse files
authored
Merge pull request #563 from ProvableHQ/mitchmindtree/abi
feat: add ABI generation guide and type lowering specification
2 parents c56a86c + 61d6b69 commit c9f3e9b

5 files changed

Lines changed: 539 additions & 0 deletions

File tree

β€Ž.github/mlc_config.jsonβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"retryOn429": true,
3+
"retryCount": 3,
4+
"fallbackRetryDelay": "30s"
5+
}

β€Ž.github/workflows/ci-branches.ymlβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ jobs:
1515
- uses: gaurav-nelson/github-action-markdown-link-check@v1
1616
with:
1717
folder-path: 'documentation'
18+
config-file: '.github/mlc_config.json'

β€Ž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)