Welcome to the official repository for VAIOT's Single Asset Staking Smart Contract. This repository is dedicated to the development and maintenance of the staking contract using the Hardhat development environment, tailored for the Ethereum ecosystem.

Begin by cloning the repository and installing the necessary dependencies:

git clone https://github.com/VAIOT/single-asset-staking.git
cd single-asset-staking
npm install

To properly configure the project, create a .env file in the root directory and include the following required variables:

MUMBAI_RPC_URL= # RPC URL for the Mumbai testnet
GOERLI_RPC_URL= # RPC URL for the Goerli testnet
PRIVATE_KEY= # Private key for contract deployment
COINMARKETCAP_API_KEY= # CoinMarketCap API key
POLYGONSCAN_API_KEY= # PolygonScan API key
REPORT_GAS= # true or false
ETHERSCAN_API_KEY= # Etherscan API key

The StakingRewards contract allows users to stake ERC20 tokens and earn rewards. Key features include:

• Non-reentrancy for secure interactions.
• Adjustable staking and reward parameters.
• Automatic reward calculations based on the amount of users staking.
• Immediate or delayed withdrawal options with a fee or grace period, respectively.

Deploy the smart contract either locally or on the Mumbai testnet using the Hardhat tool.

npx hardhat deploy

npx hardhat deploy --network mumbai

Run the unit tests to ensure code reliability:

npx hardhat test

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.