Skip to content

Commit d4f9439

Browse files
committed
add redirects
- fix per comment
1 parent d0cdfc3 commit d4f9439

File tree

24 files changed

+137
-73
lines changed

24 files changed

+137
-73
lines changed

docs/.vuepress/config.ts

Lines changed: 54 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -203,36 +203,66 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
203203
"/subquery_network/governance/foundation.html",
204204
"/indexer/run_publish/publish.html":
205205
"/indexer/run_publish/introduction.html",
206-
// EVM network mapping redirects to consolidated ethereum.md
207-
"/indexer/build/mapping/avalanche.html":
208-
"/indexer/build/mapping/ethereum.html",
209-
"/indexer/build/mapping/arbitrum.html":
210-
"/indexer/build/mapping/ethereum.html",
211-
"/indexer/build/mapping/bsc.html":
212-
"/indexer/build/mapping/ethereum.html",
213-
"/indexer/build/mapping/flare.html":
214-
"/indexer/build/mapping/ethereum.html",
215-
"/indexer/build/mapping/gnosis.html":
216-
"/indexer/build/mapping/ethereum.html",
217-
"/indexer/build/mapping/optimism.html":
218-
"/indexer/build/mapping/ethereum.html",
219-
"/indexer/build/mapping/polygon.html":
220-
"/indexer/build/mapping/ethereum.html",
221-
// EVM network manifest redirects to consolidated ethereum.md
222-
"/indexer/build/manifest/avalanche.html":
223-
"/indexer/build/manifest/ethereum.html",
206+
207+
// Restructured SDK build redirects
208+
"/indexer/build/cosmos-evm.html":
209+
"/indexer/build/datasource-processors/cosmos-evm.html",
210+
"/indexer/build/substrate-evm.html":
211+
"/indexer/build/datasource-processors/substrate-evm.html",
212+
"/indexer/build/substrate-wasm.html":
213+
"/indexer/build/datasource-processors/substrate-wasm.html",
214+
"/indexer/build/dynamicdatasources.html":
215+
"/indexer/build/dynamic-datasources.html",
216+
"/indexer/build/graphql.html":
217+
"/indexer/build/graphql/reference.html",
218+
219+
// Manifest redirects to introduction
220+
"/indexer/build/manifest/algorand.html":
221+
"/indexer/build/manifest/chain-specific/algorand.html",
224222
"/indexer/build/manifest/arbitrum.html":
225-
"/indexer/build/manifest/ethereum.html",
223+
"/indexer/build/manifest/chain-specific/ethereum.html",
224+
"/indexer/build/manifest/avalanche.html":
225+
"/indexer/build/manifest/chain-specific/ethereum.html",
226226
"/indexer/build/manifest/bsc.html":
227-
"/indexer/build/manifest/ethereum.html",
227+
"/indexer/build/manifest/chain-specific/ethereum.html",
228+
"/indexer/build/manifest/concordium.html":
229+
"/indexer/build/manifest/chain-specific/concordium.html",
230+
"/indexer/build/manifest/cosmos.html":
231+
"/indexer/build/manifest/chain-specific/cosmos.html",
228232
"/indexer/build/manifest/flare.html":
229-
"/indexer/build/manifest/ethereum.html",
233+
"/indexer/build/manifest/chain-specific/ethereum.html",
230234
"/indexer/build/manifest/gnosis.html":
231-
"/indexer/build/manifest/ethereum.html",
235+
"/indexer/build/manifest/chain-specific/ethereum.html",
236+
"/indexer/build/manifest/near.html":
237+
"/indexer/build/manifest/chain-specific/near.html",
232238
"/indexer/build/manifest/optimism.html":
233-
"/indexer/build/manifest/ethereum.html",
239+
"/indexer/build/manifest/chain-specific/ethereum.html",
240+
"/indexer/build/manifest/polkadot.html":
241+
"/indexer/build/manifest/chain-specific/polkadot.html",
234242
"/indexer/build/manifest/polygon.html":
235-
"/indexer/build/manifest/ethereum.html",
243+
"/indexer/build/manifest/chain-specific/ethereum.html",
244+
"/indexer/build/manifest/solana.html":
245+
"/indexer/build/manifest/chain-specific/solana.html",
246+
"/indexer/build/manifest/starknet.html":
247+
"/indexer/build/manifest/chain-specific/starknet.html",
248+
"/indexer/build/manifest/stellar.html":
249+
"/indexer/build/manifest/chain-specific/stellar.html",
250+
251+
// Mapping redirects to new structure
252+
"/indexer/build/mapping/arbitrum.html":
253+
"/indexer/build/mapping-functions/mapping/ethereum.html",
254+
"/indexer/build/mapping/avalanche.html":
255+
"/indexer/build/mapping-functions/mapping/ethereum.html",
256+
"/indexer/build/mapping/bsc.html":
257+
"/indexer/build/mapping-functions/mapping/ethereum.html",
258+
"/indexer/build/mapping/flare.html":
259+
"/indexer/build/mapping-functions/mapping/ethereum.html",
260+
"/indexer/build/mapping/gnosis.html":
261+
"/indexer/build/mapping-functions/mapping/ethereum.html",
262+
"/indexer/build/mapping/optimism.html":
263+
"/indexer/build/mapping-functions/mapping/ethereum.html",
264+
"/indexer/build/mapping/polygon.html":
265+
"/indexer/build/mapping-functions/mapping/ethereum.html",
236266
};
237267
return {
238268
...redirects,

docs/indexer/build/datasource-processors/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Intrtoduction
1+
# Introduction
22

33
Many blockchains have different VMs or runtimes that allow execution of smart contracts. Some of these are wide spread such as EVM, while others are more niche such as WASM. To make it easier to index these runtimes we have created a number of datasource processors that can be used in your SubQuery project.
44
These processors make it easier to filter and extract the data from these runtimes.
55

66
We have a number of processors available in the [datasource-processors repository](https://github.com/subquery/datasource-processors). There is specific documentation for the following processors:
7-
* [Substrate EVM]('./substrate-evm.md') - Also know as Frontier EVM
8-
* [Substrate Wasm]('./substrate-wasm.md')
9-
* [Cosmos EVM]('./cosmos-evm.md')
7+
* [Substrate EVM](./substrate-evm.md) - Also known as Frontier EVM
8+
* [Substrate Wasm](./substrate-wasm.md)
9+
* [Cosmos EVM](./cosmos-evm.md)
1010

1111
::: note
1212
These processors are good when you need data from within the runtime as well as data from the base chain. If you just need EVM data you can use the Ethereum SDK for more features, better performance and easier development.

docs/indexer/build/manifest/chain-specific/algorand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
AlgorandProject,
1212
} from "@subql/types-algorand";
1313

14-
// Can expand the Datasource processor types via the genreic param
14+
// Can expand the Datasource processor types via the generic param
1515
const project: AlgorandProject = {
1616
specVersion: "1.0.0",
1717
name: "algorand-subql-starter",

docs/indexer/build/manifest/chain-specific/concordium.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Concordium Manifest File
22

3-
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Algorand, please refer to the [top level manifest documentation](../introduction.md) for more general details.
3+
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. The following details are for Concordium, please refer to the [top-level manifest documentation](../introduction.md) for more general details.
44

55
Below is a standard example of a basic Concordium `project.ts`.
66

@@ -130,10 +130,10 @@ The following table explains filters supported by different handlers.
130130

131131
| Handler | Supported filter |
132132
| -------------------------------------------------------------------------------------------- | ---------------- |
133-
| [ConcordiumHandlerKind.Block](../../mapping/concordium#block-handler) | `modulo`, `timestamp` |
134-
| [ConcordiumHandlerKind.Transaction](../../mapping/concordium#transaction-handler) | `type`, `values` |
135-
| [ConcordiumHandlerKind.TransactionEvent](../../mapping/concordium#transaction-event-handler) | `type`, `values` |
136-
| [ConcordiumHandlerKind.SpecialEvent](../../mapping/concordium#special-event-handler) | `type`, `values` |
133+
| [ConcordiumHandlerKind.Block](../../mapping-functions/mapping/concordium#block-handler) | `modulo`, `timestamp` |
134+
| [ConcordiumHandlerKind.Transaction](../../mapping-functions/mapping/concordium#transaction-handler) | `type`, `values` |
135+
| [ConcordiumHandlerKind.TransactionEvent](../../mapping-functions/mapping/concordium#transaction-event-handler) | `type`, `values` |
136+
| [ConcordiumHandlerKind.SpecialEvent](../../mapping-functions/mapping/concordium#special-event-handler) | `type`, `values` |
137137

138138
`type` is type of transaction, transaction event, or special event to filter by (case sensitive). The `values` filter is a map where the keys correspond to the keys found in a transaction, transaction event, or special event. This filter allows you to search for transactions or events that have specific values for these keys. The `values` filter matches the keys in the filter against the keys in the data object. If a match is found, the corresponding transaction, event, or special event is included in the query result. For example:
139139

docs/indexer/build/manifest/chain-specific/cosmos.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
CosmosProject,
1212
} from "@subql/types-cosmos";
1313

14-
// Can expand the Datasource processor types via the genreic param
14+
// Can expand the Datasource processor types via the generic param
1515
const project: CosmosProject = {
1616
specVersion: "1.0.0",
1717
version: "0.0.1",
@@ -145,7 +145,7 @@ dataSources:
145145

146146
:::
147147

148-
### Tested and Supported networks
148+
## Tested and Supported networks
149149

150150
We expect that SubQuery will work with all Ethermint and CosmWasm Cosmos chains with the import of the correct protobuf definitions. We have tested this with the [chains in the cosmos-subql-starter repository](https://github.com/subquery/cosmos-subql-starter). However, please feel free to make a pull request to non-supported chains when you are able to test and confirm them.
151151

docs/indexer/build/manifest/chain-specific/ethereum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# EVM Manifest File
2-
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Algorand, please refer to the [top level manifest documentation](../introduction.md) for more general details.
2+
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Ethereum and other EVM-compatible chains, please refer to the [top level manifest documentation](../introduction.md) for more general details.
33

44
Below is a standard example of a basic EVM `project.ts`.
55

docs/indexer/build/manifest/chain-specific/near.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NEAR Manifest File
22

3-
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Algorand, please refer to the [top level manifest documentation](../introduction.md) for more general details.
3+
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for NEAR, please refer to the [top level manifest documentation](../introduction.md) for more general details.
44

55
Below is a standard example of a basic Near `project.ts`.
66

docs/indexer/build/manifest/chain-specific/polkadot.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Polkadot/Substrate Manifest File
22

3-
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Algorand, please refer to the [top level manifest documentation](../introduction.md) for more general details.
3+
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the Polkadot chain data. Please refer to the [top level manifest documentation](../introduction.md) for more general details.
44

55
Below is a standard example of a basic Polkadot `project.ts`.
66

@@ -11,7 +11,7 @@ import {
1111
SubstrateProject,
1212
} from "@subql/types";
1313

14-
// Can expand the Datasource processor types via the genreic param
14+
// Can expand the Datasource processor types via the generic param
1515
const project: SubstrateProject = {
1616
specVersion: "1.0.0",
1717
version: "0.0.1",
@@ -250,7 +250,7 @@ export default { typesBundle: typesBundleDeprecated };
250250

251251
You can see the suggested method for connecting and retrieving custom chain types in [SubQuery's Official Dictionary repository](https://github.com/subquery/subql-dictionary). Here you will find a dictionary project for each network with all the chain types correct inserted. We retrieve these definitions from the [official Polkadot.js repo](https://github.com/polkadot-js/apps/tree/master/packages/apps-config/src/api/spec), where each network lists their their chaintypes.
252252

253-
For example, Acala publish an [offical chain type definition to NPM](https://www.npmjs.com/package/@acala-network/type-definitions). This is imported in your project's `package.json` like so:
253+
For example, Acala publish an [official chain type definition to NPM](https://www.npmjs.com/package/@acala-network/type-definitions). This is imported in your project's `package.json` like so:
254254

255255
```json
256256
{
@@ -319,12 +319,12 @@ To enable this feature, you must ensure that your project has the [--unfinalized
319319

320320
Custom Data Sources provide network specific functionality that makes dealing with data easier. They act as a middleware that can provide extra filtering and data transformation.
321321

322-
A good example of this is EVM support, having a custom data source processor for EVM means that you can filter at the EVM level (e.g. filter contract methods or logs) and data is transformed into structures farmiliar to the Ethereum ecosystem as well as parsing parameters with ABIs.
322+
A good example of this is EVM support, having a custom data source processor for EVM means that you can filter at the EVM level (e.g. filter contract methods or logs) and data is transformed into structures familiar to the Ethereum ecosystem as well as parsing parameters with ABIs.
323323

324324
Custom Data Sources can be used with normal data sources.
325325

326326
Here is a list of supported custom datasources:
327327

328328
| Kind | Supported Handlers | Filters | Description |
329329
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
330-
| [substrate/FrontierEvm](../../datasource-processors/substrate-evm.md) | [substrate/FrontierEvmEvent](../../datasource-processors/substrate-evm#event-handlers), [substrate/FrontierEvmCall](../../dataspirce-processors/substrate-evm#call-handlers) | See filters under each handlers | Provides easy interaction with EVM transactions and events on the Frontier EVM (widely used across Polkadot including in Moonbeam and Astar networks) |
330+
| [substrate/FrontierEvm](../../datasource-processors/substrate-evm.md) | [substrate/FrontierEvmEvent](../../datasource-processors/substrate-evm#event-handlers), [substrate/FrontierEvmCall](../../datasource-processors/substrate-evm#call-handlers) | See filters under each handlers | Provides easy interaction with EVM transactions and events on the Frontier EVM (widely used across Polkadot including in Moonbeam and Astar networks) |

docs/indexer/build/manifest/chain-specific/solana.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Solana Manifest File
22

3-
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Algorand, please refer to the [top level manifest documentation](../introduction.md) for more general details.
3+
The Manifest `project.ts` file can be seen as an entry point of your project and it defines most of the details on how SubQuery will index and transform the chain data. This is the specific details for Solana, please refer to the [top level manifest documentation](../introduction.md) for more general details.
44

55
Below is a standard example of a basic Solana `project.ts`.
66

@@ -11,7 +11,7 @@ import {
1111
SolanaProject,
1212
} from "@subql/types-solana";
1313

14-
// Can expand the Datasource processor types via the genreic param
14+
// Can expand the Datasource processor types via the generic param
1515
const project: SolanaProject = {
1616
specVersion: "1.0.0",
1717
name: "solana-subql-starter",

docs/indexer/build/manifest/chain-specific/starknet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ Defines the data that will be filtered and extracted and the location of the map
161161
| **endBlock** | Integer | This sets a end block for processing on the datasource. After this block is processed, this datasource will no longer index your data. <br><br>Useful when your contracts change at a certain block height, or when you want to insert data at genesis. For example, setting both the `startBlock` and `endBlock` to 320, will mean this datasource only operates on block 320 |
162162
| **mapping** | Mapping Spec | |
163163
| **options** | { abi: string; address: string; } | The name of the abi in assets to use for decoding data and an address for the contract to filter |
164+
164165
| **assets** | Map<string, { file: string }> | A map of contract names to abi file paths |
165166
## Data Sources and Mapping
166167

0 commit comments

Comments
 (0)