@xyo-network/xl1-protocol-sdk 1.17.7 → 1.18.0

package/src/summary/primitives/balances/balancesSummary.ts

@@ -1,27 +1,27 @@
 import type { Address } from '@xylabs/sdk-js'
-import {
-  asAddress, isDefined, spanRootAsync,
-} from '@xylabs/sdk-js'
-import {
-  asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber, asXL1BlockRange,
-} from '@xyo-network/xl1-protocol'
+import { asAddress, spanRootAsync } from '@xylabs/sdk-js'
+import { asBlockBoundWitnessWithStorageMeta, asXL1BlockRange } from '@xyo-network/xl1-protocol'
 
 import { deepCalculateFramesFromRange } from '../../../block/index.ts'
-import type { Qualified } from '../../../model/index.ts'
+import {
+  type ChainQualified, type ChainQualifiedConfig, isChainQualifiedHeadConfig,
+  isChainQualifiedRangeConfig,
+} from '../../../model/index.ts'
 import { parseSignedBigInt } from '../../../SignedBigInt.ts'
 import type { BalanceStepSummaryContext } from '../../model/index.ts'
 import { balancesStepSummaryFromRange } from './balancesStepSummaryFromRange.ts'
 
 export async function balancesSummary(
   context: BalanceStepSummaryContext,
-): Promise<Qualified<Record<Address, bigint>>> {
+  config?: ChainQualifiedConfig,
+): Promise<ChainQualified<Record<Address, bigint>>> {
   return await spanRootAsync('balancesSummary', async () => {
-    const [headHash] = await context.head()
+    const [headHash] = isChainQualifiedHeadConfig(config) ? [config.head] : await context.head()
     const headResult = await context.store.chainMap.get(headHash)
     const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${headHash}`)
-    const rangeStart = asXL1BlockNumber(isDefined(context.windowSize) ? Math.max(headBoundWitness.block - context.windowSize + 1, 0) : 0, true)
+    const range = isChainQualifiedRangeConfig(config) ? config.range : asXL1BlockRange([0, headBoundWitness.block], true)
     const ranges = deepCalculateFramesFromRange(asXL1BlockRange(
-      [rangeStart, headBoundWitness.block],
+      range,
       { name: 'balancesSummary' },
     ))
     const summaries = await Promise.all(ranges.map(range => balancesStepSummaryFromRange(context, range)))
@@ -32,6 +32,6 @@ export async function balancesSummary(
         balances[validAddress] = (balances[validAddress] ?? 0n) + parseSignedBigInt(balance)
       }
     }
-    return [balances, [rangeStart, headBoundWitness.block], headHash]
+    return [balances, { range, head: headHash }]
   })
 }

package/src/summary/primitives/schemas/schemasSummary.ts

@@ -1,24 +1,26 @@
-import { isDefined, spanRootAsync } from '@xylabs/sdk-js'
+import { spanRootAsync } from '@xylabs/sdk-js'
 import type { Schema } from '@xyo-network/payload-model'
-import {
-  asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber, asXL1BlockRange,
-} from '@xyo-network/xl1-protocol'
+import { asBlockBoundWitnessWithStorageMeta, asXL1BlockRange } from '@xyo-network/xl1-protocol'
 
 import { deepCalculateFramesFromRange } from '../../../block/index.ts'
-import type { Qualified } from '../../../model/index.ts'
+import {
+  type ChainQualified, type ChainQualifiedConfig, isChainQualifiedHeadConfig,
+  isChainQualifiedRangeConfig,
+} from '../../../model/index.ts'
 import type { SchemasStepSummaryContext } from '../../model/index.ts'
 import { schemasStepSummaryFromRange } from './schemasStepSummaryFromRange.ts'
 
 export async function schemasSummary(
   context: SchemasStepSummaryContext,
-): Promise<Qualified<Record<Schema, number>>> {
+  config?: ChainQualifiedConfig,
+): Promise<ChainQualified<Record<Schema, number>>> {
   return await spanRootAsync('schemasSummary', async () => {
-    const [headHash] = await context.head()
+    const [headHash] = isChainQualifiedHeadConfig(config) ? [config.head] : await context.head()
     const headResult = await context.store.chainMap.get(headHash)
     const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${headHash}`)
-    const rangeStart = asXL1BlockNumber(isDefined(context.windowSize) ? Math.max(headBoundWitness.block - context.windowSize + 1, 0) : 0, true)
+    const range = isChainQualifiedRangeConfig(config) ? config.range : asXL1BlockRange([0, headBoundWitness.block], true)
     const ranges = deepCalculateFramesFromRange(asXL1BlockRange(
-      [rangeStart, headBoundWitness.block],
+      range,
       { name: 'schemasSummary' },
     ))
     const summaries = await Promise.all(ranges.map(range => schemasStepSummaryFromRange(context, range)))
@@ -28,6 +30,6 @@ export async function schemasSummary(
         results[schema] = (results[schema] ?? 0) + count
       }
     }
-    return [results, [rangeStart, headBoundWitness.block], headHash]
+    return [results, { range, head: headHash }]
   })
 }

