@pancakeswap/multicall 2.0.0 → 3.0.0

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "@pancakeswap/multicall",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "sideEffects": false,
-  "peerDependencies": {
-    "@pancakeswap/sdk": "^4.0.0"
-  },
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
   "dependencies": {
-    "@ethersproject/abi": "^5.0.0",
-    "@ethersproject/contracts": "^5.0.0",
-    "@ethersproject/providers": "^5.0.0"
+    "viem": "^1.2.9",
+    "@pancakeswap/sdk": "5.4.1"
   },
   "devDependencies": {
     "tsup": "^6.7.0",
-    "typescript": "^4.9.4",
-    "@pancakeswap/sdk": "4.0.0",
-    "@pancakeswap/tsconfig": "0.0.0"
+    "typescript": "^5.1.3",
+    "vitest": "^0.27.2",
+    "@pancakeswap/tsconfig": "0.0.0",
+    "@pancakeswap/utils": "5.0.2"
   },
   "exports": {
     "./package.json": "./package.json",
@@ -22,12 +25,13 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
-    },
-    "./Multicall.json": "./Multicall.json"
+    }
   },
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
+    "test": "vitest --run",
+    "coverage": "vitest run --coverage",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
   }
 }

package/CHANGELOG.md

@@ -1,25 +0,0 @@
-# @pancakeswap/multicall
-
-## 2.0.0
-
-### Patch Changes
-
-- Updated dependencies [b5dbd2921]
-  - @pancakeswap/sdk@4.0.0
-
-## 1.0.0
-
-### Minor Changes
-
-- 65fbb250a: Bump version
-
-### Patch Changes
-
-- Updated dependencies [65fbb250a]
-  - @pancakeswap/sdk@3.2.0
-
-## 0.0.2
-
-### Patch Changes
-
-- 1e4a4b27c: Base multicall feature

package/Multicall.json

