Skip to main content
Version: v3.x

Installation and setup

  1. Add .env file (see .env.example).
  2. Generate RSA key pair with pnpm run generate-keypair.
  3. Download zkey files using pnpm run download-zkeys:{type} (only test type is available for now).
  4. Make sure you copied RSA public key to your application. This will be needed for encrypting Authorization header and coordinator private key for proof generation. Also it can be accessed through API method GET v1/proof/publicKey.
  5. Run pnpm run start to run the service.
  6. All API calls must be called with Authorization header, where the value is encrypted with RSA public key you generated before. Header value contains message signature and message digest created by COORDINATOR_ADDRESSES. The format is publicEncrypt({signature}:{digest}). Make sure you set COORDINATOR_ADDRESSES env variable and sign any message with the addresses from your application (see AccountSignatureGuard).
  7. Proofs can be generated with POST v1/proof/generate API method or with Websockets (see dto spec, controller and wsgateway).

Subgraph deployment​

It is possible to deploy subgraph using coordinator service.

First, you need to setup subgraph and create a project. Subgraph dashboard.

Then, set env variables:

# Subgraph name
SUBGRAPH_NAME="maci-subgraph"

# Subgraph provider url
SUBGRAPH_PROVIDER_URL=https://api.studio.thegraph.com/deploy/

# Subgraph deploy key
SUBGRAPH_DEPLOY_KEY=*******

# Subgraph project folder
SUBGRAPH_FOLDER=../subgraph

After deployment, subgraph url will be available in studio dashboard and you can use this type of url to get latest deployed version in your application:

https://api.studio.thegraph.com/.../{SUBGRAPH_NAME}/version/latest