@xyo-network/chain-bridge 1.19.18 → 1.20.0

package/src/util/index.ts

@@ -4,6 +4,3 @@ export * from './calculateBridgeFees.ts'
 export * from './createBridgeTransfer.ts'
 export * from './generateBridgeEstimate.ts'
 export * from './getConfigFromEnv.ts'
-export * from './validateBridgeEstimate.ts'
-export * from './validateBridgeEstimateExact.ts'
-export * from './validateBridgeTransaction.ts'

package/src/validation/index.ts

@@ -0,0 +1,6 @@
+export * from './validateBridgeEstimateExact.ts'
+export * from './validateBridgeTransaction.ts'
+export * from './validateSufficientLiquiditySourceAllowance.ts'
+export * from './validateSufficientLiquiditySourceBalance.ts'
+export * from './validateSufficientRunnerEthBalanceForGas.ts'
+export * from './validateSufficientXL1SourceAddressBalance.ts'

package/src/{util → validation}/validateBridgeEstimate.ts

@@ -3,7 +3,7 @@ import type { BridgeConfig } from '@xyo-network/chain-orchestration'
 import type { BridgeIntent, Transfer } from '@xyo-network/xl1-sdk'
 
 import { getBridgeSettings } from '../config/index.ts'
-import { calculateBridgeFees } from './calculateBridgeFees.js'
+import { calculateBridgeFees } from '../util/index.ts'
 
 /**
  * Validates a bridge estimate by checking the intent and transfer against the provided configuration. This method

package/src/{util → validation}/validateBridgeEstimateExact.ts

@@ -3,7 +3,7 @@ import type { BridgeConfig } from '@xyo-network/chain-orchestration'
 import { PayloadBuilder } from '@xyo-network/sdk-js'
 import type { BridgeIntent, Transfer } from '@xyo-network/xl1-sdk'
 
-import { generateBridgeEstimate } from './generateBridgeEstimate.ts'
+import { generateBridgeEstimate } from '../util/index.ts'
 
 /**
  * Validates a bridge estimate by checking the intent and transfer against the provided configuration. This method

package/src/{util → validation}/validateBridgeTransaction.ts

@@ -5,8 +5,7 @@ import {
 import type { BridgeConfig } from '@xyo-network/chain-orchestration'
 import { PayloadBuilder } from '@xyo-network/sdk-js'
 import type {
-  BridgeIntent,
-  TransactionBoundWitness, Transfer,
+  BridgeIntent, TransactionBoundWitness, Transfer,
 } from '@xyo-network/xl1-sdk'
 
 import { getXl1ChainId } from '../config/index.ts'

package/src/validation/validateSufficientXL1SourceAddressBalance.ts

@@ -0,0 +1,39 @@
+import {
+  asAddress, assertEx, hexToBigInt,
+} from '@xylabs/sdk-js'
+import type { BridgeConfig } from '@xyo-network/chain-orchestration'
+import type { BridgeIntent, XyoGatewayRunner } from '@xyo-network/xl1-sdk'
+
+import { generateBridgeEstimate } from '../util/index.ts'
+import type { AsyncLogger } from './AsyncLogger.ts'
+
+/**
+ * Checks if the liquidity source has sufficient balance for the bridge to execute the transaction. This doesn't
+ * ensure that (due to race conditions) the transaction will succeed, but is a quick check to avoid
+ * submitting transactions that are likely to fail.
+ * @param bridgeIntent The bridge intent containing the details of the bridge transaction, including the source address and amount being bridged
+ * @param gateway The XyoGatewayRunner to check the balance of the source address on XL1
+ * @param config The bridge configuration, used to generate a bridge estimate for the transaction
+ * @param logger Optional logger for asynchronous logging
+ * @returns True if the liquidity source balance is sufficient to execute the bridge
+ */
+export const validateSufficientXL1SourceAddressBalance = async (
+  bridgeIntent: BridgeIntent,
+  gateway: XyoGatewayRunner,
+  config: BridgeConfig,
+  logger?: AsyncLogger,
+) => {
+  // Get the amount being bridged from the bridge intent
+  const viewer = assertEx(gateway.connection.viewer, () => 'Gateway connection does not have a viewer')
+  const {
+    srcAddress, srcAmount, destAddress,
+  } = bridgeIntent
+  const srcAddressBranded = asAddress(srcAddress, () => `Invalid source address in bridge intent: ${srcAddress}`)
+  const [_, calculatedTransfer] = await generateBridgeEstimate(srcAddress, srcAmount, destAddress, config)
+  const totalAmount = Object.values(calculatedTransfer.transfers).reduce((acc, transfer) => acc + hexToBigInt(transfer), 0n)
+
+  // Check the srcAddress balance on XL1 for the bridge
+  const accountBalance = await viewer.account.balance.accountBalance(srcAddressBranded)
+  await logger?.log(`Account balance for ${srcAddressBranded}: ${accountBalance.toString()}`)
+  return accountBalance >= totalAmount
+}

