aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/packages/farms/farmsStakingPool.d.ts

@@ -1,285 +0,0 @@
-import { Apr, Balance, CallerConfig, CoinType, CoinsToDecimals, CoinsToPrice, ObjectId, SuiAddress, Timestamp } from "../../types";
-import { Caller } from "../../general/utils/caller";
-import { ApiFarmsGrantOneTimeAdminCapBody, FarmOwnerOrOneTimeAdminCap, FarmsMultiplier, FarmsStakingPoolObject, FarmsStakingPoolRewardCoin, FarmsVersion } from "./farmsTypes";
-import { AftermathApi } from "../../general/providers";
-/**
- * The `FarmsStakingPool` class represents a staking pool (also referred
- * to as a "vault" in some contexts). It allows reading details about
- * emission schedules, reward tokens, stake coin type, and lock durations,
- * as well as constructing transactions to stake, harvest, and mutate the
- * pool parameters if the user has the correct admin privileges.
- */
-export declare class FarmsStakingPool extends Caller {
-    stakingPool: FarmsStakingPoolObject;
-    readonly Provider?: AftermathApi | undefined;
-    /**
-     * Creates a `FarmsStakingPool` instance based on on-chain pool data.
-     *
-     * @param stakingPool - The on-chain data object describing the pool.
-     * @param config - An optional `CallerConfig` for network settings.
-     * @param Provider - An optional `AftermathApi` for transaction building.
-     */
-    constructor(stakingPool: FarmsStakingPoolObject, config?: CallerConfig, Provider?: AftermathApi | undefined);
-    /**
-     * Fetches the total value locked (TVL) for this staking pool alone.
-     *
-     * @returns A `number` representing this pool's TVL in USD (or another currency).
-     *
-     * @example
-     * ```typescript
-     * const poolTvl = await someFarmsPool.getTVL();
-     * console.log(poolTvl);
-     * ```
-     */
-    getTVL(): Promise<number>;
-    /**
-     * Fetches the total value locked (TVL) of the reward coins in this specific staking pool.
-     *
-     * @returns A `number` representing this pool's reward TVL.
-     *
-     * @example
-     * ```typescript
-     * const rewardTvl = await someFarmsPool.getRewardsTVL();
-     * console.log(rewardTvl);
-     * ```
-     */
-    getRewardsTVL(): Promise<number>;
-    /**
-     * Retrieves the version of this staking pool (1 or 2).
-     */
-    version: () => FarmsVersion;
-    /**
-     * Returns whether this pool uses strict lock enforcement.
-     * Strict: positions must be unlocked before any principal can be withdrawn.
-     */
-    isStrictLockEnforcement: () => boolean;
-    /**
-     * Returns whether this pool uses relaxed lock enforcement.
-     * Relaxed: positions can withdraw principal while locked, forfeiting pro-rata locked rewards.
-     */
-    isRelaxedLockEnforcement: () => boolean;
-    /**
-     * Lists all reward coin types offered by this staking pool.
-     *
-     * @returns An array of `CoinType` strings.
-     */
-    rewardCoinTypes: () => CoinType[];
-    /**
-     * Lists all reward coin types for which this pool currently has a non-zero actual reward balance.
-     *
-     * @returns An array of `CoinType` strings that have > 0 actual rewards.
-     */
-    nonZeroRewardCoinTypes: () => CoinType[];
-    /**
-     * Retrieves the on-chain record for a specific reward coin type in this pool.
-     *
-     * @param inputs - Contains the `coinType` to look up.
-     * @throws If the specified coinType is not found in `rewardCoins`.
-     * @returns A `FarmsStakingPoolRewardCoin` object.
-     */
-    rewardCoin: (inputs: {
-        coinType: CoinType;
-    }) => FarmsStakingPoolRewardCoin;
-    /**
-     * Computes the maximum lock duration (in ms) that remains valid in this staking pool,
-     * factoring in the current time and the pool's emission end.
-     *
-     * @returns The maximum possible lock duration in milliseconds, or 0 if the pool is effectively closed.
-     */
-    maxLockDurationMs: () => number;
-    /**
-     * Calculates and applies newly emitted rewards for each reward coin in this pool,
-     * updating the `rewardsAccumulatedPerShare`. This simulates the on-chain
-     * `emitRewards` logic.
-     *
-     * @example
-     * ```typescript
-     * someFarmsPool.emitRewards();
-     * // The pool's rewardsAccumulatedPerShare fields are now updated.
-     * ```
-     */
-    emitRewards: () => void;
-    /**
-     * Computes an approximate APR for a specific reward coin, based on the current
-     * emission rate, coin price, pool TVL, and the lock multiplier range. This assumes
-     * maximum lock multiplier for the final APR result.
-     *
-     * @param inputs - Includes the `coinType`, its `price` and `decimals`, plus the total `tvlUsd` in the pool.
-     * @returns A numeric APR (0.05 = 5%).
-     */
-    calcApr: (inputs: {
-        coinType: CoinType;
-        price: number;
-        decimals: number;
-        tvlUsd: number;
-    }) => Apr;
-    /**
-     * Computes the total APR contributed by all reward coin types in this pool, summing
-     * up the individual APR for each coin type. This also assumes max lock multiplier.
-     *
-     * @param inputs - Contains price data (`coinsToPrice`), decimal data (`coinsToDecimals`), and the total TVL in USD.
-     * @returns The sum of all coin APRs (0.10 = 10%).
-     */
-    calcTotalApr: (inputs: {
-        coinsToPrice: CoinsToPrice;
-        coinsToDecimals: CoinsToDecimals;
-        tvlUsd: number;
-    }) => Apr;
-    /**
-     * Given a lock duration in ms, calculates the lock multiplier to be used by staked positions.
-     * This function clamps the input duration between the pool's `minLockDurationMs` and
-     * `maxLockDurationMs`.
-     *
-     * @param inputs - An object containing the `lockDurationMs` for which to calculate a multiplier.
-     * @returns A `FarmsMultiplier` (bigint) representing the scaled factor (1.0 = 1e9 if using fixedOneB).
-     */
-    calcMultiplier: (inputs: {
-        lockDurationMs: number;
-    }) => FarmsMultiplier;
-    /**
-     * Builds a transaction to stake tokens into this pool, optionally locking them.
-     *
-     * @param inputs - Contains `stakeAmount`, `lockDurationMs`, `walletAddress`, and optional sponsorship.
-     * @returns A transaction object (or bytes) that can be signed and executed to create a staked position.
-     */
-    getStakeTransaction(inputs: {
-        stakeAmount: Balance;
-        lockDurationMs: Timestamp;
-        walletAddress: SuiAddress;
-        isSponsoredTx?: boolean;
-    }): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Builds a transaction to harvest rewards from multiple staked positions in this pool.
-     *
-     * @param inputs - Contains `stakedPositionIds`, the `walletAddress`, and optionally any others.
-     * @returns A transaction that can be signed and executed to claim rewards from multiple positions.
-     */
-    getHarvestRewardsTransaction(inputs: {
-        stakedPositionIds: ObjectId[];
-        walletAddress: SuiAddress;
-    }): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Builds a transaction to increase the emission rate (or schedule) for specific reward coins.
-     *
-     * @param inputs - Contains the `ownerCapId` that authorizes changes, plus an array of `rewards` with new emission details.
-     * @returns A transaction to be signed and executed by the owner cap holder.
-     */
-    getIncreaseRewardsEmissionsTransaction(inputs: {
-        ownerCapId: ObjectId;
-        rewards: {
-            rewardCoinType: CoinType;
-            emissionScheduleMs: Timestamp;
-            emissionRate: bigint;
-        }[];
-        walletAddress: SuiAddress;
-    }): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Builds a transaction to update the pool's minimum stake amount, only authorized by the `ownerCapId`.
-     *
-     * @param inputs - Contains the new `minStakeAmount`, the `ownerCapId`, and the calling `walletAddress`.
-     * @returns A transaction that can be signed and executed to change the minimum stake requirement.
-     */
-    getUpdateMinStakeAmountTransaction(inputs: {
-        ownerCapId: ObjectId;
-        minStakeAmount: bigint;
-        walletAddress: SuiAddress;
-    }): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Builds a transaction granting a one-time admin cap to another address, allowing them to perform specific
-     * one-time administrative actions (like initializing a reward).
-     *
-     * @param inputs - Body containing the `ownerCapId`, the `recipientAddress`, and the `rewardCoinType`.
-     * @returns A transaction to be executed by the current pool owner.
-     */
-    getGrantOneTimeAdminCapTransaction(inputs: ApiFarmsGrantOneTimeAdminCapBody): import("@mysten/sui/transactions").Transaction;
-    /**
-     * Builds a transaction to initialize a new reward coin in this pool, specifying the amount, emission rate,
-     * and schedule parameters. This can be done by either the `ownerCapId` or a `oneTimeAdminCapId`.
-     *
-     * @param inputs - Contains emission info (rate, schedule) and which cap is used (`ownerCapId` or `oneTimeAdminCapId`).
-     * @returns A transaction object for the reward initialization.
-     */
-    getInitializeRewardTransaction(inputs: {
-        rewardAmount: Balance;
-        emissionScheduleMs: Timestamp;
-        emissionRate: bigint;
-        emissionDelayTimestampMs: Timestamp;
-        rewardCoinType: CoinType;
-        walletAddress: SuiAddress;
-        isSponsoredTx?: boolean;
-    } & FarmOwnerOrOneTimeAdminCap): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Builds a transaction to add more reward coins (top-up) to an existing reward
-     * coin configuration, either as the owner or via a one-time admin cap.
-     *
-     * @param inputs - Contains an array of reward objects, each specifying amount and coin type.
-     * @returns A transaction that can be signed and executed to increase the reward distribution pool.
-     */
-    getTopUpRewardsTransaction(inputs: {
-        rewards: {
-            rewardAmount: Balance;
-            rewardCoinType: CoinType;
-        }[];
-        walletAddress: SuiAddress;
-        isSponsoredTx?: boolean;
-    } & FarmOwnerOrOneTimeAdminCap): Promise<import("@mysten/sui/transactions").Transaction>;
-    /**
-     * Builds a transaction to **remove (withdraw) undistributed reward coins** from the
-     * staking pool for **one or more reward coin types** in a single call.
-     *
-     * Only the **pool owner** (via `ownerCapId`) can remove rewards. One-time admin caps
-     * are **not** permitted for removals. This operation reduces the pool’s remaining
-     * undistributed reward balances; it does **not** affect rewards already accrued/claimed
-     * by stakers.
-     *
-     * Versioning:
-     * - V1 → calls `buildRemoveStakingPoolRewardTxV1`
-     * - V2 → calls `buildRemoveStakingPoolRewardTxV2`
-     *
-     * Notes:
-     * - The effective `stakingPoolId` and `stakeCoinType` are taken from this instance’s
-     *   `this.stakingPool` and override any values passed in `inputs`.
-     *
-     * @param inputs Parameters for reward removal.
-     * @param inputs.rewards Array of removal entries. Each entry specifies:
-     *   - `rewardCoinType`: Coin type to withdraw.
-     *   - `rewardAmount`: Amount to withdraw (base units).
-     * @param inputs.ownerCapId Object ID of the pool OwnerCap that authorizes the removal.
-     * @param inputs.walletAddress Address that will sign/submit the transaction.
-     * @returns A transaction object ready to sign and execute that removes the specified
-     *          undistributed rewards for each entry in `inputs.rewards`.
-     */
-    getRemoveRewardsTransaction(inputs: {
-        rewards: {
-            rewardCoinType: CoinType;
-            rewardAmount: Balance;
-        }[];
-        ownerCapId: ObjectId;
-        walletAddress: SuiAddress;
-    }): import("@mysten/sui/transactions").Transaction;
-    /**
-     * Updates `rewardsAccumulatedPerShare` by distributing `rewardsToEmit` among
-     * the total staked amount with multiplier. This mimics on-chain distribution logic.
-     *
-     * @param inputs - Contains the `rewardsToEmit` and which `rewardCoinIndex` to update.
-     */
-    private increaseRewardsAccumulatedPerShare;
-    /**
-     * Computes how many rewards to emit based on the time since `lastRewardTimestamp` and
-     * the pool's emission schedule, clamped by the total `rewardsRemaining`.
-     */
-    private calcRewardsToEmit;
-    /**
-     * Calculates how many tokens were emitted between two timestamps (Tm and Tn) for a given reward coin,
-     * based on the discrete `emissionRate` and `emissionSchedulesMs`.
-     *
-     * @param inputs - Contains `timestampTm`, `timestampTn`, and the relevant `rewardCoin`.
-     * @returns The total number of tokens emitted in that time window.
-     */
-    private calcRewardsEmittedFromTimeTmToTn;
-    /**
-     * Provides access to the farm-specific provider methods for building transactions.
-     */
-    private useProvider;
-}
-//# sourceMappingURL=farmsStakingPool.d.ts.map

