Skip to content

Commit 41e66f6

Browse files
benfaceyash251yash251
authored
[fix] cleanup (#665)
* [fix] cleanup * [fix] add requested changes # Conflicts: # website/pages/en/network/curating.mdx --------- Co-authored-by: yash251 <[email protected]> Co-authored-by: Yash Jagtap <[email protected]>
1 parent 43a87ab commit 41e66f6

18 files changed

+41
-41
lines changed

website/pages/en/arbitrum/arbitrum-faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ The bridge has been [heavily audited](https://code4rena.com/contests/2022-10-the
7575

7676
Adding GRT to your Arbitrum billing balance can be done with a one-click experience in [Subgraph Studio](https://thegraph.com/studio/). You'll be able to easily bridge your GRT to Arbitrum and fill your API keys in one transaction.
7777

78-
Visit the [Billing page](https://thegraph.com/docs/en/billing/) for more detailed instructions on adding, withdrawing, or acquiring GRT.
78+
Visit the [Billing page](/billing/) for more detailed instructions on adding, withdrawing, or acquiring GRT.

website/pages/en/cookbook/base-testnet.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Finally, you can deploy your subgraph using this command:
100100

101101
### 5. Query your subgraph
102102

103-
Once your subgraph is deployed, you can query it from your dapp using the `Development Query URL` in the Subgraph Studio.
103+
Once your subgraph is deployed, you can query it from your dapp using the `Development Query URL` in Subgraph Studio.
104104

105105
Note - Studio API is rate-limited. Hence should preferably be used for development and testing.
106106

website/pages/en/cookbook/grafting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The grafted subgraph can use a GraphQL schema that is not identical to the one o
2020

2121
For more information, you can check:
2222

23-
- [Grafting](https://thegraph.com/docs/en/developing/creating-a-subgraph#grafting-onto-existing-subgraphs)
23+
- [Grafting](/developing/creating-a-subgraph#grafting-onto-existing-subgraphs)
2424

2525
In this tutorial, we will be covering a basic usecase. We will replace an existing contract with an identical contract (with a new address, but the same code). Then, graft the existing subgraph onto the "base" subgraph that tracks the new contract.
2626

@@ -197,6 +197,6 @@ If you want more experience with grafting, here's a few examples for popular con
197197
- [ERC-721](https://github.com/messari/subgraphs/blob/master/subgraphs/erc721-metadata/subgraph.yaml)
198198
- [Uniswap](https://github.com/messari/subgraphs/blob/master/subgraphs/uniswap-v3-forks/protocols/uniswap-v3/config/templates/uniswapV3Template.yaml),
199199

200-
To become even more of a Graph expert, consider learning about other ways to handle changes in underlying datasources. Alternatives like [Data Source Templates](https://thegraph.com/docs/en/developing/creating-a-subgraph/#data-source-templates) can achieve similar results
200+
To become even more of a Graph expert, consider learning about other ways to handle changes in underlying datasources. Alternatives like [Data Source Templates](/developing/creating-a-subgraph/#data-source-templates) can achieve similar results
201201

202202
> Note: A lot of material from this article was taken from the previously published [Arweave article](/cookbook/arweave/)

website/pages/en/cookbook/substreams-powered-subgraphs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Substreams-powered subgraphs introduce a new `kind` of data source, "substreams"
159159

160160
This data source must specify the indexed network, the Substreams package (`spkg`) as a relative file location, and the module within that Substreams package which produces subgraph-compatible entity changes (in this case `map_entity_changes`, from the Substreams package above). The mapping is specified, but simply identifies the mapping kind ("substreams/graph-entities") and the apiVersion.
161161

162-
> Currently the Subgraph Studio and The Graph Network support Substreams-powered subgraphs which index `mainnet` (Mainnet Ethereum).
162+
> Currently, Subgraph Studio and The Graph Network support Substreams-powered subgraphs which index `mainnet` (Mainnet Ethereum).
163163
164164
```yaml
165165
specVersion: 0.0.4

website/pages/en/deploying/deploying-a-subgraph-to-hosted.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ After creating an account, navigate to your [dashboard](https://thegraph.com/hos
1616

1717
## Create a Subgraph on the hosted service
1818

19-
Before deploying the subgraph, you need to create it in The Graph Explorer. Go to the [dashboard](https://thegraph.com/hosted-service/dashboard) and click on the _'Add Subgraph'_ button and fill in the information below as appropriate:
19+
Before deploying the subgraph, you need to create it in Graph Explorer. Go to the [dashboard](https://thegraph.com/hosted-service/dashboard) and click on the _Add Subgraph_ button and fill in the information below as appropriate:
2020

2121
**Image** - Select an image to be used as a preview image and thumbnail for the subgraph.
2222

@@ -30,17 +30,17 @@ Before deploying the subgraph, you need to create it in The Graph Explorer. Go t
3030

3131
**GitHub URL** - Link to the subgraph repository on GitHub.
3232

33-
**Hide** - Switching this on hides the subgraph in the Graph Explorer.
33+
**Hide** - Switching this on hides the subgraph in Graph Explorer.
3434

3535
After saving the new subgraph, you are shown a screen with help on how to install the Graph CLI, how to generate the scaffolding for a new subgraph, and how to deploy your subgraph. The first two steps were covered in the [Creating a Subgraph section](/developing/creating-a-subgraph/).
3636

3737
## Deploy a Subgraph on the hosted service
3838

39-
Deploying your subgraph will upload the subgraph files that you've built with `yarn build` to IPFS and tell the Graph Explorer to start indexing your subgraph using these files.
39+
Deploying your subgraph will upload the subgraph files that you've built with `yarn build` to IPFS and tell Graph Explorer to start indexing your subgraph using these files.
4040

4141
You deploy the subgraph by running `yarn deploy`
4242

43-
After deploying the subgraph, the Graph Explorer will switch to showing the synchronization status of your subgraph. Depending on the amount of data and the number of events that need to be extracted from historical blocks, starting with the genesis block, syncing can take from a few minutes to several hours.
43+
After deploying the subgraph, Graph Explorer will switch to showing the synchronization status of your subgraph. Depending on the amount of data and the number of events that need to be extracted from historical blocks, starting with the genesis block, syncing can take from a few minutes to several hours.
4444

4545
The subgraph status switches to `Synced` once the Graph Node has extracted all data from historical blocks. The Graph Node will continue inspecting blocks for your subgraph as these blocks are mined.
4646

website/pages/en/deploying/subgraph-studio-faqs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ Note that you will no longer be able to see or edit the subgraph in Studio once
2626

2727
## 6. How do I find query URLs for subgraphs if I’m not the developer of the subgraph I want to use?
2828

29-
You can find the query URL of each subgraph in the Subgraph Details section of The Graph Explorer. When you click on the “Query” button, you will be directed to a pane wherein you can view the query URL of the subgraph you’re interested in. You can then replace the `<api_key>` placeholder with the API key you wish to leverage in Subgraph Studio.
29+
You can find the query URL of each subgraph in the Subgraph Details section of Graph Explorer. When you click on the “Query” button, you will be directed to a pane wherein you can view the query URL of the subgraph you’re interested in. You can then replace the `<api_key>` placeholder with the API key you wish to leverage in Subgraph Studio.
3030

3131
Remember that you can create an API key and query any subgraph published to the network, even if you build a subgraph yourself. These queries via the new API key, are paid queries as any other on the network.

website/pages/en/deploying/subgraph-studio.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Check out the video overview below as well:
6666

6767
<VideoEmbed youtube="satdwdbvzAQ" />
6868

69-
Remember, while you’re going through your publishing flow, you’ll be able to push to either Arbitrum One or Arbitrum Sepolia. If you’re a first-time subgraph developer, we highly suggest you start with publishing to Arbitrum Sepolia, which is free to do. This will allow you to see how the subgraph will work in The Graph Explorer and will allow you to test curation elements.
69+
Remember, while you’re going through your publishing flow, you’ll be able to push to either Arbitrum One or Arbitrum Sepolia. If you’re a first-time subgraph developer, we highly suggest you start with publishing to Arbitrum Sepolia, which is free to do. This will allow you to see how the subgraph will work in Graph Explorer and will allow you to test curation elements.
7070

7171
Indexers need to submit mandatory Proof of Indexing records as of a specific block hash. Because publishing a subgraph is an action taken on-chain, remember that the transaction can take up to a few minutes to go through. Any address you use to publish the contract will be the only one able to publish future versions. Choose wisely!
7272

@@ -76,9 +76,9 @@ Subgraphs with curation signal are shown to Indexers so that they can be indexed
7676

7777
## Versioning your Subgraph with the CLI
7878

79-
Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to The Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and Indexers will be able to index this new version.
79+
Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and Indexers will be able to index this new version.
8080

81-
Up until recently, developers were forced to deploy and publish a new version of their subgraph to the Explorer to update the metadata of their subgraphs. Now, developers can update the metadata of their subgraphs **without having to publish a new version**. Developers can update their subgraph details in the Studio (under the profile picture, name, description, etc) by checking an option called **Update Details** in The Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in the Explorer without having to publish a new version with a new deployment.
81+
Up until recently, developers were forced to deploy and publish a new version of their subgraph to the Explorer to update the metadata of their subgraphs. Now, developers can update the metadata of their subgraphs **without having to publish a new version**. Developers can update their subgraph details in the Studio (under the profile picture, name, description, etc) by checking an option called **Update Details** in Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in the Explorer without having to publish a new version with a new deployment.
8282

8383
Please note that there are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, developers must also fund a part of the curation tax on the auto-migrating signal. You cannot publish a new version of your subgraph if curators have not signaled on it. For more information on the risks of curation, please read more [here](/network/curating).
8484

website/pages/en/developing/creating-a-subgraph.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ yarn global add @graphprotocol/graph-cli
3636
npm install -g @graphprotocol/graph-cli
3737
```
3838

39-
Once installed, the `graph init` command can be used to set up a new subgraph project, either from an existing contract or from an example subgraph. This command can be used to create a subgraph on the Subgraph Studio by passing in `graph init --product subgraph-studio`. If you already have a smart contract deployed to your preferred network, bootstrapping a new subgraph from that contract can be a good way to get started.
39+
Once installed, the `graph init` command can be used to set up a new subgraph project, either from an existing contract or from an example subgraph. This command can be used to create a subgraph in Subgraph Studio by passing in `graph init --product subgraph-studio`. If you already have a smart contract deployed to your preferred network, bootstrapping a new subgraph from that contract can be a good way to get started.
4040

4141
## From An Existing Contract
4242

@@ -146,9 +146,9 @@ dataSources:
146146
147147
The important entries to update for the manifest are:
148148
149-
- `description`: a human-readable description of what the subgraph is. This description is displayed by the Graph Explorer when the subgraph is deployed to Subgraph Studio.
149+
- `description`: a human-readable description of what the subgraph is. This description is displayed in Graph Explorer when the subgraph is deployed to Subgraph Studio.
150150

151-
- `repository`: the URL of the repository where the subgraph manifest can be found. This is also displayed by The Graph Explorer.
151+
- `repository`: the URL of the repository where the subgraph manifest can be found. This is also displayed in Graph Explorer.
152152

153153
- `features`: a list of all used [feature](#experimental-features) names.
154154

@@ -600,7 +600,7 @@ import { Gravatar } from '../generated/schema'
600600

601601
> **Note:** The code generation must be performed again after every change to the GraphQL schema or the ABIs included in the manifest. It must also be performed at least once before building or deploying the subgraph.
602602
603-
Code generation does not check your mapping code in `src/mapping.ts`. If you want to check that before trying to deploy your subgraph to the Graph Explorer, you can run `yarn build` and fix any syntax errors that the TypeScript compiler might find.
603+
Code generation does not check your mapping code in `src/mapping.ts`. If you want to check that before trying to deploy your subgraph to Graph Explorer, you can run `yarn build` and fix any syntax errors that the TypeScript compiler might find.
604604

605605
## Data Source Templates
606606

website/pages/en/developing/developer-faqs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The Graph will never charge for the hosted service. The Graph is a decentralized
136136

137137
## 27. How do I update a subgraph on mainnet?
138138

139-
If you’re a subgraph developer, you can deploy a new version of your subgraph to the Subgraph Studio using the CLI. It’ll be private at that point, but if you’re happy with it, you can publish to the decentralized Graph Explorer. This will create a new version of your subgraph that Curators can start signaling on.
139+
If you’re a subgraph developer, you can deploy a new version of your subgraph to Subgraph Studio using the CLI. It’ll be private at that point, but if you’re happy with it, you can publish to the decentralized Graph Explorer. This will create a new version of your subgraph that Curators can start signaling on.
140140

141141
## 28. In what order are the event, block, and call handlers triggered for a data source?
142142

website/pages/en/developing/graph-ts/api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `@graphprotocol/graph-ts` library provides the following APIs:
1717

1818
- An `ethereum` API for working with Ethereum smart contracts, events, blocks, transactions, and Ethereum values.
1919
- A `store` API to load and save entities from and to the Graph Node store.
20-
- A `log` API to log messages to the Graph Node output and the Graph Explorer.
20+
- A `log` API to log messages to the Graph Node output and Graph Explorer.
2121
- An `ipfs` API to load files from IPFS.
2222
- A `json` API to parse JSON data.
2323
- A `crypto` API to use cryptographic functions.
@@ -567,7 +567,7 @@ let isContract = ethereum.hasCode(eoa).inner // returns false
567567
import { log } from '@graphprotocol/graph-ts'
568568
```
569569

570-
The `log` API allows subgraphs to log information to the Graph Node standard output as well as the Graph Explorer. Messages can be logged using different log levels. A basic format string syntax is provided to compose log messages from argument.
570+
The `log` API allows subgraphs to log information to the Graph Node standard output as well as Graph Explorer. Messages can be logged using different log levels. A basic format string syntax is provided to compose log messages from argument.
571571

572572
The `log` API includes the following functions:
573573

0 commit comments

Comments
 (0)