aftermath-ts-sdk 1.2.63 → 1.2.64-docs.1

package/dist/packages/staking/stakingTypes.d.ts

@@ -1,155 +1,575 @@
 import { CoinType } from "../..";
-import { ApiEventsBody, Balance, Event, Object, Percentage, Timestamp, ObjectId, SuiAddress, TransactionDigest, ExternalFee } from "../../general/types/generalTypes";
-export interface ValidatorConfigObject extends Object {
+import { ApiEventsBody, Balance, Event, Object as SuiObject, Percentage, Timestamp, ObjectId, SuiAddress, TransactionDigest, ExternalFee } from "../../general/types/generalTypes";
+/**
+ * Represents a validator's configuration object, including its Sui address,
+ * operation cap ID, and fee percentage.
+ */
+export interface ValidatorConfigObject extends SuiObject {
+    /**
+     * The Sui address of the validator.
+     */
     suiAddress: SuiAddress;
+    /**
+     * The on-chain object ID referencing this validator's operation cap.
+     */
     operationCapId: ObjectId;
+    /**
+     * The current fee percentage for this validator (0.01 = 1%).
+     */
     fee: Percentage;
 }
-export interface ValidatorOperationCapObject extends Object {
+/**
+ * Represents a validator's operation cap object, which authorizes changes to
+ * validator settings like fees.
+ */
+export interface ValidatorOperationCapObject extends SuiObject {
+    /**
+     * The validator address authorized by this operation cap.
+     */
     authorizerValidatorAddress: SuiAddress;
 }
-export interface StakedSuiVaultStateObject extends Object {
+/**
+ * Represents the on-chain state of the stakedSui vault, which tracks liquidity
+ * for atomic unstakes, total SUI amounts, rewards, and fees.
+ */
+export interface StakedSuiVaultStateObject extends SuiObject {
+    /**
+     * The target size for atomic unstake SUI reserves.
+     */
     atomicUnstakeSuiReservesTargetValue: Balance;
+    /**
+     * The current size of the SUI reserves for atomic unstakes.
+     */
     atomicUnstakeSuiReserves: Balance;
+    /**
+     * The minimum fee for atomic unstakes, expressed as a BigInt-based percentage
+     * (e.g., 50000000n = 5% if using 1e9-based decimals).
+     */
     minAtomicUnstakeFee: bigint;
+    /**
+     * The maximum fee for atomic unstakes.
+     */
     maxAtomicUnstakeFee: bigint;
+    /**
+     * The total amount of SUI rewards accumulated in the vault.
+     */
     totalRewardsAmount: Balance;
+    /**
+     * The total amount of SUI staked in the vault.
+     */
     totalSuiAmount: Balance;
+    /**
+     * The current epoch number, as a BigInt.
+     */
     activeEpoch: bigint;
 }
+/**
+ * Represents a dynamic field holding a stake balance. Useful for tracking
+ * on-chain data related to a specific stake or delegator.
+ */
 export interface StakeBalanceDynamicField {
+    /**
+     * The on-chain object ID of this stake balance record.
+     */
     objectId: ObjectId;
+    /**
+     * The amount of SUI (or afSUI) represented by this field, expressed as a bigint.
+     */
     value: Balance;
 }
+/**
+ * Enumerates the possible states of a delegated stake on the Sui network.
+ *
+ * - **Active**: The stake is actively earning rewards.
+ * - **Pending**: The stake has been requested but not yet activated.
+ * - **Unstaked**: The stake has been removed or the SUI is no longer earning rewards.
+ */
 export type SuiDelegatedStakeState = "Active" | "Pending" | "Unstaked";
+/**
+ * Represents a delegated stake object in the Sui network. Unlike local
+ * Aftermath-specific stake positions, this is a more general Sui system stake
+ * that can earn protocol-level rewards.
+ */
 export interface SuiDelegatedStake {
+    /**
+     * The current state of the delegated stake (e.g., Active, Pending, Unstaked).
+     */
     status: SuiDelegatedStakeState;
+    /**
+     * The on-chain ID representing this stake position.
+     */
     stakedSuiId: ObjectId;
+    /**
+     * The epoch in which this stake request was made.
+     */
     stakeRequestEpoch: bigint;
+    /**
+     * The epoch in which this stake became (or will become) active.
+     */
     stakeActiveEpoch: bigint;
+    /**
+     * The principal amount of SUI delegated.
+     */
     principal: Balance;
+    /**
+     * The estimated rewards accumulated for this stake, if available.
+     */
     estimatedReward?: Balance | undefined;
+    /**
+     * The validator to which this stake is delegated.
+     */
     validatorAddress: SuiAddress;
+    /**
+     * The staking pool on-chain object that manages this stake.
+     */
     stakingPool: SuiAddress;
 }
+/**
+ * A type guard utility function to check if a position is a native Sui delegated stake
+ * (`SuiDelegatedStake`) rather than an Aftermath-specific `StakingPosition`.
+ *
+ * @param stake - An object that could be either a `StakingPosition` or a `SuiDelegatedStake`.
+ * @returns True if the object matches the shape of `SuiDelegatedStake`; otherwise, false.
+ */
 export declare const isSuiDelegatedStake: (stake: StakingPosition | SuiDelegatedStake) => stake is SuiDelegatedStake;
+/**
+ * Represents a single entry in the historical APY data, including a Unix
+ * timestamp and an APY value.
+ */
 export interface StakingApyDataPoint {
+    /**
+     * The Unix timestamp (in milliseconds or seconds) of the data point.
+     */
     timestamp: Timestamp;
+    /**
+     * The APY value recorded at that time (e.g., 0.045 = 4.5%).
+     */
     apy: number;
 }
+/**
+ * Enumerates the timeframes available for retrieving historical APY data,
+ * such as `"1W"`, `"1M"`, `"1Y"`, etc.
+ */
 export type StakingApyTimeframeKey = "1W" | "1M" | "3M" | "6M" | "1Y" | "ALL";
-export type StakeEvent = StakedEvent;
-export type UnstakeEvent = UnstakeRequestedEvent | UnstakedEvent;
+/**
+ * Represents an event when SUI has been staked, either newly or restaked.
+ */
 export interface StakedEvent extends Event {
+    /**
+     * The on-chain object ID referencing the newly created staked SUI object.
+     */
     stakedSuiId: ObjectId;
+    /**
+     * The original SUI coin ID used for staking.
+     */
     suiId: ObjectId;
+    /**
+     * The address of the user who performed the staking.
+     */
     staker: SuiAddress;
+    /**
+     * The validator address to which the user staked.
+     */
     validatorAddress: SuiAddress;
+    /**
+     * The epoch in which staking took place.
+     */
     epoch: bigint;
+    /**
+     * The amount of SUI staked.
+     */
     suiStakeAmount: Balance;
+    /**
+     * The validator fee percentage for this stake (0.01 = 1%).
+     */
     validatorFee: number;
+    /**
+     * Indicates whether this stake is a restake of an already staked position.
+     */
     isRestaked: boolean;
+    /**
+     * The on-chain ID of the afSUI object received in exchange for staking.
+     */
     afSuiId: ObjectId;
+    /**
+     * The amount of afSUI received.
+     */
     afSuiAmount: Balance;
+    /**
+     * (Optional) Referrer address for the stake.
+     */
     referrer?: SuiAddress;
 }
+/**
+ * Represents an event when a user initiates an unstake request, converting
+ * afSUI back into SUI.
+ */
 export interface UnstakeRequestedEvent extends Event {
+    /**
+     * The afSUI ID being provided to unstake.
+     */
     afSuiId: ObjectId;
+    /**
+     * The amount of afSUI provided by the user.
+     */
     providedAfSuiAmount: Balance;
+    /**
+     * The address requesting the unstake.
+     */
     requester: SuiAddress;
+    /**
+     * The epoch in which the unstake was requested.
+     */
     epoch: bigint;
 }
+/**
+ * Represents an event after an unstake has fully processed and SUI has
+ * been returned to the user.
+ */
 export interface UnstakedEvent extends Event {
+    /**
+     * The afSUI ID that was burned or converted during the unstake.
+     */
     afSuiId: ObjectId;
+    /**
+     * The amount of afSUI provided.
+     */
     providedAfSuiAmount: Balance;
+    /**
+     * The resulting SUI coin ID received by the user.
+     */
     suiId: ObjectId;
+    /**
+     * The amount of SUI returned.
+     */
     returnedSuiAmount: Balance;
+    /**
+     * The address that initiated the unstake.
+     */
     requester: SuiAddress;
+    /**
+     * The epoch in which the unstake finalized.
+     */
     epoch: bigint;
 }
+/**
+ * Represents a union type covering all possible unstake events, either
+ * requested or finalized.
+ */
+export type UnstakeEvent = UnstakeRequestedEvent | UnstakedEvent;
+/**
+ * Type guard to check if an event is a `StakedEvent`.
+ */
 export declare const isStakeEvent: (event: StakeEvent | UnstakeEvent) => event is StakedEvent;
+/**
+ * Type guard to check if an event is an `UnstakeEvent`.
+ */
 export declare const isUnstakeEvent: (event: StakeEvent | UnstakeEvent) => event is UnstakeEvent;
+/**
+ * Represents an event that indicates the epoch has changed, generally used
+ * for distributing rewards and updating positions.
+ */
 export interface EpochWasChangedEvent extends Event {
+    /**
+     * The new active epoch as a BigInt.
+     */
     activeEpoch: bigint;
+    /**
+     * The total amount of afSUI in circulation.
+     */
     totalAfSuiSupply: Balance;
+    /**
+     * The total amount of SUI rewards accrued in the system.
+     */
     totalSuiRewardsAmount: Balance;
+    /**
+     * The total amount of SUI staked in the system.
+     */
     totalSuiAmount: Balance;
 }
+/**
+ * Union type for stake events, which can represent any variant of staking.
+ */
+export type StakeEvent = StakedEvent;
+/**
+ * Represents a user's staking position, which could be either a `StakePosition`
+ * or an `UnstakePosition`.
+ */
 export type StakingPosition = StakePosition | UnstakePosition;
+/**
+ * Indicates a stake position, typically representing active or restaked SUI,
+ * along with its associated `afSuiAmount`.
+ */
 export interface StakePosition {
+    /**
+     * The staked SUI object ID referencing this position.
+     */
     stakedSuiId: ObjectId;
+    /**
+     * The original SUI coin ID.
+     */
     suiId: ObjectId;
+    /**
+     * The address of the staker.
+     */
     staker: SuiAddress;
+    /**
+     * The address of the validator to which SUI was staked.
+     */
     validatorAddress: SuiAddress;
+    /**
+     * The epoch in which the stake was established.
+     */
     epoch: bigint;
+    /**
+     * The amount of SUI staked.
+     */
     suiStakeAmount: Balance;
+    /**
+     * The validator fee percentage (0.01 = 1%).
+     */
     validatorFee: number;
+    /**
+     * Indicates if this stake is a restake operation.
+     */
     isRestaked: boolean;
+    /**
+     * The afSUI object ID generated from staking.
+     */
     afSuiId: ObjectId;
+    /**
+     * The amount of afSUI issued to the user.
+     */
     afSuiAmount: Balance;
+    /**
+     * The timestamp when the stake was recorded.
+     */
     timestamp: Timestamp | undefined;
+    /**
+     * The transaction digest where the stake operation occurred.
+     */
     txnDigest: TransactionDigest;
 }
+/**
+ * Indicates a position related to an unstake operation, either requested or
+ * finalized, with optional references to the returned SUI coin and amount.
+ */
 export interface UnstakePosition {
+    /**
+     * The state of the unstake operation: `REQUEST` (in progress) or
+     * `SUI_MINTED` (finalized).
+     */
     state: UnstakePositionState;
+    /**
+     * The afSUI object ID being burned or converted.
+     */
     afSuiId: ObjectId;
+    /**
+     * The amount of afSUI used to initiate the unstake.
+     */
     providedAfSuiAmount: Balance;
+    /**
+     * The address of the requester.
+     */
     requester: SuiAddress;
+    /**
+     * The epoch in which the unstake was requested or finalized.
+     */
     epoch: bigint;
+    /**
+     * The SUI object ID returned to the user, if unstake has finalized.
+     */
     suiId?: ObjectId;
+    /**
+     * The amount of SUI returned to the user, if unstake has finalized.
+     */
     returnedSuiAmount?: Balance;
+    /**
+     * The timestamp when the unstake request was recorded or completed.
+     */
     timestamp: Timestamp | undefined;
+    /**
+     * The transaction digest where the unstake operation occurred.
+     */
     txnDigest: TransactionDigest;
 }
+/**
+ * Enumerates the possible states of an unstake operation.
+ */
 export type UnstakePositionState = "REQUEST" | "SUI_MINTED";
+/**
+ * Type guard that checks whether a given `StakingPosition` is a stake position.
+ */
 export declare const isStakePosition: (position: StakingPosition) => position is StakePosition;
+/**
+ * Type guard that checks whether a given `StakingPosition` is an unstake position.
+ */
 export declare const isUnstakePosition: (position: StakingPosition) => position is UnstakePosition;
+/**
+ * Body payload for staking SUI.
+ */
 export interface ApiStakeBody {
+    /**
+     * The address performing the stake.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The amount of SUI to be staked.
+     */
     suiStakeAmount: Balance;
+    /**
+     * The validator address to stake with.
+     */
     validatorAddress: SuiAddress;
+    /**
+     * Optional address indicating a referrer.
+     */
     referrer?: SuiAddress;
+    /**
+     * Optional external fee object. Must not exceed `maxExternalFeePercentage`.
+     */
     externalFee?: ExternalFee;
+    /**
+     * Indicates whether the transaction should be sponsored.
+     */
     isSponsoredTx?: boolean;
 }
+/**
+ * Body payload for unstaking SUI (afSUI -> SUI).
+ */
 export interface ApiUnstakeBody {
+    /**
+     * The address performing the unstake.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The amount of afSUI to be unstaked.
+     */
     afSuiUnstakeAmount: Balance;
+    /**
+     * If true, the unstake is done atomically if possible, using liquidity reserves.
+     */
     isAtomic: boolean;
+    /**
+     * Optional address indicating a referrer.
+     */
     referrer?: SuiAddress;
+    /**
+     * Optional external fee object. Must not exceed `maxExternalFeePercentage`.
+     */
     externalFee?: ExternalFee;
+    /**
+     * Indicates whether the transaction should be sponsored.
+     */
     isSponsoredTx?: boolean;
 }
+/**
+ * Body payload for staking stakedSUI objects (re-staking).
+ */
 export interface ApiStakeStakedSuiBody {
+    /**
+     * The address performing the re-stake.
+     */
     walletAddress: SuiAddress;
+    /**
+     * An array of stakedSui object IDs to re-stake.
+     */
     stakedSuiIds: ObjectId[];
+    /**
+     * The validator address to stake with.
+     */
     validatorAddress: SuiAddress;
+    /**
+     * Optional address indicating a referrer.
+     */
     referrer?: SuiAddress;
+    /**
+     * Indicates whether the transaction should be sponsored.
+     */
     isSponsoredTx?: boolean;
 }
+/**
+ * Body payload for updating a validator's fee settings.
+ */
 export interface ApiUpdateValidatorFeeBody {
+    /**
+     * The address submitting the update transaction.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The operation cap object ID that authorizes changes to this validator.
+     */
     validatorOperationCapId: ObjectId;
+    /**
+     * The new fee percentage to be set (0.01 = 1%).
+     */
     newFeePercentage: Percentage;
+    /**
+     * Indicates whether the transaction should be sponsored.
+     */
     isSponsoredTx?: boolean;
 }
+/**
+ * Body payload for retrieving staking positions, including pagination.
+ */
 export interface ApiStakingPositionsBody {
+    /**
+     * The address whose staking positions are being queried.
+     */
     walletAddress: SuiAddress;
+    /**
+     * Optional cursor for pagination.
+     */
     cursor?: number;
+    /**
+     * Optional limit on the number of positions returned.
+     */
     limit?: number;
 }
+/**
+ * Body payload for retrieving delegated stakes, given a wallet address.
+ */
 export interface ApiDelegatedStakesBody {
+    /**
+     * The address whose delegated stakes are being queried.
+     */
     walletAddress: SuiAddress;
 }
+/**
+ * Body payload for retrieving validator operation caps, given a wallet address.
+ */
 export interface ApiValidatorOperationCapsBody {
+    /**
+     * The address whose validator operation caps are being queried.
+     */
     walletAddress: SuiAddress;
 }
+/**
+ * Body payload for retrieving staking-related events, including pagination.
+ */
 export type ApiStakingEventsBody = ApiEventsBody & {
+    /**
+     * The address whose events are being queried.
+     */
     walletAddress: SuiAddress;
 };
+/**
+ * Extends the `StakedSuiVaultStateObject` with additional fields relevant
+ * to the router pool. This includes the coin type for afSUI, the configured
+ * validator address, and the current exchange rate.
+ */
 export type AfSuiRouterPoolObject = StakedSuiVaultStateObject & {
+    /**
+     * The coin type string for afSUI (e.g., "0x<package>::afSUI::AFSUI").
+     */
     afSuiCoinType: CoinType;
+    /**
+     * The official Aftermath validator address.
+     */
     aftermathValidatorAddress: SuiAddress;
+    /**
+     * The current exchange rate from afSUI to SUI.
+     */
     afSuiToSuiExchangeRate: number;
 };
 //# sourceMappingURL=stakingTypes.d.ts.map

package/dist/packages/staking/stakingTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stakingTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/staking/stakingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EACN,aAAa,EACb,OAAO,EACP,KAAK,EACL,MAAM,EACN,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,MAAM,kCAAkC,CAAC;AAM1C,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACpD,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,EAAE,QAAQ,CAAC;IACzB,GAAG,EAAE,UAAU,CAAC;CAChB;AAED,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IAC1D,0BAA0B,EAAE,UAAU,CAAC;CACvC;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM;IACxD,mCAAmC,EAAE,OAAO,CAAC;IAC7C,wBAAwB,EAAE,OAAO,CAAC;IAClC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACxC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;CACf;AAED,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAEvE,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,WAAW,EAAE,QAAQ,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,gBAAgB,EAAE,UAAU,CAAC;IAC7B,WAAW,EAAE,UAAU,CAAC;CACxB;AAED,eAAO,MAAM,mBAAmB,UACxB,eAAe,GAAG,iBAAiB,+BAQ1C,CAAC;AAEF,MAAM,WAAW,mBAAmB;IACnC,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,sBAAsB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAM9E,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AACrC,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,aAAa,CAAC;AAEjE,MAAM,WAAW,WAAY,SAAQ,KAAK;IACzC,WAAW,EAAE,QAAQ,CAAC;IACtB,KAAK,EAAE,QAAQ,CAAC;IAChB,MAAM,EAAE,UAAU,CAAC;IACnB,gBAAgB,EAAE,UAAU,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,QAAQ,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,KAAK;IACnD,OAAO,EAAE,QAAQ,CAAC;IAClB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC3C,OAAO,EAAE,QAAQ,CAAC;IAClB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,QAAQ,CAAC;IAChB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,EAAE,UAAU,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,YAAY,UACjB,UAAU,GAAG,YAAY,yBAGhC,CAAC;AAEF,eAAO,MAAM,cAAc,UACnB,UAAU,GAAG,YAAY,0BAGhC,CAAC;AAEF,MAAM,WAAW,oBAAqB,SAAQ,KAAK;IAClD,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,cAAc,EAAE,OAAO,CAAC;CACxB;AAMD,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,eAAe,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC7B,WAAW,EAAE,QAAQ,CAAC;IACtB,KAAK,EAAE,QAAQ,CAAC;IAChB,MAAM,EAAE,UAAU,CAAC;IACnB,gBAAgB,EAAE,UAAU,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,QAAQ,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IAErB,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC,SAAS,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC/B,KAAK,EAAE,oBAAoB,CAAC;IAC5B,OAAO,EAAE,QAAQ,CAAC;IAClB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC,SAAS,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,YAAY,CAAC;AAE5D,eAAO,MAAM,eAAe,aACjB,eAAe,8BAGzB,CAAC;AAEF,eAAO,MAAM,iBAAiB,aACnB,eAAe,gCAGzB,CAAC;AAUF,MAAM,WAAW,YAAY;IAC5B,aAAa,EAAE,UAAU,CAAC;IAC1B,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC9B,aAAa,EAAE,UAAU,CAAC;IAC1B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACrC,aAAa,EAAE,UAAU,CAAC;IAC1B,YAAY,EAAE,QAAQ,EAAE,CAAC;IACzB,gBAAgB,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACzC,aAAa,EAAE,UAAU,CAAC;IAC1B,uBAAuB,EAAE,QAAQ,CAAC;IAClC,gBAAgB,EAAE,UAAU,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAMD,MAAM,WAAW,uBAAuB;IACvC,aAAa,EAAE,UAAU,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACtC,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC7C,aAAa,EAAE,UAAU,CAAC;CAC1B;AAMD,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG;IAClD,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAMF,MAAM,MAAM,qBAAqB,GAAG,yBAAyB,GAAG;IAC/D,aAAa,EAAE,QAAQ,CAAC;IACxB,yBAAyB,EAAE,UAAU,CAAC;IACtC,sBAAsB,EAAE,MAAM,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"stakingTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/staking/stakingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EACN,aAAa,EACb,OAAO,EACP,KAAK,EACL,MAAM,IAAI,SAAS,EACnB,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,MAAM,kCAAkC,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACvD;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,QAAQ,CAAC;IACzB;;OAEG;IACH,GAAG,EAAE,UAAU,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,SAAS;IAC7D;;OAEG;IACH,0BAA0B,EAAE,UAAU,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,SAAS;IAC3D;;OAEG;IACH,mCAAmC,EAAE,OAAO,CAAC;IAC7C;;OAEG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAClC;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,WAAW,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,UACxB,eAAe,GAAG,iBAAiB,+BAQ1C,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAM9E;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,KAAK;IACzC;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,KAAK;IACnD;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC3C;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,aAAa,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,YAAY,UACjB,UAAU,GAAG,YAAY,yBAGhC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,UACnB,UAAU,GAAG,YAAY,0BAGhC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,KAAK;IAClD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAMrC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,eAAe,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;;OAGG;IACH,KAAK,EAAE,oBAAoB,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,YAAY,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,eAAe,aACjB,eAAe,8BAGzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,aACnB,eAAe,gCAGzB,CAAC;AAMF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,YAAY,EAAE,QAAQ,EAAE,CAAC;IACzB;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,uBAAuB,EAAE,QAAQ,CAAC;IAClC;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B;AAMD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG;IAClD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAMF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,yBAAyB,GAAG;IAC/D;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,yBAAyB,EAAE,UAAU,CAAC;IACtC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAC/B,CAAC"}

package/dist/packages/staking/stakingTypes.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isUnstakePosition = exports.isStakePosition = exports.isUnstakeEvent = exports.isStakeEvent = exports.isSuiDelegatedStake = void 0;
+/**
+ * A type guard utility function to check if a position is a native Sui delegated stake
+ * (`SuiDelegatedStake`) rather than an Aftermath-specific `StakingPosition`.
+ *
+ * @param stake - An object that could be either a `StakingPosition` or a `SuiDelegatedStake`.
+ * @returns True if the object matches the shape of `SuiDelegatedStake`; otherwise, false.
+ */
 const isSuiDelegatedStake = (stake) => {
     return ("stakeRequestEpoch" in stake &&
         "stakeActiveEpoch" in stake &&
@@ -8,18 +15,30 @@ const isSuiDelegatedStake = (stake) => {
         "stakingPool" in stake);
 };
 exports.isSuiDelegatedStake = isSuiDelegatedStake;
+/**
+ * Type guard to check if an event is a `StakedEvent`.
+ */
 const isStakeEvent = (event) => {
     return "staker" in event;
 };
 exports.isStakeEvent = isStakeEvent;
+/**
+ * Type guard to check if an event is an `UnstakeEvent`.
+ */
 const isUnstakeEvent = (event) => {
     return !(0, exports.isStakeEvent)(event);
 };
 exports.isUnstakeEvent = isUnstakeEvent;
+/**
+ * Type guard that checks whether a given `StakingPosition` is a stake position.
+ */
 const isStakePosition = (position) => {
     return "stakedSuiId" in position;
 };
 exports.isStakePosition = isStakePosition;
+/**
+ * Type guard that checks whether a given `StakingPosition` is an unstake position.
+ */
 const isUnstakePosition = (position) => {
     return !(0, exports.isStakePosition)(position);
 };