@storm-trade/trading-sdk 1.0.0

package/dist/sdk/sdk.types.d.ts

@@ -0,0 +1,327 @@
+import { Direction, OraclePayload, OrderType } from '../base-packers';
+export type CollateralAssets = 'TON' | 'USDT' | 'NOT';
+export type MarketOpenOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will be used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Amount of collateral asset to use, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+    /**
+     * Leverage for this order, 9 decimals
+     */
+    leverage: bigint;
+    /**
+     * Minimal base asset amount, that will be added to position after order executed, 9 decimals
+     */
+    minBaseAssetAmount?: bigint;
+    /**
+     * If set will create stop loss order with specified trigger price, once market order is executed, 9 decimals
+     */
+    stopTriggerPrice?: bigint;
+    /**
+     * If set will create take profit order with specified trigger price, once market order is executed, 9 decimals
+     */
+    takeTriggerPrice?: bigint;
+    /**
+     * Order TTL, seconds, default to 15 minutes
+     */
+    expiration?: number;
+};
+export type MarketCloseOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * How much base asset will be swapped back to collateral asset, 9 decimals
+     */
+    size: bigint;
+};
+export type LimitOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will be used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Amount of collateral asset to use, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+    /**
+     * Leverage for this order, 9 decimals
+     */
+    leverage: bigint;
+    /**
+     * Price to trigger limit order execution, 9 decimals
+     */
+    limitPrice: bigint;
+    /**
+     * If set will create stop loss order with specified trigger price, once limit order is executed, 9 decimals
+     */
+    stopTriggerPrice?: bigint;
+    /**
+     * If set will create take profit order with specified trigger price, once limit order is executed, 9 decimals
+     */
+    takeTriggerPrice?: bigint;
+    /**
+     * Order TTL, seconds, default to 60 days
+     */
+    expiration?: number;
+};
+export type StopLimitOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will be used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Amount of collateral asset to use, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+    /**
+     * Leverage for this order, 9 decimals
+     */
+    leverage: bigint;
+    /**
+     * Price to trigger limit order creation, 9 decimals
+     */
+    stopPrice: bigint;
+    /**
+     * Price to trigger limit order execution, 9 decimals
+     */
+    limitPrice: bigint;
+    /**
+     * If set will create stop loss order with specified trigger price, once limit order is executed, 9 decimals
+     */
+    stopTriggerPrice?: bigint;
+    /**
+     * If set will create take profit order with specified trigger price, once limit order is executed, 9 decimals
+     */
+    takeTriggerPrice?: bigint;
+    /**
+     * Order TTL, seconds, default to 60 days
+     */
+    expiration?: number;
+};
+export type StopMarketOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will be used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Amount of collateral asset to use, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+    /**
+     * Leverage for this order, 9 decimals
+     */
+    leverage: bigint;
+    /**
+     * Price to trigger market order creation, 9 decimals
+     */
+    stopPrice: bigint;
+    /**
+     * If set will create stop loss order with specified trigger price, once limit order is executed, 9 decimals
+     */
+    stopTriggerPrice?: bigint;
+    /**
+     * If set will create take profit order with specified trigger price, once limit order is executed, 9 decimals
+     */
+    takeTriggerPrice?: bigint;
+    /**
+     * Order TTL, seconds, default to 60 days
+     */
+    expiration?: number;
+};
+export type StopLossOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * How much base asset will be swapped back to collateral asset, 9 decimals
+     */
+    amount: bigint;
+    /**
+     * Price to trigger order execution, 9 decimals
+     */
+    triggerPrice: bigint;
+};
+export type TakeProfitOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * How much base asset will be swapped back to collateral asset, 9 decimals
+     */
+    amount: bigint;
+    /**
+     * Price to trigger order execution, 9 decimals
+     */
+    triggerPrice: bigint;
+};
+export type CancelOrderParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Which order type will be cancelled
+     */
+    orderType: OrderType;
+    /**
+     * Order index in position manager storage.
+     * Get this from API, or from contract directly via getPositionManagerData method
+     */
+    orderIndex: number;
+};
+export type AddMarginParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Amount of collateral asset to add, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+    /**
+     * If set will provide oracle prices for base and collateral assets, otherwise sdk will request them on it's own
+     */
+    oraclePayload?: OraclePayload;
+};
+export type RemoveMarginParams = {
+    /**
+     * Market's base asset, e.g BTC
+     */
+    baseAssetName: string;
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    collateralAssetName: CollateralAssets;
+    /**
+     * Position direction short/long
+     */
+    direction: Direction;
+    /**
+     * Amount of collateral asset to remove, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+    /**
+     * If set will provide oracle prices for base and collateral assets, otherwise sdk will request them on it's own
+     */
+    oraclePayload?: OraclePayload;
+};
+export type ProvideLiquidityParams = {
+    /**
+     * Which asset will be used as collateral, e.g TON
+     */
+    assetName: CollateralAssets;
+    /**
+     * Amount of collateral asset to use, set decimals based on collateral. E.g 9 for TON, 6 for USDT, 9 for NOT
+     */
+    amount: bigint;
+};
+export type WithdrawLiquidityParams = {
+    /**
+     * Which asset will was used as collateral, e.g TON
+     */
+    assetName: CollateralAssets;
+    /**
+     * Amount of SLP tokens to swap back to collateral assets, 9 decimals
+     */
+    amountOfSLP: bigint;
+};
+export type CreateAnyLimitOrderParams = {
+    baseAssetName: string;
+    collateralAssetName: string;
+    direction: Direction;
+    amount: bigint;
+    leverage: bigint;
+    stopPrice: bigint;
+    limitPrice: bigint;
+    stopTriggerPrice?: bigint;
+    takeTriggerPrice?: bigint;
+    expiration?: number;
+};
+export type CreateSLTPOrderParams = {
+    baseAssetName: string;
+    collateralAssetName: string;
+    direction: Direction;
+    type: OrderType.stopLoss | OrderType.takeProfit;
+    amount: bigint;
+    triggerPrice: bigint;
+};

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@storm-trade/trading-sdk",
+  "version": "1.0.0",
+  "description": "Storm Trade trading SDK",
+  "private": false,
+  "exports": {
+    "./api-clients": {
+      "types": "./dist/api-clients/index.d.ts",
+      "require": "./dist/api-clients/index.js",
+      "import": "./dist/api-clients/index.esm.js"
+    },
+    "./common-packers": {
+      "types": "./dist/common-packers/index.d.ts",
+      "require": "./dist/common-packers/index.js",
+      "import": "./dist/common-packers/index.esm.js"
+    },
+    "./base-packers": {
+      "types": "./dist/base-packers/index.d.ts",
+      "require": "./dist/base-packers/index.js",
+      "import": "./dist/base-packers/index.esm.js"
+    },
+    "./sdk": {
+      "types": "./dist/sdk/index.d.ts",
+      "require": "./dist/sdk/index.js",
+      "import": "./dist/sdk/index.esm.js"
+    }
+  },
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts",
+    "dist/api-clients",
+    "dist/base-packers",
+    "dist/common-packers",
+    "dist/sdk",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "test": "jest",
+    "lint": "eslint .",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "prepare": "husky install",
+    "prepublishOnly": "npm run build",
+    "docs": "typedoc --out docs src/index.ts"
+  },
+  "keywords": [
+    "trading",
+    "sdk",
+    "storm-trade",
+    "dex",
+    "storm"
+  ],
+  "author": "",
+  "repository": "https://github.com/storm-trade/sdk-js",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@ton/ton": "^15.2.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "@typescript-eslint/parser": "^8.26.0",
+    "dotenv": "^16.4.7",
+    "eslint": "^9.21.0",
+    "eslint-config-prettier": "^10.0.2",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "globals": "^16.0.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.5.3",
+    "rollup": "^4.34.9",
+    "ton-lite-client": "^3.0.0",
+    "ts-jest": "^29.1.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.26.0"
+  },
+  "dependencies": {
+    "@hastom/fetch": "^1.0.4"
+  },
+  "peerDependencies": {
+    "@ton/ton": "^15.2.0",
+    "ton-lite-client": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "ton-lite-client": {
+      "optional": true
+    }
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}