Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 29 additions & 12 deletions frame/crowdloan-rewards/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# Crowdloan Rewards

This pallet allow contributors to claim their rewards.
The Crowdloan Rewards pallet allows contributors to claim their rewards.

A % of the reward is paid at the first claim, and the remaining % is vested over an arbitrary period splitted in windows `VestingPartition`.
## Rewards

Rewards are claiming using the following scheme.
A percentage of the reward is paid at the first claim, and the remaining
percentage is vested over an arbitrary period of time split into
`VestingPartition`s.

1. An `AdminOrigin` setup the reward accounts, consisting of a vector of triple (PublicKey, Amount, VestingPeriod)
The PublicKey is either comming from the relay chain (Kusama in this case) or from ETH.
2. Since the users don't own any funds on Picasso, the first claim has to be made using our service so that we sign the `associate` transaction using Composable `AssociationOrigin`.
The first claim result in the Picasso account being associated with the reward account.
Also, this association automatically trigger a claim, resulting in the first payment done (fixed % if first claim, vested amount otherwise) to the newly associated Picasso account.
3. Once the first claim has been made, the user has to wait until the next `VestingPartition` (probably 1 week).
After having waited for the vesting partition. The user is able to either `associate` a new account or directly `claim` using it's already associated Picasso account.
This can be repeated until the contributor has claimed all its reward.
Rewards are claimed using the following steps:

Note: both `associate` and `claim` calls are not charging fees if successful.
1. An `AdminOrigin` sets up the reward accounts, consisting of a vector of
(PublicKey, Amount, VestingPeriod).
The PublicKey is either comming from the relay chain (Kusama in this case) or
from ETH.

2. Since the users don't own any funds on Picasso, the first claim has to be
made using our service so that we sign the `associate` transaction using
Composable's `AssociationOrigin`.
The first claim results in the Picasso account being associated with the
reward account. This association automatically triggers a claim, the claim
results in the first payment being distributed to the newly associated
Picasso account.

3. Once the first claim has been made, the user has to wait until the next
`VestingPartition`.
After having waited for the vesting partition. The user is able to either
`associate` a new account or directly `claim` using their already associated
Picasso account.
This can be repeated until the contributor has claimed all of their reward.

## Notes

* both `associate` and `claim` calls do not charge fees if successful.