@xyo-network/xl1-protocol-sdk 1.17.2 → 1.17.6

package/src/simple/chainStake/SimpleChainStakeViewer.ts

@@ -1,25 +1,31 @@
 import {
   type Address, asAddress, toAddress,
 } from '@xylabs/sdk-js'
-import {
-  AbstractCreatable, assertEx,
-  creatable, CreatableParams,
-} from '@xylabs/sdk-js'
+import { assertEx } from '@xylabs/sdk-js'
 import { Account } from '@xyo-network/account'
 
+import {
+  AbstractCreatableProvider, creatableProvider, CreatableProviderParams,
+} from '../../CreatableProvider/index.ts'
 import { PayloadMap, Position } from '../../model/index.ts'
-import { StakeEventsViewer, StakeViewer } from '../../viewers/index.ts'
+import {
+  StakeEventsViewer, StakeViewer, StakeViewerMoniker,
+} from '../../viewers/index.ts'
 import { SimpleChainStakeEventsViewer } from '../chainStakeEvents/index.ts'
 
-export interface SimpleChainStakeParams extends CreatableParams {
+export interface SimpleChainStakeParams extends CreatableProviderParams {
   chainId?: Address
   chainMap: PayloadMap
   minWithdrawalBlocks?: number
   positions: Position[]
 }
 
-@creatable()
-export class SimpleChainStakeViewer extends AbstractCreatable<SimpleChainStakeParams> implements StakeViewer {
+@creatableProvider()
+export class SimpleChainStakeViewer extends AbstractCreatableProvider<SimpleChainStakeParams> implements StakeViewer {
+  static readonly defaultMoniker = StakeViewerMoniker
+  static readonly monikers = [StakeViewerMoniker]
+  moniker = SimpleChainStakeViewer.defaultMoniker
+
   private _chainId: Address | undefined
   private _chainStakeEventsViewer: StakeEventsViewer | undefined
 

package/src/simple/chainStakeEvents/SimpleChainStakeEventsViewer.ts

@@ -1,19 +1,24 @@
-import {
-  AbstractCreatable,
-  creatable, CreatableParams, isDefined,
-} from '@xylabs/sdk-js'
+import { isDefined } from '@xylabs/sdk-js'
 
+import {
+  AbstractCreatableProvider, creatableProvider, CreatableProviderParams,
+} from '../../CreatableProvider/index.ts'
 import { Position } from '../../model/index.ts'
 import {
   StakeEvent, StakeEventFilter, StakeEventName, StakeEventsViewer,
+  StakeEventsViewerMoniker,
 } from '../../viewers/index.ts'
 
-export interface SimpleChainStakeEventsParams extends CreatableParams {
+export interface SimpleChainStakeEventsParams extends CreatableProviderParams {
   positions: Position[]
 }
 
-@creatable()
-export class SimpleChainStakeEventsViewer extends AbstractCreatable<SimpleChainStakeEventsParams> implements StakeEventsViewer {
+@creatableProvider()
+export class SimpleChainStakeEventsViewer extends AbstractCreatableProvider<SimpleChainStakeEventsParams> implements StakeEventsViewer {
+  static readonly defaultMoniker = StakeEventsViewerMoniker
+  static readonly monikers = [StakeEventsViewerMoniker]
+  moniker = SimpleChainStakeEventsViewer.defaultMoniker
+
   protected get positions() {
     return this.params.positions
   }

package/src/simple/datalake/AbstractSimpleDataLake.ts

@@ -0,0 +1,64 @@
+import type { Hash } from '@xylabs/sdk-js'
+import { isAnyPayload, type Schema } from '@xyo-network/payload-model'
+
+import { AbstractCreatableProvider, type CreatableProviderParams } from '../../CreatableProvider/index.ts'
+import type { MapTypeRead, MapTypeWrite } from '../../map/index.ts'
+import { type DataLakeData } from '../../provider/index.ts'
+
+export interface AbstractSimpleDataLakeParams<TMap extends
+  MapTypeRead<Hash, DataLakeData> | MapTypeWrite<Hash, DataLakeData> = MapTypeRead<Hash, DataLakeData> | MapTypeWrite<Hash, DataLakeData>> extends
+  CreatableProviderParams {
+
+  allowedSchemas?: Schema[]
+  disallowedSchemas?: Schema[]
+  map: TMap
+}
+
+export class AbstractSimpleDataLake<TParams extends AbstractSimpleDataLakeParams = AbstractSimpleDataLakeParams> extends AbstractCreatableProvider<TParams> {
+  get allowedSchemas(): Schema[] | undefined {
+    return this.params.allowedSchemas
+  }
+
+  get disallowedSchemas(): Schema[] | undefined {
+    return this.params.disallowedSchemas
+  }
+
+  protected get map(): TParams['map'] {
+    return this.params.map
+  }
+
+  // async get(hash: Hash): Promise<DataLakeData | undefined> {
+  //   const result = await this.map.get(hash)
+  //   return this.isAllowed(result) ? result : undefined
+  // }
+
+  // async getMany(hashes: Hash[]): Promise<DataLakeData[]> {
+  //   const result = await this.map.getMany(hashes)
+  //   return result.filter(data => this.isAllowed(data))
+  // }
+
+  // async has(hash: Hash): Promise<boolean> {
+  //   const value = await this.get(hash)
+  //   if (isAnyPayload(value)) {
+  //     return this.isAllowed(value)
+  //   }
+  //   return value !== undefined
+  // }
+
+  protected isAllowed(value: DataLakeData | undefined): boolean {
+    if (isAnyPayload(value)) {
+      return this.isAllowedSchema(value.schema)
+    }
+    return true
+  }
+
+  protected isAllowedSchema(schema: Schema): boolean {
+    if (this.allowedSchemas && !this.allowedSchemas.includes(schema)) {
+      return false
+    }
+    if (this.disallowedSchemas && this.disallowedSchemas.includes(schema)) {
+      return false
+    }
+    return true
+  }
+}

package/src/simple/datalake/SimpleDataLakeRunner.ts

@@ -1,19 +1,22 @@
 import type { Hash } from '@xylabs/sdk-js'
 
-import type { MapType } from '../../map/index.ts'
-import type {
-  DataLakeData,
-  DataLakeRunner,
+import { creatableProvider } from '../../CreatableProvider/index.ts'
+import type { MapTypeWrite } from '../../map/index.ts'
+import {
+  type DataLakeData,
+  type DataLakeRunner,
+  DataLakeRunnerMoniker,
 } from '../../provider/index.ts'
-import type { DataLakeViewerParams } from './SimpleDataLakeViewer.ts'
-import { SimpleDataLakeViewer } from './SimpleDataLakeViewer.ts'
+import { AbstractSimpleDataLake, AbstractSimpleDataLakeParams } from './AbstractSimpleDataLake.ts'
 
-export interface DataLakeRunnerParams extends DataLakeViewerParams<MapType<Hash, DataLakeData>> {}
+export interface DataLakeRunnerParams extends AbstractSimpleDataLakeParams<MapTypeWrite<Hash, DataLakeData>> {}
 
-export class SimpleDataLakeRunner<TParams extends DataLakeRunnerParams> extends SimpleDataLakeViewer<MapType<Hash, DataLakeData>> implements DataLakeRunner {
-  constructor(params: TParams) {
-    super(params)
-  }
+@creatableProvider()
+export class SimpleDataLakeRunner<TParams extends DataLakeRunnerParams> extends
+  AbstractSimpleDataLake<TParams> implements DataLakeRunner {
+  static readonly defaultMoniker = DataLakeRunnerMoniker
+  static readonly monikers = [DataLakeRunnerMoniker]
+  moniker = SimpleDataLakeRunner.defaultMoniker
 
   async clear(): Promise<void> {
     await this.map.clear()

package/src/simple/datalake/SimpleDataLakeViewer.ts

@@ -1,41 +1,25 @@
 import type { Hash } from '@xylabs/sdk-js'
-import { isAnyPayload, type Schema } from '@xyo-network/payload-model'
+import { isAnyPayload } from '@xyo-network/payload-model'
 
+import { creatableProvider } from '../../CreatableProvider/index.ts'
 import type { MapTypeRead } from '../../map/index.ts'
-import type {
-  DataLakeData,
-  DataLakeViewer,
+import {
+  type DataLakeData,
+  type DataLakeViewer,
+  DataLakeViewerMoniker,
 } from '../../provider/index.ts'
+import { AbstractSimpleDataLake, AbstractSimpleDataLakeParams } from './AbstractSimpleDataLake.ts'
 
-export interface DataLakeViewerParams<TMap extends MapTypeRead<Hash, DataLakeData> = MapTypeRead<Hash, DataLakeData>> {
-  allowedSchemas?: Schema[]
-  disallowedSchemas?: Schema[]
-  map: TMap
+export interface DataLakeViewerParams<TMap extends MapTypeRead<Hash, DataLakeData> = MapTypeRead<Hash, DataLakeData>> extends
+  AbstractSimpleDataLakeParams<TMap> {
 }
 
-export class SimpleDataLakeViewer<TMap extends MapTypeRead<Hash, DataLakeData> = MapTypeRead<Hash, DataLakeData>,
-  TParams extends DataLakeViewerParams<TMap> = DataLakeViewerParams<TMap>> implements DataLakeViewer {
-  private readonly _params: TParams
-
-  constructor(params: TParams) {
-    this._params = params
-  }
-
-  get allowedSchemas(): Schema[] | undefined {
-    return this._params.allowedSchemas
-  }
-
-  get disallowedSchemas(): Schema[] | undefined {
-    return this._params.disallowedSchemas
-  }
-
-  protected get map(): TMap {
-    return this._params.map
-  }
-
-  protected get params() {
-    return this._params
-  }
+@creatableProvider()
+export class SimpleDataLakeViewer<TParams extends DataLakeViewerParams = DataLakeViewerParams>
+  extends AbstractSimpleDataLake<TParams> implements DataLakeViewer {
+  static readonly defaultMoniker = DataLakeViewerMoniker
+  static readonly monikers = [DataLakeViewerMoniker]
+  moniker = SimpleDataLakeViewer.defaultMoniker
 
   async get(hash: Hash): Promise<DataLakeData | undefined> {
     const result = await this.map.get(hash)
@@ -54,21 +38,4 @@ export class SimpleDataLakeViewer<TMap extends MapTypeRead<Hash, DataLakeData> =
     }
     return value !== undefined
   }
-
-  protected isAllowed(value: DataLakeData | undefined): boolean {
-    if (isAnyPayload(value)) {
-      return this.isAllowedSchema(value.schema)
-    }
-    return true
-  }
-
-  protected isAllowedSchema(schema: Schema): boolean {
-    if (this.allowedSchemas && !this.allowedSchemas.includes(schema)) {
-      return false
-    }
-    if (this.disallowedSchemas && this.disallowedSchemas.includes(schema)) {
-      return false
-    }
-    return true
-  }
 }

package/src/simple/mempool/SimpleMempoolViewer.ts

@@ -1,7 +1,5 @@
 import {
-  AbstractCreatable,
   creatable,
-  CreatableParams,
   exists, isDefined, isHash,
 } from '@xylabs/sdk-js'
 import type { ArchivistInstance } from '@xyo-network/archivist-model'
@@ -10,19 +8,25 @@ import {
 } from '@xyo-network/payload-model'
 import type { SignedHydratedBlockWithHashMeta, SignedHydratedTransactionWithHashMeta } from '@xyo-network/xl1-protocol'
 
+import { AbstractCreatableProvider, CreatableProviderParams } from '../../CreatableProvider/index.ts'
 import { bundledPayloadToHydratedBlock, bundledPayloadToHydratedTransaction } from '../../model/index.ts'
-import type {
-  MempoolViewer,
-  PendingTransactionsOptions,
+import {
+  type MempoolViewer,
+  MempoolViewerMoniker,
+  type PendingTransactionsOptions,
 } from '../../viewers/index.ts'
 
-export interface SimpleMempoolViewerParams extends CreatableParams {
+export interface SimpleMempoolViewerParams extends CreatableProviderParams {
   pendingBlocksArchivist: ArchivistInstance
   pendingTransactionsArchivist: ArchivistInstance
 }
 
 @creatable()
-export class SimpleMempoolViewer extends AbstractCreatable<SimpleMempoolViewerParams> implements MempoolViewer {
+export class SimpleMempoolViewer extends AbstractCreatableProvider<SimpleMempoolViewerParams> implements MempoolViewer {
+  static readonly defaultMoniker = MempoolViewerMoniker
+  static readonly monikers = [MempoolViewerMoniker]
+  moniker = SimpleMempoolViewer.defaultMoniker
+
   protected get pendingBlocksArchivist() {
     return this.params.pendingBlocksArchivist
   }

package/src/simple/timesync/SimpleTimeSyncViewer.ts

@@ -8,15 +8,28 @@ import {
 } from '@xyo-network/xl1-protocol'
 import type { Provider } from 'ethers'
 
-import type { BlockViewer, TimeSyncViewer } from '../../viewers/index.ts'
+import type { CreatableProviderParams } from '../../CreatableProvider/index.ts'
+import { AbstractCreatableProvider } from '../../CreatableProvider/index.ts'
+import {
+  type BlockViewer, type TimeSyncViewer, TimeSyncViewerMoniker,
+} from '../../viewers/index.ts'
+
+export interface SimpleTimeSyncViewerParams extends CreatableProviderParams {
+  blockViewer: BlockViewer
+  ethProvider?: Provider
+}
 
-export class SimpleTimeSyncViewer implements TimeSyncViewer {
-  protected readonly blockViewer: BlockViewer
-  protected readonly ethProvider?: Provider
+export class SimpleTimeSyncViewer extends AbstractCreatableProvider<SimpleTimeSyncViewerParams> implements TimeSyncViewer {
+  static readonly defaultMoniker = TimeSyncViewerMoniker
+  static readonly monikers = [TimeSyncViewerMoniker]
+  moniker = SimpleTimeSyncViewer.defaultMoniker
+
+  protected get blockViewer() {
+    return this.params.blockViewer
+  }
 
-  constructor(blockViewer: BlockViewer, ethProvider?: Provider) {
-    this.blockViewer = blockViewer
-    this.ethProvider = ethProvider
+  protected get ethProvider() {
+    return this.params.ethProvider
   }
 
   async convertTime(fromDomain: TimeDomain, toDomain: TimeDomain, from: number): Promise<number> {

package/src/summary/primitives/balances/balancesSummary.ts

@@ -1,6 +1,7 @@
 import type { Address } from '@xylabs/sdk-js'
-import { asAddress, isDefined } from '@xylabs/sdk-js'
-import { spanRootAsync } from '@xylabs/telemetry'
+import {
+  asAddress, isDefined, spanRootAsync,
+} from '@xylabs/sdk-js'
 import {
   asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber, asXL1BlockRange,
 } from '@xyo-network/xl1-protocol'

package/src/summary/primitives/schemas/schemasSummary.ts

@@ -1,5 +1,4 @@
-import { isDefined } from '@xylabs/sdk-js'
-import { spanRootAsync } from '@xylabs/telemetry'
+import { isDefined, spanRootAsync } from '@xylabs/sdk-js'
 import type { Schema } from '@xyo-network/payload-model'
 import {
   asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber, asXL1BlockRange,

package/src/summary/primitives/transfers/transfersSummary.ts

@@ -1,6 +1,7 @@
 import type { Address, Hash } from '@xylabs/sdk-js'
-import { asAddress, isDefined } from '@xylabs/sdk-js'
-import { spanRootAsync } from '@xylabs/telemetry'
+import {
+  asAddress, isDefined, spanRootAsync,
+} from '@xylabs/sdk-js'
 import {
   asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber, asXL1BlockRange,
 } from '@xyo-network/xl1-protocol'

package/src/transaction/hydrateTransaction.ts

@@ -6,7 +6,9 @@ import type {
   AllowedBlockPayload, SignedHydratedTransaction,
   SignedHydratedTransactionWithStorageMeta, TransactionBoundWitness,
 } from '@xyo-network/xl1-protocol'
-import { isAllowedBlockPayload, isSignedTransactionBoundWitnessWithStorageMeta } from '@xyo-network/xl1-protocol'
+import {
+  asSignedHydratedBlock, asSignedHydratedTransaction, isAllowedBlockPayload, isSignedTransactionBoundWitnessWithStorageMeta,
+} from '@xyo-network/xl1-protocol'
 
 import type { ChainStoreRead } from '../model/index.ts'
 
@@ -51,6 +53,21 @@ export const flattenHydratedTransaction = (hydratedTransaction: SignedHydratedTr
   return [...txPayloads, tx]
 }
 
+export const tryUnflattenHydratedTransaction = (
+  flattened: Payload[],
+): SignedHydratedTransaction | undefined => {
+  // Last element is always the transaction bound witness
+  const tx = flattened.at(-1)
+
+  // Everything else is a payloads
+  const txPayloads = flattened.slice(0, -1)
+
+  return asSignedHydratedTransaction([tx, txPayloads])
+}
+
+export const unflattenHydratedTransaction = (flattened: Payload[]): SignedHydratedTransaction =>
+  asSignedHydratedTransaction(tryUnflattenHydratedTransaction(flattened), true)
+
 export const flattenHydratedTransactions = (hydratedTransactions: SignedHydratedTransaction[]): Payload[] =>
   hydratedTransactions.flatMap(tx => flattenHydratedTransaction(tx))
 

package/src/viewers/AccountBalance.ts

@@ -10,7 +10,10 @@ import {
 import { BlockBoundWitnessZod, TransactionBoundWitnessZod } from '@xyo-network/xl1-protocol'
 import z from 'zod'
 
-import type { Qualified } from '../model/index.ts'
+import type {
+  Provider,
+  Qualified,
+} from '../model/index.ts'
 
 export const AccountBalanceHistoryItemZod = z.tuple([
   WithHashMetaZod(BlockBoundWitnessZod),
@@ -28,9 +31,12 @@ export interface AccountBalanceViewerMethods {
   qualifiedAccountBalances(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Qualified<Record<Address, AttoXL1>>>
 }
 
-export interface AccountBalanceViewer extends AccountBalanceViewerMethods {
+export interface AccountBalanceViewer extends AccountBalanceViewerMethods, Provider<AccountBalanceViewerMoniker> {
   accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>
   accountBalanceHistories(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Record<Address, AccountBalanceHistoryItem[]>>
   accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>
   accountBalances(address: Address[], headOrRange?: Hash | XL1BlockRange): Promisable<Record<Address, AttoXL1>>
 }
+
+export const AccountBalanceViewerMoniker = 'AccountBalanceViewer' as const
+export type AccountBalanceViewerMoniker = typeof AccountBalanceViewerMoniker

package/src/viewers/Block.ts

@@ -2,6 +2,8 @@ import type { Hash, Promisable } from '@xylabs/sdk-js'
 import type { Payload, WithHashMeta } from '@xyo-network/payload-model'
 import type { SignedHydratedBlockWithHashMeta, XL1BlockNumber } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../model/index.ts'
+
 export interface BlockViewerMethods {
   blocksByHash(hash: Hash, limit?: number): Promisable<SignedHydratedBlockWithHashMeta[]>
   blocksByNumber(block: XL1BlockNumber, limit?: number): Promisable<SignedHydratedBlockWithHashMeta[]>
@@ -9,7 +11,10 @@ export interface BlockViewerMethods {
   payloadsByHash(hashes: Hash[]): Promisable<WithHashMeta<Payload>[]>
 }
 
-export interface BlockViewer extends BlockViewerMethods {
+export const BlockViewerMoniker = 'BlockViewer' as const
+export type BlockViewerMoniker = typeof BlockViewerMoniker
+
+export interface BlockViewer extends BlockViewerMethods, Provider<BlockViewerMoniker> {
   blockByHash(hash: Hash): Promisable<SignedHydratedBlockWithHashMeta | null>
   blockByNumber(block: XL1BlockNumber): Promisable<SignedHydratedBlockWithHashMeta | null>
   currentBlockHash(): Promisable<Hash>

package/src/viewers/BlockReward.ts

@@ -1,9 +1,14 @@
 import type { Promisable } from '@xylabs/sdk-js'
 import type { AttoXL1, XL1BlockNumber } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../model/index.ts'
+
 export interface BlockRewardViewerMethods {
   // The amount of xl1 to send to the producer from the block reward
   allowedRewardForBlock(block: XL1BlockNumber): Promisable<AttoXL1>
 }
 
-export interface BlockRewardViewer extends BlockRewardViewerMethods {}
+export const BlockRewardViewerMoniker = 'BlockRewardViewer' as const
+export type BlockRewardViewerMoniker = typeof BlockRewardViewerMoniker
+
+export interface BlockRewardViewer extends BlockRewardViewerMethods, Provider<BlockRewardViewerMoniker> {}

package/src/viewers/Chain.ts

@@ -1,8 +1,13 @@
 import type { Promisable } from '@xylabs/sdk-js'
 import type { ChainId } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../model/index.ts'
+
 export interface ChainViewerMethods {
   chainId(): Promisable<ChainId>
 }
 
-export interface ChainViewer extends ChainViewerMethods {}
+export const ChainViewerMoniker = 'ChainViewer' as const
+export type ChainViewerMoniker = typeof ChainViewerMoniker
+
+export interface ChainViewer extends ChainViewerMethods, Provider<ChainViewerMoniker> {}

package/src/viewers/ChainContract.ts

@@ -1,5 +1,7 @@
 import type { Address } from '@xylabs/sdk-js'
 
+import type { Provider } from '../model/index.ts'
+
 export interface ChainContractViewerMethods {
   forkedAtBlockNumber(): Promise<bigint>
   forkedAtHash(): Promise<bigint>
@@ -9,4 +11,7 @@ export interface ChainContractViewerMethods {
   stakingTokenAddress(): Promise<string>
 }
 
-export interface ChainContractViewer extends ChainContractViewerMethods {}
+export const ChainContractViewerMoniker = 'ChainContractViewer' as const
+export type ChainContractViewerMoniker = typeof ChainContractViewerMoniker
+
+export interface ChainContractViewer extends ChainContractViewerMethods, Provider<ChainContractViewerMoniker> {}

package/src/viewers/ChainStakeViewer.ts

@@ -1,7 +1,12 @@
+import type { Provider } from '../model/index.ts'
 import type { ChainViewer } from './Chain.ts'
 import type { ChainContractViewer } from './ChainContract.ts'
 import type { StakeTotalsViewer } from './StakeTotals.ts'
 
-export interface ChainStakeViewer extends ChainContractViewer, StakeTotalsViewer, ChainViewer {
+export const ChainStakeViewerMoniker = 'ChainStakeViewer' as const
+export type ChainStakeViewerMoniker = typeof ChainStakeViewerMoniker
+
+export interface ChainStakeViewer extends Omit<ChainContractViewer, 'moniker'>, Omit<StakeTotalsViewer, 'moniker'>,
+  Omit<ChainViewer, 'moniker'>, Provider<ChainStakeViewerMoniker> {
 
 }

package/src/viewers/Mempool.ts

@@ -3,6 +3,8 @@ import type { SignedHydratedBlockWithHashMeta, SignedHydratedTransactionWithHash
 import { XL1BlockRangeZod } from '@xyo-network/xl1-protocol'
 import z from 'zod'
 
+import type { Provider } from '../model/index.ts'
+
 export const PendingTransactionsOptionsZod = z.object({
   cursor: HashZod.optional(),
   limit: z.number().int().positive().optional(),
@@ -24,4 +26,7 @@ export interface MempoolViewerMethods {
   pendingTransactions(options?: PendingTransactionsOptions): Promise<SignedHydratedTransactionWithHashMeta[]>
 }
 
-export interface MempoolViewer extends MempoolViewerMethods {}
+export const MempoolViewerMoniker = 'MempoolViewer' as const
+export type MempoolViewerMoniker = typeof MempoolViewerMoniker
+
+export interface MempoolViewer extends MempoolViewerMethods, Provider<MempoolViewerMoniker> {}

package/src/viewers/NetworkStakeStepReward.ts

@@ -1,6 +1,8 @@
 import type { Address, Promisable } from '@xylabs/sdk-js'
 import type { StepIdentity, StepIdentityString } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../model/index.ts'
+
 export interface NetworkStakeStepAddressRewardViewerMethods {
   // the step rewards for a specific network stakers for all of history
   networkStakeStepRewardAddressHistory(address: Address): Promisable<Record<Address, bigint>>
@@ -32,7 +34,7 @@ export interface NetworkStakeStepRewardPositionViewerMethods {
   networkStakeStepRewardPotentialPositionLoss(context: StepIdentity, position: number): Promisable<bigint>
 }
 
-export interface NetworkStakeStepRewardViewer extends
+export interface NetworkStakeStepRewardViewerMethods extends
   NetworkStakeStepPoolRewardViewerMethods,
   NetworkStakeStepAddressRewardViewerMethods,
   NetworkStakeStepRewardPositionViewerMethods
@@ -66,3 +68,8 @@ export interface NetworkStakeStepRewardViewer extends
   // the total rewards for a given range and step level
   networkStakeStepRewardsForStepLevel(stepLevel: number, range: [number, number]): Promisable<bigint>
 }
+
+export const NetworkStakeStepRewardViewerMoniker = 'NetworkStakeStepRewardViewer' as const
+export type NetworkStakeStepRewardViewerMoniker = typeof NetworkStakeStepRewardViewerMoniker
+
+export interface NetworkStakeStepRewardViewer extends NetworkStakeStepRewardViewerMethods, Provider<NetworkStakeStepRewardViewerMoniker> {}

package/src/viewers/Stake.ts

@@ -1,6 +1,6 @@
 import type { Address, Promisable } from '@xylabs/sdk-js'
 
-import type { Position } from '../model/index.ts'
+import type { Position, Provider } from '../model/index.ts'
 import type { StakeEventsViewer } from './StakeEvents.ts'
 
 export interface StakeViewerProperties {
@@ -18,7 +18,10 @@ export interface StakeViewerMethods {
   stakesByStaker(staker: Address): Promisable<Position[]>
 }
 
-export interface StakeViewer extends StakeViewerMethods, StakeViewerProperties {
+export const StakeViewerMoniker = 'StakeViewer' as const
+export type StakeViewerMoniker = typeof StakeViewerMoniker
+
+export interface StakeViewer extends StakeViewerMethods, StakeViewerProperties, Provider<StakeViewerMoniker> {
   active(time?: number): Promisable<bigint>
   activeByAddressStaked(address: string, time?: number): Promisable<bigint>
   activeByStaker(address: string, time?: number): Promisable<bigint>
@@ -28,7 +31,10 @@ export interface StakeViewer extends StakeViewerMethods, StakeViewerProperties {
   withdrawnByStaker(staker: string, time?: number): Promisable<bigint>
 }
 
-export interface StakeRunner extends StakeViewer {
+export const StakeRunnerMoniker = 'StakeRunner' as const
+export type StakeRunnerMoniker = typeof StakeRunnerMoniker
+
+export interface StakeRunner extends Provider<StakeRunnerMoniker> {
   addStake(staked: string, amount: bigint): Promise<boolean>
   removeStake(slot: bigint): Promise<boolean>
   withdrawStake(slot: bigint): Promise<boolean>

package/src/viewers/StakeEvents.ts

@@ -2,6 +2,8 @@ import type {
   Address, JsonObject, Promisable,
 } from '@xylabs/sdk-js'
 
+import type { Provider } from '../model/index.ts'
+
 export const StakeEventNames = ['StakeAdded', 'StakeRemoved', 'StakeWithdrawn'] as const
 export type StakeEventName = typeof StakeEventNames[number]
 
@@ -33,7 +35,10 @@ export interface StakeEvent<TName extends StakeEventName = StakeEventName> exten
   args: StakeEventArgs
 }
 
-export interface StakeEventsViewer {
+export const StakeEventsViewerMoniker = 'StakeEventsViewer' as const
+export type StakeEventsViewerMoniker = typeof StakeEventsViewerMoniker
+
+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

@@ -3,12 +3,15 @@ import type {
 } from '@xylabs/sdk-js'
 import type { ChainStakeIntent, XL1BlockRange } from '@xyo-network/xl1-protocol'
 
-import type { Qualified } from '../model/index.ts'
+import type { Provider, Qualified } from '../model/index.ts'
 
 export interface StakeIntentViewerMethods {
   qualifiedIntentByAddress(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<Qualified<ChainStakeIntent | null>>
 }
 
-export interface StakeIntentViewer extends StakeIntentViewerMethods {
+export const StakeIntentViewerMoniker = 'StakeIntentViewer' as const
+export type StakeIntentViewerMoniker = typeof StakeIntentViewerMoniker
+
+export interface StakeIntentViewer extends StakeIntentViewerMethods, Provider<StakeIntentViewerMoniker> {
   intentByAddress(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<ChainStakeIntent | null>
 }

package/src/viewers/StakeTotals.ts

@@ -1,5 +1,7 @@
 import type { Address, Promisable } from '@xylabs/sdk-js'
 
+import type { Provider } from '../model/index.ts'
+
 export interface StakeTotalsViewerMethods {
   active(): Promisable<bigint>
   activeByStaked(staked: Address): Promisable<bigint>
@@ -10,4 +12,7 @@ export interface StakeTotalsViewerMethods {
   withdrawnByStaker(staker: Address): Promisable<bigint>
 }
 
-export interface StakeTotalsViewer extends StakeTotalsViewerMethods {}
+export const StakeTotalsViewerMoniker = 'StakeTotalsViewer' as const
+export type StakeTotalsViewerMoniker = typeof StakeTotalsViewerMoniker
+
+export interface StakeTotalsViewer extends StakeTotalsViewerMethods, Provider<StakeTotalsViewerMoniker> {}