@orderly.network/core 1.5.12 → 2.0.0-alpha.0

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import EventEmitter from 'eventemitter3';
 export { default as EventEmitter } from 'eventemitter3';
-import { definedTypes, API, AccountStatusEnum } from '@orderly.network/types';
+import { definedTypes, API, ChainNamespace, AccountStatusEnum } from '@orderly.network/types';
+import { BigNumberish } from 'ethers/src.ts/utils';
 import { parseUnits, TransactionResponse, ethers } from 'ethers';
 
 interface OrderlyKeyPair {
@@ -24,6 +25,7 @@ interface OrderlyKeyStore {
     setAccountId: (address: string, accountId: string) => void;
     getAddress: () => string | undefined | null;
     setAddress: (address: string) => void;
+    removeAddress: () => void;
     generateKey: () => OrderlyKeyPair;
     cleanKey: (address: string, key: string) => void;
     cleanAllKey: (address: string) => void;
@@ -37,6 +39,7 @@ declare abstract class BaseKeyStore implements OrderlyKeyStore {
     abstract setAccountId(address: string, accountId: string): void;
     abstract getAddress(): string | undefined | null;
     abstract setAddress(address: string): void;
+    abstract removeAddress(): void;
     abstract generateKey(): OrderlyKeyPair;
     abstract setKey(orderlyKey: string, secretKey: OrderlyKeyPair): void;
     abstract cleanAllKey(address: string): void;
@@ -49,6 +52,7 @@ declare class LocalStorageStore extends BaseKeyStore {
     setAccountId(address: string, accountId: string): void;
     getAddress(): string | undefined | null;
     setAddress(address: string): void;
+    removeAddress(): void;
     generateKey(): OrderlyKeyPair;
     setKey(address: string, orderlyKey: OrderlyKeyPair): void;
     cleanAllKey(address: string): void;
@@ -65,6 +69,7 @@ declare class MockKeyStore implements OrderlyKeyStore {
     setAccountId(accountId: string): void;
     getAddress(): string;
     setAddress(address: string): void;
+    removeAddress(): void;
     setKey(orderlyKey: string, secretKey: OrderlyKeyPair): void;
     cleanAllKey(): void;
     cleanKey(key: string): void;
@@ -124,7 +129,7 @@ declare function parseBrokerHash(brokerId: string): string;
 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 formatByUnits(amount: BigNumberish, unit?: number | "ether" | "gwei"): string;
 declare function isHex(value: string): boolean;
 declare function isHexString(value: string): boolean;
 declare const getGlobalObject: () => typeof globalThis;
@@ -143,20 +148,7 @@ declare const utils_parseBrokerHash: typeof parseBrokerHash;
 declare const utils_parseTokenHash: typeof parseTokenHash;
 declare const utils_parseUnits: typeof parseUnits;
 declare namespace utils {
-  export {
-    utils_SignatureDomain as SignatureDomain,
-    utils_base64url as base64url,
-    utils_calculateStringHash as calculateStringHash,
-    utils_formatByUnits as formatByUnits,
-    utils_getGlobalObject as getGlobalObject,
-    utils_getTimestamp as getTimestamp,
-    utils_isHex as isHex,
-    utils_isHexString as isHexString,
-    utils_parseAccountId as parseAccountId,
-    utils_parseBrokerHash as parseBrokerHash,
-    utils_parseTokenHash as parseTokenHash,
-    utils_parseUnits as parseUnits,
-  };
+  export { type utils_SignatureDomain as SignatureDomain, utils_base64url as base64url, utils_calculateStringHash as calculateStringHash, utils_formatByUnits as formatByUnits, utils_getGlobalObject as getGlobalObject, utils_getTimestamp as getTimestamp, utils_isHex as isHex, utils_isHexString as isHexString, utils_parseAccountId as parseAccountId, utils_parseBrokerHash as parseBrokerHash, utils_parseTokenHash as parseTokenHash, utils_parseUnits as parseUnits };
 }
 
 declare const getMockSigner: (secretKey?: string) => BaseSigner;
@@ -227,7 +219,10 @@ declare function generateAddOrderlyKeyMessage(inputs: {
     primaryType: keyof typeof definedTypes;
     expiration?: number;
     timestamp?: number;
+    scope?: string;
+    tag?: string;
 }): readonly [{
+    tag?: string | undefined;
     brokerId: string;
     orderlyKey: string;
     scope: string;
@@ -242,6 +237,7 @@ declare function generateAddOrderlyKeyMessage(inputs: {
         verifyingContract: string;
     };
     message: {
+        tag?: string | undefined;
         brokerId: string;
         orderlyKey: string;
         scope: string;
@@ -249,7 +245,7 @@ declare function generateAddOrderlyKeyMessage(inputs: {
         timestamp: number;
         expiration: number;
     };
-    primaryType: "Registration" | "EIP712Domain" | "Withdraw" | "AddOrderlyKey" | "SettlePnl";
+    primaryType: "EIP712Domain" | "Registration" | "Withdraw" | "AddOrderlyKey" | "SettlePnl";
     types: {
         [x: string]: readonly [{
             readonly name: "name";
@@ -412,6 +408,8 @@ type OrderlyContracts = {
     vaultAddress: string;
     vaultAbi: any;
     verifyContractAddress: string;
+    solanaUSDCAddress: string;
+    solanaVaultAddress: string;
 };
 interface IContract {
     getContractInfoByEnv(): OrderlyContracts;
@@ -462,6 +460,8 @@ declare class BaseContract implements IContract {
             anonymous?: undefined;
         })[];
         vaultAddress: string;
+        solanaVaultAddress: string;
+        solanaUSDCAddress: string;
         vaultAbi: ({
             inputs: never[];
             stateMutability: string;
@@ -575,46 +575,6 @@ declare class SimpleDI {
     private constructor();
 }
 
-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>;
-    sendTransaction(contractAddress: string, method: string, payload: {
-        from: string;
-        to?: string;
-        data: any[];
-        value?: bigint;
-    }, 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;
-    }): 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;
-}
-type WalletAdapterOptions = {
-    provider: any;
-    address: string;
-    chain: {
-        id: number;
-    };
-};
-type getWalletAdapterFunc = (options: WalletAdapterOptions) => IWalletAdapter;
-
 declare class Assets {
     private readonly configStore;
     private readonly contractManger;
@@ -626,7 +586,6 @@ declare class Assets {
         amount: string | number;
         allowCrossChainWithdraw: boolean;
     }): Promise<any>;
-    private _generateWithdrawMessage;
     private getWithdrawalNonce;
     getNativeBalance(options?: {
         decimals?: number;
@@ -634,26 +593,119 @@ declare class Assets {
     getBalance(address?: string, options?: {
         decimals?: number;
     }): Promise<string>;
-    getBalanceByAddress(address: string): Promise<string>;
-    getAllowance(address?: string, vaultAddress?: string): Promise<string>;
-    approve(address?: string, amount?: string, vaultAddress?: string): Promise<any>;
-    approveByAddress(inputs: {
+    getBalanceByAddress(address: string, options?: {
+        decimals?: number;
+    }): Promise<string>;
+    getAllowance(inputs?: string | {
+        address?: string;
+        vaultAddress?: string;
+        decimals?: number;
+    }, _vaultAddress?: string): Promise<string>;
+    approve(inputs?: string | {
+        address?: string;
         amount?: string;
+        vaultAddress?: string;
+        decimals?: number;
+    }, _amount?: string, _vaultAddress?: string): Promise<any>;
+    approveByAddress(inputs: {
         address: string;
+        amount?: string;
+        decimals?: number;
     }): Promise<any>;
-    private _approve;
-    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>;
+    deposit(amount: string, fee?: bigint): Promise<any>;
     private _simpleFetch;
     get usdcAddress(): string;
 }
 
+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;
+};
+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;
     /**
@@ -663,10 +715,12 @@ interface AccountState {
     accountId?: string;
     userId?: string;
     address?: string;
+    chainNamespace?: ChainNamespace;
     /** new account */
     isNew?: boolean;
     connectWallet?: {
         name: string;
+        chainId: number;
     };
 }
 /**
@@ -680,16 +734,14 @@ interface AccountState {
 declare class Account {
     private readonly configStore;
     readonly keyStore: OrderlyKeyStore;
-    private readonly getWalletAdapter;
     static instanceName: string;
     private _singer?;
     private _ee;
+    private walletAdapterManager;
     assetsManager: Assets;
     private _state;
     private readonly contractManger;
-    walletClient?: IWalletAdapter;
-    constructor(configStore: ConfigStore, keyStore: OrderlyKeyStore, getWalletAdapter: getWalletAdapterFunc, // private readonly walletAdapterClass: { new (options: any): WalletAdapter } // private walletClient?: WalletClient
-    options?: Partial<{
+    constructor(configStore: ConfigStore, keyStore: OrderlyKeyStore, walletAdapters: WalletAdapter[], options?: Partial<{
         /**
          * smart contract configuration class
          * provide contract address and abi
@@ -697,12 +749,13 @@ declare class Account {
         contracts: IContract;
     }>);
     logout(): void;
-    setAddress(address: string, wallet?: {
+    setAddress(address: string, wallet: {
         provider: any;
         chain: {
             id: string | number;
+            namespace: ChainNamespace;
         };
-        wallet?: {
+        wallet: {
             name: string;
         };
         [key: string]: any;
@@ -712,28 +765,35 @@ declare class Account {
     get accountIdHashStr(): string | undefined;
     get address(): string | undefined;
     get chainId(): number | string | undefined;
-    /**
-     * set user positions count
-     */
     private _bindEvents;
     private _checkAccount;
     private _checkAccountExist;
     createAccount(): Promise<any>;
-    signTypedData(toSignatureMessage: Record<string, any>): Promise<string>;
-    createOrderlyKey(expiration?: number): Promise<any>;
+    createApiKey(expiration?: number, options?: {
+        tag?: string;
+        scope?: string;
+    }): Promise<{
+        key: string;
+        secretKey: string;
+    }>;
+    createOrderlyKey(expiration?: number, options?: {
+        tag?: string;
+        scope?: string;
+    }): Promise<any>;
+    private generateAPiKey;
     settle(): Promise<any>;
+    destoryOrderlyKey(): Promise<void>;
     disconnect(): Promise<void>;
     switchChainId(chainId: number | string): void;
     private parseChainId;
     private _checkOrderlyKeyState;
     get signer(): Signer;
-    get wallet(): IWalletAdapter | undefined;
+    get walletAdapter(): WalletAdapter<any> | undefined;
     private _getRegisterationNonce;
     private _getTimestampFromServer;
     private _getAccountInfo;
     private _getSettleNonce;
     private _simpleFetch;
-    getDomain(onChainDomain?: boolean): SignatureDomain;
     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 | undefined) => EventEmitter<string | symbol, any>;
@@ -748,13 +808,96 @@ declare class DefaultConfigStore implements ConfigStore {
     clear(): void;
 }
 
+declare abstract class BaseWalletAdapter<Config> implements WalletAdapter<Config> {
+    abstract generateRegisterAccountMessage(inputs: RegisterAccountInputs): Promise<Message>;
+    abstract generateWithdrawMessage(inputs: WithdrawInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
+    abstract generateSettleMessage(inputs: SettleInputs): Promise<Message & {
+        domain: SignatureDomain;
+    }>;
+    abstract generateAddOrderlyKeyMessage(inputs: AddOrderlyKeyInputs): Promise<Message>;
+    abstract getBalance(): Promise<bigint>;
+    abstract chainNamespace: ChainNamespace;
+    abstract call(address: string, method: string, params: any[], options?: {
+        abi: any;
+    }): Promise<any>;
+    abstract sendTransaction(contractAddress: string, method: string, payload: {
+        from: string;
+        to?: string;
+        data: any[];
+        value?: bigint;
+    }, options: {
+        abi: any;
+    }): Promise<any>;
+    abstract callOnChain(chain: API.NetworkInfos, address: string, method: string, params: any[], options: {
+        abi: any;
+    }): Promise<any>;
+    get address(): string;
+    get chainId(): number;
+    active(config: Config): void;
+    abstract deactivate(): void;
+    update(config: Config): void;
+    generateSecretKey(): string;
+    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;
+    abstract pollTransactionReceiptWithBackoff(txHash: string, baseInterval?: number, maxInterval?: number, maxRetries?: number): Promise<any>;
+}
+
+interface Ed25519Keypair {
+    secretKey: string;
+    publicKey: string;
+}
+
+interface IWalletAdapter {
+    get chainId(): number;
+    get addresses(): string;
+    /**
+     * Set the chain id
+     */
+    set chainId(chainId: number);
+    parseUnits: (amount: string, decimals?: number) => string;
+    formatUnits: (amount: string, decimals?: number) => string;
+    send: (method: string, params: Array<any> | Record<string, any>) => Promise<any>;
+    sendTransaction(contractAddress: string, method: string, payload: {
+        from: string;
+        to?: string;
+        data: any[];
+        value?: bigint;
+    }, 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;
+    }): 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;
+}
+type WalletAdapterOptions = {
+    provider: any;
+    address: string;
+    chain: {
+        id: number;
+    };
+};
+type getWalletAdapterFunc = (options: WalletAdapterOptions) => IWalletAdapter;
+
 declare class EtherAdapter implements IWalletAdapter {
     private provider?;
     private _chainId;
     private _address;
     constructor(options: WalletAdapterOptions);
-    parseUnits(amount: string): string;
-    formatUnits(amount: string): string;
+    parseUnits(amount: string, decimals?: number): string;
+    formatUnits(amount: string, decimals?: number): string;
     getBalance(userAddress: string): Promise<any>;
     deposit(from: string, to: string, amount: string): Promise<any>;
     call(address: string, method: string, params: any[], options: {
@@ -789,4 +932,4 @@ declare class EtherAdapter implements IWalletAdapter {
     getContract(address: string, abi: any): ethers.Contract;
 }
 
-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 };
+export { Account, type AccountState, type AddOrderlyKeyInputs, BaseContract as BaseContractManager, BaseKeyStore, BaseOrderlyKeyPair, BaseSigner, BaseWalletAdapter, type ChainType, type ConfigKey, type ConfigStore, DefaultConfigStore, 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 WalletAdapter, type WalletAdapterOptions, type WithdrawInputs, generateAddOrderlyKeyMessage, generateRegisterAccountMessage, generateSettleMessage, getDefaultSigner, getMockSigner, type getWalletAdapterFunc, utils };