1 Activity

1.1 Introduction

Activities play a pivotal role in our platform, representing a diverse range of user-initiated actions within the staking ecosystem. Whether you're staking, unstaking, claiming rewards, or performing withdrawals, activities enable seamless engagement with our protocol. In response to these actions, our platform generates appropriate responses to ensure a transparent and user-centric experience.

1.2 Activity Overview

Activity drives various user interactions, categorized into two main types:

• Raw Transaction for User Action

Certain actions, such as staking, involve the generation of raw transactions that users can independently sign and broadcast. This approach empowers users to take control of the transaction process using their wallets. By providing the raw transaction, we facilitate a decentralized and secure execution of user-initiated actions.

• User-Signed Message for Platform Action

In scenarios like Ethereum unstaking, users sign messages that our platform subsequently processes. Utilizing the validator information we possess, we execute the specified unstaking action on the user's behalf after validating the signed message. This streamlines the unstaking process while maintaining the highest standards of security.

1.3 Activity Data Fields

Activity is characterized by a set of essential fields that provide crucial insights into user interactions and their outcomes:

• id: The unique identifier assigned to each activity.
• protocol: The name of the protocol associated with the activity.
• wallet: The user's wallet address linked to the activity.
• activity_status: The status of the activity, which can be one of three values:
  • pending: The activity is being processed.
  • completed: The activity has been successfully processed.
  • failed: The activity failed to be processed.
• action: The type of action associated with the activity, with examples including "stake" and "unstake." Actions may vary based on the protocol; for instance, Ethereum supports additional actions like "claim."
• amount: The amount associated with the action. The meaning of the amount varies based on the action and protocol. For staking, the amount represents the stake size, using the largest unit in the respective protocol (e.g., ETH in Ethereum, SUI in Sui).
• raw_tx: This field contains the raw transaction generated based on the activity details. Users can use this information to sign and broadcast the transaction, ensuring the secure execution of actions.
• timestamp: The Unix timestamp representing the time when the activity was generated.

2 Asset

2.1 Introduction

When users engage in staking activities with a validator, our platform generates an "asset" to provide users with consolidated insights into their staking-related information. This document outlines the details and fields that constitute an asset, offering you a comprehensive understanding of how to manage your staked assets effectively.

2.2 Asset Overview

An asset represents a user's stake within our platform. It serves as a repository of key staking-related data, enabling users to track their staking progress, rewards, and other important metrics.

2.3 Asset Data Fields

An asset comprises several fields that encompass various aspects of a user's staking experience:

• id: A unique identifier assigned to each asset.
• protocol: The name of the protocol associated with the asset.
• wallet: The user's wallet address linked to the asset.
• validator: The address of the validator to which the asset is associated.
• active_stake: The effective stake amount within the asset.
• total_reward: The sum of received rewards and claimable rewards.
• received_reward: This field encompasses two primary types of rewards:
  • claim: Rewards that users manually claim through our platform.
  • distribute: Rewards that certain protocols automatically distribute directly to the user's wallet. Depending on the protocol, users may earn extra rewards, such as Ethereum users receiving MEV rewards for enabling MEV.
• claimable_reward: The amount of reward that users can claim. The process for claiming rewards may differ based on the protocol. For example, Ethereum users need to manually initiate the claim action, while SUI users automatically claim rewards when unstaking.
• last_action_time: The timestamp of the user's last action, including stake, unstake, claim, and more.
• pending_stake: Some protocols require a waiting period for the stake amount to become effective. During this time, the staked amount resides in the pending stake field.
• unstaking: The sum of the amounts in the unstaking_in_progress and unstaking_withdrawable fields.
• unstaking_in_progress: This field represents the amount after a user has initiated an unstake but the funds have not yet settled in the user's wallet
• unstaking_withdrawable: The fund that is waiting for the user to initiate withdrawal to their wallet. This usually requires the user to create a withdrawal action within our platform.

3 History

3.1 Introduction

In our platform, historical data plays a crucial role in providing users with a comprehensive view of their staking activities. All historical data is sourced directly from on-chain records, ensuring the utmost accuracy and transparency. This documentation outlines the details and fields that constitute our historical data, allowing you to navigate and understand your staking journey effectively.

All historical data within our platform is derived from on-chain sources, ensuring the reliability and precision of the information presented. We regularly query the latest on-chain data to provide users with up-to-date insights into their staking activities. Many historical activities are associated with corresponding transaction hashes, enabling users to explore the granular details of each action.

3.2 History Overview

History includes the historical data of stake, unstake, and received reward.

3.3 History Data Fields

Our historical data includes several essential fields that provide insights into past staking activities:

• amount: The amount associated with the action. The meaning of the amount varies based on the action and protocol. For example, if the action is "stake," the amount represents the stake size, using the largest unit in the respective protocol (e.g., 32 ETH in Ethereum).
• wallet: The user's wallet address linked to the historical activity.
• validator: The address of the validator associated with the historical action.
• tx_hash: The transaction hash that corresponds to the historical activity, enabling users to access detailed transaction information on the blockchain.
• action: The type of action associated with the historical data. Common actions include "stake," "unstake," "claim," and "distribute."
• timestamp: The timestamp in Unix format, representing the time when the historical activity occurred.
• tx_status: The status of the transaction associated with the historical activity, which can be one of three values:
  • pending: The transaction is in progress or pending confirmation.
  • completed: The transaction has been successfully completed.
  • failed: The transaction failed to be executed.