@d8x/perpetuals-sdk 0.7.0 → 0.7.2

package/src/contracts/LimitOrderBookFactory.ts

@@ -30,10 +30,12 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
   functions: {
     "CANCEL_DELAY_SEC()": FunctionFragment;
     "POSTING_FEE_TBPS()": FunctionFragment;
+    "addExecutor(uint24,address)": FunctionFragment;
     "deployLimitOrderBookProxy(address,uint24)": FunctionFragment;
     "getOrderBookAddress(uint24)": FunctionFragment;
     "orderBooks(uint24)": FunctionFragment;
     "owner()": FunctionFragment;
+    "removeExecutor(uint24,address)": FunctionFragment;
     "renounceOwnership()": FunctionFragment;
     "transferOwnership(address)": FunctionFragment;
   };
@@ -42,10 +44,12 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
     nameOrSignatureOrTopic:
       | "CANCEL_DELAY_SEC"
       | "POSTING_FEE_TBPS"
+      | "addExecutor"
       | "deployLimitOrderBookProxy"
       | "getOrderBookAddress"
       | "orderBooks"
       | "owner"
+      | "removeExecutor"
       | "renounceOwnership"
       | "transferOwnership"
   ): FunctionFragment;
@@ -58,6 +62,10 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
     functionFragment: "POSTING_FEE_TBPS",
     values?: undefined
   ): string;
+  encodeFunctionData(
+    functionFragment: "addExecutor",
+    values: [BigNumberish, string]
+  ): string;
   encodeFunctionData(
     functionFragment: "deployLimitOrderBookProxy",
     values: [string, BigNumberish]
@@ -71,6 +79,10 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
     values: [BigNumberish]
   ): string;
   encodeFunctionData(functionFragment: "owner", values?: undefined): string;
+  encodeFunctionData(
+    functionFragment: "removeExecutor",
+    values: [BigNumberish, string]
+  ): string;
   encodeFunctionData(
     functionFragment: "renounceOwnership",
     values?: undefined
@@ -88,6 +100,10 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
     functionFragment: "POSTING_FEE_TBPS",
     data: BytesLike
   ): Result;
