@orderly.network/core 2.4.1 → 2.5.0-alpha.1

package/dist/index.d.mts

@@ -731,6 +731,14 @@ declare class Assets {
     private readonly contractManger;
     private readonly account;
     constructor(configStore: ConfigStore, contractManger: IContract, account: Account);
+    /**
+     * Convert non-USDC asset to USDC manually
+     */
+    convert(inputs: {
+        slippage: number;
+        amount: number;
+        converted_asset: string;
+    }): Promise<any>;
     withdraw(inputs: {
         chainId: number;
         token: string;
@@ -741,58 +749,82 @@ declare class Assets {
     }): Promise<any>;
     private getWithdrawalNonce;
     getNativeBalance(options?: {
+        /** token decimals on chain, default is 18 */
         decimals?: number;
     }): Promise<string>;
-    getBalance(address?: string, options?: {
+    getBalance(
+    /** token address */
+    address: string, options: {
+        /** token decimals on chain, default is 18 */
         decimals?: number;
     }): Promise<string>;
-    getBalanceByAddress(address: string, options?: {
+    /**
+     * @deprecated use getBalance instead, will be removed in the future
+     */
+    getBalanceByAddress(
+    /** token address */
+    address: string, options?: {
+        /** token decimals on chain, default is 18 */
         decimals?: number;
     }): Promise<string>;
-    getAllowance(
-    /** please use object inputs instead, string inputs will be removed in the future */
-    inputs?: string | {
-        address?: string;
+    getAllowance(inputs: {
+        /** token address */
+        address: string;
+        /** vault address */
         vaultAddress?: string;
+        /** token decimals on chain, default is 18 */
         decimals?: number;
-    }, 
-    /** @deprecated use inputs.vaultAddress instead, will be removed in the future */
-    _vaultAddress?: string): Promise<string>;
-    approve(
-    /** please use object inputs instead, string inputs will be removed in the future */
-    inputs: string | {
+    }): Promise<string>;
+    approve(inputs: {
+        /** token address */
         address?: string;
-        amount?: string;
+        /** vault address */
         vaultAddress?: string;
+        /** token amount */
+        amount?: string;
+        /** token decimals on chain, default is 18 */
         decimals: number;
-    }, 
-    /** @deprecated use inputs.amount instead, will be removed in the future */
-    _amount?: string, 
-    /** @deprecated use inputs.vaultAddress instead, will be removed in the future */
-    _vaultAddress?: string): Promise<any>;
+    }): Promise<any>;
+    /**
+     * @deprecated use approve instead, will be removed in the future
+     */
     approveByAddress(inputs: {
+        /** token address */
         address: string;
+        /** token amount */
         amount?: string;
+        /** token decimals on chain, default is 18 */
         decimals: number;
     }): Promise<any>;
-    getDepositFee(
-    /** please use object inputs instead, string inputs will be removed in the future */
-    inputs: string | {
+    getDepositFee(inputs: {
         amount: string;
+        /** chain info */
         chain: API.NetworkInfos;
+        /** token decimals on chain, default is 18 */
         decimals: number;
-    }, 
-    /** @deprecated use inputs.chain instead, will be removed in the future */
-    _chain?: API.NetworkInfos): Promise<any>;
-    deposit(
-    /** please use object inputs instead */
-    inputs: string | {
+        token?: string;
+        /** token address */
+        address?: string;
+    }): Promise<any>;
+    /** deposit native token */
+    depositNativeToken(inputs: {
+        amount: string;
+        fee: bigint;
+        /** token decimals on chain, default is 18 */
+        decimals: number;
+        token?: string;
+    }): Promise<any>;
+    deposit(inputs: {
         amount: string;
         fee: bigint;
+        /** token decimals on chain, default is 18 */
         decimals: number;
-    }, 
-    /** @deprecated use inputs.fee instead, will be removed in the future */
-    _fee?: bigint): Promise<any>;
+        token?: string;
+        /** token address */
+        address?: string;
+        /** vault address */
+        vaultAddress?: string;
+    }): Promise<any>;
     private _simpleFetch;
     get usdcAddress(): string;
 }
@@ -1062,7 +1094,14 @@ declare class Account {
          * */
         subAccountId?: string;
     }): Promise<any>;
-    settle(): Promise<any>;
+    /** set main account pnl */
+    settle(options?: {
+        /**
+         * if you are main account, you don't need to pass the accountId
+         * if you are sub account and you want to settle the main account, you need to pass main account id
+         * */
+        accountId?: string;
+    }): Promise<any>;
     private signData;
     destroyOrderlyKey(): Promise<void>;
     disconnect(): Promise<void>;

package/dist/index.d.ts

@@ -731,6 +731,14 @@ declare class Assets {
     private readonly contractManger;
     private readonly account;
     constructor(configStore: ConfigStore, contractManger: IContract, account: Account);
+    /**
+     * Convert non-USDC asset to USDC manually
+     */
+    convert(inputs: {
+        slippage: number;
+        amount: number;
+        converted_asset: string;
+    }): Promise<any>;
     withdraw(inputs: {
         chainId: number;
         token: string;
@@ -741,58 +749,82 @@ declare class Assets {
     }): Promise<any>;
     private getWithdrawalNonce;
     getNativeBalance(options?: {
+        /** token decimals on chain, default is 18 */
         decimals?: number;
     }): Promise<string>;
-    getBalance(address?: string, options?: {
+    getBalance(
+    /** token address */
+    address: string, options: {
+        /** token decimals on chain, default is 18 */
         decimals?: number;
     }): Promise<string>;
-    getBalanceByAddress(address: string, options?: {
+    /**
+     * @deprecated use getBalance instead, will be removed in the future
+     */
+    getBalanceByAddress(
+    /** token address */
+    address: string, options?: {
+        /** token decimals on chain, default is 18 */
         decimals?: number;
     }): Promise<string>;
-    getAllowance(
-    /** please use object inputs instead, string inputs will be removed in the future */
-    inputs?: string | {
-        address?: string;
+    getAllowance(inputs: {
+        /** token address */
+        address: string;
+        /** vault address */
         vaultAddress?: string;
+        /** token decimals on chain, default is 18 */
         decimals?: number;
-    }, 
-    /** @deprecated use inputs.vaultAddress instead, will be removed in the future */
-    _vaultAddress?: string): Promise<string>;
-    approve(
-    /** please use object inputs instead, string inputs will be removed in the future */
-    inputs: string | {
+    }): Promise<string>;
+    approve(inputs: {
+        /** token address */
         address?: string;
-        amount?: string;
+        /** vault address */
         vaultAddress?: string;
+        /** token amount */
+        amount?: string;
+        /** token decimals on chain, default is 18 */
         decimals: number;
-    }, 
-    /** @deprecated use inputs.amount instead, will be removed in the future */
-    _amount?: string, 
-    /** @deprecated use inputs.vaultAddress instead, will be removed in the future */
-    _vaultAddress?: string): Promise<any>;
+    }): Promise<any>;
+    /**
+     * @deprecated use approve instead, will be removed in the future
+     */
     approveByAddress(inputs: {
+        /** token address */
         address: string;
+        /** token amount */
         amount?: string;
+        /** token decimals on chain, default is 18 */
         decimals: number;
     }): Promise<any>;
-    getDepositFee(
-    /** please use object inputs instead, string inputs will be removed in the future */
-    inputs: string | {
+    getDepositFee(inputs: {
         amount: string;
+        /** chain info */
         chain: API.NetworkInfos;
+        /** token decimals on chain, default is 18 */
         decimals: number;
-    }, 
-    /** @deprecated use inputs.chain instead, will be removed in the future */
-    _chain?: API.NetworkInfos): Promise<any>;
-    deposit(
-    /** please use object inputs instead */
-    inputs: string | {
+        token?: string;
+        /** token address */
+        address?: string;
+    }): Promise<any>;
+    /** deposit native token */
+    depositNativeToken(inputs: {
+        amount: string;
+        fee: bigint;
+        /** token decimals on chain, default is 18 */
+        decimals: number;
+        token?: string;
+    }): Promise<any>;
+    deposit(inputs: {
         amount: string;
         fee: bigint;
+        /** token decimals on chain, default is 18 */
         decimals: number;
-    }, 
-    /** @deprecated use inputs.fee instead, will be removed in the future */
-    _fee?: bigint): Promise<any>;
+        token?: string;
+        /** token address */
+        address?: string;
+        /** vault address */
+        vaultAddress?: string;
+    }): Promise<any>;
     private _simpleFetch;
     get usdcAddress(): string;
 }
@@ -1062,7 +1094,14 @@ declare class Account {
          * */
         subAccountId?: string;
     }): Promise<any>;
-    settle(): Promise<any>;
+    /** set main account pnl */
+    settle(options?: {
+        /**
+         * if you are main account, you don't need to pass the accountId
+         * if you are sub account and you want to settle the main account, you need to pass main account id
+         * */
+        accountId?: string;
+    }): Promise<any>;
     private signData;
     destroyOrderlyKey(): Promise<void>;
     disconnect(): Promise<void>;