@xyo-network/xl1-protocol 1.25.26 → 1.25.28

package/src/viewers/ChainContract.ts

@@ -6,6 +6,7 @@ import type { XL1BlockNumber } from '../BlockNumber/index.ts'
 import type { ChainId } from '../chain/index.ts'
 import type { Provider } from '../provider/index.ts'
 
+/** ChainContractViewerMethods interface. */
 export interface ChainContractViewerMethods {
   chainId(): Promisable<ChainId>
   forkedAtBlockNumber(): Promisable<XL1BlockNumber | null>
@@ -16,9 +17,12 @@ export interface ChainContractViewerMethods {
   stakingTokenAddress(): Promisable<Address>
 }
 
+/** Moniker identifier for the ChainContractViewer provider. */
 export const ChainContractViewerMoniker = 'ChainContractViewer' as const
+/** Type literal for the ChainContractViewer provider moniker. */
 export type ChainContractViewerMoniker = typeof ChainContractViewerMoniker
 
+/** Viewer interface for reading ChainContract data. */
 export interface ChainContractViewer extends ChainContractViewerMethods, Provider<ChainContractViewerMoniker> {
   chainIdAtBlockNumber(blockNumber: XL1BlockNumber | 'latest'): Promisable<ChainId>
   forkedChainContractViewer(): Promisable<ChainContractViewer | null>

package/src/viewers/ChainStakeViewer.ts

@@ -2,9 +2,12 @@ import type { Provider } from '../provider/index.ts'
 import type { ChainContractViewer } from './ChainContract.ts'
 import type { StakeTotalsViewer } from './StakeTotals.ts'
 
+/** Moniker identifier for the ChainStakeViewer provider. */
 export const ChainStakeViewerMoniker = 'ChainStakeViewer' as const
+/** Type literal for the ChainStakeViewer provider moniker. */
 export type ChainStakeViewerMoniker = typeof ChainStakeViewerMoniker
 
+/** Viewer interface for reading ChainStake data. */
 export interface ChainStakeViewer extends Omit<ChainContractViewer, 'moniker'>, Omit<StakeTotalsViewer, 'moniker'>,
   Provider<ChainStakeViewerMoniker> {
 

package/src/viewers/Finalization.ts

@@ -5,13 +5,17 @@ import type { XL1BlockNumber } from '../BlockNumber/index.ts'
 import type { ChainId } from '../chain/index.ts'
 import type { Provider } from '../provider/index.ts'
 
+/** FinalizationViewerMethods interface. */
 export interface FinalizationViewerMethods {
   head(): Promisable<SignedHydratedBlockWithHashMeta>
 }
 
+/** Moniker identifier for the FinalizationViewer provider. */
 export const FinalizationViewerMoniker = 'FinalizationViewer' as const
+/** Type literal for the FinalizationViewer provider moniker. */
 export type FinalizationViewerMoniker = typeof FinalizationViewerMoniker
 
+/** Viewer interface for reading Finalization data. */
 export interface FinalizationViewer extends FinalizationViewerMethods, Provider<FinalizationViewerMoniker> {
   chainId(): Promisable<ChainId>
   headBlock(): Promisable<SignedBlockBoundWitnessWithHashMeta>

package/src/viewers/Fork.ts

@@ -2,8 +2,10 @@ import type { Promisable } from '@xylabs/sdk-js'
 
 import type { ChainId } from '../chain/index.ts'
 
+/** ForkHistory type. */
 export type ForkHistory = Record<number, ChainId>
 
+/** ForkViewerMethods interface. */
 export interface ForkViewerMethods {
   forkHistory(): Promisable<ForkHistory>
 }

package/src/viewers/Mempool.ts

@@ -6,28 +6,36 @@ import type { SignedHydratedTransactionWithHashMeta } from '../model/index.ts'
 import { XL1BlockRangeZod } from '../model/index.ts'
 import type { Provider } from '../provider/index.ts'
 
+/** PendingTransactionsOptionsZod constant. */
 export const PendingTransactionsOptionsZod = z.object({
   cursor: HashZod.optional(),
   limit: z.number().int().positive().optional(),
   window: XL1BlockRangeZod.optional(),
 })
 
+/** PendingTransactionsOptions type. */
 export type PendingTransactionsOptions = z.infer<typeof PendingTransactionsOptionsZod>
 
+/** PendingBlocksOptionsZod constant. */
 export const PendingBlocksOptionsZod = z.object({
   cursor: HashZod.optional(),
   limit: z.number().int().positive().optional(),
   window: XL1BlockRangeZod.optional(),
 })
 
+/** PendingBlocksOptions type. */
 export type PendingBlocksOptions = z.infer<typeof PendingBlocksOptionsZod>
 
+/** MempoolViewerMethods interface. */
 export interface MempoolViewerMethods {
   pendingBlocks(options?: PendingBlocksOptions): Promise<SignedHydratedBlockWithHashMeta[]>
   pendingTransactions(options?: PendingTransactionsOptions): Promise<SignedHydratedTransactionWithHashMeta[]>
 }
 
+/** Moniker identifier for the MempoolViewer provider. */
 export const MempoolViewerMoniker = 'MempoolViewer' as const
+/** Type literal for the MempoolViewer provider moniker. */
 export type MempoolViewerMoniker = typeof MempoolViewerMoniker
 
+/** Viewer interface for reading Mempool data. */
 export interface MempoolViewer extends MempoolViewerMethods, Provider<MempoolViewerMoniker> {}

package/src/viewers/NetworkStake/NetworkStakeViewer.ts

@@ -3,14 +3,18 @@ import type { Promisable } from '@xylabs/sdk-js'
 import type { Provider } from '../../provider/index.ts'
 import type { NetworkStakeStepRewardsViewer } from './Rewards/index.ts'
 
+/** NetworkStakeViewerMethods interface. */
 export interface NetworkStakeViewerMethods {
   /** @returns the active stake and the number of active validators [active, block] */
   active(blockNumber?: number): Promisable<[bigint, number]>
 }
 
+/** Moniker identifier for the NetworkStakeViewer provider. */
 export const NetworkStakeViewerMoniker = 'NetworkStakeViewer' as const
+/** Type literal for the NetworkStakeViewer provider moniker. */
 export type NetworkStakeViewerMoniker = typeof NetworkStakeViewerMoniker
 
+/** Viewer interface for reading NetworkStake data. */
 export interface NetworkStakeViewer extends NetworkStakeViewerMethods, Provider<NetworkStakeViewerMoniker> {
   stepRewards?: NetworkStakeStepRewardsViewer
 }

package/src/viewers/NetworkStake/Rewards/ByPositionViewer.ts

@@ -4,11 +4,15 @@ import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './temp
 
 // Viewers are client objects that can nest other viewers and ViewerMethods objects consist only of methods that return data.
 
+/** NetworkStakeStepRewardsByPositionViewerMethods interface. */
 export interface NetworkStakeStepRewardsByPositionViewerMethods extends
   NetworkStakeStepRewardsByIndexViewerMethodsTemplate<NetworkStakeStepRewardsByPositionViewerOptions, number> {}
 
+/** Moniker identifier for the NetworkStakeStepRewardsByPositionViewer provider. */
 export const NetworkStakeStepRewardsByPositionViewerMoniker = 'NetworkStakeStepRewardsByPositionViewer' as const
+/** Type literal for the NetworkStakeStepRewardsByPositionViewer provider moniker. */
 export type NetworkStakeStepRewardsByPositionViewerMoniker = typeof NetworkStakeStepRewardsByPositionViewerMoniker
 
+/** Viewer interface for reading NetworkStakeStepRewardsByPosition data. */
 export interface NetworkStakeStepRewardsByPositionViewer extends NetworkStakeStepRewardsByPositionViewerMethods,
   Provider<NetworkStakeStepRewardsByPositionViewerMoniker> {}

package/src/viewers/NetworkStake/Rewards/ByStakerViewer.ts

@@ -6,11 +6,15 @@ import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './temp
 
 // Viewers are client objects that can nest other viewers and ViewerMethods objects consist only of methods that return data.
 
+/** NetworkStakeStepRewardsByStakerViewerMethods interface. */
 export interface NetworkStakeStepRewardsByStakerViewerMethods
   extends NetworkStakeStepRewardsByIndexViewerMethodsTemplate<NetworkStakeStepRewardsByStakerViewerOptions, Address> {}
 
+/** Moniker identifier for the NetworkStakeStepRewardsByStakerViewer provider. */
 export const NetworkStakeStepRewardsByStakerViewerMoniker = 'NetworkStakeStepRewardsByStakerViewer' as const
+/** Type literal for the NetworkStakeStepRewardsByStakerViewer provider moniker. */
 export type NetworkStakeStepRewardsByStakerViewerMoniker = typeof NetworkStakeStepRewardsByStakerViewerMoniker
 
+/** Viewer interface for reading NetworkStakeStepRewardsByStaker data. */
 export interface NetworkStakeStepRewardsByStakerViewer extends NetworkStakeStepRewardsByStakerViewerMethods,
   Provider<NetworkStakeStepRewardsByStakerViewerMoniker> {}

package/src/viewers/NetworkStake/Rewards/ByStepViewer.ts

@@ -5,10 +5,14 @@ import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './temp
 
 // Viewers are client objects that can nest other viewers and ViewerMethods objects consist only of methods that return data.
 
+/** NetworkStakeStepRewardsByStepViewerMethods interface. */
 export interface NetworkStakeStepRewardsByStepViewerMethods extends
   NetworkStakeStepRewardsByIndexViewerMethodsTemplate<NetworkStakeStepRewardsByStepViewerOptions, StepIdentityString> {}
 
+/** Moniker identifier for the NetworkStakeStepRewardsByStepViewer provider. */
 export const NetworkStakeStepRewardsByStepViewerMoniker = 'NetworkStakeStepRewardsByStepViewer' as const
+/** Type literal for the NetworkStakeStepRewardsByStepViewer provider moniker. */
 export type NetworkStakeStepRewardsByStepViewerMoniker = typeof NetworkStakeStepRewardsByStepViewerMoniker
 
+/** Viewer interface for reading NetworkStakeStepRewardsByStep data. */
 export interface NetworkStakeStepRewardsByStepViewer extends NetworkStakeStepRewardsByStepViewerMethods, Provider<NetworkStakeStepRewardsByStepViewerMoniker> {}

package/src/viewers/NetworkStake/Rewards/Options.ts

@@ -3,18 +3,22 @@ import type { Address } from '@xylabs/sdk-js'
 import type { BlockRange } from '../../../model/index.ts'
 import type { StepIdentity } from '../../../Step/index.ts'
 
+/** Options for NetworkStakeStepRewardsRange. */
 export interface NetworkStakeStepRewardsRangeOptions {
   range?: BlockRange
 }
 
+/** Options for NetworkStakeStepRewardsByStepViewer. */
 export interface NetworkStakeStepRewardsByStepViewerOptions extends NetworkStakeStepRewardsRangeOptions {
   steps?: StepIdentity[]
 }
 
+/** Options for NetworkStakeStepRewardsByStakerViewer. */
 export interface NetworkStakeStepRewardsByStakerViewerOptions extends NetworkStakeStepRewardsRangeOptions {
   stakers?: Address[]
 }
 
+/** Options for NetworkStakeStepRewardsByPositionViewer. */
 export interface NetworkStakeStepRewardsByPositionViewerOptions extends NetworkStakeStepRewardsRangeOptions {
   positions?: number[]
 }

package/src/viewers/NetworkStake/Rewards/TotalViewer.ts

@@ -5,9 +5,13 @@ import type { NetworkStakeStepRewardsViewerMethodsTemplate } from './templates/i
 
 // Viewers are client objects that can nest other viewers and ViewerMethods objects consist only of methods that return data.
 
+/** NetworkStakeStepRewardsTotalViewerMethods interface. */
 export interface NetworkStakeStepRewardsTotalViewerMethods extends NetworkStakeStepRewardsViewerMethodsTemplate<NetworkStakeStepRewardsRangeOptions, AttoXL1> {}
 
+/** Moniker identifier for the NetworkStakeStepRewardsTotalViewer provider. */
 export const NetworkStakeStepRewardsTotalViewerMoniker = 'NetworkStakeStepRewardsTotalViewer' as const
+/** Type literal for the NetworkStakeStepRewardsTotalViewer provider moniker. */
 export type NetworkStakeStepRewardsTotalViewerMoniker = typeof NetworkStakeStepRewardsTotalViewerMoniker
 
+/** Viewer interface for reading NetworkStakeStepRewardsTotal data. */
 export interface NetworkStakeStepRewardsTotalViewer extends NetworkStakeStepRewardsTotalViewerMethods, Provider<NetworkStakeStepRewardsTotalViewerMoniker> {}

package/src/viewers/NetworkStake/Rewards/Viewer.ts

@@ -4,11 +4,15 @@ import type { NetworkStakeStepRewardsByStakerViewer } from './ByStakerViewer.ts'
 import type { NetworkStakeStepRewardsByStepViewer } from './ByStepViewer.ts'
 import type { NetworkStakeStepRewardsTotalViewer } from './TotalViewer.ts'
 
+/** NetworkStakeStepRewardsViewerMethods interface. */
 export interface NetworkStakeStepRewardsViewerMethods {}
 
+/** Moniker identifier for the NetworkStakeStepRewardsViewer provider. */
 export const NetworkStakeStepRewardsViewerMoniker = 'NetworkStakeStepRewardsViewer' as const
+/** Type literal for the NetworkStakeStepRewardsViewer provider moniker. */
 export type NetworkStakeStepRewardsViewerMoniker = typeof NetworkStakeStepRewardsViewerMoniker
 
+/** Viewer interface for reading NetworkStakeStepRewards data. */
 export interface NetworkStakeStepRewardsViewer extends NetworkStakeStepRewardsViewerMethods, Provider<NetworkStakeStepRewardsViewerMoniker> {
   position?: NetworkStakeStepRewardsByPositionViewer
   staker?: NetworkStakeStepRewardsByStakerViewer

package/src/viewers/NetworkStake/Rewards/templates/ByIndexMethodsTemplate.ts

@@ -2,5 +2,6 @@ import type { RecordKeyType } from '../../../../RecordKeyType.ts'
 import type { AttoXL1 } from '../../../../xl1/index.ts'
 import type { NetworkStakeStepRewardsViewerMethodsTemplate } from './MethodsTemplate.ts'
 
+/** NetworkStakeStepRewardsByIndexViewerMethodsTemplate interface. */
 export interface NetworkStakeStepRewardsByIndexViewerMethodsTemplate<TOptions, TResultIndex extends RecordKeyType>
   extends NetworkStakeStepRewardsViewerMethodsTemplate<TOptions, Record<TResultIndex, AttoXL1>> {}

package/src/viewers/NetworkStake/Rewards/templates/MethodsTemplate.ts

@@ -1,5 +1,6 @@
 import type { Promisable } from '@xylabs/sdk-js'
 
+/** NetworkStakeStepRewardsViewerMethodsTemplate interface. */
 export interface NetworkStakeStepRewardsViewerMethodsTemplate<TOptions, TResult> {
   bonus(options?: TOptions): Promisable<TResult>
   claimed(options?: TOptions): Promisable<TResult>

package/src/viewers/NetworkStakeStepReward.ts

@@ -4,6 +4,7 @@ import type { Provider } from '../provider/index.ts'
 import type { StepIdentity, StepIdentityString } from '../Step/index.ts'
 import type { AttoXL1 } from '../xl1/index.ts'
 
+/** NetworkStakeStepAddressRewardViewerMethods interface. */
 export interface NetworkStakeStepAddressRewardViewerMethods {
   // the step rewards for a specific network stakers for all of history
   networkStakeStepRewardAddressHistory(address: Address): Promisable<Record<Address, AttoXL1>>
@@ -18,6 +19,7 @@ export interface NetworkStakeStepAddressRewardViewerMethods {
   networkStakeStepRewardWeightForAddress(context: StepIdentity, address: Address): Promisable<bigint>
 }
 
+/** NetworkStakeStepPoolRewardViewerMethods interface. */
 export interface NetworkStakeStepPoolRewardViewerMethods {
 
   // all the step rewards for all the network stakers for a given step and block
@@ -27,6 +29,7 @@ export interface NetworkStakeStepPoolRewardViewerMethods {
   networkStakeStepRewardPoolShares(context: StepIdentity): Promisable<Record<Address, bigint>>
 }
 
+/** NetworkStakeStepRewardPositionViewerMethods interface. */
 export interface NetworkStakeStepRewardPositionViewerMethods {
   // estimate the current weight for a given position at a given step
   networkStakeStepRewardPositionWeight(context: StepIdentity, position: number): Promisable<bigint>
@@ -35,6 +38,7 @@ export interface NetworkStakeStepRewardPositionViewerMethods {
   networkStakeStepRewardPotentialPositionLoss(context: StepIdentity, position: number): Promisable<AttoXL1>
 }
 
+/** NetworkStakeStepRewardViewerMethods interface. */
 export interface NetworkStakeStepRewardViewerMethods extends
   NetworkStakeStepPoolRewardViewerMethods,
   NetworkStakeStepAddressRewardViewerMethods,
@@ -70,7 +74,10 @@ export interface NetworkStakeStepRewardViewerMethods extends
   networkStakeStepRewardsForStepLevel(stepLevel: number, range: [number, number]): Promisable<AttoXL1>
 }
 
+/** Moniker identifier for the NetworkStakeStepRewardViewer provider. */
 export const NetworkStakeStepRewardViewerMoniker = 'NetworkStakeStepRewardViewer' as const
+/** Type literal for the NetworkStakeStepRewardViewer provider moniker. */
 export type NetworkStakeStepRewardViewerMoniker = typeof NetworkStakeStepRewardViewerMoniker
 
+/** Viewer interface for reading NetworkStakeStepReward data. */
 export interface NetworkStakeStepRewardViewer extends NetworkStakeStepRewardViewerMethods, Provider<NetworkStakeStepRewardViewerMoniker> {}

package/src/viewers/Stake.ts

@@ -4,10 +4,12 @@ import type { Position } from '../model/index.ts'
 import type { Provider } from '../provider/index.ts'
 import type { StakeEventsViewer } from './StakeEvents.ts'
 
+/** StakeViewerProperties interface. */
 export interface StakeViewerProperties {
   stakeEvents: StakeEventsViewer
 }
 
+/** StakeViewerMethods interface. */
 export interface StakeViewerMethods {
   minWithdrawalBlocks(): Promisable<number>
   rewardsContract(): Promisable<Address>
@@ -18,18 +20,24 @@ export interface StakeViewerMethods {
   stakingTokenAddress(): Promisable<Address>
 }
 
+/** Moniker identifier for the StakeViewer provider. */
 export const StakeViewerMoniker = 'StakeViewer' as const
+/** Type literal for the StakeViewer provider moniker. */
 export type StakeViewerMoniker = typeof StakeViewerMoniker
 
+/** Viewer interface for reading Stake data. */
 export interface StakeViewer extends StakeViewerMethods, StakeViewerProperties, Provider<StakeViewerMoniker> {
   activeStakes(): Promisable<Position[]>
   removedStakes(): Promisable<Position[]>
   withdrawnStakes(): Promisable<Position[]>
 }
 
+/** Moniker identifier for the StakeRunner provider. */
 export const StakeRunnerMoniker = 'StakeRunner' as const
+/** Type literal for the StakeRunner provider moniker. */
 export type StakeRunnerMoniker = typeof StakeRunnerMoniker
 
+/** Runner interface for executing Stake operations. */
 export interface StakeRunner extends Provider<StakeRunnerMoniker> {
   addStake(staked: string, amount: bigint): Promise<boolean>
   removeStake(slot: bigint): Promise<boolean>

package/src/viewers/StakeEvents.ts

@@ -4,20 +4,25 @@ import type {
 
 import type { Provider } from '../provider/index.ts'
 
+/** StakeEventNames constant. */
 export const StakeEventNames = ['StakeAdded', 'StakeRemoved', 'StakeWithdrawn'] as const
+/** StakeEventName type. */
 export type StakeEventName = typeof StakeEventNames[number]
 
+/** ExternalEvent interface. */
 export interface ExternalEvent<TName extends string = string, TArgs extends JsonObject = {}> {
   args: TArgs
   name: TName
   time: number // usually block number
 }
 
+/** EventFilter interface. */
 export interface EventFilter<TName extends string = string> {
   name?: TName
   time?: [number, number]
 }
 
+/** StakeEventArgs interface. */
 export interface StakeEventArgs {
   amount: bigint
   id: number
@@ -25,19 +30,25 @@ export interface StakeEventArgs {
   staker: Address
 }
 
+/** StakeEventFilterArgs type. */
 export type StakeEventFilterArgs = Partial<Pick<StakeEventArgs, 'staker' | 'staked' | 'id'>>
 
+/** StakeEventFilter interface. */
 export interface StakeEventFilter<TName extends StakeEventName = StakeEventName> extends EventFilter<TName> {
   args?: StakeEventFilterArgs
 }
 
+/** StakeEvent interface. */
 export interface StakeEvent<TName extends StakeEventName = StakeEventName> extends ExternalEvent<TName> {
   args: StakeEventArgs
 }
 
+/** Moniker identifier for the StakeEventsViewer provider. */
 export const StakeEventsViewerMoniker = 'StakeEventsViewer' as const
+/** Type literal for the StakeEventsViewer provider moniker. */
 export type StakeEventsViewerMoniker = typeof StakeEventsViewerMoniker
 
+/** Viewer interface for reading StakeEvents data. */
 export interface StakeEventsViewer extends Provider<StakeEventsViewerMoniker> {
   positionCount(range: [number, number | 'latest']): Promisable<number>
   stakeEvents<TName extends StakeEventName>(range: [number, number | 'latest'], filter?: StakeEventFilter<TName>): Promisable<StakeEvent<TName>[]>

package/src/viewers/StakeIntent.ts

@@ -6,13 +6,17 @@ import type { ChainQualified, XL1BlockRange } from '../model/index.ts'
 import type { ChainStakeIntent } from '../payload/index.ts'
 import type { Provider } from '../provider/index.ts'
 
+/** StakeIntentViewerMethods interface. */
 export interface StakeIntentViewerMethods {
   qualifiedIntentByAddress(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<ChainQualified<ChainStakeIntent | null>>
 }
 
+/** Moniker identifier for the StakeIntentViewer provider. */
 export const StakeIntentViewerMoniker = 'StakeIntentViewer' as const
+/** Type literal for the StakeIntentViewer provider moniker. */
 export type StakeIntentViewerMoniker = typeof StakeIntentViewerMoniker
 
+/** Viewer interface for reading StakeIntent data. */
 export interface StakeIntentViewer extends StakeIntentViewerMethods, Provider<StakeIntentViewerMoniker> {
   intentByAddress(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<ChainStakeIntent | null>
 }

package/src/viewers/StakeTotals.ts

@@ -2,6 +2,7 @@ import type { Address, Promisable } from '@xylabs/sdk-js'
 
 import type { Provider } from '../provider/index.ts'
 
+/** StakeTotalsViewerMethods interface. */
 export interface StakeTotalsViewerMethods {
   active(time?: number): Promisable<bigint>
   activeByStaked(staked: Address, time?: number): Promisable<bigint>
@@ -12,7 +13,10 @@ export interface StakeTotalsViewerMethods {
   withdrawnByStaker(staker: Address, time?: number): Promisable<bigint>
 }
 
+/** Moniker identifier for the StakeTotalsViewer provider. */
 export const StakeTotalsViewerMoniker = 'StakeTotalsViewer' as const
+/** Type literal for the StakeTotalsViewer provider moniker. */
 export type StakeTotalsViewerMoniker = typeof StakeTotalsViewerMoniker
 
+/** Viewer interface for reading StakeTotals data. */
 export interface StakeTotalsViewer extends StakeTotalsViewerMethods, Provider<StakeTotalsViewerMoniker> {}

package/src/viewers/StepStake.ts

@@ -3,6 +3,7 @@ import type { Address, Promisable } from '@xylabs/sdk-js'
 import type { Provider } from '../provider/index.ts'
 import type { StepIdentity } from '../Step/index.ts'
 
+/** StepStakeViewerMethods interface. */
 export interface StepStakeViewerMethods {
   // this is the prorated stake for all addresses in the step
   stepStake: (step: StepIdentity) => Promisable<Record<Address, bigint>>
@@ -20,6 +21,8 @@ export interface StepStakeViewerMethods {
 */
 
 export const StepStakeViewerMoniker = 'StepStakeViewer' as const
+/** Type literal for the StepStakeViewer provider moniker. */
 export type StepStakeViewerMoniker = typeof StepStakeViewerMoniker
 
+/** Viewer interface for reading StepStake data. */
 export interface StepStakeViewer extends StepStakeViewerMethods, Provider<StepStakeViewerMoniker> {}

package/src/viewers/StepViewer.ts

@@ -5,21 +5,25 @@ import type { Provider } from '../provider/index.ts'
 import type { StepIdentity } from '../Step/index.ts'
 import type { NetworkStakeStepRewardsViewer } from './NetworkStake/index.ts'
 
+/** Options for PagedPositions. */
 export interface PagedPositionsOptions {
   cursor?: PositionId
   limit?: number
 }
 
+/** Options for PagedStakers. */
 export interface PagedStakersOptions {
   cursor?: Address
   limit?: number
 }
 
+/** StepStatistics interface. */
 export interface StepStatistics {
   endTime: number
   startTime: number
 }
 
+/** StepViewerMethods interface. */
 export interface StepViewerMethods {
 
   // the total number of positions for a given step
@@ -42,9 +46,12 @@ export interface StepViewerMethods {
   weight(step: StepIdentity, positionId?: PositionId): Promisable<bigint>
 }
 
+/** Moniker identifier for the StepViewer provider. */
 export const StepViewerMoniker = 'StepViewer' as const
+/** Type literal for the StepViewer provider moniker. */
 export type StepViewerMoniker = typeof StepViewerMoniker
 
+/** Viewer interface for reading Step data. */
 export interface StepViewer extends StepViewerMethods, Provider<StepViewerMoniker> {
   rewards?: NetworkStakeStepRewardsViewer
 }

package/src/viewers/TimeSync.ts

@@ -3,6 +3,7 @@ import type { Promisable } from '@xylabs/sdk-js'
 import type { TimeDomain, TimePayload } from '../payload/index.ts'
 import type { Provider } from '../provider/index.ts'
 
+/** TimeSyncViewerMethods interface. */
 export interface TimeSyncViewerMethods {
   /** Convert time between different domains */
   convertTime(fromDomain: TimeDomain, toDomain: TimeDomain, from: number): Promisable<number>
@@ -17,7 +18,10 @@ export interface TimeSyncViewerMethods {
   currentTimePayload(): Promisable<TimePayload>
 }
 
+/** Moniker identifier for the TimeSyncViewer provider. */
 export const TimeSyncViewerMoniker = 'TimeSyncViewer' as const
+/** Type literal for the TimeSyncViewer provider moniker. */
 export type TimeSyncViewerMoniker = typeof TimeSyncViewerMoniker
 
+/** Viewer interface for reading TimeSync data. */
 export interface TimeSyncViewer extends TimeSyncViewerMethods, Provider<TimeSyncViewerMoniker> {}

package/src/viewers/Transaction.ts

@@ -3,6 +3,7 @@ import type { Hash, Promisable } from '@xylabs/sdk-js'
 import type { SignedHydratedTransaction, SignedHydratedTransactionWithHashMeta } from '../model/index.ts'
 import type { Provider, ProviderMoniker } from '../provider/index.ts'
 
+/** TransactionViewerMethods interface. */
 export interface TransactionViewerMethods {
   byHash(transactionHash: Hash): Promisable<SignedHydratedTransactionWithHashMeta | null>
 
@@ -14,9 +15,12 @@ export interface TransactionViewerMethods {
   transactionByHash(transactionHash: Hash): Promisable<SignedHydratedTransaction | null>
 }
 
+/** Moniker identifier for the TransactionViewer provider. */
 export const TransactionViewerMoniker = 'TransactionViewer' as const
+/** Type literal for the TransactionViewer provider moniker. */
 export type TransactionViewerMoniker = typeof TransactionViewerMoniker
 
+/** Viewer interface for reading Transaction data. */
 export interface TransactionViewer<TMoniker extends ProviderMoniker = TransactionViewerMoniker> extends TransactionViewerMethods, Provider<TMoniker> {
   byBlockHashAndIndex(blockHash: Hash, transactionIndex: number): Promisable<SignedHydratedTransactionWithHashMeta | null>
   byBlockNumberAndIndex(blockNumber: number, transactionIndex: number): Promisable<SignedHydratedTransactionWithHashMeta | null>

package/src/viewers/TransactionInvalidation.ts

@@ -9,15 +9,20 @@ import {
 import type { Provider } from '../provider/index.ts'
 import type { HydratedTransactionValidationError } from '../validation/index.ts'
 
+/** TransactionInvalidationQualificationZod constant. */
 export const TransactionInvalidationQualificationZod = ChainQualificationZod
+/** TransactionInvalidationQualification type. */
 export type TransactionInvalidationQualification = z.infer<typeof TransactionInvalidationQualificationZod>
+/** Type guard that checks if a value is a valid TransactionInvalidationQualification. */
 export const isTransactionInvalidationQualification = zodIsFactory(TransactionInvalidationQualificationZod)
 
+/** TransactionInvalidationConfigFieldsZod constant. */
 export const TransactionInvalidationConfigFieldsZod = z.object({
   state: z.boolean().optional(),
   value: z.boolean().optional(),
 })
 
+/** TransactionInvalidationConfigZod constant. */
 export const TransactionInvalidationConfigZod = z.union([
   TransactionInvalidationConfigFieldsZod.extend(ChainQualifiedHeadConfigZod.shape),
   TransactionInvalidationConfigFieldsZod.extend(ChainQualifiedRangeConfigZod.shape),
@@ -25,7 +30,9 @@ export const TransactionInvalidationConfigZod = z.union([
   z.object({}),
 ])
 
+/** TransactionInvalidationConfig type. */
 export type TransactionInvalidationConfig = z.infer<typeof TransactionInvalidationConfigZod>
+/** Type guard that checks if a value is a valid TransactionInvalidationConfig. */
 export const isTransactionInvalidationConfig = zodIsFactory(TransactionInvalidationConfigZod)
 
 /**
@@ -39,9 +46,12 @@ export interface TransactionInvalidationViewerMethods {
   ): Promisable<[(HydratedTransactionValidationError[] | SignedHydratedTransactionWithHashMeta)[], TransactionInvalidationQualification]>
 }
 
+/** Moniker identifier for the TransactionInvalidationViewer provider. */
 export const TransactionInvalidationViewerMoniker = 'TransactionInvalidationViewer' as const
+/** Type literal for the TransactionInvalidationViewer provider moniker. */
 export type TransactionInvalidationViewerMoniker = typeof TransactionInvalidationViewerMoniker
 
+/** Viewer interface for reading TransactionInvalidation data. */
 export interface TransactionInvalidationViewer extends TransactionInvalidationViewerMethods, Provider<TransactionInvalidationViewerMoniker> {
   invalidateTransaction(
     block: SignedHydratedTransaction,

package/src/viewers/TransactionValidation.ts

@@ -9,15 +9,20 @@ import {
 import type { Provider } from '../provider/index.ts'
 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),
@@ -25,9 +30,12 @@ export const TransactionValidationConfigZod = z.union([
   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[],
@@ -35,7 +43,9 @@ export interface TransactionValidationViewerMethods {
   ): 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
 
 /**

package/src/viewers/TransferBalance.ts

@@ -8,13 +8,16 @@ import type { TransactionBoundWitness } from '../transaction/index.ts'
 import type { Transfer } from '../TransferPayload.ts'
 import type { AttoXL1 } from '../xl1/index.ts'
 
+/** 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[]>>>>
@@ -22,9 +25,12 @@ export interface TransferBalancesViewerMethods {
   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[]>