@xyo-network/xl1-protocol 1.12.16 → 1.12.17

package/dist/neutral/payload/elevatable/Bridge/BridgeCompletion.d.ts

@@ -0,0 +1,23 @@
+import type { Hash } from '@xylabs/hex';
+/**
+ * Final confirmation tying the intent and the observation together.
+ */
+export interface BridgeCompletionFields {
+    /**
+     * Block number, event ID, or timestamp when the bridge was completed
+     */
+    completedAt?: Hash;
+    /**
+     * Reference to observed destination confirmation hash
+     */
+    destObservation: Hash;
+    /**
+     * Reference to source intent hash
+     */
+    srcIntent?: Hash;
+    /**
+     * Reference to observed source confirmation hash
+     */
+    srcObservation: Hash;
+}
+//# sourceMappingURL=BridgeCompletion.d.ts.map

package/dist/neutral/payload/elevatable/Bridge/BridgeCompletion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeCompletion.d.ts","sourceRoot":"","sources":["../../../../../src/payload/elevatable/Bridge/BridgeCompletion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAEvC;;GAEG;AACH,MAAM,WAAW,sBAAsB;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAA;IAElB;;OAEG;IACH,eAAe,EAAE,IAAI,CAAA;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAA;CAErB"}

package/dist/neutral/payload/elevatable/Bridge/BridgeDetails.d.ts

@@ -0,0 +1,39 @@
+import type { Hex } from '@xylabs/hex';
+/**
+ * Represents a transfer from a source chain/token/address to a destination chain/token/address.
+ */
+export interface BridgeDetailsFields {
+    /**
+     * Destination network
+     */
+    dest: Hex;
+    /**
+     * Destination address (EOA or contract)
+     */
+    destAddress: Hex;
+    /**
+     * Token amount to bridge to destination
+     */
+    destAmount: Hex;
+    /**
+     * Token being bridged to
+     */
+    destToken: Hex;
+    /**
+     * Source network
+     */
+    src: Hex;
+    /**
+     * Source address (EOA or contract)
+     */
+    srcAddress: Hex;
+    /**
+     * Token amount to bridge form source
+     */
+    srcAmount: Hex;
+    /**
+     * Token being bridged from
+     */
+    srcToken: Hex;
+}
+//# sourceMappingURL=BridgeDetails.d.ts.map

package/dist/neutral/payload/elevatable/Bridge/BridgeDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeDetails.d.ts","sourceRoot":"","sources":["../../../../../src/payload/elevatable/Bridge/BridgeDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAElC;;OAEG;IACH,IAAI,EAAE,GAAG,CAAA;IAET;;OAEG;IACH,WAAW,EAAE,GAAG,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,GAAG,CAAA;IAEf;;OAEG;IACH,SAAS,EAAE,GAAG,CAAA;IAEd;;OAEG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;OAEG;IACH,UAAU,EAAE,GAAG,CAAA;IAEf;;OAEG;IACH,SAAS,EAAE,GAAG,CAAA;IAEd;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAA;CACd"}

package/dist/neutral/payload/elevatable/Bridge/BridgeIntent.d.ts

@@ -0,0 +1,11 @@
+import type { BridgeDetailsFields } from './BridgeDetails.ts';
+/**
+ * Represents an Addresses intent to initiate a token bridge.
+ */
+export interface BridgeIntentFields extends BridgeDetailsFields {
+    /**
+     * Unique identifier for replay protection
+     */
+    nonce: string;
+}
+//# sourceMappingURL=BridgeIntent.d.ts.map

package/dist/neutral/payload/elevatable/Bridge/BridgeIntent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeIntent.d.ts","sourceRoot":"","sources":["../../../../../src/payload/elevatable/Bridge/BridgeIntent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE7D;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd"}

package/dist/neutral/payload/elevatable/Bridge/BridgeObservation.d.ts

@@ -0,0 +1,25 @@
+import type { Hex } from '@xylabs/hex';
+import type { BridgeDetailsFields } from './BridgeDetails.ts';
+/**
+ * Represents an observation that confirms a bridge action occurred on the source chain.
+ */
+export interface BridgeSourceObservationFields extends BridgeDetailsFields {
+    /**
+     * Source chain confirmation
+     */
+    srcConfirmation?: Hex;
+}
+/**
+ * Represents an observation that confirms a bridge action occurred on the destination chain.
+ */
+export interface BridgeDestinationObservationFields extends BridgeDetailsFields {
+    /**
+     * Destination chain confirmation
+     */
+    destConfirmation?: Hex;
+}
+/**
+ * Represents an observation that confirms a bridge action occurred on either the source or destination chain.
+ */
+export type BridgeObservationFields = BridgeSourceObservationFields | BridgeDestinationObservationFields;
+//# sourceMappingURL=BridgeObservation.d.ts.map

