@xyo-network/chain-bridge 1.19.16 → 1.19.18

package/src/server/routes/bridge/routeDefinitions/routes/bridgeToRemoteStatus.ts

@@ -1,102 +1,167 @@
 import type { RouteDefinition } from '@xylabs/express'
 import { requestHandlerValidator } from '@xylabs/express'
-import {
-  asAddress, asHex, toHex,
-} from '@xylabs/sdk-js'
+import { asHex, isDefined } from '@xylabs/sdk-js'
 import type { BridgeConfig } from '@xyo-network/chain-orchestration'
-import { PayloadZodStrictOfSchema } from '@xyo-network/sdk-js'
-import type { BridgeDestinationObservation, BridgeSourceObservation } from '@xyo-network/xl1-sdk'
+import { PayloadBuilder, PayloadZodStrictOfSchema } from '@xyo-network/sdk-js'
+import type {
+  BridgeDestinationObservation, BridgeSourceObservation, SignedHydratedTransaction,
+} from '@xyo-network/xl1-sdk'
 import {
-  BridgeDestinationObservationFieldsZod, BridgeDestinationObservationSchema, BridgeIntentFieldsZod, BridgeIntentSchema, BridgeSourceObservationFieldsZod,
-  BridgeSourceObservationSchema,
+  asBridgeIntent, BridgeDestinationObservationFieldsZod, BridgeDestinationObservationSchema, BridgeIntentFieldsZod, BridgeIntentSchema,
+  BridgeSourceObservationFieldsZod, BridgeSourceObservationSchema, isBridgeIntent,
 } from '@xyo-network/xl1-sdk'
+import type { Job } from 'bullmq'
+import { Queue } from 'bullmq'
 import { z } from 'zod'
 
-import { getBridgeSettings } from '../../../../../config/index.ts'
-import { generateBridgeEstimate } from '../../../../../util/index.ts'
+import {
+  EthTransactionMonitor, EthTransactionPreparation, EthTransactionSubmission, getConnection, Xl1ToEthBridgeParent, Xl1TransactionMonitor,
+  Xl1TransactionPreparation, Xl1TransactionSubmission,
+} from '../../../../../queue/index.ts'
 import { getRemoteChainIdZod } from '../pathParams/index.ts'
 
+const BridgeIntentResponseZod = PayloadZodStrictOfSchema(BridgeIntentSchema)
+  .extend(BridgeIntentFieldsZod.shape)
+
+const BridgeSourceResponseZod = PayloadZodStrictOfSchema(BridgeSourceObservationSchema)
+  .extend(BridgeSourceObservationFieldsZod.shape)
+
+const BridgeDestinationResponseZod = PayloadZodStrictOfSchema(BridgeDestinationObservationSchema)
+  .extend(BridgeDestinationObservationFieldsZod.shape)
+
 export const BridgeToRemoteStatusResponseZod = z.union([
   z.tuple([]),
-  z.tuple([PayloadZodStrictOfSchema(BridgeIntentSchema).extend(BridgeIntentFieldsZod.shape)]),
-  z.tuple([
-    PayloadZodStrictOfSchema(BridgeIntentSchema).extend(BridgeIntentFieldsZod.shape),
-    PayloadZodStrictOfSchema(BridgeSourceObservationSchema).extend(BridgeSourceObservationFieldsZod.shape),
-  ]),
-  z.tuple([
-    PayloadZodStrictOfSchema(BridgeIntentSchema).extend(BridgeIntentFieldsZod.shape),
-    PayloadZodStrictOfSchema(BridgeSourceObservationSchema).extend(BridgeSourceObservationFieldsZod.shape),
-    PayloadZodStrictOfSchema(BridgeDestinationObservationSchema).extend(BridgeDestinationObservationFieldsZod.shape),
-  ]),
+  z.tuple([BridgeIntentResponseZod]),
+  z.tuple([BridgeIntentResponseZod, BridgeSourceResponseZod]),
+  z.tuple([BridgeIntentResponseZod, BridgeSourceResponseZod, BridgeDestinationResponseZod]),
 ])
 export type BridgeToRemoteStatusResponse = z.infer<typeof BridgeToRemoteStatusResponseZod>
 
