-
Notifications
You must be signed in to change notification settings - Fork 3
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
Showing
46 changed files
with
13,106 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
/node_modules | ||
/lib | ||
/builds | ||
|
||
/**Versions.json | ||
/**Versions.jsonl | ||
|
||
# IDE files | ||
/.idea | ||
.env |
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/.git | ||
/node_modules | ||
/lib | ||
/*Versions.jsonl |
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
DB_NAME=dns | ||
DB_HOST=localhost | ||
DB_PORT=5432 | ||
GQL_PORT=4350 | ||
|
||
# JSON-RPC node endpoints (wss or https) | ||
# Use private endpoints in production! | ||
# Set urls via secrets if deploying to Cloud: https://docs.subsquid.io/deploy-squid/env-variables/ | ||
# OR use the RPC proxy service: https://docs.subsquid.io/deploy-squid/rpc-proxy | ||
RPC_ENDPOINT=wss://testnet-archive.vara.network | ||
FACTORY_PROGRAM=0xd2af5ea60be7b0d95271f0bc3029eba85fe014a18db8c2335d24f21bea91ba2d | ||
MIN_BLOCK_NUMBER=5477837 | ||
|
||
# Uncommenting this line enables the debug mode | ||
# More info at https://docs.subsquid.io/basics/logging/ | ||
#SQD_DEBUG=* |
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
/node_modules | ||
/lib | ||
/builds | ||
|
||
/**Versions.json | ||
/**Versions.jsonl | ||
|
||
# IDE files | ||
/.idea | ||
.env |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
engine-strict=true |
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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
FROM node:18-alpine AS node | ||
FROM node AS node-with-gyp | ||
RUN apk add g++ make python3 | ||
FROM node-with-gyp AS builder | ||
WORKDIR /squid | ||
ADD package.json . | ||
ADD package-lock.json . | ||
# remove if needed | ||
ADD assets assets | ||
# remove if needed | ||
ADD db db | ||
# remove if needed | ||
ADD schema.graphql . | ||
RUN npm ci | ||
ADD tsconfig.json . | ||
ADD src src | ||
RUN npm run build | ||
|
||
FROM node-with-gyp AS deps | ||
WORKDIR /squid | ||
ADD package.json . | ||
ADD package-lock.json . | ||
RUN npm ci --production | ||
|
||
FROM node AS squid | ||
RUN npm i -g @subsquid/cli@latest | ||
WORKDIR /squid | ||
COPY --from=deps /squid/package.json . | ||
COPY --from=deps /squid/package-lock.json . | ||
COPY --from=deps /squid/node_modules node_modules | ||
COPY --from=builder /squid/lib lib | ||
# remove if no assets folder | ||
COPY --from=builder /squid/assets assets | ||
# remove if no db folder | ||
COPY --from=builder /squid/db db | ||
# remove if no schema.graphql is in the root | ||
COPY --from=builder /squid/schema.graphql schema.graphql | ||
# remove if no commands.json is in the root | ||
ADD commands.json . | ||
ENV PROCESSOR_PROMETHEUS_PORT 3000 | ||
CMD ["npm", "run", "serve:prod"] |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
FROM node:18-alpine AS node | ||
RUN apk add g++ make python3 | ||
RUN npm i -g @subsquid/cli@latest | ||
RUN npm i -g [email protected] | ||
WORKDIR /squid | ||
ADD package.json . | ||
ADD package-lock.json . | ||
RUN npm i @types/node | ||
# remove if needed | ||
ADD assets assets | ||
# remove if needed | ||
ADD db db | ||
# remove if needed | ||
ADD schema.graphql . | ||
ADD tsconfig.json . | ||
ADD src src | ||
RUN npm run build | ||
|
||
ADD commands.json . | ||
ENV PROCESSOR_PROMETHEUS_PORT 3000 | ||
CMD ["sqd", "process"] |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 Subsquid Labs | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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 |
---|---|---|
@@ -0,0 +1,224 @@ | ||
# Squid template project | ||
|
||
A starter [Squid](https://subsquid.io) project to demonstrate its structure and conventions. | ||
It accumulates [kusama](https://kusama.network) account transfers and serves them via GraphQL API. | ||
|
||
## Summary | ||
|
||
- [Quickstart](#quickly-running-the-sample) | ||
- [Public archives for Parachains](#public-archives-for-parachains) | ||
- [Self-hosted archive](#self-hosted-archive) | ||
- [Development flow](#dev-flow) | ||
- [Database Schema](#1-define-database-schema) | ||
- [Entity classes](#2-generate-typeorm-classes) | ||
- [DB migrations](#3-generate-database-migration) | ||
- [Typegen for Events, Extrinsics and Storage Calls](#4-generate-typescript-definitions-for-substrate-events-calls-and-storage) | ||
- [Deploy the Squid](#deploy-the-squid) | ||
- [Conventions](#project-conventions) | ||
- [Type Bundles](#types-bundle) | ||
|
||
## Prerequisites | ||
|
||
* node 16.x | ||
* docker | ||
* npm -- note that `yarn` package manager is not supported | ||
|
||
## Quickly running the sample | ||
|
||
Example commands below use [sqd](https://docs.subsquid.io/squid-cli/). | ||
Please [install](https://docs.subsquid.io/squid-cli/installation/) it before proceeding. | ||
|
||
```bash | ||
# 1. Install dependencies | ||
npm ci | ||
|
||
# 2. Start target Postgres database and detach | ||
sqd up | ||
|
||
# 3. Build the project | ||
sqd build | ||
|
||
# 4. Start both the squid processor and the GraphQL server | ||
sqd run . | ||
``` | ||
A GraphiQL playground will be available at [localhost:4350/graphql](http://localhost:4350/graphql). | ||
|
||
## Public archives for Parachains | ||
|
||
Subsquid provides archive data sources [for most parachains](https://docs.subsquid.io/substrate-indexing/supported-networks/). Use `lookupArchive(<network name>, <lookup filters>)` from `@subsquid/archive-registry` to look up the archive endpoint by the network name, e.g. | ||
|
||
```typescript | ||
processor.setDataSource({ | ||
archive: lookupArchive("kusama", { release: "ArrowSquid" }) | ||
//... | ||
}); | ||
``` | ||
|
||
To make sure you're indexing the right chain one can additionally filter by the genesis block hash: | ||
|
||
```typescript | ||
processor.setDataSource({ | ||
archive: lookupArchive("kusama", { | ||
release: "ArrowSquid", | ||
genesis: "0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe" | ||
}), | ||
//... | ||
}); | ||
``` | ||
|
||
If the chain is not yet supported, you can still index it using [RPC ingestion](https://docs.subsquid.io/substrate-indexing/setup/general/#set-data-source). If you take this route, use [metadata exporer](https://github.com/subsquid/squid-sdk/tree/master/substrate/substrate-metadata-explorer) with [Substrate typegen](https://docs.subsquid.io/substrate-indexing/squid-substrate-typegen/) for help with decoding. | ||
|
||
You can also fill out this [form](https://forms.gle/Vhr3exPs4HrF4Zt36) to submit a request for an Archive/Subsquid Network dataset. | ||
|
||
## Self-hosted archive | ||
|
||
Self-hosted Archives are deprecated by the ArrowSquid release. Keep an eye on updates on [Subsquid Network](https://docs.subsquid.io/subsquid-network/) and use it instead once it is released. | ||
|
||
## Dev flow | ||
|
||
### 1. Define database schema | ||
|
||
Start development by defining the schema of the target database via `schema.graphql`. | ||
Schema definition consists of regular graphql type declarations annotated with custom directives. | ||
Full description of `schema.graphql` dialect is available [here](https://docs.subsquid.io/store/postgres/schema-file/). | ||
|
||
### 2. Generate TypeORM classes | ||
|
||
Mapping developers use [TypeORM](https://typeorm.io) entities | ||
to interact with the target database during data processing. All necessary entity classes are | ||
[generated](https://docs.subsquid.io/store/postgres/schema-file/intro/) by the squid framework from `schema.graphql`. This is done by running `npx squid-typeorm-codegen` | ||
or (equivalently) `sqd codegen` command. | ||
|
||
### 3. Generate database migration | ||
|
||
All database changes are applied through migration files located at `db/migrations`. | ||
`squid-typeorm-migration(1)` tool provides several commands to drive the process. | ||
It is all [TypeORM](https://typeorm.io/#/migrations) under the hood. | ||
|
||
```bash | ||
# Connect to database, analyze its state and generate migration to match the target schema. | ||
# The target schema is derived from entity classes generated earlier. | ||
# Don't forget to compile your entity classes beforehand! | ||
npx squid-typeorm-migration generate | ||
|
||
# Create template file for custom database changes | ||
npx squid-typeorm-migration create | ||
|
||
# Apply database migrations from `db/migrations` | ||
npx squid-typeorm-migration apply | ||
|
||
# Revert the last performed migration | ||
npx squid-typeorm-migration revert | ||
``` | ||
Available `sqd` shortcuts: | ||
```bash | ||
# Build the project, remove any old migrations, then run `npx squid-typeorm-migration generate` | ||
sqd migration:generate | ||
|
||
# Run npx squid-typeorm-migration apply | ||
sqd migration:apply | ||
``` | ||
|
||
### 4. Generate TypeScript definitions for substrate events, calls and storage | ||
|
||
This is an optional part, but it is very advisable. | ||
|
||
Event, call and runtime storage data come to mapping handlers as raw untyped json. | ||
While it is possible to work with raw untyped json data, | ||
it's extremely error-prone and the json structure may change over time due to runtime upgrades. | ||
|
||
Squid framework provides a tool for generating type-safe wrappers around events, calls and runtime storage items for | ||
each historical change in the spec version. See the [Substrate typegen](https://docs.subsquid.io/substrate-indexing/squid-substrate-typegen/) documentation page. | ||
|
||
## Deploy the Squid | ||
|
||
After a local run, obtain a deployment key by signing into [Subsquid Cloud](https://app.subsquid.io) and run | ||
|
||
```sh | ||
npx sqd auth -k YOUR_DEPLOYMENT_KEY | ||
``` | ||
|
||
Next, inspect the Squid CLI help to deploy and manage your squid: | ||
|
||
```sh | ||
npx sqd squid --help | ||
``` | ||
|
||
For more information, consult the [Deployment Guide](https://docs.subsquid.io/deploy-squid/). | ||
|
||
## Project conventions | ||
|
||
Squid tools assume a certain project layout. | ||
|
||
* All compiled js files must reside in `lib` and all TypeScript sources in `src`. | ||
The layout of `lib` must reflect `src`. | ||
* All TypeORM classes must be exported by `src/model/index.ts` (`lib/model` module). | ||
* Database schema must be defined in `schema.graphql`. | ||
* Database migrations must reside in `db/migrations` and must be plain js files. | ||
* `squid-*(1)` executables consult `.env` file for a number of environment variables. | ||
|
||
See the [full desription](https://docs.subsquid.io/basics/squid-structure/) in the documentation. | ||
|
||
## Types bundle | ||
|
||
Substrate chains that have blocks with metadata versions below 14 don't provide enough | ||
information to decode their data. For those chains, external [type](https://polkadot.js.org/docs/api/start/types.extend) [definitions](https://polkadot.js.org/docs/api/start/types.extend) are required. | ||
|
||
Subsquid tools include definitions for many chains, however sometimes external | ||
definitions are still required. | ||
|
||
You can pass them as a special json file (types bundle) of the following structure: | ||
|
||
```json5 | ||
{ | ||
"types": { | ||
"AccountId": "[u8; 32]" | ||
}, | ||
"typesAlias": { | ||
"assets": { | ||
"Balance": "u64" | ||
} | ||
}, | ||
"versions": [ | ||
{ | ||
"minmax": [0, 1000], // spec version range with inclusive boundaries | ||
"types": { | ||
"AccountId": "[u8; 16]" | ||
}, | ||
"typesAlias": { | ||
"assets": { | ||
"Balance": "u32" | ||
} | ||
} | ||
} | ||
] | ||
} | ||
``` | ||
|
||
* `.types` - scale type definitions similar to [polkadot.js types](https://polkadot.js.org/docs/api/start/types.extend#extension) | ||
* `.typesAlias` - similar to [polkadot.js type aliases](https://polkadot.js.org/docs/api/start/types.extend#type-clashes) | ||
* `.versions` - per-block range overrides/patches for above fields. | ||
|
||
All fields in the type bundle are optional and applied on top of a fixed set of well-known frame types. | ||
|
||
Note, that although the structure of subsquid types bundle is very similar to the one from polkadot.js, | ||
those two are not fully compatible. | ||
|
||
## Differences from polkadot.js | ||
|
||
Polkadot.js provides lots of [specialized classes](https://polkadot.js.org/docs/api/start/types.basics) for various types of data. | ||
Even primitives like `u32` are exposed through special classes. | ||
In contrast, the squid framework works only with plain js primitives and objects. | ||
For instance, account data is passed to the handler context as a plain byte array. To convert it into a standard human-readable format one should explicitly use a utility lib `@subsquid/ss58`: | ||
|
||
```typescript | ||
// ... | ||
from: ss58.codec('kusama').encode(rec.from), | ||
to: ss58.codec('kusama').encode(rec.to), | ||
``` | ||
|
||
## Graphql server extensions | ||
|
||
It is possible to extend `squid-graphql-server(1)` with custom | ||
[type-graphql](https://typegraphql.com) resolvers and to add request validation. | ||
For more details, consult [docs](https://docs.subsquid.io/graphql-api/). |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Assets | ||
|
||
`assets` is the designated folder for any additional files to be used by the squid, for example a static data file. The folder is added by default to `Dockerfile` and is kept when the squid is deployed to the Aquairum. |
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
type ActorId = struct { | ||
[u8, 32], | ||
}; | ||
|
||
constructor { | ||
New : (); | ||
}; | ||
|
||
service Dns { | ||
AddAdmin : (user: ActorId) -> null; | ||
AddNewProgram : (name: str, program_id: ActorId) -> null; | ||
ChangeProgramId : (name: str, program_id: ActorId) -> null; | ||
DeleteAdmin : (user: ActorId) -> null; | ||
query ActiveContracts : () -> vec struct { str, ActorId }; | ||
query Admins : () -> vec ActorId; | ||
query History : () -> vec struct { str, vec struct { str, ActorId } }; | ||
|
||
events { | ||
AdminAdded: struct { new_admin: ActorId }; | ||
AdminDeleted: struct { deleted_admin: ActorId }; | ||
NewProgramAdded: struct { name: str, program_id: ActorId }; | ||
ProgramIdChanged: struct { name: str, program_id: ActorId, date: str }; | ||
} | ||
}; | ||
|
Oops, something went wrong.