@xyo-network/chain-bridge 1.16.9 → 1.16.10

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

@@ -0,0 +1,47 @@
+import type { AnyConfigSchema } from '@xyo-network/module-model';
+import type { Payload } from '@xyo-network/payload-model';
+import { AbstractSentinel } from '@xyo-network/sentinel-abstract';
+import type { SentinelConfig, SentinelInstance, SentinelModuleEventData, SentinelParams } from '@xyo-network/sentinel-model';
+import type { XyoConnection, XyoGateway, XyoGatewayRunner, XyoViewer } from '@xyo-network/xl1-protocol-sdk';
+export declare const XL1toEvmBridgeSentinelConfigSchema = "network.xyo.sentinel.chain.evm.bridge.config";
+export type XL1toEvmBridgeSentinelConfigSchema = typeof XL1toEvmBridgeSentinelConfigSchema;
+/**
+ * The configuration for the XL1 to EVM bridge sentinel
+ */
+export type XL1toEvmBridgeSentinelConfig = SentinelConfig<{
+    /**
+     * The interval in milliseconds between checking for bridging intents to fulfill
+     */
+    bridgeIntentFulfillmentInterval: number;
+    /**
+     * The schema for the XL1 to EVM bridge sentinel config
+     */
+    schema: XL1toEvmBridgeSentinelConfigSchema;
+}>;
+interface XL1toEvmBridgeSentinelParamFields {
+    gateway: XyoGateway;
+}
+export type XL1toEvmBridgeSentinelParams<TConfig extends AnyConfigSchema<XL1toEvmBridgeSentinelConfig> = AnyConfigSchema<XL1toEvmBridgeSentinelConfig>> = SentinelParams<TConfig> & XL1toEvmBridgeSentinelParamFields;
+export declare class XL1toEvmBridgeSentinel<TParams extends XL1toEvmBridgeSentinelParams = XL1toEvmBridgeSentinelParams, TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>> extends AbstractSentinel<TParams, TEventData> {
+    static readonly configSchemas: string[];
+    static readonly defaultConfigSchema = "network.xyo.sentinel.chain.evm.bridge.config";
+    private _bridgeAttemptsCounter;
+    private _bridgeCheckCounter;
+    private _bridgeErrorCounter;
+    private _bridgeSuccessCounter;
+    private _connection;
+    private _gateway;
+    private _reportMutex;
+    private _viewer;
+    protected get bridgeIntentFulfillmentInterval(): number;
+    protected get connection(): XyoConnection;
+    protected get gateway(): XyoGatewayRunner;
+    protected get viewer(): XyoViewer;
+    createHandler(): Promise<void>;
+    reportHandler(payloads?: Payload[]): Promise<Payload[]>;
+    private processAllBridgeIntents;
+    private processBridgeIntent;
+    private submitBridgeInitiationTransaction;
+}
+export {};
+//# sourceMappingURL=XL1toEvmBridgeSentinel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"XL1toEvmBridgeSentinel.d.ts","sourceRoot":"","sources":["../../../../src/modules/XL1toEvmBridgeSentinel/XL1toEvmBridgeSentinel.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACjE,OAAO,KAAK,EACV,cAAc,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,cAAc,EAC1E,MAAM,6BAA6B,CAAA;AAGpC,OAAO,KAAK,EACV,aAAa,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EACvD,MAAM,+BAA+B,CAAA;AAOtC,eAAO,MAAM,kCAAkC,iDAAiD,CAAA;AAChG,MAAM,MAAM,kCAAkC,GAAG,OAAO,kCAAkC,CAAA;AAE1F;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,cAAc,CAAC;IACxD;;OAEG;IACH,+BAA+B,EAAE,MAAM,CAAA;IACvC;;OAEG;IACH,MAAM,EAAE,kCAAkC,CAAA;CAE3C,CAAC,CAAA;AAEF,UAAU,iCAAiC;IACzC,OAAO,EAAE,UAAU,CAAA;CACpB;AAED,MAAM,MAAM,4BAA4B,CACtC,OAAO,SAAS,eAAe,CAAC,4BAA4B,CAAC,GAAG,eAAe,CAAC,4BAA4B,CAAC,IAC3G,cAAc,CAAC,OAAO,CAAC,GAAG,iCAAiC,CAAA;AAI/D,qBAAa,sBAAsB,CACjC,OAAO,SAAS,4BAA4B,GAAG,4BAA4B,EAC3E,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,WAAuC;IAC7E,gBAAyB,mBAAmB,kDAAqC;IACjF,OAAO,CAAC,sBAAsB,CAAiC;IAC/D,OAAO,CAAC,mBAAmB,CAAiC;IAC5D,OAAO,CAAC,mBAAmB,CAAiC;IAC5D,OAAO,CAAC,qBAAqB,CAAiC;IAC9D,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,QAAQ,CAAwB;IACxC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,OAAO,CAAuB;IAEtC,SAAS,KAAK,+BAA+B,IAAI,MAAM,CAEtD;IAED,SAAS,KAAK,UAAU,IAAI,aAAa,CAExC;IAED,SAAS,KAAK,OAAO,IAAI,gBAAgB,CAExC;IAED,SAAS,KAAK,MAAM,IAAI,SAAS,CAEhC;IAEc,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB9B,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAqBxD,uBAAuB;YAgBvB,mBAAmB;YAiBnB,iCAAiC;CAQhD"}

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

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

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

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/chain-bridge",
-  "version": "1.16.9",
+  "version": "1.16.10",
   "description": "XYO Layer One Bridge",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -49,23 +49,25 @@
     "@opentelemetry/instrumentation": "~0.208.0",
     "@opentelemetry/instrumentation-express": "~0.57.0",
     "@opentelemetry/instrumentation-http": "~0.208.0",
