graphops/graphcast-cli

CLI for Graphcast

graphcast-cli's Issues

[Feat.Req] subcommands

Problem statement

After renaming one-shot-cli to graphcast-cli, we can consider a boarder scope for what the CLI can do

Expectation proposal

• move sending upgrade intent message into a subcommand graphcast send upgradeIntentMessage subgraph_id ...
• add simple commands relevant to upgrade presync functionality
  • query a list of indexers who has active allocation for the existing subgraph deployment
  • get public status APIs for a list of indexers
  • query indexingStatus from the public status APIs for the new deployment
  • summarize status

Add banner to Subgraph Studio to advertise Graphcast CLI

Migrated from graphops/subgraph-radio#21 by @axiomatic-aardvark

Expectation proposal
We should add a banner to Subgraph Studio that lets subgraph developers know that they can use our one-shot CLI to send messages about when they plan to publish a new version of their subgraph(s). That banner should direct them to our docs where we lay out the steps they need to take to send a message.

Alternative considerations
We could think of ways to integrate the one-shot CLI into Subgraph Studio itself, but that would require enormous effort since we would need to either 1. somehow wrap the existing one-shot CLI in WASM and create bindings for JS (which includes bundling the Go and C compilers) or 2. create a JS clone of one-shot CLI (using js-waku)

• Prioritize after User Improvement Issue, communicate with E&N subgraph studio team so the integration can be timed appropriately
• Add usage section in docs.graphops.xyz using the current README

Rename to graphcast-cli

Problem statement

More straightforward naming

Expectation proposal

• rename in codebase
• rename in docs

[Feat.Req] User Improvement

moved from @axiomatic-aardvark graphops/subgraph-radio#20

Problem statement
The current one-shot CLI is perfect for sending one-off subgraph versioning update messages (as well as any message really, with a few tweaks), but we need it to be more user-friendly. This means possibly changing its name and adding a script that runs it within Docker, eliminating the need for users to install all pre-requisites like Go, Clang, etc. We also need to extract it to a separate repo.

Expectation proposal
Users (subgraph devs) should ideally be able to pull a Docker image (GHCR package) and run it with custom arguments.

Alternative considerations
We could also skip this and instead wait for graphcast-web to be functional before recommending the subgraph versioning feature to subgraph developers, but that will take a lot longer and getting early feedback is vital.

[Feat.Req] update subcommand categories

subcommand

• send: for all commands that send various messages, such as upgrade-presync -> send upgrade-intent
• monitor: for all commands that monitor for a certain status, such as indexing-status -> monitor indexing-status
  • can add one on monitor indexer-version