README.md

TheBadge DApp Smart-contracts

For questions or request information reach out via Discord.

TheBadge Contracts

Usage

Install requirements with yarn:

yarn

Deployments

A collection of the different contract deployments and their addresses can be found in the TheBadge deployments file.

Deploy with foundry

Prerequisites

Set .env file:

WALLET_PRIVATE_KEY=
GOERLI_URL=https://goerli.infura.io/v3/
SEPOLIA_URL=https://sepolia.infura.io/v3/
GNOSIS_URL=https://rpc.gnosischain.com/
ETHERSCAN_API_KEY=
ALCHEMY_ENDPOINT_URL=https://eth-goerli.alchemyapi.io/v2/<apiKey>
TENDERLY_PROJECT=""
TENDERLY_USERNAME=""
REPORT_GAS=true

Install Rust & Cargo

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install foundry dev toolkit:

1) curl -L https://foundry.paradigm.xyz/ | bash
2) bash foundryup
3) foundryup --branch master

Install submodule dependencies:

forge install --no-commit

For troubleshooting check the fountry installation official guide.

Deploy

yarn deploy:goerli

Upgrade

yarn upgrade:goerli

Verify contract

This command will use the deployment artifacts to compile the contracts and compare them to the onchain code. It will also verify the contracts on tenderly.

yarn verify:goerli

Testing

To run the tests:

yarn build
yarn test

Deployments

• Please check the list of our deployed contracts here

Documentation

• You can check our badges architecture here

• If you want to learn more give a look to our docs

Security and Liability

All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

All smart contracts are released under BSL 1.1 - see the LICENSE.md file for details.