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

package/src/transaction/primitives/spec/transactionBlockByteCount.spec.ts

@@ -3,14 +3,14 @@ import type {
 } from '@xylabs/hex'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { AnyPayload, Sequence } from '@xyo-network/payload-model'
-import type { HydratedTransaction, TransactionBoundWitness } from '@xyo-network/xl1-protocol'
+import type { SignedHydratedTransactionWithStorageMeta, TransactionBoundWitness } from '@xyo-network/xl1-protocol'
 import {
   describe, expect, it,
 } from 'vitest'
 
 import { transactionBlockByteCount } from '../transactionBlockByteCount.ts'
 
-const hydratedTransaction: HydratedTransaction<TransactionBoundWitness, AnyPayload> = [
+const hydratedTransaction: SignedHydratedTransactionWithStorageMeta<TransactionBoundWitness, AnyPayload> = [
   {
     schema: 'network.xyo.boundwitness',
     addresses: [
@@ -90,7 +90,7 @@ describe('transactionBlockByteCount', () => {
 
   it('handles transaction with empty payload array', () => {
     // Arrange
-    const emptyPayloadsTransaction: HydratedTransaction = [
+    const emptyPayloadsTransaction: SignedHydratedTransactionWithStorageMeta = [
       { ...hydratedTransaction[0] },
       [], // Empty payload array
     ]
@@ -122,7 +122,7 @@ describe('transactionBlockByteCount', () => {
       },
     })
 
-    const complexTransaction: HydratedTransaction = [
+    const complexTransaction: SignedHydratedTransactionWithStorageMeta = [
       { ...hydratedTransaction[0] },
       [complexPayload],
     ]
@@ -155,7 +155,7 @@ describe('transactionBlockByteCount', () => {
       _hash: `hash${i}`,
     })))
 
-    const largeTransaction: HydratedTransaction = [
+    const largeTransaction: SignedHydratedTransactionWithStorageMeta = [
       { ...hydratedTransaction[0] },
       largePayloads,
     ]
@@ -185,7 +185,7 @@ describe('transactionBlockByteCount', () => {
       _hash: 'special-hash',
     })
 
-    const specialTransaction: HydratedTransaction = [
+    const specialTransaction: SignedHydratedTransactionWithStorageMeta = [
       { ...hydratedTransaction[0] },
       [specialCharPayload],
     ]
@@ -219,7 +219,7 @@ describe('transactionBlockByteCount', () => {
       _extraMeta2: 'should be omitted as well',
     })
 
-    const transactionWithExtraMeta: HydratedTransaction = [
+    const transactionWithExtraMeta: SignedHydratedTransactionWithStorageMeta = [
       txWithExtraMeta,
       [payloadWithExtraMeta],
     ]

package/src/transaction/primitives/transactionBlockByteCount.ts

@@ -1,8 +1,8 @@
 import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { SignedHydratedTransaction } from '@xyo-network/xl1-protocol'
 
 /** The number of bytes that a transaction and its payloads will take up in a block */
-export function transactionBlockByteCount([transaction, payloads]: HydratedTransaction): number {
+export function transactionBlockByteCount([transaction, payloads]: SignedHydratedTransaction): number {
   const cleanTransaction = PayloadBuilder.omitStorageMeta(transaction)
   const transactionBytes = JSON.stringify(cleanTransaction).length
   const cleanPayloads = PayloadBuilder.omitStorageMeta(payloads)

package/src/transaction/primitives/transactionElevatedPayloads.ts

@@ -1,6 +1,6 @@
 import { asHash, type Hash } from '@xylabs/hex'
 import type { Payload, WithHashStorageMeta } from '@xyo-network/payload-model'
-import type { HydratedTransaction, TransactionBoundWitness } from '@xyo-network/xl1-protocol'
+import type { SignedHydratedTransactionWithStorageMeta, TransactionBoundWitness } from '@xyo-network/xl1-protocol'
 
 import { crackOperations } from './transactionOperations.ts'
 
@@ -9,7 +9,7 @@ export function transactionElevatedPayloadHashes(transaction: TransactionBoundWi
   return elevateOperations.map(op => asHash(op[1][0], true))
 }
 
-export function transactionElevatedPayloads([transaction, payloads]: HydratedTransaction): WithHashStorageMeta<Payload>[] {
+export function transactionElevatedPayloads([transaction, payloads]: SignedHydratedTransactionWithStorageMeta): WithHashStorageMeta<Payload>[] {
   const hashes = transactionElevatedPayloadHashes(transaction)
   const elevatedPayloads = payloads.filter(payload => hashes.includes(payload._hash))
   return elevatedPayloads

package/src/transaction/primitives/transactionRequiredGas.ts

@@ -1,16 +1,16 @@
-import type { HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
 import { AttoXL1, TransactionGasCosts } from '@xyo-network/xl1-protocol'
 
 import { transactionBlockByteCount } from './transactionBlockByteCount.ts'
 import { transactionElevatedPayloads } from './transactionElevatedPayloads.ts'
 
 /** The required gas for the byte storage on the block chain for a transaction */
-export function transactionBytesRequiredGas([transaction, payloads]: HydratedTransaction): AttoXL1 {
+export function transactionBytesRequiredGas([transaction, payloads]: SignedHydratedTransactionWithStorageMeta): AttoXL1 {
   const transactionBlockBytes = transactionBlockByteCount([transaction, payloads])
   return AttoXL1(TransactionGasCosts.characterStorage * BigInt(transactionBlockBytes))
 }
 
-export function transactionRequiredGas(hydratedTransaction: HydratedTransaction): AttoXL1 {
+export function transactionRequiredGas(hydratedTransaction: SignedHydratedTransactionWithStorageMeta): AttoXL1 {
   const elevatedPayloads = transactionElevatedPayloads(hydratedTransaction)
   const hashes = elevatedPayloads.length + 1 /* for transaction itself */
   const signatures = hydratedTransaction[0].addresses.length

package/src/transaction/script.ts

@@ -2,7 +2,7 @@ import { filterAs } from '@xylabs/array'
 import { assertEx } from '@xylabs/assert'
 import { asHash, type Hash } from '@xylabs/hex'
 import type { WithStorageMeta } from '@xyo-network/payload-model'
-import type { AllowedBlockPayload, HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { AllowedBlockPayload, HydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
 import { isAllowedBlockPayloadWithHashStorageMeta } from '@xyo-network/xl1-protocol'
 
 export const tryExtractElevatedHashesFromScript = (strings: string[]): Hash[] => {
@@ -21,7 +21,7 @@ export const extractElevatedHashesFromScript = (strings: string[]): Hash[] => {
   return filtered
 }
 
-export const tryExtractElevatedHashes = (tx: HydratedTransaction): WithStorageMeta<AllowedBlockPayload>[] => {
+export const tryExtractElevatedHashes = (tx: HydratedTransactionWithStorageMeta): WithStorageMeta<AllowedBlockPayload>[] => {
   const [bw, payloads] = tx
   const { script } = bw
   const hashes = script ? tryExtractElevatedHashesFromScript(script) : []
@@ -30,7 +30,7 @@ export const tryExtractElevatedHashes = (tx: HydratedTransaction): WithStorageMe
     .filter(isAllowedBlockPayloadWithHashStorageMeta)
 }
 
-export const extractElevatedHashes = (tx: HydratedTransaction): WithStorageMeta<AllowedBlockPayload>[] => {
+export const extractElevatedHashes = (tx: HydratedTransactionWithStorageMeta): WithStorageMeta<AllowedBlockPayload>[] => {
   const [bw, payloads] = tx
   const { script } = bw
   const hashes = script ? tryExtractElevatedHashesFromScript(script) : []

package/src/transaction/signTransaction.ts

@@ -5,14 +5,14 @@ import type { AccountInstance } from '@xyo-network/account-model'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { TransactionBoundWitness } from '@xyo-network/xl1-protocol'
 
-export async function signTransaction(tx: TransactionBoundWitness, signer: AccountInstance) {
-  assertEx(tx.from === signer.address, () => 'Signer address does not match transaction from address')
+export async function signTransaction(tx: TransactionBoundWitness, account: AccountInstance) {
+  assertEx(tx.from === account.address, () => 'Signer address does not match transaction from address')
   const signedTx = structuredClone(tx)
-  signedTx.addresses = [signer.address]
-  signedTx.previous_hashes = [signer.previousHash ?? null]
+  signedTx.addresses = [account.address]
+  signedTx.previous_hashes = [account.previousHash ?? null]
   const hash = await PayloadBuilder.hash(signedTx)
   const hashBytes = toArrayBuffer(hash)
-  const [signature] = await signer.sign(hashBytes)
+  const [signature] = await account.sign(hashBytes)
   signedTx.$signatures = [hexFromArrayBuffer(signature)]
   return signedTx
 }

package/src/validation/schema/Mnemonic.ts

@@ -9,7 +9,7 @@ import { z } from 'zod'
  * • Checks that the word-count is 12, 15, 18, 21, or 24.
  *
  */
-export const MnemonicStringSchema = z
+export const MnemonicStringZod = z
   .string()
   .transform(s => s.trim().replaceAll(/\s+/g, ' ')) // normalize spacing
   .refine(
@@ -17,4 +17,4 @@ export const MnemonicStringSchema = z
     { message: 'Mnemonic must contain 12, 15, 18, 21, or 24 words.' },
   ).describe('BIP-39 mnemonic string')
 
-export type MnemonicString = z.infer<typeof MnemonicStringSchema>
+export type MnemonicString = z.infer<typeof MnemonicStringZod>