@xyo-network/xl1-protocol 1.3.8 → 1.3.9

package/src/protocol/HydratedTransaction.ts

@@ -0,0 +1,19 @@
+import type { Signed } from '@xyo-network/boundwitness-model'
+import type {
+  Payload, WithHashStorageMeta, WithStorageMeta,
+} from '@xyo-network/payload-model'
+
+import type { TransactionBoundWitness } from './TransactionBoundWitness.ts'
+
+export type HydratedTransaction<T extends TransactionBoundWitness = TransactionBoundWitness, P extends Payload = Payload> = [T, P[]]
+
+export type HydratedTransactionWithStorageMeta<T extends HydratedTransaction = HydratedTransaction>
+ = [WithStorageMeta<T[0]>, WithStorageMeta<T[1][number]>[]]
+
+export type HydratedTransactionWithHashStorageMeta<T extends HydratedTransaction = HydratedTransaction>
+ = [WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]]
+
+export type SignedHydratedTransaction<T extends HydratedTransaction = HydratedTransaction> = [Signed<T[0]>, T[1][number][]] & HydratedTransaction
+
+export type SignedHydratedTransactionWithStorageMeta<T extends HydratedTransaction = HydratedTransaction>
+ = [WithStorageMeta<Signed<T[0]>>, WithStorageMeta<T[1][number]>[]] & SignedHydratedTransaction<T> & HydratedTransaction

package/src/protocol/Issuer.ts

@@ -0,0 +1,5 @@
+import type { Address } from '@xylabs/hex'
+
+export interface Issuer {
+  issuer: Address
+}

package/src/protocol/Steps.ts

@@ -0,0 +1 @@
+export const Steps = [10, 105, 1103, 11_576, 121_551, 1_276_282, 13_400_956]

package/src/protocol/TransactionBoundWitness.ts

@@ -0,0 +1,51 @@
+import type { Address } from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { BoundWitness, Signed } 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'
+
+import type {
+  FromFields,
+  OptionalExecutable,
+} from '../payload/index.ts'
+import type { BlockDuration } from './BlockDuration.ts'
+import type { TransactionFeesFields } from './TransactionFeesFields.ts'
+
+export interface TransactionBoundWitnessFields extends BlockDuration, TransactionFeesFields {
+  chain: Address
+}
+
+export type TransactionBoundWitness = BoundWitness<TransactionBoundWitnessFields & OptionalExecutable & FromFields>
+
+export const isTransactionBoundWitness = (value: unknown): value is TransactionBoundWitness => {
+  const typedObj = value as TransactionBoundWitness
+  return isBoundWitness(value)
+    && typedObj.chain !== undefined
+    && typedObj.fees !== undefined
+    && typedObj.exp !== undefined
+    && typedObj.nbf !== undefined
+}
+
+export const isSignedTransactionBoundWitness = (value: unknown): value is Signed<TransactionBoundWitness> => {
+  return isTransactionBoundWitness(value) && isSigned(value)
+}
+
+export const isSigned = <T extends BoundWitness = BoundWitness>(value: unknown): value is Signed<T> =>
+  isBoundWitness(value)
+  && value.$signatures.length === value.addresses.length
+  && value.addresses.length > 0
+
+export const isTransactionBoundWitnessWithStorageMeta = (value: unknown): value is WithStorageMeta<TransactionBoundWitness> =>
+  isTransactionBoundWitness(value)
+  && isStorageMeta(value)
+
+export const isSignedTransactionBoundWitnessWithStorageMeta = (value: unknown): value is WithStorageMeta<Signed<TransactionBoundWitness>> =>
+  isSignedTransactionBoundWitness(value)
+  && isStorageMeta(value)
+
+export const asTransactionBoundWitness = AsObjectFactory.create(isTransactionBoundWitness)
+export const asOptionalTransactionBoundWitness = AsObjectFactory.createOptional(isTransactionBoundWitness)
+
+export const asTransactionBoundWitnessWithStorageMeta = AsObjectFactory.create(isTransactionBoundWitnessWithStorageMeta)
+export const asOptionalTransactionBoundWitnessWithStorageMeta = AsObjectFactory.createOptional(isTransactionBoundWitnessWithStorageMeta)

