Change all doc comments in Solidity to use ///, update Governable with relayable force change. (#337)

Author: drewstone

packages/contracts/contracts/DeterministicDeployFactory.sol

@@ -2,6 +2,7 @@
  * Copyright 2021-2023 Webb Technologies
  * SPDX-License-Identifier: MIT OR Apache-2.0
  */
+
 pragma solidity ^0.8.18;
 
 contract DeterministicDeployFactory {
@@ -20,16 +21,14 @@ contract DeterministicDeployFactory {
 		return addr;
 	}
 
-	/**
-		@notice Deploy a fungible token
-		@param bytecode The bytecode of the contract
-		@param _salt The salt for the contract
-		@param _feePercentage The fee percentage for wrapping
-		@param _feeRecipient The recipient for fees from wrapping.
-		@param _handler The address of the handler
-		@param _limit The maximum amount of tokens that can be wrapped
-		@param _isNativeAllowed Whether or not native tokens are allowed to be wrapped
-	 */
+	/// @notice Deploy a fungible token
+	/// @param bytecode The bytecode of the contract
+	/// @param _salt The salt for the contract
+	/// @param _feePercentage The fee percentage for wrapping
+	/// @param _feeRecipient The recipient for fees from wrapping.
+	/// @param _handler The address of the handler
+	/// @param _limit The maximum amount of tokens that can be wrapped
+	/// @param _isNativeAllowed Whether or not native tokens are allowed to be wrapped
 	function deployFungibleToken(
 		bytes memory bytecode,
 		uint _salt,
@@ -54,13 +53,11 @@ contract DeterministicDeployFactory {
 		require(success, string(data));
 	}
 
-	/**
-		@notice Deploy a VAnchor
-		@param bytecode The bytecode of the contract
-		@param _salt The salt for the contract
-		@param _minimalWithdrawalAmount The minimal withdrawal amount
-		@param _maximumDepositAmount The maximum deposit amount
-	 */
+	/// @notice Deploy a VAnchor
+	/// @param bytecode The bytecode of the contract
+	/// @param _salt The salt for the contract
+	/// @param _minimalWithdrawalAmount The minimal withdrawal amount
+	/// @param _maximumDepositAmount The maximum deposit amount
 	function deployVAnchor(
 		bytes memory bytecode,
 		uint _salt,

packages/contracts/contracts/SignatureBridge.sol

@@ -11,25 +11,19 @@ import "./utils/ChainIdWithType.sol";
 import "./utils/ProposalNonceTracker.sol";
 import "./interfaces/IExecutor.sol";
 
-/**
-	@title Facilitates proposals execution and resource ID additions/updates
-	@author ChainSafe Systems & Webb Technologies.
- */
+/// @title Facilitates proposals execution and resource ID additions/updates
+/// @author ChainSafe Systems & Webb Technologies.
 contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 	// resourceID => handler address
 	mapping(bytes32 => address) public _resourceIdToHandlerAddress;
 
-	/**
-		Verifying signature of governor over some data
-	 */
+	/// @notice Verifying signature of governor over some data
 	modifier signedByGovernor(bytes memory data, bytes memory sig) {
 		require(isSignatureFromGovernor(data, sig), "SignatureBridge: Not valid sig from governor");
 		_;
 	}
 
-	/**
-		Verifying signature of governor over some datahash
-	 */
+	/// @notice Verifying signature of governor over some datahash
 	modifier signedByGovernorPrehashed(bytes32 hashedData, bytes memory sig) {
 		require(
 			isSignatureFromGovernorPrehashed(hashedData, sig),
@@ -38,9 +32,7 @@ contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 		_;
 	}
 
-	/**
-		Verifying many signatures from a governor over some datahash
-	 */
+	/// @notice Verifying many signatures from a governor over some datahash
 	modifier manySignedByGovernor(bytes[] memory data, bytes[] memory sig) {
 		require(data.length == sig.length, "SignatureBridge: Data and sig lengths must match");
 		for (uint256 i = 0; i < data.length; i++) {
@@ -52,23 +44,19 @@ contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 		_;
 	}
 
-	/**
-		@notice Initializes SignatureBridge with a governor
-		@param initialGovernor Addresses that should be initially granted the relayer role.
-	 */
+	/// @notice Initializes SignatureBridge with a governor
+	/// @param initialGovernor Addresses that should be initially granted the relayer role.
 	constructor(address initialGovernor, uint32 nonce) Governable(initialGovernor, nonce) {}
 
-	/**
-		@notice Sets a new resource for handler contracts that use the IExecutor interface,
-		and maps the {handlerAddress} to {newResourceID} in {_resourceIdToHandlerAddress}.
-		@notice Only callable by an address that currently has the admin role.
-		@param resourceID Target resource ID of the proposal header.
-		@param functionSig Function signature of the proposal header.
-		@param nonce Nonce of the proposal header.
-		@param newResourceID Secondary resourceID begin mapped to a handler address.
-		@param handlerAddress Address of handler resource will be set for.
-		@param sig The signature from the governor of the encoded set resource proposal.
-	 */
+	/// @notice Sets a new resource for handler contracts that use the IExecutor interface,
+	/// and maps the {handlerAddress} to {newResourceID} in {_resourceIdToHandlerAddress}.
+	/// @notice Only callable by an address that currently has the admin role.
+	/// @param resourceID Target resource ID of the proposal header.
+	/// @param functionSig Function signature of the proposal header.
+	/// @param nonce Nonce of the proposal header.
+	/// @param newResourceID Secondary resourceID begin mapped to a handler address.
+	/// @param handlerAddress Address of handler resource will be set for.
+	/// @param sig The signature from the governor of the encoded set resource proposal.
 	function adminSetResourceWithSignature(
 		bytes32 resourceID,
 		bytes4 functionSig,
@@ -84,21 +72,19 @@ contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 			sig
 		)
 	{
-		_handleSetResource(resourceID, functionSig, nonce, newResourceID, handlerAddress);
+		_handleSetResource(resourceID, functionSig, newResourceID, handlerAddress);
 	}
 
-	/**
-		@notice Sets a batch new resources for handler contracts that use the IExecutor interface,
-		and maps the {handlerAddress} to {newResourceID} in {_resourceIdToHandlerAddress}.
-		@notice Only callable by an address that currently has the admin role.
-		@param resourceID Target resource ID of the proposal header.
-		@param functionSig Function signature of the proposal header.
-		@param nonces Nonces of the proposal headers.
-		@param newResourceIDs Secondary resourceIDs begin mapped to a handler address.
-		@param handlerAddresses Addresses of handler resource will be set for.
-		@param hashedData The encoded data of all proposals to be used for easy checking.
-		@param sig The signature from the governor of the encoded set resource proposal.
-	 */
+	/// @notice Sets a batch new resources for handler contracts that use the IExecutor interface,
+	/// and maps the {handlerAddress} to {newResourceID} in {_resourceIdToHandlerAddress}.
+	/// @notice Only callable by an address that currently has the admin role.
+	/// @param resourceID Target resource ID of the proposal header.
+	/// @param functionSig Function signature of the proposal header.
+	/// @param nonces Nonces of the proposal headers.
+	/// @param newResourceIDs Secondary resourceIDs begin mapped to a handler address.
+	/// @param handlerAddresses Addresses of handler resource will be set for.
+	/// @param hashedData The encoded data of all proposals to be used for easy checking.
+	/// @param sig The signature from the governor of the encoded set resource proposal.
 	function batchAdminSetResourceWithSignature(
 		bytes32 resourceID,
 		bytes4 functionSig,
@@ -131,31 +117,21 @@ contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 		);
 
 		for (uint i = 0; i < nonces.length; i++) {
-			_handleSetResource(
-				resourceID,
-				functionSig,
-				nonces[i],
-				newResourceIDs[i],
-				handlerAddresses[i]
-			);
+			_handleSetResource(resourceID, functionSig, newResourceIDs[i], handlerAddresses[i]);
 		}
 	}
 
-	/**
-		@notice Executes a proposal signed by the governor.
-		@param data Data meant for execution by execution handlers.
-	 */
+	/// @notice Executes a proposal signed by the governor.
+	/// @param data Data meant for execution by execution handlers.
 	function executeProposalWithSignature(
 		bytes calldata data,
 		bytes memory sig
 	) external signedByGovernor(data, sig) {
 		_handleExecuteProposal(data);
 	}
 
-	/**
-		@notice Executes a many of proposals signed by the governor in a single tx.
-		@param data Data meant for execution by execution handlers.
-	 */
+	/// @notice Executes a many of proposals signed by the governor in a single tx.
+	/// @param data Data meant for execution by execution handlers.
 	function executeManyProposalsWithSignature(
 		bytes[] calldata data,
 		bytes[] memory sig
@@ -165,10 +141,8 @@ contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 		}
 	}
 
-	/**
-		@notice Executes a batch of proposals signed by the governor in a single tx.
-		@param data Data meant for execution by execution handlers.
-	 */
+	/// @notice Executes a batch of proposals signed by the governor in a single tx.
+	/// @param data Data meant for execution by execution handlers.
 	function batchExecuteProposalsWithSignature(
 		bytes[] calldata data,
 		bytes memory sig
@@ -193,7 +167,6 @@ contract SignatureBridge is Governable, ChainIdWithType, ProposalNonceTracker {
 	function _handleSetResource(
 		bytes32 resourceID,
 		bytes4 functionSig,
-		uint32 nonce,
 		bytes32 newResourceID,
 		address handlerAddress
 	) internal {

packages/contracts/contracts/Treasury.sol

@@ -11,19 +11,25 @@ import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import "./interfaces/ITreasury.sol";
 import "./utils/ProposalNonceTracker.sol";
 
+/// @title Treasury contract
+/// @author Webb Technologies.
+/// @notice This contract is used to store funds and recover them.
 contract Treasury is ITreasury, ProposalNonceTracker {
 	using SafeERC20 for IERC20;
 	address treasuryHandler;
 
 	event TreasuryHandlerUpdated(address _handler);
 
 	constructor(address _treasuryHandler) {
-		require(_treasuryHandler != address(0), "Treasury Handler can't be 0");
+		require(_treasuryHandler != address(0), "Treasury: Treasury Handler can't be 0");
 		treasuryHandler = _treasuryHandler;
 	}
 
 	modifier onlyHandler() {
-		require(msg.sender == treasuryHandler, "Function can only be called by treasury handler");
+		require(
+			msg.sender == treasuryHandler,
+			"Treasury: Function can only be called by treasury handler"
+		);
 		_;
 	}
 
@@ -33,8 +39,8 @@ contract Treasury is ITreasury, ProposalNonceTracker {
 		uint256 amountToRescue,
 		uint32 nonce
 	) external override onlyHandler onlyIncrementingByOne(nonce) {
-		require(to != address(0), "Cannot send liquidity to zero address");
-		require(tokenAddress != address(this), "Cannot rescue wrapped asset");
+		require(to != address(0), "Treasury: Cannot send liquidity to zero address");
+		require(tokenAddress != address(this), "Treasury: Cannot rescue wrapped asset");
 
 		if (tokenAddress == address(0)) {
 			// Native Ether
@@ -59,7 +65,7 @@ contract Treasury is ITreasury, ProposalNonceTracker {
 		address newHandler,
 		uint32 nonce
 	) external override onlyHandler onlyIncrementingByOne(nonce) {
-		require(newHandler != address(0), "Handler cannot be 0");
+		require(newHandler != address(0), "Treasury: Handler cannot be 0");
 		treasuryHandler = newHandler;
 		emit TreasuryHandlerUpdated(treasuryHandler);
 	}

packages/contracts/contracts/handlers/AnchorHandler.sol

@@ -11,43 +11,37 @@ import "../interfaces/IExecutor.sol";
 import "../interfaces/verifiers/ISetVerifier.sol";
 import "../interfaces/ILinkableAnchor.sol";
 
-/**
-    @title Handles Anchor edge list merkle root updates
-    @author Webb Technologies.
-    @notice This contract is intended to be used with the Bridge contract.
- */
+/// @title Handles Anchor edge list merkle root updates
+/// @author Webb Technologies.
+/// @notice This contract is intended to be used with the Bridge contract.
 contract AnchorHandler is IExecutor, HandlerHelpers {
-	/**
-        @param bridgeAddress Contract address of previously deployed Bridge.
-        @param initialResourceIDs Resource IDs are used to identify a specific contract address.
-        These are the Resource IDs this contract will initially support.
-        @param initialContractAddresses These are the addresses the {initialResourceIDs} will point to, and are the contracts that will be
-        called to perform various deposit calls.
-        @dev {initialResourceIDs} and {initialContractAddresses} must have the same length (one resourceID for every address).
-        Also, these arrays must be ordered in the way that {initialResourceIDs}[0] is the intended resourceID for {initialContractAddresses}[0].
-     */
+	/// @param bridgeAddress Contract address of previously deployed Bridge.
+	/// @param initialResourceIDs Resource IDs are used to identify a specific contract address.
+	/// These are the Resource IDs this contract will initially support.
+	/// @param initialContractAddresses These are the addresses the {initialResourceIDs} will point to, and are the contracts that will be
+	/// called to perform various deposit calls.
+	/// @dev {initialResourceIDs} and {initialContractAddresses} must have the same length (one resourceID for every address).
+	/// Also, these arrays must be ordered in the way that {initialResourceIDs}[0] is the intended resourceID for {initialContractAddresses}[0].
 	constructor(
 		address bridgeAddress,
 		bytes32[] memory initialResourceIDs,
 		address[] memory initialContractAddresses
 	) {
 		require(
 			initialResourceIDs.length == initialContractAddresses.length,
-			"initialResourceIDs and initialContractAddresses len mismatch"
+			"AnchorHandler: initialResourceIDs and initialContractAddresses len mismatch"
 		);
-		require(bridgeAddress != address(0), "Bridge Address can't be 0");
+		require(bridgeAddress != address(0), "AnchorHandler: Bridge Address can't be 0");
 		_bridgeAddress = bridgeAddress;
 
 		for (uint256 i = 0; i < initialResourceIDs.length; i++) {
 			_setResource(initialResourceIDs[i], initialContractAddresses[i]);
 		}
 	}
 
-	/**
-        @notice Proposal execution should be initiated when a proposal is signed and executed by the `SignatureBridge`
-        @param resourceID ResourceID corresponding to a particular executing anchor contract.
-        @param data Consists of a specific proposal data structure for each finer-grained anchor proposal
-     */
+	/// @notice Proposal execution should be initiated when a proposal is signed and executed by the `SignatureBridge`
+	/// @param resourceID ResourceID corresponding to a particular executing anchor contract.
+	/// @param data Consists of a specific proposal data structure for each finer-grained anchor proposal
 	function executeProposal(bytes32 resourceID, bytes calldata data) external override onlyBridge {
 		bytes32 resourceId;
 		bytes4 functionSig;
@@ -59,7 +53,10 @@ contract AnchorHandler is IExecutor, HandlerHelpers {
 
 		address anchorAddress = _resourceIDToContractAddress[resourceID];
 
-		require(_contractWhitelist[anchorAddress], "provided tokenAddress is not whitelisted");
+		require(
+			_contractWhitelist[anchorAddress],
+			"AnchorHandler: provided tokenAddress is not whitelisted"
+		);
 
 		if (functionSig == bytes4(keccak256("setHandler(address,uint32)"))) {
 			uint32 nonce = uint32(bytes4(arguments[0:4]));
@@ -93,7 +90,7 @@ contract AnchorHandler is IExecutor, HandlerHelpers {
 				nonce
 			);
 		} else {
-			revert("Invalid function sig");
+			revert("AnchorHandler: Invalid function sig");
 		}
 	}
 }