An Ethereum dApp for aggregating peer review data.
The application can be run on the current bloxberg network, as well as on a local test network (ganache, test-rpc).
- docker
- docker-compose
- npm
- truffle suite
- Metamask
Download node and npm here.
Dowload and install docker and docker-compose
If not available, install truffle globally by:
npm install -g truffle
Install the Metamask browser extension at to be able to interact with the blockchain on the browser.
Keep the 12 word seed phrase for the next step.
To run the app we need two secrets in .env file.
First make a copy of the .env-template file and name it .env.
To import reviews from Publons you need to have an auth token. Login and find the token here. Enter the found token 6452ac....4f2de in the given format Token 6452ac....4f2de as the environment variable.
To import ORCiD ID and email, enter ORCiD client ID and secrets as environment variables. For development you will need sandbox credentials. The sandbox credentials can be found here after registering an application. Assign SANDBOX variables to these at .env and at client/.env for create-react-app to reach. If you need a production version register your app to ORCiD and use ORCiD's production server with credentials here. Assign variables in .env.
Enter the 12 word MNEMONIC (seed phrase) for the accounts to be used and funded by ganache. You can use the MNEMONIC created by Metamask when creating a wallet or as described here.
Install dependencies by
npm install
You can easily run the development environment by executing (if you have npm installed)
npm run dev
This will pull the docker images and run the modules according to the settings in docker-compose-dev.yml. Also, both the server, indexer, and client utilises hot reloading, meaning changes made to code are applied immediately.
We need to connect Metamask to ganache or the bloxberg network.
Ganache settings should be already set.
For bloxberg go to Settings->Networks->Add Network. Add the following settings:
Network Name: bloxberg
Network RPC Url: https://core.bloxberg.org/
Network Id: 8995
Block Explorer URL: https://blockexplorer.bloxberg.org
Our contract makes use of Gas Station Networks to enable gasless transactions so we need to initialize the contract and fund at the RelayHub. ( Note that OpenZeppelin's GSN has become OpenGSN )
When you ran npm run dev both ganache and the relayer were started. The relayer creates the RelayHub contract in ganache network, creates and runs a Relay, and funds the Relay. You only need to deploy your contract (in GSN terms the Recipient) and fund it. Deploy it while calling initialize():
npx oz create --network develop
Choose ReviewStorage. Note the address of the contract that is output.
Then, the new contract must be funded in order to use meta-transactions. This is done by calling depositFor() on the RelayHub contract. You can use this tool to send the transaction (gsn.openzeppelin.com is no longer available. To fund the recipient, you can run the site code in pages/recipients locally, use a helper script or send a transaction manually). Choose the localhost:8545 network in Metamask. Enter the address of your deployed contract and send the amount you want via Metamask. A value around 1ETH/bergs should work. Alternatively, compile the GSNRecipient contract in Remix and send a transaction with value you want to fund while calling depositFor(<your-contract-address>).
Now you can go to [http://localhost:3001] and use the application.
This time choose bloxberg network in Metamask.
In bloxberg you will need bergs to be able to send transactions. Get some bergs using the faucet
In order to deploy the contract, simply run the following command on the bloxberg network while making sure to call initialize():
npx oz create --network bloxberg
Choose ReviewStorage. Note the address of the contract that is output.
Then fund as described above. With the contract deployed in bloxberg, you can now also disable Metamask and use Magic as your wallet.
TODO:
- Add GSN Contract deployment
More info about GSNs EIP-1613 and OpenZeppelin docs.
Make sure you have set-up the .env file as described above.
To build and run the production simply execute:
docker-compose up
This will create a production build of the client, serve it through a simple nginx server at port 80, start the express server at port 3000, and start the mongo service.
You should be able to access the application at [http://localhost]
Make sure no other processes are running on TCP ports: 27017 (mongo), 3000 (server), 8545 (ganache), 3001 (client-dev), 80 (client-production).
If you get permission error when trying to stop docker containers, you can execute sudo service docker restart as a workaround.
The ganache/ folder has the owner root as this folder (docker volume, better said) is created by docker.
If you receive mnemonic errors make sure you have the environment variable MNEMONIC is properly set. Also make sure
If you receive MODULE NOT FOUND errors when running the development containers, remove the node_modules folder via rm -rf node_modules/. This is due to docker running as root and causes permission errors. Use this workaround temporarily.
In the dev environment, the relay container funds the relays each time. This may cause your accounts to run out of balance.
If you reset the development blockchain by clearing the ganache folder make sure you reset the Metamask account by Settings > Advanced > Reset Account. If not you will receive Error: [ethjs-rpc] rpc error with payload and not even able to send ether transactions from Metamask.
If you get Error: connection not open at WebsocketProvider.send (/home/node/app/node_modules/web3-providers-ws/src/index.js:282:18) this is because the indexer is running before ganache and can't connect to the ganache network. Make indexer run after network is set up. Should not be a problem in production as bloxberg will be running all the time.
Magic wallet uses 3rd party cookies for authentication. Blocking of 3rd party cookies will disrupt the login process.
On the frontend the error: Objects are not valid as react child can occur when declaring styled components. Don't forget the template literals at the declaration. See here
To run a clean state in development drop the database test from mongo console. By typing mongo in the terminal. Then use test and db.dropDatabase(). Also clean the blokchain state by removing the ganache folder rm -rf ganache and recreating it: mkdir ganache. Don't forget to reset your Metamask account by Settings > Advanced > Reset Account.
TypeError: Cannot create property 'Symbol(level)' on string is thrown if you are not logging with winston properly. Do not use logger.log(message). Either user logger.info(message) or logger.log('info', message). Same for errors: logger.error(message) or logger.log('error', message)
If you get Could not connect to node at http://ganache:8545 (Error: Found no accounts with sufficient balance (10000000000000000000 wei)). it is because you may have launched the test network with a different seed phrase and your current accounts were initially not funded. Remove the folder ganache/ by sudo rm -rf ganache/ and restart.