package/src/protocol/TransactionFeesFields.ts

@@ -0,0 +1,38 @@
+import type { Hex } from '@xylabs/hex'
+
+export interface TransactionFeesBigInt {
+  base: bigint // In mXL1
+  gasLimit: bigint // In mXL1
+  gasPrice: bigint // In mXL1
+  priority: bigint // In mXL1
+}
+
+export type TransactionFeesHex = {
+  [K in keyof TransactionFeesBigInt]: Hex;
+}
+
+export interface TransactionFeesFields {
+  fees: TransactionFeesHex
+}
+
+/** Gas Calculation
+ *
+ * 1 Million microXL1 (mXL1) = 1 XL1
+ *
+ * Gas amount is calculated as follows:
+ *
+ * 1. Each byte in the transaction cost 10 gas
+ * 2. Each payload validation in the transaction costs 1000 gas
+ * 3. Each signature verification in the transaction costs 1000 gas
+ * 4. Each hash validation in the transaction costs 100 gas
+ * 5. Each balance validation in the transaction costs 100 gas
+ * 6. Processing/Compute/Storage Cost?
+ * 7. operation Costs?
+ *
+ * The total gas cost is calculated by multiplying the gas amount by the gas price.
+ *
+ * minGasPrice is initially set to 100 mXL1
+ * minBase is initially set to 1000 mXL1
+ * minPriority is alway 0 mXL1, but can be set to increase the priority of the transaction
+ *
+ */

package/src/protocol/index.ts

@@ -0,0 +1,12 @@
+export * from './AllowedBlockPayload.ts'
+export * from './BlockBoundWitness.ts'
+export * from './BlockDuration.ts'
+export * from './BlockNumber.ts'
+export * from './ChainAnalyzer.ts'
+export * from './ChainReference.ts'
+export * from './HydratedBlock.ts'
+export * from './HydratedTransaction.ts'
+export * from './Issuer.ts'
+export * from './Steps.ts'
+export * from './TransactionBoundWitness.ts'
+export * from './TransactionFeesFields.ts'

package/src/provider/XyoProvider.ts

@@ -0,0 +1,29 @@
+import type { Address } from '@xylabs/hex'
+import type { Signed } from '@xyo-network/boundwitness-model'
+import type { Payload } from '@xyo-network/payload-model'
+
+import type {
+  AllowedBlockPayload, TransactionBoundWitness, TransactionFeesBigInt,
+} from '../protocol/index.ts'
+import type { XyoRunner } from './XyoRunner.ts'
+import type { XyoSigner } from './XyoSigner.ts'
+import type { XyoStorage } from './XyoStorage.ts'
+import type { XyoViewer } from './XyoViewer.ts'
+import type { XyoWallet } from './XyoWallet.ts'
+
+export interface XyoProvider {
+  runner?: XyoRunner
+  send?: (
+    elevatedPayloads: AllowedBlockPayload[],
+    additionalPayloads: Payload[],
+    chain?: Address,
+    nbf?: number,
+    exp?: number,
+    from?: Address,
+    fees?: TransactionFeesBigInt,
+  ) => Promise<Signed<TransactionBoundWitness>>
+  signer?: XyoSigner
+  storage?: XyoStorage
+  viewer?: XyoViewer
+  wallet?: XyoWallet
+}

package/src/provider/XyoRunner.ts

@@ -0,0 +1,8 @@
+import type { Hash } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { SignedHydratedTransaction } from '../protocol/index.ts'
+
+export interface XyoRunner {
+  broadcastTransaction(transaction: SignedHydratedTransaction): Promisable<Hash>
+}

package/src/provider/XyoSigner.ts

