@d8x/perpetuals-sdk 1.3.6 → 2.0.0-alpha

package/src/contracts/Multicall3.ts

@@ -3,89 +3,74 @@
 /* eslint-disable */
 import type {
   BaseContract,
-  BigNumber,
   BigNumberish,
   BytesLike,
-  CallOverrides,
-  ContractTransaction,
-  PayableOverrides,
-  PopulatedTransaction,
-  Signer,
-  utils,
+  FunctionFragment,
+  Result,
+  Interface,
+  AddressLike,
+  ContractRunner,
+  ContractMethod,
+  Listener,
 } from "ethers";
-import type { FunctionFragment, Result } from "@ethersproject/abi";
-import type { Listener, Provider } from "@ethersproject/providers";
 import type {
-  TypedEventFilter,
-  TypedEvent,
+  TypedContractEvent,
+  TypedDeferredTopicFilter,
+  TypedEventLog,
   TypedListener,
-  OnEvent,
+  TypedContractMethod,
 } from "./common";
 
 export declare namespace Multicall3 {
-  export type CallStruct = { target: string; callData: BytesLike };
+  export type CallStruct = { target: AddressLike; callData: BytesLike };
 
-  export type CallStructOutput = [string, string] & {
+  export type CallStructOutput = [target: string, callData: string] & {
     target: string;
     callData: string;
   };
 
   export type Call3Struct = {
-    target: string;
+    target: AddressLike;
     allowFailure: boolean;
     callData: BytesLike;
   };
 
-  export type Call3StructOutput = [string, boolean, string] & {
-    target: string;
-    allowFailure: boolean;
-    callData: string;
-  };
+  export type Call3StructOutput = [
+    target: string,
+    allowFailure: boolean,
+    callData: string
+  ] & { target: string; allowFailure: boolean; callData: string };
 
   export type ResultStruct = { success: boolean; returnData: BytesLike };
 
-  export type ResultStructOutput = [boolean, string] & {
+  export type ResultStructOutput = [success: boolean, returnData: string] & {
     success: boolean;
     returnData: string;
   };
 
   export type Call3ValueStruct = {
-    target: string;
+    target: AddressLike;
     allowFailure: boolean;
     value: BigNumberish;
     callData: BytesLike;
   };
 
-  export type Call3ValueStructOutput = [string, boolean, BigNumber, string] & {
+  export type Call3ValueStructOutput = [
+    target: string,
+    allowFailure: boolean,
+    value: bigint,
+    callData: string
+  ] & {
     target: string;
     allowFailure: boolean;
-    value: BigNumber;
+    value: bigint;
     callData: string;
   };
 }
 
-export interface Multicall3Interface extends utils.Interface {
-  functions: {
-    "aggregate((address,bytes)[])": FunctionFragment;
-    "aggregate3((address,bool,bytes)[])": FunctionFragment;
-    "aggregate3Value((address,bool,uint256,bytes)[])": FunctionFragment;
-    "blockAndAggregate((address,bytes)[])": FunctionFragment;
-    "getBasefee()": FunctionFragment;
-    "getBlockHash(uint256)": FunctionFragment;
-    "getBlockNumber()": FunctionFragment;
-    "getChainId()": FunctionFragment;
-    "getCurrentBlockCoinbase()": FunctionFragment;
-    "getCurrentBlockDifficulty()": FunctionFragment;
-    "getCurrentBlockGasLimit()": FunctionFragment;
-    "getCurrentBlockTimestamp()": FunctionFragment;
-    "getEthBalance(address)": FunctionFragment;
-    "getLastBlockHash()": FunctionFragment;
-    "tryAggregate(bool,(address,bytes)[])": FunctionFragment;
-    "tryBlockAndAggregate(bool,(address,bytes)[])": FunctionFragment;
-  };
-
+export interface Multicall3Interface extends Interface {
   getFunction(
-    nameOrSignatureOrTopic:
+    nameOrSignature:
       | "aggregate"
       | "aggregate3"
       | "aggregate3Value"
@@ -154,7 +139,7 @@ export interface Multicall3Interface extends utils.Interface {
   ): string;
   encodeFunctionData(
     functionFragment: "getEthBalance",
-    values: [string]
+    values: [AddressLike]
   ): string;
   encodeFunctionData(
     functionFragment: "getLastBlockHash",
@@ -221,362 +206,211 @@ export interface Multicall3Interface extends utils.Interface {
     functionFragment: "tryBlockAndAggregate",
     data: BytesLike
   ): Result;
-
-  events: {};
 }
 
 export interface Multicall3 extends BaseContract {
-  connect(signerOrProvider: Signer | Provider | string): this;
-  attach(addressOrName: string): this;
-  deployed(): Promise<this>;
+  connect(runner?: ContractRunner | null): Multicall3;
+  waitForDeployment(): Promise<this>;
 
   interface: Multicall3Interface;
 
-  queryFilter<TEvent extends TypedEvent>(
-    event: TypedEventFilter<TEvent>,
+  queryFilter<TCEvent extends TypedContractEvent>(
+    event: TCEvent,
     fromBlockOrBlockhash?: string | number | undefined,
     toBlock?: string | number | undefined
-  ): Promise<Array<TEvent>>;
-
-  listeners<TEvent extends TypedEvent>(
-    eventFilter?: TypedEventFilter<TEvent>
-  ): Array<TypedListener<TEvent>>;
-  listeners(eventName?: string): Array<Listener>;
-  removeAllListeners<TEvent extends TypedEvent>(
-    eventFilter: TypedEventFilter<TEvent>
-  ): this;
-  removeAllListeners(eventName?: string): this;
-  off: OnEvent<this>;
-  on: OnEvent<this>;
-  once: OnEvent<this>;
-  removeListener: OnEvent<this>;
-
-  functions: {
-    aggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    aggregate3(
-      calls: Multicall3.Call3Struct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    aggregate3Value(
-      calls: Multicall3.Call3ValueStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    blockAndAggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    getBasefee(
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { basefee: BigNumber }>;
-
-    getBlockHash(
-      blockNumber: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<[string] & { blockHash: string }>;
-
-    getBlockNumber(
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { blockNumber: BigNumber }>;
-
-    getChainId(
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { chainid: BigNumber }>;
-
-    getCurrentBlockCoinbase(
-      overrides?: CallOverrides
-    ): Promise<[string] & { coinbase: string }>;
-
-    getCurrentBlockDifficulty(
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { difficulty: BigNumber }>;
-
-    getCurrentBlockGasLimit(
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { gaslimit: BigNumber }>;
-
-    getCurrentBlockTimestamp(
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { timestamp: BigNumber }>;
-
-    getEthBalance(
-      addr: string,
-      overrides?: CallOverrides
-    ): Promise<[BigNumber] & { balance: BigNumber }>;
-
-    getLastBlockHash(
-      overrides?: CallOverrides
-    ): Promise<[string] & { blockHash: string }>;
-
-    tryAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    tryBlockAndAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<ContractTransaction>;
-  };
-
-  aggregate(
-    calls: Multicall3.CallStruct[],
-    overrides?: PayableOverrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  aggregate3(
-    calls: Multicall3.Call3Struct[],
-    overrides?: PayableOverrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  aggregate3Value(
-    calls: Multicall3.Call3ValueStruct[],
-    overrides?: PayableOverrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  blockAndAggregate(
-    calls: Multicall3.CallStruct[],
-    overrides?: PayableOverrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  getBasefee(overrides?: CallOverrides): Promise<BigNumber>;
-
-  getBlockHash(
-    blockNumber: BigNumberish,
-    overrides?: CallOverrides
-  ): Promise<string>;
-
-  getBlockNumber(overrides?: CallOverrides): Promise<BigNumber>;
-
-  getChainId(overrides?: CallOverrides): Promise<BigNumber>;
+  ): Promise<Array<TypedEventLog<TCEvent>>>;
+  queryFilter<TCEvent extends TypedContractEvent>(
+    filter: TypedDeferredTopicFilter<TCEvent>,
+    fromBlockOrBlockhash?: string | number | undefined,
+    toBlock?: string | number | undefined
+  ): Promise<Array<TypedEventLog<TCEvent>>>;
+
+  on<TCEvent extends TypedContractEvent>(
+    event: TCEvent,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+  on<TCEvent extends TypedContractEvent>(
+    filter: TypedDeferredTopicFilter<TCEvent>,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+
+  once<TCEvent extends TypedContractEvent>(
+    event: TCEvent,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+  once<TCEvent extends TypedContractEvent>(
+    filter: TypedDeferredTopicFilter<TCEvent>,
+    listener: TypedListener<TCEvent>
+  ): Promise<this>;
+
+  listeners<TCEvent extends TypedContractEvent>(
+    event: TCEvent
+  ): Promise<Array<TypedListener<TCEvent>>>;
+  listeners(eventName?: string): Promise<Array<Listener>>;
+  removeAllListeners<TCEvent extends TypedContractEvent>(
+    event?: TCEvent
+  ): Promise<this>;
+
+  aggregate: TypedContractMethod<
+    [calls: Multicall3.CallStruct[]],
+    [[bigint, string[]] & { blockNumber: bigint; returnData: string[] }],
+    "payable"
+  >;
+
+  aggregate3: TypedContractMethod<
+    [calls: Multicall3.Call3Struct[]],
+    [Multicall3.ResultStructOutput[]],
+    "payable"
+  >;
+
+  aggregate3Value: TypedContractMethod<
+    [calls: Multicall3.Call3ValueStruct[]],
+    [Multicall3.ResultStructOutput[]],
+    "payable"
+  >;
+
+  blockAndAggregate: TypedContractMethod<
+    [calls: Multicall3.CallStruct[]],
+    [
+      [bigint, string, Multicall3.ResultStructOutput[]] & {
+        blockNumber: bigint;
+        blockHash: string;
+        returnData: Multicall3.ResultStructOutput[];
+      }
+    ],
+    "payable"
+  >;
 
-  getCurrentBlockCoinbase(overrides?: CallOverrides): Promise<string>;
+  getBasefee: TypedContractMethod<[], [bigint], "view">;
 
-  getCurrentBlockDifficulty(overrides?: CallOverrides): Promise<BigNumber>;
+  getBlockHash: TypedContractMethod<
+    [blockNumber: BigNumberish],
+    [string],
+    "view"
+  >;
 
-  getCurrentBlockGasLimit(overrides?: CallOverrides): Promise<BigNumber>;
+  getBlockNumber: TypedContractMethod<[], [bigint], "view">;
 
-  getCurrentBlockTimestamp(overrides?: CallOverrides): Promise<BigNumber>;
+  getChainId: TypedContractMethod<[], [bigint], "view">;
 
-  getEthBalance(addr: string, overrides?: CallOverrides): Promise<BigNumber>;
+  getCurrentBlockCoinbase: TypedContractMethod<[], [string], "view">;
 
-  getLastBlockHash(overrides?: CallOverrides): Promise<string>;
+  getCurrentBlockDifficulty: TypedContractMethod<[], [bigint], "view">;
 
-  tryAggregate(
-    requireSuccess: boolean,
-    calls: Multicall3.CallStruct[],
-    overrides?: PayableOverrides & { from?: string }
-  ): Promise<ContractTransaction>;
+  getCurrentBlockGasLimit: TypedContractMethod<[], [bigint], "view">;
 
-  tryBlockAndAggregate(
-    requireSuccess: boolean,
-    calls: Multicall3.CallStruct[],
-    overrides?: PayableOverrides & { from?: string }
-  ): Promise<ContractTransaction>;
+  getCurrentBlockTimestamp: TypedContractMethod<[], [bigint], "view">;
 
-  callStatic: {
-    aggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, string[]] & { blockNumber: BigNumber; returnData: string[] }
-    >;
+  getEthBalance: TypedContractMethod<[addr: AddressLike], [bigint], "view">;
 
-    aggregate3(
-      calls: Multicall3.Call3Struct[],
-      overrides?: CallOverrides
-    ): Promise<Multicall3.ResultStructOutput[]>;
+  getLastBlockHash: TypedContractMethod<[], [string], "view">;
 
-    aggregate3Value(
-      calls: Multicall3.Call3ValueStruct[],
-      overrides?: CallOverrides
-    ): Promise<Multicall3.ResultStructOutput[]>;
+  tryAggregate: TypedContractMethod<
+    [requireSuccess: boolean, calls: Multicall3.CallStruct[]],
+    [Multicall3.ResultStructOutput[]],
+    "payable"
+  >;
 
-    blockAndAggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, string, Multicall3.ResultStructOutput[]] & {
-        blockNumber: BigNumber;
+  tryBlockAndAggregate: TypedContractMethod<
+    [requireSuccess: boolean, calls: Multicall3.CallStruct[]],
+    [
+      [bigint, string, Multicall3.ResultStructOutput[]] & {
+        blockNumber: bigint;
         blockHash: string;
         returnData: Multicall3.ResultStructOutput[];
       }
-    >;
-
-    getBasefee(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getBlockHash(
-      blockNumber: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<string>;
-
-    getBlockNumber(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getChainId(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockCoinbase(overrides?: CallOverrides): Promise<string>;
-
-    getCurrentBlockDifficulty(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockGasLimit(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockTimestamp(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getEthBalance(addr: string, overrides?: CallOverrides): Promise<BigNumber>;
-
-    getLastBlockHash(overrides?: CallOverrides): Promise<string>;
+    ],
+    "payable"
+  >;
 
-    tryAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: CallOverrides
-    ): Promise<Multicall3.ResultStructOutput[]>;
+  getFunction<T extends ContractMethod = ContractMethod>(
+    key: string | FunctionFragment
+  ): T;
 
-    tryBlockAndAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, string, Multicall3.ResultStructOutput[]] & {
-        blockNumber: BigNumber;
+  getFunction(
+    nameOrSignature: "aggregate"
+  ): TypedContractMethod<
+    [calls: Multicall3.CallStruct[]],
+    [[bigint, string[]] & { blockNumber: bigint; returnData: string[] }],
+    "payable"
+  >;
+  getFunction(
+    nameOrSignature: "aggregate3"
+  ): TypedContractMethod<
+    [calls: Multicall3.Call3Struct[]],
+    [Multicall3.ResultStructOutput[]],
+    "payable"
+  >;
+  getFunction(
+    nameOrSignature: "aggregate3Value"
+  ): TypedContractMethod<
+    [calls: Multicall3.Call3ValueStruct[]],
+    [Multicall3.ResultStructOutput[]],
+    "payable"
+  >;
+  getFunction(
+    nameOrSignature: "blockAndAggregate"
+  ): TypedContractMethod<
+    [calls: Multicall3.CallStruct[]],
+    [
+      [bigint, string, Multicall3.ResultStructOutput[]] & {
+        blockNumber: bigint;
         blockHash: string;
         returnData: Multicall3.ResultStructOutput[];
       }
-    >;
-  };
+    ],
+    "payable"
+  >;
+  getFunction(
+    nameOrSignature: "getBasefee"
+  ): TypedContractMethod<[], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getBlockHash"
+  ): TypedContractMethod<[blockNumber: BigNumberish], [string], "view">;
+  getFunction(
+    nameOrSignature: "getBlockNumber"
+  ): TypedContractMethod<[], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getChainId"
+  ): TypedContractMethod<[], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getCurrentBlockCoinbase"
+  ): TypedContractMethod<[], [string], "view">;
+  getFunction(
+    nameOrSignature: "getCurrentBlockDifficulty"
+  ): TypedContractMethod<[], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getCurrentBlockGasLimit"
+  ): TypedContractMethod<[], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getCurrentBlockTimestamp"
+  ): TypedContractMethod<[], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getEthBalance"
+  ): TypedContractMethod<[addr: AddressLike], [bigint], "view">;
+  getFunction(
+    nameOrSignature: "getLastBlockHash"
+  ): TypedContractMethod<[], [string], "view">;
+  getFunction(
+    nameOrSignature: "tryAggregate"
+  ): TypedContractMethod<
+    [requireSuccess: boolean, calls: Multicall3.CallStruct[]],
+    [Multicall3.ResultStructOutput[]],
+    "payable"
+  >;
+  getFunction(
+    nameOrSignature: "tryBlockAndAggregate"
+  ): TypedContractMethod<
+    [requireSuccess: boolean, calls: Multicall3.CallStruct[]],
+    [
+      [bigint, string, Multicall3.ResultStructOutput[]] & {
+        blockNumber: bigint;
+        blockHash: string;
+        returnData: Multicall3.ResultStructOutput[];
+      }
+    ],
+    "payable"
+  >;
 
   filters: {};
-
-  estimateGas: {
-    aggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    aggregate3(
-      calls: Multicall3.Call3Struct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    aggregate3Value(
-      calls: Multicall3.Call3ValueStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    blockAndAggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    getBasefee(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getBlockHash(
-      blockNumber: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getBlockNumber(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getChainId(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockCoinbase(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockDifficulty(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockGasLimit(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getCurrentBlockTimestamp(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getEthBalance(addr: string, overrides?: CallOverrides): Promise<BigNumber>;
-
-    getLastBlockHash(overrides?: CallOverrides): Promise<BigNumber>;
-
-    tryAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    tryBlockAndAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<BigNumber>;
-  };
-
-  populateTransaction: {
-    aggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    aggregate3(
-      calls: Multicall3.Call3Struct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    aggregate3Value(
-      calls: Multicall3.Call3ValueStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    blockAndAggregate(
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    getBasefee(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    getBlockHash(
-      blockNumber: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getBlockNumber(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    getChainId(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    getCurrentBlockCoinbase(
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getCurrentBlockDifficulty(
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getCurrentBlockGasLimit(
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getCurrentBlockTimestamp(
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getEthBalance(
-      addr: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getLastBlockHash(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    tryAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    tryBlockAndAggregate(
-      requireSuccess: boolean,
-      calls: Multicall3.CallStruct[],
-      overrides?: PayableOverrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-  };
 }