ethernautdao / evm-runners-backend

Backend for evm runners game

evm-runners-backend

Requirements

• Node.js v18.16.1
• NPM v8.11.0
• postgresql

Setting up the environment

The server is expecting:

1. To connect to a postgresql database

   Follow the docs and set up a postgres server on your system. After the server is up and running, create a database named evm_runners. Then, you can import the schema in the file evm_runners_database_schema.sql. As an example, in Ubuntu this can be done by running:

   psql -h localhost -U evm_runners -f evm_runners_postgres_schema.sql
   

   Where evm_runners is the user you're using in your server.

2. Discord Auth

   You'll need to access the Discord Developer Portal and create an app. Still in the portal, set the app OAuth2 redirect link to https://localhost:1337/auth/discord/ Finally, you'll need to place the CLIENT_ID and CLIENT_SECRET in the .env. This is the only way to create a new user.

Endpoints

There are three types of endpoints:

1. Require no auth (ALL);
2. Require auth token (AUTH);
3. Require user to be an admin (ADMIN);

• Auth

  • AUTH (ALL)

  You'll need to open http://localhost:1337/auth in your browser and authorize the application, at which point the defined callback will be called and it will create your user. You will get a PIN as response, which you will need to get your access token.

• User

  • GET USER INFO (ALL)

  This will return the information for the user with the given PIN.

  curl http://localhost:1337/users/info/PIN 
  

  • GET ALL (ADMIN)

  curl -H "Authorization: Bearer {token}" http://localhost:1337/users
  

  • GET BY ID (ADMIN)

  curl -H "Authorization: Bearer {token}" http://localhost:1337/users/1
  

  • GET BY WALLET ADDRESS (ADMIN)

  curl -H "Authorization: Bearer {token}" http://localhost:1337/users/wallet/0x...
  

  • ADD WALLET ADDRESS (AUTH)

  Associate an OP mainnet address with the account corresponding to the token.

  curl -X POST http://localhost:1337/users/wallet \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"address":"0x..."}' 
  

• Level

  • GET (ALL)

  curl http://localhost:1337/levels
  

  • GET BY ID (ALL)

  curl http://localhost:1337/levels/1
  

  • GET TOTAL SOLUTIONS (ALL)

  curl http://localhost:1337/levels/1/total
  

  • POST OR PUT (ADMIN)

  If the token is for an user that is an admin, this will create the level Average, with position 1, meaning it is the first level. AverageTest is the name of the foundry test file. If you want to update it use -d '{"id": 1, "name":"Average_updated", "position":2, "test_contract":"AverageTest_Updated" }'

  curl -X POST http://localhost:1337/levels \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"name":"Average", "position":1, "test_contract":"AverageTest" }' 
  

  • DELETE (ADMIN)

  curl -H "Authorization: Bearer {token}" http://localhost:1337/levels/1
  

• Submission

  • GET (ADMIN)

  curl -H "Authorization: Bearer {token}" http://localhost:1337/submissions
  

  • GET BY ID (ADMIN)

  curl -H "Authorization: Bearer {token}" http://localhost:1337/submissions/1
  

  • GET BY USER AND LEVEL (AUTH)

  This will take the authorization token and return all submissions from the corresponding user

  curl -H "Authorization: Bearer {token}" http://localhost:1337/submissions/user/
  

  • GET GAS LEADERBOARD BY LEVEL ID (ALL)

  curl http://localhost:1337/submissions/leaderboard/gas/1
  

  • GET SIZE LEADERBOARD BY LEVEL ID (ALL)

  curl http://localhost:1337/submissions/leaderboard/size/1
  

  • GET TOP GAS SUBMISSION BY LEVEL ID (ALL)

  curl http://localhost:1337/submissions/leaderboard/gas/top/1
  

  • GET TOP SIZE SUBMISSION BY LEVEL ID (ALL)

  curl http://localhost:1337/submissions/leaderboard/size/top/1
  

  • POST OR PUT (AUTH)

  User with ID 1 is submitting a solution for level 3. This solution will be tested. If it passes the tests it is saved. If the user already has a solution for this level, it is updated.

  curl -X POST http://localhost:1337/submissions \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{ "bytecode": "0x608060...", "user_id": "1", "level_id": "3" }' 
  

Run this application

1. Create env and then fill the needed variables

$ cp .env.example .env

2. Install dependencies

$ npm install

3. Run as dev

$ npm run dev