@xyo-network/xl1-protocol 1.3.8 → 1.3.9

package/src/Addressable.ts

@@ -0,0 +1,6 @@
+import type { Address } from '@xylabs/hex'
+
+// NOTE: Minimal interface in case of reuse across validators, producers, wallets, modules, etc.
+export interface Addressable {
+  address: Address
+}

package/src/ChainIterator.ts

@@ -0,0 +1,29 @@
+import type { BaseParams } from '@xylabs/base'
+import type { Hash } from '@xylabs/hex'
+import type { ArchivistInstance } from '@xyo-network/archivist-model'
+import type { BaseEmitter } from '@xyo-network/module-event-emitter'
+
+import type { ChainIteratorEventData } from './ChainIteratorEventData.ts'
+import type { BlockBoundWitness } from './protocol/index.ts'
+import type { IterableRepository, ReadRepository } from './repository/index.ts'
+import type { BaseServiceParams, ChainIdentification } from './services/index.ts'
+
+export interface ChainIterator<TKey, THead> extends ReadRepository<TKey, BlockBoundWitness>, IterableRepository<TKey, BlockBoundWitness> {
+  chainIdentification: ChainIdentification
+  head(): Promise<THead>
+  previous(cursor?: TKey | undefined, limit?: number): Promise<BlockBoundWitness[]>
+  updateHead(head: THead): Promise<void>
+}
+
+export interface EventingChainIterator<TKey, THead> extends ChainIterator<TKey, THead>, BaseEmitter<BaseParams, ChainIteratorEventData> {}
+
+export interface ChainBlockNumberIterator extends ChainIterator<number, BlockBoundWitness> {}
+export interface EventingChainBlockNumberIterator extends EventingChainIterator<number, BlockBoundWitness> {}
+
+export interface ChainHashIterator extends ChainIterator<Hash, Hash> {}
+export interface EventingChainHashIterator extends EventingChainIterator<Hash, Hash> {}
+
+export interface XyoChainIteratorParams extends BaseServiceParams {
+  chainArchivist: ArchivistInstance
+  head: BlockBoundWitness
+}

package/src/ChainIteratorEventData.ts

@@ -0,0 +1,11 @@
+import type { EventData } from '@xyo-network/module-events'
+
+import type { BlockBoundWitness } from './protocol/index.ts'
+
+export type HeadEventArgs = { blocks: [BlockBoundWitness] }
+
+export interface HeadEventData extends EventData {
+  headUpdated: HeadEventArgs
+}
+
+export interface ChainIteratorEventData extends HeadEventData {}

package/src/OpenTelemetryProviders.ts

@@ -0,0 +1,6 @@
+import type { MeterProvider, TracerProvider } from '@opentelemetry/api'
+
+export interface OpenTelemetryProviders {
+  meterProvider?: MeterProvider
+  traceProvider?: TracerProvider
+}

package/src/chain/ChainServiceCollection.ts

@@ -0,0 +1,41 @@
+import type { ArchivistInstance, WriteArchivist } from '@xyo-network/archivist-model'
+import type { WalletInstance } from '@xyo-network/wallet-model'
+
+import type { EventingChainBlockNumberIterator } from '../ChainIterator.ts'
+import type {
+  AccountBalanceService, BlockProducer,
+  BlockRewardService, ChainContractViewer, ChainInformation, ChainStaker, ChainStakeViewer, ElectionService,
+  StakeIntentService,
+} from '../services/index.ts'
+
+export interface ChainServiceCollection {
+
+  account: WalletInstance
+  /**
+   * Services for working with account balances
+   */
+  balanceService: AccountBalanceService
+  /**
+   * The archivist which the chain data is stored in
+   */
+  chainArchivist: ArchivistInstance
+  chainContractViewer: ChainContractViewer
+  /**
+   * Hydrated information about the chain
+   */
+  chainInformation: ChainInformation
+  /**
+   * The chain iterator
+   */
+  chainIterator?: EventingChainBlockNumberIterator
+  chainStakeViewer: ChainStakeViewer
+  chainStaker: ChainStaker
+  chainSubmissionsArchivistWrite: WriteArchivist
+  electionService: ElectionService
+  producer: BlockProducer
+  rewardService: BlockRewardService
+  /**
+   * Services for working with staked intents
+   */
+  stakeIntentService: StakeIntentService
+}

