@xyo-network/xl1-protocol 1.25.26 → 1.25.28

package/src/model/version.ts

@@ -1,5 +1,10 @@
+/** XL1_PROTOCOL_VERSION_MAJOR constant. */
 export const XL1_PROTOCOL_VERSION_MAJOR = 1 as const
+/** XL1_PROTOCOL_VERSION_MINOR constant. */
 export const XL1_PROTOCOL_VERSION_MINOR = 2 as const
+/** XL1_PROTOCOL_VERSION_PATCH constant. */
 export const XL1_PROTOCOL_VERSION_PATCH = 0 as const
+/** XL1_PROTOCOL_VERSION_STRING constant. */
 export const XL1_PROTOCOL_VERSION_STRING = `${XL1_PROTOCOL_VERSION_MAJOR}.${XL1_PROTOCOL_VERSION_MINOR}.${XL1_PROTOCOL_VERSION_PATCH}` as const
+/** XL1_PROTOCOL_VERSION constant. */
 export const XL1_PROTOCOL_VERSION = XL1_PROTOCOL_VERSION_MAJOR * 1_000_000 + XL1_PROTOCOL_VERSION_MINOR * 1000 + XL1_PROTOCOL_VERSION_PATCH

package/src/network/NetworkId.ts

@@ -1,4 +1,6 @@
 import type { GatewayName } from '../model/index.ts'
 
+/** Default network identifiers for mainnet, sequence, and local environments. */
 export type DefaultNetworkIds = ('mainnet' & { __gatewayName: true }) | ('sequence' & { __gatewayName: true }) | ('local' & { __gatewayName: true })
+/** A network identifier, either a custom gateway name or one of the default network IDs. */
 export type NetworkId<T extends GatewayName | void = void> = | T extends void ? DefaultNetworkIds : T | DefaultNetworkIds

package/src/network/Status.ts

@@ -1,23 +1,30 @@
 import type { Payload } from '@xyo-network/sdk-js'
 import { asSchema, isPayloadOfSchemaType } from '@xyo-network/sdk-js'
 
+/** Schema identifier for network status payloads. */
 export const NetworkStatusSchema = asSchema('network.xyo.chain.status', true)
+/** Schema type for NetworkStatus payloads. */
 export type NetworkStatusSchema = typeof NetworkStatusSchema
 
+/** Possible states of the network: online, offline, degraded, or unknown. */
 export type NetworkStatusState = 'online' | 'offline' | 'degraded' | 'unknown'
 
+/** Represents a single network status update with a time range and description. */
 export type NetworkStatusUpdate = {
   end: number
   start: number
   update: string
 }
 
+/** Fields describing the current network status, including state and optional updates. */
 export interface NetworkStatusFields {
   description: string
   state: NetworkStatusState
   updates?: NetworkStatusUpdate[]
 }
 
+/** A payload representing the current network status. */
 export type NetworkStatus = Payload<NetworkStatusFields, NetworkStatusSchema>
 
+/** Type guard that checks whether a value is a NetworkStatus payload. */
 export const isNetworkStatus = isPayloadOfSchemaType<NetworkStatus>(NetworkStatusSchema)

package/src/payload/StepIdentityPayload.ts

@@ -5,9 +5,12 @@ import type { z } from 'zod'
 
 import { StepIdentityZod } from '../Step/index.ts'
 
+/** Schema identifier for step identity payloads. */
 export const StepIdentitySchema = asSchema('network.xyo.chain.step.identity', true)
+/** Schema type for StepIdentity payloads. */
 export type StepIdentitySchema = typeof StepIdentitySchema
 
+/** Fields for a step identity, inferred from the StepIdentityZod schema. */
 export type StepIdentityFields = z.infer<typeof StepIdentityZod>
 
 /**
@@ -15,6 +18,8 @@ export type StepIdentityFields = z.infer<typeof StepIdentityZod>
  */
 export type StepIdentityPayload = Payload<StepIdentityFields, StepIdentitySchema>
 
+/** Type guard that checks whether a value is a StepIdentityPayload. */
 export const isStepIdentityPayload = isPayloadOfZodType<StepIdentityPayload>(StepIdentityZod, StepIdentitySchema)
 
