feat: batch multiplex

contracts/zero-ex/compiler.json

@@ -16,6 +16,7 @@
         "./contracts/src/errors/LibSimpleFunctionRegistryRichErrors.sol",
         "./contracts/src/errors/LibTransformERC20RichErrors.sol",
         "./contracts/src/errors/LibWalletRichErrors.sol",
+        "./contracts/src/examples/BatchMultiplexValidator.sol",
         "./contracts/src/external/FeeCollector.sol",
         "./contracts/src/external/FeeCollectorController.sol",
         "./contracts/src/external/FlashWallet.sol",
@@ -41,6 +42,7 @@
         "./contracts/src/features/UniswapFeature.sol",
         "./contracts/src/features/UniswapV3Feature.sol",
         "./contracts/src/features/interfaces/IBatchFillNativeOrdersFeature.sol",
+        "./contracts/src/features/interfaces/IBatchMultiplexFeature.sol",
         "./contracts/src/features/interfaces/IBootstrapFeature.sol",
         "./contracts/src/features/interfaces/IERC1155OrdersFeature.sol",
         "./contracts/src/features/interfaces/IERC165Feature.sol",
@@ -64,6 +66,7 @@
         "./contracts/src/features/libs/LibNFTOrder.sol",
         "./contracts/src/features/libs/LibNativeOrder.sol",
         "./contracts/src/features/libs/LibSignature.sol",
+        "./contracts/src/features/multiplex/BatchMultiplexFeature.sol",
         "./contracts/src/features/multiplex/MultiplexFeature.sol",
         "./contracts/src/features/multiplex/MultiplexLiquidityProvider.sol",
         "./contracts/src/features/multiplex/MultiplexOtc.sol",

contracts/zero-ex/contracts/src/IZeroEx.sol

@@ -33,6 +33,8 @@ import "./features/interfaces/IFundRecoveryFeature.sol";
 import "./features/interfaces/IERC721OrdersFeature.sol";
 import "./features/interfaces/IERC1155OrdersFeature.sol";
 import "./features/interfaces/IERC165Feature.sol";
+import "./features/interfaces/IBatchMultiplexFeature.sol";
+import "./features/interfaces/IBatchMultiplexFeatureV2.sol";
 
 /// @dev Interface for a fully featured Exchange Proxy.
 interface IZeroEx is
@@ -52,7 +54,9 @@ interface IZeroEx is
     IFundRecoveryFeature,
     IERC721OrdersFeature,
     IERC1155OrdersFeature,
-    IERC165Feature
+    IERC165Feature,
+    IBatchMultiplexFeature,
+    IBatchMultiplexFeatureV2
 {
     /// @dev Fallback for just receiving ether.
     receive() external payable;

contracts/zero-ex/contracts/src/examples/BatchMultiplexValidator.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+/*
+  Copyright 2024 ZeroEx Intl., Rigo Intl.
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+pragma solidity ^0.6.5;
+pragma experimental ABIEncoderV2;
+
+/// @dev A sample validator contract for the batck multiplex method.
+/// @notice Do not fall for ERC2771 address spoofing attack when implementing validation. The 0x protocol will
+///   always verify order signatures for meta transactions from signer regardless who is sending the transactions.
+contract BatchMultiplexValidator {
+    struct Batch {
+        bytes[] calls;
+    }
+
+    // TODO: check how this validation can be skipped, i.e. if the validator input is not as expected.
+    //  Also check if instead of boolean could return calls, as a validator contract may filter some calls.
+    /// @dev Validates the data passed from the 0x exchange proxy against the validator's requirements.
+    /// @param encodedCalls The swaps in 0x-protocol format.
+    /// @param /*extraData*/ An arbitrary string to be used as extra validation.
+    /// @param /*sender*/ The address that sent the transaction to the network.
+    /// @return isValid Boolean the bundle is valid.
+    /// @notice Visibility is not `pure` to potentially allow reading from state.
+    function validate(
+        bytes calldata encodedCalls,
+        bytes calldata /*extraData*/,
+        address /*sender*/
+    ) external view returns (bool isValid) {
+        // here the first four bytes of the transaction (the selector) can be extracted and each swap call can
+        //  be decoded against its respective 0x-protocol format type.
+        Batch memory swaps = abi.decode(encodedCalls, (Batch));
+        assert(swaps.calls.length > 0);
+        isValid = true;
+    }
+}

