@xyo-network/xl1-protocol-lib 1.26.1

package/src/viewers/TransactionValidation.ts

@@ -0,0 +1,72 @@
+import { type Promisable } from '@xylabs/sdk-js'
+import { zodIsFactory } from '@xylabs/sdk-js'
+import type {
+  Provider, SignedHydratedTransaction, SignedHydratedTransactionWithHashMeta,
+} from '@xyo-network/xl1-protocol-model'
+import {
+  ChainQualificationZod, ChainQualifiedHeadConfigZod, ChainQualifiedRangeConfigZod,
+} from '@xyo-network/xl1-protocol-model'
+import { z } from 'zod'
+
+import type { HydratedTransactionValidationError } from '../validation/index.ts'
+
+/** TransactionValidationQualificationZod constant. */
+export const TransactionValidationQualificationZod = ChainQualificationZod
+/** TransactionValidationQualification type. */
+export type TransactionValidationQualification = z.infer<typeof TransactionValidationQualificationZod>
+/** Type guard that checks if a value is a valid TransactionValidationQualification. */
+export const isTransactionValidationQualification = zodIsFactory(TransactionValidationQualificationZod)
+
+/** TransactionValidationConfigFieldsZod constant. */
+export const TransactionValidationConfigFieldsZod = z.object({
+  value: z.boolean().optional(),
+  state: z.boolean().optional(),
+})
+
+/** TransactionValidationConfigZod constant. */
+export const TransactionValidationConfigZod = z.union([
+  TransactionValidationConfigFieldsZod.extend(ChainQualifiedHeadConfigZod.shape),
+  TransactionValidationConfigFieldsZod.extend(ChainQualifiedRangeConfigZod.shape),
+  TransactionValidationConfigFieldsZod,
+  z.object({}),
+])
+
+/** TransactionValidationConfig type. */
+export type TransactionValidationConfig = z.infer<typeof TransactionValidationConfigZod>
+/** Type guard that checks if a value is a valid TransactionValidationConfig. */
+export const isTransactionValidationConfig = zodIsFactory(TransactionValidationConfigZod)
+
+/** TransactionValidationViewerMethods interface. */
+export interface TransactionValidationViewerMethods {
+  qualifiedValidateTransactions(
+    blocks: SignedHydratedTransaction[],
+    config?: TransactionValidationConfig
+  ): Promisable<[(HydratedTransactionValidationError[] | SignedHydratedTransactionWithHashMeta)[], TransactionValidationQualification]>
+}
+
+/** Moniker identifier for the TransactionValidationViewer provider. */
+export const TransactionValidationViewerMoniker = 'TransactionValidationViewer' as const
+/** Type literal for the TransactionValidationViewer provider moniker. */
+export type TransactionValidationViewerMoniker = typeof TransactionValidationViewerMoniker
+
+/**
+ * Checks if transactions are valid (currently valid) according to protocol rules.
+ * In the case that they are not valid, they may still become valid in the future.
+ */
+
+export interface TransactionValidationViewer extends TransactionValidationViewerMethods, Provider<TransactionValidationViewerMoniker> {
+  qualifiedValidateTransaction(
+    block: SignedHydratedTransaction,
+    config?: TransactionValidationConfig
+  ): Promisable<[HydratedTransactionValidationError[] | SignedHydratedTransactionWithHashMeta, TransactionValidationQualification]>
+
+  validateTransaction(
+    block: SignedHydratedTransaction,
+    config?: TransactionValidationConfig
+  ): Promisable<HydratedTransactionValidationError[] | SignedHydratedTransactionWithHashMeta>
+
+  validateTransactions(
+    blocks: SignedHydratedTransaction[],
+    config?: TransactionValidationConfig
+  ): Promisable<(HydratedTransactionValidationError[] | SignedHydratedTransactionWithHashMeta)[]>
+}

package/src/viewers/TransferBalance.ts

