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

Add is_on_curve hint and basic test #1

Merged
merged 21 commits into from
Feb 5, 2024

Conversation

notlesh
Copy link

@notlesh notlesh commented Jan 31, 2024

Adds the is_on_curve SNOS hint.

src/hints/mod.rs Outdated
Comment on lines 353 to 355
// TODO: assume SECP_P is in scope, or should we use this constant?
// let SECP_P = cairo_vm::hint_processor::builtin_hint_processor::secp::secp_utils::SECP_P;
let SECP_P: BigInt = exec_scopes.get("SECP_P")?;
Copy link
Author

Choose a reason for hiding this comment

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

It's not clear from the hint whether this should have been injected into exec_scopes from some other code/hint or if it should just exist implicitly.

In any case, the constant mentioned (cairo_vm::hint_processor::builtin_hint_processor::secp::secp_utils::SECP_P) is private.

Choose a reason for hiding this comment

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

From other hints defined in cairo-vm (see here) it seems that SECP_P should be inserted at some point in the execution scope but is also a constant in the VM.

src/hints/mod.rs Outdated Show resolved Hide resolved
src/hints/tests.rs Outdated Show resolved Hide resolved
@notlesh notlesh requested a review from odesenfans February 2, 2024 17:10
src/hints/tests.rs Outdated Show resolved Hide resolved
src/hints/mod.rs Outdated Show resolved Hide resolved
src/hints/mod.rs Outdated Show resolved Hide resolved
src/hints/mod.rs Outdated
_constants: &HashMap<String, Felt252>,
) -> Result<(), HintError> {
let y: BigInt = exec_scopes.get("y")?;
// TODO: should y_square_int be calculated or should caller put it in scope for us?

Choose a reason for hiding this comment

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

Given the context, y_square_int is just a variable in exec_scopes. Looking at cairo-lang, I think it is set in ec.cairo.

Copy link
Author

Choose a reason for hiding this comment

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

I don't see it in ec.cairo, can you point me to where you see that?

src/hints/mod.rs Outdated Show resolved Hide resolved
src/hints/mod.rs Outdated
// constant)?
let secp_p: BigInt = exec_scopes.get("SECP_P")?;

let is_on_curve = (y.clone() * y) % secp_p == y_square_int;

Choose a reason for hiding this comment

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

Is that clone() required? Is BigInt not a Copy type?

Copy link
Author

Choose a reason for hiding this comment

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

BigInt doesn't impl Copy probably because it is arbitrarily large, so clone() is required.

@notlesh notlesh requested a review from odesenfans February 5, 2024 18:05
@notlesh notlesh merged commit c6443ff into Moonsong-Labs:msl/hints Feb 5, 2024
5 checks passed
odesenfans pushed a commit that referenced this pull request Feb 26, 2024
* Add is_on_curve hint and basic test

* Improve test

* Add TODO

* Update Cargo.lock

* Attempt at better ids_data

* Set fp and add another segment

* Clean up

* fmt

* Fix clippy lints

* fmt

* fmt

* Add IS_ON_CURVE to hints map

* Use constants for ONE and ZERO

* fmt

* Clean up secp_p comments

* Use vars for var names

* Remove duplicate mod tests
odesenfans pushed a commit that referenced this pull request Feb 26, 2024
* Add is_on_curve hint and basic test

* Improve test

* Add TODO

* Update Cargo.lock

* Attempt at better ids_data

* Set fp and add another segment

* Clean up

* fmt

* Fix clippy lints

* fmt

* fmt

* Add IS_ON_CURVE to hints map

* Use constants for ONE and ZERO

* fmt

* Clean up secp_p comments

* Use vars for var names

* Remove duplicate mod tests
notlesh added a commit that referenced this pull request Mar 22, 2024
* wip

* wip, some progress

* WIP: Declare unimplemented hints

* Fix unused warnings

* Hint: SET_SYSCALL_PTR (#4)

* Add is_n_ge_two hint (#3)

* first iteration of is_n_ge_two hint

* refactor is_n_ge_two hint. remove unused dependencies. start test

* set vm memory in test

* remove unused macros

* fix test and remove debugging prints

* add EOF line

* add test cases

* use rstest cases. refactor hint code to avoid using match. rename hint tests module.

* apply formatter

* add case for n > two

* remove End of file line

* run fmt+nightly command

* run fmt+nightly command

* add hint in hint map and use ids map (#6)

* add hint in hint map and use ids map

* remove unused macro. makes hint constant public

* Add is_on_curve hint and basic test (#1)

* Add is_on_curve hint and basic test

* Improve test

* Add TODO

* Update Cargo.lock

* Attempt at better ids_data

* Set fp and add another segment

* Clean up

* fmt

* Fix clippy lints

* fmt

* fmt

* Add IS_ON_CURVE to hints map

* Use constants for ONE and ZERO

* fmt

* Clean up secp_p comments

* Use vars for var names

* Remove duplicate mod tests

* Add set_ap_to_actual_fee hint (#2)

Co-authored-by: Olivier Desenfans <[email protected]>
Co-authored-by: Herman Obst Demaestri <[email protected]>

* Add txn/call hints (#5)

Co-authored-by: Olivier Desenfans <[email protected]>

* Add preimage hints (#8)

Co-authored-by: Olivier Desenfans <[email protected]>

* Feature: read/write Cairo structs safely (#9)

Problem: Cairo structs are accessed in some hints. The Python VM has
abstractions to access fields by name that the Rust VM cannot implement.
This leads to accessing these structs by hardcoding the offset of each
field.

Solution: The new `CairoType` trait allows to read/write an entire
struct in one go. The derive implementation reads/writes fields one by
one according to their place in the struct definition. For cases where
reading/writing the whole struct is not appropriate, the new
`FieldOffsetGetters` macro implements a `get_<field>_offset()` method
for each field of the struct to avoid hardcoding values.

* fix tests

* one more hint

* fix contracts in StarknetOsInput

* few more hints

* ignore block test

* Add a couple missing hints

* calculate tx_hash

* fix TRANSACTIONS_LEN

* Maybe-fix gen_signature_arg hint

* Don't put signature in ap

* remove unnecesary unwraps

* fix post merge problems

* remove outdated tests

* is_reverted hint

* wip

* Pull in relevant hashing code from starknet_on_rust

* Convert equivalent contract structs

* wip

* test with cairo1

* cairo1 test setup, breaks at hint trying to load v1 class

* wip

* wip

* cairo1 class loading + execution without cairo1 hint processor

* fix tests

* fix clippy

* first round of comments

* fix typo

* remove unnecessary code

---------

Co-authored-by: Olivier Desenfans <[email protected]>
Co-authored-by: Herman Obst Demaestri <[email protected]>
Co-authored-by: Stephen Shelton <[email protected]>
odesenfans added a commit that referenced this pull request Mar 23, 2024
* wip

* wip, some progress

* WIP: Declare unimplemented hints

* Fix unused warnings

* Hint: SET_SYSCALL_PTR (#4)

* Add is_n_ge_two hint (#3)

* first iteration of is_n_ge_two hint

* refactor is_n_ge_two hint. remove unused dependencies. start test

* set vm memory in test

* remove unused macros

* fix test and remove debugging prints

* add EOF line

* add test cases

* use rstest cases. refactor hint code to avoid using match. rename hint tests module.

* apply formatter

* add case for n > two

* remove End of file line

* run fmt+nightly command

* run fmt+nightly command

* add hint in hint map and use ids map (#6)

* add hint in hint map and use ids map

* remove unused macro. makes hint constant public

* Add is_on_curve hint and basic test (#1)

* Add is_on_curve hint and basic test

* Improve test

* Add TODO

* Update Cargo.lock

* Attempt at better ids_data

* Set fp and add another segment

* Clean up

* fmt

* Fix clippy lints

* fmt

* fmt

* Add IS_ON_CURVE to hints map

* Use constants for ONE and ZERO

* fmt

* Clean up secp_p comments

* Use vars for var names

* Remove duplicate mod tests

* Add set_ap_to_actual_fee hint (#2)

Co-authored-by: Olivier Desenfans <[email protected]>
Co-authored-by: Herman Obst Demaestri <[email protected]>

* Add txn/call hints (#5)

Co-authored-by: Olivier Desenfans <[email protected]>

* Add preimage hints (#8)

Co-authored-by: Olivier Desenfans <[email protected]>

* Feature: read/write Cairo structs safely (#9)

Problem: Cairo structs are accessed in some hints. The Python VM has
abstractions to access fields by name that the Rust VM cannot implement.
This leads to accessing these structs by hardcoding the offset of each
field.

Solution: The new `CairoType` trait allows to read/write an entire
struct in one go. The derive implementation reads/writes fields one by
one according to their place in the struct definition. For cases where
reading/writing the whole struct is not appropriate, the new
`FieldOffsetGetters` macro implements a `get_<field>_offset()` method
for each field of the struct to avoid hardcoding values.

* fix tests

* one more hint

* fix contracts in StarknetOsInput

* few more hints

* ignore block test

* Add a couple missing hints

* calculate tx_hash

* fix TRANSACTIONS_LEN

* Maybe-fix gen_signature_arg hint

* Don't put signature in ap

* remove unnecesary unwraps

* fix post merge problems

* remove outdated tests

* is_reverted hint

* wip

* Pull in relevant hashing code from starknet_on_rust

* Convert equivalent contract structs

* wip

* test with cairo1

* cairo1 test setup, breaks at hint trying to load v1 class

* wip

* wip

* cairo1 class loading + execution without cairo1 hint processor

* fix tests

* fix clippy

* first round of comments

* wip

* cairo1 syscall handler

* fix imports

* fix fmt, clippy

* fix clippy

* fix fmt

---------

Co-authored-by: Olivier Desenfans <[email protected]>
Co-authored-by: Herman Obst Demaestri <[email protected]>
Co-authored-by: Stephen Shelton <[email protected]>
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