BitDAO Token Contract

The BitDAO contract as deployed on Mainnet

The aggregated solidity source file was lifted from the BitDAO contract address 0x1A4b46696b2bB4794Eb3D4c26f1c55F9170fa4C5 on Etherscan

Development Process

Git

Trunk based approach with a single main branch and ephemeral side branches. https://trunkbaseddevelopment.com/

Create yourself a user fork off the main. For every changeset create a branch off your fork. When the changeset is complete, create a pull request to merge the changeset to main. After the changeset is merged, updated your fork from the upstream (main)

Branch protection can be used to enforce this behaviour for public repo's or private repo's when owned by Pro, Team and Enterprise organisations.

Git messages

Messages for commit and merge operations enter into the browsable log of project changes, providing a historical context for the project's development.

Consistency helps readers tremendously, please follow Conventional Commits https://www.conventionalcommits.org/en/v1.0.0/

Sample Hardhat Project

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.

Try running some of the following tasks:

npx hardhat accounts
npx hardhat compile
npx hardhat clean
npx hardhat node
npx hardhat help

Tests

Target to run all the mocha tests found in the /test directory, transpiled as necessary.

npx hardhat test

Run a single test (or a regex of tests), then pass in as an argument.

 npx hardhat test .\test\sample.test.ts

Scripts

The TypeScript transpiler will automatically as needed, execute through HardHat for the instantiated environment

npx hardhat run .\scripts\sample-script.ts

Logging

Logging is performed with Bunyan

Bunyan CLI

To have the JSON logging output into a more human-readable form, pipe the stdout to the Bunyan CLI tool.

npx hardhat accounts | npx bunyan

Style Guide

Follow the Google TypeScript style guide, as they're sensible. https://google.github.io/styleguide/tsguide.html

Installation, building and running

Git clone, then from the project root execute

npm run build
npm run test

If you make changes that don't get picked up then add a clean into the process

npm run clean
npm run build
npm run test

Husky Git Commit Hooks

To enable Husky commit hooks to trigger the lint-staged behaviour of formatting and linting the staged files prior before committing, prepare your repo with prepare.

npm run prepare