package/dist/node/config/getGateway.d.ts

@@ -1,4 +0,0 @@
-import type { BridgeConfig } from '@xyo-network/chain-orchestration';
-import type { XyoGatewayRunner } from '@xyo-network/xl1-sdk';
-export declare const getGateway: (config: BridgeConfig) => Promise<XyoGatewayRunner>;
-//# sourceMappingURL=getGateway.d.ts.map

package/dist/node/config/getGateway.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getGateway.d.ts","sourceRoot":"","sources":["../../../src/config/getGateway.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAEpE,OAAO,KAAK,EACsB,gBAAgB,EACjD,MAAM,sBAAsB,CAAA;AAO7B,eAAO,MAAM,UAAU,GAAU,QAAQ,YAAY,KAAG,OAAO,CAAC,gBAAgB,CAU/E,CAAA"}

package/dist/node/modules/XL1TransactionCompletionMonitorSentinel/XL1TransactionCompletionMonitorSentinel.d.ts

@@ -1,60 +0,0 @@
-import type { Hash } from '@xylabs/sdk-js';
-import type { AnyConfigSchema, Payload } from '@xyo-network/sdk-js';
-import { AbstractSentinel } from '@xyo-network/sentinel-abstract';
-import type { SentinelConfig, SentinelInstance, SentinelModuleEventData, SentinelParams } from '@xyo-network/sentinel-model';
-import type { IterableMap, MapType, SignedHydratedTransaction, XyoViewer } from '@xyo-network/xl1-sdk';
-export declare const XL1TransactionCompletionMonitorSentinelConfigSchema: "network.xyo.sentinel.chain.transaction.completion.monitor.config" & {
-    readonly __schema: true;
-};
-export type XL1TransactionCompletionMonitorSentinelConfigSchema = typeof XL1TransactionCompletionMonitorSentinelConfigSchema;
-/**
- * The configuration for the sentinel
- */
-export type XL1TransactionCompletionMonitorSentinelConfig = SentinelConfig<{
-    /**
-     * The interval in milliseconds between checking for jobs to fulfill
-     */
-    jobCheckInterval: number;
-    /**
-     * The schema for the sentinel config
-     */
-    schema: XL1TransactionCompletionMonitorSentinelConfigSchema;
-}>;
-interface XL1TransactionCompletionMonitorSentinelParamFields {
-    /**
-     * The map of completed transactions to monitor for completion
-     */
-    completedTransactions: MapType<Hash, SignedHydratedTransaction>;
-    /**
-     * The map of pending transactions to monitor for completion
-     */
-    pendingTransactions: IterableMap<Hash, SignedHydratedTransaction>;
-    /**
-     * The viewer instance to use for viewing transactions
-     */
-    viewer: XyoViewer;
-}
-export type XL1TransactionCompletionMonitorSentinelParams<TConfig extends AnyConfigSchema<XL1TransactionCompletionMonitorSentinelConfig> = AnyConfigSchema<XL1TransactionCompletionMonitorSentinelConfig>> = SentinelParams<TConfig> & XL1TransactionCompletionMonitorSentinelParamFields;
-export declare class XL1TransactionCompletionMonitorSentinel<TParams extends XL1TransactionCompletionMonitorSentinelParams = XL1TransactionCompletionMonitorSentinelParams, TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>> extends AbstractSentinel<TParams, TEventData> {
-    static readonly configSchemas: ("network.xyo.sentinel.chain.transaction.completion.monitor.config" & {
-        readonly __schema: true;
-    })[];
-    static readonly defaultConfigSchema: "network.xyo.sentinel.chain.transaction.completion.monitor.config" & {
-        readonly __schema: true;
-    };
-    private _attemptsCounter;
-    private _checkCounter;
-    private _errorCounter;
-    private _reportMutex;
-    private _successCounter;
-    protected get completedTransactions(): MapType<Hash, SignedHydratedTransaction>;
-    protected get jobCheckInterval(): number;
-    protected get pendingTransactions(): IterableMap<Hash, SignedHydratedTransaction>;
-    protected get viewer(): XyoViewer;
-    createHandler(): Promise<void>;
-    reportHandler(payloads?: Payload[]): Promise<Payload[]>;
-    private processAllTransactions;
-    private processTransaction;
-}
-export {};
-//# sourceMappingURL=XL1TransactionCompletionMonitorSentinel.d.ts.map

