@orderly.network/core 0.2.4-rc.4 → 0.2.4

package/dist/index.d.mts

@@ -87,11 +87,11 @@ type SignedMessagePayload = {
  * ```ts
  * const signer = new BaseSigner(keyStore);
  * const payload = await signer.sign({
- *  url: "https://api.orderly.io/get_account?address=0x1234567890&brokerId=woofi_dex",
+ *  url: "https://api.orderly.io/get_account?address=0x1234567890&brokerId=orderly",
  *   method: "GET",
  *   data: {
  *     address: "0x1234567890",
- *     brokerId: "woofi_pro",
+ *     brokerId: "orderly",
  *    },
  *  });
  *  ```
@@ -113,30 +113,6 @@ declare class BaseSigner implements Signer {
     }>;
 }
 
-type ConfigKey = "apiBaseUrl" | "klineDataUrl" | "privateWsUrl" | "publicWsUrl" | "operatorUrl" | "swapSupportApiUrl" | "domain" | "brokerId" | "networkId" | "env" | "PROD_URL" | "markets";
-interface ConfigStore {
-    get<T>(key: ConfigKey): T;
-    getOr<T>(key: ConfigKey, defaultValue: T): T;
-    set<T>(key: ConfigKey, value: T): void;
-    clear(): void;
-}
-declare class MemoryConfigStore implements ConfigStore {
-    protected map: Map<ConfigKey, any>;
-    constructor(init?: any);
-    protected _restore(init?: Record<ConfigKey, any>): void;
-    get<T>(key: ConfigKey): T;
-    getOr<T>(key: ConfigKey, defaultValue: T): T;
-    set<T>(key: ConfigKey, value: T): void;
-    clear(): void;
-}
-/**
- *
- */
-declare class BaseConfigStore extends MemoryConfigStore {
-    private readonly configMap;
-    constructor(configMap: Record<string, any>);
-}
-
 type SignatureDomain = {
     name: string;
     version: string;
@@ -410,9 +386,16 @@ declare function generateSettleMessage(inputs: {
     };
 }];
 