-    "@xylabs/express": "~5.0.24",
-    "@xylabs/hex": "~5.0.24",
-    "@xylabs/logger": "~5.0.24",
-    "@xylabs/typeof": "~5.0.24",
+    "@xylabs/express": "~5.0.25",
+    "@xylabs/hex": "~5.0.25",
+    "@xylabs/logger": "~5.0.25",
+    "@xylabs/typeof": "~5.0.25",
     "@xyo-network/archivist-model": "~5.1.21",
     "@xyo-network/boundwitness-model": "~5.1.21",
-    "@xyo-network/chain-protocol": "~1.16.9",
+    "@xyo-network/chain-protocol": "~1.16.10",
     "@xyo-network/manifest-model": "~5.1.21",
     "@xyo-network/module-factory-locator": "~5.1.21",
     "@xyo-network/module-model": "~5.1.21",
     "@xyo-network/node-model": "~5.1.21",
     "@xyo-network/payload-builder": "~5.1.21",
     "@xyo-network/payload-model": "~5.1.21",
+    "@xyo-network/sentinel-abstract": "~5.1.21",
+    "@xyo-network/sentinel-model": "~5.1.21",
     "@xyo-network/typechain": "~4.0.10",
     "@xyo-network/wallet-model": "~5.1.21",
-    "@xyo-network/xl1-protocol": "~1.13.6",
-    "@xyo-network/xl1-protocol-sdk": "~1.16.9",
+    "@xyo-network/xl1-protocol": "~1.13.11",
+    "@xyo-network/xl1-protocol-sdk": "~1.16.10",
     "compression": "~1.8.1",
     "cors": "~2.8.5",
     "express": "~5.1.0",
