Skip to content
This repository has been archived by the owner on Mar 9, 2023. It is now read-only.

Latest commit

 

History

History
296 lines (218 loc) · 10.8 KB

phase1.md

File metadata and controls

296 lines (218 loc) · 10.8 KB
Raw

Phase 1: Basic Protocol Actions

Phase 1 is divided into two missions:

  1. Set up indexer components
  2. Perform basic protocol actions

Important Updates

  1. 2020-08-27: Indexer Agent and CLI bugfix releases — properly detect on-chain registration and service status.
  2. 2020-08-27: Indexer CLI status improvements — detailed status reports for endpoints, with troubleshooting help.
  3. 2020-09-01: Indexer Agent and CLI bugfix releases - avoid failing transactions, show/use correct token/allocation amounts, handle errors better.

Mission 1: Set up Indexer Components

To prepare for the second mission of phase 1, indexers will need to extend their infrastructure to include components that will facilitate their interactions with the network and help manage subgraph deployments. Two components will be added to the indexer infrastructure: indexer-agent and indexer-service. Please refer to the following documentation for help setting up for phase 1.

Phase 1 Architecture

Indexer Agent

The Indexer Agent automatically chooses which subgraphs to index and manages deploying subgraphs to the indexer's Graph Node(s), allocating stake, claiming rewards, and setting real-time query prices on indexed subgraphs. Using flexible rules and the Indexer CLI (see below), one can configure automatic behavior and also make manual subgraph indexing decisions. The Indexer Agent monitors The Graph Network as well as the Indexer's own infrastructure to implement the strategy that has been defined by the Indexer.

Indexer Service

The Indexer Service is the indexer's public API in the network. It exposes a public query endpoint, proxies part of the Graph Node's indexing status API, manages state channels for receiving query payments, and will, in the future, help to facilitate disputes that arise.

Indexer CLI

This connects to port 8000 of the Indexer Agent, which serves the so-called indexer management API. The CLI can be used to control the behavior of the Indexer Agent.

Example infrastructure

  • Kubernetes manifests — The k8s manifests in the example setup have been updated to include indexer-agent and indexer-service deployments. The indexer-service is also included in the ingress for exposing it to the network.

Installation

The indexer-agent and indexer-service each require configuration parameters to connect to Ethereum, other parts of the indexer's infrastructure (Graph Node(s), Postgres) and to communicate with the network.

These may be applied as CLI arguments (detailed below) or as environment variables prefaced with the component name and formatted in all caps. The indexer-service --ethereum argument for example becomes INDEXER_SERVICE_ETHEREUM.

Note: Some environment variables for the indexer-service are not prefixed with INDEXER_SERVICE. These are:

  • SERVER_HOST,
  • SERVER_PORT,
  • SERVER_DB_NAME,
  • SERVER_DB_USER, and
  • SERVER_DB_PASSWORD.

The Indexer Agent and Service may be installed differently depending on your preference and existing infrastructure. See instructions for installing via NPM, Docker, or directly from source below.

  • Using NPM:

    npm install -g \
  --registry https://testnet.thegraph.com/npm-registry/ \
  @graphprotocol/indexer-agent \
  @graphprotocol/indexer-service

graph-indexer-agent start \
    --graph-node-query-endpoint http://localhost:8000/ \
    --graph-node-admin-endpoint http://localhost:8020/ \
    --graph-node-status-endpoint http://localhost:8030/graphql \
    --public-indexer-url http://your.indexer.domain/ \
    --indexer-management-port 18000 \
    --indexer-geo-coordinates <indexer-lat-long-coordinates. Eg: 37.630768 -119.032631> \
    --postgres-host <postgres-host> \
    --postgres-port 5432 \
    --postgres-database <indexer-service-database>
    --postgres-username <postgres-username> \
    --postgres-password <postgres-password> \
    --index-node-ids default \
    --network-subgraph-endpoint https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-rinkeby \
    --ethereum https://eth-rinkeby.alchemyapi.io/jsonrpc/demo/ \
    --mnemonic <Ethereum mnemonic>

export SERVER_HOST=<postgres-host>
export SERVER_PORT=<postgres-port>
export SERVER_DB_NAME=<postgres-db> # Don't use the same as your Graph Node(s)!
export SERVER_DB_USER=<postgres-username>
export SERVER_DB_PASSWORD=<postgres-password>

graph-indexer-service start \
    --port 80 \
    --graph-node-query-endpoint http://localhost:8000/ \
    --graph-node-status-endpoint http://localhost:8030/graphql \
    --network-subgraph-endpoint https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-rinkeby \
    --ethereum https://eth-rinkeby.alchemyapi.io/jsonrpc/demo/ \
    --mnemonic <Ethereum mnemonic> # This must be the same as the Indexer Agent!

  • Using Docker:

    # Run indexer agent