package/src/chain/Initializable.ts

@@ -0,0 +1,3 @@
+import type { Promisable } from '@xylabs/promise'
+
+export type Initializable<T, R> = (params: T) => Promisable<R>

package/src/chain/index.ts

@@ -0,0 +1,2 @@
+export * from './ChainServiceCollection.ts'
+export * from './Initializable.ts'

package/src/ethereum.ts

@@ -0,0 +1,26 @@
+import { getAddress } from '@ethersproject/address'
+import type { Hex } from '@xylabs/hex'
+import { toHex } from '@xylabs/hex'
+import type { AccountInstance } from '@xyo-network/account-model'
+import { parseUnits } from 'ethers/utils'
+
+export interface GasConfig {
+  gasLimit?: number
+  gasPrice?: bigint
+}
+
+export const getDefaultGasConfig = (): GasConfig => {
+  return {
+    gasLimit: 2_000_000, // Set the gas limit
+    gasPrice: parseUnits('100', 'gwei'),
+  }
+}
+
+export type EthAddress = Hex
+
+export const ETH_ZERO_ADDRESS: EthAddress = '0x0000000000000000000000000000000000000000' as const
+
+export const toEthAddress = (value: bigint | string | AccountInstance): EthAddress => {
+  const address = (typeof value === 'object') ? value.address : value
+  return getAddress(toHex(address, { prefix: true, bitLength: 160 })) as EthAddress
+}

package/src/index.ts

@@ -1 +1,13 @@
-export * from './transaction/index.ts'
+export * from './Addressable.ts'
+export * from './chain/index.ts'
+export * from './ChainIterator.ts'
+export * from './ChainIteratorEventData.ts'
+export * from './ethereum.ts'
+export * from './instances/index.ts'
+export * from './OpenTelemetryProviders.ts'
+export * from './payload/index.ts'
+export * from './protocol/index.ts'
+export * from './provider/index.ts'
+export * from './repository/index.ts'
+export * from './services/index.ts'
+export * from './validation/index.ts'

package/src/instances/BoundWitness.ts

@@ -0,0 +1,13 @@
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import type { Payload } from '@xyo-network/payload-model'
+
+import type { PayloadInstance } from './Payload.ts'
+
+export interface BoundWitnessInstance<TBoundWitness extends BoundWitness = BoundWitness,
+  TPayload extends Payload = Payload> extends PayloadInstance<TBoundWitness> {
+
+  payloadCount: number
+  payloads: PayloadInstance<TPayload>[]
+
+  payload(index: number): PayloadInstance<TPayload> | undefined
+}

package/src/instances/Data.ts

@@ -0,0 +1,3 @@
+export interface DataInstance<T> {
+  data: T
+}

package/src/instances/Fees.ts

@@ -0,0 +1,8 @@
+import type { ValidatableInstance } from './modifiers/Validatable.ts'
+
+export interface TransactionFeesInstance extends ValidatableInstance {
+  base: bigint
+  gasLimit: bigint
+  gasPrice: bigint
+  priority: bigint
+}

package/src/instances/HydratedBoundWitness.ts

@@ -0,0 +1,15 @@
+import type { HydratedBoundWitness } from '@xyo-network/archivist-model'
+
+import type { DataInstance } from './Data.ts'
+import type { ValidatableInstance } from './modifiers/Validatable.ts'
+
+export interface HydratedBoundWitnessInstance<T extends HydratedBoundWitness = HydratedBoundWitness>
+  extends ValidatableInstance, DataInstance<T> {
+
+  boundWitness: T[0]
+
+  payloadCount: number
+  payloads: T[1][number][]
+
+  payload(index: number): T[1][number] | undefined
+}

package/src/instances/Object.ts

@@ -0,0 +1,5 @@
+import type { EmptyObject } from '@xylabs/object'
+
+import type { DataInstance } from './Data.ts'
+
+export interface ObjectInstance<T extends EmptyObject = EmptyObject> extends DataInstance<T> {}

package/src/instances/Payload.ts

@@ -0,0 +1,6 @@
+import type { Payload } from '@xyo-network/payload-model'
+
+import type { ValidatableInstance } from './modifiers/Validatable.ts'
+import type { ObjectInstance } from './Object.ts'
+
+export interface PayloadInstance<TPayload extends Payload = Payload> extends ObjectInstance<TPayload>, ValidatableInstance {}

