@orderly.network/core 0.1.28 → 0.2.0

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import EventEmitter from 'eventemitter3';
 export { default as EventEmitter } from 'eventemitter3';
+import { definedTypes, API, AccountStatusEnum } from '@orderly.network/types';
 import { parseUnits, TransactionResponse, ethers } from 'ethers';
-import { AccountStatusEnum } from '@orderly.network/types';
 
 interface OrderlyKeyPair {
     getPublicKey(): Promise<string>;
@@ -70,12 +70,12 @@ declare class MockKeyStore implements OrderlyKeyStore {
     cleanKey(key: string): void;
 }
 
-declare type MessageFactor = {
+type MessageFactor = {
     url: string;
     method: "GET" | "POST" | "PUT" | "DELETE";
     data?: any;
 };
-declare type SignedMessagePayload = {
+type SignedMessagePayload = {
     "orderly-key": string;
     "orderly-timestamp": string;
     "orderly-signature": string;
@@ -113,7 +113,7 @@ declare class BaseSigner implements Signer {
     }>;
 }
 
-declare type ConfigKey = "apiBaseUrl" | "klineDataUrl" | "privateWsUrl" | "publicWsUrl" | "operatorUrl" | "swapSupportApiUrl" | "domain" | "brokerId" | "networkId" | "env" | "PROD_URL";
+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;
@@ -137,7 +137,7 @@ declare class BaseConfigStore extends MemoryConfigStore {
     constructor(configMap: Record<string, any>);
 }
 
-declare type SignatureDomain = {
+type SignatureDomain = {
     name: string;
     version: string;
     chainId: number;
@@ -149,11 +149,15 @@ declare function parseAccountId(userAddress: string, brokerId: string): string;
 declare function parseTokenHash(tokenSymbol: string): string;
 declare function calculateStringHash(input: string): string;
 declare function formatByUnits(amount: string, unit?: number | "ether" | "gwei"): string;
+declare function isHex(value: string): boolean;
+declare function isHexString(value: string): boolean;
 
 type utils_SignatureDomain = SignatureDomain;
 declare const utils_base64url: typeof base64url;
 declare const utils_calculateStringHash: typeof calculateStringHash;
 declare const utils_formatByUnits: typeof formatByUnits;
+declare const utils_isHex: typeof isHex;
+declare const utils_isHexString: typeof isHexString;
 declare const utils_parseAccountId: typeof parseAccountId;
 declare const utils_parseBrokerHash: typeof parseBrokerHash;
 declare const utils_parseTokenHash: typeof parseTokenHash;
@@ -164,6 +168,8 @@ declare namespace utils {
     utils_base64url as base64url,
     utils_calculateStringHash as calculateStringHash,
     utils_formatByUnits as formatByUnits,
+    utils_isHex as isHex,
+    utils_isHexString as isHexString,
     utils_parseAccountId as parseAccountId,
     utils_parseBrokerHash as parseBrokerHash,
     utils_parseTokenHash as parseTokenHash,
@@ -171,14 +177,244 @@ declare namespace utils {
   };
 }
 
-declare const getMockSigner: (secretKey?: string | undefined) => BaseSigner;
+declare const getMockSigner: (secretKey?: string) => BaseSigner;
 declare const getDefaultSigner: () => BaseSigner;
+/**
+ * generate `registerAccount` data and to be signed message structure
+ */
+declare function generateRegisterAccountMessage(inputs: {
+    chainId: number;
+    registrationNonce: number;
+    brokerId: string;
+}): readonly [{
+    brokerId: string;
+    chainId: number;
+    timestamp: number;
+    registrationNonce: number;
+}, {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: {
+        brokerId: string;
+        chainId: number;
+        timestamp: number;
+        registrationNonce: number;
+    };
+    primaryType: string;
+    types: {
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+        Registration: readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "registrationNonce";
+            readonly type: "uint256";
+        }];
+    };
+}];
+/**
+ * generate `addOrderlyKey` data and to be signed message structure
+ */
+declare function generateAddOrderlyKeyMessage(inputs: {
+    publicKey: string;
+    chainId: number;
+    brokerId: string;
+    primaryType: keyof typeof definedTypes;
+    expiration?: number;
+}): readonly [{
+    brokerId: string;
+    orderlyKey: string;
+    scope: string;
+    chainId: number;
+    timestamp: number;
+    expiration: number;
+}, {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    message: {
+        brokerId: string;
+        orderlyKey: string;
+        scope: string;
+        chainId: number;
+        timestamp: number;
+        expiration: number;
+    };
+    primaryType: "Registration" | "EIP712Domain" | "Withdraw" | "AddOrderlyKey" | "SettlePnl";
+    types: {
+        [x: string]: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "registrationNonce";
+            readonly type: "uint256";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "token";
+            readonly type: "string";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "withdrawNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "orderlyKey";
+            readonly type: "string";
+        }, {
+            readonly name: "scope";
+            readonly type: "string";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }, {
+            readonly name: "expiration";
+            readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "settleNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }];
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+    };
+}];
+/**
+ * generate `settle` data and to be signed message structure
+ */
+declare function generateSettleMessage(inputs: {
+    chainId: number;
+    brokerId: string;
+    settlePnlNonce: string;
+    domain: SignatureDomain;
+}): readonly [{
+    brokerId: string;
+    chainId: number;
+    timestamp: number;
+    settleNonce: string;
+}, {
+    domain: SignatureDomain;
+    message: {
+        brokerId: string;
+        chainId: number;
+        timestamp: number;
+        settleNonce: string;
+    };
+    primaryType: string;
+    types: {
+        EIP712Domain: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }, {
+            readonly name: "version";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "verifyingContract";
+            readonly type: "address";
+        }];
+        SettlePnl: readonly [{
+            readonly name: "brokerId";
+            readonly type: "string";
+        }, {
+            readonly name: "chainId";
+            readonly type: "uint256";
+        }, {
+            readonly name: "settleNonce";
+            readonly type: "uint64";
+        }, {
+            readonly name: "timestamp";
+            readonly type: "uint64";
+        }];
+    };
+}];
 
 /**
  * Orderly contracts information
  * https://wootraders.atlassian.net/wiki/spaces/ORDER/pages/343441906/Orderly+V2+Contract+Information+Board
  */
-declare type OrderlyContracts = {
+type OrderlyContracts = {
     usdcAddress: string;
     usdcAbi: any;
     erc20Abi: any;
@@ -265,21 +501,6 @@ declare class BaseContract implements IContract {
             type: string;
             stateMutability?: undefined;
             outputs?: undefined;
-        } | {
-            inputs: {
-                internalType: string;
-                name: string;
-                type: string;
-            }[];
-            name: string;
-            outputs: {
-                internalType: string;
-                name: string;
-                type: string;
-            }[];
-            stateMutability: string;
-            type: string;
-            anonymous?: undefined;
         } | {
             inputs: ({
                 internalType: string;
@@ -297,7 +518,11 @@ declare class BaseContract implements IContract {
                 type: string;
             })[];
             name: string;
-            outputs: never[];
+            outputs: {
+                internalType: string;
+                name: string;
+                type: string;
+            }[];
             stateMutability: string;
             type: string;
             anonymous?: undefined;
@@ -377,17 +602,20 @@ interface IWalletAdapter {
     call(address: string, method: string, params: any, options: {
         abi: any;
     }): Promise<any>;
+    callOnChain(chain: API.NetworkInfos, address: string, method: string, params: any, options: {
+        abi: any;
+    }): Promise<any>;
     on(eventName: any, listener: any): void;
     off(eventName: any, listener: any): void;
 }
-declare type WalletAdapterOptions = {
+type WalletAdapterOptions = {
     provider: any;
     address: string;
     chain: {
-        id: string;
+        id: number;
     };
 };
-declare type getWalletAdapterFunc = (options: WalletAdapterOptions) => IWalletAdapter;
+type getWalletAdapterFunc = (options: WalletAdapterOptions) => IWalletAdapter;
 
 declare class Assets {
     private readonly configStore;
@@ -397,7 +625,7 @@ declare class Assets {
     withdraw(inputs: {
         chainId: number;
         token: string;
-        amount: number;
+        amount: string | number;
         allowCrossChainWithdraw: boolean;
     }): Promise<any>;
     private _generateWithdrawMessage;
@@ -416,7 +644,14 @@ declare class Assets {
         address: string;
     }): Promise<any>;
     private _approve;
-    deposit(amount: string): Promise<ethers.TransactionResponse>;
+    getDepositData(amount: string): {
+        accountId: string | undefined;
+        brokerHash: string;
+        tokenHash: string;
+        tokenAmount: string;
+    };
+    getDepositFee(amount: string, chain: API.NetworkInfos): Promise<any>;
+    deposit(amount: string, fee?: bigint): Promise<ethers.TransactionResponse>;
     private _simpleFetch;
     get usdcAddress(): string;
 }
@@ -443,7 +678,7 @@ interface AccountState {
  */
 declare class Account {
     private readonly configStore;
-    private readonly keyStore;
+    readonly keyStore: OrderlyKeyStore;
     private readonly getWalletAdapter;
     static instanceName: string;
     private _singer?;
@@ -464,7 +699,7 @@ declare class Account {
     setAddress(address: string, wallet?: {
         provider: any;
         chain: {
-            id: string;
+            id: string | number;
         };
         wallet?: {
             name: string;
@@ -486,7 +721,7 @@ declare class Account {
     private _checkAccountExist;
     createAccount(): Promise<any>;
     signTypedData(toSignatureMessage: Record<string, any>): Promise<string>;
-    createOrderlyKey(expiration: number): Promise<any>;
+    createOrderlyKey(expiration?: number): Promise<any>;
     settle(): Promise<any>;
     disconnect(): Promise<void>;
     private _checkOrderlyKeyState;
@@ -522,6 +757,9 @@ declare class EtherAdapter implements IWalletAdapter {
     call(address: string, method: string, params: any[], options: {
         abi: any;
     }): Promise<any>;
+    callOnChain(chain: API.NetworkInfos, address: string, method: string, params: any[], options: {
+        abi: any;
+    }): Promise<any>;
     get chainId(): number;
     get addresses(): string;
     send(method: string, params: Array<any> | Record<string, any>): Promise<any>;
@@ -545,4 +783,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, getDefaultSigner, getMockSigner, getWalletAdapterFunc, utils };
+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 };