@d8x/perpetuals-sdk 1.3.7 → 2.0.1-alpha

package/src/contracts/LimitOrderBookFactory.ts

@@ -3,45 +3,29 @@
 /* eslint-disable */
 import type {
   BaseContract,
-  BigNumber,
   BigNumberish,
   BytesLike,
-  CallOverrides,
-  ContractTransaction,
-  Overrides,
-  PopulatedTransaction,
-  Signer,
-  utils,
-} from "ethers";
-import type {
   FunctionFragment,
   Result,
+  Interface,
   EventFragment,
-} from "@ethersproject/abi";
-import type { Listener, Provider } from "@ethersproject/providers";
+  AddressLike,
+  ContractRunner,
+  ContractMethod,
+  Listener,
+} from "ethers";
 import type {
-  TypedEventFilter,
-  TypedEvent,
+  TypedContractEvent,
+  TypedDeferredTopicFilter,
+  TypedEventLog,
+  TypedLogDescription,
   TypedListener,
-  OnEvent,
+  TypedContractMethod,
 } from "./common";
 
-export interface LimitOrderBookFactoryInterface extends utils.Interface {
-  functions: {
-    "addExecutor(address)": FunctionFragment;
-    "approvedExecutor(address)": FunctionFragment;
-    "deployLimitOrderBookProxy(address,uint24)": FunctionFragment;
-    "getBeacon()": FunctionFragment;
-    "getImplementation()": FunctionFragment;
-    "orderBooks(uint24)": FunctionFragment;
-    "owner()": FunctionFragment;
-    "removeExecutor(address)": FunctionFragment;
-    "renounceOwnership()": FunctionFragment;
-    "transferOwnership(address)": FunctionFragment;
-  };
-
+export interface LimitOrderBookFactoryInterface extends Interface {
   getFunction(
-    nameOrSignatureOrTopic:
+    nameOrSignature:
       | "addExecutor"
       | "approvedExecutor"
       | "deployLimitOrderBookProxy"
@@ -54,14 +38,25 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
       | "transferOwnership"
   ): FunctionFragment;
 
-  encodeFunctionData(functionFragment: "addExecutor", values: [string]): string;
+  getEvent(
+    nameOrSignatureOrTopic:
+      | "OwnershipTransferred"
+      | "PerpetualLimitOrderBookDeployed"
+      | "SetCallbackGasLimit"
+      | "SetExecutor"
+  ): EventFragment;
+
+  encodeFunctionData(
+    functionFragment: "addExecutor",
+    values: [AddressLike]
+  ): string;
   encodeFunctionData(
     functionFragment: "approvedExecutor",
-    values: [string]
+    values: [AddressLike]
   ): string;
   encodeFunctionData(
     functionFragment: "deployLimitOrderBookProxy",
-    values: [string, BigNumberish]
+    values: [AddressLike, BigNumberish]
   ): string;
   encodeFunctionData(functionFragment: "getBeacon", values?: undefined): string;
   encodeFunctionData(
@@ -75,7 +70,7 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
   encodeFunctionData(functionFragment: "owner", values?: undefined): string;
   encodeFunctionData(
     functionFragment: "removeExecutor",
-    values: [string]
+    values: [AddressLike]
   ): string;
   encodeFunctionData(
     functionFragment: "renounceOwnership",
@@ -83,7 +78,7 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
   ): string;
   encodeFunctionData(
     functionFragment: "transferOwnership",
-    values: [string]
+    values: [AddressLike]
   ): string;
 
   decodeFunctionResult(
@@ -117,323 +112,259 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
     functionFragment: "transferOwnership",
     data: BytesLike
   ): Result;
-
-  events: {
-    "OwnershipTransferred(address,address)": EventFragment;
-    "PerpetualLimitOrderBookDeployed(uint24,address,address)": EventFragment;
-    "SetCallbackGasLimit(uint24,uint32)": EventFragment;
-    "SetExecutor(address,bool)": EventFragment;
-  };
-
-  getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
-  getEvent(
-    nameOrSignatureOrTopic: "PerpetualLimitOrderBookDeployed"
-  ): EventFragment;
-  getEvent(nameOrSignatureOrTopic: "SetCallbackGasLimit"): EventFragment;
-  getEvent(nameOrSignatureOrTopic: "SetExecutor"): EventFragment;
 }
 
-export interface OwnershipTransferredEventObject {
-  previousOwner: string;
-  newOwner: string;
+export namespace OwnershipTransferredEvent {
+  export type InputTuple = [previousOwner: AddressLike, newOwner: AddressLike];
+  export type OutputTuple = [previousOwner: string, newOwner: string];
+  export interface OutputObject {
+    previousOwner: string;
+    newOwner: string;
+  }
+  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
+  export type Filter = TypedDeferredTopicFilter<Event>;
+  export type Log = TypedEventLog<Event>;
+  export type LogDescription = TypedLogDescription<Event>;
 }
-export type OwnershipTransferredEvent = TypedEvent<
-  [string, string],
-  OwnershipTransferredEventObject
->;
 
-export type OwnershipTransferredEventFilter =
-  TypedEventFilter<OwnershipTransferredEvent>;
-
-export interface PerpetualLimitOrderBookDeployedEventObject {
-  perpetualId: number;
-  perpManagerAddress: string;
-  limitOrderBookAddress: string;
+export namespace PerpetualLimitOrderBookDeployedEvent {
+  export type InputTuple = [
+    perpetualId: BigNumberish,
+    perpManagerAddress: AddressLike,
+    limitOrderBookAddress: AddressLike
+  ];
+  export type OutputTuple = [
+    perpetualId: bigint,
+    perpManagerAddress: string,
+    limitOrderBookAddress: string
+  ];
+  export interface OutputObject {
+    perpetualId: bigint;
+    perpManagerAddress: string;
+    limitOrderBookAddress: string;
+  }
+  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
+  export type Filter = TypedDeferredTopicFilter<Event>;
+  export type Log = TypedEventLog<Event>;
+  export type LogDescription = TypedLogDescription<Event>;
 }
-export type PerpetualLimitOrderBookDeployedEvent = TypedEvent<
-  [number, string, string],
-  PerpetualLimitOrderBookDeployedEventObject
->;
-
-export type PerpetualLimitOrderBookDeployedEventFilter =
-  TypedEventFilter<PerpetualLimitOrderBookDeployedEvent>;
 
-export interface SetCallbackGasLimitEventObject {
-  perpetualId: number;
-  gasLimit: number;
+export namespace SetCallbackGasLimitEvent {
+  export type InputTuple = [perpetualId: BigNumberish, gasLimit: BigNumberish];
+  export type OutputTuple = [perpetualId: bigint, gasLimit: bigint];
+  export interface OutputObject {
+    perpetualId: bigint;
+    gasLimit: bigint;
+  }
+  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
+  export type Filter = TypedDeferredTopicFilter<Event>;
+  export type Log = TypedEventLog<Event>;
+  export type LogDescription = TypedLogDescription<Event>;
 }
-export type SetCallbackGasLimitEvent = TypedEvent<
-  [number, number],
-  SetCallbackGasLimitEventObject
->;
-
-export type SetCallbackGasLimitEventFilter =
-  TypedEventFilter<SetCallbackGasLimitEvent>;
 
-export interface SetExecutorEventObject {
-  executor: string;
-  authorized: boolean;
+export namespace SetExecutorEvent {
+  export type InputTuple = [executor: AddressLike, authorized: boolean];
+  export type OutputTuple = [executor: string, authorized: boolean];
+  export interface OutputObject {
+    executor: string;
+    authorized: boolean;
+  }
+  export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
+  export type Filter = TypedDeferredTopicFilter<Event>;
+  export type Log = TypedEventLog<Event>;
+  export type LogDescription = TypedLogDescription<Event>;
 }
-export type SetExecutorEvent = TypedEvent<
-  [string, boolean],
-  SetExecutorEventObject
->;
-
-export type SetExecutorEventFilter = TypedEventFilter<SetExecutorEvent>;
 
 export interface LimitOrderBookFactory extends BaseContract {
-  connect(signerOrProvider: Signer | Provider | string): this;
-  attach(addressOrName: string): this;
-  deployed(): Promise<this>;
+  connect(runner?: ContractRunner | null): LimitOrderBookFactory;
+  waitForDeployment(): Promise<this>;
 
   interface: LimitOrderBookFactoryInterface;
 
-  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: {
-    addExecutor(
-      _executor: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    approvedExecutor(
-      arg0: string,
-      overrides?: CallOverrides
-    ): Promise<[boolean]>;
-
-    deployLimitOrderBookProxy(
-      _perpetualManagerAddr: string,
-      _perpetualId: BigNumberish,
-      overrides?: Overrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    getBeacon(overrides?: CallOverrides): Promise<[string]>;
-
-    getImplementation(overrides?: CallOverrides): Promise<[string]>;
-
-    orderBooks(
-      arg0: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<[string]>;
-
-    owner(overrides?: CallOverrides): Promise<[string]>;
-
-    removeExecutor(
-      _executor: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    renounceOwnership(
-      overrides?: Overrides & { from?: string }
-    ): Promise<ContractTransaction>;
-
-    transferOwnership(
-      newOwner: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<ContractTransaction>;
-  };
-
-  addExecutor(
-    _executor: string,
-    overrides?: Overrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  approvedExecutor(arg0: string, overrides?: CallOverrides): Promise<boolean>;
-
-  deployLimitOrderBookProxy(
-    _perpetualManagerAddr: string,
-    _perpetualId: BigNumberish,
-    overrides?: Overrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  getBeacon(overrides?: CallOverrides): Promise<string>;
-
-  getImplementation(overrides?: CallOverrides): Promise<string>;
-
-  orderBooks(arg0: BigNumberish, overrides?: CallOverrides): Promise<string>;
-
-  owner(overrides?: CallOverrides): Promise<string>;
-
-  removeExecutor(
-    _executor: string,
-    overrides?: Overrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  renounceOwnership(
-    overrides?: Overrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  transferOwnership(
-    newOwner: string,
-    overrides?: Overrides & { from?: string }
-  ): Promise<ContractTransaction>;
-
-  callStatic: {
-    addExecutor(_executor: string, overrides?: CallOverrides): Promise<void>;
-
-    approvedExecutor(arg0: string, overrides?: CallOverrides): Promise<boolean>;
-
-    deployLimitOrderBookProxy(
-      _perpetualManagerAddr: string,
-      _perpetualId: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<void>;
-
-    getBeacon(overrides?: CallOverrides): Promise<string>;
-
-    getImplementation(overrides?: CallOverrides): Promise<string>;
-
-    orderBooks(arg0: BigNumberish, overrides?: CallOverrides): Promise<string>;
-
-    owner(overrides?: CallOverrides): Promise<string>;
-
-    removeExecutor(_executor: string, overrides?: CallOverrides): Promise<void>;
+  ): 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>;
+
+  addExecutor: TypedContractMethod<
+    [_executor: AddressLike],
+    [void],
+    "nonpayable"
+  >;
+
+  approvedExecutor: TypedContractMethod<[arg0: AddressLike], [boolean], "view">;
+
+  deployLimitOrderBookProxy: TypedContractMethod<
+    [_perpetualManagerAddr: AddressLike, _perpetualId: BigNumberish],
+    [void],
+    "nonpayable"
+  >;
+
+  getBeacon: TypedContractMethod<[], [string], "view">;
+
+  getImplementation: TypedContractMethod<[], [string], "view">;
+
+  orderBooks: TypedContractMethod<[arg0: BigNumberish], [string], "view">;
+
+  owner: TypedContractMethod<[], [string], "view">;
+
+  removeExecutor: TypedContractMethod<
+    [_executor: AddressLike],
+    [void],
+    "nonpayable"
+  >;
+
+  renounceOwnership: TypedContractMethod<[], [void], "nonpayable">;
+
+  transferOwnership: TypedContractMethod<
+    [newOwner: AddressLike],
+    [void],
+    "nonpayable"
+  >;
+
+  getFunction<T extends ContractMethod = ContractMethod>(
+    key: string | FunctionFragment
+  ): T;
 
-    renounceOwnership(overrides?: CallOverrides): Promise<void>;
+  getFunction(
+    nameOrSignature: "addExecutor"
+  ): TypedContractMethod<[_executor: AddressLike], [void], "nonpayable">;
+  getFunction(
+    nameOrSignature: "approvedExecutor"
+  ): TypedContractMethod<[arg0: AddressLike], [boolean], "view">;
+  getFunction(
+    nameOrSignature: "deployLimitOrderBookProxy"
+  ): TypedContractMethod<
+    [_perpetualManagerAddr: AddressLike, _perpetualId: BigNumberish],
+    [void],
+    "nonpayable"
+  >;
+  getFunction(
+    nameOrSignature: "getBeacon"
+  ): TypedContractMethod<[], [string], "view">;
+  getFunction(
+    nameOrSignature: "getImplementation"
+  ): TypedContractMethod<[], [string], "view">;
+  getFunction(
+    nameOrSignature: "orderBooks"
+  ): TypedContractMethod<[arg0: BigNumberish], [string], "view">;
+  getFunction(
+    nameOrSignature: "owner"
+  ): TypedContractMethod<[], [string], "view">;
+  getFunction(
+    nameOrSignature: "removeExecutor"
+  ): TypedContractMethod<[_executor: AddressLike], [void], "nonpayable">;
+  getFunction(
+    nameOrSignature: "renounceOwnership"
+  ): TypedContractMethod<[], [void], "nonpayable">;
+  getFunction(
+    nameOrSignature: "transferOwnership"
+  ): TypedContractMethod<[newOwner: AddressLike], [void], "nonpayable">;
 
-    transferOwnership(
-      newOwner: string,
-      overrides?: CallOverrides
-    ): Promise<void>;
-  };
+  getEvent(
+    key: "OwnershipTransferred"
+  ): TypedContractEvent<
+    OwnershipTransferredEvent.InputTuple,
+    OwnershipTransferredEvent.OutputTuple,
+    OwnershipTransferredEvent.OutputObject
+  >;
+  getEvent(
+    key: "PerpetualLimitOrderBookDeployed"
+  ): TypedContractEvent<
+    PerpetualLimitOrderBookDeployedEvent.InputTuple,
+    PerpetualLimitOrderBookDeployedEvent.OutputTuple,
+    PerpetualLimitOrderBookDeployedEvent.OutputObject
+  >;
+  getEvent(
+    key: "SetCallbackGasLimit"
+  ): TypedContractEvent<
+    SetCallbackGasLimitEvent.InputTuple,
+    SetCallbackGasLimitEvent.OutputTuple,
+    SetCallbackGasLimitEvent.OutputObject
+  >;
+  getEvent(
+    key: "SetExecutor"
+  ): TypedContractEvent<
+    SetExecutorEvent.InputTuple,
+    SetExecutorEvent.OutputTuple,
+    SetExecutorEvent.OutputObject
+  >;
 
   filters: {
-    "OwnershipTransferred(address,address)"(
-      previousOwner?: string | null,
-      newOwner?: string | null
-    ): OwnershipTransferredEventFilter;
-    OwnershipTransferred(
-      previousOwner?: string | null,
-      newOwner?: string | null
-    ): OwnershipTransferredEventFilter;
-
-    "PerpetualLimitOrderBookDeployed(uint24,address,address)"(
-      perpetualId?: BigNumberish | null,
-      perpManagerAddress?: null,
-      limitOrderBookAddress?: null
-    ): PerpetualLimitOrderBookDeployedEventFilter;
-    PerpetualLimitOrderBookDeployed(
-      perpetualId?: BigNumberish | null,
-      perpManagerAddress?: null,
-      limitOrderBookAddress?: null
-    ): PerpetualLimitOrderBookDeployedEventFilter;
-
-    "SetCallbackGasLimit(uint24,uint32)"(
-      perpetualId?: BigNumberish | null,
-      gasLimit?: null
-    ): SetCallbackGasLimitEventFilter;
-    SetCallbackGasLimit(
-      perpetualId?: BigNumberish | null,
-      gasLimit?: null
-    ): SetCallbackGasLimitEventFilter;
-
-    "SetExecutor(address,bool)"(
-      executor?: null,
-      authorized?: null
-    ): SetExecutorEventFilter;
-    SetExecutor(executor?: null, authorized?: null): SetExecutorEventFilter;
-  };
-
-  estimateGas: {
-    addExecutor(
-      _executor: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    approvedExecutor(
-      arg0: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    deployLimitOrderBookProxy(
-      _perpetualManagerAddr: string,
-      _perpetualId: BigNumberish,
-      overrides?: Overrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    getBeacon(overrides?: CallOverrides): Promise<BigNumber>;
-
-    getImplementation(overrides?: CallOverrides): Promise<BigNumber>;
-
-    orderBooks(
-      arg0: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    owner(overrides?: CallOverrides): Promise<BigNumber>;
-
-    removeExecutor(
-      _executor: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    renounceOwnership(
-      overrides?: Overrides & { from?: string }
-    ): Promise<BigNumber>;
-
-    transferOwnership(
-      newOwner: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<BigNumber>;
-  };
-
-  populateTransaction: {
-    addExecutor(
-      _executor: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    approvedExecutor(
-      arg0: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    deployLimitOrderBookProxy(
-      _perpetualManagerAddr: string,
-      _perpetualId: BigNumberish,
-      overrides?: Overrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    getBeacon(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    getImplementation(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    orderBooks(
-      arg0: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    owner(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    removeExecutor(
-      _executor: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    renounceOwnership(
-      overrides?: Overrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
-
-    transferOwnership(
-      newOwner: string,
-      overrides?: Overrides & { from?: string }
-    ): Promise<PopulatedTransaction>;
+    "OwnershipTransferred(address,address)": TypedContractEvent<
+      OwnershipTransferredEvent.InputTuple,
+      OwnershipTransferredEvent.OutputTuple,
+      OwnershipTransferredEvent.OutputObject
+    >;
+    OwnershipTransferred: TypedContractEvent<
+      OwnershipTransferredEvent.InputTuple,
+      OwnershipTransferredEvent.OutputTuple,
+      OwnershipTransferredEvent.OutputObject
+    >;
+
+    "PerpetualLimitOrderBookDeployed(uint24,address,address)": TypedContractEvent<
+      PerpetualLimitOrderBookDeployedEvent.InputTuple,
+      PerpetualLimitOrderBookDeployedEvent.OutputTuple,
+      PerpetualLimitOrderBookDeployedEvent.OutputObject
+    >;
+    PerpetualLimitOrderBookDeployed: TypedContractEvent<
+      PerpetualLimitOrderBookDeployedEvent.InputTuple,
+      PerpetualLimitOrderBookDeployedEvent.OutputTuple,
+      PerpetualLimitOrderBookDeployedEvent.OutputObject
+    >;
+
+    "SetCallbackGasLimit(uint24,uint32)": TypedContractEvent<
+      SetCallbackGasLimitEvent.InputTuple,
+      SetCallbackGasLimitEvent.OutputTuple,
+      SetCallbackGasLimitEvent.OutputObject
+    >;
+    SetCallbackGasLimit: TypedContractEvent<
+      SetCallbackGasLimitEvent.InputTuple,
+      SetCallbackGasLimitEvent.OutputTuple,
+      SetCallbackGasLimitEvent.OutputObject
+    >;
+
+    "SetExecutor(address,bool)": TypedContractEvent<
+      SetExecutorEvent.InputTuple,
+      SetExecutorEvent.OutputTuple,
+      SetExecutorEvent.OutputObject
+    >;
+    SetExecutor: TypedContractEvent<
+      SetExecutorEvent.InputTuple,
+      SetExecutorEvent.OutputTuple,
+      SetExecutorEvent.OutputObject
+    >;
   };
 }