package/dist/node/modules/XL1TransactionCompletionMonitorSentinel/XL1TransactionCompletionMonitorSentinel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"XL1TransactionCompletionMonitorSentinel.d.ts","sourceRoot":"","sources":["../../../../src/modules/XL1TransactionCompletionMonitorSentinel/XL1TransactionCompletionMonitorSentinel.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAI1C,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAEnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACjE,OAAO,KAAK,EACV,cAAc,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,cAAc,EAC1E,MAAM,6BAA6B,CAAA;AACpC,OAAO,KAAK,EACV,WAAW,EAAE,OAAO,EAAE,yBAAyB,EAC/C,SAAS,EACV,MAAM,sBAAsB,CAAA;AAM7B,eAAO,MAAM,mDAAmD;;CAAqF,CAAA;AACrJ,MAAM,MAAM,mDAAmD,GAAG,OAAO,mDAAmD,CAAA;AAE5H;;GAEG;AACH,MAAM,MAAM,6CAA6C,GAAG,cAAc,CAAC;IACzE;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,MAAM,EAAE,mDAAmD,CAAA;CAC5D,CAAC,CAAA;AAEF,UAAU,kDAAkD;IAC1D;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAA;IAE/D;;OAEG;IACH,mBAAmB,EAAE,WAAW,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAAA;IAEjE;;OAEG;IACH,MAAM,EAAE,SAAS,CAAA;CAClB;AAED,MAAM,MAAM,6CAA6C,CACvD,OAAO,SAAS,eAAe,CAAC,6CAA6C,CAAC,GAAG,eAAe,CAAC,6CAA6C,CAAC,IAC7I,cAAc,CAAC,OAAO,CAAC,GAAG,kDAAkD,CAAA;AAIhF,qBAAa,uCAAuC,CAClD,OAAO,SAAS,6CAA6C,GAAG,6CAA6C,EAC7G,UAAU,SAAS,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAC1H,SAAQ,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7C,gBAAyB,aAAa;;SAAwD;IAC9F,gBAAyB,mBAAmB;;MAAsD;IAClG,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,aAAa,CAAiC;IACtD,OAAO,CAAC,aAAa,CAAiC;IACtD,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,eAAe,CAAiC;IAExD,SAAS,KAAK,qBAAqB,IAAI,OAAO,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAE9E;IAED,SAAS,KAAK,gBAAgB,IAAI,MAAM,CAEvC;IAED,SAAS,KAAK,mBAAmB,IAAI,WAAW,CAAC,IAAI,EAAE,yBAAyB,CAAC,CAEhF;IAED,SAAS,KAAK,MAAM,IAAI,SAAS,CAEhC;IAEc,aAAa;IASb,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YA0BxD,sBAAsB;YAUtB,kBAAkB;CA8BjC"}

package/dist/node/modules/XL1TransactionCompletionMonitorSentinel/index.d.ts

@@ -1,2 +0,0 @@
-export * from './XL1TransactionCompletionMonitorSentinel.ts';
-//# sourceMappingURL=index.d.ts.map

package/dist/node/modules/XL1TransactionCompletionMonitorSentinel/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/XL1TransactionCompletionMonitorSentinel/index.ts"],"names":[],"mappings":"AAAA,cAAc,8CAA8C,CAAA"}

package/dist/node/queue/workers/util/AsyncLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AsyncLogger.d.ts","sourceRoot":"","sources":["../../../../../src/queue/workers/util/AsyncLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,UAAU,CAAC,OAAO,CAAC,CAAA;CAC9C"}

