graphprotocol / graphprotocol/indexer

indexer-cli: add `deployments` module

Open
#784 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement indexer-cli p3
Dominant language
TypeScript
Stars
262
Forks
148
PR merge metrics
No merged PRs in 30d

Description

Background

The Indexer-cli currently provides functionality for many important indexer operations. Ultimately the goal is to identify operations that currently need to be done outside of indexer-cli and merging them into indexer-cli functionality. Currently the indexer-cli provides tooling for: managing allocations, applying business strategy using indexing rules and the actions queue, and managing cost models. Another major area of focus for indexers is the management of deployments which can currently be done using the admin JSON-RPC endpoint on the graph-node, or using the graphman cli tool. There is an ongoing project to move graphman functionality into a GraphQL endpoint that can be called by other components. Once this work is completed it will open up the possibility to extend the indexer-cli to cover these deployment management commands.

Goal

Provide deployment management interface in the indexer-cli. For gathering data on deployments as well as managing them.

Some functionality we'll want to include:

  • mutations
    • deploy
    • reassign
    • unassign
    • rewind
    • drop
    • unused record
    • unused remove
    • account-like optimization
  • queries
    • info

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing indexer-cli command structure and the graph-node graphman-to-GraphQL work linked in the issue. Done means defining and implementing the listed deployment queries and mutations through indexer-cli, covering both deployment data gathering and management.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
api, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.