@orderly.network/types 0.0.2

package/dist/index.d.mts

@@ -0,0 +1,224 @@
+declare enum AccountStatusEnum {
+    NotConnected = 0,
+    Connected = 1,
+    NotSignedIn = 2,
+    SignedIn = 3,
+    DisabledTrading = 4,
+    EnableTrading = 5
+}
+
+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;
+    }
+    interface MarketInfoExt extends MarketInfo {
+        change: 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 TokenInfo {
+        token: string;
+        token_hash: string;
+        decimals: number;
+        minimum_withdraw_amount: number;
+        chain_details: ChainDetail[];
+    }
+    interface ChainDetail {
+        chain_id: string;
+        contract_address: string;
+        decimals: number;
+        withdrawal_fee: number;
+    }
+    interface SymbolExt extends Symbol {
+        base: string;
+        quote: string;
+        type: string;
+        name: 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 OrderExt extends Order {
+        mark_price: string;
+    }
+    interface FundingRate {
+        symbol: string;
+        est_funding_rate: number;
+        est_funding_rate_timestamp: number;
+        last_funding_rate: number;
+        last_funding_rate_timestamp: number;
+        next_funding_time: number;
+        sum_unitary_funding: number;
+    }
+    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;
+    }
+    interface Holding {
+        token: string;
+        holding: number;
+        frozen: number;
+        pending_short: number;
+        updated_time: number;
+    }
+    interface AccountInfo {
+        account_id: string;
+        email: string;
+        account_mode: string;
+        tier: string;
+        futures_tier: string;
+        maintenance_cancel_orders: boolean;
+        taker_fee_rate: number;
+        maker_fee_rate: number;
+        max_leverage: number;
+        futures_taker_fee_rate: number;
+        futures_maker_fee_rate: number;
+        imr_factor: {
+            [key: string]: number;
+        };
+        max_notional: {
+            [key: string]: number;
+        };
+    }
+}
+declare namespace WSMessage {
+    interface Ticker {
+        symbol: string;
+        open: number;
+        close: number;
+        high: number;
+        low: number;
+        volume: number;
+        amount: number;
+        count: number;
+    }
+    interface MarkPrice {
+        symbol: string;
+        price: number;
+    }
+}
+
+declare enum OrderType {
+    LIMIT = "LIMIT",
+    MARKET = "MARKET",
+    IOC = "IOC",
+    FOK = "FOK",
+    POST_ONLY = "POST_ONLY",
+    ASK = "ASK",
+    BID = "BID"
+}
+declare enum OrderSide {
+    BUY = "BUY",
+    SELL = "SELL"
+}
+interface OrderEntity {
+    symbol?: string;
+    order_type: OrderType;
+    order_type_ext?: OrderType;
+    order_price?: string | number;
+    order_quantity?: string | number;
+    order_amount?: number;
+    visible_quantity?: number;
+    reduce_only?: boolean;
+    side: OrderSide;
+    broker_id?: string;
+    total?: string | number;
+}
+
+export { API, AccountStatusEnum, OrderEntity, OrderSide, OrderType, WSMessage };

package/dist/index.d.ts

@@ -0,0 +1,224 @@
+declare enum AccountStatusEnum {
+    NotConnected = 0,
+    Connected = 1,
+    NotSignedIn = 2,
+    SignedIn = 3,
+    DisabledTrading = 4,
+    EnableTrading = 5
+}
+
+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;
+    }
+    interface MarketInfoExt extends MarketInfo {
+        change: 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 TokenInfo {
+        token: string;
+        token_hash: string;
+        decimals: number;
+        minimum_withdraw_amount: number;
+        chain_details: ChainDetail[];
+    }
+    interface ChainDetail {
+        chain_id: string;
+        contract_address: string;
+        decimals: number;
+        withdrawal_fee: number;
+    }
+    interface SymbolExt extends Symbol {
+        base: string;
+        quote: string;
+        type: string;
+        name: 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 OrderExt extends Order {
+        mark_price: string;
+    }
+    interface FundingRate {
+        symbol: string;
+        est_funding_rate: number;
+        est_funding_rate_timestamp: number;
+        last_funding_rate: number;
+        last_funding_rate_timestamp: number;
+        next_funding_time: number;
+        sum_unitary_funding: number;
+    }
+    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;
+    }
+    interface Holding {
+        token: string;
+        holding: number;
+        frozen: number;
+        pending_short: number;
+        updated_time: number;
+    }
+    interface AccountInfo {
+        account_id: string;
+        email: string;
+        account_mode: string;
+        tier: string;
+        futures_tier: string;
+        maintenance_cancel_orders: boolean;
+        taker_fee_rate: number;
+        maker_fee_rate: number;
+        max_leverage: number;
+        futures_taker_fee_rate: number;
+        futures_maker_fee_rate: number;
+        imr_factor: {
+            [key: string]: number;
+        };
+        max_notional: {
+            [key: string]: number;
+        };
+    }
+}
+declare namespace WSMessage {
+    interface Ticker {
+        symbol: string;
+        open: number;
+        close: number;
+        high: number;
+        low: number;
+        volume: number;
+        amount: number;
+        count: number;
+    }
+    interface MarkPrice {
+        symbol: string;
+        price: number;
+    }
+}
+
+declare enum OrderType {
+    LIMIT = "LIMIT",
+    MARKET = "MARKET",
+    IOC = "IOC",
+    FOK = "FOK",
+    POST_ONLY = "POST_ONLY",
+    ASK = "ASK",
+    BID = "BID"
+}
+declare enum OrderSide {
+    BUY = "BUY",
+    SELL = "SELL"
+}
+interface OrderEntity {
+    symbol?: string;
+    order_type: OrderType;
+    order_type_ext?: OrderType;
+    order_price?: string | number;
+    order_quantity?: string | number;
+    order_amount?: number;
+    visible_quantity?: number;
+    reduce_only?: boolean;
+    side: OrderSide;
+    broker_id?: string;
+    total?: string | number;
+}
+
+export { API, AccountStatusEnum, OrderEntity, OrderSide, OrderType, WSMessage };