@@ -0,0 +1,35 @@
+import type { Address, Promisable } from '@xylabs/sdk-js'
+import type { Signed } from '@xyo-network/sdk-js'
+import type {
+  AttoXL1, BlockBoundWitness, Provider, TransactionBoundWitness, Transfer, XL1BlockRange,
+} from '@xyo-network/xl1-protocol-model'
+
+/** TransferBalanceHistoryItem type. */
+export type TransferBalanceHistoryItem = [
+  Signed<BlockBoundWitness> /* block */,
+  Signed<TransactionBoundWitness> | null,
+  Transfer, /* the actual transfer payload */
+]
+/** TransferPair type. */
+export type TransferPair = [Address, Address]
+
+/** TransferBalancesViewerMethods interface. */
+export interface TransferBalancesViewerMethods {
+  transferBalances(address: Address[]): Promisable<Partial<Record<Address, Record<Address, AttoXL1>>>>
+  transferBalancesHistories(address: Address[]): Promisable<Partial<Record<Address, Record<Address, TransferBalanceHistoryItem[]>>>>
+  transferPairBalances(address: TransferPair[]): Promisable<Partial<Record<Address, Record<Address, AttoXL1>>>>
+  transferPairBalancesHistories(address: TransferPair[]): Promisable<Partial<Record<Address, Record<Address, TransferBalanceHistoryItem[]>>>>
+}
+
+/** Moniker identifier for the TransferBalanceViewer provider. */
+export const TransferBalanceViewerMoniker = 'TransferBalanceViewer' as const
+/** Type literal for the TransferBalanceViewer provider moniker. */
+export type TransferBalanceViewerMoniker = typeof TransferBalanceViewerMoniker
+
+/** Viewer interface for reading TransferBalance data. */
+export interface TransferBalanceViewer extends TransferBalancesViewerMethods, Provider<TransferBalanceViewerMoniker> {
+  transferBalance(address: Address): Promisable<AttoXL1>
+  transferBalanceHistory(address: Address, range?: XL1BlockRange): Promisable<TransferBalanceHistoryItem[]>
+  transferPairBalance(address: TransferPair): Promisable<AttoXL1>
+  transferPairBalanceHistory(address: TransferPair): Promisable<TransferBalanceHistoryItem[]>
+}

package/src/viewers/WindowedBlock.ts

@@ -0,0 +1,23 @@
+import type { Hash, Promisable } from '@xylabs/sdk-js'
+import type {
+  HydratedBlockWithHashMeta, Provider, ProviderMoniker,
+} from '@xyo-network/xl1-protocol-model'
+
+import type { BlockViewerMethods } from './Block.ts'
+
+type ExtendableBlockViewerMethods = Omit<BlockViewerMethods, 'rate' | 'stepSizeRate' | 'timeDurationRate'>
+
+/** WindowedBlockViewerMethods interface. */
+export interface WindowedBlockViewerMethods extends ExtendableBlockViewerMethods {
+  blocksByTransactionHashes(hashes: Hash[]): Promisable<HydratedBlockWithHashMeta[]>
+}
+
+/** Moniker identifier for the WindowedBlockViewer provider. */
+export const WindowedBlockViewerMoniker = 'WindowedBlockViewer' as const
+/** Type literal for the WindowedBlockViewer provider moniker. */
+export type WindowedBlockViewerMoniker = typeof WindowedBlockViewerMoniker
+
+/** Viewer interface for reading WindowedBlock data. */
+export interface WindowedBlockViewer<TMoniker extends ProviderMoniker = WindowedBlockViewerMoniker> extends WindowedBlockViewerMethods, Provider<TMoniker> {
+  blockByTransactionHash(hash: Hash): Promisable<HydratedBlockWithHashMeta | null>
+}

package/src/viewers/XyoViewer.ts