package/dist/node/queue/workers/util/validateSufficientLiquiditySourceAllowance.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateSufficientLiquiditySourceAllowance.d.ts","sourceRoot":"","sources":["../../../../../src/queue/workers/util/validateSufficientLiquiditySourceAllowance.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAClF,OAAO,EAAkB,KAAK,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAErF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;;;GASG;AACH,eAAO,MAAM,0CAA0C,GACrD,IAAI,yBAAyB,EAC7B,iBAAiB,eAAe,EAChC,QAAQ,mBAAmB,EAC3B,SAAS,WAAW,qBAcrB,CAAA"}

package/dist/node/queue/workers/util/validateSufficientLiquiditySourceBalance.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateSufficientLiquiditySourceBalance.d.ts","sourceRoot":"","sources":["../../../../../src/queue/workers/util/validateSufficientLiquiditySourceBalance.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAClF,OAAO,EAAkB,KAAK,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAErF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;;;;;;;;GASG;AACH,eAAO,MAAM,wCAAwC,GACnD,IAAI,yBAAyB,EAC7B,iBAAiB,eAAe,EAChC,QAAQ,mBAAmB,EAC3B,SAAS,WAAW,qBAarB,CAAA"}

package/dist/node/queue/workers/util/validateSufficientRunnerEthBalanceForGas.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateSufficientRunnerEthBalanceForGas.d.ts","sourceRoot":"","sources":["../../../../../src/queue/workers/util/validateSufficientRunnerEthBalanceForGas.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAEzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAInD;;;;;;;;;GASG;AACH,eAAO,MAAM,wCAAwC,GACnD,YAAY,mBAAmB,EAC/B,QAAQ,MAAM,EACd,SAAS,WAAW,EACpB,YAAW,MAA+B,qBAmC3C,CAAA"}

package/dist/node/util/validateBridgeEstimate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateBridgeEstimate.d.ts","sourceRoot":"","sources":["../../../src/util/validateBridgeEstimate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAKlE;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,YAAY,EACpB,UAAU,QAAQ,EAClB,QAAQ,YAAY,KACnB,OAAO,CAAC,OAAO,CAuCjB,CAAA"}

package/dist/node/util/validateBridgeEstimateExact.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateBridgeEstimateExact.d.ts","sourceRoot":"","sources":["../../../src/util/validateBridgeEstimateExact.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAEpE,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAIlE;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,GACtC,QAAQ,YAAY,EACpB,UAAU,QAAQ,EAClB,QAAQ,YAAY,KACnB,OAAO,CAAC,OAAO,CAcjB,CAAA"}

package/dist/node/util/validateBridgeTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateBridgeTransaction.d.ts","sourceRoot":"","sources":["../../../src/util/validateBridgeTransaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAEpE,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EAAE,QAAQ,EAClC,MAAM,sBAAsB,CAAA;AAI7B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB,GACpC,YAAY,uBAAuB,EACnC,QAAQ,YAAY,EACpB,UAAU,QAAQ,EAClB,QAAQ,YAAY,KACnB,OAAO,CAAC,OAAO,CAgBjB,CAAA"}

package/src/config/getGateway.ts

@@ -1,23 +0,0 @@
-import { assertEx, isDefined } from '@xylabs/sdk-js'
-import type { BridgeConfig } from '@xyo-network/chain-orchestration'
-import { HDWallet } from '@xyo-network/sdk-js'
-import type {
-  RpcSchemaMap, TransportFactory, XyoGatewayRunner,
-} from '@xyo-network/xl1-sdk'
-import {
-  ADDRESS_INDEX, buildJsonRpcProviderLocator, generateXyoBaseWalletFromPhrase, HttpRpcTransport, XyoGatewayRunnerMoniker,
-} from '@xyo-network/xl1-sdk'
-
-let gatewayInstance: XyoGatewayRunner | undefined
-
-export const getGateway = async (config: BridgeConfig): Promise<XyoGatewayRunner> => {
-  if (isDefined(gatewayInstance)) return gatewayInstance
-  const { mnemonic } = config
-  const endpoint = assertEx(config.remote?.rpc?.url ?? config.remote?.rpc?.url, () => 'RPC URL is required for gateway')
-  const walletPhrase = isDefined(mnemonic) ? mnemonic : HDWallet.generateMnemonic()
-  const wallet = await generateXyoBaseWalletFromPhrase(walletPhrase)
-  const signerAccount = await wallet.derivePath(ADDRESS_INDEX.XYO)
-  const transportFactory: TransportFactory = (schemas: RpcSchemaMap) => new HttpRpcTransport(endpoint, schemas)
-  const locator = await buildJsonRpcProviderLocator({ transportFactory, signerAccount })
-  return await locator.getInstance<XyoGatewayRunner>(XyoGatewayRunnerMoniker)
-}

