feat: add ripple indexer

Author: kuco23

compose.yaml

@@ -5,6 +5,13 @@ x-templates:
       db-postgres:
         condition: service_healthy
     restart: unless-stopped
+  postgres-env: &postgres-env
+    DB_TYPE: postgres
+    DB_HOST: db-postgres
+    DB_PORT: 5432
+    DB_NAME: ${POSTGRES_DB}
+    DB_USER: ${POSTGRES_USER}
+    DB_PASSWORD: ${POSTGRES_PASSWORD}
 
 services:
   core:
@@ -13,12 +20,7 @@ services:
     profiles: ["core"]
     command: ["node", "/app/packages/fasset-indexer-core/dist/src/run/run-indexer.js"]
     environment:
-      DB_TYPE: postgres
-      DB_HOST: db-postgres
-      DB_PORT: 5432
-      DB_NAME: ${POSTGRES_DB}
-      DB_USER: ${POSTGRES_USER}
-      DB_PASSWORD: ${POSTGRES_PASSWORD}
+      <<: *postgres-env
       CHAIN: ${CHAIN}
       RPC_URL: ${RPC_URL}
       RPC_API_KEY: ${RPC_API_KEY:-}
@@ -31,12 +33,7 @@ services:
     profiles: ["watchdog"]
     command: ["node", "/app/packages/fasset-indexer-core/dist/src/run/run-watchdog.js"]
     environment:
-      DB_TYPE: postgres
-      DB_HOST: db-postgres
-      DB_PORT: 5432
-      DB_NAME: ${POSTGRES_DB}
-      DB_USER: ${POSTGRES_USER}
-      DB_PASSWORD: ${POSTGRES_PASSWORD}
+      <<: *postgres-env
       CHAIN: ${CHAIN}
       RPC_URL: ${RPC_URL}
       RPC_API_KEY: ${RPC_API_KEY:-}
@@ -46,40 +43,38 @@ services:
     profiles: ["dogecoin"]
     command: ["node", "/app/packages/fasset-indexer-doge/dist/src/run/run-indexer.js"]
     environment:
-      DB_TYPE: postgres
-      DB_HOST: db-postgres
-      DB_PORT: 5432
-      DB_NAME: ${POSTGRES_DB}
-      DB_USER: ${POSTGRES_USER}
-      DB_PASSWORD: ${POSTGRES_PASSWORD}
+      <<: *postgres-env
       DOGE_RPC_URL: ${DOGE_RPC_URL}
       DOGE_RPC_API_KEY: ${DOGE_RPC_API_KEY:-}
       DOGE_RPC_USER: ${DOGE_RPC_USER:-}
       DOGE_RPC_PASSWORD: ${DOGE_RPC_PASSWORD:-}
       DOGE_MIN_BLOCK_NUMBER: ${DOGE_MIN_BLOCK_NUMBER}
+  ripple:
+    <<: *base-svc
+    container_name: ${COMPOSE_PROJECT_NAME}-ripple
+    profiles: ["ripple"]
+    command: ["node", "/app/packages/fasset-indexer-xrp/dist/src/run/run-indexer.js"]
+    environment:
+      <<: *postgres-env
+      XRP_RPC_URL: ${XRP_RPC_URL}
+      XRP_RPC_API_KEY: ${XRP_RPC_API_KEY:-}
+      XRP_MIN_BLOCK_NUMBER: ${XRP_MIN_BLOCK_NUMBER}
   api:
     <<: *base-svc
     container_name: ${COMPOSE_PROJECT_NAME}-api
     profiles: ["api"]
     command: ["node", "/app/packages/fasset-indexer-api/dist/src/main"]
     environment:
-      DB_TYPE: postgres
-      DB_HOST: db-postgres
-      DB_PORT: 5432
-      DB_NAME: ${POSTGRES_DB}
-      DB_USER: ${POSTGRES_USER}
-      DB_PASSWORD: ${POSTGRES_PASSWORD}
+      <<: *postgres-env
       API_ROOT_PATH: ${API_ROOT_PATH:-}
     ports:
       - "${API_PORT}:3000"
   db-postgres:
     image: postgres:16
     container_name: ${COMPOSE_PROJECT_NAME}-db
