Skip to content

Commit 78a065a

Browse files
authored
Update handleAction documentation in docs
1 parent 182a5f1 commit 78a065a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/rewards/rewards-controller.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `RewardsDistributor` abstract contract manages the distribution and accounta
1212

1313
## Rewards Controller
1414

15-
The Rewards Controller is the main contract and where the user interacts to claim the rewards of their positions. It inherits `RewardsDistributor` to handle the distribution of rewards. The users of the incentivised ERC20 assets will accrue value if they hold their tokens in possession without the need of staking or blocking the assets inside a contract. At every transfer the asset must call the `handleAction` method to account the rewards of the user.
15+
The Rewards Controller is the main contract and where the user interacts to claim the rewards of their positions. It inherits `RewardsDistributor` to handle the distribution of rewards. The users of the incentivised ERC20 assets will accrue value if they hold their tokens in possession without the need of staking or blocking the assets inside a contract. At every transfer the asset must call the `handleAction` method to account for the accumulated rewards of the user prior to balance change.
1616

1717
The users can claim all the rewards or an individual reward per transaction, with a variety of functions that allow more granularity at claim.
1818

@@ -155,19 +155,19 @@ The `RewardsDistributorTypes.RewardsConfigInput` struct is composed with the fol
155155

156156
## handleAction
157157

158-
Called by the corresponding asset on transfer hook to update the rewards distribution of an user.
158+
Called by the corresponding asset on transfer hook in order to update the rewards distribution.
159159

160160
### Interface
161161

162162
`function handleAction(address user, uint256 userBalance, uint256 totalSupply) external;`
163163

164164
### Input parameters
165165

166-
| Parameter Name | Type | Description |
167-
| -------------- | ------- | ----------------------------- |
168-
| user | address | The address of the user |
169-
| userBalance | uint256 | The user balance of the asset |
170-
| totalSupply | uint256 | The total supply of the asset |
166+
| Parameter Name | Type | Description |
167+
| -------------- | ------- | ---------------------------------------------------------- |
168+
| user | address | The address of the user whose asset balance has changed |
169+
| userBalance | uint256 | The previous user balance prior to balance change |
170+
| totalSupply | uint256 | The total supply of the asset prior to user balance change |
171171

172172
## claimRewards
173173

0 commit comments

Comments
 (0)