package/src/modules/XL1TransactionCompletionMonitorSentinel/XL1TransactionCompletionMonitorSentinel.ts

@@ -1,165 +0,0 @@
-import type { Attributes, Counter } from '@opentelemetry/api'
-import type { Hash } from '@xylabs/sdk-js'
-import {
-  assertEx, delay, isDefined, isNull, isUndefined,
-} from '@xylabs/sdk-js'
-import type { AnyConfigSchema, Payload } from '@xyo-network/sdk-js'
-import { asSchema, PayloadBuilder } from '@xyo-network/sdk-js'
-import { AbstractSentinel } from '@xyo-network/sentinel-abstract'
-import type {
-  SentinelConfig, SentinelInstance, SentinelModuleEventData, SentinelParams,
-} from '@xyo-network/sentinel-model'
-import type {
-  IterableMap, MapType, SignedHydratedTransaction,
-  XyoViewer,
-} from '@xyo-network/xl1-sdk'
-import {
-  flattenHydratedTransaction, flattenHydratedTransactions, tryUnflattenHydratedTransaction,
-} from '@xyo-network/xl1-sdk'
-import { Mutex } from 'async-mutex'
-
-export const XL1TransactionCompletionMonitorSentinelConfigSchema = asSchema('network.xyo.sentinel.chain.transaction.completion.monitor.config', true)
-export type XL1TransactionCompletionMonitorSentinelConfigSchema = typeof XL1TransactionCompletionMonitorSentinelConfigSchema
-
-/**
- * The configuration for the sentinel
- */
-export type XL1TransactionCompletionMonitorSentinelConfig = SentinelConfig<{
-  /**
-   * The interval in milliseconds between checking for jobs to fulfill
-   */
-  jobCheckInterval: number
-
-  /**
-   * The schema for the sentinel config
-   */
-  schema: XL1TransactionCompletionMonitorSentinelConfigSchema
-}>
-
-interface XL1TransactionCompletionMonitorSentinelParamFields {
-  /**
-   * The map of completed transactions to monitor for completion
-   */
-  completedTransactions: MapType<Hash, SignedHydratedTransaction>
-
-  /**
-   * The map of pending transactions to monitor for completion
-   */
-  pendingTransactions: IterableMap<Hash, SignedHydratedTransaction>
-
-  /**
-   * The viewer instance to use for viewing transactions
-   */
-  viewer: XyoViewer
-}
-
-export type XL1TransactionCompletionMonitorSentinelParams<
-  TConfig extends AnyConfigSchema<XL1TransactionCompletionMonitorSentinelConfig> = AnyConfigSchema<XL1TransactionCompletionMonitorSentinelConfig>,
-> = SentinelParams<TConfig> & XL1TransactionCompletionMonitorSentinelParamFields
-
-const defaultJobCheckIntervalMs = 15_000
-
-export class XL1TransactionCompletionMonitorSentinel<
-  TParams extends XL1TransactionCompletionMonitorSentinelParams = XL1TransactionCompletionMonitorSentinelParams,
-  TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,
-> extends AbstractSentinel<TParams, TEventData> {
-  static override readonly configSchemas = [XL1TransactionCompletionMonitorSentinelConfigSchema]
-  static override readonly defaultConfigSchema = XL1TransactionCompletionMonitorSentinelConfigSchema
-  private _attemptsCounter: Counter<Attributes> | undefined
-  private _checkCounter: Counter<Attributes> | undefined
-  private _errorCounter: Counter<Attributes> | undefined
-  private _reportMutex = new Mutex()
-  private _successCounter: Counter<Attributes> | undefined
-
-  protected get completedTransactions(): MapType<Hash, SignedHydratedTransaction> {
-    return assertEx(this.params.completedTransactions, () => 'Completed transactions map is not defined')
-  }
-
-  protected get jobCheckInterval(): number {
-    return isDefined(this.config.jobCheckInterval) ? this.config.jobCheckInterval : defaultJobCheckIntervalMs
-  }
-
-  protected get pendingTransactions(): IterableMap<Hash, SignedHydratedTransaction> {
-    return assertEx(this.params.pendingTransactions, () => 'Pending transactions map is not defined')
-  }
-
-  protected get viewer(): XyoViewer {
-    return assertEx(this.params.viewer, () => 'Viewer is not defined in params')
-  }
-
-  override async createHandler() {
-    await super.createHandler()
-    // Create meters for tracking bridge attempts, successes, and errors.
-    this._attemptsCounter = this.meter?.createCounter('xl1_transaction_completion_monitor_sentinel_attempts_total', { description: 'Number of attempts' })
-    this._checkCounter = this.meter?.createCounter('xl1_transaction_completion_monitor_sentinel_check_total', { description: 'Number of checks' })
-    this._successCounter = this.meter?.createCounter('xl1_transaction_completion_monitor_sentinel_success_total', { description: 'Number of successes' })
-    this._errorCounter = this.meter?.createCounter('xl1_transaction_completion_monitor_sentinel_errors_total', { description: 'Number of errors' })
-  }
-
-  override async reportHandler(payloads?: Payload[]): Promise<Payload[]> {
-    if (isDefined(payloads) && payloads.length > 0) {
-      const signedHydratedTransaction = tryUnflattenHydratedTransaction(payloads)
-      if (isDefined(signedHydratedTransaction)) {
-        // Insert into pending transactions for monitoring
-        const txHash = await PayloadBuilder.hash(signedHydratedTransaction[0])
-        this.logger?.info(`Adding transaction ${signedHydratedTransaction[0]} with hash ${txHash} to pending transactions for monitoring`)
-        await this.pendingTransactions.set(txHash, signedHydratedTransaction)
-        return flattenHydratedTransaction(signedHydratedTransaction)
-      }
-      return []
-    } else {
-      if (this._reportMutex.isLocked()) {
-        this.logger?.debug(`XL1TransactionCompletionMonitorSentinel [${this.id}] is already running, skipping report [${Date.now()}]`)
-        return []
-      }
-      return await this._reportMutex.runExclusive(async () => {
-        const response: Payload[] = []
-        if (isUndefined(payloads) || payloads.length === 0) {
-          await this.processAllTransactions()
-        }
-        return response
-      })
-    }
-  }
-
-  private async processAllTransactions(): Promise<Payload[]> {
-    const results: SignedHydratedTransaction[] = []
-    for await (const [hash, signedHydratedTransaction] of this.pendingTransactions) {
-      const result = await this.processTransaction([hash, signedHydratedTransaction])
-      if (isDefined(result)) results.push(result[1])
-      await delay(this.jobCheckInterval)
-    }
-    return flattenHydratedTransactions(results)
-  }
-
-  private async processTransaction(
-    [hash, signedHydratedTransaction]: [Hash, SignedHydratedTransaction],
-  ): Promise<[Hash, SignedHydratedTransaction] | undefined> {
-    this.logger?.info(`Checking for transaction ${signedHydratedTransaction[0]} with hash ${hash}`)
-    try {
-      let ret: [Hash, SignedHydratedTransaction] | undefined = undefined
-      this._checkCounter?.add(1)
-      this._attemptsCounter?.add(1)
-      // Check if the transaction is already included in the chain
-      const tx = await this.viewer.transactionByHash(hash)
-      if (isDefined(tx) && !isNull(tx)) {
-        await this.completedTransactions.set(hash, signedHydratedTransaction)
-        this.logger?.info(`Found transaction ${signedHydratedTransaction[0]} with hash ${hash}`)
-        this.logger?.info(`Removing completed transaction ${signedHydratedTransaction[0]} with hash ${hash}`)
-        await this.pendingTransactions.delete(hash)
-        ret = [hash, signedHydratedTransaction]
-      } else {
-        const currentBlockNumber = await this.viewer.currentBlockNumber()
-        if (signedHydratedTransaction[0].exp < currentBlockNumber) {
-          this.logger?.info(`Removing expired transaction ${signedHydratedTransaction[0]} with hash ${hash}`)
-          await this.pendingTransactions.delete(hash)
-        }
-      }
-      this._successCounter?.add(1)
-      return ret
-    } catch (error) {
-      this._errorCounter?.add(1)
-      this.logger?.error(`Error checking for transaction ${signedHydratedTransaction[0]} with hash ${hash}:`, error)
-    }
-  }
-}

package/src/modules/XL1TransactionCompletionMonitorSentinel/index.ts

@@ -1 +0,0 @@
-export * from './XL1TransactionCompletionMonitorSentinel.ts'