@@ -74,17 +76,18 @@
     "zod": "~4.1.12"
   },
   "devDependencies": {
+    "@opentelemetry/api": "~1.9.0",
     "@types/compression": "~1.8.1",
     "@types/cors": "~2.8.19",
     "@types/express": "5.0.5",
     "@types/express-serve-static-core": "~5.1.0",
     "@types/node": "~24.10.1",
-    "@xylabs/assert": "~5.0.24",
-    "@xylabs/base": "~5.0.24",
-    "@xylabs/delay": "~5.0.24",
-    "@xylabs/mongo": "~5.0.24",
-    "@xylabs/object": "~5.0.24",
-    "@xylabs/promise": "~5.0.24",
+    "@xylabs/assert": "~5.0.25",
+    "@xylabs/base": "~5.0.25",
+    "@xylabs/delay": "~5.0.25",
+    "@xylabs/mongo": "~5.0.25",
+    "@xylabs/object": "~5.0.25",
+    "@xylabs/promise": "~5.0.25",
     "@xylabs/ts-scripts-yarn3": "~7.2.8",
     "@xylabs/tsconfig": "~7.2.8",
     "@xyo-network/account": "~5.1.21",
@@ -96,10 +99,10 @@
     "@xyo-network/bios": "~7.1.1",
     "@xyo-network/bios-model": "~7.1.1",
     "@xyo-network/boundwitness-builder": "~5.1.21",
-    "@xyo-network/chain-modules": "~1.16.9",
-    "@xyo-network/chain-protocol": "~1.16.9",
-    "@xyo-network/chain-services": "~1.16.9",
-    "@xyo-network/chain-telemetry": "~1.16.9",
+    "@xyo-network/chain-modules": "~1.16.10",
+    "@xyo-network/chain-protocol": "~1.16.10",
+    "@xyo-network/chain-services": "~1.16.10",
+    "@xyo-network/chain-telemetry": "~1.16.10",
     "@xyo-network/manifest-wrapper": "~5.1.21",
     "@xyo-network/module-abstract": "~5.1.21",
     "@xyo-network/module-abstract-mongodb": "~5.1.21",
@@ -108,7 +111,8 @@
     "@xyo-network/payload-builder": "~5.1.21",
     "@xyo-network/sentinel-memory": "~5.1.21",
     "@xyo-network/wallet": "~5.1.21",
-    "@xyo-network/xl1-protocol": "~1.13.6",
+    "@xyo-network/xl1-protocol": "~1.13.11",
+    "async-mutex": "~0.5.0",
     "dotenv": "~17.2.3",
     "eslint": "^9.39.1",
     "ethers": "~6.15.0",
@@ -116,7 +120,7 @@
     "nodemon": "~3.1.11",
     "tslib": "~2.8.1",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.8",
+    "vitest": "~4.0.9",
     "vitest-mock-extended": "~3.1.0"
   },
   "engines": {

package/src/modules/XL1toEvmBridgeSentinel/XL1toEvmBridgeSentinel.ts

@@ -0,0 +1,159 @@
+import type { Attributes, Counter } from '@opentelemetry/api'
+import { assertEx } from '@xylabs/assert'
+import { delay } from '@xylabs/delay'
+import { isDefined, isUndefined } from '@xylabs/typeof'
+import type { AnyConfigSchema } from '@xyo-network/module-model'
+import type { Payload } from '@xyo-network/payload-model'
+import { AbstractSentinel } from '@xyo-network/sentinel-abstract'
+import type {
+  SentinelConfig, SentinelInstance, SentinelModuleEventData, SentinelParams,
+} from '@xyo-network/sentinel-model'
+import type { BridgeIntent, SignedHydratedTransaction } from '@xyo-network/xl1-protocol'
+import { isBridgeIntent } from '@xyo-network/xl1-protocol'
+import type {
+  XyoConnection, XyoGateway, XyoGatewayRunner, XyoViewer,
+} from '@xyo-network/xl1-protocol-sdk'
+import {
+  flattenHydratedTransaction, flattenHydratedTransactions,
+  SimpleXyoGatewayRunner,
+} from '@xyo-network/xl1-protocol-sdk'
+import { Mutex } from 'async-mutex'
+
+export const XL1toEvmBridgeSentinelConfigSchema = 'network.xyo.sentinel.chain.evm.bridge.config'
+export type XL1toEvmBridgeSentinelConfigSchema = typeof XL1toEvmBridgeSentinelConfigSchema
+
+/**
+ * The configuration for the XL1 to EVM bridge sentinel
+ */
+export type XL1toEvmBridgeSentinelConfig = SentinelConfig<{
+  /**
+   * The interval in milliseconds between checking for bridging intents to fulfill
+   */
+  bridgeIntentFulfillmentInterval: number
+  /**
+   * The schema for the XL1 to EVM bridge sentinel config
+   */
+  schema: XL1toEvmBridgeSentinelConfigSchema
+
+}>
+
+interface XL1toEvmBridgeSentinelParamFields {
+  gateway: XyoGateway
+}
+
+export type XL1toEvmBridgeSentinelParams<
+  TConfig extends AnyConfigSchema<XL1toEvmBridgeSentinelConfig> = AnyConfigSchema<XL1toEvmBridgeSentinelConfig>,
+> = SentinelParams<TConfig> & XL1toEvmBridgeSentinelParamFields
+
+const defaultStepClaimIntervalMs = 15_000
+
+export class XL1toEvmBridgeSentinel<
+  TParams extends XL1toEvmBridgeSentinelParams = XL1toEvmBridgeSentinelParams,
+  TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>,
+> extends AbstractSentinel<TParams, TEventData> {
+  static override readonly configSchemas = [XL1toEvmBridgeSentinelConfigSchema]
+  static override readonly defaultConfigSchema = XL1toEvmBridgeSentinelConfigSchema
+  private _bridgeAttemptsCounter: Counter<Attributes> | undefined
+  private _bridgeCheckCounter: Counter<Attributes> | undefined
+  private _bridgeErrorCounter: Counter<Attributes> | undefined
+  private _bridgeSuccessCounter: Counter<Attributes> | undefined
+  private _connection: XyoConnection | undefined
+  private _gateway: XyoGateway | undefined
+  private _reportMutex = new Mutex()
+  private _viewer: XyoViewer | undefined
+
+  protected get bridgeIntentFulfillmentInterval(): number {
+    return isDefined(this.config.bridgeIntentFulfillmentInterval) ? this.config.bridgeIntentFulfillmentInterval : defaultStepClaimIntervalMs
+  }
+
+  protected get connection(): XyoConnection {
+    return assertEx(this._connection, () => 'Connection is not defined')
+  }
+
+  protected get gateway(): XyoGatewayRunner {
+    return new SimpleXyoGatewayRunner(assertEx(this._gateway, () => 'Gateway is not defined'))
+  }
+
+  protected get viewer(): XyoViewer {
+    return assertEx(this._viewer, () => 'Viewer is not defined')
+  }
+
+  override async createHandler(): Promise<void> {
+    await super.createHandler()
+    // Create meters for tracking bridge attempts, successes, and errors.
+    this._bridgeAttemptsCounter = this.meter?.createCounter('xl1_to_evm_bridge_sentinel_attempts_total', { description: 'Number of bridge attempts' })
+    this._bridgeCheckCounter = this.meter?.createCounter('xl1_to_evm_bridge_sentinel_check_total', { description: 'Number of bridge checks' })
+    this._bridgeSuccessCounter = this.meter?.createCounter('xl1_to_evm_bridge_sentinel_success_total', { description: 'Number of bridge successes' })
+    this._bridgeErrorCounter = this.meter?.createCounter('xl1_to_evm_bridge_sentinel_errors_total', { description: 'Number of bridge errors' })
+
+    const gateway = assertEx(this.params.gateway, () => 'Gateway parameter is required')
+    const connection = assertEx(gateway.connectionInstance, () => 'Gateway connection is required')
+    const viewer = assertEx(connection.viewer, () => 'Viewer is not defined in gateway connection')
+    this._gateway = gateway
+    this._connection = connection
+    this._viewer = viewer
+  }
+
+  override async reportHandler(payloads?: Payload[]): Promise<Payload[]> {
+    if (this._reportMutex.isLocked()) {
+      this.logger?.debug(`XL1toEvmBridgeSentinel [${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.processAllBridgeIntents()
+      } else {
+        // Process provided payloads
+        const bridgeIntentsToProcess = payloads.filter(isBridgeIntent)
+        for (const bridgeIntent of bridgeIntentsToProcess) {
+          const result = await this.processBridgeIntent(bridgeIntent)
+          if (isDefined(result)) response.push(...flattenHydratedTransaction(result))
+        }
+      }
+      return response
+    })
+  }
+
+  private async processAllBridgeIntents(): Promise<Payload[]> {
+    // No payloads to process, just do unprocessed bridge intents since last run
+    const results: SignedHydratedTransaction[] = []
+    // TODO: Grab from iterable map of pending bridge intents
+    const bridgeIntents: BridgeIntent[] = []
+
+    for (const bridgeIntent of bridgeIntents) {
+      const result = await this.processBridgeIntent(bridgeIntent)
+      if (isDefined(result)) {
+        results.push(result)
+      }
+      await delay(this.bridgeIntentFulfillmentInterval)
+    }
+    return flattenHydratedTransactions(results)
+  }
+
+  private async processBridgeIntent(bridgeIntent: BridgeIntent): Promise<SignedHydratedTransaction | undefined> {
+    this.logger?.info(`Processing bridge request for ${bridgeIntent.srcAddress} with nonce ${bridgeIntent.nonce}`)
+    try {
+      this._bridgeCheckCounter?.add(1)
+      this._bridgeAttemptsCounter?.add(1)
+      // Create single transaction for all claims
+      const tx = await this.submitBridgeInitiationTransaction(bridgeIntent, this.gateway)
+      this.logger?.info(`Claimed rewards for ${bridgeIntent.srcAddress} with nonce ${bridgeIntent.nonce}`)
+      this._bridgeSuccessCounter?.add(1)
+      // Return submitted transaction
+      return tx
+    } catch (error) {
+      this._bridgeErrorCounter?.add(1)
+      this.logger?.error(`Error claiming rewards for ${bridgeIntent.srcAddress} with nonce ${bridgeIntent.nonce}:`, error)
+    }
+  }
+
+  private async submitBridgeInitiationTransaction(
+    bridgeIntent: BridgeIntent,
+    gateway: XyoGatewayRunner,
+  ): Promise<SignedHydratedTransaction | undefined> {
+    const currentBlockNumber = await this.viewer.currentBlockNumber()
+    const result = await gateway.addPayloadsToChain?.([], [], { nbf: currentBlockNumber, exp: currentBlockNumber + 10 })
+    if (isDefined(result)) return result[1]
+  }
+}

package/src/modules/XL1toEvmBridgeSentinel/index.ts

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

package/src/modules/index.ts

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