pepay-streams-sdk 0.1.0

package/src/staking/index.ts

@@ -0,0 +1,449 @@
+/**
+ * Staking Module
+ *
+ * Provides methods for staking operations:
+ * - Stake tokens
+ * - Unstake tokens
+ * - Claim rewards
+ * - Pool queries
+ */
+import {
+  type PublicClient,
+  type WalletClient,
+  type Address,
+  type Hash,
+} from 'viem';
+import { DIAMOND_ABI } from '@pepay-streams/abi/diamond';
+import type {
+  PoolInfo,
+  UserStake,
+  TransactionResult,
+} from '../types';
+
+/**
+ * Staking module for fixed-duration staking pools
+ */
+export class StakingModule {
+  constructor(
+    private readonly publicClient: PublicClient,
+    private readonly walletClient: WalletClient | undefined,
+    private readonly diamondAddress: Address
+  ) {}
+
+  // ============================================================================
+  // Staking Operations
+  // ============================================================================
+
+  /**
+   * Stake tokens in a pool
+   *
+   * Must approve the Diamond contract first.
+   *
+   * @example
+   * ```typescript
+   * await sdk.approve(stakeToken, amount);
+   * const result = await sdk.staking.stake(poolId, amount);
+   * ```
+   */
+  async stake(poolId: bigint, amount: bigint): Promise<TransactionResult> {
+    const wallet = this.requireWallet();
+
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account!,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'stake',
+      args: [poolId, amount],
+    });
+
+    return this.createTransactionResult(hash);
+  }
+
+  /**
+   * Increase stake in an existing deposit
+   */
+  async increaseStake(
+    poolId: bigint,
+    amount: bigint
+  ): Promise<TransactionResult> {
+    const wallet = this.requireWallet();
+
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account!,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'increaseStake',
+      args: [poolId, amount],
+    });
+
+    return this.createTransactionResult(hash);
+  }
+
+  /**
+   * Unstake all tokens from a pool
+   *
+   * Automatically claims pending rewards.
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.staking.unstake(poolId);
+   * ```
+   */
+  async unstake(poolId: bigint): Promise<TransactionResult> {
+    const wallet = this.requireWallet();
+
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account!,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'unstake',
+      args: [poolId],
+    });
+
+    return this.createTransactionResult(hash);
+  }
+
+  /**
+   * Partial unstake - withdraw some tokens but keep position open
+   */
+  async partialUnstake(
+    poolId: bigint,
+    amount: bigint
+  ): Promise<TransactionResult> {
+    const wallet = this.requireWallet();
+
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account!,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'partialUnstake',
+      args: [poolId, amount],
+    });
+
+    return this.createTransactionResult(hash);
+  }
+
+  /**
+   * Emergency unstake - forfeit rewards but get principal back
+   *
+   * Use when pool has issues or you need immediate exit.
+   */
+  async emergencyUnstake(poolId: bigint): Promise<TransactionResult> {
+    const wallet = this.requireWallet();
+
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account!,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'emergencyUnstake',
+      args: [poolId],
+    });
+
+    return this.createTransactionResult(hash);
+  }
+
+  // ============================================================================
+  // Pool Queries
+  // ============================================================================
+
+  /**
+   * Get pool information
+   *
+   * @example
+   * ```typescript
+   * const pool = await sdk.staking.getPool(1n);
+   * console.log('Total staked:', formatEther(pool.totalStaked));
+   * ```
+   */
+  async getPool(poolId: bigint): Promise<PoolInfo> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'pools',
+      args: [poolId],
+    });
+
+    return this.parsePoolInfo(poolId, result as Record<string, unknown>);
+  }
+
+  /**
+   * Get total number of staking pools
+   */
+  async getPoolCount(): Promise<bigint> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'poolCount',
+      args: [],
+    });
+
+    return result as bigint;
+  }
+
+  /**
+   * Get pool stats (runtime state)
+   */
+  async getPoolStats(poolId: bigint): Promise<{
+    statusBits: number;
+    rewardRemaining: bigint;
+    totalStaked: bigint;
+    endAt: number;
+    finalized: boolean;
+    rewardRatePerSecond: bigint;
+  }> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'poolStats',
+      args: [poolId],
+    }) as [number, bigint, bigint, bigint, bigint, bigint, boolean, bigint, bigint, bigint];
+
+    return {
+      statusBits: result[0],
+      rewardRemaining: result[1],
+      totalStaked: result[2],
+      endAt: Number(result[4]),
+      finalized: result[6],
+      rewardRatePerSecond: result[9],
+    };
+  }
+
+  // ============================================================================
+  // User Stake Queries
+  // ============================================================================
+
+  /**
+   * Get user's deposit info for a pool
+   *
+   * @example
+   * ```typescript
+   * const stake = await sdk.staking.getUserDeposit(poolId, address);
+   * console.log('Staked:', formatEther(stake.amount));
+   * ```
+   */
+  async getUserDeposit(poolId: bigint, user: Address): Promise<{
+    amount: bigint;
+    startAt: number;
+    rewardDebtRay: bigint;
+    claimedReward: bigint;
+    claimedAt: number;
+    active: boolean;
+  }> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'deposits',
+      args: [poolId, user],
+    }) as { amount: bigint; startAt: bigint; rewardDebtRay: bigint; claimedReward: bigint; claimedAt: bigint; active: boolean };
+
+    return {
+      amount: result.amount,
+      startAt: Number(result.startAt),
+      rewardDebtRay: result.rewardDebtRay,
+      claimedReward: result.claimedReward,
+      claimedAt: Number(result.claimedAt),
+      active: result.active,
+    };
+  }
+
+  /**
+   * Get comprehensive deposit status for a user
+   */
+  async getDepositStatus(poolId: bigint, user: Address): Promise<{
+    active: boolean;
+    stakedAmount: bigint;
+    pendingRewards: bigint;
+    canUnstakeNow: boolean;
+    secondsUntilUnstake: number;
+    totalClaimed: bigint;
+  }> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'depositStatus',
+      args: [poolId, user],
+    }) as [boolean, bigint, bigint, boolean, bigint, bigint];
+
+    return {
+      active: result[0],
+      stakedAmount: result[1],
+      pendingRewards: result[2],
+      canUnstakeNow: result[3],
+      secondsUntilUnstake: Number(result[4]),
+      totalClaimed: result[5],
+    };
+  }
+
+  /**
+   * Get pending rewards for a user in a pool
+   */
+  async getPendingRewards(poolId: bigint, user: Address): Promise<bigint> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'pendingReward',
+      args: [poolId, user],
+    });
+
+    return result as bigint;
+  }
+
+  /**
+   * Check if user can unstake from a pool
+   */
+  async canUnstake(poolId: bigint, user: Address): Promise<boolean> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'canUnstake',
+      args: [poolId, user],
+    });
+
+    return result as boolean;
+  }
+
+  /**
+   * Get time until user can unstake
+   */
+  async secondsUntilUnstakeable(
+    poolId: bigint,
+    user: Address
+  ): Promise<bigint> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'secondsUntilUnstakeable',
+      args: [poolId, user],
+    });
+
+    return result as bigint;
+  }
+
+  /**
+   * Get user's stake info for a pool (convenience wrapper)
+   *
+   * @example
+   * ```typescript
+   * const stake = await sdk.staking.getUserStake(poolId, address);
+   * console.log('Staked:', formatEther(stake.amount));
+   * console.log('Pending rewards:', formatEther(stake.pendingRewards));
+   * ```
+   */
+  async getUserStake(poolId: bigint, user: Address): Promise<UserStake> {
+    const [deposit, pendingRewards] = await Promise.all([
+      this.getUserDeposit(poolId, user),
+      this.getPendingRewards(poolId, user),
+    ]);
+
+    return {
+      amount: deposit.amount,
+      pendingRewards,
+      lastClaimTime: deposit.claimedAt,
+      stakeTime: deposit.startAt,
+    };
+  }
+
+  // ============================================================================
+  // Utility Functions
+  // ============================================================================
+
+  /**
+   * Get APY preview for a pool
+   */
+  async getApyPreview(poolId: bigint): Promise<{
+    ratePerSecond: bigint;
+    totalStaked: bigint;
+  }> {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: 'apyPreview',
+      args: [poolId],
+    }) as [bigint, bigint];
+
+    return {
+      ratePerSecond: result[0],
+      totalStaked: result[1],
+    };
+  }
+
+  /**
+   * Calculate APY for a pool
+   *
+   * @example
+   * ```typescript
+   * const pool = await sdk.staking.getPool(poolId);
+   * const apy = sdk.staking.calculateApy(pool);
+   * console.log('APY:', apy.toFixed(2), '%');
+   * ```
+   */
+  calculateApy(pool: PoolInfo): number {
+    if (pool.totalStaked === 0n) {
+      return 0;
+    }
+
+    const durationInYears =
+      (pool.endTime - pool.startTime) / (365 * 24 * 60 * 60);
+    const rewardRate =
+      Number(pool.rewardBudget) / Number(pool.totalStaked);
+
+    return (rewardRate / durationInYears) * 100;
+  }
+
+  // ============================================================================
+  // Helpers
+  // ============================================================================
+
+  private requireWallet(): WalletClient {
+    if (!this.walletClient) {
+      throw new Error(
+        'Wallet client required for write operations. Initialize SDK with a signer.'
+      );
+    }
+    return this.walletClient;
+  }
+
+  private parsePoolInfo(id: bigint, data: Record<string, unknown>): PoolInfo {
+    return {
+      id,
+      stakeToken: data.stake as Address,
+      rewardToken: data.reward as Address,
+      creator: data.creator as Address,
+      totalStaked: data.totalStaked as bigint,
+      rewardBudget: data.rewardRemaining as bigint, // Current remaining
+      rewardsDistributed: 0n, // Not directly available
+      startTime: 0, // Not in pool struct
+      endTime: Number(data.endAt as bigint),
+      minStake: 0n, // Not in pool struct
+      maxStake: data.cap as bigint,
+      stakerCount: 0, // Not in pool struct
+      isActive: !((data.statusBits as number) > 0),
+      isFinalized: data.finalized as boolean,
+    };
+  }
+
+  private createTransactionResult(hash: Hash): TransactionResult {
+    return {
+      hash,
+      wait: async () => {
+        const receipt = await this.publicClient.waitForTransactionReceipt({
+          hash,
+        });
+        return {
+          blockNumber: receipt.blockNumber,
+          transactionHash: receipt.transactionHash,
+          gasUsed: receipt.gasUsed,
+          status: receipt.status,
+          logs: receipt.logs,
+        };
+      },
+    };
+  }
+}
+
+export default StakingModule;