package/src/instances/Signature.ts

@@ -0,0 +1,11 @@
+import type {
+  Address, Hash, Hex,
+} from '@xylabs/hex'
+
+import type { ValidatableInstance } from './modifiers/Validatable.ts'
+
+export interface SignatureInstance extends ValidatableInstance {
+  address: Address
+  hash: Hash
+  signature: Hex
+}

package/src/instances/block/BlockFields.ts

@@ -0,0 +1,13 @@
+export interface BlockFieldsInstance<TTransactionResult> {
+  privatePayloadCount: number
+
+  publicPayloadCount: number
+
+  reward: bigint
+
+  transactionCount: number
+
+  transactions: TTransactionResult[]
+
+  transaction(index: number): TTransactionResult | undefined
+}

package/src/instances/block/HydratedBlock.ts

@@ -0,0 +1,9 @@
+import type { HydratedBlock } from '../../protocol/index.ts'
+import type { HydratedBoundWitnessInstance } from '../HydratedBoundWitness.ts'
+import type { HydratedTransactionInstance } from '../transaction/index.ts'
+import type { BlockFieldsInstance } from './BlockFields.ts'
+
+export interface HydratedBlockInstance<T extends HydratedBlock = HydratedBlock> extends
+  BlockFieldsInstance<HydratedTransactionInstance>, HydratedBoundWitnessInstance<T> {
+  publicPayloads: T[1][number][]
+}

package/src/instances/block/SignedHydratedBlock.ts

@@ -0,0 +1,5 @@
+import type { SignedHydratedBlock } from '../../protocol/index.ts'
+import type { SignedInstance } from '../modifiers/Signed.ts'
+import type { HydratedBlockInstance } from './HydratedBlock.ts'
+
+export interface SignedHydratedBlockInstance<T extends SignedHydratedBlock = SignedHydratedBlock> extends HydratedBlockInstance<T>, SignedInstance {}

package/src/instances/block/index.ts

@@ -0,0 +1,2 @@
+export * from './HydratedBlock.ts'
+export * from './SignedHydratedBlock.ts'

package/src/instances/index.ts

@@ -0,0 +1,9 @@
+export * from './block/index.ts'
+export * from './BoundWitness.ts'
+export * from './Data.ts'
+export * from './Fees.ts'
+export * from './modifiers/index.ts'
+export * from './Object.ts'
+export * from './Payload.ts'
+export * from './Signature.ts'
+export * from './transaction/index.ts'

package/src/instances/modifiers/Signed.ts

@@ -0,0 +1,8 @@
+import type { SignatureInstance } from '../Signature.ts'
+
+export interface SignedInstance {
+  signatureCount: number
+  signatures: SignatureInstance[]
+
+  signature(index: number): SignatureInstance | undefined
+}

package/src/instances/modifiers/Validatable.ts

@@ -0,0 +1,5 @@
+import type { Promisable } from '@xylabs/promise'
+
+export interface ValidatableInstance {
+  validate(): Promisable<Error[]>
+}

package/src/instances/modifiers/index.ts

@@ -0,0 +1,2 @@
+export * from './Signed.ts'
+export * from './Validatable.ts'

package/src/instances/transaction/HydratedTransaction.ts

@@ -0,0 +1,8 @@
+import type { AllowedBlockPayload, HydratedTransaction } from '../../protocol/index.ts'
+import type { HydratedBoundWitnessInstance } from '../HydratedBoundWitness.ts'
+import type { TransactionFieldsInstance } from './TransactionFields.ts'
+
+export interface HydratedTransactionInstance<T extends HydratedTransaction = HydratedTransaction,
+  TElevatedPayload extends AllowedBlockPayload = AllowedBlockPayload>
+  extends TransactionFieldsInstance<T[1][number] & TElevatedPayload>, HydratedBoundWitnessInstance<T> {
+}

package/src/instances/transaction/SignedHydratedTransaction.ts

@@ -0,0 +1,7 @@
+import type { AllowedBlockPayload, HydratedTransaction } from '../../protocol/index.ts'
+import type { SignedInstance } from '../modifiers/Signed.ts'
+import type { HydratedTransactionInstance } from './HydratedTransaction.ts'
+
+export interface SignedHydratedTransactionInstance<T extends HydratedTransaction = HydratedTransaction,
+  TBlockPayload extends AllowedBlockPayload = AllowedBlockPayload> extends HydratedTransactionInstance<T, TBlockPayload>, SignedInstance {
+}

