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

Fix documentation on revocation_lock #64

Open
indomitableSwan opened this issue Oct 5, 2021 · 3 comments
Open

Fix documentation on revocation_lock #64

indomitableSwan opened this issue Oct 5, 2021 · 3 comments

Comments

@indomitableSwan
Copy link
Contributor

indomitableSwan commented Oct 5, 2021

The documentation was not updated appropriately when revocation_lock was changed from bytes to BLS12-381 scalar. It still says it is initialized to 0x00, when instead it is passed in as an argument during origination and is no longer type bytes. (Do we enforce anything about the initialized value? Does the merchant accept any value for this now?) @jakinyele @marsella @DariusParvin

@marsella
Copy link
Contributor

marsella commented Oct 5, 2021

In zeekoe, we pass 0x00 which according to our documentation is parsed as the scalar 0.

The invariant I decided on is that one should only access the revocation lock when they actually need it (that is, when the contract is in cust_close status), so it doesn't matter what it is initialized to. However, this invariant is not enforced at compile time / with types in zeekoe yet (see boltlabs-inc/zeekoe#199).

I cannot speak to whether the contract enforces anything about the initialized value.

@DariusParvin
Copy link
Contributor

The documentation is correct in that pytezos parses 0x00 as the scalar 0.
The contract itself doesn't enforce anything other than the value being a valid BLS12-381 scalar.

@indomitableSwan
Copy link
Contributor Author

indomitableSwan commented Oct 5, 2021

The documentation is correct in that pytezos parses 0x00 as the scalar 0. The contract itself doesn't enforce anything other than the value being a valid BLS12-381 scalar.

but the documentation isn't correct since it isn't necessarily 0x00 and it is now an argument that is passed in instead of an initialized value. Can you please fix? @DariusParvin

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

3 participants