/cord-subql

Subquery Repository for CORD Networks

Primary LanguageTypeScriptMIT LicenseMIT

SubQuery - CORD

Preparation

Environment

  • Typescript are required to compile project and define types.

  • Both SubQuery CLI and generated Project have dependencies and require Node.

Configure your project

In the starter package, we have provided a simple example of project configuration. You will be mainly working on the following files:

  • The Manifest in project.yaml
  • The GraphQL Schema in schema.graphql
  • The Mapping functions in src/mappings/ directory

For more information on how to write the SubQuery, check out our doc section on Define the SubQuery

Code generation

In order to index your SubQuery project, it is mandatory to build your project first. Run this command under the project directory.

yarn codegen

Build the project

In order to deploy your SubQuery project to our hosted service, it is mandatory to pack your configuration before upload. Run pack command from root directory of your project will automatically generate a your-project-name.tgz file.

yarn build

Indexing and Query

Run required systems in docker

Under the project directory run following command:

docker-compose pull && docker-compose up

Query the project

Open your browser and head to http://localhost:3000.

Finally, you should see a GraphQL playground is showing in the explorer and the schemas that ready to query.

For the cord-subql project, you can try to query with the following code to get a taste of how it works.

TODO: fix the query with the right commands once ready

{
  query {
    starterEntities(first: 10) {
      nodes {
        field1
        field2
        field3
        field4
      }
    }
  }
}