package/dist/neutral/payload/elevatable/Bridge/BridgeObservation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeObservation.d.ts","sourceRoot":"","sources":["../../../../../src/payload/elevatable/Bridge/BridgeObservation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAEtC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE7D;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAA;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,mBAAmB;IAC7E;;OAEG;IACH,gBAAgB,CAAC,EAAE,GAAG,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,6BAA6B,GAAG,kCAAkC,CAAA"}

package/dist/neutral/payload/elevatable/Bridge/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BridgeCompletion.ts';
+export * from './BridgeIntent.ts';
+export * from './BridgeObservation.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/payload/elevatable/Bridge/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/payload/elevatable/Bridge/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA"}

package/dist/neutral/payload/elevatable/Bridge/spec/Bridge.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Bridge.test.d.ts.map

package/dist/neutral/payload/elevatable/Bridge/spec/Bridge.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bridge.test.d.ts","sourceRoot":"","sources":["../../../../../../src/payload/elevatable/Bridge/spec/Bridge.test.ts"],"names":[],"mappings":""}

package/dist/neutral/payload/elevatable/index.d.ts

@@ -1,3 +1,4 @@
+export * from './Bridge/index.ts';
 export * from './BridgeBack.ts';
 export * from './BridgeComplete.ts';
 export * from './BridgeRequest.ts';

package/dist/neutral/payload/elevatable/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/payload/elevatable/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,mBAAmB,CAAA;AACjC,cAAc,WAAW,CAAA;AACzB,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/payload/elevatable/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,mBAAmB,CAAA;AACjC,cAAc,WAAW,CAAA;AACzB,cAAc,sBAAsB,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol",
-  "version": "1.12.16",
+  "version": "1.12.17",
   "description": "XYO Layer One Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {

package/src/payload/elevatable/Bridge/BridgeCompletion.ts

@@ -0,0 +1,28 @@
+import type { Hash } from '@xylabs/hex'
+
+/**
+ * Final confirmation tying the intent and the observation together.
+ */
+export interface BridgeCompletionFields {
+
+  /**
+   * Block number, event ID, or timestamp when the bridge was completed
+   */
+  completedAt?: Hash
+
+  /**
+   * Reference to observed destination confirmation hash
+   */
+  destObservation: Hash
+
+  /**
+   * Reference to source intent hash
+   */
+  srcIntent?: Hash
+
+  /**
+   * Reference to observed source confirmation hash
+   */
+  srcObservation: Hash
+
+}

package/src/payload/elevatable/Bridge/BridgeDetails.ts

@@ -0,0 +1,47 @@
+import type { Hex } from '@xylabs/hex'
+
+/**
+ * Represents a transfer from a source chain/token/address to a destination chain/token/address.
+ */
+export interface BridgeDetailsFields {
+
+  /**
+   * Destination network
+   */
+  dest: Hex
+
+  /**
+   * Destination address (EOA or contract)
+   */
+  destAddress: Hex
+
+  /**
+   * Token amount to bridge to destination
+   */
+  destAmount: Hex
+
+  /**
+   * Token being bridged to
+   */
+  destToken: Hex
+
+  /**
+   * Source network
+   */
+  src: Hex
+
+  /**
+   * Source address (EOA or contract)
+   */
+  srcAddress: Hex
+
+  /**
+   * Token amount to bridge form source
+   */
+  srcAmount: Hex
+
+  /**
+   * Token being bridged from
+   */
+  srcToken: Hex
+}

package/src/payload/elevatable/Bridge/BridgeIntent.ts

@@ -0,0 +1,11 @@
+import type { BridgeDetailsFields } from './BridgeDetails.ts'
+
+/**
+ * Represents an Addresses intent to initiate a token bridge.
+ */
+export interface BridgeIntentFields extends BridgeDetailsFields {
+  /**
+   * Unique identifier for replay protection
+   */
+  nonce: string
+}

package/src/payload/elevatable/Bridge/BridgeObservation.ts

@@ -0,0 +1,27 @@
+import type { Hex } from '@xylabs/hex'
+
+import type { BridgeDetailsFields } from './BridgeDetails.ts'
+
+/**
+ * Represents an observation that confirms a bridge action occurred on the source chain.
+ */
+export interface BridgeSourceObservationFields extends BridgeDetailsFields {
+  /**
+   * Source chain confirmation
+   */
+  srcConfirmation?: Hex
+}
+/**
+ * Represents an observation that confirms a bridge action occurred on the destination chain.
+ */
+export interface BridgeDestinationObservationFields extends BridgeDetailsFields {
+  /**
+   * Destination chain confirmation
+   */
+  destConfirmation?: Hex
+}
+
+/**
+ * Represents an observation that confirms a bridge action occurred on either the source or destination chain.
+ */
+export type BridgeObservationFields = BridgeSourceObservationFields | BridgeDestinationObservationFields