package/dist/packages/farms/farmsStakingPool.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"farmsStakingPool.d.ts","sourceRoot":"","sources":["../../../src/packages/farms/farmsStakingPool.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,GAAG,EACH,OAAO,EACP,YAAY,EACZ,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,UAAU,EAEV,SAAS,EAET,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EACN,gCAAgC,EAIhC,0BAA0B,EAC1B,eAAe,EACf,sBAAsB,EACtB,0BAA0B,EAC1B,YAAY,EACZ,MAAM,cAAc,CAAC;AAMtB,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,MAAM;IASnC,WAAW,EAAE,sBAAsB;aAE1B,QAAQ,CAAC,EAAE,YAAY;IAVxC;;;;;;OAMG;gBAEK,WAAW,EAAE,sBAAsB,EAC1C,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,EAAE,YAAY,YAAA;IAcxC;;;;;;;;;;OAUG;IACU,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAMtC;;;;;;;;;;OAUG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAU7C;;OAEG;IACI,OAAO,QAAO,YAAY,CAE/B;IAEF;;;OAGG;IACI,uBAAuB,QAAO,OAAO,CAE1C;IAEF;;;OAGG;IACI,wBAAwB,QAAO,OAAO,CAE3C;IAEF;;;;OAIG;IACI,eAAe,QAAO,QAAQ,EAAE,CAErC;IAEF;;;;OAIG;IACI,sBAAsB,QAAO,QAAQ,EAAE,CAQ5C;IAEF;;;;;;OAMG;IACI,UAAU,GAAI,QAAQ;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,gCAOjD;IAEF;;;;;OAKG;IACI,iBAAiB,QAAO,MAAM,CAQnC;IAMF;;;;;;;;;;OAUG;IACI,WAAW,aAqChB;IAEF;;;;;;;OAOG;IACI,OAAO,GAAI,QAAQ;QACzB,QAAQ,EAAE,QAAQ,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KACf,KAAG,GAAG,CAgCL;IAEF;;;;;;OAMG;IACI,YAAY,GAAI,QAAQ;QAC9B,YAAY,EAAE,YAAY,CAAC;QAC3B,eAAe,EAAE,eAAe,CAAC;QACjC,MAAM,EAAE,MAAM,CAAC;KACf,KAAG,GAAG,CAYL;IAEF;;;;;;;OAOG;IACI,cAAc,GAAI,QAAQ;QAChC,cAAc,EAAE,MAAM,CAAC;KACvB,KAAG,eAAe,CA2BjB;IAUF;;;;;OAKG;IACU,mBAAmB,CAAC,MAAM,EAAE;QACxC,WAAW,EAAE,OAAO,CAAC;QACrB,cAAc,EAAE,SAAS,CAAC;QAC1B,aAAa,EAAE,UAAU,CAAC;QAE1B,aAAa,CAAC,EAAE,OAAO,CAAC;KACxB;IAiBD;;;;;OAKG;IACU,4BAA4B,CAAC,MAAM,EAAE;QACjD,iBAAiB,EAAE,QAAQ,EAAE,CAAC;QAC9B,aAAa,EAAE,UAAU,CAAC;KAC1B;IAgBD;;;;;OAKG;IACU,sCAAsC,CAAC,MAAM,EAAE;QAC3D,UAAU,EAAE,QAAQ,CAAC;QACrB,OAAO,EAAE;YACR,cAAc,EAAE,QAAQ,CAAC;YACzB,kBAAkB,EAAE,SAAS,CAAC;YAC9B,YAAY,EAAE,MAAM,CAAC;SACrB,EAAE,CAAC;QACJ,aAAa,EAAE,UAAU,CAAC;KAC1B;IAeD;;;;;OAKG;IACU,kCAAkC,CAAC,MAAM,EAAE;QACvD,UAAU,EAAE,QAAQ,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,EAAE,UAAU,CAAC;KAC1B;IAWD;;;;;;OAMG;IACI,kCAAkC,CACxC,MAAM,EAAE,gCAAgC;IAWzC;;;;;;OAMG;IACU,8BAA8B,CAC1C,MAAM,EAAE;QACP,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,SAAS,CAAC;QAC9B,YAAY,EAAE,MAAM,CAAC;QACrB,wBAAwB,EAAE,SAAS,CAAC;QACpC,cAAc,EAAE,QAAQ,CAAC;QACzB,aAAa,EAAE,UAAU,CAAC;QAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,0BAA0B;IAc/B;;;;;;OAMG;IACU,0BAA0B,CACtC,MAAM,EAAE;QACP,OAAO,EAAE;YACR,YAAY,EAAE,OAAO,CAAC;YACtB,cAAc,EAAE,QAAQ,CAAC;SACzB,EAAE,CAAC;QACJ,aAAa,EAAE,UAAU,CAAC;QAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,0BAA0B;IAY/B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,2BAA2B,CAAC,MAAM,EAAE;QAC1C,OAAO,EAAE;YACR,cAAc,EAAE,QAAQ,CAAC;YACzB,YAAY,EAAE,OAAO,CAAC;SACtB,EAAE,CAAC;QACJ,UAAU,EAAE,QAAQ,CAAC;QACrB,aAAa,EAAE,UAAU,CAAC;KAC1B;IAmBD;;;;;OAKG;IACH,OAAO,CAAC,kCAAkC;IAsB1C;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAqBxC;;OAEG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}