package/src/instances/transaction/TransactionFields.ts

@@ -0,0 +1,12 @@
+import type { AllowedBlockPayload } from '../../protocol/index.ts'
+import type { TransactionFeesInstance } from '../Fees.ts'
+
+export interface TransactionFieldsInstance<TBlockPayload extends AllowedBlockPayload = AllowedBlockPayload> {
+
+  elevatedPayloadCount: number
+  elevatedPayloads: TBlockPayload[]
+
+  fees: TransactionFeesInstance
+
+  elevatedPayload(index: number): TBlockPayload | undefined
+}

package/src/instances/transaction/index.ts

@@ -0,0 +1,2 @@
+export * from './HydratedTransaction.ts'
+export * from './SignedHydratedTransaction.ts'

package/src/payload/elevatable/ChainStakeIntent.ts

@@ -0,0 +1,32 @@
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import type { BlockDuration } from '../../protocol/BlockDuration.ts'
+import type { FromFields } from './Executable.ts'
+
+export const ChainStakeIntentSchema = 'network.xyo.chain.stake.intent' as const
+export type ChainStakeIntentSchema = typeof ChainStakeIntentSchema
+
+export type Intent = 'producer' // | 'bank'
+
+export interface ChainStakeIntentFields extends BlockDuration, FromFields {
+  /*
+  * The intent of the staking
+  */
+  intent: Intent
+}
+
+export type ChainStakeIntent = Payload<ChainStakeIntentFields, ChainStakeIntentSchema>
+
+export const isChainStakeIntent = (x?: unknown | null): x is ChainStakeIntent => {
+  return isPayloadOfSchemaType<ChainStakeIntent>(ChainStakeIntentSchema)(x)
+    && asNonNegativeInteger(x.nbf) !== undefined
+    && asNonNegativeInteger(x.exp) !== undefined
+}
+export const asChainStakeIntent = AsObjectFactory.create(isChainStakeIntent)
+export const asOptionalChainStakeIntent = AsObjectFactory.createOptional(isChainStakeIntent)
+
+const asNonNegativeInteger = (num: number) => {
+  return (Number.isInteger(num) && num >= 0) ? num : undefined
+}

package/src/payload/elevatable/Executable.ts

@@ -0,0 +1,29 @@
+import type { Address } from '@xylabs/hex'
+import type { EmptyObject } from '@xylabs/object'
+import { isAnyPayload } from '@xyo-network/payload-model'
+
+export interface FromFields {
+  // the address that is treated as the source of this action
+  from: Address
+}
+
+export const hasFrom = (value: unknown): value is FromFields => {
+  return (value as FromFields).from !== undefined
+}
+
+export interface ExecutableFields {
+  script: string[]
+}
+
+export type Executable<T extends EmptyObject = EmptyObject> = T & ExecutableFields
+export type OptionalExecutable<T extends EmptyObject = EmptyObject> = T & Partial<ExecutableFields>
+
+export const isExecutable = <T extends EmptyObject>(value: T | undefined): value is Executable<T> => {
+  return isAnyPayload(value) && Array.isArray((value as unknown as ExecutableFields).script)
+}
+
+export const asExecutable = <T extends EmptyObject>(value: T | undefined): Executable<T> | undefined => {
+  return isExecutable(value)
+    ? value as unknown as Executable<T>
+    : undefined
+}

package/src/payload/elevatable/Hash.ts

@@ -0,0 +1,19 @@
+import type { Hash } from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+export const HashSchema = 'network.xyo.hash' as const
+export type HashSchema = typeof HashSchema
+
+export interface HashFields {
+  hash: Hash
+}
+
+export type HashPayload = Payload<HashFields, HashSchema>
+
+export const isHashPayload = isPayloadOfSchemaType<HashPayload>(HashSchema)
+
+export const asHashPayload = AsObjectFactory.create(isHashPayload)
+export const asHashPayloadWithStorageMeta = AsObjectFactory.create(isHashPayload)
+export const asOptionalHashPayload = AsObjectFactory.createOptional(isHashPayload)

package/src/payload/elevatable/TransferPayload.ts

