nosu-nfts v0.0.1

nosu-nfts

  .S_sSSs      sSSs_sSSs      sSSs   .S       S.   
  .SS~YS%%b    d%%SP~YS%%b    d%%SP  .SS       SS.  
  S%S   `S%b  d%S'     `S%b  d%S'    S%S       S%S  
  S%S    S%S  S%S       S%S  S%|     S%S       S%S  
  S%S    S&S  S&S       S&S  S&S     S&S       S&S  
  S&S    S&S  S&S       S&S  Y&Ss    S&S       S&S  
  S&S    S&S  S&S       S&S  `S&&S   S&S       S&S  
  S&S    S&S  S&S       S&S    `S*S  S&S       S&S  
  S*S    S*S  S*b       d*S     l*S  S*b       d*S  
  S*S    S*S  S*S.     .S*S    .S*P  S*S.     .S*S  
  S*S    S*S   SSSbs_sdSSS   sSS*S    SSSbs_sdSSS   
  S*S    SSS    YSSP~YSSY    YSS'      YSSP~YSSY

This repository use Hardhat and Foundry to compile, deploy and test the Solidity Smart Contract. The contract NosuWorl is inheriting ERC721A, Ownable and using MerkleProof to validate OG and WL users.

This repository use NodeJS version 18.

Directories

• abi/
• constants/

• scripts/

• .env.development.sample

• .prettierignore
• .prettierrc
• .solcover.js
• awesome-readme.config.js
• contractsAddressDeployed.json
• contractsAddressDeployedHistory.json
• foundry.toml
• hardhat.config.js
• hardhat.flat.config.js
• LICENSE
• package-lock.json
• package.json
• README.md
• remappings.txt

Hardhat

This project use Hardhat for compiling the contracts, deployment and testing purposes. It include:

• The constants use for deployment and testing in constants/
• The contracts in contracts/
• The tests in test/
• The deployment script in scripts/
• The Hardhat config in hardhat.config.js

Hardhat - First step - Install dependencies

npm install

Or

yarn

Hardhat - Compile contract

npx hardhat compile

Hardhat - Run all tests

npx hardhat test

Hardhat - Run coverage report

npx hardhat coverage

Hardhat - Run deployment script

npm run deploy-test

Or

yarn deploy-test

Foundry

This project use Foundry for compiling the contracts and testing purposes. It include:

• The contracts in contracts/
• The tests in contracts/test/
• The Foundry config in foundry.toml
• The Foundry import remappings in remappings.txt

Foundry - First step - Install dependencies, install Foundryup and build test data

First, install all npmjs dependencies.

npm install

Or

yarn

Second, install Foundry on your system -> Foundry This will require to have Rust install -> Rust

Finally, build the test data, by running, this will create a file in contracts/test/shared/testData.t.sol with some tests data for some forge tests to use.

npm run build

Or

yarn build

Foundry - Compile contract

forge compile

Foundry - Run all tests

forge test

Directory Tree

nosu-nfts/
│   .env.development.sample
│   .prettierignore
│   .prettierrc
│   .solcover.js
│   awesome-readme.config.js
│   contractsAddressDeployed.json
│   contractsAddressDeployedHistory.json
│   foundry.toml
│   hardhat.config.js
│   hardhat.flat.config.js
│   LICENSE
│   package-lock.json
│   package.json
│   README.md
│   remappings.txt
└─── abi/
└─── constants/
└─── scripts/
   │   NosuWorld.json
   │   index.js
   │   OG.js
   │   README.md
   │   WL.js
   │   buildAbi.js
   │   buildRootAndProofs.js
   │   deploy.js
   │   README.md

Don't hesitate to contribute to this project.