Graduate to yarn 4 🧶

.github/workflows/node.yml

@@ -49,9 +49,6 @@ jobs:
         with:
           node-version: 18
 
-      - name: Install Foundry
-        uses: onbjerg/foundry-toolchain@v1
-
       - name: yarn-cache
         uses: actions/cache@v3
         with:

.lintstagedrc

@@ -1,6 +1,5 @@
 {
   "*.js": "prettier --write",
   "*.ts": "prettier --write", 
-  "*.md": "prettier --write",
-  "*.sol": "prettier --write"
+  "*.md": "prettier --write"
 }

.prettierrc

@@ -10,12 +10,12 @@
         "tabWidth": 4,
         "useTabs": false,
         "singleQuote": false,
-        "bracketSpacing": false,
-        "explicitTypes": "always"
+        "bracketSpacing": false
       }
     }
   ],
   "importOrder": ["^@hyperlane-xyz/(.*)$", "^../(.*)$", "^./(.*)$"],
   "importOrderSeparation": true,
-  "importOrderSortSpecifiers": true
+  "importOrderSortSpecifiers": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"]
 }

.yarnrc.yml

@@ -1,11 +1,13 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+enableScripts: false
+
 nodeLinker: node-modules
 
 plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
-    spec: "@yarnpkg/plugin-workspace-tools"
   - path: .yarn/plugins/@yarnpkg/plugin-outdated.cjs
     spec: "https://mskelton.dev/yarn-outdated/v3"
-  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
-    spec: "@yarnpkg/plugin-version"
 
-yarnPath: .yarn/releases/yarn-3.2.0.cjs
+yarnPath: .yarn/releases/yarn-4.0.1.cjs

package.json

@@ -3,28 +3,28 @@
   "description": "A yarn workspace of core Hyperlane packages",
   "version": "0.0.0",
   "devDependencies": {
-    "@trivago/prettier-plugin-sort-imports": "^3.2.0",
+    "@trivago/prettier-plugin-sort-imports": "^4.2.1",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "eslint": "^8.16.0",
     "eslint-config-prettier": "^8.5.0",
     "husky": "^8.0.0",
     "lint-staged": "^12.4.3",
-    "prettier": "^2.4.1"
+    "prettier": "^3.0.3"
   },
