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

zkvm: clearer API distinction and documentation #222

Open
vickiniu opened this issue Mar 14, 2019 · 1 comment
Open

zkvm: clearer API distinction and documentation #222

vickiniu opened this issue Mar 14, 2019 · 1 comment
Assignees

Comments

@vickiniu
Copy link
Contributor

In #218, the program calls prove_program_predicate, which should generally only be called indirectly when verifying a Predicate::Program variant. Looking at the zkvm codebase right now, it's a little confusing / unclear what functions should be used for building transactions (& which are internal to zkvm), especially since we expose many of them publicly.

Would be great to flesh out the ZkVM API doc with more traditional documentation of the functions, and also only expose as pub functions that should be used in tx-building.

@oleganza
Copy link
Contributor

Yeah, i guess we can expand the Predicates section of the API guide on how to construct and interact with them (and add examples with Program::build/PredicateTree API)

@vickiniu vickiniu self-assigned this Mar 22, 2019
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

No branches or pull requests

2 participants