Skip to content

Latest commit

 

History

History
185 lines (102 loc) · 7.72 KB

allocations.md

File metadata and controls

185 lines (102 loc) · 7.72 KB
Raw

Table of contents

Working environment

To open or close allocations, we will be using the cli container.

Get into the cli container by running the following command inside the root of the repository

./shell cli

Now we have access to both graph-cli and the indexer-cli as an extension to the former.

To get more information about the available graph commands use the following:

graph --help
graph indexer --help

Understanding Subgraph Allocations

In order to get a better understanding around Subgraph Allocations as an indexer, I would highly recommend reading the following article, written by Jim from WaveFive, along with the Network Overview blogposts written by Brandon.

Without a thorough understanding of the Protocol economics, you won't be profitable. So before jumping to anything else, give those links a read.

Opening Allocations

Once you read those links above and you know exactly what your plan is, and what you're doing, then make it to the Graph Explorer (https://thegraph.com/explorer), find the subgraphs that you want to allocate towards, and copy their IPFS hash (Deployment ID).

ipfs_hash

Now, to allocate towards your chosen subgraph, inside the cli container, run the following command:

graph indexer rules set <IPFS_HASH> allocationAmount <GRT> decisionBasis always

This will trigger the indexer-agent to send an allocation transaction on the network, and once that's confirmed, you've successfully allocated to the subgraph of your choice!

Reviewing your allocations using the indexer-cli

Review local database of allocations

We can use the following command with the indexer-cli:

graph indexer rules get all

This will give us a table with all the allocations that we've set up. It doesn't check for on-chain allocations, as it's only displaying the allocation rules found in your agent database.

Check for onchain allocations via the indexer-cli

We can use the following command with the indexer-cli:

graph indexer status

This will give you information about the status of your endpoints, and also display current on-chain allocations and their status.

Check for onchain allocations via the Graph Explorer and other 3rd party tools

You can easily see if you've successfully allocated to a subgraph by going to your indexer profile on the Graph Explorer, or other 3rd party tools.

You simply have to search for your indexer address (staking wallet) to find out if your allocations are set on-chain.

Check for onchain allocations via querying the Network Subgraph

Another, more direct, way of checking for successful allocations onchain, would be to query the Network Subgraph for your indexer address, with the following query:

query MyQuery {
  allocations(
    where: {activeForIndexer: "<lower_case_address>"}
  ) {
    id
    subgraphDeployment {
      ipfsHash
      originalName
    }
  }
}

Closing allocations

To close allocations, you have two options:

First option would be to run the same command that you used to allocate, but chainging the decisionBasis to never:

graph indexer rules set <IPFS_HASH> decisionBasis never

This will trigger the indexer-agent to send an allocation closure transaction on the network, and once that's confirmed, you've successfully unallocated off that subgraph!

The second option would be to just delete the allocation from the rules database. This also makes things much more nice and tidy, especially if you use the get rules all command all the time.

graph indexer rules delete <IPFS_HASH>

Or you can delete all the rules via

graph indexer rules delete all

The life of an allocation

After being created by an indexer a healthy allocation goes through four states.

  • Active - Once an allocation is created on-chain (allocateFrom()) it is considered active. A portion of the indexer's own and/or delegated stake is allocated towards a subgraph deployment, which allows them to claim indexing rewards and serve queries for that subgraph deployment. The indexer agent manages creating allocations based on the indexer rules.

  • Closed - An indexer is free to close an allocation once 1 epoch has passed (closeAllocation()) or their indexer agent will automatically close the allocation after the maxAllocationEpochs (currently 28 days). When an allocation is closed with a valid proof of indexing (POI) their indexing rewards are distributed to the indexer and its delegators (see "how are rewards distributed?" below to learn more).

  • Finalized - Once an allocation has been closed there is a dispute period after which the allocation is considered finalized and it's query fee rebates are available to be claimed (claim()). The indexer agent monitors the network to detect finalized allocations and claims them if they are above a configurable (and optional) threshold, —-allocation-claim-threshold.

  • Claimed - The final state of an allocation; it has run its course as an active allocation, all eligible rewards have been distributed and its query fee rebates have been claimed.

Table of contents