Version

2.0.0-alpha.1

Setting up local development

Pre-requisites

• Node.js version 14.0+ and yarn for Javascript environment.
• Foundry for running forge tests.

1. Clone this repository

git clone https://github.com/Metadhana-Studio/roosterwars-contracts

2. Install dependencies

yarn

3. Set environment variables on the .env file according to .env.example

cp .env.example .env
vim .env

4. Compile Solidity programs

yarn compile

Development

• To run hardhat tests

yarn test:hh

• To run forge(foundry) tests

yarn test:forge

• To start local blockchain

yarn localnode

• To run scripts on Rinkeby test

yarn script:rinkeby ./scripts/....

• To run deploy contracts on Rinkeby testnet (uses Hardhat deploy)

yarn deploy:rinkeby --tags ....

• To verify contracts on etherscan

yarn verify:rinkeby MyTokenContract,MyNFTContract

... see more useful commands in package.json file

Main Dependencies

Contracts are developed using well-known open-source software for utility libraries and developement tools. You can read more about each of them.

OpenZeppelin

Solmate

Hardhat

hardhat-deploy

foundry

ethers.js

TypeChain