The PropsProtocol contract is the single entry point for regular users to interact with the Props protocol. All protocol actions of regular users must go through the PropsProtocol contract which will, in turn, perform corresponding actions on other involved contracts that users should not (and cannot) directly interact with.
Moreover, the PropsProtocol contract is the owner and coordinator of most of the contracts involved in the Props protocol:
- it controls the rProps token contract, being responsible for initiating the rProps rewards distribution and withdrawal and for swapping rProps tokens for regular Props tokens
- it controls the sProps token contract, coordinating the minting and burning of sProps on each staking action
- it owns all staking contracts, being responsible for performing staking-related operations on all individual staking contracts and for making sure the staked amounts across all these staking contracts are always consistent
As mentioned above, the PropsProtocol contract handles minting and burning of sProps, the ERC20 governance token of the Props protocol. sProps tokens are in a 1:1 mapping with staked Props tokens (that is, for each staked Props token a corresponding sProps token will get minted, while for each withdrawn Props token a corresponding sProps token will get burned). sProps are not transferrable between users and they represent voting power in Props' governance process.
As an escape hatch for possible bugs, the PropsProtocol contract is pausable. Pausing it would simply forbid all user actions. The ability to pause and unpause the contract is given to a special address denoted as the Props guardian (however, the protocol controller is also able to pause the contract). Ideally, the Props guardian is a multi-sig of a few trusted addresses that, in case of bugs, can pause the contract until an upgrade that fixes the bug goes through the governance process.
Stake on behalf of a given account. The sender provides the funds and the apps to stake to together with the amount to stake to each app, but the stakes will get associated with the requested account.
function stakeOnBehalf(
address[] _apps,
uint256[] _amounts,
address _account
)Adjust the stake amounts to the given apps. Positive stake amounts correspond to an increase in the amount staked to a particular app while negative amounts correspond to a decrease in the staked amount.
function stake(address[] _apps, int256[] _amounts)Similar to regular stake, but the stakes are to be retrieved from the user's escrowed rewards instead of their wallet. User Props rewards are escrowed, meaning that once claimed they get locked for a known amount of time. However, these locked Props rewards can be separately staked in order to gain additional rewards.
function stakeRewards(address[] _apps, int256[] _amounts)Reallocate existing stakes. This action can only be used to reallocate existing stakes to certain apps - no additional stake can be introduced or existing stake get withdrawn.
function reallocateStakes(address[] _apps, int256[] _reallocations)Delegated stakes reallocation. Readjust existing stake on behalf of an account that explicitly delegated its staking rights. As for the direct stakes reallocation action, the delegatee cannot introduce new stake or remove existing stake on behalf of the delegator.
function reallocateStakesAsDelegate(
address[] _apps,
int256[] _reallocations,
address _account
)Unstake principal and/or rewards. This action is used to unstake (principal and/or rewards) from certain apps. The amount of principal versus rewards to get unstaked is controlled via the _principalAmount parameter, which is used to specify the amount of total principal to get unstaked as part of this action - the remaining amount will be unstaked from the user's staked rewards pool.
function unstake(
address[] _apps,
uint256[] _amounts,
uint256 _principalAmount
)Allow users to claim their AppPoints rewards from any given apps. The claimed AppPoints tokens will get transferred from the AppPoints staking contract to the user's wallet.
function claimAppPointsRewards(address[] _app)Allow app owners to claim the Props rewards of their apps. The claimed Props rewards will get transferred from the app Props staking contract to the specified wallet address.
function claimAppPropsRewards(address _app, address _wallet)Allow app owners to claim and directly stake the Props rewards of their apps. All claimed rewards will get staked to the current app.
function claimAppPropsRewardsAndStake(address _app)Allow users to claim their Props rewards. These Props rewards will get into the user's escrowed rewards pool. This action will also reset the cooldown period of the escrow.
function claimUserPropsRewards()Allow users to claim their Props rewards and directly stake them to apps, without having the rewards escrow cooldown get reset. All claimed rewards will get staked to the given apps, according to the given percentages.
function claimUserPropsRewardsAndStake(
address[] _apps,
uint256[] _percentages
)Claim and directly stake the Props rewards on behalf of a delegator account.
function claimUserPropsRewardsAndStakeAsDelegate(
address[] _apps,
uint256[] _percentages,
address _account
)Allow users to unlock their escrowed rewards, if the cooldown period passed. This action will transfer the Props rewards from the escrow to the user's wallet.
function unlockUserPropsRewards()Helper function that aggregates unstaking and claiming (both user Props rewards and app points rewards).
function unstakeAndClaim(
address[] _unstakeApps,
uint256[] _unstakeAmounts,
uint256 _unstakePrincipalAmount,
address[] _claimApps
)With delegation, accounts can outsource the following actions: reallocate existing stakes, claim and directly stake user Props rewards.
function delegate(address _to)Pause the contract.
function pause()Unpause the contract.
function unpause()Update the set of whitelisted apps. Users can only stake to whitelisted apps. By default, any newly deployed app is blacklisted. Although staking to blacklisted apps is forbidden, withdrawing and claiming are still available.
function updateAppWhitelist(address _app, bool _status)Distribute the Props rewards to the app and user Props staking contracts. This will trigger the distribution method of the rProps token, which PropsProtocol owns.
function distributePropsRewards(
uint256 _amount,
uint256 _appRewardsPercentage,
uint256 _userRewardsPercentage
)Withdraw not yet distributed Props rewards from the app and user Props staking contracts. This action should only be performed in case of the protocol migrating to a new L2.
function withdrawPropsRewards(uint256 _appRewardsAmount, uint256 _userRewardsAmount)