@@ -0,0 +1,73 @@
+import type { Address, Promisable } from '@xylabs/sdk-js'
+import type {
+  AccountBalanceHistoryItem, AccountBalanceViewer, AttoXL1,
+  ChainQualifiedConfig, Provider,
+} from '@xyo-network/xl1-protocol-model'
+
+import type { BlockViewer, BlockViewerMethods } from './Block.ts'
+import type { FinalizationViewer } from './Finalization.ts'
+import type { ForkViewerMethods } from './Fork.ts'
+import type { MempoolViewer } from './Mempool.ts'
+import type { NetworkStakeViewer } from './NetworkStake/index.ts'
+import type { NetworkStakeStepRewardViewerMethods } from './NetworkStakeStepReward.ts'
+import type { StakeViewer, StakeViewerMethods } from './Stake.ts'
+import type { StepViewer } from './StepViewer.ts'
+import type { TimeSyncViewer } from './TimeSync.ts'
+import type { TransactionViewer, TransactionViewerMethods } from './Transaction.ts'
+
+/** XyoViewerMethods interface. */
+export interface XyoViewerMethods extends
+  NetworkStakeStepRewardViewerMethods, BlockViewerMethods,
+  Omit<TransactionViewerMethods, 'byHash'>, Omit<
+    StakeViewerMethods, 'minWithdrawalBlocks' | 'rewardsContract' | 'stakingTokenAddress' | 'active'
+    | 'activeByAddressStaked' | 'activeByStaker' | 'pending' | 'pendingByStaker' | 'withdrawn' | 'withdrawnByStaker'
+  >, ForkViewerMethods {
+  /** @deprecated Use .account.balance.accountBalance instead */
+  accountBalance(address: Address, config?: ChainQualifiedConfig): Promisable<AttoXL1>
+  /** @deprecated Use .account.balance.accountBalanceHistory instead */
+  accountBalanceHistory(address: Address, config?: ChainQualifiedConfig): Promisable<AccountBalanceHistoryItem[]>
+}
+
+/** XyoViewerMethodsV2 interface. */
+export interface XyoViewerMethodsV2 {
+
+}
+
+/** Moniker identifier for the XyoViewer provider. */
+export const XyoViewerMoniker = 'XyoViewer' as const
+/** Type literal for the XyoViewer provider moniker. */
+export type XyoViewerMoniker = typeof XyoViewerMoniker
+
+/** Viewer interface for reading Xyo data. */
+export interface XyoViewer extends Omit<BlockViewer, 'moniker'>, XyoViewerMethods,
+  Omit<
+    StakeViewerMethods, 'moniker' | 'minWithdrawalBlocks' | 'rewardsContract' | 'stakingTokenAddress' | 'active'
+    | 'activeByAddressStaked' | 'activeByStaker' | 'pending' | 'pendingByStaker' | 'withdrawn' | 'withdrawnByStaker'
+  >, Provider<XyoViewerMoniker> {
+  account: {
+    balance: AccountBalanceViewer
+  }
+  block: BlockViewer
+  finalization: FinalizationViewer
+  mempool: MempoolViewer
+  networkStake: NetworkStakeViewer
+  stake: StakeViewer
+  step: StepViewer
+  time: TimeSyncViewer
+  transaction: TransactionViewer
+}
+
+/** XyoViewerV2 interface. */
+export interface XyoViewerV2 extends XyoViewerMethodsV2, Provider<XyoViewerMoniker> {
+  account: {
+    balance: AccountBalanceViewer
+  }
+  block: BlockViewer
+  finalization: FinalizationViewer
+  mempool: MempoolViewer
+  networkStake: NetworkStakeViewer
+  stake: StakeViewer
+  step: StepViewer
+  time: TimeSyncViewer
+  transaction: TransactionViewer
+}

package/src/viewers/index.ts

@@ -0,0 +1,23 @@
+export * from './Block.ts'
+export * from './BlockInvalidation.ts'
+export * from './BlockReward.ts'
+export * from './BlockValidation.ts'
+export * from './ChainContract.ts'
+export * from './ChainStakeViewer.ts'
+export * from './Finalization.ts'
+export * from './Fork.ts'
+export * from './Mempool.ts'
+export * from './NetworkStake/index.ts'
+export * from './NetworkStakeStepReward.ts'
+export * from './Stake.ts'
+export * from './StakeEvents.ts'
+export * from './StakeTotals.ts'
+export * from './StepStake.ts'
+export * from './StepViewer.ts'
+export * from './TimeSync.ts'
+export * from './Transaction.ts'
+export * from './TransactionInvalidation.ts'
+export * from './TransactionValidation.ts'
+export * from './TransferBalance.ts'
+export * from './WindowedBlock.ts'
+export * from './XyoViewer.ts'