package/src/payload/elevatable/Bridge/index.ts

@@ -0,0 +1,3 @@
+export * from './BridgeCompletion.ts'
+export * from './BridgeIntent.ts'
+export * from './BridgeObservation.ts'

package/src/payload/elevatable/Bridge/spec/Bridge.test.ts

@@ -0,0 +1,127 @@
+import { toAddress, toHex } from '@xylabs/hex'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import type { Chain } from '../../../../model.ts'
+import { AttoXL1ConvertFactor } from '../../../../xl1/index.ts'
+import type { BridgeIntentFields } from '../BridgeIntent.ts'
+import type { BridgeObservationFields } from '../BridgeObservation.ts'
+
+describe('Bridge', () => {
+  const srcAmount = toHex(100n * AttoXL1ConvertFactor.xl1) // 100 XL1 in AttoXL1
+  const destAmount = srcAmount // 1:1 for test
+
+  const xl1ChainId: Chain = toHex('dd381fbb392c85160d8b0453e446757b12384046')
+  const ethChainId = toHex('0x1')
+
+  const xl1Address = toAddress('1111111111111111111111111111111111111111')
+  const ethAddress = toAddress('0x2222222222222222222222222222222222222222')
+
+  const bridgeableTokenContract = toHex('0x3333333333333333333333333333333333333333')
+
+  const nonce = 'd5eeff33-d5bc-4aca-9ecb-3406c02a5dc4'
+
+  const xl1TxHash = toHex('0x4444444444444444444444444444444444444444444444444444444444444444') // Some XL1 tx hash
+  const ethTxHash = toHex('0x5555555555555555555555555555555555555555555555555555555555555555') // Some Eth tx hash
+
+  describe('XL1 to ETH', () => {
+    it('Sender issues BridgeIntent', () => {
+      const intent: BridgeIntentFields = {
+        // Source
+        src: xl1ChainId, // From XL1
+        srcAddress: xl1Address, // From XL1 sender
+        srcAmount,
+        srcToken: xl1ChainId, // In XL1
+
+        // Destination
+        dest: ethChainId, // To Ethereum
+        destAddress: ethAddress,
+        destAmount,
+        destToken: bridgeableTokenContract,
+
+        // Details
+        nonce,
+      }
+      expect(intent).toMatchSnapshot()
+    })
+    it('BridgeObservation (XL1 Side)', () => {
+      const observation: BridgeObservationFields = {
+        // Source
+        src: xl1ChainId, // From XL1
+        srcAddress: xl1Address, // From XL1 sender
+        srcAmount,
+        srcToken: xl1ChainId, // In XL1
+
+        // Destination
+        dest: ethChainId, // To Ethereum
+        destAddress: ethAddress,
+        destAmount,
+        destToken: bridgeableTokenContract,
+
+        // Observation
+        srcConfirmation: xl1TxHash,
+      }
+      expect(observation).toMatchSnapshot()
+    })
+    it('BridgeObservation (ETH Side)', () => {
+      const observation: BridgeObservationFields = {
+        // Source
+        src: xl1ChainId, // From XL1
+        srcAddress: xl1Address, // From XL1 sender
+        srcAmount,
+        srcToken: xl1ChainId, // In XL1
+
+        // Destination
+        dest: ethChainId, // To Ethereum
+        destAddress: ethAddress,
+        destAmount,
+        destToken: bridgeableTokenContract,
+
+        // Observation
+        destConfirmation: ethTxHash,
+      }
+      expect(observation).toMatchSnapshot()
+    })
+  })
+  describe('ETH to XL1', () => {
+    it('BridgeObservation (ETH Side)', () => {
+      const observation: BridgeObservationFields = {
+        // Source
+        src: ethChainId, // From Ethereum
+        srcToken: bridgeableTokenContract, // In Ethereum
+        srcAddress: ethAddress, // From Ethereum sender
+        srcAmount,
+
+        // Destination
+        dest: xl1ChainId, // To XL1
+        destToken: xl1ChainId, // In XL1
+        destAddress: xl1Address, // To XL1 Address
+        destAmount,
+
+        // Observation
+        srcConfirmation: ethTxHash,
+      }
+      expect(observation).toMatchSnapshot()
+    })
+    it('BridgeObservation (XL1 Side)', () => {
+      const observation: BridgeObservationFields = {
+        // Source
+        src: ethChainId, // From Ethereum
+        srcToken: bridgeableTokenContract, // In Ethereum
+        srcAddress: ethAddress, // From Ethereum sender
+        srcAmount,
+
+        // Destination
+        dest: xl1ChainId, // To XL1
+        destToken: xl1ChainId, // In XL1
+        destAddress: xl1Address, // To XL1 Address
+        destAmount,
+
+        // Observation
+        destConfirmation: xl1TxHash,
+      }
+      expect(observation).toMatchSnapshot()
+    })
+  })
+})