+/** Casts a value to StepIdentityPayload or returns undefined if it does not match. */
 export const asStepIdentityPayload = AsObjectFactory.create(isStepIdentityPayload)

package/src/payload/elevatable/Bridge/BridgeDestinationObservation.ts

@@ -5,7 +5,9 @@ import type { z } from 'zod'
 
 import { BridgeDetailsFieldsZod } from './BridgeDetails.ts'
 
+/** Schema identifier for BridgeDestinationObservation payloads. */
 export const BridgeDestinationObservationSchema = asSchema('network.xyo.chain.bridge.observation.destination', true)
+/** Schema type for BridgeDestinationObservation payloads. */
 export type BridgeDestinationObservationSchema = typeof BridgeDestinationObservationSchema
 
 /**
@@ -18,6 +20,7 @@ export const BridgeDestinationObservationFieldsZod = BridgeDetailsFieldsZod.exte
   destConfirmation: HexZod.optional().describe('Destination chain confirmation'),
 })
 
+/** BridgeDestinationObservationFields type. */
 export type BridgeDestinationObservationFields = z.infer<typeof BridgeDestinationObservationFieldsZod>
 
 /**
@@ -25,9 +28,11 @@ export type BridgeDestinationObservationFields = z.infer<typeof BridgeDestinatio
  */
 export type BridgeDestinationObservation = Payload<BridgeDestinationObservationFields, BridgeDestinationObservationSchema>
 
+/** Type guard that checks if a value is a valid BridgeDestinationObservation. */
 export const isBridgeDestinationObservation = isPayloadOfZodType<BridgeDestinationObservation>(
   BridgeDestinationObservationFieldsZod,
   BridgeDestinationObservationSchema,
 )
 
+/** Converts a value to BridgeDestinationObservation, throwing if invalid. */
 export const asBridgeDestinationObservation = AsObjectFactory.create(isBridgeDestinationObservation)

package/src/payload/elevatable/Bridge/BridgeIntent.ts

@@ -5,7 +5,9 @@ import { z } from 'zod'
 
 import { BridgeDetailsFieldsZod } from './BridgeDetails.ts'
 
+/** Schema identifier for BridgeIntent payloads. */
 export const BridgeIntentSchema = asSchema('network.xyo.chain.bridge.intent', true)
+/** Schema type for BridgeIntent payloads. */
 export type BridgeIntentSchema = typeof BridgeIntentSchema
 
 /**
@@ -18,13 +20,17 @@ export const BridgeIntentFieldsZod = BridgeDetailsFieldsZod.extend({
   nonce: z.string().describe('Unique identifier for replay protection'),
 })
 
+/** BridgeIntentFields type. */
 export type BridgeIntentFields = z.infer<typeof BridgeIntentFieldsZod>
 
+/** BridgeIntent type. */
 export type BridgeIntent = Payload<BridgeIntentFields, BridgeIntentSchema>
 
+/** Type guard that checks if a value is a valid BridgeIntent. */
 export const isBridgeIntent = isPayloadOfZodType<BridgeIntent>(
   BridgeIntentFieldsZod,
   BridgeIntentSchema,
 )
 
+/** Converts a value to BridgeIntent, throwing if invalid. */
 export const asBridgeIntent = AsObjectFactory.create(isBridgeIntent)

package/src/payload/elevatable/Bridge/BridgeSourceObservation.ts

@@ -5,7 +5,9 @@ import type { z } from 'zod'
 
 import { BridgeDetailsFieldsZod } from './BridgeDetails.ts'
 
+/** Schema identifier for BridgeSourceObservation payloads. */
 export const BridgeSourceObservationSchema = asSchema('network.xyo.chain.bridge.observation.source', true)