+type ConfigKey = "apiBaseUrl" | "klineDataUrl" | "privateWsUrl" | "publicWsUrl" | "operatorUrl" | "domain" | "brokerId" | "networkId" | "env" | "PROD_URL" | "markets";
+interface ConfigStore {
+    get<T>(key: ConfigKey): T;
+    getOr<T>(key: ConfigKey, defaultValue: T): T;
+    set<T>(key: ConfigKey, value: T): void;
+    clear(): void;
+}
+
 /**
  * Orderly contracts information
- * https://wootraders.atlassian.net/wiki/spaces/ORDER/pages/343441906/Orderly+V2+Contract+Information+Board
  */
 type OrderlyContracts = {
     usdcAddress: string;
@@ -586,6 +569,10 @@ declare class SimpleDI {
 interface IWalletAdapter {
     get chainId(): number;
     get addresses(): string;
+    /**
+     * Set the chain id
+     */
+    set chainId(chainId: number);
     parseUnits: (amount: string) => string;
     formatUnits: (amount: string) => string;
     send: (method: string, params: Array<any> | Record<string, any>) => Promise<any>;
@@ -597,7 +584,9 @@ interface IWalletAdapter {
     }, options: {
         abi: any;
     }): Promise<TransactionResponse>;
+    getTransactionRecipect: (txHash: string) => Promise<any>;
     signTypedData: (address: string, data: any) => Promise<string>;
+    pollTransactionReceiptWithBackoff: (txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number) => Promise<any>;
     getBalance: (userAddress: string) => Promise<any>;
     call(address: string, method: string, params: any, options: {
         abi: any;
@@ -724,6 +713,8 @@ declare class Account {
     createOrderlyKey(expiration?: number): Promise<any>;
     settle(): Promise<any>;
     disconnect(): Promise<void>;
+    switchChainId(chainId: number | string): void;
+    private parseChainId;
     private _checkOrderlyKeyState;
     get signer(): Signer;
     get wallet(): IWalletAdapter | undefined;
@@ -761,6 +752,7 @@ declare class EtherAdapter implements IWalletAdapter {
         abi: any;
     }): Promise<any>;
     get chainId(): number;
+    set chainId(chainId: number);
     get addresses(): string;
     send(method: string, params: Array<any> | Record<string, any>): Promise<any>;
     sendTransaction(contractAddress: string, method: string, payload: {
@@ -771,6 +763,8 @@ declare class EtherAdapter implements IWalletAdapter {
     }, options: {
         abi: any;
     }): Promise<ethers.TransactionResponse>;
+    getTransactionRecipect(txHash: string): Promise<void>;
+    pollTransactionReceiptWithBackoff(txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number): Promise<ethers.TransactionReceipt>;
     private estimateGas;
     signTypedData(address: string, data: any): Promise<any>;
     verify(data: {
@@ -783,4 +777,4 @@ declare class EtherAdapter implements IWalletAdapter {
     getContract(address: string, abi: any): ethers.Contract;
 }
 
-export { Account, AccountState, BaseConfigStore, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };
+export { Account, AccountState, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };

package/dist/index.d.ts

@@ -87,11 +87,11 @@ type SignedMessagePayload = {
  * ```ts
  * const signer = new BaseSigner(keyStore);
  * const payload = await signer.sign({
- *  url: "https://api.orderly.io/get_account?address=0x1234567890&brokerId=woofi_dex",
+ *  url: "https://api.orderly.io/get_account?address=0x1234567890&brokerId=orderly",
  *   method: "GET",
  *   data: {
  *     address: "0x1234567890",
- *     brokerId: "woofi_pro",
+ *     brokerId: "orderly",
  *    },
  *  });
  *  ```
@@ -113,30 +113,6 @@ declare class BaseSigner implements Signer {
     }>;
 }
 
-type ConfigKey = "apiBaseUrl" | "klineDataUrl" | "privateWsUrl" | "publicWsUrl" | "operatorUrl" | "swapSupportApiUrl" | "domain" | "brokerId" | "networkId" | "env" | "PROD_URL" | "markets";
-interface ConfigStore {
-    get<T>(key: ConfigKey): T;
-    getOr<T>(key: ConfigKey, defaultValue: T): T;
-    set<T>(key: ConfigKey, value: T): void;
-    clear(): void;
-}
-declare class MemoryConfigStore implements ConfigStore {
-    protected map: Map<ConfigKey, any>;
-    constructor(init?: any);
-    protected _restore(init?: Record<ConfigKey, any>): void;
-    get<T>(key: ConfigKey): T;
-    getOr<T>(key: ConfigKey, defaultValue: T): T;
-    set<T>(key: ConfigKey, value: T): void;
-    clear(): void;
-}
-/**
- *
- */
-declare class BaseConfigStore extends MemoryConfigStore {
-    private readonly configMap;
-    constructor(configMap: Record<string, any>);
-}
-
 type SignatureDomain = {
     name: string;
     version: string;
@@ -410,9 +386,16 @@ declare function generateSettleMessage(inputs: {
     };
 }];
 
+type ConfigKey = "apiBaseUrl" | "klineDataUrl" | "privateWsUrl" | "publicWsUrl" | "operatorUrl" | "domain" | "brokerId" | "networkId" | "env" | "PROD_URL" | "markets";
+interface ConfigStore {
+    get<T>(key: ConfigKey): T;
+    getOr<T>(key: ConfigKey, defaultValue: T): T;
+    set<T>(key: ConfigKey, value: T): void;
+    clear(): void;
+}
+
 /**
  * Orderly contracts information
- * https://wootraders.atlassian.net/wiki/spaces/ORDER/pages/343441906/Orderly+V2+Contract+Information+Board
  */
 type OrderlyContracts = {
     usdcAddress: string;
@@ -586,6 +569,10 @@ declare class SimpleDI {
 interface IWalletAdapter {
     get chainId(): number;
     get addresses(): string;
+    /**
+     * Set the chain id
+     */
+    set chainId(chainId: number);
     parseUnits: (amount: string) => string;
     formatUnits: (amount: string) => string;
     send: (method: string, params: Array<any> | Record<string, any>) => Promise<any>;
@@ -597,7 +584,9 @@ interface IWalletAdapter {
     }, options: {
         abi: any;
     }): Promise<TransactionResponse>;
+    getTransactionRecipect: (txHash: string) => Promise<any>;
     signTypedData: (address: string, data: any) => Promise<string>;
+    pollTransactionReceiptWithBackoff: (txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number) => Promise<any>;
     getBalance: (userAddress: string) => Promise<any>;
     call(address: string, method: string, params: any, options: {
         abi: any;
@@ -724,6 +713,8 @@ declare class Account {
     createOrderlyKey(expiration?: number): Promise<any>;
     settle(): Promise<any>;
     disconnect(): Promise<void>;
+    switchChainId(chainId: number | string): void;
+    private parseChainId;
     private _checkOrderlyKeyState;
     get signer(): Signer;
     get wallet(): IWalletAdapter | undefined;
@@ -761,6 +752,7 @@ declare class EtherAdapter implements IWalletAdapter {
         abi: any;
     }): Promise<any>;
     get chainId(): number;
+    set chainId(chainId: number);
     get addresses(): string;
     send(method: string, params: Array<any> | Record<string, any>): Promise<any>;
     sendTransaction(contractAddress: string, method: string, payload: {
@@ -771,6 +763,8 @@ declare class EtherAdapter implements IWalletAdapter {
     }, options: {
         abi: any;
     }): Promise<ethers.TransactionResponse>;
+    getTransactionRecipect(txHash: string): Promise<void>;
+    pollTransactionReceiptWithBackoff(txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number): Promise<ethers.TransactionReceipt>;
     private estimateGas;
     signTypedData(address: string, data: any): Promise<any>;
     verify(data: {
@@ -783,4 +777,4 @@ declare class EtherAdapter implements IWalletAdapter {
     getContract(address: string, abi: any): ethers.Contract;
 }
 
-export { Account, AccountState, BaseConfigStore, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };
+export { Account, AccountState, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, ConfigKey, ConfigStore, DefaultConfigStore, EtherAdapter, IContract, LocalStorageStore, MessageFactor, MockKeyStore, OrderlyKeyPair, OrderlyKeyStore, SignedMessagePayload, Signer, SimpleDI, IWalletAdapter as WalletAdapter, WalletAdapterOptions, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };