@xyo-network/chain-services 1.10.2 → 1.12.0

package/src/BlockProducer/generateTransactionFeeTransfers.ts

@@ -1,7 +1,8 @@
 import { assertEx } from '@xylabs/assert'
 import { type Address, hexFromBigInt } from '@xylabs/hex'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type {
-  HydratedTransaction,
+  SignedHydratedTransaction,
   Transfer,
   XL1,
 } from '@xyo-network/xl1-protocol'
@@ -9,8 +10,10 @@ import { TransferSchema, XYO_ZERO_ADDRESS } from '@xyo-network/xl1-protocol'
 import { transactionRequiredGas } from '@xyo-network/xl1-protocol-sdk'
 import { HydratedTransactionWrapper } from '@xyo-network/xl1-wrappers'
 
-export async function generateTransactionFeeTransfers(address: Address, transactions: HydratedTransaction[]): Promise<Transfer[]> {
-  const txs = await Promise.all(transactions.map(tx => HydratedTransactionWrapper.parse(tx)))
+export async function generateTransactionFeeTransfers(address: Address, transactions: SignedHydratedTransaction[]): Promise<Transfer[]> {
+  const txs = await Promise.all(transactions.map(async (tx) => {
+    return HydratedTransactionWrapper.parse([await PayloadBuilder.addStorageMeta(tx[0]), await PayloadBuilder.addStorageMeta(tx[1])])
+  }))
 
   // merge transactions with the same from address
   const txBaseFeeCosts: Record<Address, bigint> = {}

package/src/BlockProducer/spec/BaseBlockProducerService.spec.ts

@@ -4,8 +4,10 @@ import { filterAs } from '@xylabs/array'
 import { assertEx } from '@xylabs/assert'
 import type { CreatableName } from '@xylabs/creatable'
 import { delay } from '@xylabs/delay'
-import type { Address, Hex } from '@xylabs/hex'
-import { asAddress, ZERO_HASH } from '@xylabs/hex'
+import type { Address } from '@xylabs/hex'
+import {
+  asAddress, hexToBigInt, ZERO_HASH,
+} from '@xylabs/hex'
 import { Account } from '@xyo-network/account'
 import type { AccountInstance } from '@xyo-network/account-model'
 import { MemoryArchivist } from '@xyo-network/archivist-memory'
@@ -17,7 +19,7 @@ import {
 } from '@xyo-network/payload-model'
 import { HDWallet } from '@xyo-network/wallet'
 import type {
-  BlockBoundWitness, BlockRewardService, ElectionService,
+  BlockBoundWitness, BlockRewardService, Chain, ElectionService,
   HydratedBlock,
   HydratedBlockStateValidationFunctionV2,
   StakeIntentService,
@@ -26,7 +28,9 @@ import {
   asBlockBoundWitness,
   asChainStakeIntent,
   asTransactionBoundWitness,
+  asTransfer,
   HydratedBlockStateValidationError,
+  XYO_ZERO_ADDRESS,
 } from '@xyo-network/xl1-protocol'
 import type { Config } from '@xyo-network/xl1-protocol-sdk'
 import {
@@ -171,7 +175,7 @@ describe('XyoBlockProducer', () => {
           let rejectBlock = true
           const validateHydratedBlockState: HydratedBlockStateValidationFunctionV2 = async (
             hydratedBlock: HydratedBlock,
-            chainId: Hex,
+            chainId: Chain,
           ) => {
             return rejectBlock ? [await Promise.resolve(new HydratedBlockStateValidationError(ZERO_HASH, chainId, hydratedBlock, 'Invalid block'))] : []
           }
@@ -216,11 +220,21 @@ describe('XyoBlockProducer', () => {
           expect(result).toBeArrayOfSize(2)
           const [block, transactionsAndData] = result ?? []
           expect(block).toBeDefined()
-          expect(asBlockBoundWitness(block)).toBeDefined()
-          expect(transactionsAndData).toBeDefined()
-          expect(transactionsAndData).toBeArray()
-          const transactions = filterAs(assertEx(transactionsAndData), asTransactionBoundWitness)
-          expect(transactions).toBeArrayOfSize(newTransactionCount)
+          if (block) {
+            expect(asBlockBoundWitness(block)).toBeDefined()
+            expect(transactionsAndData).toBeDefined()
+            expect(transactionsAndData).toBeArray()
+            const transactions = filterAs(assertEx(transactionsAndData), asTransactionBoundWitness)
+            expect(transactions).toBeArrayOfSize(newTransactionCount)
+            const transfers = filterAs(assertEx(transactionsAndData), asTransfer)
+            const blockRewardTransfer = transfers.find(transfer => transfer.from === XYO_ZERO_ADDRESS)
+            expect(blockRewardTransfer).toBeDefined()
+            for (const value of Object.values(blockRewardTransfer?.transfers ?? {})) {
+              if (value) {
+                expect(hexToBigInt(value)).toEqual(1_500_000_000_000_000_000_000n)
+              }
+            }
+          }
         })
       })
     })

package/src/BlockProducer/spec/generateTransactionTransfer.spec.ts

@@ -9,7 +9,7 @@ import { isDefined } from '@xylabs/typeof'
 import type { Sequence, WithStorageMeta } from '@xyo-network/payload-model'
 import { XYO_ZERO_ADDRESS } from '@xyo-network/xl1-protocol'
 import {
-  defaultTransactionFees, type HydratedTransaction, type Transfer,
+  defaultTransactionFees, type SignedHydratedTransactionWithStorageMeta, type Transfer,
 } from '@xyo-network/xl1-protocol'
 import {
   describe, expect, it,
@@ -18,7 +18,7 @@ import {
 import { generateTransactionFeeTransfers } from '../generateTransactionFeeTransfers.ts'
 
 describe('generateTransactionTransfers', () => {
-  const testCases: HydratedTransaction[][] = [
+  const testCases: SignedHydratedTransactionWithStorageMeta[][] = [
     [
       [
         {

package/src/ChainBlockNumberIteration/model/BlockNumberIteration.ts

@@ -1,7 +1,7 @@
 import type { Promisable } from '@xylabs/promise'
-import type { BlockBoundWitness, HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { BlockBoundWitness, SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
 
 export interface BlockNumberIteration {
   validatePendingBlock(block: BlockBoundWitness): Promisable<Error[]>
-  validatePendingTransaction(tx: HydratedTransaction): Promise<boolean>
+  validatePendingTransaction(tx: SignedHydratedTransactionWithStorageMeta): Promise<boolean>
 }

package/src/ChainValidator/XyoValidator.ts

@@ -1,15 +1,15 @@
 import { assertEx } from '@xylabs/assert'
 import { creatable } from '@xylabs/creatable'
-import { Address } from '@xylabs/hex'
 import { Promisable } from '@xylabs/promise'
 import { AccountInstance } from '@xyo-network/account-model'
 import { ArchivistInstance, ReadArchivist } from '@xyo-network/archivist-model'
 import {
   BlockBoundWitness,
   BlockRewardService,
+  Chain,
   ElectionService,
   HydratedBlockStateValidationFunctionV2,
-  HydratedTransaction,
+  SignedHydratedTransactionWithStorageMeta,
   StakeIntentService,
 } from '@xyo-network/xl1-protocol'
 
@@ -20,7 +20,7 @@ import { Validator } from './model/index.ts'
 export interface XyoValidatorParams extends BaseServiceParams {
   account: AccountInstance
   chainArchivist: ReadArchivist
-  chainId: Address
+  chainId: Chain
   electionService: ElectionService
   pendingBundledTransactionsArchivist: ArchivistInstance
   rewardService: BlockRewardService
@@ -63,7 +63,7 @@ export class XyoValidator<TParams extends XyoValidatorParams = XyoValidatorParam
   }
 
   // TODO: Move to validator and inherit this class from validator
-  async validatePendingTransaction(hydratedTransaction: HydratedTransaction): Promise<boolean> {
+  async validatePendingTransaction(hydratedTransaction: SignedHydratedTransactionWithStorageMeta): Promise<boolean> {
     const [tx] = hydratedTransaction
     // Ensure not confirmed already (replay attack)
     if ((await this.chainArchivist.get([tx._hash])).length > 0) return false

package/src/ChainValidator/model/Validator.ts

@@ -1,7 +1,7 @@
 import type { Promisable } from '@xylabs/promise'
-import type { BlockBoundWitness, HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { BlockBoundWitness, SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
 
 export interface Validator {
   validatePendingBlock(block: BlockBoundWitness): Promisable<Error[]>
-  validatePendingTransaction(tx: HydratedTransaction): Promise<boolean>
+  validatePendingTransaction(tx: SignedHydratedTransactionWithStorageMeta): Promise<boolean>
 }

package/src/PendingTransactions/BasePendingTransactions.ts

@@ -4,7 +4,7 @@ import { assertEx } from '@xylabs/assert'
 import { creatable } from '@xylabs/creatable'
 import { exists } from '@xylabs/exists'
 import { forget } from '@xylabs/forget'
-import { Address, Hash } from '@xylabs/hex'
+import { Hash } from '@xylabs/hex'
 import { isDefined, isUndefined } from '@xylabs/typeof'
 import { MemoryArchivist } from '@xyo-network/archivist-memory'
 import { ArchivistInstance } from '@xyo-network/archivist-model'
@@ -13,7 +13,8 @@ import {
   Payload, PayloadBundle, Sequence, WithStorageMeta,
 } from '@xyo-network/payload-model'
 import {
-  asBlockBoundWitnessWithHashStorageMeta, HydratedTransaction, isTransactionBoundWitnessWithStorageMeta, PendingTransactionsService,
+  asBlockBoundWitnessWithHashStorageMeta, Chain, isTransactionBoundWitnessWithStorageMeta, PendingTransactionsService,
+  SignedHydratedTransactionWithStorageMeta,
 } from '@xyo-network/xl1-protocol'
 import { TransactionJsonSchemaValidator, validateTransaction } from '@xyo-network/xl1-validation'
 import { Mutex } from 'async-mutex'
@@ -25,7 +26,7 @@ import { hydratedTransactionToPayloadBundle } from './hydratedTransactionToPaylo
 
 export interface BasePendingTransactionsServiceParams extends BaseServiceParams {
   chainArchivist?: ArchivistInstance
-  chainId?: Address
+  chainId?: Chain
   pendingBundledTransactionsArchivist?: ArchivistInstance
   rejectedTransactionsArchivist?: ArchivistInstance
 }
@@ -134,7 +135,7 @@ export class BasePendingTransactionsService extends BaseService<BasePendingTrans
     })
   }
 
-  async getPendingTransactions(head: Hash, limit: number): Promise<HydratedTransaction[]> {
+  async getPendingTransactions(head: Hash, limit: number): Promise<SignedHydratedTransactionWithStorageMeta[]> {
     return await this.spanAsync('getPendingTransactions', async () => {
     // Acquires an exclusive mutex to ensure no race conditions while accessing pending transactions.
       return await this._updateCuratedPendingTransactionsArchivistMutex.runExclusive(async () => {
@@ -144,7 +145,7 @@ export class BasePendingTransactionsService extends BaseService<BasePendingTrans
 
         await this.pruneCuratedPendingTransactionsArchivist(lastHead._hash)
 
-        const foundPendingTransactions: HydratedTransaction[] = []
+        const foundPendingTransactions: SignedHydratedTransactionWithStorageMeta[] = []
         let cursor: Sequence | undefined
 
         // Continue fetching until the desired number of transactions is reached.
@@ -333,7 +334,7 @@ export class BasePendingTransactionsService extends BaseService<BasePendingTrans
  * @returns True if the transaction is expired for the given block, false otherwise.
  */
 const isTransactionExpired = (block: number) =>
-  ([txBw]: HydratedTransaction): boolean =>
+  ([txBw]: SignedHydratedTransactionWithStorageMeta): boolean =>
     txBw.exp < block
 
 /**
@@ -342,5 +343,5 @@ const isTransactionExpired = (block: number) =>
  * @returns True if the transaction is active for the given block, false otherwise.
  */
 const isTransactionActive = (block: number) =>
-  ([txBw]: HydratedTransaction): boolean =>
+  ([txBw]: SignedHydratedTransactionWithStorageMeta): boolean =>
     txBw.nbf <= block && txBw.exp >= block

package/src/PendingTransactions/bundledPayloadToHydratedTransaction.ts

@@ -1,11 +1,11 @@
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { PayloadBundle, WithStorageMeta } from '@xyo-network/payload-model'
-import type { HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
 import { asTransactionBoundWitnessWithStorageMeta } from '@xyo-network/xl1-protocol'
 
 export const bundledPayloadToHydratedTransaction = async (
   payload: WithStorageMeta<PayloadBundle>,
-): Promise<HydratedTransaction | undefined> => {
+): Promise<SignedHydratedTransactionWithStorageMeta | undefined> => {
   const withStorageMeta = await PayloadBuilder.addStorageMeta(payload.payloads)
   const tx = asTransactionBoundWitnessWithStorageMeta(withStorageMeta.find(p => p._hash === payload.root))
   if (tx) {

package/src/PendingTransactions/hydratedTransactionToPayloadBundle.ts

@@ -2,15 +2,15 @@ import type { Hash } from '@xylabs/hex'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { PayloadBundle } from '@xyo-network/payload-model'
 import { PayloadBundleSchema } from '@xyo-network/payload-model'
-import type { HydratedTransaction } from '@xyo-network/xl1-protocol'
+import type { SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
 import { flattenHydratedTransaction } from '@xyo-network/xl1-protocol-sdk'
 
-export const hydratedTransactionToPayloadBundle = (transaction: HydratedTransaction): PayloadBundle => {
+export const hydratedTransactionToPayloadBundle = (transaction: SignedHydratedTransactionWithStorageMeta): PayloadBundle => {
   const root = transaction[0]._hash
   return bundle(root, transaction)
 }
 
-const bundle = (root: Hash, transaction: HydratedTransaction) => {
+const bundle = (root: Hash, transaction: SignedHydratedTransactionWithStorageMeta) => {
   const payloads = flattenHydratedTransaction(transaction).flatMap(p => PayloadBuilder.omitStorageMeta(p))
   return new PayloadBuilder<PayloadBundle>({ schema: PayloadBundleSchema })
     .fields({ payloads, root })

package/src/PendingTransactions/spec/BasePendingTransactions.spec.ts

@@ -14,7 +14,8 @@ import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { WithStorageMeta } from '@xyo-network/payload-model'
 import type {
   BlockBoundWitness, HashPayload,
-  HydratedBlock, HydratedTransaction,
+  HydratedBlock,
+  SignedHydratedTransactionWithStorageMeta,
 } from '@xyo-network/xl1-protocol'
 import { HashSchema } from '@xyo-network/xl1-protocol'
 import {
@@ -64,7 +65,7 @@ describe('BasePendingTransactionsService', () => {
   })
 
   describe('with pending transactions', () => {
-    let newTransactions: HydratedTransaction[] = []
+    let newTransactions: SignedHydratedTransactionWithStorageMeta[] = []
     beforeEach(async () => {
       for (let index = 0; index < 5; index++) {
         const tx = await buildRandomTransaction(TestChainId)
@@ -88,8 +89,8 @@ describe('BasePendingTransactionsService', () => {
   })
 
   describe('with pending and finalized transactions', () => {
-    let finalizedTransactions: HydratedTransaction[] = []
-    let newTransactions: HydratedTransaction[] = []
+    let finalizedTransactions: SignedHydratedTransactionWithStorageMeta[] = []
+    let newTransactions: SignedHydratedTransactionWithStorageMeta[] = []
     beforeEach(async () => {
       for (let index = 0; index < 5; index++) {
         const tx = await buildRandomTransaction(TestChainId)
@@ -118,7 +119,7 @@ describe('BasePendingTransactionsService', () => {
       .build()
     beforeEach(async () => {})
     it('when unique should allow transactions', async () => {
-      let newTransactions: HydratedTransaction[] = []
+      let newTransactions: SignedHydratedTransactionWithStorageMeta[] = []
       // NOTE: Cast to Account to allow loadPreviousHash to be called
       const signer = await Account.random()
       const transaction1 = await buildTransaction(TestChainId, [hashPayload], [], signer, 0, 100)
@@ -133,7 +134,7 @@ describe('BasePendingTransactionsService', () => {
       expect(result.length).toEqual(newTransactions.length)
     })
     it('when non-unique should filter duplicate transactions', async () => {
-      let newTransactions: HydratedTransaction[] = []
+      let newTransactions: SignedHydratedTransactionWithStorageMeta[] = []
       const previousHash = 'bb27dd470ccf91665d573a16b4f652a47b8a24686d1b44c189c1fa826cd3fef5'
       // NOTE: Cast to Account to allow loadPreviousHash to be called
       const signer = await Account.random() as Account
@@ -154,7 +155,7 @@ describe('BasePendingTransactionsService', () => {
 
   describe('with expiring transactions', () => {
     const insertTransaction = async (nbf: number, exp: number) => {
-      const newTransactions: HydratedTransaction[] = []
+      const newTransactions: SignedHydratedTransactionWithStorageMeta[] = []
       const signer = await Account.random()
       const hashPayload = new PayloadBuilder<HashPayload>({ schema: HashSchema })
         .fields({ hash: head._hash })
@@ -237,8 +238,8 @@ describe('BasePendingTransactionsService', () => {
   })
 
   describe('with pending and rejected transactions', () => {
-    let rejectedTransactions: HydratedTransaction[] = []
-    let newTransactions: HydratedTransaction[] = []
+    let rejectedTransactions: SignedHydratedTransactionWithStorageMeta[] = []
+    let newTransactions: SignedHydratedTransactionWithStorageMeta[] = []
     beforeEach(async () => {
       for (let index = 0; index < 5; index++) {
         const tx = await buildRandomTransaction(TestChainId)
@@ -263,7 +264,7 @@ describe('BasePendingTransactionsService', () => {
   describe('with invalid transactions in mempool', () => {
     beforeEach(async () => {
       const incorrectChainId = assertEx(asAddress('1234567890abcdef1234567890abcdef12345678'))
-      const invalidTransactions: HydratedTransaction[] = [await buildRandomTransaction(incorrectChainId)]
+      const invalidTransactions: SignedHydratedTransactionWithStorageMeta[] = [await buildRandomTransaction(incorrectChainId)]
       const pending = invalidTransactions.map(hydratedTransactionToPayloadBundle)
       await pendingBundledTransactionsArchivist.insert(pending)
     })