@@ -0,0 +1,21 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+import type { Signed } from '@xyo-network/boundwitness-model'
+import type { Payload } from '@xyo-network/payload-model'
+
+import type {
+  AllowedBlockPayload, TransactionBoundWitness, TransactionFeesBigInt,
+} from '../protocol/index.ts'
+
+export interface XyoSigner {
+  address(): Promisable<Address>
+  createSignedTransaction(
+    chain: Address,
+    elevatedPayloads: AllowedBlockPayload[],
+    additionalPayloads: Payload[],
+    nbf: number,
+    exp: number,
+    fees: TransactionFeesBigInt,
+    from?: Address,
+  ): Promisable<Signed<TransactionBoundWitness>>
+}

package/src/provider/XyoStorage.ts

@@ -0,0 +1,17 @@
+import type { Hash } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+import type { Payload } from '@xyo-network/payload-model'
+
+export interface XyoStorageHelpers {
+  addPayloads(data: Payload[]): Promisable<Hash[]>
+  getPayloads(hashes: Hash[]): Promisable<Payload[]>
+}
+
+export interface XyoStorageCalls {
+  add(data: ArrayBuffer[]): Promisable<Hash[]>
+  fetch(hashes: Hash[], maxDepth?: number): Promisable<ArrayBuffer[]>
+  get(hashes: Hash[]): Promisable<ArrayBuffer[]>
+  trace(hashes: Hash[]): Promisable<[ArrayBuffer, Payload[]][]>
+}
+
+export interface XyoStorage extends XyoStorageHelpers, XyoStorageCalls {}

package/src/provider/XyoViewer.ts

@@ -0,0 +1,18 @@
+import type { Address, Hash } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { SignedHydratedBlock, SignedHydratedTransaction } from '../protocol/index.ts'
+
+export interface XyoViewer {
+  accountBalance(address: Address, blockNumber: number, full: boolean): Promisable<bigint>
+  blockByHash(hash: Hash): Promisable<SignedHydratedBlock | null>
+  blockByNumber(blockNumber: number): Promisable<SignedHydratedBlock | null>
+  blocksByHash(hash: Hash, limit?: number): Promisable<SignedHydratedBlock[]>
+  chainId(): Promisable<Address>
+  currentBlock(): Promisable<SignedHydratedBlock>
+  currentBlockHash(): Promisable<Hash>
+  currentBlockNumber(): Promisable<number>
+  transactionByBlockHashAndIndex(blockHash: Hash, transactionIndex: number): Promisable<SignedHydratedTransaction | null>
+  transactionByBlockNumberAndIndex(blockNumber: number, transactionIndex: number): Promisable<SignedHydratedTransaction | null>
+  transactionByHash(transactionHash: Hash): Promisable<SignedHydratedTransaction | null>
+}

package/src/provider/XyoWallet.ts

@@ -0,0 +1,15 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+// TODO: define the permissions object and return object types
+
+export interface XyoWallet {
+  accounts(): Promisable<Address[]>
+  addChain(chain: Address, name?: string): Promisable<object>
+  chain(): Promisable<Address>
+  chains(): Promisable<object>
+  permissions(): Promisable<Record<string, object>>
+  requestPermissions(permissions: object): Promisable<object>
+  revokePermissions(permissions: object): Promisable<object>
+  switchChain(chain: Address): Promisable<void>
+}

package/src/provider/index.ts

@@ -0,0 +1,6 @@
+export * from './XyoProvider.ts'
+export * from './XyoRunner.ts'
+export * from './XyoSigner.ts'
+export * from './XyoStorage.ts'
+export * from './XyoViewer.ts'
+export * from './XyoWallet.ts'

package/src/repository/Repository.ts

@@ -0,0 +1,11 @@
+export interface ReadRepository<TId, TData> {
+  get(id: TId): Promise<TData | undefined>
+}
+
+export interface IterableRepository<TId, TData> {
+  next(id: TId): Promise<TData | undefined>
+}
+
+export interface WriteRepository<TData, TResp> {
+  insert(data: TData): Promise<TResp>
+}

package/src/repository/TransactionReadRepository.ts