package/src/summary/primitives/transfers/transfersSummary.ts

@@ -1,31 +1,29 @@
 import type { Address, Hash } from '@xylabs/sdk-js'
-import {
-  asAddress, isDefined, spanRootAsync,
-} from '@xylabs/sdk-js'
-import {
-  asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber, asXL1BlockRange,
-} from '@xyo-network/xl1-protocol'
+import { asAddress, spanRootAsync } from '@xylabs/sdk-js'
+import { asBlockBoundWitnessWithStorageMeta, asXL1BlockRange } from '@xyo-network/xl1-protocol'
 
 import { deepCalculateFramesFromRange } from '../../../block/index.ts'
-import type { Qualified } from '../../../model/index.ts'
+import type { ChainQualified, ChainQualifiedConfig } from '../../../model/index.ts'
+import { isChainQualifiedHeadConfig, isChainQualifiedRangeConfig } from '../../../model/index.ts'
 import { parseSignedBigInt } from '../../../SignedBigInt.ts'
 import type { TransfersStepSummaryContext } from '../../index.ts'
 import { transfersStepSummaryFromRange } from './transfersStepSummaryFromRange.ts'
 
 // the summary of amount of rewards claimed from the step reward pool by addresses
 export async function transfersSummary(
-  transferContext: TransfersStepSummaryContext,
-): Promise<Qualified<Record<Address, Record<Address, bigint>>>> {
+  context: TransfersStepSummaryContext,
+  config?: ChainQualifiedConfig,
+): Promise<ChainQualified<Record<Address, Record<Address, bigint>>>> {
   return await spanRootAsync('transferSummary', async () => {
-    const [headHash] = await transferContext.head()
-    const headResult = await transferContext.store.chainMap.get(headHash)
-    const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${transferContext.head}`)
-    const rangeStart = asXL1BlockNumber(isDefined(transferContext.windowSize) ? Math.max(headBoundWitness.block - transferContext.windowSize + 1, 0) : 0, true)
+    const [headHash] = isChainQualifiedHeadConfig(config) ? [config.head] : await context.head()
+    const headResult = await context.store.chainMap.get(headHash)
+    const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${headHash}`)
+    const range = isChainQualifiedRangeConfig(config) ? config.range : asXL1BlockRange([0, headBoundWitness.block], true)
     const ranges = deepCalculateFramesFromRange(asXL1BlockRange(
-      [rangeStart, headBoundWitness.block],
+      range,
       { name: 'transfersSummary' },
     ))
-    const summaries = await Promise.all(ranges.map(range => transfersStepSummaryFromRange(transferContext, range)))
+    const summaries = await Promise.all(ranges.map(range => transfersStepSummaryFromRange(context, range)))
     const transfers: Record<Address, Record<Address, bigint>> = {}
     for (let summary of summaries) {
       for (const [from, toMap] of Object.entries(summary.transfers)) {
@@ -37,7 +35,7 @@ export async function transfersSummary(
         }
       }
     }
-    return [transfers, [rangeStart, headBoundWitness.block], headHash]
+    return [transfers, { range, head: headHash }]
   })
 }
 

package/src/transaction/TransactionBuilder.ts

@@ -0,0 +1,162 @@
+import type { Hex } from '@xylabs/sdk-js'
+import { assertEx, Base } from '@xylabs/sdk-js'
+import type { AccountInstance } from '@xyo-network/account-model'
+import { PayloadBuilder, type PayloadBuilderOptions } from '@xyo-network/payload-builder'
+import type { Payload } from '@xyo-network/payload-model'
+import type {
+  AllowedBlockPayload,
+  ChainId,
+  TransactionFeesBigInt,
+} from '@xyo-network/xl1-protocol'
+import {
+  asXL1BlockNumber,
+  defaultTransactionFees, isAllowedBlockPayload, minTransactionFees, XYO_ZERO_ADDRESS,
+} from '@xyo-network/xl1-protocol'
+
+import { buildTransaction } from './buildTransaction.ts'
+import { transactionRequiredGas } from './primitives/index.ts'
+
+export class TransactionBuilder<TPayload extends Payload> extends Base<Omit<PayloadBuilderOptions, 'schema'>> {
+  private _blockRange?: [number, number]
+  private _chain?: Hex
+  private _elevatedPayloads: AllowedBlockPayload[] = []
+  private _fees: TransactionFeesBigInt | undefined
+  private _payloads: TPayload[] = []
+  private _signers: AccountInstance[] = []
+
+  constructor(options: Omit<PayloadBuilderOptions, 'schema'> = {}) {
+    super(options)
+  }
+
+  async build() {
+    const chain = assertEx(this._chain, () => 'Chain must be set before building the transaction')
+    const fees = assertEx(this._fees, () => 'Fees must be set before building the transaction')
+    const blockRange = assertEx(this._blockRange, () => 'Block range must be set before building the transaction')
+    return await buildTransaction(
+      chain,
+      this._elevatedPayloads,
+      this._payloads,
+      this._signers,
+      asXL1BlockNumber(blockRange[0], true),
+      asXL1BlockNumber(blockRange[1], true),
+      this._signers[0]?.address,
+      fees,
+    )
+  }
+
+  chain(chain: ChainId) {
+    this._chain = chain
+    return this
+  }
+
+  async dryRun() {
+    return await buildTransaction(
+      XYO_ZERO_ADDRESS,
+      this._elevatedPayloads,
+      this._payloads,
+      this._signers,
+      asXL1BlockNumber(0, true),
+      asXL1BlockNumber(1000, true),
+      this._signers[0]?.address,
+      defaultTransactionFees,
+    )
+  }
+
+  elevatedPayload(payload?: AllowedBlockPayload) {
+    const allowedPayload = isAllowedBlockPayload(payload) ? payload : undefined
+    const allowPayloadExists = assertEx(allowedPayload, () => 'Payload must be an AllowedBlockPayload')
+    this._elevatedPayloads.push(allowPayloadExists)
+    return this
+  }
+
+  elevatedPayloads(payloads?: AllowedBlockPayload[]) {
+    if (payloads)
+      for (const payload of payloads) {
+        this.elevatedPayload(payload)
+      }
+    return this
+  }
+
+  async estimatedMinimumFees(): Promise<TransactionFeesBigInt> {
+    const tx = await this.dryRun()
+    const requiredGas = transactionRequiredGas(tx)
+    return {
+      base: minTransactionFees.base,
+      // eslint-disable-next-line unicorn/prefer-math-min-max
+      gasLimit: requiredGas > minTransactionFees.gasLimit ? requiredGas : minTransactionFees.gasLimit,
+      gasPrice: minTransactionFees.gasPrice,
+      priority: minTransactionFees.priority,
+    }
+  }
+
+  fees(fees: TransactionFeesBigInt) {
+    this._fees = fees
+    return this
+  }
+
+  payload(payload?: TPayload) {
+    this._payloads.push(payload as TPayload)
+    return this
+  }
+
+  payloads(payloads?: TPayload[]) {
+    if (payloads)
+      for (const payload of payloads) {
+        if (payload !== null) {
+          this.payload(payload)
+        }
+      }
+    return this
+  }
+
+  range(blockRange: [number, number]) {
+    if (blockRange.length !== 2) {
+      throw new Error('Block range must be an array of two numbers')
+    }
+    this._blockRange = blockRange
+    return this
+  }
+
+  async removeElevatedPayload(payload: AllowedBlockPayload) {
+    const hash = await PayloadBuilder.hash(payload)
+    const existingHashes = await PayloadBuilder.hashes(this._elevatedPayloads)
+
+    // no async after this point to prevent changing _elevatedPayloads from other promise
+    const existingPayloadIndex = existingHashes.indexOf(hash)
+    if (existingPayloadIndex === -1) {
+      throw new Error('Payload not found in the transaction')
+    }
+    this._elevatedPayloads = this._elevatedPayloads.filter((_, index) => index !== existingPayloadIndex)
+    return this
+  }
+
+  async removePayload(payload: TPayload) {
+    const hash = await PayloadBuilder.hash(payload)
+    const existingHashes = await PayloadBuilder.hashes(this._payloads)
+
+    // no async after this point to prevent changing _payloads from other promise
+    const existingPayloadIndex = existingHashes.indexOf(hash)
+    if (existingPayloadIndex === -1) {
+      throw new Error('Payload not found in the transaction')
+    }
+    this._payloads = this._payloads.filter((_, index) => index !== existingPayloadIndex)
+    return this
+  }
+
+  signer(signer?: AccountInstance) {
+    if (signer) {
+      this._signers.push(signer)
+    }
+    return this
+  }
+
+  signers(signers?: (AccountInstance | null)[]) {
+    if (signers)
+      for (const signer of signers) {
+        if (signer !== null) {
+          this.signer(signer)
+        }
+      }
+    return this
+  }
+}