+interface StatusQueues {
+  ethTransactionMonitor: Queue
+  ethTransactionPreparation: Queue
+  ethTransactionSubmission: Queue
+  xl1ToEthBridgeParent: Queue
+  xl1TransactionMonitor: Queue
+  xl1TransactionPreparation: Queue
+  xl1TransactionSubmission: Queue
+}
+
+let statusQueues: StatusQueues | undefined
+
+const getStatusQueues = (config: BridgeConfig): StatusQueues => {
+  if (statusQueues) return statusQueues
+  const connection = getConnection(config)
+  statusQueues = {
+    ethTransactionMonitor: new Queue(EthTransactionMonitor.queueName, { connection }),
+    ethTransactionPreparation: new Queue(EthTransactionPreparation.queueName, { connection }),
+    ethTransactionSubmission: new Queue(EthTransactionSubmission.queueName, { connection }),
+    xl1ToEthBridgeParent: new Queue(Xl1ToEthBridgeParent.queueName, { connection }),
+    xl1TransactionMonitor: new Queue(Xl1TransactionMonitor.queueName, { connection }),
+    xl1TransactionPreparation: new Queue(Xl1TransactionPreparation.queueName, { connection }),
+    xl1TransactionSubmission: new Queue(Xl1TransactionSubmission.queueName, { connection }),
+  }
+  return statusQueues
+}
+
+interface StatusQueueJobs {
+  ethTransactionMonitorJob?: Job
+  ethTransactionPreparationJob?: Job
+  ethTransactionSubmissionJob?: Job
+  xl1ToEthBridgeParentJob?: Job
+  xl1TransactionMonitorJob?: Job
+  xl1TransactionPreparationJob?: Job
+  xl1TransactionSubmissionJob?: Job
+}
+
+/**
+ * Checks all the relevant status queues for a job with the given id and returns the jobs found in an object
+ * @param queues The status queues to check for jobs
+ * @param jobId The job id to look for in the queues, which is the same as the tx hash of the bridge transaction
+ * @returns An object containing the jobs found in the status queues corresponding to the given job id
+ */
+const getStatusQueueJobs = async (queues: StatusQueues, jobId: string): Promise<StatusQueueJobs> => {
+  const [
+    ethTransactionMonitorJob,
+    ethTransactionPreparationJob,
+    ethTransactionSubmissionJob,
+    xl1ToEthBridgeParentJob,
+    xl1TransactionMonitorJob,
+    xl1TransactionPreparationJob,
+    xl1TransactionSubmissionJob,
+  ] = await Promise.all([
+    queues.ethTransactionMonitor.getJob(jobId),
+    queues.ethTransactionPreparation.getJob(jobId),
+    queues.ethTransactionSubmission.getJob(jobId),
+    queues.xl1ToEthBridgeParent.getJob(jobId),
+    queues.xl1TransactionMonitor.getJob(jobId),
+    queues.xl1TransactionPreparation.getJob(jobId),
+    queues.xl1TransactionSubmission.getJob(jobId),
+  ])
+  return {
+    ethTransactionMonitorJob,
+    ethTransactionPreparationJob,
+    ethTransactionSubmissionJob,
+    xl1ToEthBridgeParentJob,
+    xl1TransactionMonitorJob,
+    xl1TransactionPreparationJob,
+    xl1TransactionSubmissionJob,
+  }
+}
+
 export const makeBridgeToRemoteStatusRoute = (config: BridgeConfig): RouteDefinition => {
   const params = z.object({
     chainId: getRemoteChainIdZod(config),
     nonce: z.string().nonempty(),
   })
-  const query = z.object({ mockStatus: z.coerce.number().default(0) })
 
-  const validateRequest = requestHandlerValidator({
-    params, query, response: BridgeToRemoteStatusResponseZod,
-  })
+  const validateRequest = requestHandlerValidator({ params, response: BridgeToRemoteStatusResponseZod })
 
   return {
     method: 'get',
     path: '/bridge/chains/:chainId/bridgeToRemote/status/:nonce',
     handlers: validateRequest(async (req, res) => {
-      const { chainId } = req.params
-      const { mockStatus = 0 } = req.query
+      const jobId = req.params.nonce
       const result: z.infer<typeof BridgeToRemoteStatusResponseZod> = [] as unknown as z.infer<typeof BridgeToRemoteStatusResponseZod>
+      const queues = getStatusQueues(config)
 
-      const {
-        remoteTokenAddress, xl1ChainId, xl1TokenAddress,
-      } = await getBridgeSettings(config)
+      const statusQueueJobs = await getStatusQueueJobs(queues, jobId)
 
-      const src = xl1ChainId
-      const srcAddress = asAddress('2222222222222222222222222222222222222222', true)
-      const srcAmount = asHex('0x200', true)
-      const srcToken = xl1TokenAddress
+      // Check for the transaction hash in any of the queues
+      const tx = Object.values(statusQueueJobs).map(job => job?.data?.tx as SignedHydratedTransaction | undefined).find(tx => isDefined(tx))
 
-      const dest = chainId
-      const destAddress = asAddress('3333333333333333333333333333333333333333', true)
-      const destAmount = asHex('0x100', true)
-      const destToken = remoteTokenAddress
+      // If the transaction does not exist in any of them return Not Found
+      if (!tx) return res.sendStatus(404)
 
-      if (mockStatus === 0) return res.sendStatus(404)
-      if (mockStatus > 0) {
-        const [observation] = await generateBridgeEstimate(srcAddress, srcAmount, destAddress, config, req.params.nonce)
-        result[0] = observation
-      }
-      if (mockStatus > 1) {
+      // If the transaction is not the right shape return Not Found
+      const bridgeIntent = tx[1].find(isBridgeIntent)
+      if (!bridgeIntent) return res.sendStatus(404)
+
+      // At this point we know we have a valid bridge intent, so we can start building the response
+      result[0] = asBridgeIntent(PayloadBuilder.omitMeta(bridgeIntent))
+
+      // Check the state of the XL1 monitor job to determine if we can include the source observation
+      const { xl1TransactionMonitorJob } = statusQueueJobs
+      const xl1MonitorState = xl1TransactionMonitorJob ? await xl1TransactionMonitorJob.getState() : undefined
+      const srcConfirmation = asHex(jobId)
+      if (xl1MonitorState === 'completed' && isDefined(srcConfirmation)) {
+        const bridgeCommonFieldsZod = z.object({}).extend(BridgeSourceObservationFieldsZod.shape)
+        const bridgeCommonFields = bridgeCommonFieldsZod.parse(bridgeIntent)
         const observation: BridgeSourceObservation = {
-          schema: BridgeSourceObservationSchema,
-          dest,
-          destAddress,
-          destAmount,
-          destToken,
-          src,
-          srcAddress,
-          srcAmount,
-          srcToken,
-          srcConfirmation: toHex('0x8888'),
+          schema: BridgeSourceObservationSchema, ...bridgeCommonFields, srcConfirmation,
         }
         result[1] = observation
       }
-      if (mockStatus > 2) {
-        const observation: BridgeDestinationObservation = {
-          schema: BridgeDestinationObservationSchema,
-          dest,
-          destAddress,
-          destAmount,
-          destToken,
-          src,
-          srcAddress,
-          srcAmount,
-          srcToken,
-          destConfirmation: toHex('0x9999'),
-        }
+
+      // Check the state of the ETH monitor job to determine if we can include the destination observation
+      const { ethTransactionMonitorJob } = statusQueueJobs
+      const ethMonitorState = ethTransactionMonitorJob ? await ethTransactionMonitorJob.getState() : undefined
+      const submissionHash = (ethTransactionMonitorJob?.returnvalue as { submissionHash?: string } | undefined)?.submissionHash
+      const destConfirmation = asHex(submissionHash)
+      if (ethMonitorState === 'completed' && isDefined(submissionHash)) {
+        const bridgeDestinationFieldsZod = z.object({}).extend(BridgeDestinationObservationFieldsZod.shape)
+        const bridgeDestinationFields = bridgeDestinationFieldsZod.parse({ ...bridgeIntent, destConfirmation })
+        const observation: BridgeDestinationObservation = { schema: BridgeDestinationObservationSchema, ...bridgeDestinationFields }
         result[2] = observation
       }
 

package/src/services/getServices.ts

@@ -2,8 +2,8 @@ import type { Hash } from '@xylabs/sdk-js'
 import { assertEx, isDefined } from '@xylabs/sdk-js'
 import type { BridgeConfig, BridgeConfigContext } from '@xyo-network/chain-orchestration'
 import { initEvmProvider } from '@xyo-network/chain-orchestration'
+import { HDWallet } from '@xyo-network/sdk-js'
 import { BridgeableToken__factory, LiquidityPoolBridge__factory } from '@xyo-network/typechain'
-import { HDWallet } from '@xyo-network/wallet'
 import type { XyoGatewayRunner } from '@xyo-network/xl1-sdk'
 import { getAddress, Wallet } from 'ethers'
 

package/src/util/BridgeFees.ts

@@ -1,7 +1,16 @@
-import type { Hex, JsonObject } from '@xylabs/sdk-js'
+import {
+  type Hex, HexZod, type JsonObject,
+} from '@xylabs/sdk-js'
+import { z } from 'zod'
 
 export interface BridgeFees extends JsonObject {
   feeFixed: Hex
   feeVariable: Hex
   srcAmount: Hex
 }
+
+export const BridgeFeesZod = z.object({
+  feeFixed: HexZod,
+  feeVariable: HexZod,
+  srcAmount: HexZod,
+})

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

@@ -1 +0,0 @@
-{"version":3,"file":"validateSufficientAllowance.d.ts","sourceRoot":"","sources":["../../../../../src/queue/workers/util/validateSufficientAllowance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAClF,OAAO,EAAkB,KAAK,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAErF,UAAU,YAAY;IACpB,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,UAAU,CAAC,OAAO,CAAC,CAAA;CAC9C;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B,GACtC,IAAI,yBAAyB,EAC7B,iBAAiB,eAAe,EAChC,QAAQ,mBAAmB,EAC3B,SAAS,YAAY,qBActB,CAAA"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"validateSufficientBalance.d.ts","sourceRoot":"","sources":["../../../../../src/queue/workers/util/validateSufficientBalance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAClF,OAAO,EAAkB,KAAK,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAErF,UAAU,YAAY;IACpB,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,UAAU,CAAC,OAAO,CAAC,CAAA;CAC9C;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB,GACpC,IAAI,yBAAyB,EAC7B,iBAAiB,eAAe,EAChC,QAAQ,mBAAmB,EAC3B,SAAS,YAAY,qBAatB,CAAA"}