For the complete documentation index, see llms.txt. This page is also available as Markdown.

Staking Reward Simulators

Implementation Details

Class Names

Model Name
Parameters Class
Data Class

StakingRewardSimulators

StakingRewardsQueryParams

StakingRewardsData

Import Statement

pythonCopyEditfrom satoshi_terminal.models.staking_reward_simulators import (
    StakingRewardSimulators,
    StakingRewardsQueryParams,
    StakingRewardsData,
)

Parameters

Name
Type
Description
Default
Optional

staking_protocol

str

Name of the staking protocol (e.g., Lido, Rocket Pool).

None

False

staked_amount

float

Amount of tokens to simulate staking rewards for.

None

False

reward_time_horizon

int

Time horizon (in days) for reward simulations.

30

True


Data

Name
Type
Description

staking_protocol

str

Name of the staking protocol analyzed.

estimated_rewards

float

Projected staking rewards over the specified time horizon.

annual_yield

float

Annual percentage yield (APY) for the protocol.

protocol_risk_score

float

Risk score (0-100) for the staking protocol.

timestamp

datetime

Timestamp of the simulation.


Key Features

  • Reward Projections: Provides accurate estimates of staking rewards based on user input.

  • APY Analysis: Highlights yield rates and compares them across protocols.

  • Risk Assessment Integration: Includes risk scores for staking protocols to aid decision-making.

Last updated