package/src/payload/elevatable/Bridge/spec/__snapshots__/Bridge.test.ts.snap

@@ -0,0 +1,71 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Bridge > ETH to XL1 > BridgeObservation (ETH Side) 1`] = `
+{
+  "dest": "dd381fbb392c85160d8b0453e446757b12384046",
+  "destAddress": "1111111111111111111111111111111111111111",
+  "destAmount": "056bc75e2d63100000",
+  "destToken": "dd381fbb392c85160d8b0453e446757b12384046",
+  "src": "01",
+  "srcAddress": "2222222222222222222222222222222222222222",
+  "srcAmount": "056bc75e2d63100000",
+  "srcConfirmation": "5555555555555555555555555555555555555555555555555555555555555555",
+  "srcToken": "3333333333333333333333333333333333333333",
+}
+`;
+
+exports[`Bridge > ETH to XL1 > BridgeObservation (XL1 Side) 1`] = `
+{
+  "dest": "dd381fbb392c85160d8b0453e446757b12384046",
+  "destAddress": "1111111111111111111111111111111111111111",
+  "destAmount": "056bc75e2d63100000",
+  "destConfirmation": "4444444444444444444444444444444444444444444444444444444444444444",
+  "destToken": "dd381fbb392c85160d8b0453e446757b12384046",
+  "src": "01",
+  "srcAddress": "2222222222222222222222222222222222222222",
+  "srcAmount": "056bc75e2d63100000",
+  "srcToken": "3333333333333333333333333333333333333333",
+}
+`;
+
+exports[`Bridge > XL1 to ETH > BridgeObservation (ETH Side) 1`] = `
+{
+  "dest": "01",
+  "destAddress": "2222222222222222222222222222222222222222",
+  "destAmount": "056bc75e2d63100000",
+  "destConfirmation": "5555555555555555555555555555555555555555555555555555555555555555",
+  "destToken": "3333333333333333333333333333333333333333",
+  "src": "dd381fbb392c85160d8b0453e446757b12384046",
+  "srcAddress": "1111111111111111111111111111111111111111",
+  "srcAmount": "056bc75e2d63100000",
+  "srcToken": "dd381fbb392c85160d8b0453e446757b12384046",
+}
+`;
+
+exports[`Bridge > XL1 to ETH > BridgeObservation (XL1 Side) 1`] = `
+{
+  "dest": "01",
+  "destAddress": "2222222222222222222222222222222222222222",
+  "destAmount": "056bc75e2d63100000",
+  "destToken": "3333333333333333333333333333333333333333",
+  "src": "dd381fbb392c85160d8b0453e446757b12384046",
+  "srcAddress": "1111111111111111111111111111111111111111",
+  "srcAmount": "056bc75e2d63100000",
+  "srcConfirmation": "4444444444444444444444444444444444444444444444444444444444444444",
+  "srcToken": "dd381fbb392c85160d8b0453e446757b12384046",
+}
+`;
+
+exports[`Bridge > XL1 to ETH > Sender issues BridgeIntent 1`] = `
+{
+  "dest": "01",
+  "destAddress": "2222222222222222222222222222222222222222",
+  "destAmount": "056bc75e2d63100000",
+  "destToken": "3333333333333333333333333333333333333333",
+  "nonce": "d5eeff33-d5bc-4aca-9ecb-3406c02a5dc4",
+  "src": "dd381fbb392c85160d8b0453e446757b12384046",
+  "srcAddress": "1111111111111111111111111111111111111111",
+  "srcAmount": "056bc75e2d63100000",
+  "srcToken": "dd381fbb392c85160d8b0453e446757b12384046",
+}
+`;

package/src/payload/elevatable/index.ts

@@ -1,3 +1,4 @@
+export * from './Bridge/index.ts'
 export * from './BridgeBack.ts'
 export * from './BridgeComplete.ts'
 export * from './BridgeRequest.ts'

package/src/validation/block/error.spec.ts

@@ -15,8 +15,6 @@ describe('HydratedBlockStateValidationError', () => {
       'Test Error',
       [new Error('Inner error')],
     )
-    console.log('error', error)
-
     expect(error).toBeDefined()
   })
 })