-  "packageManager": "yarn@3.2.0",
+  "packageManager": "yarn@4.0.1",
   "private": true,
   "scripts": {
-    "build": "yarn workspaces foreach --verbose --parallel --topological run build",
-    "clean": "yarn workspaces foreach --verbose --parallel run clean",
+    "build": "yarn workspaces foreach --all --parallel --topological run build",
+    "clean": "yarn workspaces foreach --all --parallel run clean",
+    "prettier": "yarn workspaces foreach --all --parallel run prettier",
+    "lint": "yarn workspaces foreach --all --parallel run lint",
+    "test": "yarn workspaces foreach --all --parallel run test",
+    "coverage": "yarn workspaces foreach --all --parallel run coverage",
+    "version:prepare": "yarn workspaces foreach --all --no-private --topological version --immediate",
+    "publish:all": "yarn workspaces foreach --all --no-private --topological npm publish --access public",
     "postinstall": "husky install",
-    "prettier": "yarn workspaces foreach --verbose --parallel run prettier",
-    "lint": "yarn workspaces foreach --verbose --parallel run lint",
-    "test": "yarn workspaces foreach --verbose --parallel run test",
-    "coverage": "yarn workspaces foreach --verbose --parallel run coverage",
-    "version:check": "yarn version check --interactive",
-    "version:prepare": "yarn workspaces foreach --no-private --verbose --topological version --immediate",
-    "publish:all": "yarn workspaces foreach --no-private --verbose --topological npm publish --access public"
+    "version:check": "yarn version check --interactive"
   },
   "workspaces": [
     "solidity",

solidity/contracts/Mailbox.sol

@@ -191,52 +191,51 @@
      * @param _metadata Metadata used by the ISM to verify `_message`.
      * @param _message Formatted Hyperlane message (refer to Message.sol).
      */
-    function process(bytes calldata _metadata, bytes calldata _message)
-        external
-        payable
-        override
-    {
+    function process(
+        bytes calldata _metadata,
+        bytes calldata _message
+    ) external payable override {
         /// CHECKS ///
 
         // Check that the message was intended for this mailbox.
         require(_message.version() == VERSION, "Mailbox: bad version");
         require(
             _message.destination() == localDomain,
             "Mailbox: unexpected destination"
         );
 
         // Check that the message hasn't already been delivered.
         bytes32 _id = _message.id();
         require(delivered(_id) == false, "Mailbox: already delivered");
 
         // Get the recipient's ISM.
         address recipient = _message.recipientAddress();
         IInterchainSecurityModule ism = recipientIsm(recipient);
 
         /// EFFECTS ///
 
         deliveries[_id] = Delivery({
             processor: msg.sender,
             blockNumber: uint48(block.number)
         });
         emit Process(_message.origin(), _message.sender(), recipient);
         emit ProcessId(_id);
 
         /// INTERACTIONS ///
 
         // Verify the message via the interchain security module.
         require(
             ism.verify(_metadata, _message),
             "Mailbox: ISM verification failed"
         );
 
         // Deliver the message to the recipient.
         IMessageRecipient(recipient).handle{value: msg.value}(
             _message.origin(),
             _message.sender(),
             _message.body()
         );
     }
 
     /**
      * @notice Returns the account that processed the message.
@@ -391,11 +390,9 @@
      * @param _recipient The message recipient whose ISM should be returned.
      * @return The ISM to use for `_recipient`.
      */
-    function recipientIsm(address _recipient)
-        public
-        view
-        returns (IInterchainSecurityModule)
-    {
+    function recipientIsm(
+        address _recipient
+    ) public view returns (IInterchainSecurityModule) {
         // use low-level staticcall in case of revert or empty return data
         (bool success, bytes memory returnData) = _recipient.staticcall(
             abi.encodeCall(

solidity/contracts/client/GasRouter.sol

@@ -19,10 +19,9 @@ abstract contract GasRouter is Router {
      * @notice Sets the gas amount dispatched for each configured domain.
      * @param gasConfigs The array of GasRouterConfig structs
      */
-    function setDestinationGas(GasRouterConfig[] calldata gasConfigs)
-        external
-        onlyOwner
-    {
+    function setDestinationGas(
+        GasRouterConfig[] calldata gasConfigs
+    ) external onlyOwner {
         for (uint256 i = 0; i < gasConfigs.length; i += 1) {
             _setDestinationGas(gasConfigs[i].domain, gasConfigs[i].gas);
         }
@@ -42,25 +41,19 @@ abstract contract GasRouter is Router {
      * @param _destinationDomain The domain of the router.
      * @return _gasPayment Payment computed by the registered InterchainGasPaymaster.
      */
-    function quoteGasPayment(uint32 _destinationDomain)
-        external
-        view
-        returns (uint256 _gasPayment)
-    {
+    function quoteGasPayment(
+        uint32 _destinationDomain
+    ) external view returns (uint256 _gasPayment) {
         return _quoteDispatch(_destinationDomain, "");
     }
 
     function _refundAddress(uint32) internal view virtual returns (address) {
         return msg.sender;
     }
 
-    function _metadata(uint32 _destination)
-        internal
-        view
-        virtual
-        override
-        returns (bytes memory)
-    {
+    function _metadata(
+        uint32 _destination
+    ) internal view virtual override returns (bytes memory) {
         return
             StandardHookMetadata.formatMetadata(
                 destinationGas[_destination],

solidity/contracts/client/MailboxClient.sol

@@ -68,11 +68,9 @@ abstract contract MailboxClient is OwnableUpgradeable {
      * @notice Sets the address of the application's custom interchain security module.
      * @param _module The address of the interchain security module contract.
      */
-    function setInterchainSecurityModule(address _module)
-        public
-        onlyContractOrNull(_module)
-        onlyOwner
-    {
+    function setInterchainSecurityModule(
+        address _module
+    ) public onlyContractOrNull(_module) onlyOwner {
         interchainSecurityModule = IInterchainSecurityModule(_module);
     }
 

solidity/contracts/client/Router.sol

@@ -52,11 +52,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain of the remote Application Router
      * @param _router The address of the remote Application Router
      */
-    function enrollRemoteRouter(uint32 _domain, bytes32 _router)
-        external
-        virtual
-        onlyOwner
-    {
+    function enrollRemoteRouter(
+        uint32 _domain,
+        bytes32 _router
+    ) external virtual onlyOwner {
         _enrollRemoteRouter(_domain, _router);
     }
 
@@ -80,11 +79,9 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @notice Batch version of `unenrollRemoteRouter`
      * @param _domains The domains of the remote Application Routers
      */
-    function unenrollRemoteRouters(uint32[] calldata _domains)
-        external
-        virtual
-        onlyOwner
-    {
+    function unenrollRemoteRouters(
+        uint32[] calldata _domains
+    ) external virtual onlyOwner {
         uint256 length = _domains.length;
         for (uint256 i = 0; i < length; i += 1) {
             _unenrollRemoteRouter(_domains[i]);
@@ -121,10 +118,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain
      * @param _address The new router
      */
-    function _enrollRemoteRouter(uint32 _domain, bytes32 _address)
-        internal
-        virtual
-    {
+    function _enrollRemoteRouter(
+        uint32 _domain,
+        bytes32 _address
+    ) internal virtual {
         _routers.set(_domain, _address);
     }
 
@@ -141,11 +138,10 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain of the potential remote Application Router
      * @param _address The address of the potential remote Application Router
      */
-    function _isRemoteRouter(uint32 _domain, bytes32 _address)
-        internal
-        view
-        returns (bool)
-    {
+    function _isRemoteRouter(
+        uint32 _domain,
+        bytes32 _address
+    ) internal view returns (bool) {
         return routers(_domain) == _address;
     }
 
@@ -154,33 +150,28 @@ abstract contract Router is MailboxClient, IMessageRecipient {
      * @param _domain The domain of the chain for which to get the Application Router
      * @return _router The address of the remote Application Router on _domain
      */
-    function _mustHaveRemoteRouter(uint32 _domain)
-        internal
-        view
-        returns (bytes32)
-    {
+    function _mustHaveRemoteRouter(
+        uint32 _domain
+    ) internal view returns (bytes32) {
         (bool contained, bytes32 _router) = _routers.tryGet(_domain);
         require(contained, _domainNotFoundError(_domain));
         return _router;
     }
 
-    function _domainNotFoundError(uint32 _domain)
-        internal
-        pure
-        returns (string memory)
-    {
+    function _domainNotFoundError(
+        uint32 _domain
+    ) internal pure returns (string memory) {
         return
             string.concat(
                 "No router enrolled for domain: ",
                 _domain.toString()
             );
     }
 
-    function _dispatch(uint32 _destinationDomain, bytes memory _messageBody)
-        internal
-        virtual
-        returns (bytes32)
-    {
+    function _dispatch(
+        uint32 _destinationDomain,
+        bytes memory _messageBody
+    ) internal virtual returns (bytes32) {
         return _dispatch(_destinationDomain, msg.value, _messageBody);
     }
 

solidity/contracts/hooks/OPStackHook.sol

@@ -59,28 +59,26 @@
     }
 
     // ============ Internal functions ============
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        pure
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal pure override returns (uint256) {
         return 0; // gas subsidized by the L2
     }
 
     /// @inheritdoc AbstractMessageIdAuthHook
-    function _sendMessageId(bytes calldata metadata, bytes memory payload)
-        internal
-        override
-    {
+    function _sendMessageId(
+        bytes calldata metadata,
+        bytes memory payload
+    ) internal override {
         require(
-            metadata.msgValue(0) < 2**255,
+            metadata.msgValue(0) < 2 ** 255,
             "OPStackHook: msgValue must be less than 2 ** 255"
         );
         l1Messenger.sendMessage{value: metadata.msgValue(0)}(
             TypeCasts.bytes32ToAddress(ism),
             payload,
             GAS_LIMIT
         );
     }
 }

solidity/contracts/hooks/PausableHook.sol

@@ -43,19 +43,16 @@ contract PausableHook is AbstractPostDispatchHook, Ownable, Pausable {
     // ============ Internal functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-        whenNotPaused
-    {}
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override whenNotPaused {}
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        pure
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal pure override returns (uint256) {
         return 0;
     }
 }

solidity/contracts/hooks/StaticProtocolFee.sol

@@ -91,10 +91,10 @@ contract StaticProtocolFee is AbstractPostDispatchHook, Ownable {
     // ============ Internal Functions ============
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _postDispatch(bytes calldata metadata, bytes calldata message)
-        internal
-        override
-    {
+    function _postDispatch(
+        bytes calldata metadata,
+        bytes calldata message
+    ) internal override {
         require(
             msg.value >= protocolFee,
             "StaticProtocolFee: insufficient protocol fee"
@@ -109,12 +109,10 @@ contract StaticProtocolFee is AbstractPostDispatchHook, Ownable {
     }
 
     /// @inheritdoc AbstractPostDispatchHook
-    function _quoteDispatch(bytes calldata, bytes calldata)
-        internal
-        view
-        override
-        returns (uint256)
-    {
+    function _quoteDispatch(
+        bytes calldata,
+        bytes calldata
+    ) internal view override returns (uint256) {
         return protocolFee;
     }