This is a decentralized application (DApp) that demonstrates a simple implementation using the game of OWAAT (One Word At A Time).
- Must have a crypto wallet
- Connect account to one of the following networks:
- Polygon Mumbai Test Network
- Recommend registering for a free RPC Moralis account at https://moralis.io/
- Add OWAAT application to get a free endpoint/ID registered with the network
- Add the test network RPC endpoint/ID to your wallet
- Go to Polygon faucet to get MATIC https://faucet.polygon.technology/
- Molereum private network
- Add RPC endpoint to your wallet, https://molereum.jdubedition.com
- Currently no faucet for this network, so have to contact Justin to get MOLE for your account
- Polygon Mumbai Test Network
- Go to dapp-owaat.jdubedition.com
- Clone this repository to your workstation
- Download and execute Ganache, to run a local blockchain (choose Quickstart network option in GUI)
- Setup account information for the DApp
- Import private key for one of the Ganache accounts into your wallet
- Transfer funds from the imported account to the test account in your wallet
- Copy .env.template to .env.local and add the private key for your test account
- Install Yarn
- Push contracts to Ganache
yarn installtruffle migrate --network develop
- Run the DApp
cd clientyarn installyarn start, this should openhttp://localhost:3000in your default browser
- enjoy!
- Install Truffle CLI with
npm install -g truffle - Create a Truffle React application
truffle unbox react - Change port setting to
7545(to use Ganache) intruffle-config.jsand getWeb3.js - Update
truffle-config.jsto use Molereum network - Add NPM dependencies to
package.jsonto support Molereum network - Add Material-UI to the project:
cd client- Update dependencies for good measure:
yarn upgrade-interactive --latest yarn add @mui/material @emotion/react @emotion/styled @mui/icons-material- Add the following elements to the
<head>section of index.html:
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" /> <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" /> - Add OpenZeppelin upgradeable contracts for truffle
yarn add -D @openzeppelin/truffle-upgrades(note when compiling or migrating, this will add a .openzeppelin directory to the project and this will be used to link ProxyAdmin and TransparentUpgradableProxy contracts with the Truffle contracts in client/src/contracts directory) - Use upgradeable contracts for OpenZeppelin Ownable by installing
yarn add @openzeppelin/contracts-upgradeableand thentruffle compile --allto make sure it extracts the upgradeable contracts that are implemented in the truffle contracts - Use CloudFlare Pages React application configuration. A few settings to point at the
clientdirectory, runyarn build, and use the custom domain of dapp-owaat.jdubedition.com and it is all set. - Use OpenZeppelin test environment instead of
truffle testas it is a lot faster and easier to understand. Add the dependencies to the projectyarn add -D @openzeppelin/test-environment @openzeppelin/test-helpers mocha chaiand addtest-environment.config.jsand set the build directory toclient/src/contracts. Update package.json to include:and then run"scripts": { "test": "mocha --exit --recursive" }truffle compileand thenyarn testto run the tests. Each time you modify the contracts you will need to runtruffle compileand then you can runyarn testto run the tests.
yarn installto install dependencies- Add solidity file to ./contracts
- Add deployProxy to ./migrations (uses OpenZeppelin deployProxy for upgrading contracts later, has additional expense of deploying ProxyAdmin and TransparentUpgradeableProxy contracts for each contract)
- Create tests by adding solidity file and JS file to ./test
- Run
truffle testto make sure everything is working as expected - Compile and Deploy contracts as using
truffle migrate(use--network <network>to deploy to a specific network) - Import contract into ./client/src/App.js (or other JS file in client/src)
yarn installto install dependencies- Add solidity file to ./contracts with suffix designation of next version (e.g. V2 or V3)
- Add upgradeProxy to ./migrations (uses OpenZeppelin upgradeProxy and new contract version)
- Update tests associated with contract JS file in ./test
- Run
truffle compileto create new contract artifacts - Run
yarn testto make sure everything is working as expected - Compile and Deploy contracts as using
truffle migrate(use--network <network>to deploy to a specific network) - Update ./client/src/App.js to import new contract version
Testing this DApp on Molereum network
- Make sure you have a crypto wallet setup on your local machine, with an account on the Molereum network, and a MOLE balance large enough to pay for the gas cost of the migration (recommend using Brave browser Crypto Wallets or MetaMask extension)
- Create .env file from .env.template
- Export private key of your Molereum account from your wallet and add it into .env.local
- Migrate contracts to the network
truffle migrate --network molereum - Start client
yarn start
- Set a base price for up to 13 characters and add a price per character for each additional character
- Maybe add price paid for the word to the transaction history section of the client
- Add more client tests