@pancakeswap/multicall 2.0.0 → 3.0.1

package/README.md

@@ -0,0 +1,75 @@
+# Pancake Multicall
+
+Enhanced multicall sdk to safely make multicalls within the gas limit.
+
+Inspired by the [1inch multicall](https://github.com/1inch/multicall).
+
+## Install
+
+```bash
+$ pnpm add @pancakeswap/multicall @pancakeswap/sdk viem
+```
+
+## Usage
+
+### Basic usage
+
+By default the calls will be splitted into chunks based on gas limit of each call and the rpc call gas limit of the chain
+
+```typescript
+import { ChainId } from '@pancakeswap/sdk'
+import { multicallByGasLimit, MulticallRequestWithGas } from '@pancakeswap/multicall'
+
+const calls: MulticallRequestWithGas[] = [
+  {
+    // Target contract to call
+    target: '0x',
+    // Encoded call data
+    callData: '',
+    // The maximum gas limit set to this single call
+    gasLimit: 1_000_000,
+  },
+]
+
+const { results, blockNumber } = await multicallByGasLimit(calls, {
+  chainId: ChainId.BSC,
+
+  // Rpc client. Please refer to `PublicClient` from viem
+  client,
+})
+
+for (const { success, result, gasUsed } of results) {
+  if (success) {
+    // Decode result
+    decodeResult(result)
+  }
+}
+```
+
+### Advanced usage
+
+The rpc call gas limit can be overriden if provided. Once provided, the multicall sdk won't ask for the gas limit from on chain.
+
+```typescript
+const { results, blockNumber } = await multicallByGasLimit(calls, {
+  chainId: ChainId.BSC,
+  client,
+  gasLimit: 150_000_000,
+})
+```
+
+## Other utilities
+
+### Get multicall gas limit
+
+```typescript
+import { ChainId } from '@pancakeswap/sdk'
+import { getGasLimitOnChain } from '@pancakeswap/multicall'
+
+// Get the rpc call gas limit of the specified chain
+const gasLimit = await getGasLimitOnChain(ChainId.BSC)
+```
+
+## Supported chains
+
+For supported chains and contract addresses, please refer to [multicall contracts](https://github.com/pancakeswap/pancake-frontend/blob/develop/packages/multicall/src/constants/contracts.ts).

package/dist/abis/IMulticall.d.ts

@@ -0,0 +1,36 @@
+export declare const iMulticallABI: {
+    inputs: ({
+        components: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        internalType: string;
+        name: string;
+        type: string;
+    } | {
+        internalType: string;
+        name: string;
+        type: string;
+        components?: undefined;
+    })[];
+    name: string;
+    outputs: ({
+        internalType: string;
+        name: string;
+        type: string;
+        components?: undefined;
+    } | {
+        components: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        internalType: string;
+        name: string;
+        type: string;
+    })[];
+    stateMutability: string;
+    type: string;
+}[];
+//# sourceMappingURL=IMulticall.d.ts.map

package/dist/abis/IMulticall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMulticall.d.ts","sourceRoot":"","sources":["../../src/abis/IMulticall.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EzB,CAAA"}

package/dist/constants/blockConflictTolerance.d.ts

@@ -0,0 +1,6 @@
+import { ChainId } from '@pancakeswap/sdk';
+export declare const DEFAULT_BLOCK_CONFLICT_TOLERANCE = 0;
+export declare const BLOCK_CONFLICT_TOLERANCE: {
+    [key in ChainId]?: number;
+};
+//# sourceMappingURL=blockConflictTolerance.d.ts.map

package/dist/constants/blockConflictTolerance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockConflictTolerance.d.ts","sourceRoot":"","sources":["../../src/constants/blockConflictTolerance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1C,eAAO,MAAM,gCAAgC,IAAI,CAAA;AAEjD,eAAO,MAAM,wBAAwB,EAAE;KAAG,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,MAAM;CAmBjE,CAAA"}

package/dist/constants/contracts.d.ts

@@ -0,0 +1,6 @@
+import { ChainId } from '@pancakeswap/sdk';
+import { Address } from 'viem';
+export declare const MULTICALL_ADDRESS: {
+    [key in ChainId]?: Address;
+};
+//# sourceMappingURL=contracts.d.ts.map

package/dist/constants/contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../src/constants/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAE9B,eAAO,MAAM,iBAAiB,EAAE;KAAG,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,OAAO;CAmB3D,CAAA"}

package/dist/constants/gasLimit.d.ts

@@ -0,0 +1,10 @@
+import { ChainId } from '@pancakeswap/sdk';
+export declare const DEFAULT_GAS_LIMIT = 150000000n;
+export declare const DEFAULT_GAS_LIMIT_BY_CHAIN: {
+    [key in ChainId]?: bigint;
+};
+export declare const DEFAULT_GAS_BUFFER = 3000000n;
+export declare const DEFAULT_GAS_BUFFER_BY_CHAIN: {
+    [key in ChainId]?: bigint;
+};
+//# sourceMappingURL=gasLimit.d.ts.map

package/dist/constants/gasLimit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gasLimit.d.ts","sourceRoot":"","sources":["../../src/constants/gasLimit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1C,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAE3C,eAAO,MAAM,0BAA0B,EAAE;KAAG,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,MAAM;CAInE,CAAA;AAED,eAAO,MAAM,kBAAkB,WAAW,CAAA;AAE1C,eAAO,MAAM,2BAA2B,EAAE;KAAG,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,MAAM;CAGpE,CAAA"}

package/dist/constants/index.d.ts

@@ -0,0 +1,4 @@
+export * from './contracts';
+export * from './blockConflictTolerance';
+export * from './gasLimit';
+//# sourceMappingURL=index.d.ts.map

package/dist/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,0BAA0B,CAAA;AACxC,cAAc,YAAY,CAAA"}

package/dist/getBlockConflictTolerance.d.ts

@@ -0,0 +1,3 @@
+import { ChainId } from '@pancakeswap/sdk';
+export declare function getBlockConflictTolerance(chainId: ChainId): number;
+//# sourceMappingURL=getBlockConflictTolerance.d.ts.map

package/dist/getBlockConflictTolerance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlockConflictTolerance.d.ts","sourceRoot":"","sources":["../src/getBlockConflictTolerance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAI1C,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,OAAO,UAEzD"}

package/dist/getGasLimit.d.ts

@@ -0,0 +1,15 @@
+import { BigintIsh, ChainId } from '@pancakeswap/sdk';
+import { PublicClient } from 'viem';
+export type GetGasLimitParams = {
+    chainId: ChainId;
+    client?: PublicClient;
+    gasLimit?: BigintIsh;
+    maxGasLimit?: BigintIsh;
+    gasBuffer?: BigintIsh;
+};
+export declare function getDefaultGasLimit(chainId?: ChainId): bigint;
+export declare function getDefaultGasBuffer(chainId?: ChainId): bigint;
+export type GetGasLimitOnChainParams = Pick<GetGasLimitParams, 'chainId' | 'client'>;
+export declare function getGasLimitOnChain({ chainId, client }: GetGasLimitOnChainParams): Promise<bigint>;
+export declare function getGasLimit({ chainId, gasLimit: gasLimitInput, maxGasLimit: maxGasLimitInput, gasBuffer: gasBufferInput, client, }: GetGasLimitParams): Promise<bigint>;
+//# sourceMappingURL=getGasLimit.d.ts.map

package/dist/getGasLimit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getGasLimit.d.ts","sourceRoot":"","sources":["../src/getGasLimit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAUnC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,YAAY,CAAA;IAGrB,QAAQ,CAAC,EAAE,SAAS,CAAA;IAGpB,WAAW,CAAC,EAAE,SAAS,CAAA;IAEvB,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,OAAO,UAGnD;AAED,wBAAgB,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,UAGpD;AAED,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,QAAQ,CAAC,CAAA;AAEpF,wBAAsB,kBAAkB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,wBAAwB,mBAIrF;AAED,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,QAAQ,EAAE,aAAa,EACvB,WAAW,EAAE,gBAA8C,EAC3D,SAAS,EAAE,cAA6C,EACxD,MAAM,GACP,EAAE,iBAAiB,mBAQnB"}

package/dist/getMulticallContract.d.ts

@@ -0,0 +1,10 @@
+import { ChainId } from '@pancakeswap/sdk';
+import { GetContractReturnType, PublicClient } from 'viem';
+import { iMulticallABI } from './abis/IMulticall';
+type Params = {
+    chainId: ChainId;
+    client?: PublicClient;
+};
+export declare function getMulticallContract({ chainId, client, }: Params): GetContractReturnType<typeof iMulticallABI, PublicClient>;
+export {};
+//# sourceMappingURL=getMulticallContract.d.ts.map

package/dist/getMulticallContract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMulticallContract.d.ts","sourceRoot":"","sources":["../src/getMulticallContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAe,MAAM,MAAM,CAAA;AAGvE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAEjD,KAAK,MAAM,GAAG;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,wBAAgB,oBAAoB,CAAC,EACnC,OAAO,EACP,MAAM,GACP,EAAE,MAAM,GAAG,qBAAqB,CAAC,OAAO,aAAa,EAAE,YAAY,CAAC,CAOpE"}

package/dist/index.d.ts

@@ -1,54 +1,8 @@
-import { Contract, CallOverrides } from '@ethersproject/contracts';
-import { Provider } from '@ethersproject/providers';
-import { ChainId } from '@pancakeswap/sdk';
-
-declare const multicallAddresses: {
-    readonly 1: "0xcA11bde05977b3631167028862bE2a173976CA11";
-    readonly 4: "0xcA11bde05977b3631167028862bE2a173976CA11";
-    readonly 5: "0xcA11bde05977b3631167028862bE2a173976CA11";
-    readonly 56: "0xcA11bde05977b3631167028862bE2a173976CA11";
-    readonly 97: "0xcA11bde05977b3631167028862bE2a173976CA11";
-};
-declare const getMulticallContract: (chainId: ChainId, provider: Provider) => Contract | null;
-interface Call {
-    address: string;
-    name: string;
-    params?: any[];
-}
-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;
-}
-interface CallV3 extends Call {
-    abi: any[] | any;
-    allowFailure?: boolean;
-}
-interface MulticallV3Params {
-    calls: CallV3[];
-    chainId?: ChainId;
-    allowFailure?: boolean;
-    overrides?: CallOverrides;
-}
-type MultiCallV2 = <T = any>(params: MulticallV2Params) => Promise<T>;
-type MultiCall = <T = any>(abi: any[], calls: Call[], chainId?: ChainId) => Promise<T>;
-declare function createMulticall<TProvider extends Provider>(provider: ({ chainId }: {
-    chainId?: number | undefined;
-}) => TProvider): {
-    multicall: MultiCall;
-    multicallv2: MultiCallV2;
-    multicallv3: ({ calls, chainId, allowFailure, overrides }: MulticallV3Params) => Promise<any>;
-};
-
-export { Call, CallV3, MultiCall, MultiCallV2, MulticallOptions, createMulticall, getMulticallContract, multicallAddresses };
+export * from './getGasLimit';
+export * from './abis/IMulticall';
+export * from './constants';
+export * from './getMulticallContract';
+export * from './multicall';
+export * from './types';
+export * from './getBlockConflictTolerance';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,aAAa,CAAA;AAC3B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,6BAA6B,CAAA"}