fix(IEntropy): revealWithCallback comment (#1404)

* fix reveal comment

* update comment
This commit is contained in:
Dev Kalra 2024-03-28 14:55:31 +05:30 committed by GitHub
parent 02e196e924
commit 6fb5ab483d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 9 deletions

View File

@ -363,10 +363,10 @@ abstract contract Entropy is IEntropy, EntropyState {
clearRequest(provider, sequenceNumber); clearRequest(provider, sequenceNumber);
} }
// Fulfill a request for a random number and call back the requester. This method validates the provided userRandomness // Fulfill a request for a random number. This method validates the provided userRandomness
// and provider's revelation against the corresponding commitment in the in-flight request. If both values are validated // and provider's revelation against the corresponding commitment in the in-flight request. If both values are validated
// and the requestor address is a contract address, this function calls the requester's entropyCallback method with the // and the requestor address is a contract address, this function calls the requester's entropyCallback method with the
// sequence number and the random number as arguments. Else if the requestor is an EOA, it won't call it. // sequence number, provider address and the random number as arguments. Else if the requestor is an EOA, it won't call it.
// //
// Note that this function can only be called once per in-flight request. Calling this function deletes the stored // Note that this function can only be called once per in-flight request. Calling this function deletes the stored
// request information (so that the contract doesn't use a linear amount of storage in the number of requests). // request information (so that the contract doesn't use a linear amount of storage in the number of requests).

View File

@ -51,10 +51,9 @@ interface IEntropy is EntropyEvents {
bytes32 userRandomNumber bytes32 userRandomNumber
) external payable returns (uint64 assignedSequenceNumber); ) external payable returns (uint64 assignedSequenceNumber);
// Fulfill a request for a random number and call back the requester. This method validates the provided userRandomness // Fulfill a request for a random number. This method validates the provided userRandomness and provider's proof
// and provider's revelation against the corresponding commitment in the in-flight request. If both values are validated // against the corresponding commitments in the in-flight request. If both values are validated, this function returns
// and the requestor address is a contract address, this function calls the requester's entropyCallback method with the // the corresponding random number.
// sequence number and the random number as arguments. Else if the requestor is an EOA, it won't call it.
// //
// Note that this function can only be called once per in-flight request. Calling this function deletes the stored // Note that this function can only be called once per in-flight request. Calling this function deletes the stored
// request information (so that the contract doesn't use a linear amount of storage in the number of requests). // request information (so that the contract doesn't use a linear amount of storage in the number of requests).
@ -66,9 +65,10 @@ interface IEntropy is EntropyEvents {
bytes32 providerRevelation bytes32 providerRevelation
) external returns (bytes32 randomNumber); ) external returns (bytes32 randomNumber);
// Fulfill a request for a random number and call back the requester. This method validates the provided userRandomness // Fulfill a request for a random number. This method validates the provided userRandomness
// and provider's revelation against the corresponding commitment in the in-flight request. If both values are validated, // and provider's revelation against the corresponding commitment in the in-flight request. If both values are validated
// this function calls the requester's entropyCallback method with the sequence number and the random number as arguments. // and the requestor address is a contract address, this function calls the requester's entropyCallback method with the
// sequence number, provider address and the random number as arguments. Else if the requestor is an EOA, it won't call it.
// //
// Note that this function can only be called once per in-flight request. Calling this function deletes the stored // Note that this function can only be called once per in-flight request. Calling this function deletes the stored
// request information (so that the contract doesn't use a linear amount of storage in the number of requests). // request information (so that the contract doesn't use a linear amount of storage in the number of requests).