package/src/transaction/buildRandomTransaction.ts

@@ -0,0 +1,36 @@
+import type { Address } from '@xylabs/sdk-js'
+import { Account } from '@xyo-network/account'
+import type { AccountInstance } from '@xyo-network/account-model'
+import type { Payload, Schema } from '@xyo-network/payload-model'
+import type {
+  AllowedBlockPayload, ChainId,
+  SignedHydratedTransactionWithHashMeta,
+  Transfer,
+  XL1BlockNumber,
+} from '@xyo-network/xl1-protocol'
+import { asXL1BlockNumber, isAllowedBlockPayload } from '@xyo-network/xl1-protocol'
+
+import { createTransferPayload } from '../createTransferPayload.ts'
+import { buildTransaction } from './buildTransaction.ts'
+
+export const buildRandomTransaction = async (
+  chain: ChainId,
+  payloads?: Payload[],
+  account?: AccountInstance,
+  nbf: XL1BlockNumber = asXL1BlockNumber(0, true),
+  exp: XL1BlockNumber = asXL1BlockNumber(nbf + 1000, true),
+  privatePayloadSchemas: Schema[] = [],
+  receiverAddress?: Address,
+): Promise<SignedHydratedTransactionWithHashMeta> => {
+  const elevatedPayloads: AllowedBlockPayload[] = (payloads ?? []).filter(isAllowedBlockPayload)
+  const additionalPayloads: Payload[] = (payloads ?? []).filter(payload => !isAllowedBlockPayload(payload))
+  const sender = account ?? await Account.random()
+  if (elevatedPayloads?.length === 0) {
+    const receiver = receiverAddress ?? (await Account.random()).address
+    const transferPayload: Transfer = createTransferPayload(sender.address, { [receiver]: 1n })
+    elevatedPayloads.push(transferPayload)
+  }
+  const hydratedTransaction = await buildTransaction(chain, elevatedPayloads, additionalPayloads, sender, nbf, exp)
+  // remove private payloads from hydrated
+  return [hydratedTransaction[0], hydratedTransaction[1].filter(p => !privatePayloadSchemas.includes(p.schema))]
+}

package/src/transaction/hydrateTransaction.ts

@@ -7,7 +7,7 @@ import type {
   SignedHydratedTransactionWithStorageMeta, TransactionBoundWitness,
 } from '@xyo-network/xl1-protocol'
 import {
-  asSignedHydratedBlock, asSignedHydratedTransaction, isAllowedBlockPayload, isSignedTransactionBoundWitnessWithStorageMeta,
+  asSignedHydratedTransaction, isAllowedBlockPayload, isSignedTransactionBoundWitnessWithStorageMeta,
 } from '@xyo-network/xl1-protocol'
 
 import type { ChainStoreRead } from '../model/index.ts'

package/src/transaction/index.ts

@@ -1,3 +1,4 @@
+export * from './buildRandomTransaction.ts'
 export * from './buildTransaction.ts'
 export * from './buildUnsignedTransaction.ts'
 export * from './confirmSubmittedTransaction.ts'
@@ -5,3 +6,4 @@ export * from './hydrateTransaction.ts'
 export * from './primitives/index.ts'
 export * from './script.ts'
 export * from './signTransaction.ts'
+export * from './TransactionBuilder.ts'

package/src/viewers/AccountBalance.ts

@@ -1,18 +1,18 @@
-import type {
-  Address, Hash, Promisable,
-} from '@xylabs/sdk-js'
+import { type Address, type Promisable } from '@xylabs/sdk-js'
+import { zodIsFactory } from '@xylabs/zod'
 import { WithHashMetaZod } from '@xyo-network/payload-model'
 import {
   type AttoXL1,
   TransferZod,
-  type XL1BlockRange,
 } from '@xyo-network/xl1-protocol'
 import { BlockBoundWitnessZod, TransactionBoundWitnessZod } from '@xyo-network/xl1-protocol'
 import z from 'zod'
 
-import type {
-  Provider,
-  Qualified,
+import {
+  ChainQualificationZod,
+  type ChainQualified,
+  ChainQualifiedConfigZod,
+  type Provider,
 } from '../model/index.ts'
 
 export const AccountBalanceHistoryItemZod = z.tuple([
@@ -23,19 +23,27 @@ export const AccountBalanceHistoryItemZod = z.tuple([
 
 export type AccountBalanceHistoryItem = z.infer<typeof AccountBalanceHistoryItemZod>
 
+export const AccountBalanceQualificationZod = ChainQualificationZod
+export type AccountBalanceQualification = z.infer<typeof AccountBalanceQualificationZod>
+export const isAccountBalanceQualification = zodIsFactory(AccountBalanceQualificationZod)
+
+export const AccountBalanceConfigZod = ChainQualifiedConfigZod
+export type AccountBalanceConfig = z.infer<typeof AccountBalanceConfigZod>
+export const isAccountBalanceCOnfig = zodIsFactory(AccountBalanceConfigZod)
+
 export interface AccountBalanceViewerMethods {
   qualifiedAccountBalanceHistories(
     address: Address[],
-    headOrRange?: Hash | XL1BlockRange
-  ): Promisable<Qualified<Record<Address, AccountBalanceHistoryItem[]>>>
-  qualifiedAccountBalances(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Qualified<Record<Address, AttoXL1>>>
+    config: AccountBalanceConfig
+  ): Promisable<ChainQualified<Record<Address, AccountBalanceHistoryItem[]>>>
+  qualifiedAccountBalances(address: Address[], config: AccountBalanceConfig): Promisable<ChainQualified<Record<Address, AttoXL1>>>
 }
 
 export interface AccountBalanceViewer extends AccountBalanceViewerMethods, Provider<AccountBalanceViewerMoniker> {
-  accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>
-  accountBalanceHistories(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Record<Address, AccountBalanceHistoryItem[]>>
-  accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>
-  accountBalances(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Record<Address, AttoXL1>>
+  accountBalance(address: Address, config?: AccountBalanceConfig): Promisable<AttoXL1>
+  accountBalanceHistories(address: Address[], config?: AccountBalanceConfig): Promisable<Record<Address, AccountBalanceHistoryItem[]>>
+  accountBalanceHistory(address: Address, config?: AccountBalanceConfig): Promisable<AccountBalanceHistoryItem[]>
+  accountBalances(address: Address[], config?: AccountBalanceConfig): Promisable<Record<Address, AttoXL1>>
 }
 
 export const AccountBalanceViewerMoniker = 'AccountBalanceViewer' as const

package/src/viewers/Block.ts

@@ -1,6 +1,8 @@
 import type { Hash, Promisable } from '@xylabs/sdk-js'
 import type { Payload, WithHashMeta } from '@xyo-network/payload-model'
-import type { SignedHydratedBlockWithHashMeta, XL1BlockNumber } from '@xyo-network/xl1-protocol'
+import type {
+  ChainId, SignedHydratedBlockWithHashMeta, XL1BlockNumber,
+} from '@xyo-network/xl1-protocol'
 
 import type { Provider } from '../model/index.ts'
 
@@ -17,6 +19,9 @@ export type BlockViewerMoniker = typeof BlockViewerMoniker
 export interface BlockViewer extends BlockViewerMethods, Provider<BlockViewerMoniker> {
   blockByHash(hash: Hash): Promisable<SignedHydratedBlockWithHashMeta | null>
   blockByNumber(block: XL1BlockNumber): Promisable<SignedHydratedBlockWithHashMeta | null>
+  chainId(): Promisable<ChainId>
+  chainId(blockNumber: XL1BlockNumber): Promisable<ChainId>
+  chainId(blockNumber: 'latest'): Promisable<ChainId>
   currentBlockHash(): Promisable<Hash>
   currentBlockNumber(): Promisable<XL1BlockNumber>
   payloadByHash(hash: Hash): Promisable<WithHashMeta<Payload> | null>

package/src/viewers/BlockValidation.ts

@@ -0,0 +1,47 @@
+import { type Promisable } from '@xylabs/sdk-js'
+import { zodIsFactory } from '@xylabs/zod'
+import type { HydratedBlock, SignedHydratedBlockWithHashMeta } from '@xyo-network/xl1-protocol'
+import z from 'zod'
+
+import {
+  ChainQualificationZod, ChainQualifiedHeadConfigZod, ChainQualifiedRangeConfigZod, type Provider,
+} from '../model/index.ts'
+import type { HydratedBlockValidationError } from '../validation/index.ts'
+
+export const BlockValidationQualificationZod = ChainQualificationZod
+export type BlockValidationQualification = z.infer<typeof BlockValidationQualificationZod>
+export const isBlockValidationQualification = zodIsFactory(BlockValidationQualificationZod)
+
+export const BlockValidationConfigFieldsZod = z.object({
+  value: z.boolean().optional(),
+  state: z.boolean().optional(),
+})
+
+export const BlockValidationConfigZod = z.union([
+  BlockValidationConfigFieldsZod.extend(ChainQualifiedHeadConfigZod.shape),
+  BlockValidationConfigFieldsZod.extend(ChainQualifiedRangeConfigZod.shape),
+  BlockValidationConfigFieldsZod,
+  z.object({}),
+])
+
+export type BlockValidationConfig = z.infer<typeof BlockValidationConfigZod>
+export const isBlockValidationConfig = zodIsFactory(BlockValidationConfigZod)
+
+export interface BlockValidationViewerMethods {
+  qualifiedValidateBlocks(
+    blocks: HydratedBlock[],
+    config?: BlockValidationConfig
+  ): Promisable<[HydratedBlockValidationError[], BlockValidationQualification]>
+}
+
+export const BlockValidationViewerMoniker = 'BlockValidationViewer' as const
+export type BlockValidationViewerMoniker = typeof BlockValidationViewerMoniker
+
+export interface BlockValidationViewer extends BlockValidationViewerMethods, Provider<BlockValidationViewerMoniker> {
+  qualifiedValidateBlock(
+    block: SignedHydratedBlockWithHashMeta,
+    config?: BlockValidationConfig
+  ): Promisable<[HydratedBlockValidationError[], BlockValidationQualification]>
+  validateBlock(block: SignedHydratedBlockWithHashMeta, config?: BlockValidationConfig): Promisable<HydratedBlockValidationError[]>
+  validateBlocks(blocks: SignedHydratedBlockWithHashMeta[], config?: BlockValidationConfig): Promisable<HydratedBlockValidationError[]>
+}

package/src/viewers/ChainStakeViewer.ts

@@ -1,5 +1,4 @@
 import type { Provider } from '../model/index.ts'
-import type { ChainViewer } from './Chain.ts'
 import type { ChainContractViewer } from './ChainContract.ts'
 import type { StakeTotalsViewer } from './StakeTotals.ts'
 
@@ -7,6 +6,6 @@ export const ChainStakeViewerMoniker = 'ChainStakeViewer' as const
 export type ChainStakeViewerMoniker = typeof ChainStakeViewerMoniker
 
 export interface ChainStakeViewer extends Omit<ChainContractViewer, 'moniker'>, Omit<StakeTotalsViewer, 'moniker'>,
-  Omit<ChainViewer, 'moniker'>, Provider<ChainStakeViewerMoniker> {
+  Provider<ChainStakeViewerMoniker> {
 
 }

package/src/viewers/Fork.ts

@@ -4,6 +4,5 @@ import type { ChainId } from '@xyo-network/xl1-protocol'
 export type ForkHistory = Record<number, ChainId>
 
 export interface ForkViewerMethods {
-  chainIdAtBlock(blockNumber: number): Promisable<ChainId | undefined>
   forkHistory(): Promisable<ForkHistory>
 }

package/src/viewers/Stake.ts

@@ -4,7 +4,6 @@ import type { Position, Provider } from '../model/index.ts'
 import type { StakeEventsViewer } from './StakeEvents.ts'
 
 export interface StakeViewerProperties {
-  chainId: Address
   minWithdrawalBlocks: number
   rewardsContract: Address
   stakeEvents: StakeEventsViewer

package/src/viewers/StakeIntent.ts

@@ -3,10 +3,10 @@ import type {
 } from '@xylabs/sdk-js'
 import type { ChainStakeIntent, XL1BlockRange } from '@xyo-network/xl1-protocol'
 
-import type { Provider, Qualified } from '../model/index.ts'
+import type { ChainQualified, Provider } from '../model/index.ts'
 
 export interface StakeIntentViewerMethods {
-  qualifiedIntentByAddress(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<Qualified<ChainStakeIntent | null>>
+  qualifiedIntentByAddress(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<ChainQualified<ChainStakeIntent | null>>
 }
 
 export const StakeIntentViewerMoniker = 'StakeIntentViewer' as const

package/src/viewers/TransactionValidation.ts

@@ -0,0 +1,35 @@
+import { type Promisable } from '@xylabs/sdk-js'
+import { zodIsFactory } from '@xylabs/zod'
+import { type HydratedTransaction, type ValidationError } from '@xyo-network/xl1-protocol'
+import type z from 'zod'
+
+import {
+  ChainQualificationZod, ChainQualifiedConfigZod, type Provider,
+} from '../model/index.ts'
+
+export const TransactionValidationQualificationZod = ChainQualificationZod
+export type TransactionValidationQualification = z.infer<typeof TransactionValidationQualificationZod>
+export const isTransactionValidationQualification = zodIsFactory(TransactionValidationQualificationZod)
+
+export const TransactionValidationConfigZod = ChainQualifiedConfigZod
+export type TransactionValidationConfig = z.infer<typeof TransactionValidationConfigZod>
+export const isTransactionValidationConfig = zodIsFactory(TransactionValidationConfigZod)
+
+export interface TransactionValidationViewerMethods {
+  qualifiedValidateTransactions(
+    transactions: HydratedTransaction[],
+    config?: TransactionValidationConfig
+  ): Promisable<[ValidationError[][], TransactionValidationQualification]>
+}
+
+export const TransactionValidationViewerMoniker = 'TransactionValidationViewer' as const
+export type TransactionValidationViewerMoniker = typeof TransactionValidationViewerMoniker
+
+export interface TransactionValidationViewer extends TransactionValidationViewerMethods, Provider<TransactionValidationViewerMoniker> {
+  qualifiedValidateTransaction(
+    transaction: HydratedTransaction,
+    config?: TransactionValidationConfig
+  ): Promisable<[ValidationError[], TransactionValidationQualification]>
+  validateTransaction(transaction: HydratedTransaction[], config?: TransactionValidationConfig): Promisable<ValidationError[]>
+  validateTransactions(transactions: HydratedTransaction[], config?: TransactionValidationConfig): Promisable<ValidationError[][]>
+}

package/src/viewers/index.ts

@@ -1,7 +1,7 @@
 export * from './AccountBalance.ts'
 export * from './Block.ts'
 export * from './BlockReward.ts'
-export * from './Chain.ts'
+export * from './BlockValidation.ts'
 export * from './ChainContract.ts'
 export * from './ChainStakeViewer.ts'
 export * from './Fork.ts'
@@ -14,4 +14,5 @@ export * from './StepStake.ts'
 export * from './StepViewer.ts'
 export * from './TimeSync.ts'
 export * from './Transaction.ts'
+export * from './TransactionValidation.ts'
 export * from './TransferBalance.ts'

package/dist/neutral/model/Qualified.d.ts

@@ -1,6 +0,0 @@
-import { type Hash } from '@xylabs/sdk-js';
-import { type XL1BlockRange } from '@xyo-network/xl1-protocol';
-import z from 'zod';
-export type Qualified<T> = [T, XL1BlockRange, Hash];
-export declare const QualifiedZod: <T>(zodType: z.ZodType<T>) => z.ZodTuple<[z.ZodType<T, unknown, z.z.core.$ZodTypeInternals<T, unknown>>, z.ZodTuple<[z.ZodPipe<z.ZodNumber, z.ZodTransform<import("@xyo-network/xl1-protocol").XL1BlockNumber, number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import("@xyo-network/xl1-protocol").XL1BlockNumber, number>>], null>, z.ZodPipe<z.ZodString, z.ZodTransform<Hash, string>>], null>;
-//# sourceMappingURL=Qualified.d.ts.map

package/dist/neutral/model/Qualified.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Qualified.d.ts","sourceRoot":"","sources":["../../../src/model/Qualified.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAW,MAAM,gBAAgB,CAAA;AACnD,OAAO,EAAE,KAAK,aAAa,EAAoB,MAAM,2BAA2B,CAAA;AAChF,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAA;AAEnD,eAAO,MAAM,YAAY,GAAI,CAAC,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,wWAEpD,CAAA"}

package/dist/neutral/simple/chain/SimpleChainViewer.d.ts

@@ -1,15 +0,0 @@
-import { type Address, Promisable } from '@xylabs/sdk-js';
-import { ChainId } from '@xyo-network/xl1-protocol';
-import { AbstractCreatableProvider, CreatableProviderParams } from '../../CreatableProvider/index.ts';
-import { ChainViewer } from '../../viewers/index.ts';
-export interface SimpleChainParams extends CreatableProviderParams {
-    chainId: Address;
-}
-export declare class SimpleChainViewer extends AbstractCreatableProvider<SimpleChainParams> implements ChainViewer {
-    static readonly defaultMoniker: "ChainViewer";
-    static readonly monikers: "ChainViewer"[];
-    moniker: "ChainViewer";
-    static paramsHandler(params?: Partial<SimpleChainParams>): Promise<SimpleChainParams>;
-    chainId(): Promisable<ChainId>;
-}
-//# sourceMappingURL=SimpleChainViewer.d.ts.map

package/dist/neutral/simple/chain/SimpleChainViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SimpleChainViewer.d.ts","sourceRoot":"","sources":["../../../../src/simple/chain/SimpleChainViewer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EAAS,UAAU,EAChC,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAEnD,OAAO,EACL,yBAAyB,EAAqB,uBAAuB,EACtE,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,WAAW,EAAsB,MAAM,wBAAwB,CAAA;AAExE,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,qBACa,iBAAkB,SAAQ,yBAAyB,CAAC,iBAAiB,CAAE,YAAW,WAAW;IACxG,MAAM,CAAC,QAAQ,CAAC,cAAc,gBAAqB;IACnD,MAAM,CAAC,QAAQ,CAAC,QAAQ,kBAAuB;IAC/C,OAAO,gBAAmC;WAEpB,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAIvE,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC;CAG/B"}

package/dist/neutral/simple/chain/index.d.ts

@@ -1,2 +0,0 @@
-export * from './SimpleChainViewer.ts';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/simple/chain/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/simple/chain/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}

package/dist/neutral/simple/chainStake/SimpleChainStakeViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SimpleChainStakeViewer.d.ts","sourceRoot":"","sources":["../../../../src/simple/chainStake/SimpleChainStakeViewer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACb,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EACL,yBAAyB,EAAqB,uBAAuB,EACtE,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EACL,iBAAiB,EAAE,WAAW,EAC/B,MAAM,wBAAwB,CAAA;AAG/B,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACrE,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,UAAU,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB;AAED,qBACa,sBAAuB,SAAQ,yBAAyB,CAAC,sBAAsB,CAAE,YAAW,WAAW;IAClH,MAAM,CAAC,QAAQ,CAAC,cAAc,gBAAqB;IACnD,MAAM,CAAC,QAAQ,CAAC,QAAQ,kBAAuB;IAC/C,OAAO,gBAAwC;IAE/C,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,uBAAuB,CAA+B;IAE9D,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,QAAQ,eAEX;IAED,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED,IAAI,eAAe,IAAI,OAAO,CAE7B;IAED,IAAI,WAAW,sBAEd;IAED,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED,SAAS,KAAK,SAAS,eAEtB;IAED,MAAM,IAAI,MAAM;IAUhB,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM;IAU9C,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM;IAUvC,OAAO,IAAI,MAAM;IAUjB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM;IAUxC,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ;IAI/B,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ;IAItD,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,GAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAkB,GAAG,QAAQ,EAAE;IAKjG,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,GAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAkB,GAAG,QAAQ,EAAE;IAKjG,SAAS,IAAI,MAAM;IAUnB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM;cAUjB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAKvD"}

package/dist/neutral/simple/chainStakeEvents/SimpleChainStakeEventsViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SimpleChainStakeEventsViewer.d.ts","sourceRoot":"","sources":["../../../../src/simple/chainStakeEvents/SimpleChainStakeEventsViewer.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,yBAAyB,EAAqB,uBAAuB,EACtE,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/C,OAAO,EACL,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAE,iBAAiB,EAEhE,MAAM,wBAAwB,CAAA;AAE/B,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB;AAED,qBACa,4BAA6B,SAAQ,yBAAyB,CAAC,4BAA4B,CAAE,YAAW,iBAAiB;IACpI,MAAM,CAAC,QAAQ,CAAC,cAAc,sBAA2B;IACzD,MAAM,CAAC,QAAQ,CAAC,QAAQ,wBAA6B;IACrD,OAAO,sBAA8C;IAErD,SAAS,KAAK,SAAS,eAEtB;IAED,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAG,MAAM;IAIzD,WAAW,CAAC,KAAK,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,GAAE,gBAAgB,CAAC,KAAK,CAAM,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE;cASjH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAItD,OAAO,CAAC,mBAAmB;IAyC3B,OAAO,CAAC,kBAAkB;CAQ3B"}