Skip to content

Commit cb1cc2f

Browse files
Examples README (#1945)
* Update README.md * fix lint --------- Co-authored-by: YaroShkvorets <[email protected]>
1 parent 7956faa commit cb1cc2f

File tree

3 files changed

+60
-3
lines changed

3 files changed

+60
-3
lines changed

.prettierrc.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import prettierConfig from '@theguild/prettier-config';
2+
3+
export default {
4+
...prettierConfig,
5+
overrides: [
6+
...(prettierConfig.overrides || []),
7+
{
8+
files: '*.md{,x}',
9+
options: {
10+
semi: false,
11+
trailingComma: 'none',
12+
proseWrap: 'preserve',
13+
},
14+
},
15+
],
16+
};

.prettierrc.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

examples/README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
11
# Example Subgraphs
22

3-
A collection of subgraph examples to help developers get started with The Graph. Please see
4-
[the documentation](https://thegraph.com/docs) for more information.
3+
This section contains several subgraph examples to help you get started with [The Graph](https://thegraph.com/). Each example demonstrates specific configurations and assumes basic familiarity with subgraph components.
4+
5+
## Table of Contents
6+
7+
1. **[Aggregations](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/aggregations)**
8+
This example demonstrates how to aggregate data using block numbers as predictable values. The comments in the schema, subgraph manifest, and mappings provide guidance for implementing custom aggregations.
9+
10+
2. **[Arweave Blocks and Transactions](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/arweave-blocks-transactions)**
11+
This example indexes blocks, transactions, tags, and POAs on the Arweave blockchain. Please note that it requires `graph-cli` version 0.30.2 or above to build.
12+
13+
3. **[Cosmos Block Filtering](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/cosmos-block-filtering)**
14+
This example stores `Block` objects that represent blocks appended to a Cosmos chain, saving only the block number and timestamp to the store.
15+
16+
4. **[Cosmos Osmosis Token Swaps](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/cosmos-osmosis-token-swaps)**
17+
This example stores `TokenSwap` objects that represent token swaps made using the Generalized Automated Market Maker (GAMM) in the Osmosis chain.
18+
19+
5. **[Cosmos Validator Delegations](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/cosmos-validator-delegations)**
20+
This example stores `Delegation` objects representing validator delegations on a Cosmos chain.
21+
22+
6. **[Cosmos Validator Rewards](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/cosmos-validator-rewards)**
23+
This example stores `Reward` objects representing rewards received by validators on a Cosmos chain.
24+
25+
7. **[Ethereum Basic Event Handlers](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/ethereum-basic-event-handlers)**
26+
This example shows how to handle basic events on the Ethereum blockchain using The Graph. It provides a practical implementation of event handlers, showcasing how to index and query blockchain data.
27+
28+
8. **[Ethereum Gravatar](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/ethereum-gravatar)**
29+
This example indexes data from the Ethereum Gravatar smart contract. Gravatar is a service where users can create and manage globally unique avatars.
30+
31+
9. **[Example Subgraph](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/example-subgraph)**
32+
This example shows the structure of a minimal,basic subgraph. It provides a generic setup with a simple contract and schema designed to teach the fundamentals of defining, mapping, and querying subgraph data.
33+
34+
10. **[Matic Lens Protocol Posts Subgraph](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/matic-lens-protocol-posts-subgraph)**
35+
This example demonstrates how to index data from the Lens Protocol deployed on the Polygon (Matic) network.
36+
37+
11. **[NEAR Blocks](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/near-blocks)**
38+
This example indexes blockchain data from the NEAR Protocol. It listens to block-related events and stores key data such as block number, timestamp, and hash in a queryable format.
39+
40+
12. **[NEAR Receipts](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/near-receipts)**
41+
This example indexes transaction receipts from the NEAR Protocol. It tracks and stores receipt data such as transaction hash, status, and execution details.
42+
43+
13. **[Substreams Powered Subgraph](https://github.com/graphprotocol/graph-tooling/tree/adding-table/examples/substreams-powered-subgraph)**
44+
This example is a basic Substreams-powered subgraph, which includes the Substreams definition. It tracks new contract deployments on Ethereum and demonstrates integration with Graph Node using `substreams_entity_change` types and helpers.
45+
46+
To learn more about subgraphs, review [subgraphs](https://thegraph.com/docs/en/subgraphs/developing/subgraphs/) on [The Graph docs](https://thegraph.com/docs/en/).

0 commit comments

Comments
 (0)