dexorder/install.md

Dexorder Dev Environment Installation

1. Initialize the submodules with git submodule init then pull with git submodule update
   • submodule tutorial
2. PostgresSQL
   1. install PostgreSQL
   2. sudo -u postgres psql (Ubuntu)
      1. create database dexorder
      2. create user dexorder password 'redroxed'
      3. grant all on database dexorder to dexorder
3. Install Docker
   • Ubuntu: Docker-engine install. Or install Docker Desktop with snap: snap install docker Fix sudo required: sudo groupadd docker sudo usermod -aG docker $USER
   • alternatively we can use containerd and update the backend/bin/df.sh script.
4. Install NodeJS
   1. Suggested to use Node Version Manager nvm.(Install instructions.)
   2. npm install --global yarn we use yarn as the package manager.
   3. cd web && yarn install; cd ..
   4. cd server && yarn install; cd ..
5. Install Python 3.11+
   1. suggested to create a virtualenv under backend/venv cd backend; python3 -m venv venv; cd .. source backend/venv/bin/activate
   2. cd backend && pip install -r requirements.txt; cd ..
6. Get an ethereum RPC account; both a websocket and http polling url are necessary. alchemy.com has these at the free tier.
   1. cp contract/foundry-default.toml contract/foundry.toml
   2. set the arbitrum_mock and arbitrum_test aliases at the bottom of that foundry.toml file:

   [profile.default.rpc_endpoints]
   arbitrum_mock='https://arb-mainnet.g.alchemy.com/v2/Nb705...'
   arbitrum_test='https://arb-mainnet.g.alchemy.com/v2/Nb705...'
   

7. cp backend/dexorder-mock.toml backend/dexorder.toml
8. cp backend/.secret-mock.toml backend/.secret.toml
9. cp server/.env-mock server/.env
10. cp web/.env-mock web/.env
11. Install a web wallet like MetaMask.
    1. Configure the wallet for a new chain:
       • name "Mock"
       • RPC URL http://localhost:8545
       • chain ID 31337
       • token name ETH. Metamask complains about the token name but ignore the warning.
    2. Create a mock account in your wallet
       1. use "import wallet" in metamask
       2. private key is 0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6
          • public address 0xa0Ee7A142d267C1f36714E4a8F75612F20a79720
          • this is the well-known Dev Account #9 and you can see the private key and address in hardhat startup.
          • starts with 10,000 ETH on any anvil chain
       3. under your Dev Account, import a few important tokens:
          1. WETH
             • 0x82aF49447D8a07e3bd95BD0d56f35241523fBab1
             • 18 decimals
          2. USDT
             • 0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9
             • 6 decimals
          3. USDC
             • 0xaf88d065e77c8cC2239327C5EDb3A432268e5831
             • 6 decimals

Mock Environment Execution

1. run web (port 3000)
   1. cd web && npm run dev
2. ./bin/mock.sh (from top level dexorder directory)
   1. builds contracts
   2. starts anvil, forking arbitrum_ankr (we should change this to something like arbitrum_anvil so we can each set it to whatever we want )
   3. runs forge script Deploy.sol and broadcasts init contracts onto the private anvil fork
   4. resets database, all data gone
   5. starts dragonfly (redis clone) using Docker
   6. log files for background processes go into ./tmp/*.txt
   7. the script traps ctrl-c to cleanly shut down anvil & dragonfly
3. wait until the mock script says "ONCHAIN EXECUTION COMPLETE & SUCCESSFUL"
4. run backend
   1. cd backend
   2. PYTHONPATH=src python -u src/dexorder/bin/main.py
5. run server (port 3001)
   1. cd server
   2. DEXORDER_PORT=3001 node main.js
6. browse to http://localhost:3000

NOTE: you can leave the web process (Vue) running while resetting everything else from #2 onwards. Just refresh the web browser after a new mock deployment