diff --git a/packages/core/contracts/optimistic-asserter/implementation/OptimisticAsserter.sol b/packages/core/contracts/optimistic-asserter/implementation/OptimisticAsserter.sol index 66251b3fdb..114d64c210 100644 --- a/packages/core/contracts/optimistic-asserter/implementation/OptimisticAsserter.sol +++ b/packages/core/contracts/optimistic-asserter/implementation/OptimisticAsserter.sol @@ -119,17 +119,17 @@ contract OptimisticAsserter is OptimisticAsserterInterface, Lockable, Ownable, M * recipient _must_ implement these callbacks and not revert or the assertion resolution will be blocked. * @param escalationManager if configured, this address will control escalation properties of the assertion. This * means a) choosing to arbitrate via the UMA DVM, b) choosing to discard assertions on dispute, or choosing to - * validate disputes. Combining these, the asserter can define their own security properties the assertion. + * validate disputes. Combining these, the asserter can define their own security properties for the assertion. * escalationManager also _must_ implement the same callbacks as callbackRecipient. * @param liveness time to wait before the assertion can be resolved. Assertion can be disputed in this time. * @param currency bond currency pulled from the caller and held in escrow until the assertion is resolved. * @param bond amount of currency to pull from the caller and hold in escrow until the assertion is resolved. This * must be >= getMinimumBond(address(currency)). - * @param identifier UMA DVM identifier to use for price requests in the event of a dispute. Must be a pre-approved. + * @param identifier UMA DVM identifier to use for price requests in the event of a dispute. Must be pre-approved. * @param domainId optional domain that can be used to relate this assertion to others in the escalationManager and * can be used by the configured escalationManager to define custom behavior for groups of assertions. This is * typically used for "escalation games" by changing bonds or other assertion properties based on the other - * assertions that have come before. If not needed this value should be bytes32 to save gas. + * assertions that have come before. If not needed this value should be 0 to save gas. */ function assertTruth( bytes memory claim, @@ -177,7 +177,7 @@ contract OptimisticAsserter is OptimisticAsserterInterface, Lockable, Ownable, M require(!assertionPolicy.blockAssertion, "Assertion not allowed"); // Check if the assertion is permitted. EscalationManagerSettings storage emSettings = assertions[assertionId].escalationManagerSettings; (emSettings.arbitrateViaEscalationManager, emSettings.discardOracle, emSettings.validateDisputers) = ( - // Choose which oracle to arbitrate disputes via. If Set to true then the escalation manager will + // Choose which oracle to arbitrate disputes via. If set to true then the escalation manager will // arbitrate disputes. Else, the DVM arbitrates disputes. This lets integrations "unplug" the DVM. assertionPolicy.arbitrateViaEscalationManager, // Choose whether to discard the Oracle result. If true then "throw away" the assertion. To get an @@ -213,7 +213,7 @@ contract OptimisticAsserter is OptimisticAsserterInterface, Lockable, Ownable, M * @param disputer receives bonds back at settlement. */ function disputeAssertion(bytes32 assertionId, address disputer) external nonReentrant { - require(disputer != address(0), "Disputer cant be 0"); + require(disputer != address(0), "Disputer can't be 0"); Assertion storage assertion = assertions[assertionId]; require(assertion.asserter != address(0), "Assertion does not exist"); require(assertion.disputer == address(0), "Assertion already disputed"); diff --git a/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/BaseEscalationManager.sol b/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/BaseEscalationManager.sol index 94f2eed146..7c4c62115c 100644 --- a/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/BaseEscalationManager.sol +++ b/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/BaseEscalationManager.sol @@ -32,7 +32,7 @@ contract BaseEscalationManager is EscalationManagerInterface { * if the dispute should be allowed based on the escalation policy. * @param assertionId the assertionId to validate the dispute for. * @param disputeCaller the caller of the dispute function. - * @return bool if the dispute is allowed, false otherwise. + * @return bool true if the dispute is allowed, false otherwise. */ function isDisputeAllowed(bytes32 assertionId, address disputeCaller) public view virtual returns (bool) { return true; @@ -54,7 +54,7 @@ contract BaseEscalationManager is EscalationManagerInterface { /** * @notice Implements price requesting logic for the escalation manager. This function is called by the Optimistic - * on dispute and is constructed to mimic that of the UMA DVM interface. + * Asserter on dispute and is constructed to mimic that of the UMA DVM interface. * @param identifier the identifier to fetch the price for. * @param time the time to fetch the price for. * @param ancillaryData ancillary data of the price being requested. diff --git a/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/FullPolicyEscalationManager.sol b/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/FullPolicyEscalationManager.sol index 5a2659279a..7a9bad018c 100644 --- a/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/FullPolicyEscalationManager.sol +++ b/packages/core/contracts/optimistic-asserter/implementation/escalation-manager/FullPolicyEscalationManager.sol @@ -10,7 +10,7 @@ import "../../interfaces/OptimisticAsserterInterface.sol"; * resolutions for the Escalation Manager. Optionally, assertion blocking can be enabled using a whitelist of * assertingCallers or assertingCallers and asserters. On the other hand, it enables the determination of whether to * arbitrate via the escalation manager as opposed to the DVM, whether to disregard the resolution of a potential - * dispute arbitrated by the Oracle, and whether to restrict who can register disputes via a whitelistedDisputeCallers. + * dispute arbitrated by the Oracle, and whether to restrict who can register disputes via whitelistedDisputeCallers. * @dev If nothing is configured using the setters and configureEscalationManager method upon deployment, the * FullPolicyEscalationManager will return a default policy with all values set to false. */ @@ -99,7 +99,7 @@ contract FullPolicyEscalationManager is BaseEscalationManager, Ownable { * @param assertionId the ID of the assertion to check the disputerCaller for. * @param disputeCaller the address of the disputeCaller to check. * @return true if the disputerCaller is authorised to dispute the assertion. - * @dev In order for this function to be used by the Optimistic Assertor, validateDisputers must be set to true. + * @dev In order for this function to be used by the Optimistic Asserter, validateDisputers must be set to true. */ function isDisputeAllowed(bytes32 assertionId, address disputeCaller) public view override returns (bool) { return whitelistedDisputeCallers[disputeCaller]; @@ -159,7 +159,7 @@ contract FullPolicyEscalationManager is BaseEscalationManager, Ownable { } /** - * @notice Adds/removes a disputerCaller to the whitelist of disputers that can file disputes. + * @notice Adds/removes a disputeCaller to the whitelist of disputers that can file disputes. * @param disputeCaller the address of the disputeCaller to add. * @dev This function is only used if validateDisputers is set to true. */ diff --git a/packages/core/contracts/optimistic-asserter/interfaces/OptimisticAsserterInterface.sol b/packages/core/contracts/optimistic-asserter/interfaces/OptimisticAsserterInterface.sol index 1fa8ffd962..681eb93cea 100644 --- a/packages/core/contracts/optimistic-asserter/interfaces/OptimisticAsserterInterface.sol +++ b/packages/core/contracts/optimistic-asserter/interfaces/OptimisticAsserterInterface.sol @@ -7,7 +7,7 @@ interface OptimisticAsserterInterface { struct EscalationManagerSettings { bool arbitrateViaEscalationManager; // False if the DVM is used as an oracle (EscalationManager on True). bool discardOracle; // False if Oracle result is used for resolving assertion after dispute. - bool validateDisputers; // True if the SS isDisputeAllowed should be checked on disputes. + bool validateDisputers; // True if the EM isDisputeAllowed should be checked on disputes. address assertingCaller; address escalationManager; }