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

update docs #44

Merged
merged 1 commit into from
Oct 21, 2022
Merged

update docs #44

merged 1 commit into from
Oct 21, 2022

Conversation

leonardoalt
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@hrkrshnn hrkrshnn left a comment

Choose a reason for hiding this comment

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

Fine to merge. I'll make a new PR that adds my suggestions

Comment on lines +5 to +10
In order to commit your contract, call function `commit(bytes32 key)` where
`key = keccak256(abi.encode(sender, codehash, salt))`, `sender` is the address
you intend to use when performin the challenge, `codehash` is the code hash of
your solution contract, and `salt` is any number of your choice. This will
(hopefully) make sure that you do not know the challenge inputs in advance, and
that only you can use your contract.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should probably add that the salting is done so that an external observer wouldn't be able to know the contract that solves the challenge in advance.

Comment on lines +15 to +16
should be the owner of the newly minted NFT, in case you become the leader; and
`salt` must be the same you passed when committing.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should just say that the salt should match the one you used to commit.

@hrkrshnn hrkrshnn merged commit 5e3cb4d into main Oct 21, 2022
@hrkrshnn hrkrshnn deleted the update_docs branch October 21, 2022 16:23
know the challenge inputs in advance, and that only you can use your contract.
In order to commit your contract, call function `commit(bytes32 key)` where
`key = keccak256(abi.encode(sender, codehash, salt))`, `sender` is the address
you intend to use when performin the challenge, `codehash` is the code hash of
Copy link
Collaborator

Choose a reason for hiding this comment

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

"performing". Will fix

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