fix: setting previously null value to uint256 database value due to updated "redemptionPoolFeeShareBIPS" agent setting

Author: kuco23

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

@@ -575,7 +575,7 @@ export class EventStorer {
         agentSettings.redemptionPoolFeeShareBIPS = BigInt(value)
         break
       } default: {
-        break
+        throw new Error(`agent has no setting ${name}`)
       }
     }
   }

packages/fasset-indexer-core/src/orm/custom/uint.ts

@@ -1,18 +1,24 @@
 import { Type } from '@mikro-orm/core'
 
 
-export class uint256 extends Type<bigint, string> {
+export class uint256 extends Type<bigint | null | undefined, string | null | undefined> {
 
-  convertToDatabaseValue(value: bigint): string {
-    return value.toString()
+  convertToDatabaseValue(value: bigint | null | undefined): string | null {
+    if (value === null || value === undefined) {
+      return null;
+    }
+    return value.toString();
   }
 
-  convertToJSValue(value: string): bigint {
-    return BigInt(value)
+  convertToJSValue(value: string | null | undefined): bigint | null {
+    if (value === null || value === undefined) {
+      return null;
+    }
+    return BigInt(value);
   }
 
   getColumnType() {
-    return `NUMERIC(78)`
+    return `NUMERIC(78)`; // or DECIMAL(78), depending on your DB
   }
 }
 

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

@@ -2,5 +2,9 @@ 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, findOrCreateUnderlyingTransaction, updateUnderlyingBalance } from "./utils"
+export {
+  getVar, setVar, findOrCreateUnderlyingAddress,
+  findOrCreateUnderlyingTransaction, updateUnderlyingBalance,
+  findOrCreateUnderlyingBlock
+} from "./utils"
 export { OrmOptions, ORM, AddressType } from "./interface"

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

@@ -48,6 +48,15 @@ export async function findOrCreateUnderlyingAddress(em: EntityManager, address:
   return underlyingAddress
 }
 
+export async function findOrCreateUnderlyingBlock(em: EntityManager, index: number, hash: string, timestamp: number): Promise<UnderlyingBlock> {
+  let underlyingBlock = await em.findOne(UnderlyingBlock, { height: index })
+  if (!underlyingBlock) {
+    underlyingBlock = new UnderlyingBlock(hash, index, timestamp)
+    em.persist(underlyingBlock)
+  }
+  return underlyingBlock
+}
+
 export async function findOrCreateUnderlyingTransaction(
   em: EntityManager, hash: string, block: UnderlyingBlock, value: bigint,
   source: UnderlyingAddress, target?: UnderlyingAddress

packages/fasset-indexer-core/test/events.test.ts

@@ -125,11 +125,10 @@ describe("FAsset evm events", () => {
 
   it("should store agent created event", async () => {
     const assetManager = context.getContractAddress(ASSET_MANAGER_FXRP)
-    await fixture.storeInitialAgents()
     const em = context.orm.em.fork()
     // add initial collateral token type
     const collateralTypeAddedEvent = await fixture.generateEvent(EVENTS.ASSET_MANAGER.COLLATERAL_TYPE_ADDED, assetManager)
-    await storer.processEventUnsafe(em, collateralTypeAddedEvent)
+    await storer.processEvent(collateralTypeAddedEvent)
     const collateralTypeAdded = await em.findOneOrFail(CollateralTypeAdded,
       { evmLog: { index: collateralTypeAddedEvent.logIndex, block: { index: collateralTypeAddedEvent.blockNumber }}},
       { populate: ['evmLog.block', 'address'] })
@@ -138,6 +137,8 @@ describe("FAsset evm events", () => {
     expect(collateralTypeAdded.evmLog.block.index).to.equal(collateralTypeAddedEvent.blockNumber)
     expect(collateralTypeAdded.address.hex).to.equal(collateralTypeAddedEvent.args[1])
     expect(collateralTypeAdded.fasset).to.equal(FAssetType.FXRP)
+    // store agents
+    await fixture.storeInitialAgents(FAssetType.FXRP, true)
     // create agent
     const agentVaultCreatedEvent = await fixture.generateEvent(EVENTS.ASSET_MANAGER.AGENT_VAULT_CREATED, assetManager)
     await storer.processEventUnsafe(em, agentVaultCreatedEvent)
@@ -860,4 +861,17 @@ describe("FAsset evm events", () => {
     })
   })
 
+  describe("edge cases", async () => {
+    it("should fetch null bigint when storing agent settings updated", async () => {
+      const assetManager = context.getContractAddress(ASSET_MANAGER_FXRP)
+      // add initial collateral token type
+      const collateralTypeAddedEvent = await fixture.generateEvent(EVENTS.ASSET_MANAGER.COLLATERAL_TYPE_ADDED, assetManager)
+      await storer.processEvent(collateralTypeAddedEvent)
+      // store
+      await fixture.storeInitialAgents(FAssetType.FXRP, true)
+      const settingChanged = await fixture.generateEvent(EVENTS.ASSET_MANAGER.AGENT_SETTING_CHANGED, assetManager)
+      await storer.processEvent(settingChanged)
+    })
+  })
+
 })

packages/fasset-indexer-core/test/fixtures/constants.ts

@@ -11,6 +11,5 @@ export const AGENT_SETTINGS = [
   'mintingPoolCollateralRatioBIPS',
   'buyFAssetByAgentFactorBIPS',
   'poolExitCollateralRatioBIPS',
-  'poolTopupCollateralRatioBIPS',
-  'poolTopupTokenPriceFactorBIPS'
+  'redemptionPoolFeeShareBIPS'
 ]

packages/fasset-indexer-core/test/fixtures/events/event.ts

@@ -9,6 +9,7 @@ import { EventGeneration } from "./generate"
 import { EVENTS } from "../../../src/config"
 import type { Event } from "../../../src/indexer/eventlib/event-scraper"
 import type { EventNameToEventArgs } from "./types"
+import { AgentVaultSettings, CollateralTypeAdded } from "../../../src/orm/entities"
 
 
 export class EventFixture extends EventGeneration {
@@ -22,7 +23,7 @@ export class EventFixture extends EventGeneration {
     })
   }
 
-  async storeInitialAgents(fasset: FAssetType = FAssetType.FXRP): Promise<AgentVault[]> {
+  async storeInitialAgents(fasset: FAssetType = FAssetType.FXRP, settings = false): Promise<AgentVault[]> {
     const agents: AgentVault[] = []
     await this.orm.em.transactional(async (em) => {
       const managerAddress = new EvmAddress(randomNativeAddress(), 1)
@@ -42,6 +43,21 @@ export class EventFixture extends EventGeneration {
         collateralPoolTokenAddress, agentOwner, false
       )
       em.persist(agentVault)
+      if (settings) {
+        const collateralTypeAdded = await em.findOneOrFail(CollateralTypeAdded, { collateralClass: 1 })
+        const agentVaultSettings = new AgentVaultSettings(
+          agentVault,
+          collateralTypeAdded,
+          BigInt(0),
+          BigInt(0),
+          BigInt(0),
+          BigInt(0),
+          BigInt(0),
+          BigInt(0),
+          BigInt(0)
+        )
+        em.persist(agentVaultSettings)
+      }
       agents.push(agentVault)
     })
     return agents

packages/fasset-indexer-core/test/fixtures/events/generate.ts

@@ -86,7 +86,7 @@ export class EventGeneration {
         transactionIndex: randomNumber(1, 1e6),
         logIndex: randomNumber(1, 1e6),
         source: source ?? randomChoice(ASSET_MANAGERS),
-        blockTimestamp: Date.now(),
+        blockTimestamp: Math.floor(Date.now() / 1000),
         transactionHash: randomHash(),
         transactionSource: randomNativeAddress(),
         transactionTarget: randomNativeAddress()