@opendatalabs/vana-sdk 2.3.0 → 3.0.1

package/dist/controllers/staking.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/controllers/staking.ts"],"sourcesContent":["/**\n * Provides staking functionality for the VanaPool protocol.\n *\n * @remarks\n * This controller handles interactions with VanaPool staking contracts,\n * allowing users to query staking information such as total VANA staked,\n * entity information, and staker positions.\n *\n * @category Controllers\n * @module StakingController\n */\n\nimport type { ControllerContext } from \"../types/controller-context\";\nimport type { TransactionOptions } from \"../types/operations\";\nimport { BaseController } from \"./base\";\nimport { getContract, parseEther } from \"viem\";\nimport type { Address, Hash } from \"viem\";\nimport { getContractAddress } from \"../generated/addresses\";\nimport { getAbi } from \"../generated/abi\";\nimport { BlockchainError } from \"../errors\";\n\n/**\n * Information about a staking entity in the VanaPool protocol.\n */\nexport interface EntityInfo {\n  entityId: bigint;\n  ownerAddress: Address;\n  status: number;\n  name: string;\n  maxAPY: bigint;\n  lockedRewardPool: bigint;\n  activeRewardPool: bigint;\n  totalShares: bigint;\n  lastUpdateTimestamp: bigint;\n  totalDistributedRewards: bigint;\n}\n\n/**\n * Information about a staker's position in an entity.\n */\nexport interface StakerEntityInfo {\n  shares: bigint;\n  costBasis: bigint;\n  rewardEligibilityTimestamp: bigint;\n  realizedRewards: bigint;\n  vestedRewards: bigint;\n}\n\n/**\n * Comprehensive staking summary for a staker in an entity.\n */\nexport interface StakerEntitySummary {\n  /** Number of shares owned by the staker */\n  shares: bigint;\n  /** Cost basis - the original VANA amount staked */\n  costBasis: bigint;\n  /** Current value of the staker's shares in VANA */\n  currentValue: bigint;\n  /** Timestamp when rewards become eligible */\n  rewardEligibilityTimestamp: bigint;\n  /** Remaining bonding time in seconds (0 if bonding period has passed) */\n  remainingBondingTime: bigint;\n  /** Whether the staker is still in the bonding period */\n  isInBondingPeriod: boolean;\n  /** Vested rewards that can be claimed without penalty */\n  vestedRewards: bigint;\n  /** Unvested rewards (pending interest = currentValue - costBasis) */\n  unvestedRewards: bigint;\n  /** Realized/withdrawn rewards (already claimed) */\n  realizedRewards: bigint;\n  /** Total earned rewards (includes vested, unvested, and realized) */\n  earnedRewards: bigint;\n}\n\n/**\n * Controller for VanaPool staking operations.\n *\n * @remarks\n * Provides methods to query staking information from the VanaPool contracts.\n * This includes total VANA staked across the protocol, entity information,\n * and individual staker positions.\n *\n * @example\n * ```typescript\n * // Get total VANA staked in the protocol\n * const totalStaked = await vana.staking.getTotalVanaStaked();\n * console.log(`Total staked: ${totalStaked} wei`);\n *\n * // Get entity information\n * const entity = await vana.staking.getEntity(1n);\n * console.log(`Entity name: ${entity.name}`);\n * ```\n *\n * @category Controllers\n */\nexport class StakingController extends BaseController {\n  constructor(context: ControllerContext) {\n    super(context);\n  }\n\n  /**\n   * Gets the chain ID from context.\n   */\n  private getChainId(): number {\n    const chainId =\n      this.context.walletClient?.chain?.id ??\n      this.context.publicClient.chain?.id;\n    if (!chainId) {\n      throw new Error(\"Chain ID not available\");\n    }\n    return chainId;\n  }\n\n  /**\n   * Gets the VanaPoolEntity contract instance.\n   */\n  private getEntityContract() {\n    const chainId = this.getChainId();\n    return getContract({\n      address: getContractAddress(chainId, \"VanaPoolEntity\"),\n      abi: getAbi(\"VanaPoolEntity\"),\n      client: this.context.publicClient,\n    });\n  }\n\n  /**\n   * Gets the VanaPoolStaking contract instance.\n   */\n  private getStakingContract() {\n    const chainId = this.getChainId();\n    return getContract({\n      address: getContractAddress(chainId, \"VanaPoolStaking\"),\n      abi: getAbi(\"VanaPoolStaking\"),\n      client: this.context.publicClient,\n    });\n  }\n\n  /**\n   * Gets the total amount of VANA staked in the VanaPool protocol or a specific entity.\n   *\n   * @remarks\n   * When called without an entityId, this retrieves the sum of activeRewardPool\n   * across all active entities in the VanaPool protocol.\n   * When called with an entityId, this returns the activeRewardPool for that specific entity.\n   * The value is returned in wei (10^18 = 1 VANA).\n   *\n   * @param entityId - Optional entity ID to get staked amount for a specific entity\n   * @returns The total amount of VANA staked in wei\n   *\n   * @example\n   * ```typescript\n   * // Get total staked across all entities\n   * const totalStaked = await vana.staking.getTotalVanaStaked();\n   * console.log(`Total staked: ${Number(totalStaked) / 1e18} VANA`);\n   *\n   * // Get staked amount for a specific entity\n   * const entityStaked = await vana.staking.getTotalVanaStaked(1n);\n   * console.log(`Entity 1 staked: ${Number(entityStaked) / 1e18} VANA`);\n   * ```\n   */\n  async getTotalVanaStaked(entityId?: bigint): Promise<bigint> {\n    const entityContract = this.getEntityContract();\n\n    // If entityId is provided, return the activeRewardPool for that specific entity\n    if (entityId !== undefined) {\n      const entity = await entityContract.read.entities([entityId]);\n      return entity.activeRewardPool;\n    }\n\n    // Otherwise, sum up the activeRewardPool from all active entities\n    const activeEntityIds = await entityContract.read.activeEntitiesValues();\n\n    let totalStaked = 0n;\n    for (const id of activeEntityIds) {\n      const entity = await entityContract.read.entities([id]);\n      totalStaked += entity.activeRewardPool;\n    }\n\n    return totalStaked;\n  }\n\n  /**\n   * Gets information about a specific staking entity.\n   *\n   * @param entityId - The ID of the entity to query\n   * @returns The entity information including name, APY, shares, and reward pools\n   *\n   * @example\n   * ```typescript\n   * const entity = await vana.staking.getEntity(1n);\n   * console.log(`Entity: ${entity.name}`);\n   * console.log(`Total shares: ${entity.totalShares}`);\n   * console.log(`Max APY: ${Number(entity.maxAPY) / 100}%`);\n   * ```\n   */\n  async getEntity(entityId: bigint): Promise<EntityInfo> {\n    const entityContract = this.getEntityContract();\n\n    const result = await entityContract.read.entities([entityId]);\n\n    return {\n      entityId: result.entityId,\n      ownerAddress: result.ownerAddress as Address,\n      status: result.status,\n      name: result.name,\n      maxAPY: result.maxAPY,\n      lockedRewardPool: result.lockedRewardPool,\n      activeRewardPool: result.activeRewardPool,\n      totalShares: result.totalShares,\n      lastUpdateTimestamp: result.lastUpdateTimestamp,\n      totalDistributedRewards: result.totalDistributedRewards,\n    };\n  }\n\n  /**\n   * Gets the total number of staking entities in the protocol.\n   *\n   * @returns The count of entities\n   *\n   * @example\n   * ```typescript\n   * const count = await vana.staking.getEntitiesCount();\n   * console.log(`Total entities: ${count}`);\n   * ```\n   */\n  async getEntitiesCount(): Promise<bigint> {\n    const entityContract = this.getEntityContract();\n    return entityContract.read.entitiesCount();\n  }\n\n  /**\n   * Gets the IDs of all active staking entities.\n   *\n   * @returns Array of active entity IDs\n   *\n   * @example\n   * ```typescript\n   * const activeIds = await vana.staking.getActiveEntities();\n   * console.log(`Active entities: ${activeIds.join(', ')}`);\n   * ```\n   */\n  async getActiveEntities(): Promise<readonly bigint[]> {\n    const entityContract = this.getEntityContract();\n    return entityContract.read.activeEntitiesValues();\n  }\n\n  /**\n   * Gets a staker's position in a specific entity.\n   *\n   * @param staker - The address of the staker\n   * @param entityId - The ID of the entity\n   * @returns The staker's position information\n   *\n   * @example\n   * ```typescript\n   * const position = await vana.staking.getStakerPosition(\n   *   '0x742d35...',\n   *   1n\n   * );\n   * console.log(`Shares: ${position.shares}`);\n   * console.log(`Rewards: ${position.realizedRewards}`);\n   * ```\n   */\n  async getStakerPosition(\n    staker: Address,\n    entityId: bigint,\n  ): Promise<StakerEntityInfo> {\n    const stakingContract = this.getStakingContract();\n\n    const result = await stakingContract.read.stakerEntities([\n      staker,\n      entityId,\n    ]);\n\n    return {\n      shares: result.shares,\n      costBasis: result.costBasis,\n      rewardEligibilityTimestamp: result.rewardEligibilityTimestamp,\n      realizedRewards: result.realizedRewards,\n      vestedRewards: result.vestedRewards,\n    };\n  }\n\n  /**\n   * Gets the earned rewards for a staker in an entity.\n   *\n   * @param staker - The address of the staker\n   * @param entityId - The ID of the entity\n   * @returns The earned rewards amount in wei\n   *\n   * @example\n   * ```typescript\n   * const rewards = await vana.staking.getEarnedRewards(\n   *   '0x742d35...',\n   *   1n\n   * );\n   * console.log(`Earned: ${Number(rewards) / 1e18} VANA`);\n   * ```\n   */\n  async getEarnedRewards(staker: Address, entityId: bigint): Promise<bigint> {\n    const stakingContract = this.getStakingContract();\n    return stakingContract.read.getEarnedRewards([staker, entityId]);\n  }\n\n  /**\n   * Gets the minimum stake amount required to stake.\n   *\n   * @returns The minimum stake amount in wei\n   *\n   * @example\n   * ```typescript\n   * const minStake = await vana.staking.getMinStakeAmount();\n   * console.log(`Minimum stake: ${Number(minStake) / 1e18} VANA`);\n   * ```\n   */\n  async getMinStakeAmount(): Promise<bigint> {\n    const stakingContract = this.getStakingContract();\n    return stakingContract.read.minStakeAmount();\n  }\n\n  /**\n   * Gets the count of active stakers in the protocol.\n   *\n   * @returns The number of active stakers\n   *\n   * @example\n   * ```typescript\n   * const count = await vana.staking.getActiveStakersCount();\n   * console.log(`Active stakers: ${count}`);\n   * ```\n   */\n  async getActiveStakersCount(): Promise<bigint> {\n    const stakingContract = this.getStakingContract();\n    return stakingContract.read.activeStakersListCount();\n  }\n\n  /**\n   * Gets the bonding period for staking.\n   *\n   * @returns The bonding period in seconds\n   *\n   * @example\n   * ```typescript\n   * const bondingPeriod = await vana.staking.getBondingPeriod();\n   * console.log(`Bonding period: ${bondingPeriod / 86400n} days`);\n   * ```\n   */\n  async getBondingPeriod(): Promise<bigint> {\n    const stakingContract = this.getStakingContract();\n    return stakingContract.read.bondingPeriod();\n  }\n\n  /**\n   * Gets the total distributed rewards for a specific entity from the contract.\n   *\n   * @remarks\n   * This reads the `totalDistributedRewards` field from the entity's on-chain state.\n   * This value represents the sum of all rewards that have been processed\n   * (moved from lockedRewardPool to activeRewardPool) minus any forfeited\n   * rewards that were returned.\n   *\n   * @param entityId - The ID of the entity to query\n   * @returns The total distributed rewards in wei\n   *\n   * @example\n   * ```typescript\n   * const totalRewards = await vana.staking.getTotalDistributedRewards(1n);\n   * const totalRewardsVana = Number(totalRewards) / 1e18;\n   * console.log(`Total distributed rewards: ${totalRewardsVana.toLocaleString()} VANA`);\n   * ```\n   */\n  async getTotalDistributedRewards(entityId: bigint): Promise<bigint> {\n    const entityContract = this.getEntityContract();\n    const result = await entityContract.read.entities([entityId]);\n    return result.totalDistributedRewards;\n  }\n\n  /**\n   * Gets a comprehensive staking summary for a staker in an entity.\n   *\n   * @remarks\n   * This method aggregates all relevant staking information for a staker in a single call,\n   * including staked amount, current value, bonding status, and all reward types.\n   *\n   * Reward breakdown:\n   * - `earnedRewards` = pendingInterest + vestedRewards + realizedRewards\n   * - `pendingInterest` = currentValue - costBasis (unvested appreciation)\n   * - `vestedRewards` = rewards that have vested but not yet withdrawn\n   * - `realizedRewards` = rewards already withdrawn during unstakes\n   *\n   * @param staker - The address of the staker\n   * @param entityId - The ID of the entity\n   * @returns A comprehensive summary of the staker's position\n   *\n   * @example\n   * ```typescript\n   * const summary = await vana.staking.getStakerSummary('0x742d35...', 1n);\n   * console.log(`Total staked: ${Number(summary.totalStaked) / 1e18} VANA`);\n   * console.log(`Current value: ${Number(summary.currentValue) / 1e18} VANA`);\n   * console.log(`In bonding period: ${summary.isInBondingPeriod}`);\n   * console.log(`Remaining bonding time: ${Number(summary.remainingBondingTime) / 86400} days`);\n   * console.log(`Vested rewards: ${Number(summary.vestedRewards) / 1e18} VANA`);\n   * console.log(`Unvested rewards: ${Number(summary.unvestedRewards) / 1e18} VANA`);\n   * console.log(`Realized rewards: ${Number(summary.realizedRewards) / 1e18} VANA`);\n   * console.log(`Total earned: ${Number(summary.earnedRewards) / 1e18} VANA`);\n   * ```\n   */\n  async getStakerSummary(\n    staker: Address,\n    entityId: bigint,\n  ): Promise<StakerEntitySummary> {\n    const chainId = this.getChainId();\n    const stakingAddress = getContractAddress(chainId, \"VanaPoolStaking\");\n    const entityAddress = getContractAddress(chainId, \"VanaPoolEntity\");\n    const stakingAbi = getAbi(\"VanaPoolStaking\");\n    const entityAbi = getAbi(\"VanaPoolEntity\");\n\n    // Get latest block first to ensure all reads are from the same block\n    const block = await this.context.publicClient.getBlock();\n    const blockNumber = block.number;\n\n    // Batch all contract reads into a single multicall RPC request at the same block\n    const multicallResults = await this.context.publicClient.multicall({\n      contracts: [\n        {\n          address: stakingAddress,\n          abi: stakingAbi,\n          functionName: \"stakerEntities\",\n          args: [staker, entityId],\n        },\n        {\n          address: stakingAddress,\n          abi: stakingAbi,\n          functionName: \"getEarnedRewards\",\n          args: [staker, entityId],\n        },\n        {\n          address: entityAddress,\n          abi: entityAbi,\n          functionName: \"entityShareToVana\",\n          args: [entityId],\n        },\n      ],\n      blockNumber,\n    });\n\n    const [positionResult, earnedRewardsResult, shareToVanaResult] =\n      multicallResults;\n\n    if (\n      positionResult.status === \"failure\" ||\n      earnedRewardsResult.status === \"failure\" ||\n      shareToVanaResult.status === \"failure\"\n    ) {\n      throw new BlockchainError(\n        \"Failed to fetch staker summary: one or more contract calls failed\",\n      );\n    }\n\n    const position = positionResult.result as {\n      shares: bigint;\n      costBasis: bigint;\n      rewardEligibilityTimestamp: bigint;\n      realizedRewards: bigint;\n      vestedRewards: bigint;\n    };\n    const earnedRewards = earnedRewardsResult.result as bigint;\n    const shareToVana = shareToVanaResult.result as bigint;\n    const currentTimestamp = block.timestamp;\n\n    // Calculate remaining bonding time\n    const eligibilityTimestamp = position.rewardEligibilityTimestamp;\n    const remainingBondingTime =\n      eligibilityTimestamp > currentTimestamp\n        ? eligibilityTimestamp - currentTimestamp\n        : 0n;\n    const isInBondingPeriod = remainingBondingTime > 0n;\n\n    // Calculate current value of shares\n    // entityShareToVana returns the VANA value of 1 share (scaled by 1e18)\n    const currentValue = (position.shares * shareToVana) / 10n ** 18n;\n\n    // Calculate pending interest (unvested rewards)\n    // pendingInterest = currentValue - costBasis (if positive)\n    const unvestedRewards =\n      currentValue > position.costBasis\n        ? currentValue - position.costBasis\n        : 0n;\n\n    return {\n      shares: position.shares,\n      costBasis: position.costBasis,\n      currentValue,\n      rewardEligibilityTimestamp: eligibilityTimestamp,\n      remainingBondingTime,\n      isInBondingPeriod,\n      vestedRewards: position.vestedRewards,\n      unvestedRewards,\n      realizedRewards: position.realizedRewards,\n      earnedRewards,\n    };\n  }\n\n  /**\n   * Stakes VANA to an entity in the VanaPool protocol.\n   *\n   * @remarks\n   * This method stakes native VANA tokens to a specified entity. The staker will receive\n   * shares in proportion to their stake amount. A bonding period applies during which\n   * rewards cannot be fully claimed without penalty.\n   *\n   * Requires a wallet client to be configured in the Vana constructor.\n   *\n   * @param params - The staking parameters\n   * @param params.entityId - The ID of the entity to stake to\n   * @param params.amount - The amount of VANA to stake (in wei, or as a string like \"1.5\" for 1.5 VANA)\n   * @param params.recipient - Optional recipient address for the shares (defaults to the sender)\n   * @param params.minShares - Optional minimum shares to receive (slippage protection, defaults to 0)\n   * @returns The transaction hash\n   * @throws {BlockchainError} When wallet client is not configured\n   *\n   * @example\n   * ```typescript\n   * // Stake 100 VANA to entity 1\n   * const txHash = await vana.staking.stake({\n   *   entityId: 1n,\n   *   amount: \"100\", // 100 VANA\n   * });\n   * console.log(`Staked! Transaction: ${txHash}`);\n   *\n   * // Stake with slippage protection\n   * const txHash2 = await vana.staking.stake({\n   *   entityId: 1n,\n   *   amount: parseEther(\"50\"), // 50 VANA in wei\n   *   minShares: parseEther(\"49\"), // Expect at least 49 shares\n   * });\n   * ```\n   */\n  async stake(\n    params: {\n      entityId: bigint;\n      amount: bigint | string;\n      recipient?: Address;\n      minShares?: bigint;\n    },\n    options?: TransactionOptions,\n  ): Promise<Hash> {\n    this.assertWallet();\n\n    const chainId = this.getChainId();\n    const stakingAddress = getContractAddress(chainId, \"VanaPoolStaking\");\n    const stakingAbi = getAbi(\"VanaPoolStaking\");\n\n    // Convert amount to bigint if it's a string (e.g., \"1.5\" -> 1.5 VANA in wei)\n    const amountWei =\n      typeof params.amount === \"string\"\n        ? parseEther(params.amount)\n        : params.amount;\n\n    // Get account with fallback to userAddress\n    const account =\n      this.context.walletClient.account ?? this.context.userAddress;\n    const accountAddress =\n      typeof account === \"string\" ? account : account.address;\n\n    // Default recipient to the sender's address\n    const recipient = params.recipient ?? accountAddress;\n\n    // Default minShares to 0 (no slippage protection)\n    const minShares = params.minShares ?? 0n;\n\n    const txHash = await this.context.walletClient.writeContract({\n      address: stakingAddress,\n      abi: stakingAbi,\n      functionName: \"stake\",\n      args: [params.entityId, recipient, minShares],\n      value: amountWei,\n      account,\n      chain: this.context.walletClient.chain,\n      ...this.spreadTransactionOptions(options),\n    });\n\n    return txHash;\n  }\n\n  /**\n   * Gets the maximum amount of VANA that can be unstaked in a single transaction.\n   *\n   * @remarks\n   * This calls the contract's getMaxUnstakeAmount which returns the minimum of:\n   * 1. The withdrawable VANA (costBasis if in bonding period, shareValue if eligible)\n   * 2. The entity's activeRewardPool (what the entity has available)\n   * 3. The treasury balance (what can be paid out)\n   *\n   * The limiting factor indicates what's constraining the unstake:\n   * - 0 = user shares/costBasis\n   * - 1 = activeRewardPool\n   * - 2 = treasury\n   *\n   * @param staker - The address of the staker\n   * @param entityId - The ID of the entity\n   * @returns Object containing maxVana, maxShares, limitingFactor, and isInBondingPeriod\n   *\n   * @example\n   * ```typescript\n   * const result = await vana.staking.getMaxUnstakeAmount('0x742d35...', 1n);\n   * console.log(`Max unstake: ${Number(result.maxVana) / 1e18} VANA`);\n   * console.log(`Max shares: ${result.maxShares}`);\n   * console.log(`In bonding period: ${result.isInBondingPeriod}`);\n   * ```\n   */\n  async getMaxUnstakeAmount(\n    staker: Address,\n    entityId: bigint,\n  ): Promise<{\n    maxVana: bigint;\n    maxShares: bigint;\n    limitingFactor: number;\n    isInBondingPeriod: boolean;\n  }> {\n    const stakingContract = this.getStakingContract();\n\n    const result = await stakingContract.read.getMaxUnstakeAmount([\n      staker,\n      entityId,\n    ]);\n\n    return {\n      maxVana: result[0],\n      maxShares: result[1],\n      limitingFactor: Number(result[2]),\n      isInBondingPeriod: result[3],\n    };\n  }\n\n  /**\n   * Computes the new bonding period end timestamp after adding stake.\n   *\n   * @remarks\n   * When a staker adds more stake to an existing position, the reward eligibility timestamp\n   * is recalculated as a weighted average of the existing and new positions. This function\n   * allows you to preview what the new eligibility timestamp would be without executing\n   * the stake transaction.\n   *\n   * The formula used (matching the contract):\n   * ```\n   * newEligibility = (existingShares * existingEligibility + newShares * newEligibility) / totalShares\n   * ```\n   *\n   * Where `newEligibility` for the incoming stake is `currentTimestamp + bondingPeriod`.\n   *\n   * @param params - The parameters for computing the new bonding period\n   * @param params.staker - The address of the staker\n   * @param params.entityId - The ID of the entity\n   * @param params.stakeAmount - The amount of VANA to stake (in wei)\n   * @returns Object containing the new eligibility timestamp and related info\n   *\n   * @example\n   * ```typescript\n   * // Preview bonding period after staking 100 VANA\n   * const preview = await vana.staking.computeNewBondingPeriod({\n   *   staker: '0x742d35...',\n   *   entityId: 1n,\n   *   stakeAmount: parseEther(\"100\"),\n   * });\n   * console.log(`New eligibility: ${new Date(Number(preview.newEligibilityTimestamp) * 1000)}`);\n   * console.log(`Remaining bonding time: ${Number(preview.newRemainingBondingTime) / 86400} days`);\n   * ```\n   */\n  async computeNewBondingPeriod(params: {\n    staker: Address;\n    entityId: bigint;\n    stakeAmount: bigint;\n  }): Promise<{\n    /** The new reward eligibility timestamp after staking */\n    newEligibilityTimestamp: bigint;\n    /** Remaining bonding time in seconds after staking */\n    newRemainingBondingTime: bigint;\n    /** Current eligibility timestamp (before staking) */\n    currentEligibilityTimestamp: bigint;\n    /** Current remaining bonding time (before staking) */\n    currentRemainingBondingTime: bigint;\n    /** Current shares held by staker */\n    currentShares: bigint;\n    /** Estimated new shares to be received */\n    estimatedNewShares: bigint;\n    /** Total shares after staking */\n    totalSharesAfter: bigint;\n    /** The bonding period duration in seconds */\n    bondingPeriodDuration: bigint;\n    /** Current block timestamp used for calculation */\n    currentTimestamp: bigint;\n  }> {\n    const chainId = this.getChainId();\n    const stakingAddress = getContractAddress(chainId, \"VanaPoolStaking\");\n    const entityAddress = getContractAddress(chainId, \"VanaPoolEntity\");\n    const stakingAbi = getAbi(\"VanaPoolStaking\");\n    const entityAbi = getAbi(\"VanaPoolEntity\");\n\n    // Get latest block first to ensure all reads are from the same block\n    const block = await this.context.publicClient.getBlock();\n    const blockNumber = block.number;\n    const currentTimestamp = block.timestamp;\n\n    // Batch all contract reads into a single multicall RPC request at the same block\n    const multicallResults = await this.context.publicClient.multicall({\n      contracts: [\n        {\n          address: stakingAddress,\n          abi: stakingAbi,\n          functionName: \"stakerEntities\",\n          args: [params.staker, params.entityId],\n        },\n        {\n          address: stakingAddress,\n          abi: stakingAbi,\n          functionName: \"bondingPeriod\",\n          args: [],\n        },\n        {\n          address: entityAddress,\n          abi: entityAbi,\n          functionName: \"vanaToEntityShare\",\n          args: [params.entityId],\n        },\n      ],\n      blockNumber,\n    });\n\n    const [positionResult, bondingPeriodResult, vanaToShareResult] =\n      multicallResults;\n\n    if (\n      positionResult.status === \"failure\" ||\n      bondingPeriodResult.status === \"failure\" ||\n      vanaToShareResult.status === \"failure\"\n    ) {\n      throw new BlockchainError(\n        \"Failed to compute new bonding period: one or more contract calls failed\",\n      );\n    }\n\n    const position = positionResult.result as {\n      shares: bigint;\n      costBasis: bigint;\n      rewardEligibilityTimestamp: bigint;\n      realizedRewards: bigint;\n      vestedRewards: bigint;\n    };\n    const bondingPeriodDuration = bondingPeriodResult.result as bigint;\n    const vanaToShare = vanaToShareResult.result as bigint;\n\n    const currentShares = position.shares;\n    const currentEligibilityTimestamp = position.rewardEligibilityTimestamp;\n\n    // Calculate current remaining bonding time\n    const currentRemainingBondingTime =\n      currentEligibilityTimestamp > currentTimestamp\n        ? currentEligibilityTimestamp - currentTimestamp\n        : 0n;\n\n    // Estimate new shares: newShares = (stakeAmount * vanaToShare) / 1e18\n    const estimatedNewShares = (params.stakeAmount * vanaToShare) / 10n ** 18n;\n\n    // Calculate new eligibility timestamp using weighted average formula\n    // newEligibility = (existingShares * existingEligibility + newShares * (currentTime + bondingPeriod)) / totalShares\n    const totalSharesAfter = currentShares + estimatedNewShares;\n    const newStakeEligibility = currentTimestamp + bondingPeriodDuration;\n\n    let newEligibilityTimestamp: bigint;\n    if (currentShares === 0n) {\n      // First stake: eligibility is simply current time + bonding period\n      newEligibilityTimestamp = newStakeEligibility;\n    } else {\n      // Weighted average of existing and new positions\n      newEligibilityTimestamp =\n        (currentShares * currentEligibilityTimestamp +\n          estimatedNewShares * newStakeEligibility) /\n        totalSharesAfter;\n    }\n\n    // Calculate new remaining bonding time\n    const newRemainingBondingTime =\n      newEligibilityTimestamp > currentTimestamp\n        ? newEligibilityTimestamp - currentTimestamp\n        : 0n;\n\n    return {\n      newEligibilityTimestamp,\n      newRemainingBondingTime,\n      currentEligibilityTimestamp,\n      currentRemainingBondingTime,\n      currentShares,\n      estimatedNewShares,\n      totalSharesAfter,\n      bondingPeriodDuration,\n      currentTimestamp,\n    };\n  }\n\n  /**\n   * Unstakes VANA from an entity in the VanaPool protocol.\n   *\n   * @remarks\n   * This method unstakes native VANA tokens from a specified entity. The amount\n   * that can be unstaked depends on whether the staker is in the bonding period:\n   *\n   * - **During bonding period**: Only cost basis can be withdrawn; rewards are forfeited\n   * - **After bonding period**: Full current value (cost basis + rewards) can be withdrawn\n   *\n   * Use `getMaxUnstakeAmount` to determine the maximum amount that can be unstaked.\n   *\n   * Requires a wallet client to be configured in the Vana constructor.\n   *\n   * @param params - The unstaking parameters\n   * @param params.entityId - The ID of the entity to unstake from\n   * @param params.amount - The amount of VANA to unstake (in wei, or as a string like \"1.5\" for 1.5 VANA)\n   * @param params.maxShares - Maximum shares to burn for slippage protection (defaults to 0, no protection)\n   * @returns The transaction hash\n   * @throws {BlockchainError} When wallet client is not configured\n   *\n   * @example\n   * ```typescript\n   * // Get max unstake amount first\n   * const maxUnstake = await vana.staking.getMaxUnstakeAmount(address, 1n);\n   *\n   * // Unstake the maximum amount with slippage protection\n   * const txHash = await vana.staking.unstake({\n   *   entityId: 1n,\n   *   amount: maxUnstake.maxVana,\n   *   maxShares: maxUnstake.maxShares,\n   * });\n   * console.log(`Unstaked! Transaction: ${txHash}`);\n   * ```\n   */\n  async unstake(\n    params: {\n      entityId: bigint;\n      amount: bigint | string;\n      maxShares?: bigint;\n    },\n    options?: TransactionOptions,\n  ): Promise<Hash> {\n    this.assertWallet();\n\n    const chainId = this.getChainId();\n    const stakingAddress = getContractAddress(chainId, \"VanaPoolStaking\");\n    const stakingAbi = getAbi(\"VanaPoolStaking\");\n\n    // Convert amount to bigint if it's a string (e.g., \"1.5\" -> 1.5 VANA in wei)\n    const amountWei =\n      typeof params.amount === \"string\"\n        ? parseEther(params.amount)\n        : params.amount;\n\n    // Default maxShares to 0 (no slippage protection)\n    const maxShares = params.maxShares ?? 0n;\n\n    // Get account with fallback to userAddress\n    const account =\n      this.context.walletClient.account ?? this.context.userAddress;\n\n    const txHash = await this.context.walletClient.writeContract({\n      address: stakingAddress,\n      abi: stakingAbi,\n      functionName: \"unstakeVana\",\n      args: [params.entityId, amountWei, maxShares],\n      account,\n      chain: this.context.walletClient.chain,\n      ...this.spreadTransactionOptions(options),\n    });\n\n    return txHash;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,kBAA+B;AAC/B,kBAAwC;AAExC,uBAAmC;AACnC,iBAAuB;AACvB,oBAAgC;AA4EzB,MAAM,0BAA0B,2BAAe;AAAA,EACpD,YAAY,SAA4B;AACtC,UAAM,OAAO;AAAA,EACf;AAAA;AAAA;AAAA;AAAA,EAKQ,aAAqB;AAC3B,UAAM,UACJ,KAAK,QAAQ,cAAc,OAAO,MAClC,KAAK,QAAQ,aAAa,OAAO;AACnC,QAAI,CAAC,SAAS;AACZ,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAAoB;AAC1B,UAAM,UAAU,KAAK,WAAW;AAChC,eAAO,yBAAY;AAAA,MACjB,aAAS,qCAAmB,SAAS,gBAAgB;AAAA,MACrD,SAAK,mBAAO,gBAAgB;AAAA,MAC5B,QAAQ,KAAK,QAAQ;AAAA,IACvB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKQ,qBAAqB;AAC3B,UAAM,UAAU,KAAK,WAAW;AAChC,eAAO,yBAAY;AAAA,MACjB,aAAS,qCAAmB,SAAS,iBAAiB;AAAA,MACtD,SAAK,mBAAO,iBAAiB;AAAA,MAC7B,QAAQ,KAAK,QAAQ;AAAA,IACvB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,MAAM,mBAAmB,UAAoC;AAC3D,UAAM,iBAAiB,KAAK,kBAAkB;AAG9C,QAAI,aAAa,QAAW;AAC1B,YAAM,SAAS,MAAM,eAAe,KAAK,SAAS,CAAC,QAAQ,CAAC;AAC5D,aAAO,OAAO;AAAA,IAChB;AAGA,UAAM,kBAAkB,MAAM,eAAe,KAAK,qBAAqB;AAEvE,QAAI,cAAc;AAClB,eAAW,MAAM,iBAAiB;AAChC,YAAM,SAAS,MAAM,eAAe,KAAK,SAAS,CAAC,EAAE,CAAC;AACtD,qBAAe,OAAO;AAAA,IACxB;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,UAAU,UAAuC;AACrD,UAAM,iBAAiB,KAAK,kBAAkB;AAE9C,UAAM,SAAS,MAAM,eAAe,KAAK,SAAS,CAAC,QAAQ,CAAC;AAE5D,WAAO;AAAA,MACL,UAAU,OAAO;AAAA,MACjB,cAAc,OAAO;AAAA,MACrB,QAAQ,OAAO;AAAA,MACf,MAAM,OAAO;AAAA,MACb,QAAQ,OAAO;AAAA,MACf,kBAAkB,OAAO;AAAA,MACzB,kBAAkB,OAAO;AAAA,MACzB,aAAa,OAAO;AAAA,MACpB,qBAAqB,OAAO;AAAA,MAC5B,yBAAyB,OAAO;AAAA,IAClC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,mBAAoC;AACxC,UAAM,iBAAiB,KAAK,kBAAkB;AAC9C,WAAO,eAAe,KAAK,cAAc;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,oBAAgD;AACpD,UAAM,iBAAiB,KAAK,kBAAkB;AAC9C,WAAO,eAAe,KAAK,qBAAqB;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,MAAM,kBACJ,QACA,UAC2B;AAC3B,UAAM,kBAAkB,KAAK,mBAAmB;AAEhD,UAAM,SAAS,MAAM,gBAAgB,KAAK,eAAe;AAAA,MACvD;AAAA,MACA;AAAA,IACF,CAAC;AAED,WAAO;AAAA,MACL,QAAQ,OAAO;AAAA,MACf,WAAW,OAAO;AAAA,MAClB,4BAA4B,OAAO;AAAA,MACnC,iBAAiB,OAAO;AAAA,MACxB,eAAe,OAAO;AAAA,IACxB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,MAAM,iBAAiB,QAAiB,UAAmC;AACzE,UAAM,kBAAkB,KAAK,mBAAmB;AAChD,WAAO,gBAAgB,KAAK,iBAAiB,CAAC,QAAQ,QAAQ,CAAC;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,oBAAqC;AACzC,UAAM,kBAAkB,KAAK,mBAAmB;AAChD,WAAO,gBAAgB,KAAK,eAAe;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,wBAAyC;AAC7C,UAAM,kBAAkB,KAAK,mBAAmB;AAChD,WAAO,gBAAgB,KAAK,uBAAuB;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,mBAAoC;AACxC,UAAM,kBAAkB,KAAK,mBAAmB;AAChD,WAAO,gBAAgB,KAAK,cAAc;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,MAAM,2BAA2B,UAAmC;AAClE,UAAM,iBAAiB,KAAK,kBAAkB;AAC9C,UAAM,SAAS,MAAM,eAAe,KAAK,SAAS,CAAC,QAAQ,CAAC;AAC5D,WAAO,OAAO;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgCA,MAAM,iBACJ,QACA,UAC8B;AAC9B,UAAM,UAAU,KAAK,WAAW;AAChC,UAAM,qBAAiB,qCAAmB,SAAS,iBAAiB;AACpE,UAAM,oBAAgB,qCAAmB,SAAS,gBAAgB;AAClE,UAAM,iBAAa,mBAAO,iBAAiB;AAC3C,UAAM,gBAAY,mBAAO,gBAAgB;AAGzC,UAAM,QAAQ,MAAM,KAAK,QAAQ,aAAa,SAAS;AACvD,UAAM,cAAc,MAAM;AAG1B,UAAM,mBAAmB,MAAM,KAAK,QAAQ,aAAa,UAAU;AAAA,MACjE,WAAW;AAAA,QACT;AAAA,UACE,SAAS;AAAA,UACT,KAAK;AAAA,UACL,cAAc;AAAA,UACd,MAAM,CAAC,QAAQ,QAAQ;AAAA,QACzB;AAAA,QACA;AAAA,UACE,SAAS;AAAA,UACT,KAAK;AAAA,UACL,cAAc;AAAA,UACd,MAAM,CAAC,QAAQ,QAAQ;AAAA,QACzB;AAAA,QACA;AAAA,UACE,SAAS;AAAA,UACT,KAAK;AAAA,UACL,cAAc;AAAA,UACd,MAAM,CAAC,QAAQ;AAAA,QACjB;AAAA,MACF;AAAA,MACA;AAAA,IACF,CAAC;AAED,UAAM,CAAC,gBAAgB,qBAAqB,iBAAiB,IAC3D;AAEF,QACE,eAAe,WAAW,aAC1B,oBAAoB,WAAW,aAC/B,kBAAkB,WAAW,WAC7B;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAW,eAAe;AAOhC,UAAM,gBAAgB,oBAAoB;AAC1C,UAAM,cAAc,kBAAkB;AACtC,UAAM,mBAAmB,MAAM;AAG/B,UAAM,uBAAuB,SAAS;AACtC,UAAM,uBACJ,uBAAuB,mBACnB,uBAAuB,mBACvB;AACN,UAAM,oBAAoB,uBAAuB;AAIjD,UAAM,eAAgB,SAAS,SAAS,cAAe,OAAO;AAI9D,UAAM,kBACJ,eAAe,SAAS,YACpB,eAAe,SAAS,YACxB;AAEN,WAAO;AAAA,MACL,QAAQ,SAAS;AAAA,MACjB,WAAW,SAAS;AAAA,MACpB;AAAA,MACA,4BAA4B;AAAA,MAC5B;AAAA,MACA;AAAA,MACA,eAAe,SAAS;AAAA,MACxB;AAAA,MACA,iBAAiB,SAAS;AAAA,MAC1B;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqCA,MAAM,MACJ,QAMA,SACe;AACf,SAAK,aAAa;AAElB,UAAM,UAAU,KAAK,WAAW;AAChC,UAAM,qBAAiB,qCAAmB,SAAS,iBAAiB;AACpE,UAAM,iBAAa,mBAAO,iBAAiB;AAG3C,UAAM,YACJ,OAAO,OAAO,WAAW,eACrB,wBAAW,OAAO,MAAM,IACxB,OAAO;AAGb,UAAM,UACJ,KAAK,QAAQ,aAAa,WAAW,KAAK,QAAQ;AACpD,UAAM,iBACJ,OAAO,YAAY,WAAW,UAAU,QAAQ;AAGlD,UAAM,YAAY,OAAO,aAAa;AAGtC,UAAM,YAAY,OAAO,aAAa;AAEtC,UAAM,SAAS,MAAM,KAAK,QAAQ,aAAa,cAAc;AAAA,MAC3D,SAAS;AAAA,MACT,KAAK;AAAA,MACL,cAAc;AAAA,MACd,MAAM,CAAC,OAAO,UAAU,WAAW,SAAS;AAAA,MAC5C,OAAO;AAAA,MACP;AAAA,MACA,OAAO,KAAK,QAAQ,aAAa;AAAA,MACjC,GAAG,KAAK,yBAAyB,OAAO;AAAA,IAC1C,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BA,MAAM,oBACJ,QACA,UAMC;AACD,UAAM,kBAAkB,KAAK,mBAAmB;AAEhD,UAAM,SAAS,MAAM,gBAAgB,KAAK,oBAAoB;AAAA,MAC5D;AAAA,MACA;AAAA,IACF,CAAC;AAED,WAAO;AAAA,MACL,SAAS,OAAO,CAAC;AAAA,MACjB,WAAW,OAAO,CAAC;AAAA,MACnB,gBAAgB,OAAO,OAAO,CAAC,CAAC;AAAA,MAChC,mBAAmB,OAAO,CAAC;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoCA,MAAM,wBAAwB,QAuB3B;AACD,UAAM,UAAU,KAAK,WAAW;AAChC,UAAM,qBAAiB,qCAAmB,SAAS,iBAAiB;AACpE,UAAM,oBAAgB,qCAAmB,SAAS,gBAAgB;AAClE,UAAM,iBAAa,mBAAO,iBAAiB;AAC3C,UAAM,gBAAY,mBAAO,gBAAgB;AAGzC,UAAM,QAAQ,MAAM,KAAK,QAAQ,aAAa,SAAS;AACvD,UAAM,cAAc,MAAM;AAC1B,UAAM,mBAAmB,MAAM;AAG/B,UAAM,mBAAmB,MAAM,KAAK,QAAQ,aAAa,UAAU;AAAA,MACjE,WAAW;AAAA,QACT;AAAA,UACE,SAAS;AAAA,UACT,KAAK;AAAA,UACL,cAAc;AAAA,UACd,MAAM,CAAC,OAAO,QAAQ,OAAO,QAAQ;AAAA,QACvC;AAAA,QACA;AAAA,UACE,SAAS;AAAA,UACT,KAAK;AAAA,UACL,cAAc;AAAA,UACd,MAAM,CAAC;AAAA,QACT;AAAA,QACA;AAAA,UACE,SAAS;AAAA,UACT,KAAK;AAAA,UACL,cAAc;AAAA,UACd,MAAM,CAAC,OAAO,QAAQ;AAAA,QACxB;AAAA,MACF;AAAA,MACA;AAAA,IACF,CAAC;AAED,UAAM,CAAC,gBAAgB,qBAAqB,iBAAiB,IAC3D;AAEF,QACE,eAAe,WAAW,aAC1B,oBAAoB,WAAW,aAC/B,kBAAkB,WAAW,WAC7B;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAW,eAAe;AAOhC,UAAM,wBAAwB,oBAAoB;AAClD,UAAM,cAAc,kBAAkB;AAEtC,UAAM,gBAAgB,SAAS;AAC/B,UAAM,8BAA8B,SAAS;AAG7C,UAAM,8BACJ,8BAA8B,mBAC1B,8BAA8B,mBAC9B;AAGN,UAAM,qBAAsB,OAAO,cAAc,cAAe,OAAO;AAIvE,UAAM,mBAAmB,gBAAgB;AACzC,UAAM,sBAAsB,mBAAmB;AAE/C,QAAI;AACJ,QAAI,kBAAkB,IAAI;AAExB,gCAA0B;AAAA,IAC5B,OAAO;AAEL,iCACG,gBAAgB,8BACf,qBAAqB,uBACvB;AAAA,IACJ;AAGA,UAAM,0BACJ,0BAA0B,mBACtB,0BAA0B,mBAC1B;AAEN,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqCA,MAAM,QACJ,QAKA,SACe;AACf,SAAK,aAAa;AAElB,UAAM,UAAU,KAAK,WAAW;AAChC,UAAM,qBAAiB,qCAAmB,SAAS,iBAAiB;AACpE,UAAM,iBAAa,mBAAO,iBAAiB;AAG3C,UAAM,YACJ,OAAO,OAAO,WAAW,eACrB,wBAAW,OAAO,MAAM,IACxB,OAAO;AAGb,UAAM,YAAY,OAAO,aAAa;AAGtC,UAAM,UACJ,KAAK,QAAQ,aAAa,WAAW,KAAK,QAAQ;AAEpD,UAAM,SAAS,MAAM,KAAK,QAAQ,aAAa,cAAc;AAAA,MAC3D,SAAS;AAAA,MACT,KAAK;AAAA,MACL,cAAc;AAAA,MACd,MAAM,CAAC,OAAO,UAAU,WAAW,SAAS;AAAA,MAC5C;AAAA,MACA,OAAO,KAAK,QAAQ,aAAa;AAAA,MACjC,GAAG,KAAK,yBAAyB,OAAO;AAAA,IAC1C,CAAC;AAED,WAAO;AAAA,EACT;AACF;","names":[]}

