@xyo-network/xl1-protocol-sdk 1.12.0 → 1.12.2

package/src/transaction/signTransaction.ts

@@ -2,17 +2,29 @@ import { toArrayBuffer } from '@xylabs/arraybuffer'
 import { assertEx } from '@xylabs/assert'
 import { hexFromArrayBuffer } from '@xylabs/hex'
 import type { AccountInstance } from '@xyo-network/account-model'
+import type { Unsigned } from '@xyo-network/boundwitness-model'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { TransactionBoundWitness } from '@xyo-network/xl1-protocol'
 
-export async function signTransaction(tx: TransactionBoundWitness, account: AccountInstance) {
+/**
+ * Signs an unsigned transaction with the provided account.
+ * @param tx The transaction to sign
+ * @param account The account to sign the transaction with
+ * @returns The signed transaction
+ */
+export async function signTransaction(tx: Unsigned<TransactionBoundWitness>, account: AccountInstance) {
   assertEx(tx.from === account.address, () => 'Signer address does not match transaction from address')
+  // Clone tx to prevent modifying original
   const signedTx = structuredClone(tx)
+  // Update dynamic fields based on account
   signedTx.addresses = [account.address]
   signedTx.previous_hashes = [account.previousHash ?? null]
-  const hash = await PayloadBuilder.hash(signedTx)
+  // Calculate tx hash and sign it
+  const hash = await PayloadBuilder.dataHash(signedTx)
   const hashBytes = toArrayBuffer(hash)
   const [signature] = await account.sign(hashBytes)
+  // Append the signatures to the transaction
   signedTx.$signatures = [hexFromArrayBuffer(signature)]
+  // Return the signed transaction
   return signedTx
 }

package/src/transaction/spec/signTransaction.spec.ts

@@ -0,0 +1,46 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Account } from '@xyo-network/account'
+import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
+import type { TransactionBoundWitness } from '@xyo-network/xl1-protocol'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { signTransaction } from '../signTransaction.ts'
+
+describe('signTransaction', () => {
+  it('successfully signs transaction', async () => {
+    const bw = {
+      $signatures: [],
+      addresses: [],
+      chain: '0000000000000000000000000000000000000000',
+      exp: 1001,
+      fees: {
+        base: 'e8d4a51000',
+        gasLimit: '038d7ea4c68000',
+        gasPrice: '02540be400',
+        priority: '00',
+      },
+      nbf: 1,
+      payload_hashes: [
+        '34e5eadb2ccfc7005e224bfa6c3d10c32087d63238005efeaef9c67a85ed6fa2',
+        'eb28b0213854d3b5f255806c2261e568fabcef8afa8b7d7f504bee35d9bce917',
+      ],
+      payload_schemas: [
+        'network.xyo.hash',
+        'network.xyo.id',
+      ],
+      previous_hashes: [],
+      schema: 'network.xyo.boundwitness',
+      script: [
+        'elevate|34e5eadb2ccfc7005e224bfa6c3d10c32087d63238005efeaef9c67a85ed6fa2',
+      ],
+    } as any as TransactionBoundWitness
+    const account = await Account.random()
+    bw.from = account.address
+    const signed = await signTransaction(bw, account)
+    expect(signed).toBeDefined()
+    const validationErrors = await new BoundWitnessValidator(signed).validate()
+    expect(validationErrors.length).toBe(0)
+  })
+})

package/src/validation/schema/Mnemonic.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod'
+import * as z from 'zod'
 
 /**
  * Validates a single string containing a BIP-39 mnemonic.