Skip to content

Commit ece1ea8

Browse files
authored
update Spec and Api versions + typos (#894)
* update Spec and Api versions * fix: commit requested change * fix: add style
1 parent f327971 commit ece1ea8

File tree

16 files changed

+43
-42
lines changed

16 files changed

+43
-42
lines changed

website/src/pages/en/indexing/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The `queryFeeCut` and `indexingRewardCut` values are delegation parameters that
9595

9696
Indexers may differentiate themselves by applying advanced techniques for making Subgraph indexing decisions but to give a general idea we'll discuss several key metrics used to evaluate Subgraphs in the network:
9797

98-
- **Curation signal** - The proportion of network curation signal applied to a particular Subgraph is a good indicator of the interest in that Subgraph, especially during the bootstrap phase when query voluming is ramping up.
98+
- **Curation signal** - The proportion of network curation signal applied to a particular Subgraph is a good indicator of the interest in that Subgraph, especially during the bootstrap phase when query volume is ramping up.
9999

100100
- **Query fees collected** - The historical data for volume of query fees collected for a specific Subgraph is a good indicator of future demand.
101101

@@ -784,7 +784,7 @@ Once an Indexer has staked GRT in the protocol, the [Indexer components](/indexi
784784

785785
7. (Optional) Indexers may approve another address to be the operator for their Indexer infrastructure in order to separate the keys that control the funds from those that are performing day to day actions such as allocating on Subgraphs and serving (paid) queries. In order to set the operator call `setOperator()` with the operator address.
786786

787-
8. (Optional) In order to control the distribution of rewards and strategically attract Delegators Indexers can update their delegation parameters by updating their indexingRewardCut (parts per million), queryFeeCut (parts per million), and cooldownBlocks (number of blocks). To do so call `setDelegationParameters()`. The following example sets the queryFeeCut to distribute 95% of query rebates to the Indexer and 5% to Delegators, set the indexingRewardCutto distribute 60% of indexing rewards to the Indexer and 40% to Delegators, and set `thecooldownBlocks` period to 500 blocks.
787+
8. (Optional) In order to control the distribution of rewards and strategically attract Delegators Indexers can update their delegation parameters by updating their `indexingRewardCut` (parts per million), `queryFeeCut` (parts per million), and `cooldownBlocks` (number of blocks). To do so call `setDelegationParameters()`. The following example sets the `queryFeeCut` to distribute 95% of query rebates to the Indexer and 5% to Delegators, set the `indexingRewardCut` to distribute 60% of indexing rewards to the Indexer and 40% to Delegators, and set the `cooldownBlocks` period to 500 blocks.
788788

789789
```
790790
setDelegationParameters(950000, 600000, 500)

website/src/pages/en/indexing/supported-network-requirements.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Supported Network Requirements
66
| --- | --- | --- | :-: |
77
| Arbitrum | [Baremetal Guide](https://docs.infradao.com/archive-nodes-101/arbitrum/baremetal)<br /> [Docker Guide](https://docs.infradao.com/archive-nodes-101/arbitrum/docker) | 4+ core CPU<br /> Ubuntu 22.04<br /> 16GB+ RAM<br /> >= 8 TiB NVMe SSD<br /> _last updated August 2023_ ||
88
| Avalanche | [Docker Guide](https://docs.infradao.com/archive-nodes-101/avalanche/docker) | 4 core / 8 threads CPU<br /> Ubuntu 22.04<br /> 16GB+ RAM<br /> >= 5 TiB NVMe SSD<br /> _last updated August 2023_ ||
9-
| Base | [Erigon Baremetal Guide](https://docs.infradao.com/archive-nodes-101/base/erigon/baremetal)<br /><br /> [GETH Baremetal Guide](https://docs.infradao.com/archive-nodes-101/base/geth/baremetal)<br /> [GETH Docker Guide](https://docs.infradao.com/archive-nodes-101/base/geth/docker) | 8+ core CPU<br /> Debian 12/Ubuntu 22.04<br /> 16 GB RAM<br /> >= 4.5TB (NVME preffered)<br /> _last updated 14th May 2024_ ||
9+
| Base | [Erigon Baremetal Guide](https://docs.infradao.com/archive-nodes-101/base/erigon/baremetal)<br /><br /> [GETH Baremetal Guide](https://docs.infradao.com/archive-nodes-101/base/geth/baremetal)<br /> [GETH Docker Guide](https://docs.infradao.com/archive-nodes-101/base/geth/docker) | 8+ core CPU<br /> Debian 12/Ubuntu 22.04<br /> 16 GB RAM<br /> >= 4.5TB (NVME preferred)<br /> _last updated 14th May 2024_ ||
1010
| Binance | [Erigon Baremetal Guide](https://docs.infradao.com/archive-nodes-101/binance/erigon/baremetal) | 8 core / 16 threads CPU<br /> Ubuntu 22.04<br /> >=32 GB RAM<br /> >= 14 TiB NVMe SSD<br /> _last updated 22nd June 2024_ ||
1111
| Celo | [Docker Guide](https://docs.infradao.com/archive-nodes-101/celo/docker) | 4 core / 8 threads CPU<br /> Ubuntu 22.04<br /> 16GB+ RAM<br /> >= 2 TiB NVMe SSD<br /> _last updated August 2023_ ||
1212
| Ethereum | [Docker Guide](https://docs.infradao.com/archive-nodes-101/ethereum/erigon/docker) | Higher clock speed over core count<br /> Ubuntu 22.04<br /> 16GB+ RAM<br /> >=3TB (NVMe recommended)<br /> _last updated August 2023_ ||

website/src/pages/en/resources/migration-guides/assemblyscript-migration-guide.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ This guide is applicable for anyone using `graph-cli`/`graph-ts` below version `
4444

4545
## How to upgrade?
4646

47-
1. Change your mappings `apiVersion` in `subgraph.yaml` to `0.0.6`:
47+
1. Change your mappings `apiVersion` in `subgraph.yaml` to `0.0.9`:
4848

4949
```yaml
5050
...
5151
dataSources:
5252
...
5353
mapping:
5454
...
55-
apiVersion: 0.0.6
55+
apiVersion: 0.0.9
5656
...
5757
```
5858

website/src/pages/en/sps/tutorial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ dataSources:
7272
moduleName: map_spl_transfers # Module defined in the substreams.yaml
7373
file: ./my-project-sol-v0.1.0.spkg
7474
mapping:
75-
apiVersion: 0.0.7
75+
apiVersion: 0.0.9
7676
kind: substreams/graph-entities
7777
file: ./src/mappings.ts
7878
handler: handleTriggers

website/src/pages/en/subgraphs/best-practices/grafting-hotfix.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Suppose you have a Subgraph tracking a smart contract that has stopped indexing
6262
1. **Failed Subgraph Manifest (subgraph.yaml)**
6363

6464
```yaml
65-
specVersion: 1.0.0
65+
specVersion: 1.3.0
6666
schema:
6767
file: ./schema.graphql
6868
dataSources:
@@ -75,7 +75,7 @@ Suppose you have a Subgraph tracking a smart contract that has stopped indexing
7575
startBlock: 5000000
7676
mapping:
7777
kind: ethereum/events
78-
apiVersion: 0.0.7
78+
apiVersion: 0.0.9
7979
language: wasm/assemblyscript
8080
entities:
8181
- Withdrawal
@@ -90,7 +90,7 @@ Suppose you have a Subgraph tracking a smart contract that has stopped indexing
9090
9191
2. **New Grafted Subgraph Manifest (subgraph.yaml)**
9292
```yaml
93-
specVersion: 1.0.0
93+
specVersion: 1.3.0
9494
schema:
9595
file: ./schema.graphql
9696
dataSources:
@@ -103,7 +103,7 @@ Suppose you have a Subgraph tracking a smart contract that has stopped indexing
103103
startBlock: 6000001 # Block after the last indexed block
104104
mapping:
105105
kind: ethereum/events
106-
apiVersion: 0.0.7
106+
apiVersion: 0.0.9
107107
language: wasm/assemblyscript
108108
entities:
109109
- Withdrawal

website/src/pages/en/subgraphs/best-practices/pruning.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Add a section called `indexerHints` in the manifest.
2020
We can add `indexerHints` to our Subgraphs by updating our `subgraph.yaml`:
2121

2222
```yaml
23-
specVersion: 1.0.0
23+
specVersion: 1.3.0
2424
schema:
2525
file: ./schema.graphql
2626
indexerHints:

website/src/pages/en/subgraphs/cookbook/arweave.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ $ graph build # generates Web Assembly from the AssemblyScript files, and prepar
5858
The Subgraph manifest `subgraph.yaml` identifies the data sources for the Subgraph, the triggers of interest, and the functions that should be run in response to those triggers. See below for an example Subgraph manifest for an Arweave Subgraph:
5959

6060
```yaml
61-
specVersion: 0.0.5
61+
specVersion: 1.3.0
6262
description: Arweave Blocks Indexing
6363
schema:
6464
file: ./schema.graphql # link to the schema file
@@ -70,7 +70,7 @@ dataSources:
7070
owner: 'ID-OF-AN-OWNER' # The public key of an Arweave wallet
7171
startBlock: 0 # set this to 0 to start indexing from chain genesis
7272
mapping:
73-
apiVersion: 0.0.5
73+
apiVersion: 0.0.9
7474
language: wasm/assemblyscript
7575
file: ./src/blocks.ts # link to the file with the Assemblyscript mappings
7676
entities:

website/src/pages/en/subgraphs/cookbook/grafting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Building Subgraphs is an essential part of The Graph, described more in depth [h
5353
The Subgraph manifest `subgraph.yaml` identifies the data sources for the Subgraph, the triggers of interest, and the functions that should be run in response to those triggers. See below for an example Subgraph manifest that you will use:
5454

5555
```yaml
56-
specVersion: 0.0.4
56+
specVersion: 1.3.0
5757
schema:
5858
file: ./schema.graphql
5959
dataSources:
@@ -66,7 +66,7 @@ dataSources:
6666
startBlock: 5955690
6767
mapping:
6868
kind: ethereum/events
69-
apiVersion: 0.0.6
69+
apiVersion: 0.0.9
7070
language: wasm/assemblyscript
7171
entities:
7272
- Withdrawal

website/src/pages/en/subgraphs/cookbook/near.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $ graph build # generates Web Assembly from the AssemblyScript files, and prepar
5151
The Subgraph manifest (`subgraph.yaml`) identifies the data sources for the Subgraph, the triggers of interest, and the functions that should be run in response to those triggers. See below for an example Subgraph manifest for a NEAR Subgraph:
5252

5353
```yaml
54-
specVersion: 0.0.2
54+
specVersion: 1.3.0
5555
schema:
5656
file: ./src/schema.graphql # link to the schema file
5757
dataSources:
@@ -61,7 +61,7 @@ dataSources:
6161
account: app.good-morning.near # This data source will monitor this account
6262
startBlock: 10662188 # Required for NEAR
6363
mapping:
64-
apiVersion: 0.0.5
64+
apiVersion: 0.0.9
6565
language: wasm/assemblyscript
6666
blockHandlers:
6767
- handler: handleNewBlock # the function name in the mapping file

website/src/pages/en/subgraphs/cookbook/transfer-to-the-graph.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Tranfer to The Graph
2+
title: Transfer to The Graph
33
---
44

55
Quickly upgrade your Subgraphs from any platform to [The Graph's decentralized network](https://thegraph.com/networks/).

website/src/pages/en/subgraphs/developing/creating/advanced.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Starting from `specVersion` `0.0.4`, Subgraph features must be explicitly declar
1717
For instance, if a Subgraph uses the **Full-Text Search** and the **Non-fatal Errors** features, the `features` field in the manifest should be:
1818

1919
```yaml
20-
specVersion: 0.0.4
20+
specVersion: 1.3.0
2121
description: Gravatar for Ethereum
2222
features:
2323
- fullTextSearch
@@ -104,7 +104,7 @@ Indexing errors on already synced Subgraphs will, by default, cause the Subgraph
104104
Enabling non-fatal errors requires setting the following feature flag on the Subgraph manifest:
105105

106106
```yaml
107-
specVersion: 0.0.4
107+
specVersion: 1.3.0
108108
description: Gravatar for Ethereum
109109
features:
110110
- nonFatalErrors
@@ -221,7 +221,7 @@ templates:
221221
- name: TokenMetadata
222222
kind: file/ipfs
223223
mapping:
224-
apiVersion: 0.0.7
224+
apiVersion: 0.0.9
225225
language: wasm/assemblyscript
226226
file: ./src/mapping.ts
227227
handler: handleMetadata

website/src/pages/en/subgraphs/developing/creating/subgraph-manifest.mdx

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The full specification for Subgraph manifests can be found [here](https://github
2929
For the example Subgraph listed above, `subgraph.yaml` is:
3030

3131
```yaml
32-
specVersion: 0.0.4
32+
specVersion: 1.3.0
3333
description: Gravatar for Ethereum
3434
repository: https://github.com/graphprotocol/graph-tooling
3535
schema:
@@ -54,7 +54,7 @@ dataSources:
5454
data: 'bar'
5555
mapping:
5656
kind: ethereum/events
57-
apiVersion: 0.0.6
57+
apiVersion: 0.0.9
5858
language: wasm/assemblyscript
5959
entities:
6060
- Gravatar
@@ -83,7 +83,7 @@ dataSources:
8383
8484
The important entries to update for the manifest are:
8585
86-
- `specVersion`: a semver version that identifies the supported manifest structure and functionality for the Subgraph. The latest version is `1.2.0`. See [specVersion releases](#specversion-releases) section to see more details on features & releases.
86+
- `specVersion`: a semver version that identifies the supported manifest structure and functionality for the Subgraph. The latest version is `1.3.0`. See [specVersion releases](#specversion-releases) section to see more details on features & releases.
8787

8888
- `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.
8989

@@ -131,7 +131,7 @@ dataSources:
131131
abi: Gravity
132132
mapping:
133133
kind: ethereum/events
134-
apiVersion: 0.0.6
134+
apiVersion: 0.0.9
135135
language: wasm/assemblyscript
136136
entities:
137137
- Gravatar
@@ -169,7 +169,7 @@ dataSources:
169169
abi: Gravity
170170
mapping:
171171
kind: ethereum/events
172-
apiVersion: 0.0.6
172+
apiVersion: 0.0.9
173173
language: wasm/assemblyscript
174174
entities:
175175
- Gravatar
@@ -232,7 +232,7 @@ dataSources:
232232
abi: Gravity
233233
mapping:
234234
kind: ethereum/events
235-
apiVersion: 0.0.6
235+
apiVersion: 0.0.9
236236
language: wasm/assemblyscript
237237
entities:
238238
- Gravatar
@@ -360,7 +360,7 @@ dataSources:
360360
abi: Factory
361361
mapping:
362362
kind: ethereum/events
363-
apiVersion: 0.0.6
363+
apiVersion: 0.0.9
364364
language: wasm/assemblyscript
365365
file: ./src/mappings/factory.ts
366366
entities:
@@ -390,7 +390,7 @@ templates:
390390
abi: Exchange
391391
mapping:
392392
kind: ethereum/events
393-
apiVersion: 0.0.6
393+
apiVersion: 0.0.9
394394
language: wasm/assemblyscript
395395
file: ./src/mappings/exchange.ts
396396
entities:
@@ -467,7 +467,7 @@ dataSources:
467467
startBlock: 6627917
468468
mapping:
469469
kind: ethereum/events
470-
apiVersion: 0.0.6
470+
apiVersion: 0.0.9
471471
language: wasm/assemblyscript
472472
file: ./src/mappings/factory.ts
473473
entities:
@@ -537,12 +537,13 @@ indexerHints:
537537

538538
| Version | Release notes |
539539
| :-: | --- |
540-
| 1.2.0 | Added support for [Indexed Argument Filtering](/#indexed-argument-filters--topic-filters) & declared `eth_call` |
541-
| 1.1.0 | Supports [Timeseries & Aggregations](#timeseries-and-aggregations). Added support for type `Int8` for `id`. |
542-
| 1.0.0 | Supports [`indexerHints`](/developing/creating-a-subgraph/#indexer-hints) feature to prune Subgraphs |
540+
| 1.3.0 | Added support for [Subgraph Composition](/cookbook/subgraph-composition-three-sources) |
541+
| 1.2.0 | Added support for [Indexed Argument Filtering](/developing/creating/advanced/#indexed-argument-filters--topic-filters) & declared `eth_call` |
542+
| 1.1.0 | Supports [Timeseries & Aggregations](/developing/creating/advanced/#timeseries-and-aggregations). Added support for type `Int8` for `id`. |
543+
| 1.0.0 | Supports [`indexerHints`](/developing/creating/subgraph-manifest/#indexer-hints) feature to prune Subgraphs |
543544
| 0.0.9 | Supports `endBlock` feature |
544-
| 0.0.8 | Added support for polling [Block Handlers](/developing/creating-a-subgraph/#polling-filter) and [Initialisation Handlers](/developing/creating-a-subgraph/#once-filter). |
545-
| 0.0.7 | Added support for [File Data Sources](/developing/creating-a-subgraph/#file-data-sources). |
545+
| 0.0.8 | Added support for polling [Block Handlers](/developing/creating/subgraph-manifest/#polling-filter) and [Initialisation Handlers](/developing/creating/subgraph-manifest/#once-filter). |
546+
| 0.0.7 | Added support for [File Data Sources](/developing/creating/advanced/#ipfsarweave-file-data-sources). |
546547
| 0.0.6 | Supports fast [Proof of Indexing](/indexing/overview/#what-is-a-proof-of-indexing-poi) calculation variant. |
547548
| 0.0.5 | Added support for event handlers having access to transaction receipts. |
548549
| 0.0.4 | Added support for managing subgraph features. |

website/src/pages/en/subgraphs/developing/creating/unit-testing-framework.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Also you can check out the video series on ["How to use Matchstick to write unit
155155
156156
## Tests structure
157157
158-
_**IMPORTANT: The test structure described below depens on `matchstick-as` version >=0.5.0**_
158+
_**IMPORTANT: The test structure described below depends on `matchstick-as` version >=0.5.0**_
159159

160160
### describe()
161161

@@ -756,7 +756,7 @@ createMockedFunction(contractAddress, 'getGravatar', 'getGravatar(address):(stri
756756

757757
Users can mock IPFS files by using `mockIpfsFile(hash, filePath)` function. The function accepts two arguments, the first one is the IPFS file hash/path and the second one is the path to a local file.
758758

759-
NOTE: When testing `ipfs.map/ipfs.mapJSON`, the callback function must be exported from the test file in order for matchstck to detect it, like the `processGravatar()` function in the test example bellow:
759+
NOTE: When testing `ipfs.map/ipfs.mapJSON`, the callback function must be exported from the test file in order for matchstick to detect it, like the `processGravatar()` function in the test example bellow:
760760

761761
`.test.ts` file:
762762

@@ -765,7 +765,7 @@ import { assert, test, mockIpfsFile } from 'matchstick-as/assembly/index'
765765
import { ipfs } from '@graphprotocol/graph-ts'
766766
import { gravatarFromIpfs } from './utils'
767767

768-
// Export ipfs.map() callback in order for matchstck to detect it
768+
// Export ipfs.map() callback in order for matchstick to detect it
769769
export { processGravatar } from './utils'
770770

771771
test('ipfs.cat', () => {
@@ -1172,7 +1172,7 @@ templates:
11721172
network: mainnet
11731173
mapping:
11741174
kind: ethereum/events
1175-
apiVersion: 0.0.6
1175+
apiVersion: 0.0.9
11761176
language: wasm/assemblyscript
11771177
file: ./src/token-lock-wallet.ts
11781178
handler: handleMetadata

website/src/pages/en/subgraphs/querying/graph-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ All `fetch` strategies can be combined to create the ultimate execution flow.
235235

236236
The `retry` mechanism allow you to specify the retry attempts for a single GraphQL endpoint/source.
237237

238-
The retry flow will execute in both conditions: a netword error, or due to a runtime error (indexing issue/inavailability of the indexer).
238+
The retry flow will execute in both conditions: a network error, or due to a runtime error (indexing issue/unavailability of the indexer).
239239

240240
```yaml
241241
sources:

website/src/pages/en/subgraphs/querying/graph-client/live.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ query ExampleQuery @live(interval: 5000) {
3838

3939
## Integrations
4040

41-
Since the entire network layer (along with the `@live` mechanism) is implemented inside `graph-client` core, you can use Live queries with every GraphQL client (such as Urql or Apollo-Client), as long as it supports streame responses (`AsyncIterable`).
41+
Since the entire network layer (along with the `@live` mechanism) is implemented inside `graph-client` core, you can use Live queries with every GraphQL client (such as Urql or Apollo-Client), as long as it supports stream responses (`AsyncIterable`).
4242

4343
No additional setup is required for GraphQL clients cache updates.

website/src/pages/en/substreams/publishing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ A Substreams package is a precompiled binary file that defines the specific data
4444

4545
![confirm](/img/4_confirm.png)
4646

47-
That's it! You have succesfully published a package in the Substreams registry.
47+
That's it! You have successfully published a package in the Substreams registry.
4848

4949
![success](/img/5_success.png)
5050

0 commit comments

Comments
 (0)