diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts index 039c2705b0b..7e9e3ba343d 100644 --- a/docs/.vuepress/sidebar.ts +++ b/docs/.vuepress/sidebar.ts @@ -202,6 +202,10 @@ export const getSidebar = (locale: string) => text: "ZkSync Era", link: `${locale}/quickstart/quickstart_chains/zksync-era.md`, }, + { + text: "And more EVM networks", + link: `${locale}/quickstart/quickstart_chains/evm.md`, + }, ], }, { diff --git a/docs/quickstart/quickstart_chains/cosmos-other.md b/docs/quickstart/quickstart_chains/cosmos-other.md index 2a93cfc7d4e..3c71e197d4f 100644 --- a/docs/quickstart/quickstart_chains/cosmos-other.md +++ b/docs/quickstart/quickstart_chains/cosmos-other.md @@ -1,27 +1,29 @@ # Other Supported Cosmos Zones -Although we only list quick start guides for [Juno](./cosmos-juno.md), [Cronos](./cosmos-cronos.md), and [Thorchain](./cosmos-thorchain.md) - SubQuery has been tested to support all the following Cosmos zones and you can quickly initialise a new project in any of them using the `subql init` command: +Although we only list quick start guides for select Cosmos zones - SubQuery has been tested to support most zones that that use CosmWasm, Tendermint, or Ethermint. You can quickly initialise a new project in any [supported network](https://subquery.network/networks) using the `subql init` command: CosmWasm Projects: - [Axelar](https://github.com/subquery/cosmos-subql-starter/tree/main/Axelar/axelar-starter) - [COMDEX](https://github.com/subquery/cosmos-subql-starter/tree/main/Comdex/comdex-starter) ([Quick start video](https://www.youtube.com/watch?v=uAhE4SxcbGk)) -- [CosmosHub](https://github.com/subquery/cosmos-subql-starter/tree/main/CosmosHub/cosmoshub-starter) +- [CosmosHub](https://github.com/subquery/cosmos-subql-starter/tree/main/CosmosHub/cosmoshub-starter) - [Evmos](https://github.com/subquery/cosmos-subql-starter/tree/main/Evmos/evmos-starter) ([Quick start video](https://www.youtube.com/watch?v=tfB8hi0cHy4)) - [Fetch.ai](https://github.com/subquery/cosmos-subql-starter/tree/main/Fetch.ai/fetchhub-starter) ([Quick start video](https://www.youtube.com/watch?v=lqU0Ivpn3Ww)) - [Injective](https://github.com/subquery/cosmos-subql-starter/tree/main/Injective/injective-starter) ([Quick start video](https://www.youtube.com/watch?v=Z9TSJaiHS70)) - [Juno](https://github.com/subquery/cosmos-subql-starter/tree/main/Juno/juno-starter) -- [Kava](https://github.com/subquery/cosmos-subql-starter/tree/main/Kava/kava-starter) ([Quick start video](https://www.youtube.com/watch?v=B9DUS0brLoI)) +- [Kava](https://github.com/subquery/cosmos-subql-starter/tree/main/Kava/kava-starter) ([Quick start video](https://www.youtube.com/watch?v=B9DUS0brLoI)) - [Osmosis](https://github.com/subquery/cosmos-subql-starter/tree/main/Osmosis/osmosis-starter) ([Quick start video](https://www.youtube.com/watch?v=W9nriCvgQvM)) - [Persistence](https://github.com/subquery/cosmos-subql-starter/tree/main/Persistence/persistence-starter) ([Quick start video](https://www.youtube.com/watch?v=pgSlo41LW84)) - [Stargaze](https://github.com/subquery/cosmos-subql-starter/tree/main/Stargaze/stargaze-starter) - [Thorchain](https://github.com/subquery/cosmos-subql-starter/tree/main/Thorchain/thorchain-starter) +- [And more...](https://github.com/subquery/cosmos-subql-starter) Ethermint Projects: - [Cronos](https://github.com/subquery/cosmos-subql-starter/tree/main/Cronos) (view the [quick start guide](./cosmos-cronos.md)) - [OKC Chain (by OKX)](https://github.com/subquery/cosmos-subql-starter/tree/main/OKX/okx-starter) +- [And more...](https://github.com/subquery/cosmos-subql-starter) View the full list of tested projects in [the cosmos-subql-starter repository](https://github.com/subquery/cosmos-subql-starter). @@ -36,7 +38,7 @@ If your (or anyone else's Cosmos zone) needs indexing support, we're pretty conf **Before you start, you will need:** -- Access to a full archive node to index from +- Access to a RPC node to index from - Any protobuf files that are required for the network (these end in `.proto`). For example, you can find Osmosis' protobuf definitions [here](https://buf.build/osmosis-labs/osmosis/tree/main:osmosis) - It's helpful to have a block explorer to see what you are trying to index first, [Mintscan](https://www.mintscan.io/cosmos) is a popular Cosmos explorer. @@ -58,7 +60,7 @@ The majority of changes occur in the project manifest (`project.ts`). This inclu - `network.dictionary`: Unless you have already created a [dictionary](../../academy/tutorials_examples/dictionary.md), please comment out or remove this. - `network.chainTypes`: Please see the docs under [Chain Types](../../build/manifest/cosmos.md#chain-types). -We suggest adding one or two chain types that relate to the events or messages that you are trying to index, and recursively add more after running it and observing errors from missing protobuf definitionns +We suggest adding one or two chain types that relate to the events or messages that you are trying to index, and recursively add more after running it and observing errors from missing protobuf definitions **3. Update Readme** @@ -66,7 +68,7 @@ Update the README file with a description and a sample GraphQL query of your pro **4. Contribute back to our starter projects** -Please contribute your new chain back to our starter projects by making a PR back to [https://github.com/subquery/cosmos-subql-starter](https://github.com/subquery/cosmos-subql-starter). +Please contribute your new chain back to our example projects by making a PR back to [https://github.com/subquery/cosmos-subql-starter](https://github.com/subquery/cosmos-subql-starter). We really appreciate it, and will absolutely give you a shout out for your effort on social media to our community! diff --git a/docs/quickstart/quickstart_chains/evm.md b/docs/quickstart/quickstart_chains/evm.md new file mode 100644 index 00000000000..c0788454415 --- /dev/null +++ b/docs/quickstart/quickstart_chains/evm.md @@ -0,0 +1,57 @@ +# Other EVM Networks + +Although we only list quick start guides for select EVM based networks - SubQuery has been tested to support all standard EVM implementations. You can quickly initialise a new project in any [supported network](https://subquery.network/networks) using the `subql init` command: + +View the full list of tested EVM projects in [the ethereum-subql-starter repository](https://github.com/subquery/ethereum-subql-starter). + +## Can SubQuery Support your EVM Network + +::: tip SubQuery supports all pure EVM implementations + +**We're confident that SubQuery supports all pure EVM implementations!** + +If your (or anyone else's EVM network) needs indexing support, we're pretty confident that SubQuery will work off the shelf with it! Reach out to us on Discord or at [hello@subquery.network](hello@subquery.network) and we can help out, or continue with the steps below. +::: + +**Before you start, you will need:** + +- Access to a RPC node to index from +- The chain ID of the network +- It's helpful to have a block explorer to see what you are trying to index first, [Blockscout](https://www.blockscout.com/) is a popular EVM explorer. + +**1. Clone an existing starter project** + +Clone a project from: [https://github.com/subquery/ethereum-subql-starter](https://github.com/subquery/ethereum-subql-starter) to start with some standard boilerplate (it might be easiest to just fork that repo and copy an existing one that is most like your chain). + +**2. Update project.ts & package.json file** + +In the `package.json`, you will want to update the `name` and `description`. + +The majority of changes occur in the project manifest (`project.ts`). This include the following: + +- `name` +- `description` +- `network.chainId`: This will be the ethereum chain ID, for example [Ethereum is `1`](https://chainlist.org/chain/1), [Optimism is `10`](https://chainlist.org/chain/10), [Polygon is `137`](https://chainlist.org/chain/137). +- `network.endpoint`: This defines the (HTTP or WSS) RPC endpoint of the blockchain to be indexed. This property can be a string or an array of strings (e.g. `endpoint: ['rpc1.endpoint.com', 'rpc2.endpoint.com']`). Read more in [Network Spec](../../build/manifest/ethereum.md#network-spec). + +**3. Update Readme** + +Update the README file with a description and a sample GraphQL query of your project + +**4. Contribute back to our starter projects** + +Please contribute your new chain back to our example projects by making a PR back to [https://github.com/subquery/ethereum-subql-starter](https://github.com/subquery/ethereum-subql-starter). + +We really appreciate it, and will absolutely give you a shout out for your effort on social media to our community! + +## What’s Next? + +Congratulations! You have now a locally running EVM SubQuery project that accepts GraphQL API requests. + +::: tip Tip + +Find out how to build a performant SubQuery project and avoid common mistakes in [Project Optimisation](../../build/optimisation.md). + +::: + +Click [here](../../quickstart/whats-next.md) to learn what should be your **next step** in your SubQuery journey. diff --git a/docs/quickstart/quickstart_chains/polkadot-other.md b/docs/quickstart/quickstart_chains/polkadot-other.md index d0063a135ce..e6f71af3cfd 100644 --- a/docs/quickstart/quickstart_chains/polkadot-other.md +++ b/docs/quickstart/quickstart_chains/polkadot-other.md @@ -1,52 +1,6 @@ # Other Supported Polkadot/Substrate Chains -Although we only list quick start guides for [Polkadot](./polkadot.md), [Astar](./polkadot-astar.md), and [Humanode](./polkadot-humanode.md) - SubQuery has been tested to support all the following Polkadot parachains and standalone Substrate chains and you can quickly initialise a new project in any of them using the `subql init` command: - -- [Acala](https://github.com/subquery/subql-starter/tree/main/Acala) -- [Ajuna](https://github.com/subquery/subql-starter/tree/main/Ajuna/ajuna-starter) -- [Altair](https://github.com/subquery/subql-starter/tree/main/Altair/altair-starter) -- [Astar](https://github.com/subquery/subql-starter/tree/main/Astar) -- [Automata](https://github.com/subquery/subql-starter/tree/main/Automata/automata-starter) -- [Basilisk](https://github.com/subquery/subql-starter/tree/main/Basilisk/basilisk-starter) -- [Bifrost](https://github.com/subquery/subql-starter/tree/main/Bifrost/bifrost-starter) -- [Bitcountry](https://github.com/subquery/subql-starter/tree/main/Bitcountry/bitcountry-starter) -- [Bitgreen](https://github.com/subquery/subql-starter/tree/main/Bitgreen/bitgreen-starter) -- [Calamari](https://github.com/subquery/subql-starter/tree/main/Calamari/calamari-starter) -- [Centrifuge](https://github.com/subquery/subql-starter/tree/main/Centrifuge/centrifuge-starter) -- [Clover](https://github.com/subquery/subql-starter/tree/main/Clover/clover-starter) -- [Composable](https://github.com/subquery/subql-starter/tree/main/ComposableFinance/composable-finance-starter) -- [ContextFree](https://github.com/subquery/subql-starter/tree/main/Contextfree/contextfree-starter) -- [Darwinia](https://github.com/subquery/subql-starter/tree/main/Darwinia/darwinia-starter) -- [Efinity](https://github.com/subquery/subql-starter/tree/main/Efinity/efinity-starter) -- [Encointer](https://github.com/subquery/subql-starter/tree/main/Encointer/Encointer-starter) -- [Equilibrium](https://github.com/subquery/subql-starter/tree/main/Equilibrium/equilibrium-starter) -- [Frequency](https://github.com/subquery/subql-starter/tree/main/Frequency/frequency-starter) -- [Hashed](https://github.com/subquery/subql-starter/tree/main/HashedNetwork/hashed-network-starter) -- [Humanode](https://github.com/subquery/subql-starter/tree/main/Humanode/Humanode-starter) -- [HydraDX](https://github.com/subquery/subql-starter/tree/main/HydraDX/hydradx-starter) -- [Integritee](https://github.com/subquery/subql-starter/tree/main/IntegriteeShell/integritee-shell-starter) -- [Interlay](https://github.com/subquery/subql-starter/tree/main/Interlay/interlay-starter) -- [Kapex](https://github.com/subquery/subql-starter/tree/main/Kapex/kapex-starter) -- [Karura](https://github.com/subquery/subql-starter/tree/main/Karura) -- [Khala](https://github.com/subquery/subql-starter/tree/main/Khala/khala-starter) -- [KILT](https://github.com/subquery/subql-starter/tree/main/Kilt/kilt-spiritnet-starter) -- [Kusama](https://github.com/subquery/subql-starter/tree/main/Kusama/kusama-starter) -- [Kylin](https://github.com/subquery/subql-starter/tree/main/Kylin/kylin-starter) -- [Moonbeam](https://github.com/subquery/subql-starter/tree/main/Moonbeam) -- [Moonriver](https://github.com/subquery/subql-starter/tree/main/Moonriver) -- [Nodle](https://github.com/subquery/subql-starter/tree/main/Nodle/nodle-starter) -- [Origin Trail](https://github.com/subquery/subql-starter/tree/main/OriginTrail/origintrail-starter) -- [Parallel](https://github.com/subquery/subql-starter/tree/main/Parallel) -- [Polkadex](https://github.com/subquery/subql-starter/tree/main/Polkadex/polkadex-starter) -- [Polkadot](https://github.com/subquery/subql-starter/tree/main/Polkadot/Polkadot-starter) -- [Quartz](https://github.com/subquery/subql-starter/tree/main/Quartz/quartz-subql-starter) -- [Shiden](https://github.com/subquery/subql-starter/tree/main/Shiden/shiden-starter) -- [Statemine](https://github.com/subquery/subql-starter/tree/main/Statemine/statemine-starter) -- [Statemint](https://github.com/subquery/subql-starter/tree/main/Statemint/statemint-starter) -- [Unique](https://github.com/subquery/subql-starter/tree/main/Unique/unique-starter) -- [Vara](https://github.com/subquery/subql-starter/tree/main/Vara/vara-starter) -- [Watr](https://github.com/subquery/subql-starter/tree/main/Watr/watr-starter) -- [Westend](https://github.com/subquery/subql-starter/tree/main/Westend/westend-starter) +Although we only list quick start guides for select Polkadot networks - SubQuery has been tested to support most Polkadot parachains and standalone Substrate chains and you can quickly initialise a new project in any [supported network](https://subquery.network/networks) using the `subql init` command. View the full list of tested projects in [the subql-starter repository](https://github.com/subquery/subql-starter). @@ -88,7 +42,7 @@ Update the README file with a description and a sample GraphQL query of your pro **4. Contribute back to our starter projects** -Please contribute your new chain back to our starter projects by making a PR back to [https://github.com/subquery/subql-starter](https://github.com/subquery/subql-starter). +Please contribute your new chain back to our example projects by making a PR back to [https://github.com/subquery/subql-starter](https://github.com/subquery/subql-starter). We really appreciate it, and will absolutely give you a shout out for your effort on social media to our community!