@orderly.network/core 2.6.0 → 2.6.1-alpha.0

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import EventEmitter from 'eventemitter3';
 export { default as EventEmitter } from 'eventemitter3';
-import { definedTypes, API, ChainNamespace, AccountStatusEnum, NetworkId } from '@orderly.network/types';
+import { definedTypes, ChainNamespace, API, AccountStatusEnum, NetworkId } from '@orderly.network/types';
 import { BigNumberish } from 'ethers/src.ts/utils';
 import { parseUnits, TransactionResponse, ethers } from 'ethers';
 
@@ -248,7 +248,7 @@ declare function generateAddOrderlyKeyMessage(inputs: {
         timestamp: number;
         expiration: number;
     };
-    primaryType: "EIP712Domain" | "Registration" | "Withdraw" | "AddOrderlyKey" | "SettlePnl";
+    primaryType: "EIP712Domain" | "Registration" | "Withdraw" | "AddOrderlyKey" | "SettlePnl" | "DexRequest" | "InternalTransfer";
     types: {
         [x: string]: readonly [{
             readonly name: "name";
@@ -325,6 +325,39 @@ declare function generateAddOrderlyKeyMessage(inputs: {
         }, {
             readonly name: "timestamp";
             readonly type: "uint64";
+        }] | readonly [{
+            readonly name: "payloadType";
+            readonly type: "uint8";
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint256";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "vaultId";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "token";
+            readonly type: "string";
+        }, {
+            readonly name: "dexBrokerId";
+            readonly type: "string";
+        }] | readonly [{
+            readonly name: "receiver";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "token";
+            readonly type: "string";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "transferNonce";
+            readonly type: "uint64";
         }];
         EIP712Domain: readonly [{
             readonly name: "name";
@@ -392,6 +425,78 @@ declare function generateSettleMessage(inputs: {
         }];
     };
 }];
+/**
+ * generate `dexRequest` data and to be signed message structure
+ */
+declare function generateDexRequestMessage(inputs: {
+    chainId: number;
+    payloadType: number;
+    nonce: string;
+    receiver: string;
+    amount: string;
+    vaultId: string;
+    token: string;
+    dexBrokerId: string;
+    domain: SignatureDomain;
+    timestamp?: number;
+}): readonly [{
+    payloadType: number;
+    nonce: string;
+    receiver: string;
+    amount: string;
+    vaultId: string;
+    token: string;
+    dexBrokerId: string;
+}, {
+    domain: SignatureDomain;
+    message: {
+        payloadType: number;
+        nonce: string;
+        receiver: string;
+        amount: string;
+        vaultId: string;
+        token: string;
+        dexBrokerId: 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";
+        }];
+        DexRequest: readonly [{
+            readonly name: "payloadType";
+            readonly type: "uint8";
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint256";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly name: "vaultId";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "token";
+            readonly type: "string";
+        }, {
+            readonly name: "dexBrokerId";
+            readonly type: "string";
+        }];
+    };
+}];
 
 type ConfigKey = "apiBaseUrl" | "klineDataUrl" | "privateWsUrl" | "publicWsUrl" | "operatorUrl" | "domain" | "brokerId" | "brokerName" | "networkId" | "env" | "chainNamespace" | "PROD_URL" | "orderly_markets" | "markets";
 interface ConfigStore {
@@ -726,6 +831,120 @@ declare class SimpleDI {
     private constructor();
 }
 
+type ChainType = "EVM" | "SOL";
+interface Message {
+    message: {
+        chainType: ChainType;
+        [key: string]: any;
+    };
+    signatured: string;
+}
+type RegisterAccountInputs = {
+    brokerId: string;
+    registrationNonce: number;
+    timestamp: number;
+};
+type WithdrawInputs = {
+    brokerId: string;
+    receiver: string;
+    token: string;
+    amount: string;
+    nonce: number;
+    timestamp: number;
+    verifyContract?: string;
+};
+type InternalTransferInputs = {
+    receiver: string;
+    token: string;
+    amount: string;
+    nonce: number;
+    verifyContract?: string;
+};
+type SettleInputs = {
+    brokerId: string;
+    settlePnlNonce: string;
+    timestamp: number;
+    verifyContract?: string;
+};
+type AddOrderlyKeyInputs = {
+    publicKey: string;
+    brokerId: string;
+    expiration: number;
+    timestamp: number;
+    scope?: string;
+    tag?: string;
+    /** @since 2.3.0, when create orderly key for sub account, it's required */
+    subAccountId?: string;
+};
+type DexRequestInputs = {
+    payloadType: number;
+    nonce: string;
+    receiver: string;
+    amount: string;
+    vaultId: string;
+    token: string;
+    dexBrokerId: string;
+    timestamp: number;
+    domain: SignatureDomain;
+};
+interface WalletAdapter<Config = any> {
+    chainNamespace: ChainNamespace;
+    get chainId(): number;
+    get address(): string;
+    set chainId(chainId: number);
+    set address(addresses: string);
+    active(config: Config): void;
+    update(config: Config): void;
+    deactivate(): void;
+    generateSecretKey(): string;
+    /**
+     * business methods
+     */
+    generateRegisterAccountMessage(inputs: RegisterAccountInputs): Promise<Message>;
+    generateWithdrawMessage(inputs: WithdrawInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
+    generateInternalTransferMessage(inputs: InternalTransferInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
+    generateSettleMessage(inputs: SettleInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
+    generateAddOrderlyKeyMessage(inputs: AddOrderlyKeyInputs): Promise<Message>;
+    generateDexRequestMessage(inputs: DexRequestInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
+    /**
+     * ===== general methods =====
+     */
+    /**
+     * call contract
+     */
+    call(address: string, method: string, params: any[], options?: {
+        abi: any;
+    }): Promise<any>;
+    /**
+     * send transaction
+     */
+    sendTransaction(contractAddress: string, method: string, payload: {
+        from: string;
+        to?: string;
+        data: any[];
+        value?: bigint;
+    }, options: {
+        abi: any;
+    }): Promise<any>;
+    callOnChain(chain: API.NetworkInfos, address: string, method: string, params: any[], options: {
+        abi: any;
+    }): Promise<any>;
+    getBalance(): Promise<bigint>;
+    pollTransactionReceiptWithBackoff(txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number): Promise<any>;
+    parseUnits: (amount: string, decimals: number) => string;
+    formatUnits: (amount: BigNumberish, decimals: number) => string;
+    on(eventName: string, listener: (...args: any[]) => void): void;
+    off(eventName: string, listener: (...args: any[]) => void): void;
+}
+
 declare class Assets {
     private readonly configStore;
     private readonly contractManger;
@@ -826,6 +1045,14 @@ declare class Assets {
         /** vault address */
         vaultAddress?: string;
     }): Promise<any>;
+    internalTransfer(inputs: {
+        token: string;
+        amount: string;
+        receiver: string;
+        /** orderly token decimals */
+        decimals: number;
+    }): Promise<any>;
+    private getTransferNonce;
     private _simpleFetch;
     get usdcAddress(): string;
 }
@@ -836,96 +1063,6 @@ type SubAccount = {
     holding: API.Holding[];
 };
 
-type ChainType = "EVM" | "SOL";
-interface Message {
-    message: {
-        chainType: ChainType;
-        [key: string]: any;
-    };
-    signatured: string;
-}
-type RegisterAccountInputs = {
-    brokerId: string;
-    registrationNonce: number;
-    timestamp: number;
-};
-type WithdrawInputs = {
-    brokerId: string;
-    receiver: string;
-    token: string;
-    amount: string;
-    nonce: number;
-    timestamp: number;
-    verifyContract?: string;
-};
-type SettleInputs = {
-    brokerId: string;
-    settlePnlNonce: string;
-    timestamp: number;
-    verifyContract?: string;
-};
-type AddOrderlyKeyInputs = {
-    publicKey: string;
-    brokerId: string;
-    expiration: number;
-    timestamp: number;
-    scope?: string;
-    tag?: string;
-    /** @since 2.3.0, when create orderly key for sub account, it's required */
-    subAccountId?: string;
-};
-interface WalletAdapter<Config = any> {
-    chainNamespace: ChainNamespace;
-    get chainId(): number;
-    get address(): string;
-    set chainId(chainId: number);
-    set address(addresses: string);
-    active(config: Config): void;
-    update(config: Config): void;
-    deactivate(): void;
-    generateSecretKey(): string;
-    /**
-     * business methods
-     */
-    generateRegisterAccountMessage(inputs: RegisterAccountInputs): Promise<Message>;
-    generateWithdrawMessage(inputs: WithdrawInputs): Promise<Message & {
-        domain: SignatureDomain;
-    }>;
-    generateSettleMessage(inputs: SettleInputs): Promise<Message & {
-        domain: SignatureDomain;
-    }>;
-    generateAddOrderlyKeyMessage(inputs: AddOrderlyKeyInputs): Promise<Message>;
-    /**
-     * ===== general methods =====
-     */
-    /**
-     * call contract
-     */
-    call(address: string, method: string, params: any[], options?: {
-        abi: any;
-    }): Promise<any>;
-    /**
-     * send transaction
-     */
-    sendTransaction(contractAddress: string, method: string, payload: {
-        from: string;
-        to?: string;
-        data: any[];
-        value?: bigint;
-    }, options: {
-        abi: any;
-    }): Promise<any>;
-    callOnChain(chain: API.NetworkInfos, address: string, method: string, params: any[], options: {
-        abi: any;
-    }): Promise<any>;
-    getBalance(): Promise<bigint>;
-    pollTransactionReceiptWithBackoff(txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number): Promise<any>;
-    parseUnits: (amount: string, decimals: number) => string;
-    formatUnits: (amount: BigNumberish, decimals: number) => string;
-    on(eventName: string, listener: (...args: any[]) => void): void;
-    off(eventName: string, listener: (...args: any[]) => void): void;
-}
-
 interface AccountState {
     status: AccountStatusEnum;
     /**
@@ -1116,10 +1253,30 @@ declare class Account {
     private _getAccountInfo;
     private _getSettleNonce;
     private _simpleFetch;
+    private _getVaultOperationNonce;
     getAdditionalInfo(): Record<string, any> | null;
     get on(): <T extends string | symbol>(event: T, fn: (...args: any[]) => void, context?: any) => EventEmitter<string | symbol, any>;
     get once(): <T extends string | symbol>(event: T, fn: (...args: any[]) => void, context?: any) => EventEmitter<string | symbol, any>;
     get off(): <T extends string | symbol>(event: T, fn?: ((...args: any[]) => void) | undefined, context?: any, once?: boolean) => EventEmitter<string | symbol, any>;
+    /**
+     * Generate DexRequest message for DEX operations
+     * @param inputs DexRequest parameters
+     * @returns Signed message and domain
+     */
+    generateDexRequest(inputs: {
+        payloadType: number;
+        amount: string;
+        vaultId: string;
+        token: string;
+        domain: SignatureDomain;
+    }): Promise<{
+        message: {
+            [key: string]: any;
+            chainType: ChainType;
+        };
+        signatured: string;
+        domain: SignatureDomain;
+    }>;
     /**
      * Signs a GET MessageFactor payload with the current timestamp.
      * @param url The URL for the GET request
@@ -1150,10 +1307,16 @@ declare abstract class BaseWalletAdapter<Config> implements WalletAdapter<Config
     abstract generateWithdrawMessage(inputs: WithdrawInputs): Promise<Message & {
         domain: SignatureDomain;
     }>;
+    abstract generateInternalTransferMessage(inputs: InternalTransferInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
     abstract generateSettleMessage(inputs: SettleInputs): Promise<Message & {
         domain: SignatureDomain;
     }>;
     abstract generateAddOrderlyKeyMessage(inputs: AddOrderlyKeyInputs): Promise<Message>;
+    abstract generateDexRequestMessage(inputs: DexRequestInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
     abstract getBalance(): Promise<bigint>;
     abstract chainNamespace: ChainNamespace;
     signMessageByOrderlyKey(payload: any): Promise<SignedMessagePayload>;
@@ -1270,4 +1433,4 @@ declare class EtherAdapter implements IWalletAdapter {
     getContract(address: string, abi: any): ethers.Contract;
 }
 
-export { API_URLS, Account, type AccountState, type AddOrderlyKeyInputs, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, BaseWalletAdapter, type ChainType, type ConfigKey, type ConfigStore, DefaultConfigStore, EVENT_NAMES, type Ed25519Keypair, EtherAdapter, type IContract, LocalStorageStore, type Message, type MessageFactor, MockKeyStore, type OrderlyKeyPair, type OrderlyKeyStore, type RegisterAccountInputs, type SettleInputs, type SignatureDomain, type SignedMessagePayload, type Signer, SimpleDI, type SubAccount, type URLS, type WalletAdapter, type WalletAdapterOptions, type WithdrawInputs, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, type getWalletAdapterFunc, utils };
+export { API_URLS, Account, type AccountState, type AddOrderlyKeyInputs, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, BaseWalletAdapter, type ChainType, type ConfigKey, type ConfigStore, DefaultConfigStore, type DexRequestInputs, EVENT_NAMES, type Ed25519Keypair, EtherAdapter, type IContract, type InternalTransferInputs, LocalStorageStore, type Message, type MessageFactor, MockKeyStore, type OrderlyKeyPair, type OrderlyKeyStore, type RegisterAccountInputs, type SettleInputs, type SignatureDomain, type SignedMessagePayload, type Signer, SimpleDI, type SubAccount, type URLS, type WalletAdapter, type WalletAdapterOptions, type WithdrawInputs, generateAddOrderlyKeyMessage, generateDexRequestMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, type getWalletAdapterFunc, utils };