feat: docs #8
Merged
feat: docs #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathanpwang
approved these changes
Feb 14, 2024
| } | ||
|
|
||
| /// A trait for specifying an Axiom Compute function | ||
| pub trait AxiomComputeFn: AxiomComputeInput { |
There was a problem hiding this comment.
add comment that FirstPhasePayload is only for compute_phase1 is optional
sdk/src/api.rs
Outdated
| @@ -24,6 +24,7 @@ use crate::{ | |||
| Fr, | |||
| }; | |||
|
|
|||
| /// Axiom Circuit API | |||
There was a problem hiding this comment.
a bit more commentary that this is the api for both Axiom calls and zk primitives
| @@ -24,6 +24,7 @@ use crate::{ | |||
| Fr, | |||
| }; | |||
|
|
|||
| /// Axiom Circuit API | |||
| pub struct AxiomAPI<'a> { | |||
| pub builder: &'a mut RlcCircuitBuilder<Fr>, | |||
There was a problem hiding this comment.
add basic comment this is an axiom-eth / halo2-lib struct
| @@ -24,6 +24,7 @@ use crate::{ | |||
| Fr, | |||
| }; | |||
|
|
|||
| /// Axiom Circuit API | |||
| pub struct AxiomAPI<'a> { | |||
| pub builder: &'a mut RlcCircuitBuilder<Fr>, | |||
| pub range: &'a RangeChip<Fr>, | |||
There was a problem hiding this comment.
comment this is main chip for zk primitives
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.