Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 1.65 KB

stacking-claims.md

File metadata and controls

51 lines (30 loc) · 1.65 KB
description
CityCoin contract functions related to stacking claims.

Stacking Claims

Overview

After CityCoins are Stacked in the contract, Stackers are required to claim their rewards and unlocked CityCoins after a cycle ends.

Claiming rewards from Stacking CityCoins happens by calling the contract function claim-stacking-rewards.

Details

The payouts are based on the amount Stacked by the user R, the total STX reward that cycle S, and the total of all StackersTusing the formula:
STX Rewards = (R * S) / T

Contract Functions

API Ref: Stacking Claims

claim-stacking-reward

Type: Public Function

Input: targetCycle as uint

Success: (ok true)

Errors:

  • ERR_USER_ID_NOT_FOUND u1003
  • ERR_STACKING_NOT_AVAILABLE u1015
  • ERR_REWARD_CYCLE_NOT_COMPLETED u1017
  • ERR_NOTHING_TO_REDEEM u1018

Claiming Stacking rewards happens through calling the claim-stacking-reward function in the contract, which accepts a reward cycle and checks both the entitled STX reward from miners and the amount of CityCoins to return, then transfers them to the user.

get-stacking-reward

Type: Read-only Function

Input: userId as uint and targetCycle as uint

Returns: entitledStackingReward as uint, or default (u0)

Returns the amount of STX a user can claim in a given reward cycle in uSTX. This method will only return a positive value if:

  • the current block height is in a subsequent reward cycle
  • the Stacker locked up CityCoins in the target reward cycle
  • the Stacker locked up enough CityCoins to receive at least one uSTX