Simulate route-aware Bitcoin Staking yield
simulate_yieldCompute Bitcoin staking returns on Stacks with route-aware economics and complete duration, rate, and fee inputs. Optional live prices enrich results.
Instructions
Calculate deterministic route-aware economics only when duration, rate, and all applicable route or LST fees are complete; optional CoinGecko prices enrich the result.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bondId | Yes | ||
| feeBps | No | ||
| routeId | No | ||
| lstFeeBps | No | ||
| includeLst | No | ||
| btcPriceUsd | No | ||
| durationDays | No | ||
| principalBtc | No | ||
| annualRateBps | No | ||
| principalSats | No | ||
| stxPriceScenariosUsd | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bondId | Yes | ||
| feeBps | Yes | ||
| feeSats | No | ||
| routeId | Yes | ||
| sources | Yes | ||
| lstFeeBps | Yes | ||
| dataStatus | Yes | ||
| lstFeeSats | No | ||
| verifiedAt | Yes | ||
| assumptions | Yes | ||
| rewardAsset | Yes | ||
| routeFeeBps | Yes | ||
| availability | Yes | ||
| durationDays | Yes | ||
| modelContext | Yes | ||
| netRewardBtc | No | ||
| principalBtc | Yes | ||
| routeFeeSats | No | ||
| annualRateBps | Yes | ||
| netRewardSats | No | ||
| priceSnapshot | Yes | ||
| principalSats | Yes | ||
| grossRewardBtc | Yes | ||
| priceScenarios | Yes | ||
| grossRewardSats | Yes | ||
| inputDataStatus | Yes | ||
| netRewardDisplay | No | ||
| projectionPeriod | Yes | ||
| netRewardBtcExact | No | ||
| grossRewardDisplay | No | ||
| grossRewardBtcExact | No | ||
| pairedStxRequirement | Yes | ||
| estimatedRewardValueUsd | Yes |