https://github.com/subquery/subql-dictionary

A subquery project provide dictionary data & service for a substrate-based network
https://github.com/subquery/subql-dictionary

Last synced: about 2 months ago
JSON representation

A subquery project provide dictionary data & service for a substrate-based network

• Host: GitHub
• URL: https://github.com/subquery/subql-dictionary
• Owner: subquery
• Created: 2021-06-29T22:42:09.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-12T22:37:12.000Z (5 months ago)
• Last Synced: 2024-05-12T23:27:57.491Z (5 months ago)
• Language: TypeScript
• Size: 490 KB
• Stars: 17
• Watchers: 6
• Forks: 41
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-dot - SubQl - This library serve pre-computed indexes of each block for most Polkadot and (Libraries / Multisig Wallets)

README

        
# 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

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.

**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

```shell

network:

  endpoint: wss://polkadot.api.onfinality.io/public-ws

  dictionary: https://api.subquery.network/sq/subquery/polkadot-dictionary

```

# 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.

# Adding your own dictionary

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`).