Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update SDK example for app and EVM proofs #1163

Merged
merged 4 commits into from
Jan 4, 2025

Conversation

ytham
Copy link
Contributor

@ytham ytham commented Jan 3, 2025

  • Splits Book SDK section into two subsections for app and EVM proofs.
  • Separates sdk example sdk.rs into two files: sdk_app.rs, sdk_evm.rs
    • NOTE: there is a fair amount of reused code; this was done intentionally for the sake of making the examples easier to read in isolation, as well as to keep the imports in the book a bit cleaner. I can create some common functions instead if it's preferred.

@ytham ytham requested review from jonathanpwang, arayikhalatyan and yi-sun and removed request for arayikhalatyan January 3, 2025 02:41
book/src/SUMMARY.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jonathanpwang jonathanpwang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if the sdk md stays in one file, we can make the EVM Proof part a larger heading and explain that the generate_app_proof does not need to be called.

The sdk_app.rs, sdk_evm.rs split makes sense.

Copy link
Contributor

@jonathanpwang jonathanpwang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jonathanpwang jonathanpwang merged commit 226b353 into main Jan 4, 2025
4 checks passed
@jonathanpwang jonathanpwang deleted the feat/update_sdk_example branch January 4, 2025 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants