Staking Contract

A staking contract that allows the user to set their own apy.

Table of contents

• Table of contents
  • About the website
  • Technical
    • Technology Used
    • Running the project
      • Backend
    • CONTRIBUTING
  • License
  • Versions
  • Contact Info

About the website

A staking contract that allows the user to set their own apy.

Technical

Technology Used

This project uses: Truffle

• Truffle version v5.5.11
• OpenZeppelin library version latest
• Node v16.16.0
• Npm 8.15.1

Running the project

Backend

Openzeppelin needs to be installed. This can be done on the root of the project by running:

npm install @openzeppelin/contracts

To run the truffle development enviroment, run:

truffle develop

To compile the smart contract, within the truffle development environment, run:

compile

To migrate and create a fresh and clean smart contract session, within the truffle development environment, run:

migrate --refresh

To run the test cases within the truffle development environment, run:

test

CONTRIBUTING

I would/ We'd love to have your help in making staking-contract better. The project is still very incomplete, but if there's an issue you'd like to see addressed sooner rather than later, let me(/us) know.

Before you contribute though read the contributing guide here: Contributing.md

For any concerns, please open an issue, or JUST, fork the project and send a pull request.

---

License

• see LICENSE file

Versions

• Version 1.0 DATE 24/01/2023

Contact Info

If you have found any bugs, or have any feedback or questions and or want to post a feature request please use the Issuetracker to report them.

---