+  decodeFunctionResult(
+    functionFragment: "addExecutor",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
     functionFragment: "deployLimitOrderBookProxy",
     data: BytesLike
@@ -98,6 +114,10 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
   ): Result;
   decodeFunctionResult(functionFragment: "orderBooks", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
+  decodeFunctionResult(
+    functionFragment: "removeExecutor",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
     functionFragment: "renounceOwnership",
     data: BytesLike
@@ -108,15 +128,30 @@ export interface LimitOrderBookFactoryInterface extends utils.Interface {
   ): Result;
 
   events: {
+    "AddExecutor(uint24,address)": EventFragment;
     "OwnershipTransferred(address,address)": EventFragment;
     "PerpetualLimitOrderBookDeployed(uint24,address,address)": EventFragment;
+    "RemoveExecutor(uint24,address)": EventFragment;
   };
 
+  getEvent(nameOrSignatureOrTopic: "AddExecutor"): EventFragment;
   getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
   getEvent(
     nameOrSignatureOrTopic: "PerpetualLimitOrderBookDeployed"
   ): EventFragment;
+  getEvent(nameOrSignatureOrTopic: "RemoveExecutor"): EventFragment;
+}
+
+export interface AddExecutorEventObject {
+  perpetualId: number;
+  executor: string;
 }
+export type AddExecutorEvent = TypedEvent<
+  [number, string],
+  AddExecutorEventObject
+>;
+
+export type AddExecutorEventFilter = TypedEventFilter<AddExecutorEvent>;
 
 export interface OwnershipTransferredEventObject {
   previousOwner: string;
@@ -143,6 +178,17 @@ export type PerpetualLimitOrderBookDeployedEvent = TypedEvent<
 export type PerpetualLimitOrderBookDeployedEventFilter =
   TypedEventFilter<PerpetualLimitOrderBookDeployedEvent>;
 
+export interface RemoveExecutorEventObject {
+  perpetualId: number;
+  executor: string;
+}
+export type RemoveExecutorEvent = TypedEvent<
+  [number, string],
+  RemoveExecutorEventObject
+>;
+
+export type RemoveExecutorEventFilter = TypedEventFilter<RemoveExecutorEvent>;
+
 export interface LimitOrderBookFactory extends BaseContract {
   connect(signerOrProvider: Signer | Provider | string): this;
   attach(addressOrName: string): this;
@@ -174,6 +220,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     POSTING_FEE_TBPS(overrides?: CallOverrides): Promise<[number]>;
 
+    addExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<ContractTransaction>;
+
     deployLimitOrderBookProxy(
       _perpetualManagerAddr: string,
       _perpetualId: BigNumberish,
@@ -181,7 +233,7 @@ export interface LimitOrderBookFactory extends BaseContract {
     ): Promise<ContractTransaction>;
 
     getOrderBookAddress(
-      _perpetualId: BigNumberish,
+      _iPerpetualId: BigNumberish,
       overrides?: CallOverrides
     ): Promise<[string]>;
 
@@ -192,6 +244,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     owner(overrides?: CallOverrides): Promise<[string]>;
 
+    removeExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<ContractTransaction>;
+
     renounceOwnership(
       overrides?: Overrides & { from?: string }
     ): Promise<ContractTransaction>;
@@ -206,6 +264,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
   POSTING_FEE_TBPS(overrides?: CallOverrides): Promise<number>;
 
+  addExecutor(
+    _iPerpetualId: BigNumberish,
+    _executor: string,
+    overrides?: Overrides & { from?: string }
+  ): Promise<ContractTransaction>;
+
   deployLimitOrderBookProxy(
     _perpetualManagerAddr: string,
     _perpetualId: BigNumberish,
@@ -213,7 +277,7 @@ export interface LimitOrderBookFactory extends BaseContract {
   ): Promise<ContractTransaction>;
 
   getOrderBookAddress(
-    _perpetualId: BigNumberish,
+    _iPerpetualId: BigNumberish,
     overrides?: CallOverrides
   ): Promise<string>;
 
@@ -221,6 +285,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
   owner(overrides?: CallOverrides): Promise<string>;
 
+  removeExecutor(
+    _iPerpetualId: BigNumberish,
+    _executor: string,
+    overrides?: Overrides & { from?: string }
+  ): Promise<ContractTransaction>;
+
   renounceOwnership(
     overrides?: Overrides & { from?: string }
   ): Promise<ContractTransaction>;
@@ -235,6 +305,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     POSTING_FEE_TBPS(overrides?: CallOverrides): Promise<number>;
 
+    addExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: CallOverrides
+    ): Promise<void>;
+
     deployLimitOrderBookProxy(
       _perpetualManagerAddr: string,
       _perpetualId: BigNumberish,
@@ -242,7 +318,7 @@ export interface LimitOrderBookFactory extends BaseContract {
     ): Promise<void>;
 
     getOrderBookAddress(
-      _perpetualId: BigNumberish,
+      _iPerpetualId: BigNumberish,
       overrides?: CallOverrides
     ): Promise<string>;
 
@@ -250,6 +326,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     owner(overrides?: CallOverrides): Promise<string>;
 
+    removeExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: CallOverrides
+    ): Promise<void>;
+
     renounceOwnership(overrides?: CallOverrides): Promise<void>;
 
     transferOwnership(
@@ -259,6 +341,15 @@ export interface LimitOrderBookFactory extends BaseContract {
   };
 
   filters: {
+    "AddExecutor(uint24,address)"(
+      perpetualId?: BigNumberish | null,
+      executor?: null
+    ): AddExecutorEventFilter;
+    AddExecutor(
+      perpetualId?: BigNumberish | null,
+      executor?: null
+    ): AddExecutorEventFilter;
+
     "OwnershipTransferred(address,address)"(
       previousOwner?: string | null,
       newOwner?: string | null
@@ -278,6 +369,15 @@ export interface LimitOrderBookFactory extends BaseContract {
       perpManagerAddress?: null,
       limitOrderBookAddress?: null
     ): PerpetualLimitOrderBookDeployedEventFilter;
+
+    "RemoveExecutor(uint24,address)"(
+      perpetualId?: BigNumberish | null,
+      executor?: null
+    ): RemoveExecutorEventFilter;
+    RemoveExecutor(
+      perpetualId?: BigNumberish | null,
+      executor?: null
+    ): RemoveExecutorEventFilter;
   };
 
   estimateGas: {
@@ -285,6 +385,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     POSTING_FEE_TBPS(overrides?: CallOverrides): Promise<BigNumber>;
 
+    addExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<BigNumber>;
+
     deployLimitOrderBookProxy(
       _perpetualManagerAddr: string,
       _perpetualId: BigNumberish,
@@ -292,7 +398,7 @@ export interface LimitOrderBookFactory extends BaseContract {
     ): Promise<BigNumber>;
 
     getOrderBookAddress(
-      _perpetualId: BigNumberish,
+      _iPerpetualId: BigNumberish,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
@@ -303,6 +409,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     owner(overrides?: CallOverrides): Promise<BigNumber>;
 
+    removeExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<BigNumber>;
+
     renounceOwnership(
       overrides?: Overrides & { from?: string }
     ): Promise<BigNumber>;
@@ -318,6 +430,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     POSTING_FEE_TBPS(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
+    addExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<PopulatedTransaction>;
+
     deployLimitOrderBookProxy(
       _perpetualManagerAddr: string,
       _perpetualId: BigNumberish,
@@ -325,7 +443,7 @@ export interface LimitOrderBookFactory extends BaseContract {
     ): Promise<PopulatedTransaction>;
 
     getOrderBookAddress(
-      _perpetualId: BigNumberish,
+      _iPerpetualId: BigNumberish,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
@@ -336,6 +454,12 @@ export interface LimitOrderBookFactory extends BaseContract {
 
     owner(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
+    removeExecutor(
+      _iPerpetualId: BigNumberish,
+      _executor: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<PopulatedTransaction>;
+
     renounceOwnership(
       overrides?: Overrides & { from?: string }
     ): Promise<PopulatedTransaction>;

package/src/contracts/factories/IPerpetualManager__factory.ts

@@ -5406,6 +5406,11 @@ const _abi = [
         name: "_order",
         type: "tuple",
       },
+      {
+        internalType: "bool",
+        name: "_isApprovedExecutor",
+        type: "bool",
+      },
     ],
     name: "tradeViaOrderBook",
     outputs: [

package/src/contracts/factories/LimitOrderBookFactory__factory.ts

@@ -10,6 +10,25 @@ import type {
 } from "../LimitOrderBookFactory";
 
 const _abi = [
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "uint24",
+        name: "perpetualId",
+        type: "uint24",
+      },
+      {
+        indexed: false,
+        internalType: "address",
+        name: "executor",
+        type: "address",
+      },
+    ],
+    name: "AddExecutor",
+    type: "event",
+  },
   {
     anonymous: false,
     inputs: [
@@ -54,6 +73,25 @@ const _abi = [
     name: "PerpetualLimitOrderBookDeployed",
     type: "event",
   },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "uint24",
+        name: "perpetualId",
+        type: "uint24",
+      },
+      {
+        indexed: false,
+        internalType: "address",
+        name: "executor",
+        type: "address",
+      },
+    ],
+    name: "RemoveExecutor",
+    type: "event",
+  },
   {
     inputs: [],
     name: "CANCEL_DELAY_SEC",
@@ -80,6 +118,24 @@ const _abi = [
     stateMutability: "view",
     type: "function",
   },
+  {
+    inputs: [
+      {
+        internalType: "uint24",
+        name: "_iPerpetualId",
+        type: "uint24",
+      },
+      {
+        internalType: "address",
+        name: "_executor",
+        type: "address",
+      },
+    ],
+    name: "addExecutor",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
   {
     inputs: [
       {
@@ -102,7 +158,7 @@ const _abi = [
     inputs: [
       {
         internalType: "uint24",
-        name: "_perpetualId",
+        name: "_iPerpetualId",
         type: "uint24",
       },
     ],
@@ -149,6 +205,24 @@ const _abi = [
     stateMutability: "view",
     type: "function",
   },
+  {
+    inputs: [
+      {
+        internalType: "uint24",
+        name: "_iPerpetualId",
+        type: "uint24",
+      },
+      {
+        internalType: "address",
+        name: "_executor",
+        type: "address",
+      },
+    ],
+    name: "removeExecutor",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
   {
     inputs: [],
     name: "renounceOwnership",

package/src/contracts/factories/LimitOrderBook__factory.ts

@@ -176,6 +176,19 @@ const _abi = [
     name: "PerpetualLimitOrderCreated",
     type: "event",
   },
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "_executor",
+        type: "address",
+      },
+    ],
+    name: "addExecutor",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
   {
     inputs: [
       {
@@ -219,6 +232,25 @@ const _abi = [
     stateMutability: "view",
     type: "function",
   },
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "",
+        type: "address",
+      },
+    ],
+    name: "approvedExecutor",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
   {
     inputs: [
       {
@@ -1070,6 +1102,19 @@ const _abi = [
     stateMutability: "view",
     type: "function",
   },
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "_executor",
+        type: "address",
+      },
+    ],
+    name: "removeExecutor",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
 ] as const;
 
 export class LimitOrderBook__factory {

package/src/liquidatorTool.ts

@@ -29,11 +29,10 @@ export default class LiquidatorTool extends WriteAccessHandler {
    * }
    * main();
    *
-   * @param {string} privateKey Private key of account that liquidates.
-   * @param {Signer} signer Signer that liquidates (ignored if a private key is provided)
+   * @param {string | Signer} signer Private key or ethers Signer of the account
    */
-  public constructor(config: NodeSDKConfig, privateKey?: string, signer?: Signer) {
-    super(config, privateKey, signer);
+  public constructor(config: NodeSDKConfig, signer: string | Signer) {
+    super(config, signer);
   }
 
   /**

package/src/liquidityProviderTool.ts

@@ -28,11 +28,10 @@ export default class LiquidityProviderTool extends WriteAccessHandler {
    * }
    * main();
    *
-   * @param {string} privateKey private key of account that trades
-   * @param {Signer} signer Signer that provides liquidity (ignored if a private key is provided)
+   * @param {string | Signer} signer Private key or ethers Signer of the account
    */
-  public constructor(config: NodeSDKConfig, privateKey?: string, signer?: Signer) {
-    super(config, privateKey, signer);
+  public constructor(config: NodeSDKConfig, signer: string | Signer) {
+    super(config, signer);
   }
 
   /**

package/src/marketData.ts

@@ -1198,7 +1198,6 @@ export default class MarketData extends PerpetualDataHandler {
           poolShareTokenAddr: pools[k].shareTokenAddress,
           defaultFundCashCC: ABK64x64ToFloat(pools[k].fDefaultFundCashCC),
           pnlParticipantCashCC: ABK64x64ToFloat(pools[k].fPnLparticipantsCashCC),
-          totalAMMFundCashCC: ABK64x64ToFloat(pools[k].fAMMFundCashCC),
           totalTargetAMMFundSizeCC: ABK64x64ToFloat(pools[k].fTargetAMMFundSize),
           brokerCollateralLotSize: ABK64x64ToFloat(pools[k].fBrokerCollateralLotSize),
           perpetuals: [],

package/src/nodeSDKTypes.ts

@@ -137,7 +137,6 @@ export interface ExchangeInfo {
  * This is the token issued to external liquidity providers.
  * @property {number} defaultFundCashCC Amount of cash in the default fund of this pool, denominated in margin tokens.
  * @property {number} pnlParticipantCashCC Amount of cash in the PnL participation pool, i.e. cash deposited by external liquidity providers.
- * @property {number} totalAMMFundCashCC Amount of cash aggregated across all perpetual AMM funds in this pool.
  * @property {number} totalTargetAMMFundSizeCC Target AMM funds aggregated across all perpetuals in this pool.
  * @property {number} brokerCollateralLotSize Price of one lot for brokers who wish to participate in this pool. Denominated in margin tokens.
  * @property {PerpetualState[]} perpetuals Array of all perpetuals in this pool.
@@ -149,7 +148,6 @@ export interface PoolState {
   poolShareTokenAddr: string;
   defaultFundCashCC: number;
   pnlParticipantCashCC: number;
-  totalAMMFundCashCC: number;
   totalTargetAMMFundSizeCC: number;
   brokerCollateralLotSize: number;
   perpetuals: PerpetualState[];

package/src/orderReferrerTool.ts

@@ -43,11 +43,10 @@ export default class OrderReferrerTool extends WriteAccessHandler {
    * }
    * main();
    *
-   * @param {string} privateKey Private key of the wallet that executes the conditional orders.
-   * @param {Signer} signer Signer that executes orders (ignored if a private key is provided)
+   * @param {string | Signer} signer Private key or ethers Signer of the account
    */
-  public constructor(config: NodeSDKConfig, privateKey?: string, signer?: Signer) {
-    super(config, privateKey, signer);
+  public constructor(config: NodeSDKConfig, signer: string | Signer) {
+    super(config, signer);
     // override parent's gas limit with a lower number
     this.gasLimit = 4_000_000;
   }

package/src/version.ts

@@ -1 +1 @@
-export const D8X_SDK_VERSION = "0.7.0";
+export const D8X_SDK_VERSION = "0.7.2";

package/src/writeAccessHandler.ts

@@ -23,17 +23,14 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
   protected gasLimit: number = 15_000_000;
   /**
    * Constructor
-   * @param {NodeSDKConfig} config configuration
-   * @param {string} privateKey private key of account that trades
+   * @param {string | Signer} signer Private key or ethers Signer of the account
    */
-  public constructor(config: NodeSDKConfig, privateKey?: string, signer?: Signer) {
+  public constructor(config: NodeSDKConfig, signer: string | Signer) {
     super(config);
-    if (privateKey) {
-      this.privateKey = privateKey;
-    } else if (signer) {
-      this.signer = signer;
+    if (typeof signer == "string") {
+      this.privateKey = signer;
     } else {
-      throw new Error("No private key nor signer provided.");
+      this.signer = signer;
     }
     if (config.gasLimit != undefined) {
       this.gasLimit = config.gasLimit;