@@ -1,236 +0,0 @@
-[
-  {
-    "inputs": [
-      {
-        "components": [
-          { "internalType": "address", "name": "target", "type": "address" },
-          { "internalType": "bytes", "name": "callData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Call[]",
-        "name": "calls",
-        "type": "tuple[]"
-      }
-    ],
-    "name": "aggregate",
-    "outputs": [
-      { "internalType": "uint256", "name": "blockNumber", "type": "uint256" },
-      { "internalType": "bytes[]", "name": "returnData", "type": "bytes[]" }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          { "internalType": "address", "name": "target", "type": "address" },
-          { "internalType": "bool", "name": "allowFailure", "type": "bool" },
-          { "internalType": "bytes", "name": "callData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Call3[]",
-        "name": "calls",
-        "type": "tuple[]"
-      }
-    ],
-    "name": "aggregate3",
-    "outputs": [
-      {
-        "components": [
-          { "internalType": "bool", "name": "success", "type": "bool" },
-          { "internalType": "bytes", "name": "returnData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Result[]",
-        "name": "returnData",
-        "type": "tuple[]"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          { "internalType": "address", "name": "target", "type": "address" },
-          { "internalType": "bool", "name": "allowFailure", "type": "bool" },
-          { "internalType": "uint256", "name": "value", "type": "uint256" },
-          { "internalType": "bytes", "name": "callData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Call3Value[]",
-        "name": "calls",
-        "type": "tuple[]"
-      }
-    ],
-    "name": "aggregate3Value",
-    "outputs": [
-      {
-        "components": [
-          { "internalType": "bool", "name": "success", "type": "bool" },
-          { "internalType": "bytes", "name": "returnData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Result[]",
-        "name": "returnData",
-        "type": "tuple[]"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      {
-        "components": [
-          { "internalType": "address", "name": "target", "type": "address" },
-          { "internalType": "bytes", "name": "callData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Call[]",
-        "name": "calls",
-        "type": "tuple[]"
-      }
-    ],
-    "name": "blockAndAggregate",
-    "outputs": [
-      { "internalType": "uint256", "name": "blockNumber", "type": "uint256" },
-      { "internalType": "bytes32", "name": "blockHash", "type": "bytes32" },
-      {
-        "components": [
-          { "internalType": "bool", "name": "success", "type": "bool" },
-          { "internalType": "bytes", "name": "returnData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Result[]",
-        "name": "returnData",
-        "type": "tuple[]"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getBasefee",
-    "outputs": [{ "internalType": "uint256", "name": "basefee", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [{ "internalType": "uint256", "name": "blockNumber", "type": "uint256" }],
-    "name": "getBlockHash",
-    "outputs": [{ "internalType": "bytes32", "name": "blockHash", "type": "bytes32" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getBlockNumber",
-    "outputs": [{ "internalType": "uint256", "name": "blockNumber", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getChainId",
-    "outputs": [{ "internalType": "uint256", "name": "chainid", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getCurrentBlockCoinbase",
-    "outputs": [{ "internalType": "address", "name": "coinbase", "type": "address" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getCurrentBlockDifficulty",
-    "outputs": [{ "internalType": "uint256", "name": "difficulty", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getCurrentBlockGasLimit",
-    "outputs": [{ "internalType": "uint256", "name": "gaslimit", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getCurrentBlockTimestamp",
-    "outputs": [{ "internalType": "uint256", "name": "timestamp", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [{ "internalType": "address", "name": "addr", "type": "address" }],
-    "name": "getEthBalance",
-    "outputs": [{ "internalType": "uint256", "name": "balance", "type": "uint256" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [],
-    "name": "getLastBlockHash",
-    "outputs": [{ "internalType": "bytes32", "name": "blockHash", "type": "bytes32" }],
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      { "internalType": "bool", "name": "requireSuccess", "type": "bool" },
-      {
-        "components": [
-          { "internalType": "address", "name": "target", "type": "address" },
-          { "internalType": "bytes", "name": "callData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Call[]",
-        "name": "calls",
-        "type": "tuple[]"
-      }
-    ],
-    "name": "tryAggregate",
-    "outputs": [
-      {
-        "components": [
-          { "internalType": "bool", "name": "success", "type": "bool" },
-          { "internalType": "bytes", "name": "returnData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Result[]",
-        "name": "returnData",
-        "type": "tuple[]"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  },
-  {
-    "inputs": [
-      { "internalType": "bool", "name": "requireSuccess", "type": "bool" },
-      {
-        "components": [
-          { "internalType": "address", "name": "target", "type": "address" },
-          { "internalType": "bytes", "name": "callData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Call[]",
-        "name": "calls",
-        "type": "tuple[]"
-      }
-    ],
-    "name": "tryBlockAndAggregate",
-    "outputs": [
-      { "internalType": "uint256", "name": "blockNumber", "type": "uint256" },
-      { "internalType": "bytes32", "name": "blockHash", "type": "bytes32" },
-      {
-        "components": [
-          { "internalType": "bool", "name": "success", "type": "bool" },
-          { "internalType": "bytes", "name": "returnData", "type": "bytes" }
-        ],
-        "internalType": "struct Multicall3.Result[]",
-        "name": "returnData",
-        "type": "tuple[]"
-      }
-    ],
-    "stateMutability": "payable",
-    "type": "function"
-  }
-]

package/index.ts

@@ -1,138 +0,0 @@
-import { Interface, Fragment } from '@ethersproject/abi'
-import { CallOverrides, Contract } from '@ethersproject/contracts'
-import { Provider } from '@ethersproject/providers'
-import { ChainId } from '@pancakeswap/sdk'
-
-import multicallAbi from './Multicall.json'
-
-export const multicallAddresses = {
-  1: '0xcA11bde05977b3631167028862bE2a173976CA11',
-  4: '0xcA11bde05977b3631167028862bE2a173976CA11',
-  5: '0xcA11bde05977b3631167028862bE2a173976CA11',
-  56: '0xcA11bde05977b3631167028862bE2a173976CA11',
-  97: '0xcA11bde05977b3631167028862bE2a173976CA11',
-} as const
-
-export const getMulticallContract = (chainId: ChainId, provider: Provider) => {
-  if (multicallAddresses[chainId as keyof typeof multicallAddresses]) {
-    return new Contract(multicallAddresses[chainId as keyof typeof multicallAddresses], multicallAbi, provider)
-  }
-  return null
-}
-
-export interface Call {
-  address: string // Address of the contract
-  name: string // Function name on the contract (example: balanceOf)
-  params?: any[] // Function params
-}
-
-export interface MulticallOptions extends CallOverrides {
-  requireSuccess?: boolean
-}
-
-/**
- * Multicall V2 uses the new "tryAggregate" function. It is different in 2 ways
- *
- * 1. If "requireSuccess" is false multicall will not bail out if one of the calls fails
- * 2. The return includes a boolean whether the call was successful e.g. [wasSuccessful, callResult]
- */
-interface MulticallV2Params {
-  abi: any[] | any
-  calls: Call[]
-  chainId?: ChainId
-  options?: MulticallOptions
-  provider?: Provider
-}
-
-export interface CallV3 extends Call {
-  abi: any[] | any
-  allowFailure?: boolean
-}
-
-interface MulticallV3Params {
-  calls: CallV3[]
-  chainId?: ChainId
-  allowFailure?: boolean
-  overrides?: CallOverrides
-}
-
-export type MultiCallV2 = <T = any>(params: MulticallV2Params) => Promise<T>
-export type MultiCall = <T = any>(abi: any[], calls: Call[], chainId?: ChainId) => Promise<T>
-
-export function createMulticall<TProvider extends Provider>(
-  provider: ({ chainId }: { chainId?: number | undefined }) => TProvider,
-) {
-  const multicall: MultiCall = async (abi: any[], calls: Call[], chainId = ChainId.BSC) => {
-    const multi = getMulticallContract(chainId, provider({ chainId }))
-    if (!multi) throw new Error(`Multicall Provider missing for ${chainId}`)
-    const itf = new Interface(abi)
-
-    const calldata = calls.map((call) => ({
-      target: call.address.toLowerCase(),
-      callData: itf.encodeFunctionData(call.name, call.params),
-    }))
-    const { returnData } = await multi.callStatic.aggregate(calldata)
-
-    const res = returnData.map((call: any, i: number) => itf.decodeFunctionResult(calls[i].name, call))
-
-    return res as any
-  }
-
-  const multicallv2: MultiCallV2 = async ({ abi, calls, chainId = ChainId.BSC, options, provider: _provider }) => {
-    const { requireSuccess = true, ...overrides } = options || {}
-    const multi = getMulticallContract(chainId, _provider || provider({ chainId }))
-    if (!multi) throw new Error(`Multicall Provider missing for ${chainId}`)
-    const itf = new Interface(abi)
-
-    const calldata = calls.map((call) => ({
-      target: call.address.toLowerCase(),
-      callData: itf.encodeFunctionData(call.name, call.params),
-    }))
-
-    const returnData = await multi.callStatic.tryAggregate(requireSuccess, calldata, overrides)
-    const res = returnData.map((call: any, i: number) => {
-      const [result, data] = call
-      return result && data !== '0x' ? itf.decodeFunctionResult(calls[i].name, data) : null
-    })
-
-    return res as any
-  }
-
-  const multicallv3 = async ({ calls, chainId = ChainId.BSC, allowFailure, overrides }: MulticallV3Params) => {
-    const multi = getMulticallContract(chainId, provider({ chainId }))
-    if (!multi) throw new Error(`Multicall Provider missing for ${chainId}`)
-    const interfaceCache = new WeakMap()
-    const _calls = calls.map(({ abi, address, name, params, allowFailure: _allowFailure }) => {
-      let itf = interfaceCache.get(abi)
-      if (!itf) {
-        itf = new Interface(abi)
-        interfaceCache.set(abi, itf)
-      }
-      if (!itf.fragments.some((fragment: Fragment) => fragment.name === name))
-        console.error(`${name} missing on ${address}`)
-      const callData = itf.encodeFunctionData(name, params ?? [])
-      return {
-        target: address.toLowerCase(),
-        allowFailure: allowFailure || _allowFailure,
-        callData,
-      }
-    })
-
-    const result = await multi.callStatic.aggregate3(_calls, ...(overrides ? [overrides] : []))
-
-    return result.map((call: any, i: number) => {
-      const { returnData, success } = call
-      if (!success || returnData === '0x') return null
-      const { abi, name } = calls[i]
-      const itf = interfaceCache.get(abi)
-      const decoded = itf?.decodeFunctionResult(name, returnData)
-      return decoded
-    })
-  }
-
-  return {
-    multicall,
-    multicallv2,
-    multicallv3,
-  }
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "@pancakeswap/tsconfig/base",
-  "include": ["./index.ts"],
-  "compilerOptions": {
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "skipLibCheck": true
-  }
-}

package/tsup.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from 'tsup'
-
-export default defineConfig({
-  entry: {
-    index: 'index.ts',
-  },
-  format: ['esm', 'cjs'],
-  dts: true,
-  treeshake: true,
-  splitting: true,
-})