-    profiles: ["core", "watchdog", "dogecoin", "api"]
+    profiles: ["core", "watchdog", "api", "ripple", "dogecoin"]
     environment:
-      POSTGRES_DB: ${POSTGRES_DB}
-      POSTGRES_USER: ${POSTGRES_USER}
-      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      <<: *postgres-env
     volumes:
       - 'db_data:/var/lib/postgresql/data'
     healthcheck:

fasset-indexer.code-workspace

@@ -12,6 +12,10 @@
 			"name": "🚀 api",
 			"path": "packages/fasset-indexer-api"
 		},
+        {
+            "name": "✕ xrp",
+            "path": "packages/fasset-indexer-xrp"
+        },
         {
             "name": "🐶 doge",
             "path": "packages/fasset-indexer-doge"

package.json

@@ -19,6 +19,7 @@
     "run-native-indexer": "yarn build-base && node packages/fasset-indexer-core/dist/src/run/run-indexer.js",
     "run-native-indexer-debug": "ts-node packages/fasset-indexer-core/src/run/run-indexer.ts",
     "run-native-watchdog": "yarn build-base && node packages/fasset-indexer-core/dist/src/run/run-watchdog.js",
+    "run-xrp-indexer": "yarn build-base && node packages/fasset-indexer-xrp/dist/src/run/run-indexer.js",
     "run-btc-indexer": "yarn build-base && node packages/fasset-indexer-btc/dist/src/run/run-indexer.js",
     "run-doge-indexer": "yarn build-base && node packages/fasset-indexer-doge/dist/src/run/run-indexer.js",
     "run-api": "yarn build && node packages/fasset-indexer-api/dist/src/main",

packages/fasset-indexer-core/src/orm/entities/index.ts

@@ -41,6 +41,7 @@ export { AssetManagerSettings } from './state/settings'
 // underlying data
 export { UnderlyingBlock } from "./underlying/block"
 export { UnderlyingAddress } from "./underlying/address"
-export { UnderlyingVoutReference } from "./underlying/reference"
+export { UnderlyingReference as UnderlyingVoutReference } from "./underlying/reference"
+export { UnderlyingTransaction } from "./underlying/transaction"
 // building event bound stuff
 export { EventBound, FAssetEventBound } from "./events/_bound"

packages/fasset-indexer-core/src/orm/entities/underlying/reference.ts

@@ -2,11 +2,12 @@ import { Entity, ManyToOne, Property, PrimaryKey, Unique, Enum } from "@mikro-or
 import { UnderlyingBlock } from "./block"
 import { UnderlyingAddress } from "../underlying/address"
 import { FAssetType } from "../../../shared"
+import { UnderlyingTransaction } from "./transaction"
 
 
 @Entity()
-@Unique({ properties: ['fasset', 'block', 'reference', 'transactionHash'] })
-export class UnderlyingVoutReference {
+@Unique({ properties: ['fasset', 'block', 'reference', 'transaction'] })
+export class UnderlyingReference {
 
   @PrimaryKey({ autoincrement: true, type: 'integer' })
   id!: number
@@ -17,19 +18,19 @@ export class UnderlyingVoutReference {
   @Property({ type: 'text' })
   reference: string
 
-  @Property({ type: 'text' })
-  transactionHash: string
+  @ManyToOne({ entity: () => UnderlyingTransaction })
+  transaction: UnderlyingTransaction
 
   @ManyToOne(() => UnderlyingAddress)
   address: UnderlyingAddress
 
   @ManyToOne(() => UnderlyingBlock)
   block: UnderlyingBlock
 
-  constructor(fasset: FAssetType, reference: string, transactionHash: string, address: UnderlyingAddress, block: UnderlyingBlock) {
+  constructor(fasset: FAssetType, reference: string, transaction: UnderlyingTransaction, address: UnderlyingAddress, block: UnderlyingBlock) {
     this.fasset = fasset
     this.reference = reference
-    this.transactionHash = transactionHash
+    this.transaction = transaction
     this.address = address
     this.block = block
   }

packages/fasset-indexer-core/src/orm/entities/underlying/transaction.ts

@@ -0,0 +1,27 @@
+import { Entity, ManyToOne, PrimaryKey, Property } from "@mikro-orm/core"
+import { UnderlyingBlock } from "./block"
+import { uint256 } from "../../custom/uint"
+
+
+@Entity()
+export class UnderlyingTransaction {
+
+  @PrimaryKey({ type: 'integer', autoincrement: true })
+  id!: number
+
+  @ManyToOne({ entity: () => UnderlyingBlock })
+  block: UnderlyingBlock
+
+  @Property({ type: 'text', unique: true })
+  hash: string
+
+  @Property({ type: new uint256() })
+  value: bigint
+
+  constructor(block: UnderlyingBlock, hash: string, value: bigint) {
+    this.block = block
+    this.hash = hash
+    this.value = value
+  }
+
+}

packages/fasset-indexer-core/src/orm/index.ts

@@ -2,5 +2,5 @@ export { createOrm } from "./mikro-orm.config"
 export { raw } from "@mikro-orm/core"
 export { EntityManager, SelectQueryBuilder } from "@mikro-orm/knex"
 export { ZeroAddress } from 'ethers' // for database lookup
-export { getVar, setVar, findOrCreateUnderlyingAddress } from "./utils"
+export { getVar, setVar, findOrCreateUnderlyingAddress, findOrCreateUnderlyingTransaction } from "./utils"
 export { OrmOptions, ORM, AddressType } from "./interface"

packages/fasset-indexer-core/src/orm/mikro-orm.config.ts

@@ -51,7 +51,7 @@ import { FtsoPrice } from "./entities/state/price"
 import { TokenBalance } from "./entities/state/balance"
 import { UnderlyingBlock } from "./entities/underlying/block"
 import { UnderlyingAddress } from "./entities/underlying/address"
-import { UnderlyingVoutReference } from "./entities/underlying/reference"
+import { UnderlyingReference } from "./entities/underlying/reference"
 import { updateSchema } from "./utils"
 import { MIN_DATABASE_POOL_CONNECTIONS, MAX_DATABASE_POOL_CONNECTIONS } from "../config/constants"
 import type { Options } from "@mikro-orm/core"
@@ -86,7 +86,7 @@ export const ORM_OPTIONS: Options<AbstractSqlDriver> = defineConfig({
     EscrowFinished, CoreVaultManagerCustodianAddressUpdated,
     AssetManagerSettings, CoreVaultManagerSettings,
     // underlying
-    UnderlyingBlock, UnderlyingVoutReference, UnderlyingAddress
+    UnderlyingBlock, UnderlyingReference, UnderlyingAddress
   ],
   pool: {
     min: MIN_DATABASE_POOL_CONNECTIONS,

packages/fasset-indexer-core/src/orm/utils.ts

@@ -2,6 +2,7 @@ import { Var } from "../orm/entities/state/var"
 import { UnderlyingAddress } from "../orm/entities/underlying/address"
 import type { EntityManager } from "@mikro-orm/core"
 import type { ORM, SchemaUpdate, AddressType } from "./interface"
+import { UnderlyingBlock, UnderlyingTransaction } from "./entities";
 
 
 export async function updateSchema(orm: ORM, update: SchemaUpdate = "full"): Promise<void> {
@@ -45,4 +46,13 @@ export async function findOrCreateUnderlyingAddress(em: EntityManager, address:
     em.persist(underlyingAddress)
   }
   return underlyingAddress
+}
+
+export async function findOrCreateUnderlyingTransaction(em: EntityManager, hash: string, block: UnderlyingBlock, value: bigint): Promise<UnderlyingTransaction> {
+  let underlyingTransaction = await em.findOne(UnderlyingTransaction, { hash })
+  if (!underlyingTransaction) {
+    underlyingTransaction = new UnderlyingTransaction(block, hash, value)
+    em.persist(underlyingTransaction)
+  }
+  return underlyingTransaction
 }

packages/fasset-indexer-core/src/utils/reference.ts

@@ -2,7 +2,6 @@
 export namespace PaymentReference {
     export const TYPE_SHIFT = BigInt(192)
     export const LOW_BITS_MASK = (BigInt(1) << TYPE_SHIFT) - BigInt(1)
-
     // common prefix 0x464250526641 = hex('FBPRfA' - Flare Bridge Payment Reference / fAsset)
 
     export function isValid(reference: string | null): reference is string {