@orderly.network/core 0.0.3

package/dist/index.d.mts

@@ -0,0 +1,323 @@
+import { BehaviorSubject } from 'rxjs';
+
+interface OrderlyKeyPair {
+    getPublicKey(): Promise<string>;
+    secretKey: string;
+    sign: (data: Uint8Array) => Promise<Uint8Array>;
+}
+declare class BaseOrderlyKeyPair implements OrderlyKeyPair {
+    secretKey: string;
+    constructor(secretKey: string);
+    sign(message: Uint8Array): Promise<Uint8Array>;
+    getPublicKey(): Promise<string>;
+}
+
+interface KeyStore {
+    getOrderlyKey: () => OrderlyKeyPair;
+    generateKey: () => OrderlyKeyPair;
+    setKey: (orderlyKey: string, secretKey: string) => void;
+}
+declare class LocalStorageStore implements KeyStore {
+    private readonly networkId;
+    private readonly accountId;
+    constructor(networkId: string, accountId: string);
+    getOrderlyKey(): OrderlyKeyPair;
+    generateKey(): BaseOrderlyKeyPair;
+    setKey(orderlyKey: string, secretKey: string): void;
+    private get _keyPrefix();
+}
+declare class MockKeyStore implements KeyStore {
+    private readonly secretKey;
+    constructor(secretKey: string);
+    generateKey(): BaseOrderlyKeyPair;
+    getOrderlyKey(): BaseOrderlyKeyPair;
+    setKey(orderlyKey: string, secretKey: string): void;
+}
+
+type MessageFactor = {
+    url: string;
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    data?: any;
+};
+type SignedMessagePayload = {
+    "orderly-key": string;
+    "orderly-timestamp": string;
+    "orderly-signature": string;
+};
+/**
+ * 签名
+ * @example
+ * ```ts
+ * const signer = new BaseSigner(keyStore);
+ * const payload = await signer.sign({
+ *  url: "https://api.orderly.io/get_account?address=0x1234567890&brokerId=woofi_dex",
+ *   method: "GET",
+ *   data: {
+ *     address: "0x1234567890",
+ *     brokerId: "woofi_dex",
+ *    },
+ *  });
+ *  ```
+ */
+interface Signer {
+    sign: (data: MessageFactor) => Promise<SignedMessagePayload>;
+}
+declare class BaseSigner implements Signer {
+    private readonly keyStore;
+    constructor(keyStore: KeyStore);
+    sign(message: MessageFactor): Promise<SignedMessagePayload>;
+    signText(text: string): Promise<{
+        signature: string;
+        publicKey: string;
+    }>;
+}
+
+interface ConfigStore {
+    get<T>(key: string): T;
+    set<T>(key: string, value: T): void;
+    clear(): void;
+}
+declare class MemoryConfigStore implements ConfigStore {
+    private map;
+    constructor();
+    private _restore;
+    get<T>(key: string): T;
+    set<T>(key: string, value: T): void;
+    clear(): void;
+}
+
+declare const getMockSigner: (secretKey?: string) => BaseSigner;
+declare const getDefaultSigner: () => BaseSigner;
+
+declare class SimpleDI {
+    private static container;
+    private static getContainer;
+    static register(...serviceClasses: any[]): void;
+    static registerByName(name: string, serviceClass: any): void;
+    static get<T = any>(name: string): T;
+    static getAll(): {
+        [name: string]: any;
+    };
+    private constructor();
+}
+
+interface WalletClient {
+    get address(): string;
+    getBalance: () => Promise<any>;
+    deposit: () => Promise<any>;
+    connect: () => Promise<any>;
+}
+declare abstract class BaseWalletClient implements WalletClient {
+    private readonly _address;
+    constructor(_address: string);
+    abstract getBalance(): Promise<any>;
+    abstract deposit(): Promise<any>;
+    abstract connect(): Promise<any>;
+    get address(): string;
+}
+declare class SimpleWallet extends BaseWalletClient {
+    getBalance(): Promise<any>;
+    deposit(): Promise<any>;
+    connect(): Promise<any>;
+}
+
+type wallet_BaseWalletClient = BaseWalletClient;
+declare const wallet_BaseWalletClient: typeof BaseWalletClient;
+type wallet_SimpleWallet = SimpleWallet;
+declare const wallet_SimpleWallet: typeof SimpleWallet;
+type wallet_WalletClient = WalletClient;
+declare namespace wallet {
+  export {
+    wallet_BaseWalletClient as BaseWalletClient,
+    wallet_SimpleWallet as SimpleWallet,
+    wallet_WalletClient as WalletClient,
+  };
+}
+
+type AccountStatus = "NotConnected" | "Connected" | "NotSignedIn" | "SignedIn";
+declare enum AccountStatusEnum {
+    NotConnected = 0,
+    Connected = 1,
+    NotSignedIn = 2,
+    SignedIn = 3,
+    EnableTrading = 4
+}
+interface AccountState {
+    status: AccountStatus;
+    accountId?: string;
+    userId?: string;
+    address?: string;
+    balance: string;
+    leverage: number;
+    positon?: string[];
+    orders?: string[];
+}
+/**
+ * 账户
+ * @example
+ * ```ts
+ * const account = new Account();
+ * account.login("0x1234567890");
+ * ```
+ */
+declare class Account {
+    private readonly configStore;
+    private walletClient?;
+    private _state$;
+    constructor(configStore: ConfigStore, walletClient?: WalletClient | undefined);
+    /**
+     * 登录
+     * @param address 钱包地址
+     */
+    login(address: string): void;
+    logout(): void;
+    /**
+     * 连接钱包先用第三方的React版本，不用自己实现
+     */
+    /**
+     * 为账户设置钱包
+     */
+    set wallet(wallet: WalletClient | string);
+    get state$(): BehaviorSubject<AccountState>;
+    get stateValue(): AccountState;
+    /**
+     * set user positions count
+     */
+    set position(position: string[]);
+    set orders(orders: string[]);
+    private _checkAccount;
+    private _checkAccountExist;
+    private getAccountInfo;
+    private getBalance;
+    private _fetch;
+}
+
+declare namespace API {
+    interface Token {
+        token: string;
+        token_hash: string;
+        decimals: number;
+        minimum_withdraw_amount: number;
+        chain_details: ChainDetail[];
+    }
+    interface ChainDetail {
+        chain_id: string;
+        contract_address: string;
+        decimals: number;
+    }
+    interface MarketInfo {
+        symbol: string;
+        index_price: number;
+        mark_price: number;
+        sum_unitary_funding: number;
+        est_funding_rate: number;
+        last_funding_rate: number;
+        next_funding_time: number;
+        open_interest: string;
+        "24h_open": number;
+        "24h_close": number;
+        "24h_high": number;
+        "24h_low": number;
+        "24h_volumn": number;
+        "24h_amount": number;
+    }
+    /**
+     * v1/public/info
+     */
+    interface Symbol {
+        symbol: string;
+        quote_min: number;
+        quote_max: number;
+        quote_tick: number;
+        base_min: number;
+        base_max: number;
+        base_tick: number;
+        min_notional: number;
+        price_range: number;
+        price_scope: number;
+        std_liquidation_fee: number;
+        liquidator_fee: number;
+        claim_insurance_fund_discount: number;
+        funding_period: number;
+        cap_funding: number;
+        floor_funding: number;
+        interest_rate: number;
+        created_time: number;
+        updated_time: number;
+        imr_factor: number;
+        base_mmr: number;
+        base_imr: number;
+    }
+    interface SymbolExt extends Symbol {
+        base: string;
+        quote: string;
+        type: string;
+    }
+    interface Order {
+        symbol: string;
+        status: string;
+        side: string;
+        order_id: number;
+        user_id: number;
+        price: number | null;
+        type: string;
+        quantity: number;
+        amount: null;
+        visible: number;
+        executed: number;
+        total_fee: number;
+        fee_asset: string;
+        client_order_id: null;
+        average_executed_price: number;
+        created_time: number;
+        updated_time: number;
+        reduce_only: boolean;
+    }
+    interface PositionInfo {
+        margin_ratio: number;
+        initial_margin_ratio: number;
+        maintenance_margin_ratio: number;
+        open_margin_ratio: number;
+        current_margin_ratio_with_orders: number;
+        initial_margin_ratio_with_orders: number;
+        maintenance_margin_ratio_with_orders: number;
+        total_collateral_value: number;
+        free_collateral: number;
+        rows: Position[];
+        total_pnl_24_h: number;
+    }
+    interface Position {
+        symbol: string;
+        position_qty: number;
+        cost_position: number;
+        last_sum_unitary_funding: number;
+        pending_long_qty: number;
+        pending_short_qty: number;
+        settle_price: number;
+        average_open_price: number;
+        unsettled_pnl: number;
+        mark_price: number;
+        est_liq_price: number;
+        timestamp: number;
+        mmr: number;
+        imr: number;
+        IMR_withdraw_orders: number;
+        MMR_with_orders: number;
+        pnl_24_h: number;
+        fee_24_h: number;
+    }
+}
+declare namespace WSMessage {
+    interface Ticker {
+        symbol: string;
+        open: number;
+        close: number;
+        high: number;
+        low: number;
+        volume: number;
+        amount: number;
+        count: number;
+    }
+}
+
+export { API, Account, AccountState, AccountStatusEnum, BaseSigner, ConfigStore, KeyStore, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, SignedMessagePayload, Signer, SimpleDI, WSMessage, getDefaultSigner, getMockSigner, wallet };