# Note: This assumes a `graph-node` is accessible on localhost with
# the admin endpoint on port 8020 and status endpoint on port 8030.
docker run \
  -p 8000:8000 \
  -p 8020:8020 \
  -p 8030:8030 \
  -p 18000:18000 \
  -it graphprotocol/indexer-agent:sha-573cee8 \
  ...env vars...

# Run indexer service
docker run \
   -p 7600:7600 \
   -it graphprotocol/indexer-service:sha-573cee8 \
  ...env vars...

  • Installing from source:

    git clone https://github.com/graphprotocol/indexer
cd indexer
yarn

cd packages/indexer-service
npm install -g

cd ../indexer-agent
npm install -g

# Run indexer components
graph-indexer-agent start ...
graph-indexer-service start ...

Successful Completion

Submit the following details using the Mission Control 1 - Phase 1 Endpoints form.

  1. In order to complete mission 1, you are asked to install the Indexer CLI, connect it to your Indexer agent, and run its graph indexer status command:
npm install -g \
  --registry https://testnet.thegraph.com/npm-registry/ \
  @graphprotocol/[email protected] \
  @graphprotocol/indexer-cli

graph indexer connect http://<indexer-agent-host>:<indexer-management-port>/
graph indexer status

Currently this library uses libsecret so you may need to install it before running npm install. Depending on your distribution, you will need to run the following command:

Debian/Ubuntu: sudo apt-get install libsecret-1-dev
Red Hat-based: sudo yum install libsecret-devel
Arch Linux: sudo pacman -S libsecret
  1. Send us the output of this command via the form linked above.
  2. Configure your Prometheus so it scrapes metrics from the Indexer Service (note: we'll add metrics for the Indexer Agent in phase 2).
  3. If the Prometheus endpoint has changed since phase 0, submit the Prometheus endpoint through the form as well.

Mission 2: Performing Basic Protocol Functions

Now that you have set up your Indexer Agent, Indexer Service and Graph Indexer CLI, your next mission is to perform basic protocol actions, which will leverage these tools as well as some new ones: The Graph Explorer, Uniswap Exchange and the (testnet only) GUSD Savings Rate.

You will be expected to complete the following actions:

  • Login to testnet Graph Explorer
  • Connect an ENS name
  • Stake Graph Tokens (GRT)
  • Signal on a subgraph
  • Index a subgraph
  • Unsignal on a subgraph
  • Unstake Graph Tokens (GRT)
  • Sell GRT for GUSD on Uniswap V2
  • Deposit GUSD into Savings Rate Account

Login to Graph Explorer

  1. Navigate to testnet.thegraph.com
  2. Provide login credentials sent to you via email.
  • (These credentials have nothing to do with your account in the app, they are just how we are controlling access to the private beta app).
  1. Connect Metamask wallet.
  • Be sure to use the same Ethereum Account that is currently setup with your Graph Indexer CLI + Indexer Agent.

Connect ENS name

  1. Navigate to profile dashboard.
  2. Click "edit" icon.
  3. Create ENS Name for Rinkeby (or use existing one)
  4. Enter your top-level ENS name and click "Register"
  • ENS subdomains are not supported

Stake Graph Tokens (GRT)

  1. Navigate to your profile dashboard.
  2. Click on "Stake" to stake Graph Tokens.
  • You should have received Graph Tokens at the address you provided to The Graph team.

Signal on a subgraph

  1. Navigate to the "Explore" page in Graph Explorer.
  2. Find a subgraph to signal on.
  • Reflect on why you might or might want to signal on this subgraph based on the information available to you. We may ask you about this!
  1. Navigate to the "subgraph details" page of the subgraph you chose.
  2. Click "Curate" to to signal on that subgraph.
  3. Complete steps in action panel.

Index a subgraph

  1. Navigate to the "Explore" page in Graph Explorer.
  2. Find a subgraph to index.
  • Reflect on why you might or might not want to index this subgraph based on the information available to you. We may ask you about this!
  1. Navigate to the "subgraph details" page of the subgraph you chose.
    • Note the subgraph ID.
  2. Use the Graph Indexer CLI to index the subgraph.
  • graph indexer rules set <deployment> decisionBasis always allocationAmount <amount>

Unsignal and Unstake

  1. Unsignal from the same entry point you used to signal.
  • This will require clicking the "Unsignal" tab from the action panel.
  1. Unstake some tokens from same entry point as where you staked.
  • This will require clicking the "Unstake" tab in the action panel.

Sell GRT for GDAI

  1. Navigate to Uniswap V2 Exchange for GRT <> GDAI on Rinkeby.
  2. Connect your wallet.
  3. Swap some GRT for GDAI.

Deposit GDAI into GDAI Savings Account

  1. Navigate to https://testnet.thegraph.com/savings/
  2. Connect your MetaMask wallet.
  3. Deposit GDAI into Savings Account.