package/dist/index.js

@@ -0,0 +1,61 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  AccountStatusEnum: () => AccountStatusEnum,
+  OrderSide: () => OrderSide,
+  OrderType: () => OrderType
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/constants.ts
+var AccountStatusEnum = /* @__PURE__ */ ((AccountStatusEnum2) => {
+  AccountStatusEnum2[AccountStatusEnum2["NotConnected"] = 0] = "NotConnected";
+  AccountStatusEnum2[AccountStatusEnum2["Connected"] = 1] = "Connected";
+  AccountStatusEnum2[AccountStatusEnum2["NotSignedIn"] = 2] = "NotSignedIn";
+  AccountStatusEnum2[AccountStatusEnum2["SignedIn"] = 3] = "SignedIn";
+  AccountStatusEnum2[AccountStatusEnum2["DisabledTrading"] = 4] = "DisabledTrading";
+  AccountStatusEnum2[AccountStatusEnum2["EnableTrading"] = 5] = "EnableTrading";
+  return AccountStatusEnum2;
+})(AccountStatusEnum || {});
+
+// src/order.ts
+var OrderType = /* @__PURE__ */ ((OrderType2) => {
+  OrderType2["LIMIT"] = "LIMIT";
+  OrderType2["MARKET"] = "MARKET";
+  OrderType2["IOC"] = "IOC";
+  OrderType2["FOK"] = "FOK";
+  OrderType2["POST_ONLY"] = "POST_ONLY";
+  OrderType2["ASK"] = "ASK";
+  OrderType2["BID"] = "BID";
+  return OrderType2;
+})(OrderType || {});
+var OrderSide = /* @__PURE__ */ ((OrderSide2) => {
+  OrderSide2["BUY"] = "BUY";
+  OrderSide2["SELL"] = "SELL";
+  return OrderSide2;
+})(OrderSide || {});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AccountStatusEnum,
+  OrderSide,
+  OrderType
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/constants.ts","../src/order.ts"],"sourcesContent":["export * from \"./constants\";\nexport * from \"./types/api\";\nexport * from \"./order\";\n","export enum AccountStatusEnum {\n  NotConnected = 0,\n  Connected = 1,\n  NotSignedIn = 2,\n  SignedIn = 3,\n  DisabledTrading = 4,\n  EnableTrading = 5,\n}\n","export enum OrderType {\n  LIMIT = \"LIMIT\",\n  MARKET = \"MARKET\",\n  IOC = \"IOC\",\n  FOK = \"FOK\",\n  POST_ONLY = \"POST_ONLY\",\n  ASK = \"ASK\",\n  BID = \"BID\",\n}\n\nexport enum OrderSide {\n  BUY = \"BUY\",\n  SELL = \"SELL\",\n}\n\nexport interface OrderEntity {\n  symbol?: string;\n  order_type: OrderType;\n  order_type_ext?: OrderType;\n  order_price?: string | number;\n  order_quantity?: string | number;\n  order_amount?: number;\n  // 是否显示在orderbook, 默认=order_quantity, =0时不显示,\n  visible_quantity?: number;\n  reduce_only?: boolean;\n  side: OrderSide;\n  broker_id?: string;\n\n  // internal fields\n  total?: string | number;\n  // hideInOrderbook?: boolean;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,IAAK,oBAAL,kBAAKA,uBAAL;AACL,EAAAA,sCAAA,kBAAe,KAAf;AACA,EAAAA,sCAAA,eAAY,KAAZ;AACA,EAAAA,sCAAA,iBAAc,KAAd;AACA,EAAAA,sCAAA,cAAW,KAAX;AACA,EAAAA,sCAAA,qBAAkB,KAAlB;AACA,EAAAA,sCAAA,mBAAgB,KAAhB;AANU,SAAAA;AAAA,GAAA;;;ACAL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,WAAQ;AACR,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,eAAY;AACZ,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,SAAM;AAPI,SAAAA;AAAA,GAAA;AAUL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;","names":["AccountStatusEnum","OrderType","OrderSide"]}

