feat: index core vault manager settings

Author: kuco23

packages/fasset-indexer-core/src/context/context.ts

@@ -1,8 +1,8 @@
 import { JsonRpcProvider, FetchRequest } from "ethers"
 import { createOrm } from "../orm/mikro-orm.config"
 import { ContractLookup } from "./lookup"
-import { IAssetManager__factory, IERC20__factory, IAgentOwnerRegistry__factory, IPriceReader__factory } from "../../chain/typechain"
-import type { IAssetManager, IERC20, IAgentOwnerRegistry, IPriceReader } from "../../chain/typechain"
+import { IAssetManager__factory, IERC20__factory, IAgentOwnerRegistry__factory, IPriceReader__factory, ICoreVaultManager__factory } from "../../chain/typechain"
+import type { IAssetManager, IERC20, IAgentOwnerRegistry, IPriceReader, ICoreVaultManager } from "../../chain/typechain"
 import type { ORM } from "../orm/interface"
 import type { ConfigLoader } from "../config/config"
 
@@ -32,6 +32,10 @@ export class Context extends ContractLookup {
     return IAssetManager__factory.connect(address, this.provider)
   }
 
+  getCoreVaultManagerContract(address: string): ICoreVaultManager {
+    return ICoreVaultManager__factory.connect(address, this.provider)
+  }
+
   getERC20(address: string): IERC20 {
     return IERC20__factory.connect(address, this.provider)
   }

packages/fasset-indexer-core/src/context/lookup.ts

@@ -12,6 +12,7 @@ export class ContractLookup extends EventInterface {
   private fAssetTokenToFAsset__cache: Map<string, FAssetType> = new Map()
   private fAssetToFAssetToken__cache: Map<FAssetType, string> = new Map()
   private coreVaultToFAsset__cache: Map<string, FAssetType> = new Map()
+  private fAssetToCoreVault__cache: Map<FAssetType, string> = new Map()
   // public
   public fassetTokens: string[] = []
   public contractInfos!: ContractInfo[]
@@ -86,6 +87,14 @@ export class ContractLookup extends EventInterface {
     }
   }
 