+/** Schema type for BridgeSourceObservation payloads. */
 export type BridgeSourceObservationSchema = typeof BridgeSourceObservationSchema
 
 /**
@@ -18,15 +20,18 @@ export const BridgeSourceObservationFieldsZod = BridgeDetailsFieldsZod.extend({
   srcConfirmation: HexZod.optional().describe('Source chain confirmation'),
 })
 
+/** BridgeSourceObservationFields type. */
 export type BridgeSourceObservationFields = z.infer<typeof BridgeSourceObservationFieldsZod>
 /**
  * Represents an observation that confirms a bridge action occurred on the source chain.
  */
 export type BridgeSourceObservation = Payload<BridgeSourceObservationFields, BridgeSourceObservationSchema>
 
+/** Type guard that checks if a value is a valid BridgeSourceObservation. */
 export const isBridgeSourceObservation = isPayloadOfZodType<BridgeSourceObservation>(
   BridgeSourceObservationFieldsZod,
   BridgeSourceObservationSchema,
 )
 
+/** Converts a value to BridgeSourceObservation, throwing if invalid. */
 export const asBridgeSourceObservation = AsObjectFactory.create(isBridgeSourceObservation)

package/src/payload/elevatable/ChainStakeIntent.ts

@@ -7,11 +7,15 @@ import {
 import type { BlockDuration } from '../../fields/index.ts'
 import type { FromFields } from './Executable.ts'
 
+/** Schema identifier for chain stake intent payloads. */
 export const ChainStakeIntentSchema = asSchema('network.xyo.chain.stake.intent', true)
+/** Schema type for ChainStakeIntent payloads. */
 export type ChainStakeIntentSchema = typeof ChainStakeIntentSchema
 
+/** The type of staking intent, currently limited to 'producer'. */
 export type Intent = 'producer' // | 'bank'
 
+/** Fields for a chain stake intent, including the staking intent type and source address. */
 export interface ChainStakeIntentFields extends BlockDuration, FromFields {
   /*
   * The intent of the staking
@@ -19,15 +23,19 @@ export interface ChainStakeIntentFields extends BlockDuration, FromFields {
   intent: Intent
 }
 
+/** A payload representing an intent to stake on the chain. */
 export type ChainStakeIntent = Payload<ChainStakeIntentFields, ChainStakeIntentSchema>
 
+/** Type guard that checks whether a value is a valid ChainStakeIntent with non-negative nbf and exp. */
 export const isChainStakeIntent = (x?: unknown | null): x is ChainStakeIntent => {
   return isPayloadOfSchemaType<ChainStakeIntent>(ChainStakeIntentSchema)(x)
     && asNonNegativeInteger(x.nbf) !== undefined
     && asNonNegativeInteger(x.exp) !== undefined
 }
+/** Casts a value to ChainStakeIntent or returns undefined if it does not match. */
 export const asChainStakeIntent = AsObjectFactory.create(isChainStakeIntent)
 
+/** Type guard that checks whether a value is a ChainStakeIntent with storage metadata. */
 export const isChainStakeIntentWithStorageMeta = (x?: unknown | null): x is WithStorageMeta<ChainStakeIntent> => {
   return isChainStakeIntent(x) && isStorageMeta(x)
 }

package/src/payload/elevatable/Executable.ts

@@ -1,26 +1,33 @@
 import type { Address, EmptyObject } from '@xylabs/sdk-js'
 import { isAnyPayload } from '@xyo-network/sdk-js'
 
+/** FromFields interface. */
 export interface FromFields {
   // the address that is treated as the source of this action
   from: Address
 }
 
+/** hasFrom constant. */
 export const hasFrom = (value: unknown): value is FromFields => {
   return (value as FromFields).from !== undefined
 }
 
+/** ExecutableFields interface. */
 export interface ExecutableFields {
   script: string[]
 }
 
+/** Executable type. */
 export type Executable<T extends EmptyObject = EmptyObject> = T & ExecutableFields
+/** OptionalExecutable type. */
 export type OptionalExecutable<T extends EmptyObject = EmptyObject> = T & Partial<ExecutableFields>
 
+/** Type guard that checks if a value is a valid Executable. */
 export const isExecutable = <T extends EmptyObject>(value: T | undefined): value is Executable<T> => {
   return isAnyPayload(value) && Array.isArray((value as unknown as ExecutableFields).script)
 }
 
+/** Converts a value to Executable, throwing if invalid. */
 export const asExecutable = <T extends EmptyObject>(value: T | undefined): Executable<T> | undefined => {
   return isExecutable(value)
     ? value as unknown as Executable<T>

package/src/payload/elevatable/Hash.ts

@@ -3,16 +3,23 @@ import { AsObjectFactory } from '@xylabs/sdk-js'
 import type { Payload } from '@xyo-network/sdk-js'
 import { asSchema, isPayloadOfSchemaType } from '@xyo-network/sdk-js'
 
+/** Schema identifier for hash payloads. */
 export const HashSchema = asSchema('network.xyo.hash', true)
+/** Schema type for Hash payloads. */
 export type HashSchema = typeof HashSchema
 
+/** Fields for a hash payload containing a single hash value. */
 export interface HashFields {
   hash: Hash
 }
 
+/** A payload containing a hash value. */
 export type HashPayload = Payload<HashFields, HashSchema>
 
+/** Type guard that checks whether a value is a HashPayload. */
 export const isHashPayload = isPayloadOfSchemaType<HashPayload>(HashSchema)
 
+/** Casts a value to HashPayload or returns undefined if it does not match. */
 export const asHashPayload = AsObjectFactory.create(isHashPayload)
+/** Casts a value to HashPayload with storage metadata or returns undefined. */
 export const asHashPayloadWithStorageMeta = AsObjectFactory.create(isHashPayload)

package/src/payload/elevatable/StepComplete.ts

@@ -5,7 +5,9 @@ import { asSchema, isPayloadOfSchemaType } from '@xyo-network/sdk-js'
 
 import type { FromFields } from './Executable.ts'
 
+/** Schema identifier for StepComplete payloads. */
 export const StepCompleteSchema = asSchema('network.xyo.chain.step.complete', true)
+/** Schema type for StepComplete payloads. */
 export type StepCompleteSchema = typeof StepCompleteSchema
 
 /* This records the completion of a step in the network - needed for network staking rewards */
@@ -19,8 +21,11 @@ export interface StepCompleteFields extends FromFields {
 }
 
 // if this payload is included in a boundwitness, it needs to be available for inspection to be included in block
+/** StepComplete type. */
 export type StepComplete = Payload<StepCompleteFields, StepCompleteSchema>
 
+/** Type guard that checks if a value is a valid StepComplete. */
 export const isStepComplete = isPayloadOfSchemaType<StepComplete>(StepCompleteSchema)
 
+/** Converts a value to StepComplete, throwing if invalid. */
 export const asStepComplete = AsObjectFactory.create(isStepComplete)

package/src/payload/elevatable/Time.ts

@@ -5,11 +5,15 @@ import {
 import { z } from 'zod'
 
 // xl1 = xl1 block number, epoch = epoch number, ethereum = ethereum block number
+/** Supported time domains: xl1 block number, epoch timestamp, or ethereum block number. */
 export type TimeDomain = 'xl1' | 'epoch' | 'ethereum'
 
+/** Schema identifier for time payloads. */
 export const TimeSchema = asSchema('network.xyo.time', true)
+/** Schema type for Time payloads. */
 export type TimeSchema = typeof TimeSchema
 
+/** Zod schema for XL1 time fields including block number and hash. */
 export const XL1TimeFieldsZod = z.object({
   // block number
   xl1: z.number().optional(),
@@ -17,6 +21,7 @@ export const XL1TimeFieldsZod = z.object({
   xl1Hash: HashZod.optional(),
 })
 
+/** Zod schema for Ethereum time fields including block number and hash. */
 export const EthereumTimeFieldsZod = z.object({
   // block number
   ethereum: z.number().optional(),
@@ -24,25 +29,33 @@ export const EthereumTimeFieldsZod = z.object({
   ethereumHash: HashZod.optional(),
 })
 
+/** Zod schema for epoch time fields in milliseconds. */
 export const EpochTimeFieldsZod = z.object({
   // in milliseconds
   epoch: z.number(),
 })
 
+/** Combined Zod schema for all time fields across XL1, Ethereum, and epoch domains. */
 export const TimeFieldsZod = XL1TimeFieldsZod.extend(XL1TimeFieldsZod.shape).extend(EthereumTimeFieldsZod.shape).extend(EpochTimeFieldsZod.shape)
 
+/** Zod schema for a complete time payload including schema and all time fields. */
 export const TimePayloadZod = PayloadZodOfSchema(TimeSchema).extend(TimeFieldsZod.shape)
 
+/** A payload containing time information across multiple domains. */
 export type TimePayload = z.infer<typeof TimePayloadZod>
 
 // to prevent scaling problems, we use double the current time as a max safe epoch
+/** Checks whether a value is a safe epoch timestamp (less than double the current time). */
 export const isSafeEpoch = (value: unknown): value is number => {
   return typeof value === 'number' && value < 2 * Date.now()
 }
 
+/** Type guard that checks whether a value is a valid TimePayload with a safe epoch. */
 export const isTimePayload = (value: unknown): value is TimePayload => {
   return isPayloadOfSchemaType<TimePayload>(TimeSchema)(value) && isSafeEpoch(value.epoch)
 }
 
+/** Casts a value to TimePayload or returns undefined if it does not match. */
 export const asTimePayload = AsObjectFactory.create(isTimePayload)
+/** Casts a value to TimePayload with storage metadata or returns undefined. */
 export const asTimePayloadWithStorageMeta = AsObjectFactory.create(isTimePayload)

package/src/permissions/InvokerPermission.ts

@@ -24,6 +24,7 @@ export interface RequestedPermission {
   parentCapability: string
 }
 
+/** CaveatTypes type. */
 export type CaveatTypes = 'chain' | 'expiration' | 'filteredResponse' | 'rateLimit' | 'restrictReturnedAccounts'
 
 /**
@@ -50,6 +51,7 @@ export interface Permission {
   parentCapability: string
 }
 
+/** InvokerPermission interface. */
 export interface InvokerPermission extends Permission {
   /** Time at which the permission was granted */
   date?: number

package/src/permissions/XyoPermissions.ts

@@ -37,4 +37,5 @@ export interface XyoPermissions extends PermissionsGetHandler, PermissionRequest
 }
 
 // @deprecated - use XyoPermissions instead
+/** PermissionsProvider interface. */
 export interface PermissionsProvider extends XyoPermissions {}

package/src/provider/Provider.ts

@@ -1,5 +1,6 @@
 import type { ProviderMoniker } from './ProviderMoniker.ts'
 
+/** Provider interface. */
 export interface Provider<T extends ProviderMoniker> {
   moniker: T
 }

package/src/provider/ProviderMoniker.ts

@@ -1,11 +1,15 @@
 import { assertEx, isString } from '@xylabs/sdk-js'
 
+/** Type literal for the Provider provider moniker. */
 export type ProviderMoniker = string
 
+/** Moniker identifier for the asProvider provider. */
 export const asProviderMoniker = <T>(value: T) => {
   const moniker = isString(value) ? (value as unknown as ProviderMoniker) : undefined
   return assertEx(moniker)
 }
 
+/** Moniker identifier for the DefaultProvider provider. */
 export const DefaultProviderMoniker = 'Provider' as const
+/** Type literal for the DefaultProvider provider moniker. */
 export type DefaultProviderMoniker = typeof DefaultProviderMoniker

package/src/providers/DataLake/Provider.ts

@@ -2,8 +2,10 @@ import type { Payload, Schema } from '@xyo-network/sdk-js'
 
 import type { Provider, ProviderMoniker } from '../../provider/index.ts'
 
+/** DataLakeData type. */
 export type DataLakeData = Payload | ArrayBuffer
 
+/** DataLakeProvider interface. */
 export interface DataLakeProvider<TMoniker extends ProviderMoniker = ProviderMoniker> extends Provider<TMoniker> {
   allowedSchemas?: Schema[]
   disallowedSchemas?: Schema[]

package/src/providers/DataLake/Runner.ts

@@ -4,9 +4,13 @@ import type { WriteArchivistFunctions } from '@xyo-network/sdk-js'
 import type { DataLakeData, DataLakeProvider } from './Provider.ts'
 import type { DataLakeViewer, DataLakeViewerMethods } from './Viewer.ts'
 
+/** Moniker identifier for the DataLakeRunner provider. */
 export const DataLakeRunnerMoniker = 'DataLakeRunner' as const
+/** Type literal for the DataLakeRunner provider moniker. */
 export type DataLakeRunnerMoniker = typeof DataLakeRunnerMoniker
 
+/** DataLakeRunnerMethods interface. */
 export interface DataLakeRunnerMethods extends WriteArchivistFunctions<DataLakeData, DataLakeData, DataLakeData, Hash>, DataLakeViewerMethods {}
 
+/** Runner interface for executing DataLake operations. */
 export interface DataLakeRunner extends DataLakeProvider<DataLakeRunnerMoniker>, DataLakeRunnerMethods, Omit<DataLakeViewer, 'moniker'> {}

package/src/providers/DataLake/Viewer.ts

@@ -3,10 +3,14 @@ import type { ReadArchivistFunctions, Sequence } from '@xyo-network/sdk-js'
 
 import type { DataLakeData, DataLakeProvider } from './Provider.ts'
 
+/** Moniker identifier for the DataLakeViewer provider. */
 export const DataLakeViewerMoniker = 'DataLakeViewer' as const
+/** Type literal for the DataLakeViewer provider moniker. */
 export type DataLakeViewerMoniker = typeof DataLakeViewerMoniker
 
+/** DataLakeViewerMethods interface. */
 export interface DataLakeViewerMethods extends ReadArchivistFunctions<DataLakeData, Hash, Sequence> {}
 
+/** Viewer interface for reading DataLake data. */
 export interface DataLakeViewer extends DataLakeProvider<DataLakeViewerMoniker>, DataLakeViewerMethods {
 }

package/src/providers/TransactionHelper.ts

@@ -3,6 +3,7 @@ import type { Payload } from '@xyo-network/sdk-js'
 
 import type { UnsignedHydratedTransaction } from '../model/index.ts'
 
+/** TransactionHelper interface. */
 export interface TransactionHelper {
   // build tx, sign tx, send tx
   addPayloadsToChain(onChain: Payload[], offChain: Payload[]): void

package/src/providers/XyoClient.ts

@@ -14,6 +14,7 @@ export interface XyoRpcGatewayConfig extends XyoGatewayConfig {
   networkEndpoint: string
 }
 
+/** XyoClient interface. */
 export interface XyoClient {
   gateways: Readonly<Partial<Record<GatewayName, XyoGatewayRunner>>>
   permissions: XyoPermissions

package/src/providers/XyoConnection.ts

@@ -4,9 +4,12 @@ import type { DataLakeRunner, DataLakeViewer } from './DataLake/index.ts'
 import type { XyoNetwork } from './XyoNetwork.ts'
 import type { XyoRunner } from './XyoRunner.ts'
 
+/** Moniker identifier for the XyoConnection provider. */
 export const XyoConnectionMoniker = 'XyoConnection' as const
+/** Type literal for the XyoConnection provider moniker. */
 export type XyoConnectionMoniker = typeof XyoConnectionMoniker
 
+/** XyoConnection interface. */
 export interface XyoConnection extends Provider<XyoConnectionMoniker> {
   network?: XyoNetwork
   networkStake?: NetworkStakeViewer

package/src/providers/XyoGateway.ts

@@ -1,11 +1,15 @@
 import type { Provider, ProviderMoniker } from '../provider/index.ts'
 import type { XyoConnection } from './XyoConnection.ts'
 
+/** Moniker identifier for the XyoGateway provider. */
 export const XyoGatewayMoniker = 'XyoGateway' as const
+/** Type literal for the XyoGateway provider moniker. */
 export type XyoGatewayMoniker = typeof XyoGatewayMoniker
 
+/** XyoGatewayMethods interface. */
 export interface XyoGatewayMethods {}
 
+/** XyoGatewayProvider interface. */
 export interface XyoGatewayProvider<
   TMoniker extends ProviderMoniker = ProviderMoniker> extends XyoGatewayMethods, Provider<TMoniker> {
   /**
@@ -14,5 +18,6 @@ export interface XyoGatewayProvider<
   connection: XyoConnection
 }
 
+/** XyoGateway interface. */
 export interface XyoGateway extends XyoGatewayProvider<XyoGatewayMoniker>, Provider<XyoGatewayMoniker> {
 }

package/src/providers/XyoGatewayRunner.ts

@@ -15,6 +15,7 @@ import type { AttoXL1 } from '../xl1/index.ts'
 import type { XyoSigner } from './signer/index.ts'
 import type { XyoGatewayProvider } from './XyoGateway.ts'
 
+/** ConfirmSubmittedTransactionOptions type. */
 export type ConfirmSubmittedTransactionOptions = {
   /**
    * Number of attempts to confirm the transaction.
@@ -32,6 +33,7 @@ export type ConfirmSubmittedTransactionOptions = {
   logger?: Logger
 }
 
+/** Options for Transaction. */
 export interface TransactionOptions {
   chain?: ChainId
   exp?: XL1BlockNumber
@@ -40,9 +42,12 @@ export interface TransactionOptions {
   nbf?: XL1BlockNumber
 }
 
+/** Moniker identifier for the XyoGatewayRunner provider. */
 export const XyoGatewayRunnerMoniker = 'XyoGatewayRunner' as const
+/** Type literal for the XyoGatewayRunner provider moniker. */
 export type XyoGatewayRunnerMoniker = typeof XyoGatewayRunnerMoniker
 
+/** XyoGatewayRunnerMethods interface. */
 export interface XyoGatewayRunnerMethods {
 
   addPayloadsToChain(
@@ -62,6 +67,7 @@ export interface XyoGatewayRunnerMethods {
   sendMany(transfers: Record<Address, AttoXL1>, options?: TransactionOptions): Promisable<Hash>
 }
 
+/** Runner interface for executing XyoGateway operations. */
 export interface XyoGatewayRunner extends XyoGatewayRunnerMethods, XyoGatewayProvider<XyoGatewayRunnerMoniker> {
   /**
    * Returns the signer for this gateway.

package/src/providers/XyoNetwork.ts

@@ -2,6 +2,7 @@ import type { Promisable } from '@xylabs/sdk-js'
 
 import type { NetworkStatus } from '../network/index.ts'
 
+/** XyoNetwork interface. */
 export interface XyoNetwork {
   status(): Promisable<NetworkStatus>
 }

package/src/providers/XyoRunner.ts

@@ -4,13 +4,17 @@ import type { SignedHydratedTransaction } from '../model/index.ts'
 import type { Provider } from '../provider/index.ts'
 import type { MempoolRunner } from '../runners/index.ts'
 
+/** XyoRunnerMethods interface. */
 export interface XyoRunnerMethods {
   broadcastTransaction(transaction: SignedHydratedTransaction): Promisable<Hash>
 }
 
+/** Moniker identifier for the XyoRunner provider. */
 export const XyoRunnerMoniker = 'XyoRunner' as const
+/** Type literal for the XyoRunner provider moniker. */
 export type XyoRunnerMoniker = typeof XyoRunnerMoniker
 
+/** Runner interface for executing Xyo operations. */
 export interface XyoRunner extends XyoRunnerMethods, Provider<XyoRunnerMoniker> {
   mempool: MempoolRunner
 }

package/src/providers/signer/XyoSigner.ts

@@ -7,9 +7,12 @@ import type { SignedHydratedTransactionWithHashMeta } from '../../model/index.ts
 import type { Provider } from '../../provider/index.ts'
 import type { TransactionBoundWitness, TransactionFeesBigInt } from '../../transaction/index.ts'
 
+/** Moniker identifier for the XyoSigner provider. */
 export const XyoSignerMoniker = 'XyoSigner' as const
+/** Type literal for the XyoSigner provider moniker. */
 export type XyoSignerMoniker = typeof XyoSignerMoniker
 
+/** XyoSignerMethods interface. */
 export interface XyoSignerMethods {
   address(): Promisable<Address>
   // The tx passed in must have all the payloads (on and off chain) in the payloads array
@@ -18,8 +21,10 @@ export interface XyoSignerMethods {
   signTransaction(tx: [TransactionBoundWitness, Payload[]]): Promisable<SignedHydratedTransactionWithHashMeta>
 }
 
+/** XyoSigner interface. */
 export interface XyoSigner extends XyoSignerMethods, Provider<XyoSignerMoniker> {}
 
+/** XyoSignerDeprecated interface. */
 export interface XyoSignerDeprecated {
   /** @deprecated use signTransaction instead */
   createSignedTransaction(

package/src/repository/Repository.ts

@@ -3,23 +3,30 @@ import type {
   NextOptions, Payload, WithStorageMeta,
 } from '@xyo-network/sdk-js'
 
+/** ReadRepository interface. */
 export interface ReadRepository<TId, TData> {
   get(id: TId): Promisable<TData>
 }
 
+/** IterableRepository interface. */
 export interface IterableRepository<TId, TData> {
   next(id: TId): Promisable<TData>
 }
 
+/** WriteRepository interface. */
 export interface WriteRepository<TData, TResp> {
   insert(data: TData): Promisable<TResp>
 }
 
+/** PayloadReadRepository interface. */
 export interface PayloadReadRepository<TId = Hash, TData extends Payload = Payload> extends ReadRepository<TId[], WithStorageMeta<TData>[]> {}
+/** PayloadWriteRepository interface. */
 export interface PayloadWriteRepository<TData extends Payload = Payload> extends WriteRepository<TData[], WithStorageMeta<TData>[]> {}
 
+/** PayloadIterableRepository interface. */
 export interface PayloadIterableRepository<TId = Hash, TData extends Payload = Payload>
   extends IterableRepository<NextOptions<TId>, WithStorageMeta<TData>[]> {}
 
+/** PayloadRepository interface. */
 export interface PayloadRepository<TId = Hash, TData extends Payload = Payload>
   extends PayloadReadRepository<TId, TData>, PayloadWriteRepository<TData>, PayloadIterableRepository<TId, TData> {}

package/src/repository/TransactionReadRepository.ts

@@ -2,4 +2,5 @@ import type { SignedHydratedTransaction } from '../model/index.ts'
 import type { TransactionBoundWitness } from '../transaction/index.ts'
 import type { ReadRepository } from './Repository.ts'
 
+/** TransactionReadRepository interface. */
 export interface TransactionReadRepository extends ReadRepository<TransactionBoundWitness, SignedHydratedTransaction | undefined> {}

package/src/repository/TransactionRepository.ts

@@ -2,8 +2,11 @@ import type { TransactionReadRepository } from './TransactionReadRepository.ts'
 import type { TransactionRepositoryIterator } from './TransactionRepositoryIterator.ts'
 import type { TransactionWriteRepository } from './TransactionWriteRepository.ts'
 
+/** TransactionRepository interface. */
 export interface TransactionRepository extends TransactionReadRepository, TransactionWriteRepository {}
 
+/** ReadonlyIterableTransactionRepository interface. */
 export interface ReadonlyIterableTransactionRepository extends TransactionReadRepository, TransactionRepositoryIterator {}
 
+/** IterableTransactionRepository interface. */
 export interface IterableTransactionRepository extends TransactionRepository, TransactionRepositoryIterator {}

package/src/repository/TransactionRepositoryIterator.ts

@@ -2,4 +2,5 @@ import type { SignedHydratedTransactionWithStorageMeta } from '../model/index.ts
 import type { TransactionBoundWitness } from '../transaction/index.ts'
 import type { IterableRepository } from './Repository.ts'
 
+/** TransactionRepositoryIterator interface. */
 export interface TransactionRepositoryIterator extends IterableRepository<TransactionBoundWitness, SignedHydratedTransactionWithStorageMeta | undefined> {}

package/src/repository/TransactionWriteRepository.ts

@@ -1,4 +1,5 @@
 import type { SignedHydratedTransaction } from '../model/index.ts'
 import type { WriteRepository } from './Repository.ts'
 
+/** TransactionWriteRepository interface. */
 export interface TransactionWriteRepository extends WriteRepository<SignedHydratedTransaction, boolean> {}