From 4daa91573bbb2b2267b683571a43040bccc702bc Mon Sep 17 00:00:00 2001 From: bgodlin <37313677+bgodlin@users.noreply.github.com> Date: Mon, 27 Nov 2023 12:18:52 +0100 Subject: [PATCH] Add ref finance example (#9) --- .../.github/scripts/publish-deploy.sh | 15 ++++ .../.github/workflows/cli-deploy.yml | 34 ++++++++ .../near-ref-finance/.github/workflows/pr.yml | 20 +++++ Near/near-ref-finance/.gitignore | 58 +++++++++++++ Near/near-ref-finance/LICENSE | 21 +++++ Near/near-ref-finance/README.md | 83 +++++++++++++++++++ Near/near-ref-finance/docker-compose.yml | 64 ++++++++++++++ .../docker/load-extensions.sh | 5 ++ Near/near-ref-finance/docker/pg-Dockerfile | 12 +++ Near/near-ref-finance/package.json | 32 +++++++ Near/near-ref-finance/project.ts | 62 ++++++++++++++ Near/near-ref-finance/schema.graphql | 14 ++++ Near/near-ref-finance/src/index.ts | 2 + .../src/mappings/mappingHandlers.ts | 45 ++++++++++ Near/near-ref-finance/tsconfig.json | 20 +++++ 15 files changed, 487 insertions(+) create mode 100644 Near/near-ref-finance/.github/scripts/publish-deploy.sh create mode 100644 Near/near-ref-finance/.github/workflows/cli-deploy.yml create mode 100644 Near/near-ref-finance/.github/workflows/pr.yml create mode 100644 Near/near-ref-finance/.gitignore create mode 100644 Near/near-ref-finance/LICENSE create mode 100644 Near/near-ref-finance/README.md create mode 100644 Near/near-ref-finance/docker-compose.yml create mode 100644 Near/near-ref-finance/docker/load-extensions.sh create mode 100644 Near/near-ref-finance/docker/pg-Dockerfile create mode 100644 Near/near-ref-finance/package.json create mode 100644 Near/near-ref-finance/project.ts create mode 100644 Near/near-ref-finance/schema.graphql create mode 100644 Near/near-ref-finance/src/index.ts create mode 100644 Near/near-ref-finance/src/mappings/mappingHandlers.ts create mode 100644 Near/near-ref-finance/tsconfig.json diff --git a/Near/near-ref-finance/.github/scripts/publish-deploy.sh b/Near/near-ref-finance/.github/scripts/publish-deploy.sh new file mode 100644 index 0000000..3c9dc04 --- /dev/null +++ b/Near/near-ref-finance/.github/scripts/publish-deploy.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +while getopts p:o:e: flag +do + case "${flag}" in + e) ENDPOINT=${OPTARG};; + p) PROJECTNAME=${OPTARG};; + o) ORG=${OPTARG};; + *) echo "Usage: $0 [-p projectname] [-o org] [-e endpoint]" && exit 1;; + esac +done + +IPFSCID=$(npx subql publish -o -f .) + +npx subql deployment:deploy -d --ipfsCID="$IPFSCID" --projectName="${PROJECTNAME}" --org="${ORG%/*}" --endpoint="${ENDPOINT}" diff --git a/Near/near-ref-finance/.github/workflows/cli-deploy.yml b/Near/near-ref-finance/.github/workflows/cli-deploy.yml new file mode 100644 index 0000000..658d2c6 --- /dev/null +++ b/Near/near-ref-finance/.github/workflows/cli-deploy.yml @@ -0,0 +1,34 @@ +name: "CLI deploy" + +on: + workflow_dispatch: + inputs: + projectName: + description: "Project name" + required: true + type: string +jobs: + deploy: + name: CLI Deploy + runs-on: ubuntu-latest + environment: + name: DEPLOYMENT + env: + SUBQL_ACCESS_TOKEN: ${{ secrets.SUBQL_ACCESS_TOKEN }} + ENDPOINT: ${{ secrets.ENDPOINT }} + steps: + - uses: actions/checkout@v2 + - name: Setup Node.js environment + uses: actions/setup-node@v2 + with: + node-version: 16 + - run: yarn + - name: Codegen + run: yarn codegen + - name: Version + run: npx subql --version + - name: repo + run: echo ${{github.repository}} + - name: Publish and Deploy + run: | + sh .github/workflows/scripts/publish-deploy.sh -o ${{github.repository}} -p ${{github.event.inputs.projectName}} -e ${{secrets.ENDPOINT}} diff --git a/Near/near-ref-finance/.github/workflows/pr.yml b/Near/near-ref-finance/.github/workflows/pr.yml new file mode 100644 index 0000000..a7cf1a6 --- /dev/null +++ b/Near/near-ref-finance/.github/workflows/pr.yml @@ -0,0 +1,20 @@ +name: PR +on: + pull_request: + paths-ignore: + - ".github/workflows/**" +jobs: + pr: + name: pr + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup Node.js environment + uses: actions/setup-node@v2 + with: + node-version: 16 + - run: yarn + - name: Codegen + run: yarn codegen + - name: Build + run: yarn build diff --git a/Near/near-ref-finance/.gitignore b/Near/near-ref-finance/.gitignore new file mode 100644 index 0000000..42864e1 --- /dev/null +++ b/Near/near-ref-finance/.gitignore @@ -0,0 +1,58 @@ +# 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/ + +# lock files +yarn.lock +package-lock.json + +# Compiled Java class files +*.class + +# Compiled Python bytecode +*.py[cod] + +# Log files +*.log + +# Package files +*.jar + +# Generated files +target/ +dist/ +src/types +#project.yaml + +# 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 +.eslintcache diff --git a/Near/near-ref-finance/LICENSE b/Near/near-ref-finance/LICENSE new file mode 100644 index 0000000..76e70cc --- /dev/null +++ b/Near/near-ref-finance/LICENSE @@ -0,0 +1,21 @@ +MIT LICENSE + +Copyright 2020-2021 SubQuery Pte Ltd authors & contributors + +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 NON-INFRINGEMENT. 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. diff --git a/Near/near-ref-finance/README.md b/Near/near-ref-finance/README.md new file mode 100644 index 0000000..bdc92f3 --- /dev/null +++ b/Near/near-ref-finance/README.md @@ -0,0 +1,83 @@ +# SubQuery - Example Project for Ref Finance on NEAR + +[SubQuery](https://subquery.network) is a fast, flexible, and reliable open-source data indexer that provides you with custom APIs for your web3 project across all of our supported networks. To learn about how to get started with SubQuery, [visit our docs](https://academy.subquery.network). + +**This SubQuery project indexes the `swap` actions of the `v2.ref-finance.near` contract on the NEAR mainnet.** + +## Start + +First, install SubQuery CLI globally on your terminal by using NPM `npm install -g @subql/cli` + +You can either clone this GitHub repo, or use the `subql` CLI to bootstrap a clean project in the network of your choosing by running `subql init` and following the prompts. + +Don't forget to install dependencies with `npm install` or `yarn install`! + +## Editing your SubQuery project + +Although this is a working example SubQuery project, you can edit the SubQuery project by changing the following files: + +- The project manifest in `project.yaml` defines the key project configuration and mapping handler filters +- The GraphQL Schema (`schema.graphql`) defines the shape of the resulting data that you are using SubQuery to index +- The Mapping functions in `src/mappings/` directory are typescript functions that handle transformation logic + +SubQuery supports various layer-1 blockchain networks and provides [dedicated quick start guides](https://academy.subquery.network/quickstart/quickstart.html) as well as [detailed technical documentation](https://academy.subquery.network/build/introduction.html) for each of them. + +## Run your project + +_If you get stuck, find out how to get help below._ + +The simplest way to run your project is by running `yarn dev` or `npm run-script dev`. This does all of the following: + +1. `yarn codegen` - Generates types from the GraphQL schema definition and contract ABIs and saves them in the `/src/types` directory. This must be done after each change to the `schema.graphql` file or the contract ABIs +2. `yarn build` - Builds and packages the SubQuery project into the `/dist` directory +3. `docker-compose pull && docker-compose up` - Runs a Docker container with an indexer, PostgeSQL DB, and a query service. This requires [Docker to be installed](https://docs.docker.com/engine/install) and running locally. The configuration for this container is set from your `docker-compose.yml` + +You can observe the three services start, and once all are running (it may take a few minutes on your first start), please open your browser and head to [http://localhost:3000](http://localhost:3000) - you should see a GraphQL playground showing with the schemas ready to query. [Read the docs for more information](https://academy.subquery.network/run_publish/run.html) or [explore the possible service configuration for running SubQuery](https://academy.subquery.network/run_publish/references.html). + +## Query your project + +For this project, you can try to query with the following GraphQL code to get a taste of how it works. + +```graphql +{ + query { + swaps { + nodes { + id + firstToken { + id + } + secondToken { + id + } + pool { + id + } + } + } + } +} +``` + +You can explore the different possible queries and entities to help you with GraphQL using the documentation draw on the right. + +## Publish your project + +SubQuery is open-source, meaning you have the freedom to run it in the following three ways: + +- Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html) +- By publishing it to our enterprise-level [Managed Service](https://managedservice.subquery.network), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. We even have a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html) +- [Coming Soon] By publishing it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way + +## What Next? + +Take a look at some of our advanced features to take your project to the next level! + +- [**Multi-chain indexing support**](https://academy.subquery.network/build/multi-chain.html) - SubQuery allows you to index data from across different layer-1 networks into the same database, this allows you to query a single endpoint to get data for all supported networks. +- [**Dynamic Data Sources**](https://academy.subquery.network/build/dynamicdatasources.html) - When you want to index factory contracts, for example on a DEX or generative NFT project. +- [**Project Optimisation Advice**](https://academy.subquery.network/build/optimisation.html) - Some common tips on how to tweak your project to maximise performance. +- [**GraphQL Subscriptions**](https://academy.subquery.network/run_publish/subscription.html) - Build more reactive front end applications that subscribe to changes in your SubQuery project. + +## Need Help? + +The fastest way to get support is by [searching our documentation](https://academy.subquery.network), or by [joining our discord](https://discord.com/invite/subquery) and messaging us in the `#technical-support` channel. diff --git a/Near/near-ref-finance/docker-compose.yml b/Near/near-ref-finance/docker-compose.yml new file mode 100644 index 0000000..3aaddae --- /dev/null +++ b/Near/near-ref-finance/docker-compose.yml @@ -0,0 +1,64 @@ +version: "3" + +services: + postgres: + build: + context: . + dockerfile: ./docker/pg-Dockerfile + ports: + - 5432:5432 + volumes: + - .data/postgres:/var/lib/postgresql/data + environment: + POSTGRES_PASSWORD: postgres + healthcheck: + test: ["CMD-SHELL", "pg_isready -U postgres"] + interval: 5s + timeout: 5s + retries: 5 + + subquery-node: + image: subquerynetwork/subql-node-near:latest + depends_on: + "postgres": + condition: service_healthy + restart: always + environment: + DB_USER: postgres + DB_PASS: postgres + DB_DATABASE: postgres + DB_HOST: postgres + DB_PORT: 5432 + volumes: + - ./:/app + command: + - ${SUB_COMMAND:-} # set SUB_COMMAND env variable to "test" to run tests + - -f=/app + - --db-schema=app + - --workers=4 + healthcheck: + test: ["CMD", "curl", "-f", "http://subquery-node:3000/ready"] + interval: 3s + timeout: 5s + retries: 10 + + graphql-engine: + image: onfinality/subql-query:latest + ports: + - 3000:3000 + depends_on: + "postgres": + condition: service_healthy + "subquery-node": + condition: service_healthy + restart: always + environment: + DB_USER: postgres + DB_PASS: postgres + DB_DATABASE: postgres + DB_HOST: postgres + DB_PORT: 5432 + command: + - --name=app + - --playground + - --indexer=http://subquery-node:3000 diff --git a/Near/near-ref-finance/docker/load-extensions.sh b/Near/near-ref-finance/docker/load-extensions.sh new file mode 100644 index 0000000..6d33f86 --- /dev/null +++ b/Near/near-ref-finance/docker/load-extensions.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" < { + logger.info(`Swap found at block ${action.transaction.block_height}`); + // An Action can belong to either a transaction or a receipt + // To check which one, we can check if action.transaction is null + // If it is null, then it belongs to a receipt + if (!action.transaction) { + return; + } + let actions = action.action.args.toJson()["actions"]; + + for (let i = 0; i < actions.length; i++) { + Swap.create({ + id: `${action.transaction.block_height}-${action.transaction.result.id}-${action.id}-${i}`, + poolId: (await getOrCreatePool(JSON.stringify(actions[i]["pool_id"]))).id, + firstTokenId: ( + await getOrCreateToken(JSON.stringify(actions[i]["token_in"])) + ).id, + secondTokenId: ( + await getOrCreateToken(JSON.stringify(actions[i]["token_out"])) + ).id, + }).save(); + logger.info("Swap is saved"); + } +} + +async function getOrCreateToken(tokenid: string): Promise { + let token = await Token.get(tokenid); + if (token === undefined) { + token = Token.create({ id: tokenid }); + await token.save(); + } + return token; +} + +async function getOrCreatePool(poolid: string): Promise { + let pool = await Token.get(poolid); + if (pool === undefined) { + pool = Token.create({ id: poolid }); + await pool.save(); + } + return pool; +} diff --git a/Near/near-ref-finance/tsconfig.json b/Near/near-ref-finance/tsconfig.json new file mode 100644 index 0000000..423aae4 --- /dev/null +++ b/Near/near-ref-finance/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "emitDecoratorMetadata": true, + "experimentalDecorators": true, + "esModuleInterop": true, + "declaration": true, + "importHelpers": true, + "resolveJsonModule": true, + "module": "commonjs", + "outDir": "dist", + "rootDir": "src", + "target": "es2017", + "strict": true + }, + "include": [ + "src/**/*", + "node_modules/@subql/types-near/dist/global.d.ts", + "node_modules/@subql/types-core/dist/global.d.ts" + ] +}