+  fassetTypeToCoreVaultManagerAddress(type: FAssetType): string {
+    if (this.fAssetToCoreVault__cache.get(type)) {
+      return this.fAssetToCoreVault__cache.get(type)!
+    } else {
+      throw new Error(`No core vault manager found for type ${type}`)
+    }
+  }
+
   getContractAddress(name: string): string {
     for (const contract of this.contractInfos) {
       if (contract.name === name)
@@ -108,6 +117,7 @@ export class ContractLookup extends EventInterface {
       const fasset = this.contractNameToFAssetType(contract.name, 'CoreVaultManager_')
       if (fasset == null) continue
       this.coreVaultToFAsset__cache.set(contract.address, fasset)
+      this.fAssetToCoreVault__cache.set(fasset, contract.address)
     }
   }
 

packages/fasset-indexer-core/src/indexer/eventlib/event-storer.ts

@@ -137,6 +137,7 @@ import type { TransferEvent } from "../../../chain/typechain/IERC20"
 import type { CurrentUnderlyingBlockUpdatedEvent, RedeemedInCollateralEvent } from "../../../chain/typechain/IAssetManager"
 import type { PricesPublishedEvent } from "../../../chain/typechain/IPriceChangeEmitter"
 import type { ORM } from "../../orm/interface"
+import { CoreVaultManagerSettings } from "../../orm/entities/state/settings"
 
 
 export class EventStorer {
@@ -969,11 +970,17 @@ export class EventStorer {
   // core vault manager
 
   protected async onCoreVaultManagerSettingsUpdated(em: EntityManager, evmLog: EvmLog, logArgs: SettingsUpdatedEvent.OutputTuple):
-    Promise<CoreVaultManagerSettingsUpdated>
+    Promise<[CoreVaultManagerSettings, CoreVaultManagerSettingsUpdated]>
   {
     const fasset = this.lookup.coreVaultManagerToFAssetType(evmLog.address.hex)
     const [ escrowEndTimeSeconds, escrowAmount, minimalAmount, fee ] = logArgs
-    return new CoreVaultManagerSettingsUpdated(evmLog, fasset, escrowEndTimeSeconds, escrowAmount, minimalAmount, fee)
+    const settings = await em.findOneOrFail(CoreVaultManagerSettings, { fasset })
+    settings.escrowEndTimeSeconds = Number(escrowEndTimeSeconds)
+    settings.escrowAmount = escrowAmount
+    settings.minimalAmount = minimalAmount
+    settings.chainPaymentFee = fee
+    const settingsUpdated = new CoreVaultManagerSettingsUpdated(evmLog, fasset, Number(escrowEndTimeSeconds), escrowAmount, minimalAmount, fee)
+    return [settings, settingsUpdated]
   }
 
   protected async onCustodianAddressUpdated(em: EntityManager, evmLog: EvmLog, logArgs: CustodianAddressUpdatedEvent.OutputTuple):

packages/fasset-indexer-core/src/orm/entities/events/core-vault-manager.ts

@@ -10,8 +10,8 @@ import { UnderlyingAddress } from "../underlying/address"
 @Entity()
 export class CoreVaultManagerSettingsUpdated extends FAssetEventBound {
 
-  @Property({ type: new uint256() })
-  escrowEndTimeSeconds: bigint
+  @Property({ type: 'integer' })
+  escrowEndTimeSeconds: number
 
   @Property({ type: new uint256() })
   escrowAmount: bigint
@@ -23,7 +23,7 @@ export class CoreVaultManagerSettingsUpdated extends FAssetEventBound {
   fee: bigint
 
   constructor(evmLog: EvmLog, fasset: FAssetType,
-    escrowEndTimeSeconds: bigint, escrowAmount: bigint,
+    escrowEndTimeSeconds: number, escrowAmount: bigint,
     minimalAmount: bigint, fee: bigint
   ) {
     super(evmLog, fasset)

packages/fasset-indexer-core/src/orm/entities/state/settings.ts

@@ -16,4 +16,31 @@ export class AssetManagerSettings {
     this.lotSizeAmg = lotSizeAmg
   }
 
+}
+
+@Entity()
+export class CoreVaultManagerSettings {
+
+  @Enum({ type: () => FAssetType, primary: true })
+  fasset: FAssetType
+
+  @Property({ type: new uint256() })
+  escrowAmount: bigint
+
+  @Property({ type: new uint256() })
+  minimalAmount: bigint
+
+  @Property({ type: 'integer' })
+  escrowEndTimeSeconds: number
+
+  @Property({ type: new uint256() })
+  chainPaymentFee: bigint
+
+  constructor(fasset: FAssetType, escrowAmount: bigint, minimalAmount: bigint, escrowEndTimeSeconds: number, chainPaymentFee: bigint) {
+    this.fasset = fasset
+    this.escrowAmount = escrowAmount
+    this.minimalAmount = minimalAmount
+    this.escrowEndTimeSeconds = escrowEndTimeSeconds
+    this.chainPaymentFee = chainPaymentFee
+  }
 }

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

@@ -46,7 +46,7 @@ import {
 import { CoreVaultManagerCustodianAddressUpdated, CoreVaultManagerPaymentConfirmed, CoreVaultManagerSettingsUpdated, CoreVaultManagerTransferRequestCanceled, CoreVaultManagerTransferRequested, EscrowFinished, CoreVaultManagerEscrowInstructions, CoreVaultManagerNotAllEscrowsProcessed, CoreVaultManagerPaymentInstructions } from "./entities/events/core-vault-manager"
 import { AgentVaultInfo, AgentVaultSettings } from "./entities/state/agent"
 import { AgentManager, AgentOwner, AgentVault } from "./entities/agent"
-import { AssetManagerSettings } from "./entities"
+import { AssetManagerSettings, CoreVaultManagerSettings } from "./entities/state/settings"
 import { FtsoPrice } from "./entities/state/price"
 import { TokenBalance } from "./entities/state/balance"
 import { UnderlyingBlock } from "./entities/underlying/block"
@@ -84,7 +84,7 @@ export const ORM_OPTIONS: Options<AbstractSqlDriver> = defineConfig({
     CoreVaultManagerPaymentConfirmed, CoreVaultManagerPaymentInstructions, CoreVaultManagerEscrowInstructions,
     CoreVaultManagerTransferRequested, CoreVaultManagerTransferRequestCanceled, CoreVaultManagerNotAllEscrowsProcessed,
     EscrowFinished, CoreVaultManagerCustodianAddressUpdated,
-    AssetManagerSettings,
+    AssetManagerSettings, CoreVaultManagerSettings,
     // underlying
     UnderlyingBlock, UnderlyingVoutReference, UnderlyingAddress
   ],

packages/fasset-indexer-core/src/run/ensure-data.ts

@@ -0,0 +1,44 @@
+import { Context } from "../context/context"
+import { AssetManagerSettings } from "../orm/entities"
+import { CoreVaultManagerSettings } from "../orm/entities/state/settings"
+import { FASSETS, FAssetType } from "../shared"
+
+
+export async function ensureData(context: Context) {
+  await ensureAssetManagerSettings(context)
+  await ensureCoreVaultManagerSettings(context)
+}
+
+async function ensureAssetManagerSettings(context: Context) {
+  for (const _fasset of FASSETS) {
+    const fasset = FAssetType[_fasset]
+    if (!context.supportsFAsset(fasset)) continue
+    await context.orm.em.transactional(async em => {
+      let assetManagerSettings = await em.findOne(AssetManagerSettings, { fasset })
+      if (assetManagerSettings == null) {
+        const assetManagerAddress = context.fAssetTypeToAssetManagerAddress(fasset)
+        const assetManager = context.getAssetManagerContract(assetManagerAddress)
+        const settings = await assetManager.getSettings()
+        assetManagerSettings = new AssetManagerSettings(fasset, settings.lotSizeAMG)
+        em.persist(assetManagerSettings)
+      }
+    })
+  }
+}
+
+async function ensureCoreVaultManagerSettings(context: Context) {
+  const fasset = FAssetType.FXRP
+  await context.orm.em.transactional(async em => {
+    let coreVaultManagerSettings = await em.findOne(CoreVaultManagerSettings, { fasset })
+    if (coreVaultManagerSettings == null) {
+      const coreVaultManagerAddress = context.fassetTypeToCoreVaultManagerAddress(fasset)
+      const coreVaultManager = context.getCoreVaultManagerContract(coreVaultManagerAddress)
+      const settings = await coreVaultManager.getSettings()
+      coreVaultManagerSettings = new CoreVaultManagerSettings(fasset,
+        settings._escrowAmount, settings._minimalAmount,
+        Number(settings._escrowEndTimeSeconds), settings._fee
+      )
+      em.persist(coreVaultManagerSettings)
+    }
+  })
+}

packages/fasset-indexer-core/src/run/ensure_data.ts

@@ -1,6 +1,6 @@
 import { EventIndexer } from "../indexer/indexer"
 import { ensureConfigIntegrity } from "./integrity"
-import { ensureData } from "./ensure_data"
+import { ensureData } from "./ensure-data"
 import { ConfigLoader } from "../config/config"
 import { Context } from "../context/context"
 import { logger } from "../logger"

packages/fasset-indexer-core/src/run/run-indexer.ts

@@ -38,6 +38,7 @@ import {
 } from "../src/orm/entities/events/core-vault"
 import { CoreVaultManagerSettingsUpdated } from "../src/orm/entities/events/core-vault-manager"
 import { AssetManagerSettings } from "../src/orm/entities"
+import { CoreVaultManagerSettings } from "../src/orm/entities/state/settings"
 
 
 const ASSET_MANAGER_FXRP = "AssetManager_FTestXRP"
@@ -708,17 +709,24 @@ describe("FAsset evm events", () => {
   describe("core vault manager", () => {
     it("should store settings updated", async () => {
       const coreVaultManagerXrp = context.getContractAddress(CORE_VAULT_MANAGER_FXRP)
+      await fixture.storeInitialCoreVaultManagerSettings()
       const em = context.orm.em.fork()
       const esu = await fixture.generateEvent(EVENTS.CORE_VAULT_MANAGER.SETTINGS_UPDATED, coreVaultManagerXrp)
       await storer.processEventUnsafe(em, esu)
       const su = await em.findOneOrFail(CoreVaultManagerSettingsUpdated,
         { evmLog: { block: { index: esu.blockNumber }, index: esu.logIndex }}
       )
       expect(su.fasset).to.equal(FAssetType.FXRP)
-      expect(su.escrowEndTimeSeconds).to.equal(esu.args[0])
+      expect(su.escrowEndTimeSeconds).to.equal(Number(esu.args[0]))
       expect(su.escrowAmount).to.equal(esu.args[1])
       expect(su.minimalAmount).to.equal(esu.args[2])
       expect(su.fee).to.equal(esu.args[3])
+      const cvms = await em.findOneOrFail(CoreVaultManagerSettings, { fasset: FAssetType.FXRP })
+      expect(cvms.fasset).to.equal(FAssetType.FXRP)
+      expect(cvms.escrowEndTimeSeconds).to.equal(su.escrowEndTimeSeconds)
+      expect(cvms.escrowAmount).to.equal(su.escrowAmount)
+      expect(cvms.minimalAmount).to.equal(su.minimalAmount)
+      expect(cvms.chainPaymentFee).to.equal(su.fee)
     })
   })