Influence Server

API and events server for Influence. A grand strategy game set in an asteroid belt and built on Ethereum.

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0). Commercial use is not permitted without a separate license from Unstoppable Games, Inc.

For the avoidance of doubt: The licensor considers non-commercial use under this license to include deployments or uses that collect funds solely to recover the reasonable costs of operating, maintaining, or administering the software, provided that such use is not primarily intended for or directed toward commercial advantage or monetary compensation, and that no profit is distributed to operators, contributors, or participants.

Migration to Starknet

1. Run scripts in ./bin/starknet-setup to migrate asteroids and crewmates to components from snapshots.
2. Manually retrieve and process events since the snapshot block time on L1.
3. Setup retriever for Starknet.
4. Re-process all events.

Test Environment

1. Install local node modules: npm install
2. Ensure a local mongo instance is running.
3. (Optionally) ensure a local redis instance is running.
4. Initialize your .env file:

   echo "API_SERVER=1
   CLIENT_URL=http://localhost:3000
   BRIDGE_CLIENT_URL=http://localhost:4000
   IMAGES_SERVER=1
   IMAGES_SERVER_URL=http://localhost:3001
   MONGO_URL=mongodb://localhost:27017/influence
   #REDIS_URL=
   CLOUDINARY_URL=
   NODE_ENV=development
   JWT_SECRET=
   ETHEREUM_PROVIDER=http://localhost:8545
   CONTRACT_PLANETS=
   CONTRACT_ASTEROID_TOKEN=
   CONTRACT_ASTEROID_FEATURES=
   CONTRACT_ASTEROID_SCANS=
   CONTRACT_ASTEROID_SALE=
   CONTRACT_ASTEROID_NAMES=
   CONTRACT_ARVAD_CREW_SALE=
   CONTRACT_CREW_TOKEN=
   CONTRACT_CREW_FEATURES=
   CONTRACT_CREW_NAMES=
   " > .env
   

5. Adjust or fill in any missing .env variables as needed.

• REDIS_URL is optional (uncomment if you plan to use it)
• JWT_SECRET can be any random string
• CONTRACT_* values should have been output at the end of the seedChain script in the contracts project.

1. Install Homebrew (https://brew.sh)
2. Install mongodb tools brew tap mongodb/brew then brew install [email protected]
3. Download this seed data for local development. Unzip the file into ./data
4. Run NODE_ENV=development node ./bin/seedData.js to reset the database
5. Run npm run watch to start

Fixing "stuck" scans

1. Run node ./bin/updateCommon.js with the findStuck method uncommented.
2. Grab the output and run truffle test ./test/lib/TestScansMock.js with the output in the contracts project.
3. Get the output from #2 and run node ./bin/updateCommon.js with updateDatabase method uncommented.

Running as a Docker container 🐋

Notes:

• The compose.yaml file in the project expects a Docker network named web for the communication across containers (your mongo, redis, elasticsearch instances, optionally your own Starknet node if you want to run indexers, or a reverse-proxy e.g. Caddy). To create it, run docker network create web .
• By default the application port (3001) is only exposed to the web Docker network and not to the host machine. Un-comment the port configuration in compose.yaml if needed.
• The compose.yaml file includes the setup of redis and elasticsearch instances; the mongo instance is not included; initialisation of these services is not included.

Build and run a development image

1. Download source
2. Initialize your .env file - NODE_ENV=development
3. Build the image from local source: docker compose build
4. Start the container(s) (sample commands in compose.yaml)

Build and run the unit tests image

1. Download source
2. Build the image from local source: docker compose -f compose.unittest.yaml build
3. Start the container to run unit tests: docker compose -f compose.unittest.yaml up

Run an official prerelease or production image

1. Download compose.yaml and compose.prerelease.yaml or compose.prod.yaml
2. Initialize your .env file with the NODE_ENV that matches the image (prerelease or production); if running against a local redis instance, set REDIS_DISABLE_TLS=1
3. Start the containers (sample commands in compose.prerelease.yaml and compose.prod.yaml)

Influence-server services

• influence-server: the main service, running the API server
• four indexer services under the --indexer flag, designed to run continuously and index the onchain events
  • influence-indexer
  • influence-ethereumeventretriever
  • influence-starkneteventretriever
  • influence-eventprocessor
• two auditor services designed to be scheduled in order to catch missed events or reorgs
  • influence-eventauditor - run every 10 minutes
  • influence-agreementauditor - run daily
• influence-tools: a maintenance image running node as the default command used to execute initialization scripts