@@ -0,0 +1,4 @@
+import type { HydratedTransaction, TransactionBoundWitness } from '../protocol/index.ts'
+import type { ReadRepository } from './Repository.ts'
+
+export interface TransactionReadRepository extends ReadRepository<TransactionBoundWitness, HydratedTransaction> {}

package/src/repository/TransactionRepository.ts

@@ -0,0 +1,9 @@
+import type { TransactionReadRepository } from './TransactionReadRepository.ts'
+import type { TransactionRepositoryIterator } from './TransactionRepositoryIterator.ts'
+import type { TransactionWriteRepository } from './TransactionWriteRepository.ts'
+
+export interface TransactionRepository extends TransactionReadRepository, TransactionWriteRepository {}
+
+export interface ReadonlyIterableTransactionRepository extends TransactionReadRepository, TransactionRepositoryIterator {}
+
+export interface IterableTransactionRepository extends TransactionRepository, TransactionRepositoryIterator {}

package/src/repository/TransactionRepositoryIterator.ts

@@ -0,0 +1,4 @@
+import type { HydratedTransaction, TransactionBoundWitness } from '../protocol/index.ts'
+import type { IterableRepository } from './Repository.ts'
+
+export interface TransactionRepositoryIterator extends IterableRepository<TransactionBoundWitness, HydratedTransaction> {}

package/src/repository/TransactionWriteRepository.ts

@@ -0,0 +1,4 @@
+import type { HydratedTransaction } from '../protocol/index.ts'
+import type { WriteRepository } from './Repository.ts'
+
+export interface TransactionWriteRepository extends WriteRepository<HydratedTransaction, boolean> {}

package/src/repository/index.ts

@@ -0,0 +1,5 @@
+export * from './Repository.ts'
+export * from './TransactionReadRepository.ts'
+export * from './TransactionRepository.ts'
+export * from './TransactionRepositoryIterator.ts'
+export * from './TransactionWriteRepository.ts'

package/src/services/AccountBalanceService.ts

@@ -0,0 +1,9 @@
+import type {
+  Address, Hash, Hex,
+} from '@xylabs/hex'
+
+export interface AccountBalanceService {
+  getBalance(address: Address): Hex
+  getBalances(): Record<Address, Hex>
+  sync(head: Hash): Promise<void>
+}

package/src/services/BlockProducer.ts

@@ -0,0 +1,7 @@
+import type { Addressable } from '../Addressable.ts'
+import type { BlockBoundWitness, HydratedBlock } from '../protocol/index.ts'
+import type { IterableRepository } from '../repository/index.ts'
+
+export type NextBlockProducer = IterableRepository<BlockBoundWitness, HydratedBlock>
+
+export interface BlockProducer extends Addressable, NextBlockProducer {}

package/src/services/BlockReward.ts

@@ -0,0 +1,7 @@
+import type { Promisable } from '@xylabs/promise'
+
+import type { Service } from './Service.ts'
+
+export interface BlockRewardService extends Service {
+  getRewardForBlock(block: bigint): Promisable<bigint>
+}

package/src/services/Chain/ChainContractViewer.ts

@@ -0,0 +1,12 @@
+import type { Address } from '@xylabs/hex'
+
+export interface ChainContractViewer {
+  active(): Promise<bigint>
+  chainId(): Promise<Address>
+  forkedAtBlockNumber(): Promise<bigint>
+  forkedAtHash(): Promise<bigint>
+  forkedChainId(): Promise<Address>
+  minWithdrawalBlocks(): Promise<bigint>
+  rewardsContract(): Promise<string>
+  stakingTokenAddress(): Promise<string>
+}

package/src/services/Chain/ChainIdentification.ts

