Dev Quickstart

1. clone and cd into directory
2. run yarn
3. run yarn test or yarn test:watch

Environment Setup

• node ^v14 (nvm recommended)
• yarn
• ethlint (if running coverage script)

Scripts

command	description
claim	test claim, generate tokenURI for given id yarn claim 6434
coverage	check test coverage
gas	compile and check estimated gas cost for deployment and functions
gas:quick	check estimated gas without compiling
test	compile and run js tests
test:quick	run js tests without compiling
test:watch	compile and run js tests while watching for test.js changes

Note: yarn test:watch only watches test.js files for changes, any Contract.sol changes will require re-compiling, meaning you have to re-run the test script to compile the contract

Upgrading

1. include const { deployProxy, upgradeProxy } = require('@openzeppelin/truffle-upgrades'); in 2_deploy
2. first deploy in format: await deployProxy(Crystals, [mana.address], { deployer });
3. upgrade format: await upgradeProxy('<proxy address>', Crystals, { deployer });

Deploy

• Verify deploying wallet has over 2x estimated funds required