diff --git a/Stellar/soroban-starter/.github/scripts/publish-deploy.sh b/Stellar/soroban-starter/.github/scripts/publish-deploy.sh new file mode 100644 index 0000000..3c9dc04 --- /dev/null +++ b/Stellar/soroban-starter/.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/Stellar/soroban-starter/.github/workflows/cli-deploy.yml b/Stellar/soroban-starter/.github/workflows/cli-deploy.yml new file mode 100644 index 0000000..658d2c6 --- /dev/null +++ b/Stellar/soroban-starter/.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/Stellar/soroban-starter/.github/workflows/pr.yml b/Stellar/soroban-starter/.github/workflows/pr.yml new file mode 100644 index 0000000..47e66be --- /dev/null +++ b/Stellar/soroban-starter/.github/workflows/pr.yml @@ -0,0 +1,24 @@ +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 + - name: Install subql-node-stellar + run: yarn global add @subql/node-stellar + - name: Run tests with Subquery Node + run: subql-node-stellar test -f ${{ github.workspace }} diff --git a/Stellar/soroban-starter/.gitignore b/Stellar/soroban-starter/.gitignore new file mode 100644 index 0000000..9615e3c --- /dev/null +++ b/Stellar/soroban-starter/.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/Stellar/soroban-starter/LICENSE b/Stellar/soroban-starter/LICENSE new file mode 100644 index 0000000..76e70cc --- /dev/null +++ b/Stellar/soroban-starter/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/Stellar/soroban-starter/README.md b/Stellar/soroban-starter/README.md new file mode 100644 index 0000000..47f2cc8 --- /dev/null +++ b/Stellar/soroban-starter/README.md @@ -0,0 +1,150 @@ +# SubQuery - Example Project for Stellar Soroban + +[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). + +**The example project indexes all soroban transfer events on Stellar's Mainnet. It also indexes all account payments including credits and debits** + +## 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 { + transfers(first: 5, orderBy: VALUE_DESC) { + totalCount + nodes { + id + date + ledger + toId + fromId + value + } + } + accounts(first: 5, orderBy: SENT_TRANSFERS_COUNT_DESC) { + nodes { + id + sentTransfers(first: 5, orderBy: LEDGER_DESC) { + totalCount + nodes { + id + toId + value + } + } + firstSeenLedger + lastSeenLedger + } + } + } +} +``` + +Results: + +``` +{ + "data": { + "query": { + "transfers": { + "totalCount": 0, + "nodes": [] + }, + "accounts": { + "nodes": [ + { + "id": "gbtbdklzbabdgnpvdygchqzxqxkjfu73ayhls44j7u26ti6lzvlzfg5a", + "sentTransfers": { + "totalCount": 0, + "nodes": [] + }, + "firstSeenLedger": 1700000, + "lastSeenLedger": 1700000 + }, + { + "id": "gdea4efymx2vcx7hduurwvuy6de36qihe6faouhuzaldgul4ooq5euvu", + "sentTransfers": { + "totalCount": 0, + "nodes": [] + }, + "firstSeenLedger": 1700000, + "lastSeenLedger": 1700000 + }, + { + "id": "gcbwgcat2nhokpnr2toy6o3qdky22lzzeydwh4azhdyyl57qfu53ugzr", + "sentTransfers": { + "totalCount": 0, + "nodes": [] + }, + "firstSeenLedger": 1700000, + "lastSeenLedger": 1700000 + }, + { + "id": "gb7yga2xmamr6wqb2z5c4l6s2imudrqzu7zxdpr4df2dewcxpxhmzjy5", + "sentTransfers": { + "totalCount": 0, + "nodes": [] + }, + "firstSeenLedger": 1700000, + "lastSeenLedger": 1700000 + } + ] + } + } + } +} +``` + +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/Stellar/soroban-starter/docker-compose.yml b/Stellar/soroban-starter/docker-compose.yml new file mode 100644 index 0000000..e661410 --- /dev/null +++ b/Stellar/soroban-starter/docker-compose.yml @@ -0,0 +1,65 @@ +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-stellar: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=1 # The more the faster + - --batch-size=5 # The higher the faster, set low to avoid rate limit on SDF endpoint + healthcheck: + test: ["CMD", "curl", "-f", "http://subquery-node:3000/ready"] + interval: 3s + timeout: 5s + retries: 10 + + graphql-engine: + image: subquerynetwork/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/Stellar/soroban-starter/docker/load-extensions.sh b/Stellar/soroban-starter/docker/load-extensions.sh new file mode 100644 index 0000000..06ae32d --- /dev/null +++ b/Stellar/soroban-starter/docker/load-extensions.sh @@ -0,0 +1,6 @@ + +#!/bin/sh + +psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" < +): Promise { + logger.info(`Indexing operation ${op.id}, type: ${op.type}`); + + const fromAccount = await checkAndGetAccount(op.from, op.ledger.sequence); + const toAccount = await checkAndGetAccount(op.to, op.ledger.sequence); + + const payment = Payment.create({ + id: op.id, + fromId: fromAccount.id, + toId: toAccount.id, + txHash: op.transaction_hash, + amount: op.amount, + }); + + fromAccount.lastSeenLedger = op.ledger.sequence; + toAccount.lastSeenLedger = op.ledger.sequence; + await Promise.all([fromAccount.save(), toAccount.save(), payment.save()]); +} + +export async function handleCredit( + effect: StellarEffect +): Promise { + logger.info(`Indexing effect ${effect.id}, type: ${effect.type}`); + + const account = await checkAndGetAccount( + effect.account, + effect.ledger.sequence + ); + + const credit = Credit.create({ + id: effect.id, + accountId: account.id, + amount: effect.amount, + }); + + account.lastSeenLedger = effect.ledger.sequence; + await Promise.all([account.save(), credit.save()]); +} + +export async function handleDebit( + effect: StellarEffect +): Promise { + logger.info(`Indexing effect ${effect.id}, type: ${effect.type}`); + + const account = await checkAndGetAccount( + effect.account, + effect.ledger.sequence + ); + + const debit = Debit.create({ + id: effect.id, + accountId: account.id, + amount: effect.amount, + }); + + account.lastSeenLedger = effect.ledger.sequence; + await Promise.all([account.save(), debit.save()]); +} + +export async function handleEvent(event: SorobanEvent): Promise { + logger.info(`New transfer event found at block ${event.ledger.sequence.toString()}`); + + // Get data from the event + // The transfer event has the following payload \[env, from, to\] + // logger.info(JSON.stringify(event)); + const { + topic: [env, from, to] + } = event; + + try { + decodeAddress(from) + decodeAddress(to) + }catch (e) { + logger.info(`decode address failed`) + } + + const fromAccount = await checkAndGetAccount(decodeAddress(from), event.ledger.sequence); + const toAccount = await checkAndGetAccount(decodeAddress(to), event.ledger.sequence); + + // Create the new transfer entity + const transfer = Transfer.create({ + id: event.id, + ledger: event.ledger.sequence, + date: new Date(event.ledgerClosedAt), + contract: event.contractId?.contractId().toString()!, + fromId: fromAccount.id, + toId: toAccount.id, + value: BigInt(event.value.decoded!), + }); + + fromAccount.lastSeenLedger = event.ledger.sequence; + toAccount.lastSeenLedger = event.ledger.sequence; + await Promise.all([fromAccount.save(), toAccount.save(), transfer.save()]); +} + +async function checkAndGetAccount( + id: string, + ledgerSequence: number +): Promise { + let account = await Account.get(id.toLowerCase()); + if (!account) { + // We couldn't find the account + account = Account.create({ + id: id.toLowerCase(), + firstSeenLedger: ledgerSequence, + }); + } + return account; +} + +// scValToNative not works, temp solution +function decodeAddress(scVal:xdr.ScVal):string{ + try { + return Address.account(scVal.address().accountId().ed25519()).toString(); + }catch (e) { + return Address.contract( + scVal.address().contractId()).toString(); + } + + +} \ No newline at end of file diff --git a/Stellar/soroban-starter/src/test/mappingHandlers.test.ts b/Stellar/soroban-starter/src/test/mappingHandlers.test.ts new file mode 100644 index 0000000..42f41c3 --- /dev/null +++ b/Stellar/soroban-starter/src/test/mappingHandlers.test.ts @@ -0,0 +1,12 @@ +import { subqlTest } from "@subql/testing"; + +/* +// https://academy.subquery.network/build/testing.html +subqlTest( + "testName", // test name + 1000003, // block height to process + [], // dependent entities + [], // expected entities + "handleEvent" //handler name +); +*/ diff --git a/Stellar/soroban-starter/tsconfig.json b/Stellar/soroban-starter/tsconfig.json new file mode 100644 index 0000000..f2f0fdb --- /dev/null +++ b/Stellar/soroban-starter/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-core/dist/global.d.ts", + "node_modules/@subql/types-stellar/dist/global.d.ts" + ] +} diff --git a/Stellar/soroban-testnet-starter/package.json b/Stellar/soroban-testnet-starter/package.json index e327a8f..0a8a279 100644 --- a/Stellar/soroban-testnet-starter/package.json +++ b/Stellar/soroban-testnet-starter/package.json @@ -22,8 +22,7 @@ "license": "MIT", "dependencies": { "@subql/common": "latest", - "@subql/types-stellar": "latest", - "@subql/validator": "latest" + "@subql/types-stellar": "latest" }, "devDependencies": { "@subql/cli": "latest", diff --git a/Stellar/soroban-testnet-starter/project.ts b/Stellar/soroban-testnet-starter/project.ts index 98c56df..5ff97fb 100644 --- a/Stellar/soroban-testnet-starter/project.ts +++ b/Stellar/soroban-testnet-starter/project.ts @@ -49,7 +49,7 @@ const project: StellarProject = { { kind: StellarDatasourceKind.Runtime, /* Set this as a logical start block, it might be block 1 (genesis) or when your contract was deployed */ - startBlock: 1700000, + startBlock: 228206, mapping: { file: "./dist/index.js", handlers: [ @@ -57,7 +57,7 @@ const project: StellarProject = { handler: "handleOperation", kind: StellarHandlerKind.Operation, filter: { - type: Horizon.OperationResponseType.payment, + type: Horizon.HorizonApi.OperationResponseType.payment, }, }, { diff --git a/Stellar/soroban-testnet-starter/src/mappings/mappingHandlers.ts b/Stellar/soroban-testnet-starter/src/mappings/mappingHandlers.ts index c15f7ee..4a6fcaa 100644 --- a/Stellar/soroban-testnet-starter/src/mappings/mappingHandlers.ts +++ b/Stellar/soroban-testnet-starter/src/mappings/mappingHandlers.ts @@ -4,11 +4,13 @@ import { StellarEffect, SorobanEvent, } from "@subql/types-stellar"; -import { AccountCredited, AccountDebited } from "stellar-sdk/lib/types/effects"; -import { Horizon } from "stellar-sdk"; +import { AccountCredited, AccountDebited } from "stellar-sdk/lib/horizon/types/effects"; +import { Horizon, } from "stellar-sdk"; +import { Address,xdr,} from 'soroban-client'; +import {logger} from "ethers"; export async function handleOperation( - op: StellarOperation + op: StellarOperation ): Promise { logger.info(`Indexing operation ${op.id}, type: ${op.type}`); @@ -69,24 +71,31 @@ export async function handleDebit( } export async function handleEvent(event: SorobanEvent): Promise { - logger.info(`New transfer event found at block ${event.ledger}`); + logger.info(`New transfer event found at block ${event.ledger.sequence.toString()}`); // Get data from the event // The transfer event has the following payload \[env, from, to\] // logger.info(JSON.stringify(event)); const { - topic: [env, from, to], + topic: [env, from, to] } = event; - const fromAccount = await checkAndGetAccount(from, event.ledger.sequence); - const toAccount = await checkAndGetAccount(to, event.ledger.sequence); + try { + decodeAddress(from) + decodeAddress(to) + }catch (e) { + logger.info(`decode address failed`) + } + + const fromAccount = await checkAndGetAccount(decodeAddress(from), event.ledger.sequence); + const toAccount = await checkAndGetAccount(decodeAddress(to), event.ledger.sequence); // Create the new transfer entity const transfer = Transfer.create({ id: event.id, ledger: event.ledger.sequence, date: new Date(event.ledgerClosedAt), - contract: event.contractId, + contract: event.contractId?.contractId().toString()!, fromId: fromAccount.id, toId: toAccount.id, value: BigInt(event.value.decoded!), @@ -111,3 +120,15 @@ async function checkAndGetAccount( } return account; } + +// scValToNative not works, temp solution +function decodeAddress(scVal:xdr.ScVal):string{ + try { + return Address.account(scVal.address().accountId().ed25519()).toString(); + }catch (e) { + return Address.contract( + scVal.address().contractId()).toString(); + } + + +} \ No newline at end of file