Staked TRX

Introduction

Based on Stake 2.0, with TRX Liquid Staking, users can stake TRX to get sTRX tokens and gain high rewards. Compared to traditional staking, TRX Liquid Staking is easier to use and more profitable. Staked TRX will be used automatically for voting and governance, and gain rewards via Energy Rental. The contract StakedTRX used to set up the staked TRX service.

Query Interface

Exchange Rate

Query the exchange rate between sTRX and TRX.

function exchangeRate() public view returns (uint256)

• Parameter description: N/A;

• Returns: exchange rate, 1 sTRX / 1 TRX exchange rate, scaled by 1e18.

---

Total TRX Assets

Query the total TRX assets managed by contract.

function totalUnderlying() public view returns (uint256)

• Parameter description: N/A;

• Returns: the total assets of TRX managed by contract, the minimum unit.

---

User Balance in TRX

Query the amount of TRX corresponding to the sTRX held by user.

function balanceInTrx(address _account) public view returns (uint256)

• Parameter description:

  • _account: the user address.

• Returns: the amount of TRX corresponding to the sTRX held by user, the minimum unit.

---

Current Unfreezing Round

Query the current unfreezing round of the contract. The initial value is 1

function round() view external returns (uint256)

• Parameter description: N/A;

• Returns: current unfreezing round.

---

Claimable Amount in TRX

The amount of TRX that can be withdrawn after the unfreezing period has expired.

function claimable() external returns (uint256)

• Parameter description: N/A;

• Returns: the amount of TRX that can be claimed.

---

Withdrawal Amount in TRX

The amount of TRX being withdrawn. This value is increased when the user withdraws.

function withdrawal() external returns (uint256)

• Parameter description: N/A;

• Returns: the amount of TRX being withdrawn.

---

Unfreeze Balance in TRX

The total amount to be unfrozen. If the user withdraws but has not completed the round, it will enter the unfreezing queue.

function balanceToUnfreeze() external returns (uint256)

• Parameter description: N/A;

• Returns: the amount of TRX to be unfrozen, minimum unit.

---

Freeze Balance in TRX

The amount to be frozen. As long as the value is greater than 1 TRX, the freezing operation will be performed.

function balanceToFreeze() external returns (uint256)

• Parameter description: N/A;

• Returns: the amount of TRX to be frozen, minimum unit.

---

Write Interface

Deposit TRX

Deposit TRX assets and receive sTRX.

function deposit() external payable returns (uint256)

• Parameter description:

  • msg.value: the amount of TRX to deposit.

• Returns: the amount of sTRX received by user through exchange, the minimum unit.

📅 Event

Deposit(address user, uint256 trxAmount, uint256 strx, uint256 userHoldStrx)

• Emits when user successfully deposits TRX.

  • trxAmount: the amount of TRX user deposits;

  • strx: the amount of sTRX user gets;

  • userHoldStrx: the total amount of sTRX held by user after the deposit.

---

Withdraw sTRX

Specify the amount of sTRX to withdraw, the minimum unit.

function withdraw(uint256 tokenAmount) external returns (uint256)

• Parameter description:

  • tokenAmount: the amount of sTRX to withdraw.

• Returns: the amount of TRX to be unfrozen when user withdraws, the minimum unit.

📅 Event

Withdraw(address user, uint256 strx, uint256 trxAmount, uint256 userHoldStrx)

• Emits when user successfully withdraws sTRX.

  • strx: the amount of sTRX user withdraws;

  • trxAmount: the amount of TRX user gets;

  • userHoldStrx: the total amount of sTRX held by user after the withdrawal.

---

Withdraw sTRX (with the amount of TRX specified)

Specify the amount of TRX user hopes to obtain through withdrawal, the minimum unit.

function withdrawExact(uint256 trxAmount) external returns (uint256)

• Parameter description:

  • tokenAmount: the specific amount of sTRX to withdraw.

• Returns: the amount of sTRX withdrawn by user, the minimum unit.

---

Claim TRX

Claim the ready-to-be-withdrawn TRX unfrozen in the earliest round.

function claim() external returns (uint256)

• Parameter description: N/A;

• Returns: the amount of TRX claimed by user in the earliest unfreezing round, the minimum unit.

📅 Event

Claim(address user, uint256 trxAmount)

• Emits when user successfully claims TRX.

  • trxAmount: the amount of TRX user claims.

---

Claim all unfrozen TRX

Claim all ready-to-be-withdrawn, unfrozen TRX

function claimAll() external returns (uint256)

• Parameter description: N/A;

• Returns: the amount of TRX claimed by the user for all expired unfreezing rounds, the minimum unit.