package/dist/index.mjs

@@ -0,0 +1,33 @@
+// src/constants.ts
+var AccountStatusEnum = /* @__PURE__ */ ((AccountStatusEnum2) => {
+  AccountStatusEnum2[AccountStatusEnum2["NotConnected"] = 0] = "NotConnected";
+  AccountStatusEnum2[AccountStatusEnum2["Connected"] = 1] = "Connected";
+  AccountStatusEnum2[AccountStatusEnum2["NotSignedIn"] = 2] = "NotSignedIn";
+  AccountStatusEnum2[AccountStatusEnum2["SignedIn"] = 3] = "SignedIn";
+  AccountStatusEnum2[AccountStatusEnum2["DisabledTrading"] = 4] = "DisabledTrading";
+  AccountStatusEnum2[AccountStatusEnum2["EnableTrading"] = 5] = "EnableTrading";
+  return AccountStatusEnum2;
+})(AccountStatusEnum || {});
+
+// src/order.ts
+var OrderType = /* @__PURE__ */ ((OrderType2) => {
+  OrderType2["LIMIT"] = "LIMIT";
+  OrderType2["MARKET"] = "MARKET";
+  OrderType2["IOC"] = "IOC";
+  OrderType2["FOK"] = "FOK";
+  OrderType2["POST_ONLY"] = "POST_ONLY";
+  OrderType2["ASK"] = "ASK";
+  OrderType2["BID"] = "BID";
+  return OrderType2;
+})(OrderType || {});
+var OrderSide = /* @__PURE__ */ ((OrderSide2) => {
+  OrderSide2["BUY"] = "BUY";
+  OrderSide2["SELL"] = "SELL";
+  return OrderSide2;
+})(OrderSide || {});
+export {
+  AccountStatusEnum,
+  OrderSide,
+  OrderType
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts","../src/order.ts"],"sourcesContent":["export enum AccountStatusEnum {\n  NotConnected = 0,\n  Connected = 1,\n  NotSignedIn = 2,\n  SignedIn = 3,\n  DisabledTrading = 4,\n  EnableTrading = 5,\n}\n","export enum OrderType {\n  LIMIT = \"LIMIT\",\n  MARKET = \"MARKET\",\n  IOC = \"IOC\",\n  FOK = \"FOK\",\n  POST_ONLY = \"POST_ONLY\",\n  ASK = \"ASK\",\n  BID = \"BID\",\n}\n\nexport enum OrderSide {\n  BUY = \"BUY\",\n  SELL = \"SELL\",\n}\n\nexport interface OrderEntity {\n  symbol?: string;\n  order_type: OrderType;\n  order_type_ext?: OrderType;\n  order_price?: string | number;\n  order_quantity?: string | number;\n  order_amount?: number;\n  // 是否显示在orderbook, 默认=order_quantity, =0时不显示,\n  visible_quantity?: number;\n  reduce_only?: boolean;\n  side: OrderSide;\n  broker_id?: string;\n\n  // internal fields\n  total?: string | number;\n  // hideInOrderbook?: boolean;\n}\n"],"mappings":";AAAO,IAAK,oBAAL,kBAAKA,uBAAL;AACL,EAAAA,sCAAA,kBAAe,KAAf;AACA,EAAAA,sCAAA,eAAY,KAAZ;AACA,EAAAA,sCAAA,iBAAc,KAAd;AACA,EAAAA,sCAAA,cAAW,KAAX;AACA,EAAAA,sCAAA,qBAAkB,KAAlB;AACA,EAAAA,sCAAA,mBAAgB,KAAhB;AANU,SAAAA;AAAA,GAAA;;;ACAL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,WAAQ;AACR,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,eAAY;AACZ,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,SAAM;AAPI,SAAAA;AAAA,GAAA;AAUL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;","names":["AccountStatusEnum","OrderType","OrderSide"]}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@orderly.network/types",
+  "version": "0.0.2",
+  "description": "",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "keywords": [],
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@babel/core": "^7.22.9",
+    "@babel/preset-env": "^7.22.9",
+    "@babel/preset-typescript": "^7.22.5",
+    "@types/jest": "^29.5.3",
+    "babel-jest": "^29.6.1",
+    "jest": "^29.6.1",
+    "tsup": "^7.1.0",
+    "tsconfig": "0.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test": "jest"
+  }
+}