@certik/skynet 0.8.16 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.0
+
+- Added `web3` library with call support
+
 ## 0.8.16
 
 - Changed monitor exit behavior

package/abi.js

@@ -6,35 +6,35 @@ const ERC20 = [
     outputs: [
       {
         name: "",
-        type: "string"
-      }
+        type: "string",
+      },
     ],
     payable: false,
     stateMutability: "view",
-    type: "function"
+    type: "function",
   },
   {
     constant: false,
     inputs: [
       {
         name: "_spender",
-        type: "address"
+        type: "address",
       },
       {
         name: "_value",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     name: "approve",
     outputs: [
       {
         name: "",
-        type: "bool"
-      }
+        type: "bool",
+      },
     ],
     payable: false,
     stateMutability: "nonpayable",
-    type: "function"
+    type: "function",
   },
   {
     constant: true,
@@ -43,39 +43,39 @@ const ERC20 = [
     outputs: [
       {
         name: "",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     payable: false,
     stateMutability: "view",
-    type: "function"
+    type: "function",
   },
   {
     constant: false,
     inputs: [
       {
         name: "_from",
-        type: "address"
+        type: "address",
       },
       {
         name: "_to",
-        type: "address"
+        type: "address",
       },
       {
         name: "_value",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     name: "transferFrom",
     outputs: [
       {
         name: "",
-        type: "bool"
-      }
+        type: "bool",
+      },
     ],
     payable: false,
     stateMutability: "nonpayable",
-    type: "function"
+    type: "function",
   },
   {
     constant: true,
@@ -84,31 +84,31 @@ const ERC20 = [
     outputs: [
       {
         name: "",
-        type: "uint8"
-      }
+        type: "uint8",
+      },
     ],
     payable: false,
     stateMutability: "view",
-    type: "function"
+    type: "function",
   },
   {
     constant: true,
     inputs: [
       {
         name: "_owner",
-        type: "address"
-      }
+        type: "address",
+      },
     ],
     name: "balanceOf",
     outputs: [
       {
         name: "balance",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     payable: false,
     stateMutability: "view",
-    type: "function"
+    type: "function",
   },
   {
     constant: true,
@@ -117,63 +117,63 @@ const ERC20 = [
     outputs: [
       {
         name: "",
-        type: "string"
-      }
+        type: "string",
+      },
     ],
     payable: false,
     stateMutability: "view",
-    type: "function"
+    type: "function",
   },
   {
     constant: false,
     inputs: [
       {
         name: "_to",
-        type: "address"
+        type: "address",
       },
       {
         name: "_value",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     name: "transfer",
     outputs: [
       {
         name: "",
-        type: "bool"
-      }
+        type: "bool",
+      },
     ],
     payable: false,
     stateMutability: "nonpayable",
-    type: "function"
+    type: "function",
   },
   {
     constant: true,
     inputs: [
       {
         name: "_owner",
-        type: "address"
+        type: "address",
       },
       {
         name: "_spender",
-        type: "address"
-      }
+        type: "address",
+      },
     ],
     name: "allowance",
     outputs: [
       {
         name: "",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     payable: false,
     stateMutability: "view",
-    type: "function"
+    type: "function",
   },
   {
     payable: true,
     stateMutability: "payable",
-    type: "fallback"
+    type: "fallback",
   },
   {
     anonymous: false,
@@ -181,21 +181,21 @@ const ERC20 = [
       {
         indexed: true,
         name: "owner",
-        type: "address"
+        type: "address",
       },
       {
         indexed: true,
         name: "spender",
-        type: "address"
+        type: "address",
       },
       {
         indexed: false,
         name: "value",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     name: "Approval",
-    type: "event"
+    type: "event",
   },
   {
     anonymous: false,
@@ -203,25 +203,151 @@ const ERC20 = [
       {
         indexed: true,
         name: "from",
-        type: "address"
+        type: "address",
       },
       {
         indexed: true,
         name: "to",
-        type: "address"
+        type: "address",
       },
       {
         indexed: false,
         name: "value",
-        type: "uint256"
-      }
+        type: "uint256",
+      },
     ],
     name: "Transfer",
-    type: "event"
-  }
+    type: "event",
+  },
+];
+
+const MULTICALL = [
+  {
+    inputs: [{ internalType: "address", name: "_addr", type: "address" }],
+    name: "callBalanceOf",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callBlockNumber",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint256", name: "_i", type: "uint256" }],
+    name: "callBlockhash",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callChainId",
+    outputs: [{ internalType: "uint256", name: "id", type: "uint256" }],
+    stateMutability: "pure",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "_addr", type: "address" }],
+    name: "callCode",
+    outputs: [{ internalType: "bytes", name: "code", type: "bytes" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "_addr", type: "address" }],
+    name: "callCodeHash",
+    outputs: [{ internalType: "bytes32", name: "codeHash", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "_addr", type: "address" }],
+    name: "callCodeSize",
+    outputs: [{ internalType: "uint256", name: "size", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callCoinbase",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callDifficulty",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callGasLeft",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callGasLimit",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callGasPrice",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callOrigin",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "callTimestamp",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        components: [
+          { internalType: "bool", name: "delegateCall", type: "bool" },
+          { internalType: "bool", name: "revertOnError", type: "bool" },
+          { internalType: "uint256", name: "gasLimit", type: "uint256" },
+          { internalType: "address", name: "target", type: "address" },
+          { internalType: "uint256", name: "value", type: "uint256" },
+          { internalType: "bytes", name: "data", type: "bytes" },
+        ],
+        internalType: "struct IModuleCalls.Transaction[]",
+        name: "_txs",
+        type: "tuple[]",
+      },
+    ],
+    name: "multiCall",
+    outputs: [
+      { internalType: "bool[]", name: "_successes", type: "bool[]" },
+      { internalType: "bytes[]", name: "_results", type: "bytes[]" },
+    ],
+    stateMutability: "payable",
+    type: "function",
+  },
 ];
 
 module.exports = {
+  MULTICALL,
   ERC20,
-  BEP20: ERC20
+  BEP20: ERC20,
 };

package/const.js

@@ -23,6 +23,7 @@ const PROTOCOLS = {
       endpoint: "https://api.etherscan.io/api",
       key: getEtherScanApiKey(),
     },
+    multiCallProvider: "0xCa731e0f33Afbcfa9363d6F7449d1f5447d10C80",
     scanUrl: "https://etherscan.io/",
   },
   bsc: {
@@ -39,6 +40,7 @@ const PROTOCOLS = {
       endpoint: "https://api.bscscan.com/api",
       key: getBscScanApiKey(),
     },
+    multiCallProvider: "0xe7144e57d832c9005D252f415d205b4b8D78228e",
     scanUrl: "https://bscscan.com/",
   },
   polygon: {
@@ -56,8 +58,9 @@ const PROTOCOLS = {
       endpoint: "https://api.polygonscan.com/api",
       key: getPolygonScanApiKey(),
     },
+    multiCallProvider: "", // TODO
     scanUrl: "https://polygonscan.com/",
-  },
+  }
 };
 
 const TIME = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@certik/skynet",
