forked from subquery/subql-dictionary
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a9c4919
commit 264da95
Showing
288 changed files
with
74 additions
and
9,984 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,53 @@ | ||
.idea/ | ||
# These are some examples of commonly ignored file patterns. | ||
# You should customize this list as applicable to your project. | ||
# Learn more about .gitignore: | ||
# https://www.atlassian.com/git/tutorials/saving-changes/gitignore | ||
|
||
# Node artifact files | ||
node_modules/ | ||
dist/ | ||
yarn.lock | ||
|
||
# Compiled Java class files | ||
*.class | ||
|
||
# Compiled Python bytecode | ||
*.py[cod] | ||
|
||
# Log files | ||
*.log | ||
|
||
# Package files | ||
*.jar | ||
|
||
# Maven | ||
target/ | ||
dist/ | ||
src/types | ||
|
||
# JetBrains IDE | ||
.idea/ | ||
|
||
# Unit test reports | ||
TEST*.xml | ||
|
||
# Generated by MacOS | ||
.DS_Store | ||
|
||
# Generated by Windows | ||
Thumbs.db | ||
|
||
# Applications | ||
*.app | ||
*.exe | ||
*.war | ||
|
||
# Large media files | ||
*.mp4 | ||
*.tiff | ||
*.avi | ||
*.flv | ||
*.mov | ||
*.wmv | ||
|
||
.data |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,28 @@ | ||
# What is SubQuery? | ||
|
||
SubQuery powers the next generation of Polkadot dApps by allowing developers to extract, transform and query blockchain data in real time using GraphQL. In addition to this, SubQuery provides production quality hosting infrastructure to run these projects in. | ||
|
||
# What is SubQuery Dictionary | ||
# SubQuery - Dictionary | ||
|
||
This special SubQuery Project provides a dictionary of data that pre-indexes events on chain to dramatically improve indexing the performance of your own SubQuery Project, sometimes up to 10x faster. | ||
|
||
It scans over the network, and records the module and method for every event/extrinsic on each block. See the standard entities in the `schema.graphql` file within this project to see what fields are available. | ||
It scans over the network, and simply records the module and method for every event/extrinsic on each block - please see the standard entities in `schema.graphql`. | ||
|
||
**If you want to create your SubQuery Dictionary to speed up indexing of your own Substrate chain, fork this project and let us know** | ||
|
||
# Getting Started | ||
|
||
### 1. Add the dictionary URL to your SubQuery project | ||
|
||
# Geting Started | ||
### 1. Install dependencies | ||
```shell | ||
network: | ||
endpoint: wss://polkadot.api.onfinality.io/public-ws | ||
dictionary: https://api.subquery.network/sq/subquery/polkadot-dictionary | ||
yarn | ||
``` | ||
|
||
# Understanding the dictionary | ||
|
||
Visit [How the dictionary works](https://academy.subquery.network/academy/tutorials_examples/dictionary.html#how-does-a-subquery-dictionary-work) for more information. | ||
### 2. Generate types | ||
```shell | ||
yarn codegen | ||
``` | ||
|
||
# Adding your own dictionary | ||
### 3. Build | ||
```shell | ||
yarn build | ||
``` | ||
|
||
1. Fork the repository. | ||
2. Add your own dictionary project to the root directory. | ||
3. To publish on our Managed Services, you can use the GitHub actions. | ||
1. Set a GitHub environment to `DEPLOYMENT`. | ||
2. Set a GitHub secret name to `SUBQL_ACCES_TOKEN` (Your token generated on https://project.subquery.network/ ) under the previously set environment. | ||
3. Create a project using the UI or the CLI. | ||
4. Navigate to GitHub actions in your forked repository and select the workflow `Deploy to Hosted Service`. | ||
1. Enter your dictionary directory name in the input field `Dictionary directory name` e.g.`acala`. | ||
2. For the input field `Project Name` enter the name of the project created earlier (If your project name uses spaces please replace them with `-` e.g. `perfect - dictionary` -> `perfect---dictionary`). | ||
### 4. Run locally | ||
```shell | ||
yarn start:docker | ||
``` |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.