@star-factory/sdk-staking 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,141 @@
+import { AnchorProvider, Program, web3 } from '@coral-xyz/anchor';
+import type { CanClaimUnstakeInput, CanClaimUnstakeOutput, ClaimRewardsInput, ClaimUnstakeInput, DepositRewardsInput, GetActiveRewardMintOutput, GetAllStakersOutput, GetPendingRewardsInput, GetPendingRewardsOutput, GetRewardTokenInput, GetRewardTokenOutput, GetRewardTokenPDAInput, GetRewardVaultPDAInput, GetStakePoolOutput, GetStakeVaultPDAInput, GetTimeUntilClaimInput, GetTimeUntilClaimOutput, GetUnstakeStatusInput, GetUserPoolShareInput, GetUserPoolShareOutput, GetUserRewardInfoInput, GetUserRewardInfoOutput, GetUserRewardInfoPDAInput, GetUserStakeInput, GetUserStakeOutput, GetUserStakePDAInput, InitializeInput, IsPausedOutput, ListenerId, OnAuthorityUpdatedEventInput, OnClaimUnstakeEventInput, OnPauseEventInput, OnStakeEventInput, OnUnstakeEventInput, PDAWithBump, RemoveEventListenerInput, StakeInput, StakeProgram, StakingSDKInterface, SwitchPauseInput, TransactionOutput, UnstakeInput, UnstakeStatus, UpdateAuthorityInput } from './types';
+export * from './types';
+/**
+ * StakingSDK - Client SDK for the Staking program
+ *
+ * All methods use clear Input/Output types for type safety and discoverability.
+ */
+export declare class StakingSDK implements StakingSDKInterface {
+    readonly program: Program<StakeProgram>;
+    readonly provider: AnchorProvider;
+    readonly programId: web3.PublicKey;
+    constructor(program: Program<StakeProgram>, provider: AnchorProvider);
+    /**
+     * Static factory method to create SDK instance
+     */
+    static create(provider: AnchorProvider, programId?: web3.PublicKey): Promise<StakingSDK>;
+    getStakePoolPDA(): PDAWithBump;
+    getUserStakePDA(input: GetUserStakePDAInput): PDAWithBump;
+    getStakeVaultPDA(input: GetStakeVaultPDAInput): PDAWithBump;
+    getRewardTokenPDA(input: GetRewardTokenPDAInput): PDAWithBump;
+    getRewardVaultPDA(input: GetRewardVaultPDAInput): PDAWithBump;
+    getUserRewardInfoPDA(input: GetUserRewardInfoPDAInput): PDAWithBump;
+    /**
+     * Initialize the staking pool
+     */
+    initialize(input: InitializeInput): Promise<TransactionOutput>;
+    /**
+     * Stake tokens
+     */
+    stake(input: StakeInput): Promise<TransactionOutput>;
+    /**
+     * Unstake tokens (starts 30-day unlock period)
+     */
+    unstake(input: UnstakeInput): Promise<TransactionOutput>;
+    /**
+     * Claim unstaked tokens after 30-day period
+     */
+    claimUnstake(input?: ClaimUnstakeInput): Promise<TransactionOutput>;
+    /**
+     * Deposit rewards into the pool (admin only)
+     */
+    depositRewards(input: DepositRewardsInput): Promise<TransactionOutput>;
+    /**
+     * Claim accumulated rewards
+     */
+    claimRewards(input: ClaimRewardsInput): Promise<TransactionOutput>;
+    /**
+     * Toggle pause on contract (admin only) - USE ONLY IN CASE OF EMERGENCY
+     */
+    switchPause(input?: SwitchPauseInput): Promise<TransactionOutput>;
+    /**
+     * Transfer pool authority to a new account (current authority only)
+     */
+    updateAuthority(input: UpdateAuthorityInput): Promise<TransactionOutput>;
+    /**
+     * Get stake pool data
+     */
+    getStakePool(): Promise<GetStakePoolOutput>;
+    /**
+     * Get user stake data
+     */
+    getUserStake(input?: GetUserStakeInput): Promise<GetUserStakeOutput>;
+    /**
+     * Get reward token config data
+     */
+    getRewardToken(input: GetRewardTokenInput): Promise<GetRewardTokenOutput>;
+    /**
+     * Get user reward info data
+     */
+    getUserRewardInfo(input: GetUserRewardInfoInput): Promise<GetUserRewardInfoOutput>;
+    /**
+     * Calculate user's proportional share of the pool
+     */
+    getUserPoolShare(input?: GetUserPoolShareInput): Promise<GetUserPoolShareOutput>;
+    /**
+     * Check if user can claim unstake
+     */
+    canClaimUnstake(input?: CanClaimUnstakeInput): Promise<CanClaimUnstakeOutput>;
+    /**
+     * Get time remaining until claim is available
+     */
+    getTimeUntilClaim(input?: GetTimeUntilClaimInput): Promise<GetTimeUntilClaimOutput>;
+    /**
+     * Get comprehensive unstake status for UI display.
+     * Single RPC call that returns all information needed to render unstake UI.
+     */
+    getUnstakeStatus(input?: GetUnstakeStatusInput): Promise<UnstakeStatus>;
+    /**
+     * Calculate pending rewards for a user (without claiming)
+     */
+    getPendingRewards(input: GetPendingRewardsInput): Promise<GetPendingRewardsOutput>;
+    /**
+     * Check if protocol is paused
+     */
+    isPaused(): Promise<IsPausedOutput>;
+    /**
+     * Check if rewards are active (reward mint has been set)
+     */
+    getActiveRewardMint(): Promise<GetActiveRewardMintOutput>;
+    /**
+     * Get all stakers and their staking positions.
+     * Useful for computing reward distributions or snapshots.
+     */
+    getAllStakers(): Promise<GetAllStakersOutput>;
+    /**
+     * Listen for stake events
+     */
+    onStakeEvent(input: OnStakeEventInput): ListenerId;
+    /**
+     * Listen for unstake events
+     */
+    onUnstakeEvent(input: OnUnstakeEventInput): ListenerId;
+    /**
+     * Listen for claim unstake events
+     */
+    onClaimUnstakeEvent(input: OnClaimUnstakeEventInput): ListenerId;
+    /**
+     * Listen for pause events
+     */
+    onPauseEvent(input: OnPauseEventInput): ListenerId;
+    /**
+     * Listen for authority updated events
+     */
+    onAuthorityUpdatedEvent(input: OnAuthorityUpdatedEventInput): ListenerId;
+    /**
+     * Remove event listener
+     */
+    removeEventListener(input: RemoveEventListenerInput): Promise<void>;
+    /**
+     * Format seconds into human-readable string (e.g., "5d 3h 22m")
+     * @internal
+     */
+    private formatTimeRemaining;
+    private get accounts();
+    private fetchStakePool;
+    private fetchUserStake;
+    private fetchRewardToken;
+    private fetchUserRewardInfo;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAM,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAEtE,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,UAAU,EACV,4BAA4B,EAC5B,wBAAwB,EACxB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,EACX,wBAAwB,EAExB,UAAU,EAEV,YAAY,EAEZ,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,oBAAoB,EAGrB,MAAM,SAAS,CAAC;AAGjB,cAAc,SAAS,CAAC;AAIxB;;;;GAIG;AACH,qBAAa,UAAW,YAAW,mBAAmB;IACpD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IACxC,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC;gBAEvB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,cAAc;IAMpE;;OAEG;WACU,MAAM,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC;IAe9F,eAAe,IAAI,WAAW;IAI9B,eAAe,CAAC,KAAK,EAAE,oBAAoB,GAAG,WAAW;IAOzD,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,WAAW;IAO3D,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,WAAW;IAO7D,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,WAAW;IAO7D,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,WAAW;IAWnE;;OAEG;IACG,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoBpE;;OAEG;IACG,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA4D1D;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoD9D;;OAEG;IACG,YAAY,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwBzE;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwB5E;;OAEG;IACG,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA4BxE;;OAEG;IACG,WAAW,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAevE;;OAEG;IACG,eAAe,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAmB9E;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAKjD;;OAEG;IACG,YAAY,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAW1E;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAU/E;;OAEG;IACG,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAWxF;;OAEG;IACG,gBAAgB,CAAC,KAAK,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAsBtF;;OAEG;IACG,eAAe,CAAC,KAAK,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAanF;;OAEG;IACG,iBAAiB,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAczF;;;OAGG;IACG,gBAAgB,CAAC,KAAK,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC;IA0C7E;;OAEG;IACG,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA8BxF;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC;IAKzC;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAe/D;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAgEnD;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU;IAIlD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,UAAU;IAItD;;OAEG;IACH,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,UAAU;IAIhE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU;IAIlD;;OAEG;IACH,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,UAAU;IAIxE;;OAEG;IACG,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzE;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAe3B,OAAO,KAAK,QAAQ,GAYnB;YAEa,cAAc;YAId,cAAc;YAId,gBAAgB;YAIhB,mBAAmB;CAGlC"}