@d8x/perpetuals-sdk 1.3.6 → 2.0.0-alpha

package/src/brokerTool.ts

@@ -1,7 +1,3 @@
-import { defaultAbiCoder } from "@ethersproject/abi";
-import { Signer } from "@ethersproject/abstract-signer";
-import { CallOverrides, ContractTransaction, Overrides } from "@ethersproject/contracts";
-import { keccak256 } from "@ethersproject/keccak256";
 import { ABK64x64ToFloat } from "./d8XMath";
 import { NodeSDKConfig, Order, PerpetualStaticInfo, SmartContractOrder } from "./nodeSDKTypes";
 import PerpetualDataHandler from "./perpetualDataHandler";
@@ -9,6 +5,7 @@ import WriteAccessHandler from "./writeAccessHandler";
 
 import { Buffer } from "buffer";
 import AccountTrade from "./accountTrade";
+import { AbiCoder, BigNumberish, ContractTransactionResponse, keccak256, Overrides, Signer } from "ethers";
 /**
  * Functions for white-label partners to determine fees, deposit lots, and sign-up traders.
  * This class requires a private key and executes smart-contract interactions that
@@ -64,7 +61,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} Exchange fee for this white-label partner, in decimals (i.e. 0.1% is 0.001)
    */
-  public async getBrokerInducedFee(poolSymbolName: string, overrides?: CallOverrides): Promise<number | undefined> {
+  public async getBrokerInducedFee(poolSymbolName: string, overrides?: Overrides): Promise<number | undefined> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -103,7 +100,7 @@ export default class BrokerTool extends WriteAccessHandler {
   public async getFeeForBrokerDesignation(
     poolSymbolName: string,
     lots?: number,
-    overrides?: CallOverrides
+    overrides?: Overrides
   ): Promise<number> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
@@ -142,7 +139,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} Fee based solely on a white-label partner's traded volume in the corresponding pool, in decimals (i.e. 0.1% is 0.001).
    */
-  public async getFeeForBrokerVolume(poolSymbolName: string, overrides?: CallOverrides): Promise<number> {
+  public async getFeeForBrokerVolume(poolSymbolName: string, overrides?: Overrides): Promise<number> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -173,7 +170,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} Fee based solely on a white-label partner's D8X balance, in decimals (i.e. 0.1% is 0.001).
    */
-  public async getFeeForBrokerStake(brokerAddr?: string, overrides?: CallOverrides): Promise<number> {
+  public async getFeeForBrokerStake(brokerAddr?: string, overrides?: Overrides): Promise<number> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -219,7 +216,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} Fee in decimals (i.e. 0.1% is 0.001).
    */
-  public async determineExchangeFee(order: Order, traderAddr: string, overrides?: CallOverrides): Promise<number> {
+  public async determineExchangeFee(order: Order, traderAddr: string, overrides?: Overrides): Promise<number> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -251,7 +248,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} Current trading volume for this white-label partner, in USD.
    */
-  public async getCurrentBrokerVolume(poolSymbolName: string, overrides?: CallOverrides): Promise<number> {
+  public async getCurrentBrokerVolume(poolSymbolName: string, overrides?: Overrides): Promise<number> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -283,7 +280,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} White-label partner lot size in a given pool's currency, e.g. in MATIC for poolSymbolName MATIC.
    */
-  public async getLotSize(poolSymbolName: string, overrides?: CallOverrides): Promise<number> {
+  public async getLotSize(poolSymbolName: string, overrides?: Overrides): Promise<number> {
     if (this.proxyContract == null) {
       throw Error("no proxy contract initialized. Use createProxyInstance().");
     }
@@ -314,7 +311,7 @@ export default class BrokerTool extends WriteAccessHandler {
    *
    * @returns {number} Number of lots purchased by this white-label partner.
    */
-  public async getBrokerDesignation(poolSymbolName: string, overrides?: CallOverrides): Promise<number> {
+  public async getBrokerDesignation(poolSymbolName: string, overrides?: Overrides): Promise<number> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -349,7 +346,7 @@ export default class BrokerTool extends WriteAccessHandler {
     poolSymbolName: string,
     lots: number,
     overrides?: Overrides
-  ): Promise<ContractTransaction> {
+  ): Promise<ContractTransactionResponse> {
     if (this.proxyContract == null || this.signer == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }
@@ -490,19 +487,19 @@ export default class BrokerTool extends WriteAccessHandler {
   }
 
   private static async _signOrderFromRawData(
-    iPerpetualId: number,
-    brokerFeeTbps: number,
+    iPerpetualId: BigNumberish,
+    brokerFeeTbps: BigNumberish,
     traderAddr: string,
-    iDeadline: number,
+    iDeadline: BigNumberish,
     signer: Signer,
-    chainId: number,
+    chainId: BigNumberish,
     proxyAddress: string
   ) {
     const NAME = "Perpetual Trade Manager";
     const DOMAIN_TYPEHASH = keccak256(
       Buffer.from("EIP712Domain(string name,uint256 chainId,address verifyingContract)")
     );
-    let abiCoder = defaultAbiCoder;
+    let abiCoder = new AbiCoder();
     let domainSeparator = keccak256(
       abiCoder.encode(
         ["bytes32", "bytes32", "uint256", "address"],
@@ -532,7 +529,7 @@ export default class BrokerTool extends WriteAccessHandler {
     traderAddr: string,
     iDeadline: number,
     signer: Signer,
-    chainId: number,
+    chainId: BigNumberish,
     proxyAddress: string,
     symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>
   ): Promise<string> {
@@ -577,7 +574,7 @@ export default class BrokerTool extends WriteAccessHandler {
     poolSymbolName: string,
     newAddress: string,
     overrides?: Overrides
-  ): Promise<ContractTransaction> {
+  ): Promise<ContractTransactionResponse> {
     if (this.proxyContract == null) {
       throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
     }

package/src/constants.ts

@@ -1,5 +1,4 @@
-import { BigNumber } from "@ethersproject/bignumber";
-import { AddressZero, HashZero } from "@ethersproject/constants";
+import { ZeroAddress, ZeroHash } from "ethers";
 import { NodeSDKConfig } from "./nodeSDKTypes";
 
 export const ERC20_ABI = require("./abi/ERC20.json");
@@ -16,21 +15,21 @@ export const COLLATERAL_CURRENCY_QUOTE = 0;
 export const COLLATERAL_CURRENCY_BASE = 1;
 export const COLLATERAL_CURRENCY_QUANTO = 2;
 export const PERP_STATE_STR = ["INVALID", "INITIALIZING", "NORMAL", "EMERGENCY", "SETTLE", "CLEARED"];
-export const ZERO_ADDRESS = AddressZero;
-export const ZERO_ORDER_ID = HashZero;
+export const ZERO_ADDRESS = ZeroAddress;
+export const ZERO_ORDER_ID = ZeroHash;
 export const MULTICALL_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
-export const ONE_64x64 = BigNumber.from("0x010000000000000000");
-export const MAX_64x64 = BigNumber.from("0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF");
-export const MAX_UINT_256 = BigNumber.from(2).pow(256).sub(BigNumber.from(1));
-export const DECIMALS = BigNumber.from(10).pow(BigNumber.from(18));
+export const ONE_64x64 = BigInt("0x010000000000000000");
+export const MAX_64x64 = BigInt("0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF");
+export const MAX_UINT_256 = 2n ** 256n - 1n; // BigNumber.from(2).pow(256).sub(BigNumber.from(1));
+export const DECIMALS = 10n ** 18n; // BigNumber.from(10).pow(BigNumber.from(18));
 
 export const ORDER_MAX_DURATION_SEC = 60 * 60 * 24 * 30 * 4;
 
-export const MASK_CLOSE_ONLY = BigNumber.from("0x80000000");
-export const MASK_LIMIT_ORDER = BigNumber.from("0x04000000");
-export const MASK_MARKET_ORDER = BigNumber.from("0x40000000");
-export const MASK_STOP_ORDER = BigNumber.from("0x20000000");
-export const MASK_KEEP_POS_LEVERAGE = BigNumber.from("0x08000000");
+export const MASK_CLOSE_ONLY = BigInt("0x80000000");
+export const MASK_LIMIT_ORDER = BigInt("0x04000000");
+export const MASK_MARKET_ORDER = BigInt("0x40000000");
+export const MASK_STOP_ORDER = BigInt("0x20000000");
+export const MASK_KEEP_POS_LEVERAGE = BigInt("0x08000000");
 
 export const ORDER_TYPE_LIMIT = "LIMIT";
 export const ORDER_TYPE_MARKET = "MARKET";