-  "version": "0.8.16",
+  "version": "0.9.0",
   "description": "Skynet Shared JS library",
   "main": "index.js",
   "author": "CertiK Engineering",

package/util.js

@@ -10,10 +10,7 @@ function partition(startAt, endAt, numGroups) {
   const step = Math.max(Math.floor(span / numGroups), 1);
   const adjustedStep = span % step === 0 ? step : step + 1;
 
-  return [
-    [startAt, startAt + adjustedStep - 1],
-    ...partition(startAt + adjustedStep, endAt, numGroups - 1)
-  ];
+  return [[startAt, startAt + adjustedStep - 1], ...partition(startAt + adjustedStep, endAt, numGroups - 1)];
 }
 
 // Inclusive range
@@ -50,9 +47,21 @@ function fillRange(start, end) {
   return result;
 }
 
+function chunk(array, count) {
+  if (count == null || count < 1) return [];
+  var result = [];
+  var i = 0,
+    length = array.length;
+  while (i < length) {
+    result.push(array.slice(i, (i += count)));
+  }
+  return result;
+}
+
 module.exports = {
   arrayGroup,
   partition,
   range,
-  fillRange
+  fillRange,
+  chunk
 };

package/web3.js

@@ -0,0 +1,117 @@
+const Web3 = require("web3");
+const { PROTOCOLS } = require("./const");
+const { MULTICALL } = require("./abi");
+const { chunk } = require("./util");
+const MULTICALL_CHUNK_SIZE = 400;
+
+function newWeb3ByProtocol(protocol) {
+  if (!Object.keys(PROTOCOLS).includes(protocol)) {
+    return null;
+  }
+
+  return new Web3(PROTOCOLS[protocol].endpoint);
+}
+
+function normalizeCallParams(params) {
+  if (params === undefined) {
+    return [];
+  }
+
+  if (Array.isArray(params)) {
+    return params;
+  }
+
+  return [params];
+}
+
+async function singleCall(protocol, abi, target, params) {
+  const web3 = newWeb3ByProtocol(protocol);
+
+  if (!web3) {
+    throw new Error(`unsupported protocol`);
+  }
+
+  const contract = new web3.eth.Contract([abi], target);
+  const functionSignature = web3.eth.abi.encodeFunctionSignature(abi);
+  const method = contract.methods[functionSignature];
+
+  const result = await method(...normalizeCallParams(params)).call();
+
+  return result;
+}
+
+// limiter if provided, should be an instance of Bottleneck, which is part of bottleneck package
+async function multiCall({ protocol, limiter = null, target, abi, calls }) {
+  const web3 = newWeb3ByProtocol(protocol);
+
+  if (!web3) {
+    throw new Error(`unsupported protocol`);
+  }
+
+  const multiCallProviderAddress = PROTOCOLS[protocol].multiCallProvider;
+
+  if (!multiCallProviderAddress) {
+    throw new Error("protocol doesn't support multicall yet");
+  }
+
+  if (calls.length === 0) return { callCount: 0, output: [] };
+
+  const multiCallContract = new web3.eth.Contract(MULTICALL, multiCallProviderAddress);
+
+  let maybeRateLimitedCallChunk = async (callChunk) => {
+    const txs = callChunk.map((call) => ({
+      delegateCall: false,
+      revertOnError: false,
+      gasLimit: 0,
+      target: call.target || target,
+      value: 0,
+      data: web3.eth.abi.encodeFunctionCall(abi, normalizeCallParams(call.params)),
+    }));
+
+    const response = await multiCallContract.methods.multiCall(txs).call();
+
+    return response._results.map((res, idx) => {
+      const input = {
+        target: callChunk[idx].target || target,
+        params: normalizeCallParams(callChunk[idx].params),
+      };
+
+      try {
+        const callResult = web3.eth.abi.decodeParameters(abi.outputs, res);
+
+        return {
+          input,
+          success: response._successes[idx],
+          // according to SDK doc, if there's only one, return result directly
+          output: abi.outputs.length === 1 ? callResult[0] : callResult,
+        };
+      } catch (decodeErr) {
+        console.log("decode err", abi.name, callChunk[idx].target || target, callChunk[idx].params, decodeErr.message);
+
+        return {
+          input,
+          success: false,
+          output: null,
+        };
+      }
+    });
+  };
+
+  if (limiter) {
+    maybeRateLimitedCallChunk = limiter.wrap(maybeRateLimitedCallChunk);
+  }
+
+  const callChunks = chunk(calls, MULTICALL_CHUNK_SIZE);
+
+  const responses = (
+    await Promise.all(callChunks.map(async (callChunk) => await maybeRateLimitedCallChunk(callChunk)))
+  ).flat();
+
+  return { actualCallCount: callChunks.length, output: responses };
+}
+
+module.exports = {
+  newWeb3ByProtocol,
+  singleCall,
+  multiCall,
+};