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

Create a Tutorial for Staking PEO Tokens Locally #5

Open
dkrizhanovskyi opened this issue Dec 11, 2024 · 0 comments
Open

Create a Tutorial for Staking PEO Tokens Locally #5

dkrizhanovskyi opened this issue Dec 11, 2024 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dkrizhanovskyi
Copy link
Member

What to Do:
We have code for staking PEO tokens, but no beginner-friendly tutorial. Write a step-by-step guide (as a Markdown file in docs/) showing how someone can:

  1. Deploy contracts locally with Hardhat.
  2. Mint PEO tokens to a test account.
  3. Approve and stake tokens.
  4. Check staking rewards.

Suggested Structure:

  • "Prerequisites" section (Node.js, npm, Hardhat).
  • "Setup" section (cloning repo, installing deps).
  • "Deploy & Stake" steps with example commands and expected outputs.
  • "Verifying Rewards" section.

Why This Matters:
A tutorial helps new contributors and users quickly understand how to interact with the staking contract, improving onboarding and reducing confusion.

Experience Level:
Beginner to intermediate. Basic familiarity with Hardhat and ERC-20 tokens helpful.

@dkrizhanovskyi dkrizhanovskyi added good first issue Good for newcomers help wanted Extra attention is needed labels Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant