Skip to content

Commit 5a5ac66

Browse files
committed
chore: update incorrect comments (OZ N-10)
Signed-off-by: Tomás Migone <[email protected]>
1 parent ef7417c commit 5a5ac66

File tree

7 files changed

+8
-9
lines changed

7 files changed

+8
-9
lines changed

packages/horizon/contracts/data-service/extensions/DataServiceFees.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ abstract contract DataServiceFees is DataService, DataServiceFeesV1Storage, IDat
8888
* @dev This function is used as a callback in the stake claims linked list traversal.
8989
* @param _claimId The id of the stake claim
9090
* @param _acc The accumulator for the stake claims being processed
91-
* @return Wether the stake claim is still locked, indicating that the traversal should continue or stop.
91+
* @return Whether the stake claim is still locked, indicating that the traversal should continue or stop.
9292
* @return The updated accumulator data
9393
*/
9494
function _processStakeClaim(bytes32 _claimId, bytes memory _acc) private returns (bool, bytes memory) {

packages/horizon/contracts/data-service/utilities/ProvisionManager.sol

-2
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,6 @@ abstract contract ProvisionManager is Initializable, GraphDirectory, ProvisionMa
153153
* the {HorizonStaking} contract.
154154
* @dev Checks the pending provision parameters, not the current ones.
155155
*
156-
* Emits a {ProvisionPendingParametersAccepted} event.
157-
*
158156
* @param _serviceProvider The address of the service provider.
159157
*/
160158
function _acceptProvisionParameters(address _serviceProvider) internal {

packages/horizon/contracts/interfaces/IAuthorizable.sol

+3-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ interface IAuthorizable {
100100
* - `proof` must be a valid signature from the signer being authorized
101101
*
102102
* Emits a {SignerAuthorized} event
103-
* @param signer The addres of the signer
103+
* @param signer The address of the signer
104104
* @param proofDeadline The deadline for the proof provided by the signer
105105
* @param proof The proof provided by the signer to be authorized by the authorizer
106106
* consists of (chain id, verifying contract address, domain, proof deadline, authorizer address)
@@ -141,7 +141,8 @@ interface IAuthorizable {
141141
function revokeAuthorizedSigner(address signer) external;
142142

143143
/**
144-
* @notice Returns the timestamp at which the thawing period ends for a signer
144+
* @notice Returns the timestamp at which the thawing period ends for a signer.
145+
* Returns 0 if the signer is not thawing.
145146
* @param signer The address of the signer
146147
* @return The timestamp at which the thawing period ends
147148
*/

packages/horizon/contracts/interfaces/internal/IHorizonStakingMain.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface IHorizonStakingMain {
2424
/**
2525
* @notice Emitted when a service provider unstakes tokens during the transition period.
2626
* @param serviceProvider The address of the service provider
27-
* @param tokens The amount of tokens unstaked
27+
* @param tokens The amount of tokens now locked (including previously locked tokens)
2828
* @param until The block number until the stake is locked
2929
*/
3030
event HorizonStakeLocked(address indexed serviceProvider, uint256 tokens, uint256 until);

packages/horizon/contracts/libraries/MathUtils.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ library MathUtils {
1313
* @dev Calculates the weighted average of two values pondering each of these
1414
* values based on configured weights. The contribution of each value N is
1515
* weightN/(weightA + weightB). The calculation rounds up to ensure the result
16-
* is always greater than the smallest of the two values.
16+
* is always equal or greater than the smallest of the two values.
1717
* @param valueA The amount for value A
1818
* @param weightA The weight to use for value A
1919
* @param valueB The amount for value B

packages/horizon/contracts/payments/collectors/GraphTallyCollector.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ contract GraphTallyCollector is EIP712, GraphDirectory, Authorizable, IGraphTall
8888
* This variant adds the ability to partially collect a RAV by specifying the amount of tokens to collect.
8989
* @param _paymentType The payment type to collect
9090
* @param _data Additional data required for the payment collection
91-
* @param _tokensToCollect The amount of tokens to collect
91+
* @param _tokensToCollect The amount of tokens to collect. If 0, all tokens from the RAV will be collected.
9292
* @return The amount of tokens collected
9393
*/
9494
function _collect(

packages/subgraph-service/contracts/DisputeManager.sol

+1-1
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ contract DisputeManager is
413413
)
414414
);
415415

416-
// Only one dispute for a (indexer, subgraphDeploymentId) at a time
416+
// Only one dispute at a time
417417
require(!isDisputeCreated(disputeId), DisputeManagerDisputeAlreadyCreated(disputeId));
418418

419419
// Store dispute

0 commit comments

Comments
 (0)