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 2 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
23 changes: 23 additions & 0 deletions pallets/creator-staking/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Creator Staking Pallet

The Subsocial Creator Staking Pallet is a critical component of the Subsocial content creation ecosystem. It provides features for tracking staking information for creators by era, storing general info about total staking amounts per era, and managing the economic interactions between creators and their supporters.

olehmell marked this conversation as resolved.
Show resolved Hide resolved
## Features

- **Staking Information**: The pallet tracks staking information for creators by era, allowing users to stake funds to their favorite creators.
olehmell marked this conversation as resolved.
Show resolved Hide resolved

- **Unstaking and Withdrawal**: Users can start the unstaking process, and once the unstaking period has passed, they can withdraw their staked funds.
olehmell marked this conversation as resolved.
Show resolved Hide resolved

- **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). Feel free to use, modify, and distribute it as needed.
olehmell marked this conversation as resolved.
Show resolved Hide resolved

## 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).

## Support and Contact

If you have any questions or need support, please don't hesitate to [open an issue](https://github.com/dappforce/subsocial-parachain/issues).
olehmell marked this conversation as resolved.
Show resolved Hide resolved