@zofai/zo-sdk 0.1.92

package/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx tsc:*)",
+      "Bash(npm run build:*)",
+      "Bash(echo:*)"
+    ]
+  }
+}

package/.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

package/.prettierrc.js

@@ -0,0 +1,9 @@
+export default {
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+  printWidth: 100,
+  tabWidth: 2,
+  arrowParens: 'avoid',
+  endOfLine: 'lf',
+}

package/README.md

@@ -0,0 +1,28 @@
+# ZO SDK
+
+TypeScript SDK for interacting with multiple LP tokens on Sui Network: **ZLP**, **SLP**, and **USDZ**.
+
+## Installation
+
+```bash
+npm install zo-sdk
+# or
+yarn add zo-sdk
+# or
+pnpm add zo-sdk
+```
+
+## Documentation
+
+Full documentation is in the **[docs/](docs/)** folder, structured for GitBook:
+
+- [Introduction](docs/introduction.md)
+- [Architecture](docs/architecture.md)
+- [Getting Started](docs/getting-started.md)
+- [Common Operations](docs/common-operations.md)
+- [Trading Examples](docs/lp-specific-features.md)
+- [Type Safety](docs/type-safety.md)
+- [Error Handling](docs/error-handling.md)
+- [API Reference](docs/api-reference.md)
+
+Use **docs/SUMMARY.md** as the GitBook table of contents when building the book.

package/dist/abstract/BaseAPI.cjs

@@ -0,0 +1,206 @@
+"use strict";
+/**
+ * Abstract base class for all API implementations
+ * Extends BaseDataAPI with trading functionality
+ */
+/* eslint-disable class-methods-use-this -- base class helpers used by subclasses */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseAPI = void 0;
+const transactions_1 = require("@mysten/sui/transactions");
+const utils_1 = require("@mysten/sui/utils");
+const consts_1 = require("../consts/index.cjs");
+const BaseDataAPI_1 = require("./BaseDataAPI.cjs");
+class BaseAPI extends BaseDataAPI_1.BaseDataAPI {
+    /* eslint-disable-next-line @typescript-eslint/no-useless-constructor -- passes params to super */
+    constructor(network, provider, apiEndpoint, connectionURL, lpToken) {
+        super(network, provider, apiEndpoint, connectionURL, lpToken);
+    }
+    // Delegate BaseDataAPI methods to this.dataAPI so subclasses don't need stub implementations
+    valuateVaults(tx) {
+        return this.dataAPI.valuateVaults(tx);
+    }
+    valuateSymbols(tx) {
+        return this.dataAPI.valuateSymbols(tx);
+    }
+    valuate(tx) {
+        return this.dataAPI.valuate(tx);
+    }
+    valuateMarket() {
+        return this.dataAPI.valuateMarket();
+    }
+    fundingFeeRate(indexToken, long, sender) {
+        return this.dataAPI.fundingFeeRate(indexToken, long, sender);
+    }
+    rebaseFeeRate(collateralToken, increase, amount, sender) {
+        return this.dataAPI.rebaseFeeRate(collateralToken, increase, amount, sender);
+    }
+    reservingFeeRate(collateralToken, amount, sender) {
+        return this.dataAPI.reservingFeeRate(collateralToken, amount, sender);
+    }
+    getMarketInfo() {
+        return this.dataAPI.getMarketInfo();
+    }
+    getVaultInfo(vault) {
+        return this.dataAPI.getVaultInfo(vault);
+    }
+    getSymbolInfo(tokenId, long) {
+        return this.dataAPI.getSymbolInfo(tokenId, long);
+    }
+    getPositionConfig(indexToken, long) {
+        return this.dataAPI.getPositionConfig(indexToken, long);
+    }
+    getRebaseFeeModel() {
+        return this.dataAPI.getRebaseFeeModel();
+    }
+    getOpenPositions(batchSize, symbol) {
+        return this.dataAPI.getOpenPositions(batchSize, symbol);
+    }
+    getPositionCapInfoList(owner) {
+        return this.dataAPI.getPositionCapInfoList(owner);
+    }
+    getPositionInfoList(positionCapInfoList, owner, batchSize) {
+        return this.dataAPI.getPositionInfoList(positionCapInfoList, owner, batchSize);
+    }
+    getOrderCapInfoList(owner) {
+        return this.dataAPI.getOrderCapInfoList(owner);
+    }
+    getOrderInfoList(orderCapInfoList, owner, batchSize) {
+        return this.dataAPI.getOrderInfoList(orderCapInfoList, owner, batchSize);
+    }
+    getHistory(trader, page, limit, orderType, symbol) {
+        return this.dataAPI.getHistory(trader, page, limit, orderType, symbol);
+    }
+    getStaked(owner) {
+        return this.dataAPI.getStaked(owner);
+    }
+    getStakePool() {
+        return this.dataAPI.getStakePool();
+    }
+    hasReferral(referree) {
+        return this.dataAPI.hasReferral(referree);
+    }
+    getReferralData(referree) {
+        return this.dataAPI.getReferralData(referree);
+    }
+    /**
+     * Processes coin objects for transactions
+     * Handles SUI gas coin and merges multiple coin objects if needed
+     */
+    processCoins(tx, coin, coinObjects, sponsoredTx = false) {
+        if (coin === 'sui' && !sponsoredTx) {
+            return tx.gas;
+        }
+        if (coinObjects.length > 1) {
+            tx.mergeCoins(tx.object(coinObjects[0]), coinObjects.slice(1).map(coinObject => tx.object(coinObject)));
+        }
+        return tx.object(coinObjects[0]);
+    }
+    processCoinSplitting(tx, token, coinObjects, amounts, sponsoredTx, suiCoinObject) {
+        if (sponsoredTx) {
+            const sourceObject = token === 'sui'
+                ? suiCoinObject
+                : this.processCoins(tx, token, coinObjects, true);
+            return tx.splitCoins(sourceObject, amounts);
+        }
+        const coinObject = this.processCoins(tx, token, coinObjects);
+        return tx.splitCoins(coinObject, amounts);
+    }
+    /**
+     * Processes slippage for price calculations
+     */
+    processSlippage(indexPrice, long, slippage) {
+        const raw = long ? indexPrice * (1 + slippage) : indexPrice * (1 - slippage);
+        return BigInt(Math.round(raw * 1e18));
+    }
+    /**
+     * Processes slippage for price calculations
+     */
+    processPriceThreshold(indexPrice, slippage) {
+        const raw = indexPrice * slippage;
+        return BigInt(Math.round(raw * 1e18));
+    }
+    /**
+     * Determines trade allowance based on order type
+     */
+    getTradeAllowance(isLimitOrder, isIocOrder) {
+        if (isLimitOrder) {
+            return isIocOrder ? consts_1.ALLOW_TRADE_NO_TRADE : consts_1.ALLOW_TRADE_CAN_TRADE;
+        }
+        return consts_1.ALLOW_TRADE_MUST_TRADE;
+    }
+    /**
+     * Default: not supported. Override in subclasses that support S Card claim (e.g. SLP).
+     */
+    claimTokenFromSCard(_token, _coinObjects, _kioskClient, _kioskCap, _scard) {
+        throw new Error(`Method not implemented in ${this.constructor.name}.`);
+    }
+    /**
+     * Helper method to initialize oracle transaction block
+     * This is commonly used across all LP token implementations
+     */
+    async initOracleTransaction(tokens, tx) {
+        const txToUse = tx ?? new transactions_1.Transaction();
+        return await this.initOracleTxb(tokens, txToUse);
+    }
+    /**
+     * Helper method to add clock object to transaction
+     */
+    addClockToTransaction(tx) {
+        return tx.object(utils_1.SUI_CLOCK_OBJECT_ID);
+    }
+    /**
+     * Helper method to create move call arguments array
+     */
+    createMoveCallArgs(tx, args) {
+        return args.map((arg) => {
+            if (typeof arg === 'string' && arg.startsWith('0x')) {
+                return tx.object(arg);
+            }
+            if (typeof arg === 'number') {
+                return tx.pure.u64(arg);
+            }
+            if (typeof arg === 'bigint') {
+                return tx.pure.u256(arg);
+            }
+            return arg;
+        });
+    }
+    /**
+     * Helper method to validate transaction parameters
+     */
+    validateTransactionParams(params) {
+        const { coin, coinObjects, amount, minAmountOut } = params;
+        if (coin && !this.consts.coins[coin]) {
+            throw new Error(`Unsupported coin: ${coin}`);
+        }
+        if (coinObjects && coinObjects.length === 0) {
+            throw new Error('At least one coin object is required');
+        }
+        if (amount !== undefined && amount <= 0) {
+            throw new Error('Amount must be greater than 0');
+        }
+        if (minAmountOut !== undefined && minAmountOut < 0) {
+            throw new Error('Minimum amount out cannot be negative');
+        }
+    }
+    /**
+     * Helper method to validate position parameters
+     */
+    validatePositionParams(params) {
+        const { collateralToken, indexToken, size, collateralAmount } = params;
+        if (!this.consts.coins[collateralToken]) {
+            throw new Error(`Unsupported collateral token: ${collateralToken}`);
+        }
+        if (!this.consts.coins[indexToken]) {
+            throw new Error(`Unsupported index token: ${indexToken}`);
+        }
+        if (size <= 0n) {
+            throw new Error('Position size must be greater than 0');
+        }
+        if (collateralAmount <= 0n) {
+            throw new Error('Collateral amount must be greater than 0');
+        }
+    }
+}
+exports.BaseAPI = BaseAPI;
+//# sourceMappingURL=BaseAPI.cjs.map