package/dist/index.d.ts

@@ -0,0 +1,323 @@
+import { BehaviorSubject } from 'rxjs';
+
+interface OrderlyKeyPair {
+    getPublicKey(): Promise<string>;
+    secretKey: string;
+    sign: (data: Uint8Array) => Promise<Uint8Array>;
+}
+declare class BaseOrderlyKeyPair implements OrderlyKeyPair {
+    secretKey: string;
+    constructor(secretKey: string);
+    sign(message: Uint8Array): Promise<Uint8Array>;
+    getPublicKey(): Promise<string>;
+}
+
+interface KeyStore {
+    getOrderlyKey: () => OrderlyKeyPair;
+    generateKey: () => OrderlyKeyPair;
+    setKey: (orderlyKey: string, secretKey: string) => void;
+}
+declare class LocalStorageStore implements KeyStore {
+    private readonly networkId;
+    private readonly accountId;
+    constructor(networkId: string, accountId: string);
+    getOrderlyKey(): OrderlyKeyPair;
+    generateKey(): BaseOrderlyKeyPair;
+    setKey(orderlyKey: string, secretKey: string): void;
+    private get _keyPrefix();
+}
+declare class MockKeyStore implements KeyStore {
+    private readonly secretKey;
+    constructor(secretKey: string);
+    generateKey(): BaseOrderlyKeyPair;
+    getOrderlyKey(): BaseOrderlyKeyPair;
+    setKey(orderlyKey: string, secretKey: string): void;
+}
+
+type MessageFactor = {
+    url: string;
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    data?: any;
+};
+type SignedMessagePayload = {
+    "orderly-key": string;
+    "orderly-timestamp": string;
+    "orderly-signature": string;
+};
+/**
+ * 签名
+ * @example
+ * ```ts
+ * const signer = new BaseSigner(keyStore);
+ * const payload = await signer.sign({
+ *  url: "https://api.orderly.io/get_account?address=0x1234567890&brokerId=woofi_dex",
+ *   method: "GET",
+ *   data: {
+ *     address: "0x1234567890",
+ *     brokerId: "woofi_dex",
+ *    },
+ *  });
+ *  ```
+ */
+interface Signer {
+    sign: (data: MessageFactor) => Promise<SignedMessagePayload>;
+}
+declare class BaseSigner implements Signer {
+    private readonly keyStore;
+    constructor(keyStore: KeyStore);
+    sign(message: MessageFactor): Promise<SignedMessagePayload>;
+    signText(text: string): Promise<{
+        signature: string;
+        publicKey: string;
+    }>;
+}
+
+interface ConfigStore {
+    get<T>(key: string): T;
+    set<T>(key: string, value: T): void;
+    clear(): void;
+}
+declare class MemoryConfigStore implements ConfigStore {
+    private map;
+    constructor();
+    private _restore;
+    get<T>(key: string): T;
+    set<T>(key: string, value: T): void;
+    clear(): void;
+}
+
+declare const getMockSigner: (secretKey?: string) => BaseSigner;
+declare const getDefaultSigner: () => BaseSigner;
+
+declare class SimpleDI {
+    private static container;
+    private static getContainer;
+    static register(...serviceClasses: any[]): void;
+    static registerByName(name: string, serviceClass: any): void;
+    static get<T = any>(name: string): T;
+    static getAll(): {
+        [name: string]: any;
+    };
+    private constructor();
+}
+
+interface WalletClient {
+    get address(): string;
+    getBalance: () => Promise<any>;
+    deposit: () => Promise<any>;
+    connect: () => Promise<any>;
+}
+declare abstract class BaseWalletClient implements WalletClient {
+    private readonly _address;
+    constructor(_address: string);
+    abstract getBalance(): Promise<any>;
+    abstract deposit(): Promise<any>;
+    abstract connect(): Promise<any>;
+    get address(): string;
+}
+declare class SimpleWallet extends BaseWalletClient {
+    getBalance(): Promise<any>;
+    deposit(): Promise<any>;
+    connect(): Promise<any>;
+}
+
+type wallet_BaseWalletClient = BaseWalletClient;
+declare const wallet_BaseWalletClient: typeof BaseWalletClient;
+type wallet_SimpleWallet = SimpleWallet;
+declare const wallet_SimpleWallet: typeof SimpleWallet;
+type wallet_WalletClient = WalletClient;
+declare namespace wallet {
+  export {
+    wallet_BaseWalletClient as BaseWalletClient,
+    wallet_SimpleWallet as SimpleWallet,
+    wallet_WalletClient as WalletClient,
+  };
+}
+
+type AccountStatus = "NotConnected" | "Connected" | "NotSignedIn" | "SignedIn";
+declare enum AccountStatusEnum {
+    NotConnected = 0,
+    Connected = 1,
+    NotSignedIn = 2,
+    SignedIn = 3,
+    EnableTrading = 4
+}
+interface AccountState {
+    status: AccountStatus;
+    accountId?: string;
+    userId?: string;
+    address?: string;
+    balance: string;
+    leverage: number;
+    positon?: string[];
+    orders?: string[];
+}
+/**
+ * 账户
+ * @example
+ * ```ts
+ * const account = new Account();
+ * account.login("0x1234567890");
+ * ```
+ */
+declare class Account {
+    private readonly configStore;
+    private walletClient?;
+    private _state$;
+    constructor(configStore: ConfigStore, walletClient?: WalletClient | undefined);
+    /**
+     * 登录
+     * @param address 钱包地址
+     */
+    login(address: string): void;
+    logout(): void;
+    /**
+     * 连接钱包先用第三方的React版本，不用自己实现
+     */
+    /**
+     * 为账户设置钱包
+     */
+    set wallet(wallet: WalletClient | string);
+    get state$(): BehaviorSubject<AccountState>;
+    get stateValue(): AccountState;
+    /**
+     * set user positions count
+     */
+    set position(position: string[]);
+    set orders(orders: string[]);
+    private _checkAccount;
+    private _checkAccountExist;
+    private getAccountInfo;
+    private getBalance;
+    private _fetch;
+}
+
+declare namespace API {
+    interface Token {
+        token: string;
+        token_hash: string;
+        decimals: number;
+        minimum_withdraw_amount: number;
+        chain_details: ChainDetail[];
+    }
+    interface ChainDetail {
+        chain_id: string;
+        contract_address: string;
+        decimals: number;
+    }
+    interface MarketInfo {
+        symbol: string;
+        index_price: number;
+        mark_price: number;
+        sum_unitary_funding: number;
+        est_funding_rate: number;
+        last_funding_rate: number;
+        next_funding_time: number;
+        open_interest: string;
+        "24h_open": number;
+        "24h_close": number;
+        "24h_high": number;
+        "24h_low": number;
+        "24h_volumn": number;
+        "24h_amount": number;
+    }
+    /**
+     * v1/public/info
+     */
+    interface Symbol {
+        symbol: string;
+        quote_min: number;
+        quote_max: number;
+        quote_tick: number;
+        base_min: number;
+        base_max: number;
+        base_tick: number;
+        min_notional: number;
+        price_range: number;
+        price_scope: number;
+        std_liquidation_fee: number;
+        liquidator_fee: number;
+        claim_insurance_fund_discount: number;
+        funding_period: number;
+        cap_funding: number;
+        floor_funding: number;
+        interest_rate: number;
+        created_time: number;
+        updated_time: number;
+        imr_factor: number;
+        base_mmr: number;
+        base_imr: number;
+    }
+    interface SymbolExt extends Symbol {
+        base: string;
+        quote: string;
+        type: string;
+    }
+    interface Order {
+        symbol: string;
+        status: string;
+        side: string;
+        order_id: number;
+        user_id: number;
+        price: number | null;
+        type: string;
+        quantity: number;
+        amount: null;
+        visible: number;
+        executed: number;
+        total_fee: number;
+        fee_asset: string;
+        client_order_id: null;
+        average_executed_price: number;
+        created_time: number;
+        updated_time: number;
+        reduce_only: boolean;
+    }
+    interface PositionInfo {
+        margin_ratio: number;
+        initial_margin_ratio: number;
+        maintenance_margin_ratio: number;
+        open_margin_ratio: number;
+        current_margin_ratio_with_orders: number;
+        initial_margin_ratio_with_orders: number;
+        maintenance_margin_ratio_with_orders: number;
+        total_collateral_value: number;
+        free_collateral: number;
+        rows: Position[];
+        total_pnl_24_h: number;
+    }
+    interface Position {
+        symbol: string;
+        position_qty: number;
+        cost_position: number;
+        last_sum_unitary_funding: number;
+        pending_long_qty: number;
+        pending_short_qty: number;
+        settle_price: number;
+        average_open_price: number;
+        unsettled_pnl: number;
+        mark_price: number;
+        est_liq_price: number;
+        timestamp: number;
+        mmr: number;
+        imr: number;
+        IMR_withdraw_orders: number;
+        MMR_with_orders: number;
+        pnl_24_h: number;
+        fee_24_h: number;
+    }
+}
+declare namespace WSMessage {
+    interface Ticker {
+        symbol: string;
+        open: number;
+        close: number;
+        high: number;
+        low: number;
+        volume: number;
+        amount: number;
+        count: number;
+    }
+}
+
+export { API, Account, AccountState, AccountStatusEnum, BaseSigner, ConfigStore, KeyStore, LocalStorageStore, MemoryConfigStore, MessageFactor, MockKeyStore, SignedMessagePayload, Signer, SimpleDI, WSMessage, getDefaultSigner, getMockSigner, wallet };