package/dist/controllers/staking.d.ts

@@ -1,457 +0,0 @@
-/**
- * Provides staking functionality for the VanaPool protocol.
- *
- * @remarks
- * This controller handles interactions with VanaPool staking contracts,
- * allowing users to query staking information such as total VANA staked,
- * entity information, and staker positions.
- *
- * @category Controllers
- * @module StakingController
- */
-import type { ControllerContext } from "../types/controller-context";
-import type { TransactionOptions } from "../types/operations";
-import { BaseController } from "./base";
-import type { Address, Hash } from "viem";
-/**
- * Information about a staking entity in the VanaPool protocol.
- */
-export interface EntityInfo {
-    entityId: bigint;
-    ownerAddress: Address;
-    status: number;
-    name: string;
-    maxAPY: bigint;
-    lockedRewardPool: bigint;
-    activeRewardPool: bigint;
-    totalShares: bigint;
-    lastUpdateTimestamp: bigint;
-    totalDistributedRewards: bigint;
-}
-/**
- * Information about a staker's position in an entity.
- */
-export interface StakerEntityInfo {
-    shares: bigint;
-    costBasis: bigint;
-    rewardEligibilityTimestamp: bigint;
-    realizedRewards: bigint;
-    vestedRewards: bigint;
-}
-/**
- * Comprehensive staking summary for a staker in an entity.
- */
-export interface StakerEntitySummary {
-    /** Number of shares owned by the staker */
-    shares: bigint;
-    /** Cost basis - the original VANA amount staked */
-    costBasis: bigint;
-    /** Current value of the staker's shares in VANA */
-    currentValue: bigint;
-    /** Timestamp when rewards become eligible */
-    rewardEligibilityTimestamp: bigint;
-    /** Remaining bonding time in seconds (0 if bonding period has passed) */
-    remainingBondingTime: bigint;
-    /** Whether the staker is still in the bonding period */
-    isInBondingPeriod: boolean;
-    /** Vested rewards that can be claimed without penalty */
-    vestedRewards: bigint;
-    /** Unvested rewards (pending interest = currentValue - costBasis) */
-    unvestedRewards: bigint;
-    /** Realized/withdrawn rewards (already claimed) */
-    realizedRewards: bigint;
-    /** Total earned rewards (includes vested, unvested, and realized) */
-    earnedRewards: bigint;
-}
-/**
- * Controller for VanaPool staking operations.
- *
- * @remarks
- * Provides methods to query staking information from the VanaPool contracts.
- * This includes total VANA staked across the protocol, entity information,
- * and individual staker positions.
- *
- * @example
- * ```typescript
- * // Get total VANA staked in the protocol
- * const totalStaked = await vana.staking.getTotalVanaStaked();
- * console.log(`Total staked: ${totalStaked} wei`);
- *
- * // Get entity information
- * const entity = await vana.staking.getEntity(1n);
- * console.log(`Entity name: ${entity.name}`);
- * ```
- *
- * @category Controllers
- */
-export declare class StakingController extends BaseController {
-    constructor(context: ControllerContext);
-    /**
-     * Gets the chain ID from context.
-     */
-    private getChainId;
-    /**
-     * Gets the VanaPoolEntity contract instance.
-     */
-    private getEntityContract;
-    /**
-     * Gets the VanaPoolStaking contract instance.
-     */
-    private getStakingContract;
-    /**
-     * Gets the total amount of VANA staked in the VanaPool protocol or a specific entity.
-     *
-     * @remarks
-     * When called without an entityId, this retrieves the sum of activeRewardPool
-     * across all active entities in the VanaPool protocol.
-     * When called with an entityId, this returns the activeRewardPool for that specific entity.
-     * The value is returned in wei (10^18 = 1 VANA).
-     *
-     * @param entityId - Optional entity ID to get staked amount for a specific entity
-     * @returns The total amount of VANA staked in wei
-     *
-     * @example
-     * ```typescript
-     * // Get total staked across all entities
-     * const totalStaked = await vana.staking.getTotalVanaStaked();
-     * console.log(`Total staked: ${Number(totalStaked) / 1e18} VANA`);
-     *
-     * // Get staked amount for a specific entity
-     * const entityStaked = await vana.staking.getTotalVanaStaked(1n);
-     * console.log(`Entity 1 staked: ${Number(entityStaked) / 1e18} VANA`);
-     * ```
-     */
-    getTotalVanaStaked(entityId?: bigint): Promise<bigint>;
-    /**
-     * Gets information about a specific staking entity.
-     *
-     * @param entityId - The ID of the entity to query
-     * @returns The entity information including name, APY, shares, and reward pools
-     *
-     * @example
-     * ```typescript
-     * const entity = await vana.staking.getEntity(1n);
-     * console.log(`Entity: ${entity.name}`);
-     * console.log(`Total shares: ${entity.totalShares}`);
-     * console.log(`Max APY: ${Number(entity.maxAPY) / 100}%`);
-     * ```
-     */
-    getEntity(entityId: bigint): Promise<EntityInfo>;
-    /**
-     * Gets the total number of staking entities in the protocol.
-     *
-     * @returns The count of entities
-     *
-     * @example
-     * ```typescript
-     * const count = await vana.staking.getEntitiesCount();
-     * console.log(`Total entities: ${count}`);
-     * ```
-     */
-    getEntitiesCount(): Promise<bigint>;
-    /**
-     * Gets the IDs of all active staking entities.
-     *
-     * @returns Array of active entity IDs
-     *
-     * @example
-     * ```typescript
-     * const activeIds = await vana.staking.getActiveEntities();
-     * console.log(`Active entities: ${activeIds.join(', ')}`);
-     * ```
-     */
-    getActiveEntities(): Promise<readonly bigint[]>;
-    /**
-     * Gets a staker's position in a specific entity.
-     *
-     * @param staker - The address of the staker
-     * @param entityId - The ID of the entity
-     * @returns The staker's position information
-     *
-     * @example
-     * ```typescript
-     * const position = await vana.staking.getStakerPosition(
-     *   '0x742d35...',
-     *   1n
-     * );
-     * console.log(`Shares: ${position.shares}`);
-     * console.log(`Rewards: ${position.realizedRewards}`);
-     * ```
-     */
-    getStakerPosition(staker: Address, entityId: bigint): Promise<StakerEntityInfo>;
-    /**
-     * Gets the earned rewards for a staker in an entity.
-     *
-     * @param staker - The address of the staker
-     * @param entityId - The ID of the entity
-     * @returns The earned rewards amount in wei
-     *
-     * @example
-     * ```typescript
-     * const rewards = await vana.staking.getEarnedRewards(
-     *   '0x742d35...',
-     *   1n
-     * );
-     * console.log(`Earned: ${Number(rewards) / 1e18} VANA`);
-     * ```
-     */
-    getEarnedRewards(staker: Address, entityId: bigint): Promise<bigint>;
-    /**
-     * Gets the minimum stake amount required to stake.
-     *
-     * @returns The minimum stake amount in wei
-     *
-     * @example
-     * ```typescript
-     * const minStake = await vana.staking.getMinStakeAmount();
-     * console.log(`Minimum stake: ${Number(minStake) / 1e18} VANA`);
-     * ```
-     */
-    getMinStakeAmount(): Promise<bigint>;
-    /**
-     * Gets the count of active stakers in the protocol.
-     *
-     * @returns The number of active stakers
-     *
-     * @example
-     * ```typescript
-     * const count = await vana.staking.getActiveStakersCount();
-     * console.log(`Active stakers: ${count}`);
-     * ```
-     */
-    getActiveStakersCount(): Promise<bigint>;
-    /**
-     * Gets the bonding period for staking.
-     *
-     * @returns The bonding period in seconds
-     *
-     * @example
-     * ```typescript
-     * const bondingPeriod = await vana.staking.getBondingPeriod();
-     * console.log(`Bonding period: ${bondingPeriod / 86400n} days`);
-     * ```
-     */
-    getBondingPeriod(): Promise<bigint>;
-    /**
-     * Gets the total distributed rewards for a specific entity from the contract.
-     *
-     * @remarks
-     * This reads the `totalDistributedRewards` field from the entity's on-chain state.
-     * This value represents the sum of all rewards that have been processed
-     * (moved from lockedRewardPool to activeRewardPool) minus any forfeited
-     * rewards that were returned.
-     *
-     * @param entityId - The ID of the entity to query
-     * @returns The total distributed rewards in wei
-     *
-     * @example
-     * ```typescript
-     * const totalRewards = await vana.staking.getTotalDistributedRewards(1n);
-     * const totalRewardsVana = Number(totalRewards) / 1e18;
-     * console.log(`Total distributed rewards: ${totalRewardsVana.toLocaleString()} VANA`);
-     * ```
-     */
-    getTotalDistributedRewards(entityId: bigint): Promise<bigint>;
-    /**
-     * Gets a comprehensive staking summary for a staker in an entity.
-     *
-     * @remarks
-     * This method aggregates all relevant staking information for a staker in a single call,
-     * including staked amount, current value, bonding status, and all reward types.
-     *
-     * Reward breakdown:
-     * - `earnedRewards` = pendingInterest + vestedRewards + realizedRewards
-     * - `pendingInterest` = currentValue - costBasis (unvested appreciation)
-     * - `vestedRewards` = rewards that have vested but not yet withdrawn
-     * - `realizedRewards` = rewards already withdrawn during unstakes
-     *
-     * @param staker - The address of the staker
-     * @param entityId - The ID of the entity
-     * @returns A comprehensive summary of the staker's position
-     *
-     * @example
-     * ```typescript
-     * const summary = await vana.staking.getStakerSummary('0x742d35...', 1n);
-     * console.log(`Total staked: ${Number(summary.totalStaked) / 1e18} VANA`);
-     * console.log(`Current value: ${Number(summary.currentValue) / 1e18} VANA`);
-     * console.log(`In bonding period: ${summary.isInBondingPeriod}`);
-     * console.log(`Remaining bonding time: ${Number(summary.remainingBondingTime) / 86400} days`);
-     * console.log(`Vested rewards: ${Number(summary.vestedRewards) / 1e18} VANA`);
-     * console.log(`Unvested rewards: ${Number(summary.unvestedRewards) / 1e18} VANA`);
-     * console.log(`Realized rewards: ${Number(summary.realizedRewards) / 1e18} VANA`);
-     * console.log(`Total earned: ${Number(summary.earnedRewards) / 1e18} VANA`);
-     * ```
-     */
-    getStakerSummary(staker: Address, entityId: bigint): Promise<StakerEntitySummary>;
-    /**
-     * Stakes VANA to an entity in the VanaPool protocol.
-     *
-     * @remarks
-     * This method stakes native VANA tokens to a specified entity. The staker will receive
-     * shares in proportion to their stake amount. A bonding period applies during which
-     * rewards cannot be fully claimed without penalty.
-     *
-     * Requires a wallet client to be configured in the Vana constructor.
-     *
-     * @param params - The staking parameters
-     * @param params.entityId - The ID of the entity to stake to
-     * @param params.amount - The amount of VANA to stake (in wei, or as a string like "1.5" for 1.5 VANA)
-     * @param params.recipient - Optional recipient address for the shares (defaults to the sender)
-     * @param params.minShares - Optional minimum shares to receive (slippage protection, defaults to 0)
-     * @returns The transaction hash
-     * @throws {BlockchainError} When wallet client is not configured
-     *
-     * @example
-     * ```typescript
-     * // Stake 100 VANA to entity 1
-     * const txHash = await vana.staking.stake({
-     *   entityId: 1n,
-     *   amount: "100", // 100 VANA
-     * });
-     * console.log(`Staked! Transaction: ${txHash}`);
-     *
-     * // Stake with slippage protection
-     * const txHash2 = await vana.staking.stake({
-     *   entityId: 1n,
-     *   amount: parseEther("50"), // 50 VANA in wei
-     *   minShares: parseEther("49"), // Expect at least 49 shares
-     * });
-     * ```
-     */
-    stake(params: {
-        entityId: bigint;
-        amount: bigint | string;
-        recipient?: Address;
-        minShares?: bigint;
-    }, options?: TransactionOptions): Promise<Hash>;
-    /**
-     * Gets the maximum amount of VANA that can be unstaked in a single transaction.
-     *
-     * @remarks
-     * This calls the contract's getMaxUnstakeAmount which returns the minimum of:
-     * 1. The withdrawable VANA (costBasis if in bonding period, shareValue if eligible)
-     * 2. The entity's activeRewardPool (what the entity has available)
-     * 3. The treasury balance (what can be paid out)
-     *
-     * The limiting factor indicates what's constraining the unstake:
-     * - 0 = user shares/costBasis
-     * - 1 = activeRewardPool
-     * - 2 = treasury
-     *
-     * @param staker - The address of the staker
-     * @param entityId - The ID of the entity
-     * @returns Object containing maxVana, maxShares, limitingFactor, and isInBondingPeriod
-     *
-     * @example
-     * ```typescript
-     * const result = await vana.staking.getMaxUnstakeAmount('0x742d35...', 1n);
-     * console.log(`Max unstake: ${Number(result.maxVana) / 1e18} VANA`);
-     * console.log(`Max shares: ${result.maxShares}`);
-     * console.log(`In bonding period: ${result.isInBondingPeriod}`);
-     * ```
-     */
-    getMaxUnstakeAmount(staker: Address, entityId: bigint): Promise<{
-        maxVana: bigint;
-        maxShares: bigint;
-        limitingFactor: number;
-        isInBondingPeriod: boolean;
-    }>;
-    /**
-     * Computes the new bonding period end timestamp after adding stake.
-     *
-     * @remarks
-     * When a staker adds more stake to an existing position, the reward eligibility timestamp
-     * is recalculated as a weighted average of the existing and new positions. This function
-     * allows you to preview what the new eligibility timestamp would be without executing
-     * the stake transaction.
-     *
-     * The formula used (matching the contract):
-     * ```
-     * newEligibility = (existingShares * existingEligibility + newShares * newEligibility) / totalShares
-     * ```
-     *
-     * Where `newEligibility` for the incoming stake is `currentTimestamp + bondingPeriod`.
-     *
-     * @param params - The parameters for computing the new bonding period
-     * @param params.staker - The address of the staker
-     * @param params.entityId - The ID of the entity
-     * @param params.stakeAmount - The amount of VANA to stake (in wei)
-     * @returns Object containing the new eligibility timestamp and related info
-     *
-     * @example
-     * ```typescript
-     * // Preview bonding period after staking 100 VANA
-     * const preview = await vana.staking.computeNewBondingPeriod({
-     *   staker: '0x742d35...',
-     *   entityId: 1n,
-     *   stakeAmount: parseEther("100"),
-     * });
-     * console.log(`New eligibility: ${new Date(Number(preview.newEligibilityTimestamp) * 1000)}`);
-     * console.log(`Remaining bonding time: ${Number(preview.newRemainingBondingTime) / 86400} days`);
-     * ```
-     */
-    computeNewBondingPeriod(params: {
-        staker: Address;
-        entityId: bigint;
-        stakeAmount: bigint;
-    }): Promise<{
-        /** The new reward eligibility timestamp after staking */
-        newEligibilityTimestamp: bigint;
-        /** Remaining bonding time in seconds after staking */
-        newRemainingBondingTime: bigint;
-        /** Current eligibility timestamp (before staking) */
-        currentEligibilityTimestamp: bigint;
-        /** Current remaining bonding time (before staking) */
-        currentRemainingBondingTime: bigint;
-        /** Current shares held by staker */
-        currentShares: bigint;
-        /** Estimated new shares to be received */
-        estimatedNewShares: bigint;
-        /** Total shares after staking */
-        totalSharesAfter: bigint;
-        /** The bonding period duration in seconds */
-        bondingPeriodDuration: bigint;
-        /** Current block timestamp used for calculation */
-        currentTimestamp: bigint;
-    }>;
-    /**
-     * Unstakes VANA from an entity in the VanaPool protocol.
-     *
-     * @remarks
-     * This method unstakes native VANA tokens from a specified entity. The amount
-     * that can be unstaked depends on whether the staker is in the bonding period:
-     *
-     * - **During bonding period**: Only cost basis can be withdrawn; rewards are forfeited
-     * - **After bonding period**: Full current value (cost basis + rewards) can be withdrawn
-     *
-     * Use `getMaxUnstakeAmount` to determine the maximum amount that can be unstaked.
-     *
-     * Requires a wallet client to be configured in the Vana constructor.
-     *
-     * @param params - The unstaking parameters
-     * @param params.entityId - The ID of the entity to unstake from
-     * @param params.amount - The amount of VANA to unstake (in wei, or as a string like "1.5" for 1.5 VANA)
-     * @param params.maxShares - Maximum shares to burn for slippage protection (defaults to 0, no protection)
-     * @returns The transaction hash
-     * @throws {BlockchainError} When wallet client is not configured
-     *
-     * @example
-     * ```typescript
-     * // Get max unstake amount first
-     * const maxUnstake = await vana.staking.getMaxUnstakeAmount(address, 1n);
-     *
-     * // Unstake the maximum amount with slippage protection
-     * const txHash = await vana.staking.unstake({
-     *   entityId: 1n,
-     *   amount: maxUnstake.maxVana,
-     *   maxShares: maxUnstake.maxShares,
-     * });
-     * console.log(`Unstaked! Transaction: ${txHash}`);
-     * ```
-     */
-    unstake(params: {
-        entityId: bigint;
-        amount: bigint | string;
-        maxShares?: bigint;
-    }, options?: TransactionOptions): Promise<Hash>;
-}