package/dist/abstract/BaseAPI.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAPI.cjs","sourceRoot":"","sources":["../../src/abstract/BaseAPI.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH,oFAAoF;;;AAIpF,2DAAsD;AACtD,6CAAuD;AAGvD,gDAA+F;AAmB/F,mDAA2C;AAE3C,MAAsB,OAAQ,SAAQ,yBAAW;IAI/C,kGAAkG;IAClG,YACE,OAAgB,EAChB,QAAmB,EACnB,WAAmB,EACnB,aAAqB,EACrB,OAAgB;QAEhB,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;IAC/D,CAAC;IAED,6FAA6F;IACtF,aAAa,CAAC,EAAe;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAA;IACvC,CAAC;IAEM,cAAc,CAAC,EAAe;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;IACxC,CAAC;IAEM,OAAO,CAAC,EAAe;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACjC,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;IACrC,CAAC;IAEM,cAAc,CAAC,UAAkB,EAAE,IAAa,EAAE,MAAe;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC;IAEM,aAAa,CAAC,eAAuB,EAAE,QAAiB,EAAE,MAAc,EAAE,MAAe;QAC9F,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9E,CAAC;IAEM,gBAAgB,CAAC,eAAuB,EAAE,MAAc,EAAE,MAAe;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACvE,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;IACrC,CAAC;IAEM,YAAY,CAAC,KAAa;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;IACzC,CAAC;IAEM,aAAa,CAAC,OAAe,EAAE,IAAa;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IAClD,CAAC;IAEM,iBAAiB,CAAC,UAAkB,EAAE,IAAa;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IACzD,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAA;IACzC,CAAC;IAEM,gBAAgB,CAAC,SAAiB,EAAE,MAAc;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IACzD,CAAC;IAEM,sBAAsB,CAAC,KAAa;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAA;IACnD,CAAC;IAEM,mBAAmB,CAAC,mBAA2C,EAAE,KAAa,EAAE,SAAkB;QACvG,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;IAChF,CAAC;IAEM,mBAAmB,CAAC,KAAa;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAChD,CAAC;IAEM,gBAAgB,CAAC,gBAAqC,EAAE,KAAa,EAAE,SAAkB;QAC9F,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;IAC1E,CAAC;IAEM,UAAU,CAAC,MAAc,EAAE,IAAY,EAAE,KAAa,EAAE,SAAkB,EAAE,MAAe;QAChG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;IACxE,CAAC;IAEM,SAAS,CAAC,KAAa;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAA;IACpC,CAAC;IAEM,WAAW,CAAC,QAAgB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC3C,CAAC;IAEM,eAAe,CAAC,QAAgB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACO,YAAY,CAAC,EAAe,EAAE,IAAY,EAAE,WAAqB,EAAE,WAAW,GAAG,KAAK;QAC9F,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,OAAO,EAAE,CAAC,GAAG,CAAA;QACf,CAAC;QACD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,EAAE,CAAC,UAAU,CACX,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EACzB,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAC9D,CAAA;QACH,CAAC;QACD,OAAO,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC;IAES,oBAAoB,CAAC,EAAe,EAAE,KAAa,EAAE,WAAqB,EAAE,OAAc,EAAE,WAAqB,EAAE,aAAmB;QAC9I,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,YAAY,GAAG,KAAK,KAAK,KAAK;gBAClC,CAAC,CAAC,aAAa;gBACf,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAA;YACnD,OAAO,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;QAC5D,OAAO,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,UAAkB,EAAE,IAAa,EAAE,QAAgB;QAC3E,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAA;QAC5E,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAA;IACvC,CAAC;IAED;;OAEG;IACO,qBAAqB,CAAC,UAAkB,EAAE,QAAgB;QAClE,MAAM,GAAG,GAAG,UAAU,GAAG,QAAQ,CAAA;QACjC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAA;IACvC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,YAAqB,EAAE,UAAmB;QACpE,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,UAAU,CAAC,CAAC,CAAC,6BAAoB,CAAC,CAAC,CAAC,8BAAqB,CAAA;QAClE,CAAC;QACD,OAAO,+BAAsB,CAAA;IAC/B,CAAC;IAgPD;;OAEG;IACI,mBAAmB,CACxB,MAAc,EACd,YAAsB,EACtB,YAAyB,EACzB,SAAwB,EACxB,MAAc;QAEd,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,CAAA;IACxE,CAAC;IA4CD;;;OAGG;IACO,KAAK,CAAC,qBAAqB,CAAC,MAAgB,EAAE,EAAgB;QACtE,MAAM,OAAO,GAAG,EAAE,IAAI,IAAI,0BAAW,EAAE,CAAA;QACvC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClD,CAAC;IAED;;OAEG;IACO,qBAAqB,CAAC,EAAe;QAC7C,OAAO,EAAE,CAAC,MAAM,CAAC,2BAAmB,CAAC,CAAA;IACvC,CAAC;IAED;;OAEG;IACO,kBAAkB,CAAC,EAAe,EAAE,IAAW;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpD,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC;YACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACzB,CAAC;YACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC1B,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACO,yBAAyB,CAAC,MAKnC;QACC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAA;QAE1D,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,EAAE,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1D,CAAC;IACH,CAAC;IAED;;OAEG;IACO,sBAAsB,CAAC,MAMhC;QACC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAA;QAEtE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,iCAAiC,eAAe,EAAE,CAAC,CAAA;QACrE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,4BAA4B,UAAU,EAAE,CAAC,CAAA;QAC3D,CAAC;QAED,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACzD,CAAC;QAED,IAAI,gBAAgB,IAAI,EAAE,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;CACF;AA7hBD,0BA6hBC"}