@@ -0,0 +1,26 @@
+import type {
+  Address,
+  Hex,
+} from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import type { FromFields } from './Executable.ts'
+
+export const TransferSchema = 'network.xyo.transfer' as const
+export type TransferSchema = typeof TransferSchema
+
+export interface TransferFields extends FromFields {
+  epoch: number
+  // the amount that is being sent to another address
+  transfers: Record<Address, Hex>
+}
+
+// if this payload is included in a boundwitness, it needs to be available for inspection to be included in block
+export type Transfer = Payload<TransferFields, TransferSchema>
+
+export const isTransfer = isPayloadOfSchemaType<Transfer>(TransferSchema)
+
+export const asTransfer = AsObjectFactory.create(isTransfer)
+export const asOptionalTransfer = AsObjectFactory.createOptional(isTransfer)

package/src/payload/elevatable/index.ts

@@ -0,0 +1,4 @@
+export * from './ChainStakeIntent.ts'
+export * from './Executable.ts'
+export * from './Hash.ts'
+export * from './TransferPayload.ts'

package/src/payload/index.ts

@@ -0,0 +1 @@
+export * from './elevatable/index.ts'

package/src/protocol/AllowedBlockPayload.ts

@@ -0,0 +1,29 @@
+import { BoundWitnessSchema } from '@xyo-network/boundwitness-model'
+import type { Schema, WithStorageMeta } from '@xyo-network/payload-model'
+import { isHashStorageMeta, isSchema } from '@xyo-network/payload-model'
+import type { SchemaPayload } from '@xyo-network/schema-payload-plugin'
+import { isSchemaPayload, SchemaSchema } from '@xyo-network/schema-payload-plugin'
+
+import type {
+  ChainStakeIntent, HashPayload, Transfer,
+} from '../payload/index.ts'
+import {
+  ChainStakeIntentSchema, HashSchema, isChainStakeIntent, isHashPayload, isTransfer, TransferSchema,
+} from '../payload/index.ts'
+import { isTransactionBoundWitness, type TransactionBoundWitness } from './TransactionBoundWitness.ts'
+
+export type AllowedBlockPayload = Transfer | ChainStakeIntent | SchemaPayload | TransactionBoundWitness | HashPayload
+export const AllowedBlockPayloadSchemas: Schema[] = [TransferSchema, ChainStakeIntentSchema, SchemaSchema, BoundWitnessSchema, HashSchema]
+export type AllowedBlockPayloadSchema = typeof AllowedBlockPayloadSchemas[number]
+
+export const isAllowedBlockPayloadSchema = (value: unknown): value is AllowedBlockPayloadSchema => {
+  return isSchema(value) && AllowedBlockPayloadSchemas.includes(value)
+}
+
+export const isAllowedBlockPayload = (value: unknown): value is AllowedBlockPayload => {
+  return isTransfer(value) || isChainStakeIntent(value) || isSchemaPayload(value) || isTransactionBoundWitness(value) || isHashPayload(value)
+}
+
+export const isAllowedBlockPayloadWithHashStorageMeta = (value: unknown): value is WithStorageMeta<AllowedBlockPayload> => {
+  return isAllowedBlockPayload(value) && isHashStorageMeta(value)
+}

package/src/protocol/BlockBoundWitness.ts

@@ -0,0 +1,47 @@
+import type {
+  Address, Hash, Hex,
+} from '@xylabs/hex'
+import { isHex } from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import { isBoundWitness } from '@xyo-network/boundwitness-model'
+import type { WithStorageMeta } from '@xyo-network/payload-model'
+import { isStorageMeta } from '@xyo-network/payload-model'
+
+export interface BlockBoundWitnessMeta {
+  $epoch: number
+}
+
+export interface BlockBoundWitnessFields {
+  /** Updated balance of address whose balance were changed by this block */
+  balances: Record<Address, Hex>
+  /** Block number */
+  block: number
+  /** Chain id - this should be "0" for the genesis block */
+  chain: Hex
+  /** Previous block hash if not block 0 */
+  previous: Hash | null /* the previous block hash */
+  /** Version of the protocol being used major * 1,000,000 + minor * 1,000 + patch */
+  protocol: number
+  /** Step hashes */
+  step_hashes: Hex[]
+}
+
+export type BlockBoundWitness = BoundWitness<BlockBoundWitnessFields & BlockBoundWitnessMeta>
+
+export const isBlockBoundWitness = (value: unknown): value is BlockBoundWitness => {
+  const typedObj = value as BlockBoundWitness
+  return isBoundWitness(value)
+    && Number.isInteger(typedObj.block)
+    && isHex(typedObj.chain)
+}
+
+export const isBlockBoundWitnessWithStorageMeta = (value: unknown): value is WithStorageMeta<BlockBoundWitness> => {
+  return isBlockBoundWitness(value) && isStorageMeta(value)
+}
+
+export const asBlockBoundWitness = AsObjectFactory.create(isBlockBoundWitness)
+export const asOptionalBlockBoundWitness = AsObjectFactory.createOptional(isBlockBoundWitness)
+
+export const asBlockBoundWitnessWithStorageMeta = AsObjectFactory.create(isBlockBoundWitnessWithStorageMeta)
+export const asOptionalBlockBoundWitnessWithStorageMeta = AsObjectFactory.createOptional(isBlockBoundWitnessWithStorageMeta)