@@ -0,0 +1,17 @@
+import type { Address } from '@xylabs/hex'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+export const ChainIdentificationPayloadSchema = 'network.xyo.chain.identification' as const
+export type ChainIdentificationPayloadSchema = typeof ChainIdentificationPayloadSchema
+
+/**
+ * Identification required to uniquely identify a chain
+ */
+export interface ChainIdentification {
+  /** @field the id of the chain */
+  id: Address
+}
+
+export type ChainIdentificationPayload = Payload<ChainIdentification, ChainIdentificationPayloadSchema>
+export const isChainIdentificationPayload = isPayloadOfSchemaType<ChainIdentificationPayload>(ChainIdentificationPayloadSchema)

package/src/services/Chain/ChainInformation.ts

@@ -0,0 +1,20 @@
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+export const ChainInformationPayloadSchema = 'network.xyo.chain.information' as const
+export type ChainInformationPayloadSchema = typeof ChainInformationPayloadSchema
+
+import type { ChainIdentification } from './ChainIdentification.ts'
+
+/**
+ * Information required to produce a chain
+ */
+export interface ChainInformation extends ChainIdentification {
+  // TODO: Add these fields which are currently promises on the smart contract
+  // forkedAtBlockNumber: bigint
+  // forkedAtHash: Hash
+  // forkedChainId: Address
+}
+
+export type ChainInformationPayload = Payload<ChainIdentification, ChainInformationPayloadSchema>
+export const isChainInformationPayload = isPayloadOfSchemaType<ChainInformationPayload>(ChainInformationPayloadSchema)

package/src/services/Chain/ChainService.ts

@@ -0,0 +1,7 @@
+import type { Service } from '../Service.ts'
+import type { ChainContractViewer } from './ChainContractViewer.ts'
+import type { ChainInformation } from './ChainInformation.ts'
+import type { ChainStaker } from './ChainStaker.ts'
+import type { ChainStakeViewer } from './ChainStakeViewer.ts'
+
+export interface ChainService extends ChainInformation, ChainContractViewer, ChainStakeViewer, ChainStaker, Service {}

package/src/services/Chain/ChainStakeViewer.ts

@@ -0,0 +1,10 @@
+import type { ChainContractViewer } from './ChainContractViewer.ts'
+
+export interface ChainStakeViewer extends ChainContractViewer {
+  activeByAddressStaked(address: string): Promise<bigint>
+  activeByStaker(address: string): Promise<bigint>
+  pending(): Promise<bigint>
+  pendingByStaker(staker: string): Promise<bigint>
+  withdrawn(): Promise<bigint>
+  withdrawnByStaker(staker: string): Promise<bigint>
+}

package/src/services/Chain/ChainStaker.ts

@@ -0,0 +1,5 @@
+export interface ChainStaker {
+  addStake(staked: string, amount: bigint): Promise<boolean>
+  removeStake(slot: bigint): Promise<boolean>
+  withdrawStake(slot: bigint): Promise<boolean>
+}

package/src/services/Chain/index.ts

@@ -0,0 +1,6 @@
+export * from './ChainContractViewer.ts'
+export * from './ChainIdentification.ts'
+export * from './ChainInformation.ts'
+export * from './ChainService.ts'
+export * from './ChainStaker.ts'
+export * from './ChainStakeViewer.ts'

package/src/services/Election.ts

@@ -0,0 +1,14 @@
+import type { Address } from '@xylabs/hex'
+
+import type { BlockBoundWitness } from '../protocol/index.ts'
+import type { Service } from './Service.ts'
+
+export interface ElectionService extends Service {
+
+  /**
+   * Given the current block, get the leader for the next block
+   * @param current The previous block
+   */
+  getCreatorCommitteeForNextBlock(current: BlockBoundWitness): Promise<Address[]>
+
+}

package/src/services/Params.ts

@@ -0,0 +1,11 @@
+import type { BaseParams } from '@xylabs/base'
+import type { EmptyObject } from '@xylabs/object'
+import type { AccountInstance } from '@xyo-network/account-model'
+
+import type { OpenTelemetryProviders } from '../OpenTelemetryProviders.ts'
+
+export type BaseServiceParams<TAdditionalParams extends EmptyObject = EmptyObject> = BaseParams<TAdditionalParams & OpenTelemetryProviders>
+
+export type BaseAccountableServiceParams = BaseServiceParams<{
+  account: AccountInstance
+}>