package/dist/abstract/BaseAPI.d.cts

@@ -0,0 +1,172 @@
+/**
+ * Abstract base class for all API implementations
+ * Extends BaseDataAPI with trading functionality
+ */
+import type { KioskClient, KioskOwnerCap } from "@mysten/kiosk";
+import type { SuiClient } from "@mysten/sui/client";
+import { Transaction } from "@mysten/sui/transactions";
+import type { LPToken, Network } from "../consts/index.cjs";
+import type { IBaseDataAPI, IBaseAPI, IBaseCredential, IBaseHistoryResponse, IBaseMarketInfo, IBaseMarketValuationInfo, IBaseOrderCapInfo, IBaseOrderInfo, IBasePositionCapInfo, IBasePositionConfig, IBasePositionInfo, IBaseRebaseFeeModel, IBaseStaked, IBaseStakePool, IBaseSymbolInfo, IBaseVaultInfo } from "../interfaces/index.cjs";
+import { BaseDataAPI } from "./BaseDataAPI.cjs";
+export declare abstract class BaseAPI extends BaseDataAPI implements IBaseAPI {
+    /** Subclasses must provide their DataAPI instance; data methods delegate to it. */
+    protected abstract get dataAPI(): IBaseDataAPI;
+    constructor(network: Network, provider: SuiClient, apiEndpoint: string, connectionURL: string, lpToken: LPToken);
+    valuateVaults(tx: Transaction): any;
+    valuateSymbols(tx: Transaction): any;
+    valuate(tx: Transaction): {
+        vaultsValuation: any;
+        symbolsValuation: any;
+    };
+    valuateMarket(): Promise<IBaseMarketValuationInfo>;
+    fundingFeeRate(indexToken: string, long: boolean, sender?: string): Promise<number>;
+    rebaseFeeRate(collateralToken: string, increase: boolean, amount: number, sender?: string): Promise<number>;
+    reservingFeeRate(collateralToken: string, amount: number, sender?: string): Promise<number>;
+    getMarketInfo(): Promise<IBaseMarketInfo>;
+    getVaultInfo(vault: string): Promise<IBaseVaultInfo>;
+    getSymbolInfo(tokenId: string, long: boolean): Promise<IBaseSymbolInfo>;
+    getPositionConfig(indexToken: string, long: boolean): Promise<IBasePositionConfig>;
+    getRebaseFeeModel(): Promise<IBaseRebaseFeeModel>;
+    getOpenPositions(batchSize: number, symbol: string): Promise<IBasePositionInfo[]>;
+    getPositionCapInfoList(owner: string): Promise<IBasePositionCapInfo[]>;
+    getPositionInfoList(positionCapInfoList: IBasePositionCapInfo[], owner: string, batchSize?: number): Promise<IBasePositionInfo[]>;
+    getOrderCapInfoList(owner: string): Promise<IBaseOrderCapInfo[]>;
+    getOrderInfoList(orderCapInfoList: IBaseOrderCapInfo[], owner: string, batchSize?: number): Promise<IBaseOrderInfo[]>;
+    getHistory(trader: string, page: number, limit: number, orderType?: string, symbol?: string): Promise<IBaseHistoryResponse>;
+    getStaked(owner: string): Promise<IBaseStaked>;
+    getStakePool(): Promise<IBaseStakePool>;
+    hasReferral(referree: string): Promise<boolean>;
+    getReferralData(referree: string): Promise<any>;
+    /**
+     * Processes coin objects for transactions
+     * Handles SUI gas coin and merges multiple coin objects if needed
+     */
+    protected processCoins(tx: Transaction, coin: string, coinObjects: string[], sponsoredTx?: boolean): {
+        $kind: "Input";
+        Input: number;
+        type?: "object";
+    } | {
+        $kind: "GasCoin";
+        GasCoin: true;
+    };
+    protected processCoinSplitting(tx: Transaction, token: string, coinObjects: string[], amounts: any[], sponsoredTx?: boolean, suiCoinObject?: any): {
+        $kind: "Result";
+        Result: number;
+    } & {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }[];
+    /**
+     * Processes slippage for price calculations
+     */
+    protected processSlippage(indexPrice: number, long: boolean, slippage: number): bigint;
+    /**
+     * Processes slippage for price calculations
+     */
+    protected processPriceThreshold(indexPrice: number, slippage: number): bigint;
+    /**
+     * Determines trade allowance based on order type
+     */
+    protected getTradeAllowance(isLimitOrder: boolean, isIocOrder: boolean): number;
+    abstract deposit(coin: string, coinObjects: string[], amount: number, minAmountOut?: number, referralAddress?: string, sender?: string, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract withdraw(coin: string, lpCoinObjects: string[], amount: number, minAmountOut?: number, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract swap(fromToken: string, toToken: string, fromAmount: bigint, fromCoinObjects: string[]): Promise<Transaction>;
+    abstract stake(lpCoinObjects: string[], amount: bigint, pool: string, tx?: Transaction): Transaction;
+    abstract unstake(credentials: IBaseCredential[], amount: bigint, pool: string, tx?: Transaction): Transaction;
+    abstract openPosition(collateralToken: string, indexToken: string, size: bigint, collateralAmount: bigint, coinObjects: string[], long: boolean, reserveAmount: bigint, indexPrice: number, collateralPrice: number, isLimitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, referralAddress?: string, sender?: string, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract decreasePosition(pcpId: string, collateralToken: string, indexToken: string, amount: bigint, long: boolean, indexPrice: number, collateralPrice: number, isTriggerOrder?: boolean, isTakeProfitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, coinObjects?: string[], sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract decreaseMultiPositions(positions: Array<{
+        pcpId: string;
+        collateralToken: string;
+        indexToken: string;
+        amount: bigint;
+        long: boolean;
+        indexPrice: number;
+        collateralPrice: number;
+        isTriggerOrder?: boolean;
+        isTakeProfitOrder?: boolean;
+        isIocOrder?: boolean;
+        pricesSlippage?: number;
+        collateralSlippage?: number;
+        relayerFee?: bigint;
+        coinObjects?: string[];
+    }>, tx?: Transaction): Promise<Transaction>;
+    abstract pledgeInPosition(pcpId: string, collateralToken: string, indexToken: string, amount: number, coinObjects: string[], long: boolean, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract redeemFromPosition(pcpId: string, collateralToken: string, indexToken: string, amount: number, long: boolean, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract cancelOrder(orderCapId: string, collateralToken: string, indexToken: string, long: boolean, type: string, isV11Order?: boolean): Transaction;
+    abstract cancelMultiOrders(orders: Array<{
+        orderCapId: string;
+        collateralToken: string;
+        indexToken: string;
+        long: boolean;
+        type: string;
+        isV11Order?: boolean;
+    }>, tx?: Transaction): Transaction;
+    abstract clearClosedPosition(pcpId: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction): void;
+    abstract clearOpenPositionOrder(orderCapId: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction, isV11Order?: boolean): void;
+    abstract clearDecreasePositionOrder(orderCapId: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction, isV11Order?: boolean): void;
+    abstract openPositionWithSCard(collateralToken: string, indexToken: string, size: bigint, collateralAmount: bigint, coinObjects: string[], long: boolean, reserveAmount: bigint, indexPrice: number, collateralPrice: number, kioskClient: KioskClient, kioskCap: KioskOwnerCap, scard: string, isLimitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, referralAddress?: string, sender?: string): Promise<Transaction>;
+    abstract decreasePositionWithSCard(pcpId: string, collateralToken: string, indexToken: string, amount: bigint, long: boolean, indexPrice: number, collateralPrice: number, kioskClient: KioskClient, kioskCap: KioskOwnerCap, scard: string, isTriggerOrder?: boolean, isTakeProfitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, coinObjects?: string[]): Promise<Transaction>;
+    abstract decreaseMultiPositionsWithSCard(positions: Array<{
+        pcpId: string;
+        collateralToken: string;
+        indexToken: string;
+        amount: bigint;
+        long: boolean;
+        indexPrice: number;
+        collateralPrice: number;
+        isTriggerOrder?: boolean;
+        isTakeProfitOrder?: boolean;
+        isIocOrder?: boolean;
+        pricesSlippage?: number;
+        collateralSlippage?: number;
+        relayerFee?: bigint;
+        coinObjects?: string[];
+    }>, kioskClient: KioskClient, kioskCap: KioskOwnerCap, scard: string, tx?: Transaction): Promise<Transaction>;
+    /**
+     * Default: not supported. Override in subclasses that support S Card claim (e.g. SLP).
+     */
+    claimTokenFromSCard(_token: string, _coinObjects: string[], _kioskClient: KioskClient, _kioskCap: KioskOwnerCap, _scard: string): Transaction;
+    abstract addReferral(referrer: string, tx?: Transaction): Transaction;
+    abstract adminUpdatePriceFeed(collateralToken: string, indexToken: string): Promise<Transaction>;
+    abstract adminSettlePosition(positionId: string, owner: string, collateralToken: string, indexToken: string, long: boolean): Transaction;
+    abstract adminDecreasePosition(positionId: string, owner: string, collateralToken: string, indexToken: string, positionAmount: number, amount: bigint, long: boolean, collateralPrice?: number, collateralSlippage?: number, relayerFee?: bigint): Transaction;
+    abstract adminClearClosedPosition(positionId: string, owner: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction): void;
+    /**
+     * Helper method to initialize oracle transaction block
+     * This is commonly used across all LP token implementations
+     */
+    protected initOracleTransaction(tokens: string[], tx?: Transaction): Promise<Transaction>;
+    /**
+     * Helper method to add clock object to transaction
+     */
+    protected addClockToTransaction(tx: Transaction): {
+        $kind: "Input";
+        Input: number;
+        type?: "object";
+    };
+    /**
+     * Helper method to create move call arguments array
+     */
+    protected createMoveCallArgs(tx: Transaction, args: any[]): any[];
+    /**
+     * Helper method to validate transaction parameters
+     */
+    protected validateTransactionParams(params: {
+        coin?: string;
+        coinObjects?: string[];
+        amount?: number;
+        minAmountOut?: number;
+    }): void;
+    /**
+     * Helper method to validate position parameters
+     */
+    protected validatePositionParams(params: {
+        collateralToken: string;
+        indexToken: string;
+        size: bigint;
+        collateralAmount: bigint;
+        long: boolean;
+    }): void;
+}
+//# sourceMappingURL=BaseAPI.d.cts.map

package/dist/abstract/BaseAPI.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAPI.d.cts","sourceRoot":"","sources":["../../src/abstract/BaseAPI.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,sBAAqB;AAC/D,OAAO,KAAK,EAAE,SAAS,EAAE,2BAA0B;AACnD,OAAO,EAAE,WAAW,EAAE,iCAAgC;AAGtD,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,4BAAiB;AAEjD,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,eAAe,EACf,oBAAoB,EACpB,eAAe,EACf,wBAAwB,EACxB,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACf,gCAAqB;AACtB,OAAO,EAAE,WAAW,EAAE,0BAAqB;AAE3C,8BAAsB,OAAQ,SAAQ,WAAY,YAAW,QAAQ;IACnE,mFAAmF;IACnF,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,YAAY,CAAA;gBAI5C,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO;IAMX,aAAa,CAAC,EAAE,EAAE,WAAW;IAI7B,cAAc,CAAC,EAAE,EAAE,WAAW;IAI9B,OAAO,CAAC,EAAE,EAAE,WAAW,GAAG;QAAE,eAAe,EAAE,GAAG,CAAC;QAAC,gBAAgB,EAAE,GAAG,CAAA;KAAE;IAIzE,aAAa,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAIlD,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAInF,aAAa,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3G,gBAAgB,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3F,aAAa,IAAI,OAAO,CAAC,eAAe,CAAC;IAIzC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAIpD,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IAIvE,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIlF,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAIjD,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAIjF,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAItE,mBAAmB,CAAC,mBAAmB,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAIjI,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAIhE,gBAAgB,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIrH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI3H,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9C,YAAY,IAAI,OAAO,CAAC,cAAc,CAAC;IAIvC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/C,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAItD;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,WAAW,UAAQ;;;;;;;;IAahG,SAAS,CAAC,oBAAoB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,GAAG;;;;;;;IAWhJ;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAKtF;;OAEG;IACH,SAAS,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAK7E;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,MAAM;aAU/D,OAAO,CACrB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE,EACrB,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,MAAM,EACrB,eAAe,CAAC,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,GACrC,OAAO,CAAC,WAAW,CAAC;aAEP,QAAQ,CACtB,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EAAE,EACvB,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,GACrC,OAAO,CAAC,WAAW,CAAC;aAEP,IAAI,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,WAAW,CAAC;aAGP,KAAK,CACnB,aAAa,EAAE,MAAM,EAAE,EACvB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,CAAC,EAAE,WAAW,GACf,WAAW;aAEE,OAAO,CACrB,WAAW,EAAE,eAAe,EAAE,EAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,EAAE,CAAC,EAAE,WAAW,GACf,WAAW;aAGE,YAAY,CAC1B,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,EAAE,EACrB,IAAI,EAAE,OAAO,EACb,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,YAAY,CAAC,EAAE,OAAO,EACtB,UAAU,CAAC,EAAE,OAAO,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,GACrC,OAAO,CAAC,WAAW,CAAC;aAEP,gBAAgB,CAC9B,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,OAAO,EACxB,iBAAiB,CAAC,EAAE,OAAO,EAC3B,UAAU,CAAC,EAAE,OAAO,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EAAE,EACtB,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,GACrC,OAAO,CAAC,WAAW,CAAC;aAEP,sBAAsB,CACpC,SAAS,EAAE,KAAK,CAAC;QACf,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;QACvB,UAAU,EAAE,MAAM,CAAA;QAClB,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,OAAO,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;QAClB,eAAe,EAAE,MAAM,CAAA;QACvB,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,iBAAiB,CAAC,EAAE,OAAO,CAAA;QAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;KACvB,CAAC,EAAE,EAAE,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,WAAW,CAAC;aAEP,gBAAgB,CAC9B,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EAAE,EACrB,IAAI,EAAE,OAAO,EACb,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,GACrC,OAAO,CAAC,WAAW,CAAC;aAEP,kBAAkB,CAChC,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,WAAW,CAAC,EAAE,OAAO,EACrB,2BAA2B,CAAC,EAAE,MAAM,EAAE,GACrC,OAAO,CAAC,WAAW,CAAC;aAEP,WAAW,CACzB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO,EACb,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,OAAO,GACnB,WAAW;aAEE,iBAAiB,CAC/B,MAAM,EAAE,KAAK,CAAC;QACZ,UAAU,EAAE,MAAM,CAAA;QAClB,eAAe,EAAE,MAAM,CAAA;QACvB,UAAU,EAAE,MAAM,CAAA;QAClB,IAAI,EAAE,OAAO,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAC,EAAE,EAAE,CAAC,EAAE,WAAW,GACnB,WAAW;aAEE,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO,EACb,EAAE,EAAE,WAAW,GACd,IAAI;aAES,sBAAsB,CACpC,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO,EACb,EAAE,EAAE,WAAW,EACf,UAAU,CAAC,EAAE,OAAO,GACnB,IAAI;aAES,0BAA0B,CACxC,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO,EACb,EAAE,EAAE,WAAW,EACf,UAAU,CAAC,EAAE,OAAO,GACnB,IAAI;aAGS,qBAAqB,CACnC,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,EAAE,EACrB,IAAI,EAAE,OAAO,EACb,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,OAAO,EACtB,UAAU,CAAC,EAAE,OAAO,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,eAAe,CAAC,EAAE,MAAM,EACxB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,WAAW,CAAC;aAEP,yBAAyB,CACvC,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,OAAO,EACxB,iBAAiB,CAAC,EAAE,OAAO,EAC3B,UAAU,CAAC,EAAE,OAAO,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,WAAW,CAAC;aAEP,+BAA+B,CAC7C,SAAS,EAAE,KAAK,CAAC;QACf,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;QACvB,UAAU,EAAE,MAAM,CAAA;QAClB,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,OAAO,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;QAClB,eAAe,EAAE,MAAM,CAAA;QACvB,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,iBAAiB,CAAC,EAAE,OAAO,CAAA;QAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;KACvB,CAAC,EACF,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,MAAM,EACb,EAAE,CAAC,EAAE,WAAW,GACf,OAAO,CAAC,WAAW,CAAC;IAEvB;;OAEG;IACI,mBAAmB,CACxB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EAAE,EACtB,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,aAAa,EACxB,MAAM,EAAE,MAAM,GACb,WAAW;aAKE,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,EAAE,CAAC,EAAE,WAAW,GACf,WAAW;aAGE,oBAAoB,CAClC,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,WAAW,CAAC;aAEP,mBAAmB,CACjC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO,GACZ,WAAW;aAEE,qBAAqB,CACnC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,eAAe,CAAC,EAAE,MAAM,EACxB,kBAAkB,CAAC,EAAE,MAAM,EAC3B,UAAU,CAAC,EAAE,MAAM,GAClB,WAAW;aAEE,wBAAwB,CACtC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,OAAO,EACb,EAAE,EAAE,WAAW,GACd,IAAI;IAEP;;;OAGG;cACa,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAK/F;;OAEG;IACH,SAAS,CAAC,qBAAqB,CAAC,EAAE,EAAE,WAAW;;;;;IAI/C;;OAEG;IACH,SAAS,CAAC,kBAAkB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE;IAejE;;OAEG;IACH,SAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE;QAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;QACtB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,GAAG,IAAI;IAoBR;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAAC,MAAM,EAAE;QACvC,eAAe,EAAE,MAAM,CAAA;QACvB,UAAU,EAAE,MAAM,CAAA;QAClB,IAAI,EAAE,MAAM,CAAA;QACZ,gBAAgB,EAAE,MAAM,CAAA;QACxB,IAAI,EAAE,OAAO,CAAA;KACd,GAAG,IAAI;CAmBT"}

package/dist/abstract/BaseAPI.d.mts

@@ -0,0 +1,172 @@
+/**
+ * Abstract base class for all API implementations
+ * Extends BaseDataAPI with trading functionality
+ */
+import type { KioskClient, KioskOwnerCap } from "@mysten/kiosk";
+import type { SuiClient } from "@mysten/sui/client";
+import { Transaction } from "@mysten/sui/transactions";
+import type { LPToken, Network } from "../consts/index.mjs";
+import type { IBaseDataAPI, IBaseAPI, IBaseCredential, IBaseHistoryResponse, IBaseMarketInfo, IBaseMarketValuationInfo, IBaseOrderCapInfo, IBaseOrderInfo, IBasePositionCapInfo, IBasePositionConfig, IBasePositionInfo, IBaseRebaseFeeModel, IBaseStaked, IBaseStakePool, IBaseSymbolInfo, IBaseVaultInfo } from "../interfaces/index.mjs";
+import { BaseDataAPI } from "./BaseDataAPI.mjs";
+export declare abstract class BaseAPI extends BaseDataAPI implements IBaseAPI {
+    /** Subclasses must provide their DataAPI instance; data methods delegate to it. */
+    protected abstract get dataAPI(): IBaseDataAPI;
+    constructor(network: Network, provider: SuiClient, apiEndpoint: string, connectionURL: string, lpToken: LPToken);
+    valuateVaults(tx: Transaction): any;
+    valuateSymbols(tx: Transaction): any;
+    valuate(tx: Transaction): {
+        vaultsValuation: any;
+        symbolsValuation: any;
+    };
+    valuateMarket(): Promise<IBaseMarketValuationInfo>;
+    fundingFeeRate(indexToken: string, long: boolean, sender?: string): Promise<number>;
+    rebaseFeeRate(collateralToken: string, increase: boolean, amount: number, sender?: string): Promise<number>;
+    reservingFeeRate(collateralToken: string, amount: number, sender?: string): Promise<number>;
+    getMarketInfo(): Promise<IBaseMarketInfo>;
+    getVaultInfo(vault: string): Promise<IBaseVaultInfo>;
+    getSymbolInfo(tokenId: string, long: boolean): Promise<IBaseSymbolInfo>;
+    getPositionConfig(indexToken: string, long: boolean): Promise<IBasePositionConfig>;
+    getRebaseFeeModel(): Promise<IBaseRebaseFeeModel>;
+    getOpenPositions(batchSize: number, symbol: string): Promise<IBasePositionInfo[]>;
+    getPositionCapInfoList(owner: string): Promise<IBasePositionCapInfo[]>;
+    getPositionInfoList(positionCapInfoList: IBasePositionCapInfo[], owner: string, batchSize?: number): Promise<IBasePositionInfo[]>;
+    getOrderCapInfoList(owner: string): Promise<IBaseOrderCapInfo[]>;
+    getOrderInfoList(orderCapInfoList: IBaseOrderCapInfo[], owner: string, batchSize?: number): Promise<IBaseOrderInfo[]>;
+    getHistory(trader: string, page: number, limit: number, orderType?: string, symbol?: string): Promise<IBaseHistoryResponse>;
+    getStaked(owner: string): Promise<IBaseStaked>;
+    getStakePool(): Promise<IBaseStakePool>;
+    hasReferral(referree: string): Promise<boolean>;
+    getReferralData(referree: string): Promise<any>;
+    /**
+     * Processes coin objects for transactions
+     * Handles SUI gas coin and merges multiple coin objects if needed
+     */
+    protected processCoins(tx: Transaction, coin: string, coinObjects: string[], sponsoredTx?: boolean): {
+        $kind: "Input";
+        Input: number;
+        type?: "object";
+    } | {
+        $kind: "GasCoin";
+        GasCoin: true;
+    };
+    protected processCoinSplitting(tx: Transaction, token: string, coinObjects: string[], amounts: any[], sponsoredTx?: boolean, suiCoinObject?: any): {
+        $kind: "Result";
+        Result: number;
+    } & {
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }[];
+    /**
+     * Processes slippage for price calculations
+     */
+    protected processSlippage(indexPrice: number, long: boolean, slippage: number): bigint;
+    /**
+     * Processes slippage for price calculations
+     */
+    protected processPriceThreshold(indexPrice: number, slippage: number): bigint;
+    /**
+     * Determines trade allowance based on order type
+     */
+    protected getTradeAllowance(isLimitOrder: boolean, isIocOrder: boolean): number;
+    abstract deposit(coin: string, coinObjects: string[], amount: number, minAmountOut?: number, referralAddress?: string, sender?: string, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract withdraw(coin: string, lpCoinObjects: string[], amount: number, minAmountOut?: number, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract swap(fromToken: string, toToken: string, fromAmount: bigint, fromCoinObjects: string[]): Promise<Transaction>;
+    abstract stake(lpCoinObjects: string[], amount: bigint, pool: string, tx?: Transaction): Transaction;
+    abstract unstake(credentials: IBaseCredential[], amount: bigint, pool: string, tx?: Transaction): Transaction;
+    abstract openPosition(collateralToken: string, indexToken: string, size: bigint, collateralAmount: bigint, coinObjects: string[], long: boolean, reserveAmount: bigint, indexPrice: number, collateralPrice: number, isLimitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, referralAddress?: string, sender?: string, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract decreasePosition(pcpId: string, collateralToken: string, indexToken: string, amount: bigint, long: boolean, indexPrice: number, collateralPrice: number, isTriggerOrder?: boolean, isTakeProfitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, coinObjects?: string[], sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract decreaseMultiPositions(positions: Array<{
+        pcpId: string;
+        collateralToken: string;
+        indexToken: string;
+        amount: bigint;
+        long: boolean;
+        indexPrice: number;
+        collateralPrice: number;
+        isTriggerOrder?: boolean;
+        isTakeProfitOrder?: boolean;
+        isIocOrder?: boolean;
+        pricesSlippage?: number;
+        collateralSlippage?: number;
+        relayerFee?: bigint;
+        coinObjects?: string[];
+    }>, tx?: Transaction): Promise<Transaction>;
+    abstract pledgeInPosition(pcpId: string, collateralToken: string, indexToken: string, amount: number, coinObjects: string[], long: boolean, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract redeemFromPosition(pcpId: string, collateralToken: string, indexToken: string, amount: number, long: boolean, sponsoredTx?: boolean, suiCoinObjectsForPythUpdate?: string[]): Promise<Transaction>;
+    abstract cancelOrder(orderCapId: string, collateralToken: string, indexToken: string, long: boolean, type: string, isV11Order?: boolean): Transaction;
+    abstract cancelMultiOrders(orders: Array<{
+        orderCapId: string;
+        collateralToken: string;
+        indexToken: string;
+        long: boolean;
+        type: string;
+        isV11Order?: boolean;
+    }>, tx?: Transaction): Transaction;
+    abstract clearClosedPosition(pcpId: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction): void;
+    abstract clearOpenPositionOrder(orderCapId: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction, isV11Order?: boolean): void;
+    abstract clearDecreasePositionOrder(orderCapId: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction, isV11Order?: boolean): void;
+    abstract openPositionWithSCard(collateralToken: string, indexToken: string, size: bigint, collateralAmount: bigint, coinObjects: string[], long: boolean, reserveAmount: bigint, indexPrice: number, collateralPrice: number, kioskClient: KioskClient, kioskCap: KioskOwnerCap, scard: string, isLimitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, referralAddress?: string, sender?: string): Promise<Transaction>;
+    abstract decreasePositionWithSCard(pcpId: string, collateralToken: string, indexToken: string, amount: bigint, long: boolean, indexPrice: number, collateralPrice: number, kioskClient: KioskClient, kioskCap: KioskOwnerCap, scard: string, isTriggerOrder?: boolean, isTakeProfitOrder?: boolean, isIocOrder?: boolean, pricesSlippage?: number, collateralSlippage?: number, relayerFee?: bigint, coinObjects?: string[]): Promise<Transaction>;
+    abstract decreaseMultiPositionsWithSCard(positions: Array<{
+        pcpId: string;
+        collateralToken: string;
+        indexToken: string;
+        amount: bigint;
+        long: boolean;
+        indexPrice: number;
+        collateralPrice: number;
+        isTriggerOrder?: boolean;
+        isTakeProfitOrder?: boolean;
+        isIocOrder?: boolean;
+        pricesSlippage?: number;
+        collateralSlippage?: number;
+        relayerFee?: bigint;
+        coinObjects?: string[];
+    }>, kioskClient: KioskClient, kioskCap: KioskOwnerCap, scard: string, tx?: Transaction): Promise<Transaction>;
+    /**
+     * Default: not supported. Override in subclasses that support S Card claim (e.g. SLP).
+     */
+    claimTokenFromSCard(_token: string, _coinObjects: string[], _kioskClient: KioskClient, _kioskCap: KioskOwnerCap, _scard: string): Transaction;
+    abstract addReferral(referrer: string, tx?: Transaction): Transaction;
+    abstract adminUpdatePriceFeed(collateralToken: string, indexToken: string): Promise<Transaction>;
+    abstract adminSettlePosition(positionId: string, owner: string, collateralToken: string, indexToken: string, long: boolean): Transaction;
+    abstract adminDecreasePosition(positionId: string, owner: string, collateralToken: string, indexToken: string, positionAmount: number, amount: bigint, long: boolean, collateralPrice?: number, collateralSlippage?: number, relayerFee?: bigint): Transaction;
+    abstract adminClearClosedPosition(positionId: string, owner: string, collateralToken: string, indexToken: string, long: boolean, tx: Transaction): void;
+    /**
+     * Helper method to initialize oracle transaction block
+     * This is commonly used across all LP token implementations
+     */
+    protected initOracleTransaction(tokens: string[], tx?: Transaction): Promise<Transaction>;
+    /**
+     * Helper method to add clock object to transaction
+     */
+    protected addClockToTransaction(tx: Transaction): {
+        $kind: "Input";
+        Input: number;
+        type?: "object";
+    };
+    /**
+     * Helper method to create move call arguments array
+     */
+    protected createMoveCallArgs(tx: Transaction, args: any[]): any[];
+    /**
+     * Helper method to validate transaction parameters
+     */
+    protected validateTransactionParams(params: {
+        coin?: string;
+        coinObjects?: string[];
+        amount?: number;
+        minAmountOut?: number;
+    }): void;
+    /**
+     * Helper method to validate position parameters
+     */
+    protected validatePositionParams(params: {
+        collateralToken: string;
+        indexToken: string;
+        size: bigint;
+        collateralAmount: bigint;
+        long: boolean;
+    }): void;
+}
+//# sourceMappingURL=BaseAPI.d.mts.map