Skip to content

Position.md

Latest commit

 

History

History
75 lines (42 loc) · 3.27 KB

Position.md

File metadata and controls

75 lines (42 loc) · 3.27 KB
Raw

Position

Properties

Name Type Description Notes
id string The unique identifier of the staking position [default to undefined]
vaultAccountId string The source vault account to stake from [default to undefined]
validatorName string The destination validator address name [default to undefined]
providerName string The destination validator provider name [default to undefined]
chainDescriptor string The protocol identifier (e.g. "ETH"/ "SOL") to use [default to undefined]
amount string Total value of the staking position. For Solana, Lido and Ethereum (compounding validator): includes the original stake plus accumulated rewards. For MATIC, Cosmos and Ethereum (legacy validator): refers to the amount currently staked. [default to undefined]
rewardsAmount string The amount staked in the position, measured in the staked asset unit. Returned as null for chains where reward tracking is not supported (Cosmos-family chains), instead of a numeric value. [default to undefined]
dateCreated string When was the request made (ISO Date). [default to undefined]
dateUpdated string When has the position last changed (ISO Date). [default to undefined]
status string The current status. [default to undefined]
validatorAddress string The destination address of the staking transaction. [default to undefined]
providerId StakingProvider [default to undefined]
availableActions Array<string> An array of available actions that can be performed. for example, actions like &quot;UNSTAKE&quot; or &quot;WITHDRAW&quot;. [default to undefined]
inProgress boolean Indicates whether there is an ongoing action for this position related to this request [default to undefined]
blockchainPositionInfo DelegationBlockchainPositionInfo [default to undefined]
inProgressTxId string The transaction ID of the initial stake position request only. Only present when there is an active initial stake transaction. [optional] [default to undefined]

Enum: PositionStatusEnum

  • Creating (value: 'CREATING')

  • Pending (value: 'PENDING')

  • Activating (value: 'ACTIVATING')

  • Active (value: 'ACTIVE')

  • Deactivating (value: 'DEACTIVATING')

  • Deactivated (value: 'DEACTIVATED')

  • Withdrawing (value: 'WITHDRAWING')

  • Withdrawn (value: 'WITHDRAWN')

  • Merged (value: 'MERGED')

  • Consolidated (value: 'CONSOLIDATED')

  • Canceled (value: 'CANCELED')

  • Failed (value: 'FAILED')

Enum: Array<PositionAvailableActionsEnum>

  • Unstake (value: 'UNSTAKE')

  • Withdraw (value: 'WITHDRAW')

  • AddToStake (value: 'ADD_TO_STAKE')

  • Split (value: 'SPLIT')

  • Merge (value: 'MERGE')

  • ClaimRewards (value: 'CLAIM_REWARDS')

  • Consolidate (value: 'CONSOLIDATE')

[Back to top] [Back to API list] [Back to Model list] [Back to README]