package/src/services/PendingTransactionsService.ts

@@ -0,0 +1,8 @@
+import type { Hash } from '@xylabs/hex'
+
+import type { HydratedTransaction } from '../protocol/index.ts'
+import type { Service } from './Service.ts'
+
+export interface PendingTransactionsService extends Service {
+  getPendingTransactions(head: Hash, limit: number, timeout?: number): Promise<HydratedTransaction[]>
+}

package/src/services/Service.ts

@@ -0,0 +1,10 @@
+import type { Meter, Tracer } from '@opentelemetry/api'
+import type { Logger } from '@xylabs/logger'
+
+export type ServiceName = Exclude<string, 'reserved-service-name-value'>
+
+export interface Service {
+  logger?: Logger
+  meter?: Meter
+  tracer?: Tracer
+}

package/src/services/index.ts

@@ -0,0 +1,9 @@
+export * from './AccountBalanceService.ts'
+export * from './BlockProducer.ts'
+export * from './BlockReward.ts'
+export * from './Chain/index.ts'
+export * from './Election.ts'
+export * from './Params.ts'
+export * from './PendingTransactionsService.ts'
+export * from './Service.ts'
+export * from './stakeIntent/index.ts'

package/src/services/stakeIntent/ChainIndexingServiceStateSchema.ts

@@ -0,0 +1,46 @@
+import type { Hash } from '@xylabs/hex'
+import type { JsonValue } from '@xylabs/object'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload, WithStorageMeta } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType, isStorageMeta } from '@xyo-network/payload-model'
+
+export interface ChainIndexingServiceStateFields<T extends JsonValue = JsonValue> {
+  /**
+   * The hash of the last block that this service has indexing
+   */
+  endBlockHash: Hash
+  /**
+   * The hash of the block that the service started indexing. If undefined, the service is
+   * assumed to have started indexing from the genesis block
+   */
+  startBlockHash?: Hash
+  /**
+   * The indexed state for the range
+   */
+  state: T
+}
+export const ChainIndexingServiceStateSchema = 'network.xyo.chain.indexing.service.state' as const
+export type ChainIndexingServiceStateSchema = typeof ChainIndexingServiceStateSchema
+
+/**
+ * The result of a ChainIndexingServiceState
+ */
+export type ChainIndexingServiceState<T extends JsonValue = JsonValue> = Payload<ChainIndexingServiceStateFields<T>, ChainIndexingServiceStateSchema>
+
+/**
+ * Identity functions for determining if an object is an ChainIndexingServiceState
+ */
+export const isChainIndexingServiceState = <T extends JsonValue = JsonValue>(payload?: unknown): payload is ChainIndexingServiceState<T> => {
+  return isPayloadOfSchemaType<ChainIndexingServiceState<T>>(ChainIndexingServiceStateSchema)(payload)
+}
+export const asChainIndexingServiceState = AsObjectFactory.create<ChainIndexingServiceState<JsonValue>>(isChainIndexingServiceState)
+
+export const isChainIndexingServiceStateWithStorageMeta
+= <T extends JsonValue = JsonValue>(value: unknown): value is WithStorageMeta<ChainIndexingServiceState<T>> =>
+  isChainIndexingServiceState<T>(value) && isStorageMeta(value)
+
+export const asChainIndexingServiceStateWithStorageMeta
+= AsObjectFactory.create<WithStorageMeta<ChainIndexingServiceState>>(isChainIndexingServiceStateWithStorageMeta)
+
+export const asOptionalChainIndexingServiceStateWithStorageMeta
+= AsObjectFactory.createOptional<WithStorageMeta<ChainIndexingServiceState>>(isChainIndexingServiceStateWithStorageMeta)

package/src/services/stakeIntent/StakeIntentService.ts

