✨ V1.1.0 (#12)

Vectorized · web-flow · commit 2a0cd59c986c · 2023-02-28T11:10:03.000+08:00
diff --git a/.gas-snapshot b/.gas-snapshot
@@ -1,15 +1,15 @@
-MulticallerTest:testMulticallerForwardsMessageValue() (gas: 2450761)
-MulticallerTest:testMulticallerGetNames() (gas: 2334984)
-MulticallerTest:testMulticallerReentrancyGuard() (gas: 2111963)
-MulticallerTest:testMulticallerReturnDataIsProperlyEncoded() (gas: 2290123)
-MulticallerTest:testMulticallerReturnDataIsProperlyEncoded(string,string,uint256) (runs: 256, μ: 2448241, ~: 2454984)
-MulticallerTest:testMulticallerReturnDataIsProperlyEncoded(uint256,uint256,uint256,uint256) (runs: 256, μ: 2290225, ~: 2290225)
-MulticallerTest:testMulticallerRevertWithCustomError() (gas: 2120768)
-MulticallerTest:testMulticallerRevertWithMessage() (gas: 2126144)
-MulticallerTest:testMulticallerRevertWithMessage(string) (runs: 256, μ: 2127399, ~: 2127589)
-MulticallerTest:testMulticallerRevertWithNothing() (gas: 2120453)
-MulticallerTest:testMulticallerSenderDoesNotRevertWithoutMulticallerDeployed() (gas: 3352)
-MulticallerTest:testMulticallerTargetGetMulticallerSender() (gas: 2133323)
-MulticallerTest:testMulticallerWithNoData() (gas: 2101526)
-MulticallerTest:test__codesize() (gas: 23211)
+MulticallerTest:testMulticallerForwardsMessageValue() (gas: 2289495)
+MulticallerTest:testMulticallerGetNames() (gas: 2174099)
+MulticallerTest:testMulticallerReentrancyGuard() (gas: 1946480)
+MulticallerTest:testMulticallerReturnDataIsProperlyEncoded() (gas: 2129174)
+MulticallerTest:testMulticallerReturnDataIsProperlyEncoded(string,string,uint256) (runs: 256, μ: 2288240, ~: 2293927)
+MulticallerTest:testMulticallerReturnDataIsProperlyEncoded(uint256,uint256,uint256,uint256) (runs: 256, μ: 2129276, ~: 2129276)
+MulticallerTest:testMulticallerRevertWithCustomError() (gas: 1959779)
+MulticallerTest:testMulticallerRevertWithMessage() (gas: 1965111)
+MulticallerTest:testMulticallerRevertWithMessage(string) (runs: 256, μ: 1966366, ~: 1966556)
+MulticallerTest:testMulticallerRevertWithNothing() (gas: 1959421)
+MulticallerTest:testMulticallerSenderDoesNotRevertWithoutMulticallerDeployed() (gas: 3395)
+MulticallerTest:testMulticallerTargetGetMulticallerSender() (gas: 1950399)
+MulticallerTest:testMulticallerWithNoData() (gas: 1940500)
+MulticallerTest:test__codesize() (gas: 23110)
 TestPlus:test__codesize() (gas: 1102)
diff --git a/.gitignore b/.gitignore
@@ -28,4 +28,5 @@ lcov.info
 
 # Build files for CREATE2 deployments
 /multicaller
+/multicaller_with_sender
 .tmp
diff --git a/README.md b/README.md
@@ -6,19 +6,19 @@
 
 Efficiently call multiple contracts in a single transaction.
 
-Allows for optional "forwarding" of `msg.sender` to the contracts called.
+Enables "forwarding" of `msg.sender` to the contracts called.
 
 ## Deployments
 
-| Chain | Multicaller |
-|---|---|
-| Ethereum | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://etherscan.io/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
-| Goerli | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://goerli.etherscan.io/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
-| Sepolia | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://sepolia.etherscan.io/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
-| Polygon | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://polygonscan.com/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
-| Mumbai | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://mumbai.polygonscan.com/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
-| Optimism | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://optimistic.etherscan.io/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
-| Arbitrum | [`0x00000000000015bF55A34241Bbf73Ec4f4b080B2`](https://arbiscan.io/address/0x00000000000015bF55A34241Bbf73Ec4f4b080B2) |
+| Chain | Multicaller | MulticallerWithSender |
+|---|---|---|
+| Ethereum | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://etherscan.io/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://etherscan.io/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
+| Goerli | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://goerli.etherscan.io/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://goerli.etherscan.io/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
+| Sepolia | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://sepolia.etherscan.io/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://sepolia.etherscan.io/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
+| Polygon | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://polygonscan.com/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://polygonscan.com/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
+| Mumbai | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://mumbai.polygonscan.com/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://mumbai.polygonscan.com/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
+| Optimism | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://optimistic.etherscan.io/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://optimistic.etherscan.io/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
+| Arbitrum | [`0x0000000000Fb21e1322c03884Aa754002339F983`](https://arbiscan.io/address/0x0000000000Fb21e1322c03884Aa754002339F983) | [`0x0000000000D593850Ac7C4ff4D944DD8081abdB1`](https://arbiscan.io/address/0x0000000000D593850Ac7C4ff4D944DD8081abdB1) |
 
 Please open an issue if you need help to deploy to an EVM chain of your choice.
 
@@ -27,12 +27,13 @@ Please open an issue if you need help to deploy to an EVM chain of your choice.
 ```ml
 src
 ├─ Multicaller.sol — "The multicaller contract"
-└─ MulticallerReader.sol — "Library to read the `msg.sender` of the multicaller contract"
+├─ MulticallerWithSender.sol — "The multicaller with sender contract"
+└─ LibMulticaller.sol — "Library to read the multicaller with sender contract"
 ``` 
 
 ## Installation
 
-You can use the [`src/MulticallerReader.sol`](./src/MulticallerReader.sol) library in your contracts to query the Multicaller efficiently.
+You can use the [`src/LibMulticaller.sol`](./src/LibMulticaller.sol) library in your contracts to query the multicaller with sender contract efficiently.
 
 To install with [**Foundry**](https://github.com/gakonst/foundry):
 
@@ -61,6 +62,8 @@ Aggregates multiple calls in a single transaction.
 
 The `msg.value` will be forwarded to the last call.
 
+### MulticallerWithSender
+
 #### `aggregateWithSender`
 ```solidity
 function aggregateWithSender(address[] calldata targets, bytes[] calldata data)
@@ -84,21 +87,21 @@ Returns the address that called `aggregateWithSender` on the contract.
 
 The value is always the zero address outside a transaction.
 
-### MulticallerReader
+### LibMulticaller
 
-Library to read the `msg.sender` of the multicaller contract.
+Library to read the multicaller with sender contract.
 
 #### `multicallerSender`
 ```solidity
 function multicallerSender() internal view returns (address)
 ```  
-Returns the address that called `aggregateWithSender` on the multicaller.
+Returns the address that called `aggregateWithSender` on the multicaller with sender contract.
 
 #### `sender`
 ```solidity
 function sender() internal view returns (address result)
 ```  
-Returns the address that called `aggregateWithSender` on the multicaller, if `msg.sender` is the multicaller.
+Returns the address that called `aggregateWithSender` on the multicaller with sender contract, if `msg.sender` is the multicaller with sender contract.
 
 Otherwise, returns `msg.sender`.
 
@@ -114,7 +117,7 @@ The contracts are designed with a priority on efficiency and minimalism.
 
 For the following, the contracts called must read the `msg.sender` from the multicaller contract. 
 
-The `MulticallerReader` library can be used for efficient reading.
+The `LibMulticaller` library can be used for efficient reading.
 
 **Example use cases:**
 
diff --git a/build_multicaller.sh b/build_multicaller.sh
@@ -56,3 +56,6 @@ fs.writeFileSync(
 node .tmp/generate_initcodehash.js;
 
 rm .tmp/*.sol .tmp/*.js > /dev/null 2>&1;
+
+cat multicaller/initcodehash.txt; echo;
+cat multicaller/initcode.txt; echo;
diff --git a/build_multicaller_with_sender.sh b/build_multicaller_with_sender.sh
@@ -0,0 +1,61 @@
+mkdir .tmp > /dev/null 2>&1;
+
+forge fmt;
+
+cp src/MulticallerWithSender.sol .tmp;
+
+echo 'const fs = require("fs"), rfs = s => fs.readFileSync(s, { encoding: "utf8", flag: "r" });
+const p = ".tmp/MulticallerWithSender.sol";
+fs.writeFileSync(
+    p, 
+    rfs(p).replace(/import\s*?\"\.\/utils/, "import \".")
+)' > .tmp/replace_imports.js;
+node .tmp/replace_imports.js;
+
+rm .tmp/foundry.toml > /dev/null 2>&1;
+
+forge build --out="out" --root=".tmp" --contracts="." --via-ir --optimize --optimizer-runs=1000000 --use=0.8.18;
+
+mkdir multicaller_with_sender > /dev/null 2>&1;
+
+echo 'const fs = require("fs"), rfs = s => fs.readFileSync(s, { encoding: "utf8", flag: "r" });
+fs.writeFileSync(
+    "multicaller_with_sender/initcode.txt", 
+    JSON.parse(rfs(".tmp/out/MulticallerWithSender.sol/MulticallerWithSender.json"))["bytecode"]["object"].slice(2)
+)' > .tmp/extract_initcode.js;
+node .tmp/extract_initcode.js;
+
+echo 'const fs = require("fs"), rfs = s => fs.readFileSync(s, { encoding: "utf8", flag: "r" });
+fs.writeFileSync(
+    "multicaller_with_sender/input.json", 
+    JSON.stringify({
+        "language": "Solidity",
+        "sources": {
+            "MulticallerWithSender.sol": {
+                "content": rfs(".tmp/MulticallerWithSender.sol")
+            }
+        },
+        "settings": {
+            "optimizer": { "enabled": true, "runs": 1000000 },
+            "viaIR": true,
+            "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "abi" ] } }
+        }
+    })
+)' > .tmp/generate_input_json.js;
+node .tmp/generate_input_json.js;
+
+echo '{ "devDependencies": { "@ethersproject/keccak256": "5.7.0" } }' > .tmp/package.json;
+
+if [ ! -f .tmp/package-lock.json ]; then cd .tmp; npm install; cd ..; fi
+
+echo 'const fs = require("fs"), rfs = s => fs.readFileSync(s, { encoding: "utf8", flag: "r" });
+fs.writeFileSync(
+    "multicaller_with_sender/initcodehash.txt", 
+    require("@ethersproject/keccak256").keccak256("0x" + rfs("multicaller_with_sender/initcode.txt"))
+)' > .tmp/generate_initcodehash.js;
+node .tmp/generate_initcodehash.js;
+
+rm .tmp/*.sol .tmp/*.js > /dev/null 2>&1;
+
+cat multicaller_with_sender/initcodehash.txt; echo;
+cat multicaller_with_sender/initcode.txt; echo;
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "multicaller",
   "license": "MIT",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Efficient multicaller contract",
   "files": [
     "src/**/*.sol"
diff --git a/src/LibMulticaller.sol b/src/LibMulticaller.sol
@@ -2,26 +2,31 @@
 pragma solidity ^0.8.4;
 
 /**
- * @title MulticallerReader
+ * @title LibMulticaller
  * @author vectorized.eth
- * @notice Library to read the `msg.sender` of the multicaller contract.
+ * @notice Library to read the `msg.sender` of the multicaller with sender contract.
  */
-library MulticallerReader {
+library LibMulticaller {
     /**
      * @dev The address of the multicaller contract.
      */
-    address internal constant MULTICALLER = 0x00000000000015bF55A34241Bbf73Ec4f4b080B2;
+    address internal constant MULTICALLER = 0x0000000000Fb21e1322c03884Aa754002339F983;
 
     /**
-     * @dev Returns the caller of `aggregateWithSender` on the multicaller.
+     * @dev The address of the multicaller with sender contract.
+     */
+    address internal constant MULTICALLER_WITH_SENDER = 0x0000000000D593850Ac7C4ff4D944DD8081abdB1;
+
+    /**
+     * @dev Returns the caller of `aggregateWithSender` on `MULTICALLER_WITH_SENDER`.
      */
     function multicallerSender() internal view returns (address result) {
         /// @solidity memory-safe-assembly
         assembly {
             if iszero(
                 staticcall(
                     gas(), // Remaining gas.
-                    MULTICALLER, // The multicaller.
+                    MULTICALLER_WITH_SENDER, // The multicaller.
                     0x00, // Start of calldata in memory.
                     0x00, // Length of calldata.
                     0x00, // Start of returndata in memory.
@@ -34,19 +39,19 @@ library MulticallerReader {
     }
 
     /**
-     * @dev Returns the caller of `aggregateWithSender` on the multicaller,
-     *      if the current context's `msg.sender` is the multicaller.
+     * @dev Returns the caller of `aggregateWithSender` on `MULTICALLER_WITH_SENDER`,
+     *      if the current context's `msg.sender` is `MULTICALLER_WITH_SENDER`.
      *      Otherwise, returns `msg.sender`.
      */
     function sender() internal view returns (address result) {
         /// @solidity memory-safe-assembly
         assembly {
             result := caller()
-            if eq(result, MULTICALLER) {
+            if eq(result, MULTICALLER_WITH_SENDER) {
                 if iszero(
                     staticcall(
                         gas(), // Remaining gas.
-                        MULTICALLER, // The multicaller.
+                        MULTICALLER_WITH_SENDER, // The multicaller with sender.
                         0x00, // Start of calldata in memory.
                         0x00, // Length of calldata.
                         0x00, // Start of returndata in memory.
diff --git a/src/Multicaller.sol b/src/Multicaller.sol
diff --git a/src/MulticallerWithSender.sol b/src/MulticallerWithSender.sol
diff --git a/test/Multicaller.t.sol b/test/Multicaller.t.sol

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "multicaller",`
`3`	`3`	`"license": "MIT",`
`4`		`- "version": "1.0.2",`
	`4`	`+ "version": "1.1.0",`
`5`	`5`	`"description": "Efficient multicaller contract",`
`6`	`6`	`"files": [`
`7`	`7`	`"src/*/.sol"`