@d8x/perpetuals-sdk 1.3.7 → 2.0.0-alpha

package/src/nodeSDKTypes.ts

@@ -1,6 +1,4 @@
-import { BigNumber, type BigNumberish } from "@ethersproject/bignumber";
-import type { BytesLike } from "@ethersproject/bytes";
-import type { ContractInterface, ContractTransaction } from "@ethersproject/contracts";
+import { BigNumberish, BytesLike, ContractTransaction, ContractTransactionResponse, Interface } from "ethers";
 import { CollaterlCCY } from "./constants";
 
 export interface NodeSDKConfig {
@@ -16,10 +14,10 @@ export interface NodeSDKConfig {
   symbolListLocation: string;
   priceFeedConfigNetwork: string;
   gasLimit?: number | undefined;
-  proxyABI?: ContractInterface | undefined;
-  lobFactoryABI?: ContractInterface | undefined;
-  lobABI?: ContractInterface | undefined;
-  shareTokenABI?: ContractInterface | undefined;
+  proxyABI?: Interface | undefined;
+  lobFactoryABI?: Interface | undefined;
+  lobABI?: Interface | undefined;
+  shareTokenABI?: Interface | undefined;
   priceFeedEndpoints?: PriceFeedEndpointsOptionalWrite;
   multicall?: string;
 }
@@ -27,7 +25,7 @@ export interface NodeSDKConfig {
 export type SettlementConfig = SettlementCcyItem[];
 
 export interface SettlementCcyItem {
-  perpFlags: BigNumberish;
+  perpFlags: bigint;
   description: string;
   settleTokenDecimals: number;
   settleCCY: string;
@@ -79,7 +77,7 @@ export interface PerpetualStaticInfo {
   referralRebate: number;
   priceIds: string[];
   isPyth: boolean[];
-  perpFlags: BigNumberish;
+  perpFlags: bigint;
 }
 
 /*
@@ -156,7 +154,7 @@ export interface PerpetualState {
 }
 
 export interface OrderResponse {
-  tx: ContractTransaction;
+  tx: ContractTransactionResponse;
   orderId: string;
 }
 
@@ -195,16 +193,16 @@ export interface TradeEvent {
 /**
  * @global
  * @typedef {Object} SmartContractOrder
- * @property {BigNumberish} flags
+ * @property {bigint} flags
  * @property {number} iPerpetualId
  * @property {number} brokerFeeTbps
  * @property {string} traderAddr
  * @property {string} brokerAddr
  * @property {string} executorAddr
  * @property {BytesLike} brokerSignature
- * @property {BigNumberish} fAmount
- * @property {BigNumberish} fLimitPrice
- * @property {BigNumberish} fTriggerPrice
+ * @property {bigint} fAmount
+ * @property {bigint} fLimitPrice
+ * @property {bigint} fTriggerPrice
  * @property {number} leverageTDR
  * @property {number} iDeadline
  * @property {number} executionTimestamp
@@ -212,37 +210,52 @@ export interface TradeEvent {
  */
 export interface SmartContractOrder {
   flags: BigNumberish;
-  iPerpetualId: number;
-  brokerFeeTbps: number;
+  iPerpetualId: BigNumberish;
+  brokerFeeTbps: BigNumberish;
   traderAddr: string;
   brokerAddr: string;
   executorAddr: string;
   brokerSignature: BytesLike;
-  fAmount: BigNumberish;
-  fLimitPrice: BigNumberish;
-  fTriggerPrice: BigNumberish;
-  leverageTDR: number;
-  iDeadline: number;
-  executionTimestamp: number;
-  submittedTimestamp: number;
+  fAmount: bigint;
+  fLimitPrice: bigint;
+  fTriggerPrice: bigint;
+  leverageTDR: BigNumberish;
+  iDeadline: BigNumberish;
+  executionTimestamp: BigNumberish;
+  submittedTimestamp: BigNumberish;
 }
-
+// {
+//   leverageTDR: bigint;
+//   brokerFeeTbps: bigint;
+//   iPerpetualId: bigint;
+//   traderAddr: string;
+//   executionTimestamp: bigint;
+//   brokerAddr: string;
+//   submittedTimestamp: bigint;
+//   flags: bigint;
+//   iDeadline: bigint;
+//   executorAddr: string;
+//   fAmount: bigint;
+//   fLimitPrice: bigint;
+//   fTriggerPrice: bigint;
+//   brokerSignature: string;
+// };
 /**
  * @global
  * @typedef {Object} ClientOrder
- * @property {BigNumberish} flags
- * @property {BigNumberish} iPerpetualId
- * @property {BigNumberish} brokerFeeTbps
+ * @property {bigint} flags
+ * @property {bigint} iPerpetualId
+ * @property {bigint} brokerFeeTbps
  * @property {string} traderAddr
  * @property {string} brokerAddr
  * @property {string} executorAddr
  * @property {BytesLike} brokerSignature
- * @property {BigNumberish} fAmount
- * @property {BigNumberish} fLimitPrice
- * @property {BigNumberish} fTriggerPrice
- * @property {BigNumberish} leverageTDR
- * @property {BigNumberish} iDeadline
- * @property {BigNumberish} executionTimestamp
+ * @property {bigint} fAmount
+ * @property {bigint} fLimitPrice
+ * @property {bigint} fTriggerPrice
+ * @property {bigint} leverageTDR
+ * @property {bigint} iDeadline
+ * @property {bigint} executionTimestamp
  * @property {string} parentChildDigest1
  * @property {string} parentChildDigest2
  * @property {string} callbackTarget
@@ -255,9 +268,9 @@ export interface ClientOrder {
   brokerAddr: string;
   executorAddr: string;
   brokerSignature: BytesLike;
-  fAmount: BigNumberish;
-  fLimitPrice: BigNumberish;
-  fTriggerPrice: BigNumberish;
+  fAmount: bigint;
+  fLimitPrice: bigint;
+  fTriggerPrice: bigint;
   leverageTDR: BigNumberish;
   iDeadline: BigNumberish;
   executionTimestamp: BigNumberish;
@@ -316,9 +329,9 @@ export interface PriceFeedSubmission {
 }
 
 export interface PriceFeedFormat {
-  conf: BigNumber;
+  conf: bigint;
   expo: number;
-  price: BigNumber;
+  price: bigint;
   publish_time: number;
 }
 

package/src/onChainPxFeed.ts

@@ -1,4 +1,4 @@
-import { StaticJsonRpcProvider } from "@ethersproject/providers";
+import { JsonRpcProvider, Provider } from "ethers";
 
 /**
  * OnChainPxFeed: get a price from a chainlink-style oracle
@@ -7,7 +7,7 @@ export default abstract class OnChainPxFeed {
   public rpcs: string[];
   protected lastRpc: number = 0;
   protected lastPx: number | undefined;
-  protected provider: StaticJsonRpcProvider;
+  protected provider: Provider;
   protected lastResponseTs: number = 0;
 
   protected abstract fetchPrice(delay: boolean): Promise<void>;
@@ -15,12 +15,12 @@ export default abstract class OnChainPxFeed {
   public constructor(rpcs: string[]) {
     this.rpcs = rpcs;
     this.lastRpc = Math.floor(Math.random() * rpcs.length);
-    this.provider = new StaticJsonRpcProvider(this.rpcs[this.lastRpc]);
+    this.provider = new JsonRpcProvider(this.rpcs[this.lastRpc]);
   }
 
   protected setRpc() {
     this.lastRpc = (this.lastRpc + 1) % this.rpcs.length;
-    this.provider = new StaticJsonRpcProvider(this.rpcs[this.lastRpc]);
+    this.provider = new JsonRpcProvider(this.rpcs[this.lastRpc]);
   }
 
   public async getPrice(): Promise<number> {

package/src/onChainPxFeedAngle.ts

@@ -1,9 +1,7 @@
-import { Contract } from "@ethersproject/contracts";
-import { StaticJsonRpcProvider } from "@ethersproject/providers";
 import { decNToFloat } from "./d8XMath";
-import { BigNumber } from "ethers";
 import { sleep } from "./utils";
 import OnChainPxFeed from "./onChainPxFeed";
+import { Contract, Provider } from "ethers";
 
 /**
  * OnChainPxFeedAngle: get STUSD-USDC exchange rate
@@ -49,7 +47,7 @@ export default class OnChainPxFeedAngle extends OnChainPxFeed {
  * @param provider arbitrum provider
  * @returns STUSD-USDC
  */
-export async function STUSDToUSDC(provider: StaticJsonRpcProvider): Promise<number> {
+export async function STUSDToUSDC(provider: Provider): Promise<number> {
   // ABIs for IERC4626 and ITransmuter contracts
   const ierc4626ABI = ["function previewMint(uint256) external view returns (uint256)"];
   const iTransmuterABI = ["function quoteOut(uint256, address, address) external view returns (uint256)"];
@@ -64,11 +62,11 @@ export async function STUSDToUSDC(provider: StaticJsonRpcProvider): Promise<numb
   const iTransmuterContract = new Contract(transmuterAddr, iTransmuterABI, provider);
 
   // Call previewMint to get amountUSDA
-  const ONE_STUSD = BigNumber.from(10).pow(BigNumber.from(18));
-  const amountUSDA: BigNumber = await ierc4626Contract.previewMint(ONE_STUSD);
+  const ONE_STUSD = 10n ** 18n; // BigNumber.from(10).pow(BigNumber.from(18));
+  const amountUSDA: bigint = await ierc4626Contract.previewMint(ONE_STUSD);
 
   // Call quoteOut to get amountIn
-  const amountUSDC: BigNumber = await iTransmuterContract.quoteOut(amountUSDA, USDC, USDA);
+  const amountUSDC: bigint = await iTransmuterContract.quoteOut(amountUSDA, USDC, USDA);
 
   return decNToFloat(amountUSDC, 6);
 }

package/src/onChainPxFeedRedStone.ts

@@ -1,9 +1,7 @@
-import { Contract } from "@ethersproject/contracts";
-import { StaticJsonRpcProvider } from "@ethersproject/providers";
 import { decNToFloat } from "./d8XMath";
-import { BigNumber } from "ethers";
 import { sleep } from "./utils";
 import OnChainPxFeed from "./onChainPxFeed";
+import { Contract } from "ethers";
 
 /**
  * OnChainPxFeedRedStone: get a price from a chainlink-style oracle