package/src/protocol/BlockDuration.ts

@@ -0,0 +1,23 @@
+export interface BlockStart {
+  /**
+   * The block at which the duration starts
+   */
+  nbf: number
+}
+
+export interface BlockEnd {
+  /**
+   * The block at which the duration ends
+   */
+  exp: number
+}
+
+/**
+ * A optional duration referenced to block numbers
+ */
+export interface OptionalBlockDuration extends Partial<BlockStart>, Partial<BlockEnd> {}
+
+/**
+ * A duration referenced to block numbers
+ */
+export interface BlockDuration extends BlockStart, BlockEnd {}

package/src/protocol/BlockNumber.ts

@@ -0,0 +1,39 @@
+import type { Hex } from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload, WithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+export const BlockNumberSchema = 'network.xyo.chain.block.number' as const
+export type BlockNumberSchema = typeof BlockNumberSchema
+
+export interface BlockNumberFields {
+  /**
+   * The block number
+   */
+  block: Hex
+  /**
+   * The chain id
+   */
+  chain?: Hex
+}
+/**
+ * The number of a block
+ */
+export type BlockNumber = Payload<BlockNumberFields, BlockNumberSchema>
+
+/**
+ * Identity function for determining if an object is a BlockNumber
+ */
+export const isBlockNumber = isPayloadOfSchemaType<BlockNumber>(BlockNumberSchema)
+export const asBlockNumber = AsObjectFactory.create<BlockNumber>(isBlockNumber)
+export const asOptionalBlockNumber = AsObjectFactory.createOptional<BlockNumber>(isBlockNumber)
+
+/**
+ * Identity function for determining if an object is a BlockNumber with sources
+ */
+export const isBlockNumberWithSources = isPayloadOfSchemaTypeWithSources<BlockNumber>(BlockNumberSchema)
+export const asBlockNumberWithSources = AsObjectFactory.create<WithSources<BlockNumber>>(isBlockNumberWithSources)
+export const asOptionalBlockNumberWithSources = AsObjectFactory.createOptional<WithSources<BlockNumber>>(isBlockNumberWithSources)

package/src/protocol/ChainAnalyzer.ts

@@ -0,0 +1,10 @@
+import type { Promisable } from '@xylabs/promise'
+import type { Payload } from '@xyo-network/payload-model'
+
+import type { HydratedBlock } from './HydratedBlock.ts'
+
+export interface ChainAnalyzer<T extends Payload = Payload> {
+  onBlock(block: HydratedBlock): Promisable<boolean>
+  result(): T
+  shouldContinue(): boolean
+}

package/src/protocol/ChainReference.ts

@@ -0,0 +1,11 @@
+import type { Address } from '@xylabs/hex'
+
+/**
+ * Required info for a chain reference
+ */
+export interface ChainReference {
+  /**
+   * The contract address referenced by the chain
+   */
+  chain: Address
+}

package/src/protocol/HydratedBlock.ts

@@ -0,0 +1,8 @@
+import type { Signed } from '@xyo-network/boundwitness-model'
+import type { Payload, WithStorageMeta } from '@xyo-network/payload-model'
+
+import type { BlockBoundWitness } from './BlockBoundWitness.ts'
+
+export type HydratedBlock = [WithStorageMeta<BlockBoundWitness>, WithStorageMeta<Payload>[]]
+
+export type SignedHydratedBlock = [WithStorageMeta<Signed<BlockBoundWitness>>, WithStorageMeta<Payload>[]] & HydratedBlock