@@ -0,0 +1,28 @@
+import type { Address } from '@xylabs/hex'
+
+import type { Intent } from '../../payload/index.ts'
+
+export interface StakeIntentService {
+
+  /**
+   * Gets the declared ranges for an address based on historical on-chain data
+   * @param address The address to get the declared ranges for
+   * @param intent The declared intent to filter for
+   */
+  getDeclaredCandidateRanges(address: Address, intent: Intent): Promise<Readonly<Readonly<[number, number]>[]>>
+
+  /**
+   * Gets the declared candidates for a block based on historical on-chain data
+   * @param block The block number to get the declared candidates for
+   * @param intent The declared intent to filter for
+  */
+  getDeclaredCandidatesForBlock(block: number, intent: Intent): Promise<Address[]>
+
+  /**
+   * Checks if the address is staked for a block for a given intent
+   * @param block The block number to check
+   * @param intent The declared intent to filter for
+   * @param address The address to check
+   */
+  isStakedForBlock(block: number, intent: Intent, address: Address): Promise<boolean>
+}

package/src/services/stakeIntent/index.ts

@@ -0,0 +1,2 @@
+export * from './ChainIndexingServiceStateSchema.ts'
+export * from './StakeIntentService.ts'

package/src/validation/block/BlockValidationFunction.ts

@@ -0,0 +1,9 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { BlockBoundWitness } from '../../protocol/index.ts'
+
+export type BlockValidatorFunction = (
+  block: BlockBoundWitness,
+  chainId?: Address,
+) => Promisable<Error[]>

package/src/validation/block/HydratedBlockStateValidationFunction.ts

@@ -0,0 +1,18 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+import type { ReadArchivist } from '@xyo-network/archivist-model'
+
+import type { HydratedBlock } from '../../protocol/index.ts'
+
+/**
+ * A function that validates a hydrated block against chain state.
+ * @param hydratedBlock The hydrated block to validate.
+ * @param chainId The chain ID to use for validation.
+ * @param archivist The archivist to use for validation.
+ * @returns An array of errors if the block is invalid, or an empty array if it is valid.
+ */
+export type HydratedBlockStateValidationFunction = (
+  hydratedBlock: HydratedBlock,
+  chainId: Address,
+  archivist: ReadArchivist,
+) => Promisable<Error[]>

package/src/validation/block/HydratedBlockValidationFunction.ts

@@ -0,0 +1,15 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { HydratedBlock } from '../../protocol/index.ts'
+
+/**
+ * A function that validates a hydrated block.
+ * @param hydratedBlock The hydrated block to validate.
+ * @param chainId The chain ID to use for validation.
+ * @returns An array of errors if the block is invalid, or an empty array if it is valid.
+ */
+export type HydratedBlockValidatorFunction = (
+  hydratedBlock: HydratedBlock,
+  chainId?: Address,
+) => Promisable<Error[]>

package/src/validation/block/index.ts

@@ -0,0 +1,3 @@
+export * from './BlockValidationFunction.ts'
+export * from './HydratedBlockStateValidationFunction.ts'
+export * from './HydratedBlockValidationFunction.ts'

package/src/validation/boundwitness/BoundWitnessValidationFunction.ts

@@ -0,0 +1,6 @@
+import type { Promisable } from '@xylabs/promise'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+
+export type BoundWitnessValidationFunction<T extends BoundWitness = BoundWitness> = (
+  bw: T
+) => Promisable<Error[]>

package/src/validation/boundwitness/HydratedBoundWitnessValidationFunction.ts

@@ -0,0 +1,10 @@
+import type { Promisable } from '@xylabs/promise'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import type { Payload, WithHashStorageMeta } from '@xyo-network/payload-model'
+
+export type HydratedBoundWitnessWithHashStorageMeta<T extends BoundWitness = BoundWitness, P extends Payload = Payload>
+  = [WithHashStorageMeta<T>, WithHashStorageMeta<P>[]]
+
+export type HydratedBoundWitnessValidationFunction<T extends BoundWitness = BoundWitness> = (
+  bw: HydratedBoundWitnessWithHashStorageMeta<T>
+) => Promisable<Error[]>