contracts/zero-ex/contracts/src/features/interfaces/IBatchMultiplexFeature.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: Apache-2.0
+/*
+  Copyright 2024 ZeroEx Intl., Rigo Intl.
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+pragma solidity ^0.6.5;
+pragma experimental ABIEncoderV2;
+
+import "../../features/libs/LibTypes.sol";
+import "../../storage/LibBatchMultiplexStorage.sol";
+
+interface IBatchMultiplexFeature {
+    struct UpdateSelectorStatus {
+        // The selector of the function call.
+        bytes4 selector;
+        // The status of the selector.
+        LibBatchMultiplexStorage.SelectorStatus status;
+    }
+
+    /// @dev Emitted whenever the owner updates the selectors' status.
+    /// @param status Array of tuples of selectors and status (Whitelisted, Blacklisted, RequiresRouting).
+    event SelectorStatusUpdated(UpdateSelectorStatus[] status);
+
+    /// @dev Routes the swaps in the `data` array to the EP.
+    /// @param data The array of swap transactions.
+    /// @return results The array of returned values from the swap calls.
+    function batchMultiplexCall(bytes[] calldata data) external payable returns (bytes[] memory results);
+
+    /// @dev Routes the swaps in the `data` array to the EP after validating them in an external validator
+    ///   contract and passes extra data and the desired error behavior.
+    /// @param data The array of swap transactions.
+    /// @param extraData A string of extra data for project-specific validation.
+    /// @param validatorAddress The address of the validator contract.
+    /// @param errorBehavior Number of the error behavior type when one of the swaps fails.
+    /// @return results The array of returned values from the swap calls.
+    function batchMultiplexOptionalParamsCall(
+        bytes[] calldata data,
+        bytes calldata extraData,
+        address validatorAddress,
+        LibTypes.ErrorBehavior errorBehavior
+    ) external payable returns (bytes[] memory results);
+
+    /// @dev A method to update the batch multiplex storage slot. It is restricted to the EP owner.
+    /// @param selectorsTuple Array of tuples of selector and selector status.
+    function updateSelectorsStatus(UpdateSelectorStatus[] calldata selectorsTuple) external;
+
+    /// @dev A public method to query whether a method is restricted.
+    /// @notice Can be used by batchMultiplex for querying status of multiple selectors.
+    function getSelectorStatus(bytes4) external view returns (LibBatchMultiplexStorage.SelectorStatus selectorStatus);
+}

contracts/zero-ex/contracts/src/features/interfaces/IBatchMultiplexFeatureV2.sol

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: Apache-2.0
+/*
+  Copyright 2024 ZeroEx Intl., Rigo Intl.
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+pragma solidity ^0.6.5;
+pragma experimental ABIEncoderV2;
+
+import "../../features/libs/LibTypes.sol";
+
+interface IBatchMultiplexFeatureV2 {
+    /// @dev Routes multiple swaps in a `data` array to the EP.
+    /// @notice Non-payable, does not support ETH to tokens calls.
+    /// @param data The array of swap transactions.
+    /// @return results The array of returned values from the swap calls.
+    function batchMultiplexCallV2(bytes[] calldata data) external returns (bytes[] memory results);
+
+    /// @dev Routes multiple swaps in a `data` array to the EP with the desired error behavior.
+    /// @notice Non-payable, does not support ETH to tokens calls.
+    /// @param data The array of swap transactions.
+    /// @param errorBehavior Number of the error behavior type when one of the swaps fails.
+    /// @return results The array of returned values from the swap calls.
+    function batchMultiplexOptionalParamsCallV2(
+        bytes[] calldata data,
+        LibTypes.ErrorBehavior errorBehavior
+    ) external returns (bytes[] memory results);
+}

contracts/zero-ex/contracts/src/features/libs/LibTypes.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: Apache-2.0
+/*
+  Copyright 2024 ZeroEx Intl., Rigo Intl.
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+pragma solidity ^0.6.5;
+
+/// @dev A library for defining types.
+library LibTypes {
+    enum ErrorBehavior {
+        REVERT,
+        STOP,
+        CONTINUE
+    }
+}