graphcast-sdk 0.7.4

SDK to build Graphcast Radios
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# Graphcast SDK

[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://docs.graphops.xyz/graphcast/intro)
[![crates.io](https://img.shields.io/crates/v/graphcast-sdk.svg)](https://crates.io/crates/graphcast-sdk)

## Introduction

Graphcast is a decentralized, distributed peer-to-peer (P2P) communication tool that allows Indexers across the network to exchange information in real-time. Today, network participants coordinate with one another using the protocol by submitting on-chain transactions that update the shared global state in The Graph Network. These transactions cost gas, which makes some types of signaling or coordination between participants too expensive. In other words, sending signals to other network participants has a high cost that is determined by the cost of transacting on the Ethereum blockchain. Graphcast solves this problem.

To see the full idea behind Graphcast, you can check out the [GRC](https://forum.thegraph.com/t/grc-001-graphcast-a-gossip-network-for-indexers/3544/8) for it.

## Upgrading

Updates to the SDK will be merged into the `main` branch once their respective PR has been approved.

## Testing

We recommend using [nextest](https://nexte.st/) as your test runner. Once you have it installed you can run the the suite using the following command:

```
cargo nextest run
```

Alternatively, to run graphcast-sdk tests using docker to avoid local dependency issues:
```
./scripts/docker-run-tests.sh
```


## How does the Graphcast SDK work?

The SDK is essentially a base layer that Radio developers can use to build their applications without needing to worry about starting everything from scratch. The components that are included in the SDK are:

- Connecting to the Graphcast network, e.g., a cluster of [Waku](https://waku.org/) nodes. It also provides an interface to subscribe to receive messages on specific topics and to broadcast messages onto the network.
- Interactions with an Ethereum node.

There is also a POI cross-checker Radio in the `examples/` folder that leverages the base layer and defines the specific logic around constructing and sending messages, as well as receiving and handling them.


## Graphcast Network Configurations

A Graphcast radio can interact with many parts of The Graph network modularly; below are the network configurations actively supported by our team. You are free to define and use your own Graphcast Network and Graphcast Registry. 

| Graphcast Network | Supporting Network | Graph Network                   | Graphcast Registry             |
| ---------------- | ---------------- | --------------------------- | ----------------- |
| Mainnet | Mainnet | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-mainnet                | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-mainnet |
| Testnet | Goerli | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-goerli                | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-goerli |
| Testnet | Arbitrum Goerli | https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum-goerli                | https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-arbitrum-go |


## Contributing

We welcome and appreciate your contributions! Please see the [Contributor Guide](/CONTRIBUTING.md), [Code Of Conduct](/CODE_OF_CONDUCT.md) and [Security Notes](/SECURITY.md) for this repository.