Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update glossary.mdx #552

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update glossary.mdx #552

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
805e78a
Update glossary.mdx
wise4rmgod Dec 4, 2023
cf98774
Update glossary.mdx
wise4rmgod Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions website/pages/en/glossary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@ title: Glossary

- **The Graph**: A decentralized protocol for indexing and querying data.

- **Query**: A request for data. In the case of The Graph, a query is a request for data from a subgraph that will be answered by an Indexer.
- **Query**: A request for data. In the case of The Graph, a query is a request for data from a subgraph that an Indexer will answer.

- **GraphQL**: A query language for APIs and a runtime for fulfilling those queries with your existing data. The Graph uses GraphQL to query subgraphs.

- **Endpoint**: A URL that can be used to query a subgraph. The testing endpoint for Subgraph Studio is `https://api.studio.thegraph.com/query/<ID>/<SUBGRAPH_NAME>/<VERSION>` and the Graph Explorer endpoint is `https://gateway.thegraph.com/api/<API_KEY>/subgraphs/id/<SUBGRAPH_ID>`. The Graph Explorer endpoint is used to query subgraphs on The Graph's decentralized network.
- **Endpoint**: A URL that can query a subgraph. The testing endpoint for Subgraph Studio is `https://api.studio.thegraph.com/query/<ID>/<SUBGRAPH_NAME>/<VERSION>` and the Graph Explorer endpoint is `https://gateway.thegraph.com/api/<API_KEY>/subgraphs/id/<SUBGRAPH_ID>`. The Graph Explorer endpoint is used to query subgraphs on The Graph's decentralized network.

- **Subgraph**: A custom API built on blockchain data that can be queried using [GraphQL](https://graphql.org/). Developers can build, deploy and publish subgraphs to The Graph's decentralized network. Then, Indexers can begin indexing subgraphs to make them available to be queried by subgraph consumers.
- **Firehose**: A versatile and scalable blockchain data processing solution that makes it easy to process and analyze data from any blockchain, regardless of its protocol or implementation. Specific Firehose instrumentation is required for each blockchain protocol.

- **Hosted service**: A temporary scaffold service for building and querying subgraphs as The Graph's decentralized network is maturing its cost of service, quality of service, and developer experience.
- **Substreams**: Allows developers to define the data Firehose should retrieve from the blockchain and apply transformations to it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this definition is missing a noun, i.e. what is it exactly, not just what it allows?


- **Substreams-powered subgraph**: Enables subgraph developers to leverage Substreams' high indexing speed and additional data by using Substreams modules as data sources.

- **Subgraph**: A custom API built on blockchain data that can be queried using [GraphQL](https://graphql.org/). Developers can build, deploy, and publish subgraphs to The Graph's decentralized network. Then, Indexers can begin indexing subgraphs to make them available to be queried by subgraph consumers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Subgraph should at least be above Substreams-powered subgraph, but probably above Firehose and Substreams as well, right?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initially, I wanted to make this page Alphabetical; if that were in line, I would fix it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's a good idea. @MichaelMacaulay, what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great idea, go for it!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will start working on it, thanks.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have worked on the Alphabetical task; kindly review it.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MichaelMacaulay I am waiting for your feedback on this task.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benface Any update on this task?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wise4rmgod – Can you please fix the conflicts and I'll review this again?


- **Hosted service**: A temporary scaffold service for building and querying subgraphs as The Graph's decentralized network matures its service cost, quality of service, and developer experience.

- **Indexers**: Network participants that run indexing nodes to index data from blockchains and serve GraphQL queries.

Expand Down