@typus/typus-perp-sdk 1.2.1 → 1.3.0

package/dist/src/generated/typus_perp/treasury_caps.d.ts

@@ -5,14 +5,17 @@
  * The `treasury_caps` module defines the `TreasuryCaps` struct, which is a shared
  * object that stores the treasury caps for the TLP tokens.
  */
-import { MoveStruct, type RawTransactionArgument } from "../utils/index.js";
-import { type Transaction } from "@mysten/sui/transactions";
+import { MoveStruct, type RawTransactionArgument } from '../utils/index';
+import { type Transaction } from '@mysten/sui/transactions';
 export declare const TreasuryCaps: MoveStruct<{
-    id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    id: MoveStruct<{
+        id: import("@mysten/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    }, "0x2::object::UID">;
 }, "@typus/perp::treasury_caps::TreasuryCaps">;
 export interface InitOptions {
     package?: string;
-    arguments?: [];
+    arguments?: [
+    ];
 }
 export declare function init(options?: InitOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
 export interface GetMutTreasuryCapArguments {
@@ -20,8 +23,12 @@ export interface GetMutTreasuryCapArguments {
 }
 export interface GetMutTreasuryCapOptions {
     package?: string;
-    arguments: GetMutTreasuryCapArguments | [treasuryCaps: RawTransactionArgument<string>];
-    typeArguments: [string];
+    arguments: GetMutTreasuryCapArguments | [
+        treasuryCaps: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
 }
 /** Gets a mutable reference to a treasury cap. WARNING: no authority check inside */
 export declare function getMutTreasuryCap(options: GetMutTreasuryCapOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
@@ -37,6 +44,8 @@ export interface ManagerStoreTreasuryCapOptions {
         treasuryCaps: RawTransactionArgument<string>,
         treasuryCap: RawTransactionArgument<string>
     ];
-    typeArguments: [string];
+    typeArguments: [
+        string
+    ];
 }
 export declare function managerStoreTreasuryCap(options: ManagerStoreTreasuryCapOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;

package/dist/src/generated/typus_perp/treasury_caps.js

@@ -2,6 +2,39 @@
 /**************************************************************
  * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
  **************************************************************/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreasuryCaps = void 0;
 exports.init = init;
@@ -11,45 +44,48 @@ exports.managerStoreTreasuryCap = managerStoreTreasuryCap;
  * The `treasury_caps` module defines the `TreasuryCaps` struct, which is a shared
  * object that stores the treasury caps for the TLP tokens.
  */
-const index_js_1 = require("../utils/index.js");
-const bcs_1 = require("@mysten/sui/bcs");
-const $moduleName = "@typus/perp::treasury_caps";
-exports.TreasuryCaps = new index_js_1.MoveStruct({
-    name: `${$moduleName}::TreasuryCaps`,
-    fields: {
-        id: bcs_1.bcs.Address,
-    },
-});
+const index_1 = require("../utils/index");
+const object = __importStar(require("./deps/sui/object"));
+const $moduleName = '@typus/perp::treasury_caps';
+exports.TreasuryCaps = new index_1.MoveStruct({ name: `${$moduleName}::TreasuryCaps`, fields: {
+        id: object.UID
+    } });
 function init(options = {}) {
-    const packageAddress = options.package ?? "@typus/perp";
+    const packageAddress = options.package ?? '@typus/perp';
     return (tx) => tx.moveCall({
         package: packageAddress,
-        module: "treasury_caps",
-        function: "init",
+        module: 'treasury_caps',
+        function: 'init',
     });
 }
 /** Gets a mutable reference to a treasury cap. WARNING: no authority check inside */
 function getMutTreasuryCap(options) {
-    const packageAddress = options.package ?? "@typus/perp";
-    const argumentsTypes = [null];
+    const packageAddress = options.package ?? '@typus/perp';
+    const argumentsTypes = [
+        `${packageAddress}::treasury_caps::TreasuryCaps`
+    ];
     const parameterNames = ["treasuryCaps"];
     return (tx) => tx.moveCall({
         package: packageAddress,
-        module: "treasury_caps",
-        function: "get_mut_treasury_cap",
-        arguments: (0, index_js_1.normalizeMoveArguments)(options.arguments, argumentsTypes, parameterNames),
-        typeArguments: options.typeArguments,
+        module: 'treasury_caps',
+        function: 'get_mut_treasury_cap',
+        arguments: (0, index_1.normalizeMoveArguments)(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
     });
 }
 function managerStoreTreasuryCap(options) {
-    const packageAddress = options.package ?? "@typus/perp";
-    const argumentsTypes = [null, null, null];
+    const packageAddress = options.package ?? '@typus/perp';
+    const argumentsTypes = [
+        `${packageAddress}::admin::Version`,
+        `${packageAddress}::treasury_caps::TreasuryCaps`,
+        `0x0000000000000000000000000000000000000000000000000000000000000002::coin::TreasuryCap<${options.typeArguments[0]}>`
+    ];
     const parameterNames = ["version", "treasuryCaps", "treasuryCap"];
     return (tx) => tx.moveCall({
         package: packageAddress,
-        module: "treasury_caps",
-        function: "manager_store_treasury_cap",
-        arguments: (0, index_js_1.normalizeMoveArguments)(options.arguments, argumentsTypes, parameterNames),
-        typeArguments: options.typeArguments,
+        module: 'treasury_caps',
+        function: 'manager_store_treasury_cap',
+        arguments: (0, index_1.normalizeMoveArguments)(options.arguments, argumentsTypes, parameterNames),
+        typeArguments: options.typeArguments
     });
 }

package/dist/src/generated/typus_perp/user_account.d.ts

@@ -0,0 +1,40 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * The `user_account` module defines the `UserAccount` and `UserAccountCap`
+ * structs, and the logic for creating, updating, and using them.
+ */
+import { MoveStruct } from '../utils/index';
+export declare const UserAccount: MoveStruct<{
+    id: MoveStruct<{
+        id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    }, "0x2::object::UID">;
+    /** The address of the owner of the user account. */
+    owner: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    /** A vector of the delegate users. */
+    delegate_user: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string[], Iterable<string | Uint8Array<ArrayBufferLike>> & {
+        length: number;
+    }, string>;
+    /** A vector of the symbols of the tokens in the user account. */
+    symbols: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<{
+        name: string;
+    }[], Iterable<{
+        name: string;
+    }> & {
+        length: number;
+    }, string>;
+    /** Padding for future use. */
+    u64_padding: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string[], Iterable<string | number | bigint> & {
+        length: number;
+    }, string>;
+}, "@typus/perp::user_account::UserAccount">;
+export declare const UserAccountCap: MoveStruct<{
+    id: MoveStruct<{
+        id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    }, "0x2::object::UID">;
+    /** The address of the owner of the user account. */
+    owner: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    /** The ID of the user account. */
+    user_account_id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+}, "@typus/perp::user_account::UserAccountCap">;

package/dist/src/generated/typus_perp/user_account.js

@@ -0,0 +1,66 @@
+"use strict";
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserAccountCap = exports.UserAccount = void 0;
+/**
+ * The `user_account` module defines the `UserAccount` and `UserAccountCap`
+ * structs, and the logic for creating, updating, and using them.
+ */
+const index_1 = require("../utils/index");
+const bcs_1 = require("@mysten/sui/bcs");
+const object = __importStar(require("./deps/sui/object"));
+const type_name = __importStar(require("./deps/std/type_name"));
+const $moduleName = '@typus/perp::user_account';
+exports.UserAccount = new index_1.MoveStruct({ name: `${$moduleName}::UserAccount`, fields: {
+        id: object.UID,
+        /** The address of the owner of the user account. */
+        owner: bcs_1.bcs.Address,
+        /** A vector of the delegate users. */
+        delegate_user: bcs_1.bcs.vector(bcs_1.bcs.Address),
+        /** A vector of the symbols of the tokens in the user account. */
+        symbols: bcs_1.bcs.vector(type_name.TypeName),
+        /** Padding for future use. */
+        u64_padding: bcs_1.bcs.vector(bcs_1.bcs.u64())
+    } });
+exports.UserAccountCap = new index_1.MoveStruct({ name: `${$moduleName}::UserAccountCap`, fields: {
+        id: object.UID,
+        /** The address of the owner of the user account. */
+        owner: bcs_1.bcs.Address,
+        /** The ID of the user account. */
+        user_account_id: bcs_1.bcs.Address
+    } });

package/dist/src/generated/typus_stake_pool/admin.d.ts

@@ -5,12 +5,81 @@
  * The `admin` module provides administrative functionalities for the Typus Stake
  * Pool. It includes version management, authority control, and fee handling.
  */
-import { MoveStruct, type RawTransactionArgument } from "../utils/index.js";
-import { type Transaction } from "@mysten/sui/transactions";
+import { MoveStruct, type RawTransactionArgument } from '../utils/index';
+import { type Transaction } from '@mysten/sui/transactions';
+export declare const FeeInfo: MoveStruct<{
+    /** The type name of the token. */
+    token: MoveStruct<{
+        name: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string, "string">;
+    }, "std::type_name::TypeName">;
+    /** The amount of fees collected. */
+    value: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | number | bigint, "u64">;
+}, "@typus/stake-pool::admin::FeeInfo">;
+export declare const FeePool: MoveStruct<{
+    id: MoveStruct<{
+        id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    }, "0x2::object::UID">;
+    /** A vector of `FeeInfo` structs. */
+    fee_infos: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<{
+        token: {
+            name: string;
+        };
+        value: string;
+    }[], Iterable<{
+        token: {
+            name: string;
+        };
+        value: string | number | bigint;
+    }> & {
+        length: number;
+    }, string>;
+}, "@typus/stake-pool::admin::FeePool">;
 export declare const Version: MoveStruct<{
-    id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    id: MoveStruct<{
+        id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    }, "0x2::object::UID">;
     /** The version number. */
     value: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | number | bigint, "u64">;
+    /** The fee pool for protocol fees. */
+    fee_pool: MoveStruct<{
+        id: MoveStruct<{
+            id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+        }, "0x2::object::UID">;
+        /** A vector of `FeeInfo` structs. */
+        fee_infos: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<{
+            token: {
+                name: string;
+            };
+            value: string;
+        }[], Iterable<{
+            token: {
+                name: string;
+            };
+            value: string | number | bigint;
+        }> & {
+            length: number;
+        }, string>;
+    }, "@typus/stake-pool::admin::FeePool">;
+    /** The fee pool for liquidator fees. */
+    liquidator_fee_pool: MoveStruct<{
+        id: MoveStruct<{
+            id: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+        }, "0x2::object::UID">;
+        /** A vector of `FeeInfo` structs. */
+        fee_infos: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<{
+            token: {
+                name: string;
+            };
+            value: string;
+        }[], Iterable<{
+            token: {
+                name: string;
+            };
+            value: string | number | bigint;
+        }> & {
+            length: number;
+        }, string>;
+    }, "@typus/stake-pool::admin::FeePool">;
     /** The list of authorized addresses. */
     authority: MoveStruct<{
         contents: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string[], Iterable<string | Uint8Array<ArrayBufferLike>> & {
@@ -22,12 +91,30 @@ export declare const Version: MoveStruct<{
         length: number;
     }, string>;
 }, "@typus/stake-pool::admin::Version">;
+export declare const SendFeeEvent: MoveStruct<{
+    /** The type name of the token. */
+    token: MoveStruct<{
+        name: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string, "string">;
+    }, "std::type_name::TypeName">;
+    /** The amount of fees sent. */
+    amount: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | number | bigint, "u64">;
+}, "@typus/stake-pool::admin::SendFeeEvent">;
+export declare const ProtocolFeeEvent: MoveStruct<{
+    /** The type name of the token. */
+    token: MoveStruct<{
+        name: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string, "string">;
+    }, "std::type_name::TypeName">;
+    /** The amount of fees charged. */
+    amount: import("@mysten/sui/bcs", { with: { "resolution-mode": "import" } }).BcsType<string, string | number | bigint, "u64">;
+}, "@typus/stake-pool::admin::ProtocolFeeEvent">;
 export interface VersionCheckArguments {
     version: RawTransactionArgument<string>;
 }
 export interface VersionCheckOptions {
     package?: string;
-    arguments: VersionCheckArguments | [version: RawTransactionArgument<string>];
+    arguments: VersionCheckArguments | [
+        version: RawTransactionArgument<string>
+    ];
 }
 /** Checks if the contract version is valid. */
 export declare function versionCheck(options: VersionCheckOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
@@ -36,13 +123,16 @@ export interface UpgradeArguments {
 }
 export interface UpgradeOptions {
     package?: string;
-    arguments: UpgradeArguments | [version: RawTransactionArgument<string>];
+    arguments: UpgradeArguments | [
+        version: RawTransactionArgument<string>
+    ];
 }
 /** Upgrades the contract version. WARNING: no authority check inside */
 export declare function upgrade(options: UpgradeOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
 export interface InitOptions {
     package?: string;
-    arguments?: [];
+    arguments?: [
+    ];
 }
 /** Initializes the contract. */
 export declare function init(options?: InitOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
@@ -51,7 +141,9 @@ export interface VerifyArguments {
 }
 export interface VerifyOptions {
     package?: string;
-    arguments: VerifyArguments | [version: RawTransactionArgument<string>];
+    arguments: VerifyArguments | [
+        version: RawTransactionArgument<string>
+    ];
 }
 /** [Authorized Function] Verifies if the sender is an authorized user. */
 export declare function verify(options: VerifyOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
@@ -61,7 +153,10 @@ export interface AddAuthorizedUserArguments {
 }
 export interface AddAuthorizedUserOptions {
     package?: string;
-    arguments: AddAuthorizedUserArguments | [version: RawTransactionArgument<string>, userAddress: RawTransactionArgument<string>];
+    arguments: AddAuthorizedUserArguments | [
+        version: RawTransactionArgument<string>,
+        userAddress: RawTransactionArgument<string>
+    ];
 }
 /** [Authorized Function] Adds an authorized user. */
 export declare function addAuthorizedUser(options: AddAuthorizedUserOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
@@ -71,7 +166,10 @@ export interface RemoveAuthorizedUserArguments {
 }
 export interface RemoveAuthorizedUserOptions {
     package?: string;
-    arguments: RemoveAuthorizedUserArguments | [version: RawTransactionArgument<string>, userAddress: RawTransactionArgument<string>];
+    arguments: RemoveAuthorizedUserArguments | [
+        version: RawTransactionArgument<string>,
+        userAddress: RawTransactionArgument<string>
+    ];
 }
 /** [Authorized Function] Removes an authorized user. */
 export declare function removeAuthorizedUser(options: RemoveAuthorizedUserOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
@@ -81,7 +179,10 @@ export interface InstallEcosystemManagerCapEntryArguments {
 }
 export interface InstallEcosystemManagerCapEntryOptions {
     package?: string;
-    arguments: InstallEcosystemManagerCapEntryArguments | [version: RawTransactionArgument<string>, typusEcosystemVersion: RawTransactionArgument<string>];
+    arguments: InstallEcosystemManagerCapEntryArguments | [
+        version: RawTransactionArgument<string>,
+        typusEcosystemVersion: RawTransactionArgument<string>
+    ];
 }
 /**
  * [Authorized Function] Installs the ecosystem manager cap. TODO: can be remove
@@ -107,3 +208,36 @@ export interface AddTailsExpAmountOptions {
 }
 /** Adds tails experience points to a user. */
 export declare function addTailsExpAmount(options: AddTailsExpAmountOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
+export interface SendFeeArguments {
+    version: RawTransactionArgument<string>;
+}
+export interface SendFeeOptions {
+    package?: string;
+    arguments: SendFeeArguments | [
+        version: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+/**
+ * Sends the collected fees to the fee address. Safe with constant address as
+ * receiver
+ */
+export declare function sendFee(options: SendFeeOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;
+export interface ChargeFeeArguments {
+    version: RawTransactionArgument<string>;
+    balance: RawTransactionArgument<string>;
+}
+export interface ChargeFeeOptions {
+    package?: string;
+    arguments: ChargeFeeArguments | [
+        version: RawTransactionArgument<string>,
+        balance: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+/** Charges a protocol fee. */
+export declare function chargeFee(options: ChargeFeeOptions): (tx: Transaction) => import("@mysten/sui/transactions", { with: { "resolution-mode": "import" } }).TransactionResult;