Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README for creator staking pallet #240

Merged
merged 3 commits into from
Nov 6, 2023
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
20 changes: 20 additions & 0 deletions pallets/creator-staking/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Creator Staking Pallet

The Creator Staking pallet enables SUB token holders to support their favorite content creators, communities, and application builders by staking SUB tokens. Both parties (SUB stakers and creators) earn rewards based on the inflation of the SUB token.

## Features

- **Staking Information**: The pallet tracks staking information for creators by era, allowing backers to stake funds to their favorite creators.

- **Unstaking and Withdrawal**: Backers can start the unstaking process, and once the unstaking period has passed, they can withdraw their staked funds.

- **Reward Distribution**: The pallet calculates and distributes rewards for backers and creators on a periodic basis (e.g., per era), incentivizing participation in the ecosystem.

## License

This Subsocial Staking Pallet is open-source software released under the [GNU GPL3 License](LICENSE).

## Acknowledgements

Special thanks to [Astar Network](https://github.com/AstarNetwork) for their [Pallet dapps-staking](https://github.com/AstarNetwork/astar-frame/tree/polkadot-v0.9.39/frame/dapps-staking).