@typus/typus-perp-sdk 1.1.32-codegen-exp14 → 1.1.32-codegen-exp15-profit-vault

package/dist/src/fetch.d.ts

@@ -423,6 +423,7 @@ export declare function getDeactivatingShares(client: TypusClient, input: {
  * @returns [liquidationPrice, pnl(in USD)]
  */
 export declare function getLiquidationPriceAndPnl(client: TypusClient, input: {
+    oracle?: string;
     positions: (typeof Position.$inferType)[];
 }): Promise<PositionInfo[]>;
 interface PositionInfo {
@@ -534,4 +535,42 @@ export declare function getAllPositionsWithTradingSymbol(client: TypusClient, in
     } | null;
     u64_padding: string[];
 }[]>;
+export type UserProfit = {
+    collateral_token: {
+        name: string;
+    };
+    base_token: {
+        name: string;
+    };
+    position_id: string;
+    order_id: string;
+    amount: string;
+    create_ts_ms: string;
+};
+export type LockedUserProfit = {
+    user_profit: UserProfit;
+    create_ts_ms: string;
+};
+export declare function fetchUserProfits(client: TypusClient, input: {
+    profitVault: string;
+    version: string;
+    user: string;
+}): Promise<UserProfit[]>;
+export declare function fetchLockedUserProfits(client: TypusClient, input: {
+    lockVault: string;
+    version: string;
+    user: string;
+}): Promise<LockedUserProfit[]>;
+export declare function fetchAllUserProfits(client: TypusClient, input?: {
+    profitVault?: string;
+}): Promise<{
+    user: string;
+    profits: UserProfit[];
+}[]>;
+export declare function fetchAllLockedUserProfits(client: TypusClient, input?: {
+    lockVault?: string;
+}): Promise<{
+    user: string;
+    lockedUserProfits: LockedUserProfit[];
+}[]>;
 export {};

package/dist/src/fetch.js

@@ -13,10 +13,16 @@ exports.getDeactivatingShares = getDeactivatingShares;
 exports.getLiquidationPriceAndPnl = getLiquidationPriceAndPnl;
 exports.getAllPositions = getAllPositions;
 exports.getAllPositionsWithTradingSymbol = getAllPositionsWithTradingSymbol;
+exports.fetchUserProfits = fetchUserProfits;
+exports.fetchLockedUserProfits = fetchLockedUserProfits;
+exports.fetchAllUserProfits = fetchAllUserProfits;
+exports.fetchAllLockedUserProfits = fetchAllLockedUserProfits;
 const transactions_1 = require("@mysten/sui/transactions");
+const client_1 = require("@mysten/sui/client");
 const bcs_1 = require("@mysten/bcs");
 const constants_1 = require("@typus/typus-sdk/dist/src/constants");
 const utils_1 = require("@typus/typus-sdk/dist/src/utils");
+const utils_2 = require("@typus/typus-sdk/dist/src/utils");
 const _1 = require(".");
 const trading_1 = require("./generated/typus_perp/trading");
 const lp_pool_1 = require("./generated/typus_perp/lp_pool");
@@ -294,10 +300,16 @@ async function getLiquidationPriceAndPnl(client, input) {
         tokens.push(TOKEN);
         tokens.push(BASE_TOKEN);
     }
-    await (0, utils_1.updatePyth)(client.pythClient, tx, Array.from(new Set(tokens)));
-    for (let token of Array.from(new Set(tokens))) {
+    const tokensWithoutTypus = tokens.filter((token) => token !== "TYPUS");
+    await (0, utils_1.updatePyth)(client.pythClient, tx, Array.from(new Set(tokensWithoutTypus)));
+    for (let token of Array.from(new Set(tokensWithoutTypus))) {
         (0, utils_1.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
     }
+    if (tokens.includes("TYPUS")) {
+        // TODO: update oracle contract
+        const oracleContract = input.oracle ?? "0x51fc5517f5ba4e3ba8862cd74c345e7294193c693ab41376694d1c516033e2e8";
+        tx = await (0, utils_2.updateOracleWithSignatureTx)(_1.NETWORK, tx, oracleContract, constants_1.tokenType[_1.NETWORK]["TYPUS"]);
+    }
     for (let position of input.positions) {
         // parse from Position
         let TOKEN = (0, constants_1.typeArgToAsset)(position.collateral_token.name);
@@ -421,3 +433,171 @@ async function getAllPositionsWithTradingSymbol(client, input) {
     }
     return positions;
 }
+const TypeNameBcs = bcs_1.bcs.struct("TypeName", {
+    name: bcs_1.bcs.string(),
+});
+const UserProfitBcs = bcs_1.bcs.struct("UserProfit", {
+    collateral_token: TypeNameBcs,
+    base_token: TypeNameBcs,
+    position_id: bcs_1.bcs.u64(),
+    order_id: bcs_1.bcs.u64(),
+    amount: bcs_1.bcs.u64(),
+    create_ts_ms: bcs_1.bcs.u64(),
+});
+const LockedUserProfitBcs = bcs_1.bcs.struct("LockedUserProfit", {
+    user_profit: UserProfitBcs,
+    create_ts_ms: bcs_1.bcs.u64(),
+});
+async function fetchUserProfits(client, input) {
+    let tx = new transactions_1.Transaction();
+    tx.moveCall({
+        target: `${_1.PERP_PACKAGE_ID}::profit_vault::get_user_profits`,
+        arguments: [tx.object(input.version), tx.object(input.profitVault), tx.pure.address(input.user)],
+    });
+    const res = await client.devInspectTransactionBlock({
+        sender: constants_1.SENDER,
+        transactionBlock: tx,
+    });
+    if (!res.results?.[0]?.returnValues?.[0]?.[0]) {
+        return [];
+    }
+    const returnValues = res.results[0].returnValues[0][0];
+    const reader = new bcs_1.BcsReader(new Uint8Array(returnValues));
+    const profits = [];
+    reader.readVec((reader) => {
+        const length = reader.readULEB();
+        const bytes = reader.readBytes(length);
+        const profit = UserProfitBcs.parse(Uint8Array.from(Array.from(bytes)));
+        profits.push(profit);
+    });
+    return profits;
+}
+async function fetchLockedUserProfits(client, input) {
+    let tx = new transactions_1.Transaction();
+    tx.moveCall({
+        target: `${_1.PERP_PACKAGE_ID}::profit_vault::get_locked_user_profits`,
+        arguments: [tx.object(_1.PERP_VERSION), tx.object(input.lockVault), tx.pure.address(input.user)],
+    });
+    const res = await client.devInspectTransactionBlock({
+        sender: constants_1.SENDER,
+        transactionBlock: tx,
+    });
+    if (!res.results?.[0]?.returnValues?.[0]?.[0]) {
+        return [];
+    }
+    const returnValues = res.results[0].returnValues[0][0];
+    const reader = new bcs_1.BcsReader(new Uint8Array(returnValues));
+    const lockedUserProfits = [];
+    reader.readVec((reader) => {
+        const length = reader.readULEB();
+        const bytes = reader.readBytes(length);
+        const profit = LockedUserProfitBcs.parse(Uint8Array.from(Array.from(bytes)));
+        lockedUserProfits.push(profit);
+    });
+    return lockedUserProfits;
+}
+async function fetchAllUserProfits(client, input) {
+    const provider = new client_1.SuiClient({ url: client.config.rpcEndpoint });
+    const profitVaultId = input?.profitVault ?? _1.PROFIT_VAULT;
+    // 1. Read ProfitVault object to get user_profits Table ID
+    const vaultResponse = await provider.getObject({
+        id: profitVaultId,
+        options: { showContent: true },
+    });
+    if (!vaultResponse.data?.content || vaultResponse.data.content.dataType !== "moveObject") {
+        return [];
+    }
+    const fields = vaultResponse.data.content.fields;
+    const tableId = fields?.user_profits?.fields?.id?.id;
+    if (!tableId) {
+        return [];
+    }
+    // 2. Get all dynamic fields (user addresses) from the Table
+    let cursor = null;
+    const allUsers = [];
+    while (true) {
+        const dynamicFields = await provider.getDynamicFields({
+            parentId: tableId,
+            cursor,
+            limit: 50,
+        });
+        for (const field of dynamicFields.data) {
+            const userAddress = field.name.value;
+            if (userAddress) {
+                allUsers.push(userAddress);
+            }
+        }
+        if (!dynamicFields.hasNextPage) {
+            break;
+        }
+        cursor = dynamicFields.nextCursor ?? null;
+    }
+    // 3. For each user, fetch their profits
+    const fetchUserProfitsPromises = [];
+    for (const user of allUsers) {
+        try {
+            const fetchUserProfitsWithUser = async () => {
+                const profits = await fetchUserProfits(client, { profitVault: profitVaultId, version: _1.PERP_VERSION, user });
+                return { user, profits };
+            };
+            fetchUserProfitsPromises.push(fetchUserProfitsWithUser());
+        }
+        catch (e) {
+            console.error(`Failed to get profits for user ${user}:`, e);
+        }
+    }
+    const results = await Promise.all(fetchUserProfitsPromises);
+    return results;
+}
+async function fetchAllLockedUserProfits(client, input) {
+    const provider = new client_1.SuiClient({ url: client.config.rpcEndpoint });
+    // 1. Read LockVault object to get locked_user_profits Table ID
+    const vaultResponse = await provider.getObject({
+        id: input?.lockVault ?? _1.LOCK_VAULT,
+        options: { showContent: true },
+    });
+    if (!vaultResponse.data?.content || vaultResponse.data.content.dataType !== "moveObject") {
+        return [];
+    }
+    const fields = vaultResponse.data.content.fields;
+    const tableId = fields?.locked_user_profits?.fields?.id?.id;
+    if (!tableId) {
+        return [];
+    }
+    // 2. Get all dynamic fields (user addresses) from the Table
+    let cursor = null;
+    const allUsers = [];
+    while (true) {
+        const dynamicFields = await provider.getDynamicFields({
+            parentId: tableId,
+            cursor,
+            limit: 50,
+        });
+        for (const field of dynamicFields.data) {
+            const userAddress = field.name.value;
+            if (userAddress) {
+                allUsers.push(userAddress);
+            }
+        }
+        if (!dynamicFields.hasNextPage) {
+            break;
+        }
+        cursor = dynamicFields.nextCursor ?? null;
+    }
+    // 3. For each user, fetch their locked profits
+    const fetchLockedUserProfitsPromises = [];
+    for (const user of allUsers) {
+        try {
+            const fetchLockedUserProfitsWithUser = async () => {
+                const lockedUserProfits = await fetchLockedUserProfits(client, { lockVault: _1.LOCK_VAULT, version: _1.PERP_VERSION, user });
+                return { user, lockedUserProfits };
+            };
+            fetchLockedUserProfitsPromises.push(fetchLockedUserProfitsWithUser());
+        }
+        catch (e) {
+            console.error(`Failed to get locked profits for user ${user}:`, e);
+        }
+    }
+    const results = await Promise.all(fetchLockedUserProfitsPromises);
+    return results;
+}

package/dist/src/index.d.ts

@@ -11,3 +11,5 @@ export declare const TLP_TREASURY_CAP: string;
 export declare const STAKE_POOL: string;
 export declare const STAKE_POOL_VERSION: string;
 export declare const COMPETITION_CONFIG: string;
+export declare const PROFIT_VAULT: string;
+export declare const LOCK_VAULT: string;

package/dist/src/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COMPETITION_CONFIG = exports.STAKE_POOL_VERSION = exports.STAKE_POOL = exports.TLP_TREASURY_CAP = exports.PERP_VERSION = exports.MARKET = exports.LIQUIDITY_POOL = exports.LP_POOL = exports.STAKE_PACKAGE_ID = exports.PERP_PACKAGE_ID = exports.NETWORK = void 0;
+exports.LOCK_VAULT = exports.PROFIT_VAULT = exports.COMPETITION_CONFIG = exports.STAKE_POOL_VERSION = exports.STAKE_POOL = exports.TLP_TREASURY_CAP = exports.PERP_VERSION = exports.MARKET = exports.LIQUIDITY_POOL = exports.LP_POOL = exports.STAKE_PACKAGE_ID = exports.PERP_PACKAGE_ID = exports.NETWORK = void 0;
 __exportStar(require("./fetch"), exports);
 __exportStar(require("./user"), exports);
 const dotenv_1 = __importDefault(require("dotenv"));
@@ -27,7 +27,7 @@ dotenv_1.default.config();
 exports.NETWORK = process.env.NEXT_PUBLIC_CLUSTER == "testnet" ? "TESTNET" : "MAINNET";
 exports.PERP_PACKAGE_ID = exports.NETWORK == "MAINNET"
     ? "0xe27969a70f93034de9ce16e6ad661b480324574e68d15a64b513fd90eb2423e5"
-    : "0x94cd358f552e9dd5df837de85939a9d1d682e97480740a203121e6f4c0078853";
+    : "0x7adddfb77658ff43ad0281e264fdb43403a1b97bc2f6328b55279dfb4253e1e0";
 exports.STAKE_PACKAGE_ID = exports.NETWORK == "MAINNET"
     ? "0xc427209145715a00a93d7e674a95c556a7147d79fda1bbaeb1a1cac5f9923966"
     : "0x02b94b340a8810f6c451bc244dc2dd8d9d50cf86d727798969ca2c287c3186aa";
@@ -59,3 +59,9 @@ exports.STAKE_POOL_VERSION = exports.NETWORK == "MAINNET"
 exports.COMPETITION_CONFIG = exports.NETWORK == "MAINNET"
     ? "0x36056abf9adde86f81667dad680a8ac98868c9fc1cb4d519fd2222d5d4522906"
     : "0x2b811b120177839555aabdc2c28b28078170e663e855d29aa9072013d4fc918d";
+exports.PROFIT_VAULT = exports.NETWORK == "MAINNET"
+    ? "" // TODO: Add mainnet PROFIT_VAULT address
+    : "0xb1d603139b24db2c46f6a423c8613ce677f329a0b159ff6e57672f3b663aec47"; // TODO: Add testnet PROFIT_VAULT address
+exports.LOCK_VAULT = exports.NETWORK == "MAINNET"
+    ? "" // TODO: Add mainnet LOCK_VAULT address
+    : "0x25dd9540f031b9a62b83784a727e1ef410f9aa91ecf7e3bb27a0c61f8ceecbfb"; // TODO: Add testnet LOCK_VAULT address

package/dist/src/user/order.d.ts

@@ -9,6 +9,7 @@ export declare function findMarketIndex(client: TypusClient, input: {
 }): number | undefined;
 export declare function createTradingOrder(client: TypusClient, tx: Transaction, input: {
     perpIndex: string;
+    poolIndex: string;
     coins: string[];
     cToken: TOKEN;
     amount: string;
@@ -19,6 +20,7 @@ export declare function createTradingOrder(client: TypusClient, tx: Transaction,
     isStopOrder: boolean;
     reduceOnly: boolean;
     linkedPositionId: string | null;
+    oracleContract?: string;
     suiCoins?: string[];
 }): Promise<Transaction>;
 export declare function zeroCoin(tx: Transaction, typeArgs: [string]): import("@mysten/sui/transactions").TransactionResult;

package/dist/src/user/order.js

@@ -10,13 +10,14 @@ exports.collectPositionFundingFee = collectPositionFundingFee;
 const trading_1 = require("../../src/generated/typus_perp/trading");
 const __1 = require("..");
 const utils_1 = require("@typus/typus-sdk/dist/src/utils");
+const utils_2 = require("@typus/typus-sdk/dist/src/utils");
 const constants_1 = require("@typus/typus-sdk/dist/src/constants");
-const utils_2 = require("@mysten/sui/utils");
+const utils_3 = require("@mysten/sui/utils");
 function findMarketIndex(client, input) {
     let target = constants_1.tokenType[client.config.network][input.tradingToken];
     for (let i = 0; i < input.markets.length; i++) {
         for (let symbol of input.markets[i].symbols) {
-            if ((0, utils_2.normalizeStructTag)(symbol.name) == target) {
+            if ((0, utils_3.normalizeStructTag)(symbol.name) == target) {
                 return i;
             }
         }
@@ -33,19 +34,24 @@ async function createTradingOrder(client, tx, input) {
     let suiCoin;
     if (TOKEN == "SUI" && client.config.sponsored) {
         // split together
-        [coin, suiCoin] = (0, utils_1.splitCoins)(tx, constants_1.tokenType.MAINNET.SUI, input.coins, [input.amount, tokens.length.toString()], client.config.sponsored);
+        [coin, suiCoin] = (0, utils_2.splitCoins)(tx, constants_1.tokenType.MAINNET.SUI, input.coins, [input.amount, tokens.length.toString()], client.config.sponsored);
     }
     else if (client.config.sponsored) {
-        coin = (0, utils_1.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
-        suiCoin = (0, utils_1.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
+        coin = (0, utils_2.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
+        suiCoin = (0, utils_2.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
     }
     else {
-        coin = (0, utils_1.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
+        coin = (0, utils_2.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
         // no suiCoin
     }
-    await (0, utils_1.updatePyth)(client.pythClient, tx, tokens, suiCoin);
-    for (let token of tokens) {
-        (0, utils_1.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
+    const tokensWithoutTypus = Array.from(new Set([TOKEN])).filter((token) => token !== "TYPUS");
+    await (0, utils_2.updatePyth)(client.pythClient, tx, tokensWithoutTypus, suiCoin);
+    for (let token of tokensWithoutTypus) {
+        (0, utils_2.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
+    }
+    if (tokens.includes("TYPUS")) {
+        const oracleContract = input.oracleContract ?? "0x51fc5517f5ba4e3ba8862cd74c345e7294193c693ab41376694d1c516033e2e8";
+        tx = await (0, utils_1.updateOracleWithSignatureTx)(__1.NETWORK, tx, oracleContract, constants_1.tokenType[__1.NETWORK]["TYPUS"]);
     }
     tx.add((0, trading_1.createTradingOrder)({
         arguments: {
@@ -53,7 +59,7 @@ async function createTradingOrder(client, tx, input) {
             registry: __1.MARKET,
             poolRegistry: __1.LP_POOL,
             marketIndex: BigInt(input.perpIndex),
-            poolIndex: BigInt(input.perpIndex),
+            poolIndex: BigInt(input.poolIndex),
             typusOracleCToken: constants_1.oracle[__1.NETWORK][TOKEN],
             typusOracleTradingSymbol: constants_1.oracle[__1.NETWORK][BASE_TOKEN],
             collateral: coin,
@@ -104,19 +110,19 @@ async function increaseCollateral(client, tx, input) {
     let suiCoin;
     if (TOKEN == "SUI" && client.config.sponsored) {
         // split together
-        [coin, suiCoin] = (0, utils_1.splitCoins)(tx, constants_1.tokenType.MAINNET.SUI, input.coins, [input.amount, tokens.length.toString()], client.config.sponsored);
+        [coin, suiCoin] = (0, utils_2.splitCoins)(tx, constants_1.tokenType.MAINNET.SUI, input.coins, [input.amount, tokens.length.toString()], client.config.sponsored);
     }
     else if (client.config.sponsored) {
-        coin = (0, utils_1.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
-        suiCoin = (0, utils_1.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
+        coin = (0, utils_2.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
+        suiCoin = (0, utils_2.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
     }
     else {
-        coin = (0, utils_1.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
+        coin = (0, utils_2.splitCoin)(tx, cToken, input.coins, input.amount, client.config.sponsored);
         // no suiCoin
     }
-    await (0, utils_1.updatePyth)(client.pythClient, tx, tokens, suiCoin);
+    await (0, utils_2.updatePyth)(client.pythClient, tx, tokens, suiCoin);
     for (let token of tokens) {
-        (0, utils_1.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
+        (0, utils_2.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
     }
     // @ts-ignore
     let marketIndex = BigInt(input.position.marketIndex);
@@ -143,11 +149,11 @@ async function releaseCollateral(client, tx, input) {
     let tokens = Array.from(new Set([TOKEN, BASE_TOKEN]));
     let suiCoin;
     if (client.config.sponsored) {
-        suiCoin = (0, utils_1.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
+        suiCoin = (0, utils_2.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
     }
-    await (0, utils_1.updatePyth)(client.pythClient, tx, tokens, suiCoin);
+    await (0, utils_2.updatePyth)(client.pythClient, tx, tokens, suiCoin);
     for (let token of tokens) {
-        (0, utils_1.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
+        (0, utils_2.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
     }
     let cToken = constants_1.tokenType[__1.NETWORK][TOKEN];
     let baseToken = constants_1.tokenType[__1.NETWORK][BASE_TOKEN];
@@ -177,11 +183,11 @@ async function collectPositionFundingFee(client, tx, input) {
     let tokens = Array.from(new Set([TOKEN, BASE_TOKEN]));
     let suiCoin;
     if (client.config.sponsored) {
-        suiCoin = (0, utils_1.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
+        suiCoin = (0, utils_2.splitCoin)(tx, constants_1.tokenType.MAINNET.SUI, input.suiCoins, tokens.length.toString(), client.config.sponsored);
     }
-    await (0, utils_1.updatePyth)(client.pythClient, tx, tokens, suiCoin);
+    await (0, utils_2.updatePyth)(client.pythClient, tx, tokens, suiCoin);
     for (let token of tokens) {
-        (0, utils_1.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
+        (0, utils_2.updateOracleWithPythUsd)(client.pythClient, tx, client.config.package.oracle, token);
     }
     let cToken = constants_1.tokenType[__1.NETWORK][TOKEN];
     let baseToken = constants_1.tokenType[__1.NETWORK][BASE_TOKEN];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@typus/typus-perp-sdk",
-    "version": "1.1.32-codegen-exp14",
+    "version": "1.1.32-codegen-exp15-profit-vault",
     "repository": "https://github.com/Typus-Lab/typus-perp-sdk.git",
     "author": "Typus",
     "description": "typus perp sdk",
@@ -8,7 +8,7 @@
     "dependencies": {
         "@mysten/bcs": "1.9.2",
         "@mysten/sui": "1.44.0",
-        "@typus/typus-sdk": "1.8.30"
+        "@typus/typus-sdk": "1.8.31"
     },
     "resolutions": {
         "@mysten/bcs": "1.9.2",