Registry Contract
The Graphcast Registry contracts allow an address to set a GraphcastID by calling setGraphcastID(indexer_address, graphcastID_address) as either an Indexer or an Indexer operator, or calling setGraphcastID(graphcastID_address) as the Indexer address. The relationship between an Indexer address to its GraphcastID is limited to 1:1, and cannot be set to itself. This restriction provides consistency and security for the Indexer identity to operate on Graphcast as one GraphcastID operating across Radio applications. To learn more about the registry, you can check out the Github repository.
There are also subgraphs for these registry contracts. They provide information on both the Indexer registration status and the GraphcastID registration status, specifically mapping the indexer registered on The Graph service registry contract to GraphcastID registered on the Graphcast registry contract.
Register a Graphcast ID
The Graphcast Registry contract maps Graphcast IDs to Indexers in the Graph Protocol. With a unique Graphcast ID, an Indexer can sign messages for the Radio, eliminating the need to expose their private Indexer (or Indexer Operator) key or mnemonic. This provides an added layer of security, protecting Indexers' sensitive information while enabling participation in the Graphcast Network.
Here is a brief overview of the accounts you'll be interacting with:
| Account Name | Description |
|---|---|
| Indexer Account | The existing account associated with your Graph Protocol Indexer. This may be a Token Lock Contract address, or a multisig or EOA address. |
| Indexer Operator Account | An account you have registered as an Operator for your Indexer. You can use the Operator account that you pass to indexer-agent. |
| Graphcast ID Account | A new account that you will create that is used by Graphcast Radio instances to sign messages on behalf of your Indexer. |
You'll need to use a registered Indexer Operator account for your Indexer to register a Graphcast ID.
You can register multiple Operators for your Indexer in parallel. If you would prefer not to import the Operator account that you use with indexer-agent into your wallet in order to register your Graphcast ID, you can generate and register a dedicated operator account for this purpose. After you have registered your Graphcast ID, you can deregister the dedicated operator if you desire.
- Generate a new Ethereum account to act as your Graphcast ID, keeping the details safe. Be sure to select the Ethereum network, and save the mnemonic, as well as the address and private key for the first account. This is your Graphcast ID.
- Import your Indexer Operator private key into your wallet (e.g. MetaMask or Frame) in order to send a transaction to register your Graphcast ID.
- Navigate to the Graphcast registry contract for your preferred network and register your Graphcast ID.
- Call
setGraphcastIDFor(indexer_address, graphcast_id), passing in your Indexer Address and Graphcast ID. Neither address should be your Indexer Operator address that is being used to sign the transaction. - Submit your transaction and wait for it to be included in a block.
Registry endpoints
Each Graphcast ID can be associated with a single Indexer. To revoke a Graphcast ID for your Indexer, call setGraphcastIDFor(indexer_address, graphcast_id) with a Graphcast ID of 0x0 using a registered Indexer Operator Account.
Subgraph APIs
Here we list out the APIs the team supports actively. For network subgraph endpoint, We recommend you to expose your indexer-service's endpoint at /network queries with authentication. You can also index and serve registry subgraph but they are not currently deployed on the decentralized network.
Here are the endpoints available on the hosted service.
| Protocol Network | Graphcast Network | Registry Subgraph Endpoint | Network Subgraph Endpoint |
|---|---|---|---|
| Ethereum Mainnet | mainnet | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-mainnet | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-mainnet |
| Goerli | testnet | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-goerli | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-goerli |
| Arbitrum-One | mainnet | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-arb-one | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum |
| Arbitrum-Goerli | testnet | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-arbitrum-go | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum-goerli |