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

package/src/config/Bridge.ts

@@ -1,26 +1,124 @@
+import {
+  AddressZod, HexZod, toAddress, toHex,
+} from '@xylabs/hex'
+import type { ChainId } from '@xyo-network/xl1-protocol'
+import { AttoXL1ConvertFactor, XL1 } from '@xyo-network/xl1-protocol'
 import { globalRegistry } from 'zod'
 import * as z from 'zod'
 
 import { MnemonicStringZod } from '../validation/index.ts'
 
+const DEFAULT_FIXED_FEE = toHex(XL1(1n) * AttoXL1ConvertFactor.xl1)
+const DEFAULT_MIN_BRIDGE_AMOUNT = toHex(XL1(10n) * AttoXL1ConvertFactor.xl1)
+const DEFAULT_MAX_BRIDGE_AMOUNT = toHex(XL1(100_000n) * AttoXL1ConvertFactor.xl1)
+const DEFAULT_HARDHAT_CHAIN_ID: ChainId = toHex('7A69')
+const DEFAULT_HARDHAT_TOKEN_CONTRACT = toAddress('5FbDB2315678afecb367f032d93F642f64180aa3')
+const DEFAULT_HARDHAT_BRIDGE_CONTRACT = toAddress('2279B7A0a67DB372996a5FaB50D91eAA73d2eBe6')
+
+export const BasisPointsZod = z.coerce.number().int().nonnegative().max(10_000)
+export type BasisPoints = z.infer<typeof BasisPointsZod>
+
 export const BridgeConfigZod = z.object({
+  chainRpcApiUrl: z.string().default('http://localhost:8080/rpc').register(globalRegistry, {
+    default: 'http://localhost:8080/rpc',
+    description: 'URL for the Chain RPC API',
+    title: 'bridge.chainRpcApiUrl',
+    type: 'string',
+  }),
+  escrowAddress: AddressZod.optional().register(globalRegistry, {
+    description: 'Address to which bridge escrow will be sent',
+    title: 'bridge.escrowAddress',
+    type: 'string',
+  }),
+  feesAddress: AddressZod.optional().register(globalRegistry, {
+    description: 'Address to which bridge fees will be sent',
+    title: 'bridge.feesAddress',
+    type: 'string',
+  }),
+  feeFixed: HexZod.default(DEFAULT_FIXED_FEE).register(globalRegistry, {
+    default: DEFAULT_FIXED_FEE,
+    description: 'Fixed fee (in AttoXL1) applied to bridge transfers',
+    title: 'bridge.feeFixed',
+    type: 'bigint',
+  }),
+  feeRateBasisPoints: BasisPointsZod.default(500).register(globalRegistry, {
+    default: 500,
+    description: 'Variable rate fee (in basis points where 1 bps = 0.01%) applied to bridge transfers',
+    title: 'bridge.feeRateBasisPoints',
+    type: 'number',
+  }),
   host: z.string().default('localhost').register(globalRegistry, {
     default: 'localhost',
     description: 'Host for the Bridge',
-    title: 'api.host',
+    title: 'bridge.host',
+    type: 'string',
+  }),
+  maxBridgeAmount: HexZod.default(DEFAULT_MAX_BRIDGE_AMOUNT).register(globalRegistry, {
+    default: DEFAULT_MAX_BRIDGE_AMOUNT,
+    description: 'Maximum amount allowed for a bridge transfer',
+    title: 'bridge.maxBridgeAmount',
+    type: 'string',
+  }),
+  minBridgeAmount: HexZod.default(DEFAULT_MIN_BRIDGE_AMOUNT).register(globalRegistry, {
+    default: DEFAULT_MIN_BRIDGE_AMOUNT,
+    description: 'Minimum amount required for a bridge transfer',
+    title: 'bridge.minBridgeAmount',
     type: 'string',
   }),
   mnemonic: MnemonicStringZod.optional().register(globalRegistry, {
     description: 'Mnemonic for the Bridge wallet',
-    title: 'api.mnemonic',
+    title: 'bridge.mnemonic',
     type: 'string',
   }),
   port: z.coerce.number().default(8081).register(globalRegistry, {
     default: 8081,
     description: 'Port for the Bridge',
-    title: 'api.port',
+    title: 'bridge.port',
     type: 'number',
   }),
+  remoteBridgeContractAddress: AddressZod.default(DEFAULT_HARDHAT_BRIDGE_CONTRACT).register(globalRegistry, {
+    default: DEFAULT_HARDHAT_BRIDGE_CONTRACT,
+    description: 'Hex representation of remote token address used for bridging',
+    title: 'bridge.remoteBridgeContractAddress',
+    type: 'string',
+  }),
+  remoteChainId: HexZod.default(DEFAULT_HARDHAT_CHAIN_ID).register(globalRegistry, {
+    default: DEFAULT_HARDHAT_CHAIN_ID,
+    description: 'Remote chain ID',
+    title: 'bridge.remoteChainId',
+    type: 'string',
+  }),
+  remoteTokenAddress: HexZod.default(DEFAULT_HARDHAT_TOKEN_CONTRACT).register(globalRegistry, {
+    default: DEFAULT_HARDHAT_TOKEN_CONTRACT,
+    description: 'Hex representation of remote token address used for bridging',
+    title: 'bridge.remoteTokenAddress',
+    type: 'string',
+  }),
+  xl1ChainId: HexZod.optional().register(globalRegistry, {
+    description: 'XL1 chain id used for bridging',
+    title: 'bridge.xl1ChainId',
+    type: 'string',
+  }),
+  xl1TokenAddress: HexZod.optional().register(globalRegistry, {
+    description: 'XL1 token address used for bridging',
+    title: 'bridge.xl1TokenAddress',
+    type: 'string',
+  }),
 })
 
 export type BridgeConfig = z.infer<typeof BridgeConfigZod>
+
+export const BridgeSettingsZod = BridgeConfigZod.pick({
+  feeFixed: true,
+  feeRateBasisPoints: true,
+  feesAddress: true,
+  escrowAddress: true,
+  maxBridgeAmount: true,
+  minBridgeAmount: true,
+  remoteChainId: true,
+  remoteTokenAddress: true,
+  xl1TokenAddress: true,
+  xl1ChainId: true,
+}).required()
+
+export type BridgeSettings = z.infer<typeof BridgeSettingsZod>

package/src/config/index.ts

@@ -1,3 +1,4 @@
+export * from './Bridge.ts'
 export * from './Config.ts'
 export { hasMongoConfig } from './storage/index.ts'
 export * from './UsageMeta.ts'

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './block/index.ts'
 export * from './ChainServiceCollectionV2.ts'
 export * from './config/index.ts'
 export * from './constants.ts'
+export * from './CreatableProvider/index.ts'
 export * from './driver/index.ts'
 export * from './eip-712/index.ts'
 export * from './instances/index.ts'

package/src/map/AsyncMap.ts

@@ -0,0 +1,32 @@
+import type { Promisable } from '@xylabs/sdk-js'
+
+export interface AsyncMapRead<K, V> {
+  get(id: K): Promisable<V | undefined>
+  getMany(id: K[]): Promisable<V[]>
+  has(id: K): Promisable<boolean>
+}
+/**
+ * @deprecated Use AsyncMapRead instead
+ */
+export interface AsynchronousMapRead<K, V> extends AsyncMapRead<K, V> {}
+
+export interface AsyncMapWrite<K, V> {
+  clear(): Promisable<void>
+  delete(id: K): Promisable<boolean>
+  set(id: K, data: V): Promisable<void>
+  setMany(entries: [K, V][]): Promisable<void>
+}
+/**
+ * @deprecated Use AsyncMapWrite instead
+ */
+export interface AsynchronousMapWrite<K, V> extends AsyncMapWrite<K, V> {}
+
+export interface AsyncMap<K, V> extends AsyncMapRead<K, V>, AsyncMapWrite<K, V> {}
+/**
+ * @deprecated Use AsyncMap instead
+ */
+export interface AsynchronousMap<K, V> extends AsyncMap<K, V> {}
+
+export interface AsyncIterableMapRead<K, V>extends AsyncMapRead<K, V>, AsyncIterable<[K, V]> {}
+export interface AsyncIterableMapWrite<K, V>extends AsyncMapWrite<K, V>, AsyncIterable<[K, V]> {}
+export interface AsyncIterableMap<K, V>extends AsyncMap<K, V>, AsyncIterable<[K, V]> {}

package/src/map/MapType.ts

@@ -1,12 +1,18 @@
-import type { AsynchronousMapRead, AsynchronousMapWrite } from './AsynchronousMap.ts'
-import type { SynchronousMapRead, SynchronousMapWrite } from './SynchronousMap.ts'
+import type {
+  AsyncIterableMap, AsyncIterableMapRead, AsyncIterableMapWrite, AsyncMap, AsyncMapRead, AsyncMapWrite,
+} from './AsyncMap.ts'
+import type {
+  SyncIterableMap, SyncIterableMapRead, SyncIterableMapWrite, SyncMap, SyncMapRead, SyncMapWrite,
+} from './SyncMap.ts'
 
-export type MapTypeWrite<TId, TData> = SynchronousMapWrite<TId, TData> | AsynchronousMapWrite<TId, TData>
+export type MapTypeWrite<TId, TData> = SyncMapWrite<TId, TData> | AsyncMapWrite<TId, TData>
 
-export type MapTypeRead<TId, TData> = SynchronousMapRead<TId, TData> | AsynchronousMapRead<TId, TData>
+export type MapTypeRead<TId, TData> = SyncMapRead<TId, TData> | AsyncMapRead<TId, TData>
 
-export type AsynchronousMapType<TId, TData> = AsynchronousMapRead<TId, TData> & AsynchronousMapWrite<TId, TData>
+export type MapType<TId, TData> = SyncMap<TId, TData> | AsyncMap<TId, TData>
 
-export type SynchronousMapType<TId, TData> = SynchronousMapRead<TId, TData> & SynchronousMapWrite<TId, TData>
+export type IterableMapRead<TId, TData> = SyncIterableMapRead<TId, TData> | AsyncIterableMapRead<TId, TData>
 
-export type MapType<TId, TData> = AsynchronousMapType<TId, TData> | SynchronousMapType<TId, TData>
+export type IterableMapWrite<TId, TData> = SyncIterableMapWrite<TId, TData> | AsyncIterableMapWrite<TId, TData>
+
+export type IterableMap<TId, TData> = SyncIterableMap<TId, TData> | AsyncIterableMap<TId, TData>

package/src/map/SyncMap.ts

@@ -0,0 +1,32 @@
+export interface SyncMapRead<K, V> {
+  get(id: K): V | undefined
+  getMany(id: K[]): V[]
+  has(id: K): boolean
+}
+
+/**
+ * @deprecated Use SyncMapRead instead
+ */
+export interface SynchronousMapRead<K, V> extends SyncMapRead<K, V> {}
+
+export interface SyncMapWrite<K, V> {
+  clear(): void
+  delete(id: K): boolean
+  set(id: K, data: V): void
+  setMany(entries: [K, V][]): void
+}
+
+/**
+ * @deprecated Use SyncMapWrite instead
+ */
+export interface SynchronousMapWrite<K, V> extends SyncMapWrite<K, V> {}
+
+export interface SyncMap<K, V> extends SyncMapRead<K, V>, SyncMapWrite<K, V> {}
+/**
+ * @deprecated Use SyncMap instead
+ */
+export interface SynchronousMap<K, V> extends SyncMap<K, V> {}
+
+export interface SyncIterableMapRead<K, V> extends SyncMapRead<K, V>, Iterable<[K, V]> {}
+export interface SyncIterableMapWrite<K, V> extends SyncMapWrite<K, V>, Iterable<[K, V]> {}
+export interface SyncIterableMap<K, V> extends SyncMap<K, V>, Iterable<[K, V]> {}

package/src/map/index.ts

@@ -1,3 +1,3 @@
-export * from './AsynchronousMap.ts'
+export * from './AsyncMap.ts'
 export * from './MapType.ts'
-export * from './SynchronousMap.ts'
+export * from './SyncMap.ts'

package/src/model/Provider.ts

@@ -0,0 +1,15 @@
+import { assertEx, isString } from '@xylabs/sdk-js'
+
+export type ProviderMoniker = string
+
+export const asProviderMoniker = <T>(value: T) => {
+  const moniker = isString(value) ? (value as unknown as ProviderMoniker) : undefined
+  return assertEx(moniker)
+}
+
+export interface Provider<T extends ProviderMoniker> {
+  moniker: T
+}
+
+export const DefaultProviderMoniker = 'Provider' as const
+export type DefaultProviderMoniker = typeof DefaultProviderMoniker

package/src/model/index.ts

@@ -5,5 +5,6 @@ export * from './ChainStore.ts'
 export * from './PayloadBundle/index.ts'
 export * from './PayloadMap.ts'
 export * from './Position.ts'
+export * from './Provider.ts'
 export * from './Qualified.ts'
 export * from './RecordKeyType.ts'

package/src/payloads/netBalancesForPayloads.ts

@@ -1,7 +1,7 @@
 import {
   type Address, type Hex, hexToBigInt, toAddress,
 } from '@xylabs/sdk-js'
-import { span } from '@xylabs/telemetry'
+import { span } from '@xylabs/sdk-js'
 import type { Payload } from '@xyo-network/payload-model'
 import { isTransfer } from '@xyo-network/xl1-protocol'
 

package/src/payloads/netSchemasForPayloads.ts

@@ -1,7 +1,7 @@
 import {
   type Address, type Hex, hexToBigInt, toAddress,
 } from '@xylabs/sdk-js'
-import { span } from '@xylabs/telemetry'
+import { span } from '@xylabs/sdk-js'
 import type { Payload } from '@xyo-network/payload-model'
 import { isTransfer } from '@xyo-network/xl1-protocol'
 

package/src/payloads/netTransfersForPayloads.ts

@@ -1,7 +1,7 @@
 import {
   type Address, type Hex, hexToBigInt,
 } from '@xylabs/sdk-js'
-import { span } from '@xylabs/telemetry'
+import { span } from '@xylabs/sdk-js'
 import type { Payload } from '@xyo-network/payload-model'
 import { isTransfer } from '@xyo-network/xl1-protocol'
 

package/src/primitives/rewardFromBlockNumber.ts

@@ -4,11 +4,11 @@ import { asAttoXL1, type XL1BlockNumber } from '@xyo-network/xl1-protocol'
 export const rewardFromBlockNumber = (places = 18) => {
   return (
     blockNumber: XL1BlockNumber,
-    startingReward = asAttoXL1(toFixedPoint(30_000n, places)),
+    startingReward = asAttoXL1(toFixedPoint(500n, places)),
     blocksPerStep = 1_000_000,
-    stepFactorNumerator = 90n,
+    stepFactorNumerator = 95n,
     stepFactorDenominator = 100n,
-    minBlockReward = asAttoXL1(toFixedPoint(30n, places)),
+    minBlockReward = asAttoXL1(toFixedPoint(10n, places)),
     creatorReward = asAttoXL1(toFixedPoint(20_000_000_000n, places)),
   ) => {
     if (blockNumber === 0) {

package/src/provider/DataLake.ts

@@ -12,8 +12,14 @@ export interface DataLakeViewer extends DataLakeViewerMethods {
   disallowedSchemas?: Schema[]
 }
 
+export const DataLakeViewerMoniker = 'DataLakeViewer' as const
+export type DataLakeViewerMoniker = typeof DataLakeViewerMoniker
+
 export type DataLakeRunnerMethods = Pick<MapType<Hash, DataLakeData>, 'set' | 'delete' | 'clear'> & {
   setMany(entries: [Hash, DataLakeData][]): Promise<void>
 }
 
-export interface DataLakeRunner extends DataLakeViewerMethods, DataLakeRunnerMethods {}
+export interface DataLakeRunner extends DataLakeRunnerMethods {}
+
+export const DataLakeRunnerMoniker = 'DataLakeRunner' as const
+export type DataLakeRunnerMoniker = typeof DataLakeRunnerMoniker

package/src/provider/viewer/NetworkStake/NetworkStakeViewer.ts

@@ -1,5 +1,6 @@
 import type { Promisable } from '@xylabs/sdk-js'
 
+import type { Provider } from '../../../model/index.ts'
 import type { NetworkStakeStepRewardsViewer } from './Rewards/index.ts'
 
 export interface NetworkStakeViewerMethods {
@@ -7,6 +8,9 @@ export interface NetworkStakeViewerMethods {
   active(blockNumber?: number): Promisable<[bigint, number]>
 }
 
-export interface NetworkStakeViewer extends NetworkStakeViewerMethods {
+export const NetworkStakeViewerMoniker = 'NetworkStakeViewer' as const
+export type NetworkStakeViewerMoniker = typeof NetworkStakeViewerMoniker
+
+export interface NetworkStakeViewer extends NetworkStakeViewerMethods, Provider<NetworkStakeViewerMoniker> {
   stepRewards?: NetworkStakeStepRewardsViewer
 }

package/src/provider/viewer/NetworkStake/Rewards/ByPositionViewer.ts

@@ -1,3 +1,4 @@
+import type { Provider } from '../../../../model/index.ts'
 import type { NetworkStakeStepRewardsByPositionViewerOptions } from './Options.ts'
 import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './templates/index.ts'
 
@@ -6,4 +7,8 @@ import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './temp
 export interface NetworkStakeStepRewardsByPositionViewerMethods extends
   NetworkStakeStepRewardsByIndexViewerMethodsTemplate<NetworkStakeStepRewardsByPositionViewerOptions, number> {}
 
-export interface NetworkStakeStepRewardsByPositionViewer extends NetworkStakeStepRewardsByPositionViewerMethods {}
+export const NetworkStakeStepRewardsByPositionViewerMoniker = 'NetworkStakeStepRewardsByPositionViewer' as const
+export type NetworkStakeStepRewardsByPositionViewerMoniker = typeof NetworkStakeStepRewardsByPositionViewerMoniker
+
+export interface NetworkStakeStepRewardsByPositionViewer extends NetworkStakeStepRewardsByPositionViewerMethods,
+  Provider<NetworkStakeStepRewardsByPositionViewerMoniker> {}

package/src/provider/viewer/NetworkStake/Rewards/ByStakerViewer.ts

@@ -1,5 +1,6 @@
 import type { Address } from '@xylabs/sdk-js'
 
+import type { Provider } from '../../../../model/index.ts'
 import type { NetworkStakeStepRewardsByStakerViewerOptions } from './Options.ts'
 import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './templates/index.ts'
 
@@ -7,4 +8,9 @@ import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './temp
 
 export interface NetworkStakeStepRewardsByStakerViewerMethods
   extends NetworkStakeStepRewardsByIndexViewerMethodsTemplate<NetworkStakeStepRewardsByStakerViewerOptions, Address> {}
-export interface NetworkStakeStepRewardsByStakerViewer extends NetworkStakeStepRewardsByStakerViewerMethods {}
+
+export const NetworkStakeStepRewardsByStakerViewerMoniker = 'NetworkStakeStepRewardsByStakerViewer' as const
+export type NetworkStakeStepRewardsByStakerViewerMoniker = typeof NetworkStakeStepRewardsByStakerViewerMoniker
+
+export interface NetworkStakeStepRewardsByStakerViewer extends NetworkStakeStepRewardsByStakerViewerMethods,
+  Provider<NetworkStakeStepRewardsByStakerViewerMoniker> {}

package/src/provider/viewer/NetworkStake/Rewards/ByStepViewer.ts

@@ -1,5 +1,6 @@
 import type { StepIdentityString } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../../../../model/index.ts'
 import type { NetworkStakeStepRewardsByStepViewerOptions } from './Options.ts'
 import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './templates/index.ts'
 
@@ -7,4 +8,8 @@ import type { NetworkStakeStepRewardsByIndexViewerMethodsTemplate } from './temp
 
 export interface NetworkStakeStepRewardsByStepViewerMethods extends
   NetworkStakeStepRewardsByIndexViewerMethodsTemplate<NetworkStakeStepRewardsByStepViewerOptions, StepIdentityString> {}
-export interface NetworkStakeStepRewardsByStepViewer extends NetworkStakeStepRewardsByStepViewerMethods {}
+
+export const NetworkStakeStepRewardsByStepViewerMoniker = 'NetworkStakeStepRewardsByStepViewer' as const
+export type NetworkStakeStepRewardsByStepViewerMoniker = typeof NetworkStakeStepRewardsByStepViewerMoniker
+
+export interface NetworkStakeStepRewardsByStepViewer extends NetworkStakeStepRewardsByStepViewerMethods, Provider<NetworkStakeStepRewardsByStepViewerMoniker> {}

package/src/provider/viewer/NetworkStake/Rewards/TotalViewer.ts

@@ -1,9 +1,14 @@
 import type { AttoXL1 } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../../../../model/index.ts'
 import type { NetworkStakeStepRewardsRangeOptions } from './Options.ts'
 import type { NetworkStakeStepRewardsViewerMethodsTemplate } from './templates/index.ts'
 
 // Viewers are client objects that can nest other viewers and ViewerMethods objects consist only of methods that return data.
 
 export interface NetworkStakeStepRewardsTotalViewerMethods extends NetworkStakeStepRewardsViewerMethodsTemplate<NetworkStakeStepRewardsRangeOptions, AttoXL1> {}
-export interface NetworkStakeStepRewardsTotalViewer extends NetworkStakeStepRewardsTotalViewerMethods {}
+
+export const NetworkStakeStepRewardsTotalViewerMoniker = 'NetworkStakeStepRewardsTotalViewer' as const
+export type NetworkStakeStepRewardsTotalViewerMoniker = typeof NetworkStakeStepRewardsTotalViewerMoniker
+
+export interface NetworkStakeStepRewardsTotalViewer extends NetworkStakeStepRewardsTotalViewerMethods, Provider<NetworkStakeStepRewardsTotalViewerMoniker> {}

package/src/provider/viewer/NetworkStake/Rewards/Viewer.ts

@@ -1,3 +1,4 @@
+import type { Provider } from '../../../../model/index.ts'
 import type { NetworkStakeStepRewardsByPositionViewer } from './ByPositionViewer.ts'
 import type { NetworkStakeStepRewardsByStakerViewer } from './ByStakerViewer.ts'
 import type { NetworkStakeStepRewardsByStepViewer } from './ByStepViewer.ts'
@@ -5,7 +6,10 @@ import type { NetworkStakeStepRewardsTotalViewer } from './TotalViewer.ts'
 
 export interface NetworkStakeStepRewardsViewerMethods {}
 
-export interface NetworkStakeStepRewardsViewer extends NetworkStakeStepRewardsViewerMethods {
+export const NetworkStakeStepRewardsViewerMoniker = 'NetworkStakeStepRewardsViewer' as const
+export type NetworkStakeStepRewardsViewerMoniker = typeof NetworkStakeStepRewardsViewerMoniker
+
+export interface NetworkStakeStepRewardsViewer extends NetworkStakeStepRewardsViewerMethods, Provider<NetworkStakeStepRewardsViewerMoniker> {
   position?: NetworkStakeStepRewardsByPositionViewer
   staker?: NetworkStakeStepRewardsByStakerViewer
   step?: NetworkStakeStepRewardsByStepViewer

package/src/provider/viewer/XyoViewer.ts

@@ -3,6 +3,7 @@ import type {
 } from '@xylabs/sdk-js'
 import type { AttoXL1, XL1BlockRange } from '@xyo-network/xl1-protocol'
 
+import type { Provider } from '../../model/index.ts'
 import type {
   AccountBalanceHistoryItem,
   AccountBalanceViewer,
@@ -11,22 +12,25 @@ import type {
   ChainViewerMethods,
   ForkViewerMethods,
   MempoolViewer,
-  NetworkStakeStepRewardViewer,
+  NetworkStakeStepRewardViewerMethods,
   StakeViewerMethods,
   StepViewer,
   TransactionViewerMethods,
-  TransferBalanceViewerMethods,
 } from '../../viewers/index.ts'
 import type { NetworkStakeViewer } from './NetworkStake/index.ts'
 
 export interface XyoViewerMethods extends
-  TransferBalanceViewerMethods, NetworkStakeStepRewardViewer,
-  Pick<ChainViewerMethods, 'chainId'>, BlockViewerMethods, TransactionViewerMethods, StakeViewerMethods, ForkViewerMethods {
+  NetworkStakeStepRewardViewerMethods, Pick<ChainViewerMethods, 'chainId'>, BlockViewerMethods,
+  TransactionViewerMethods, StakeViewerMethods, ForkViewerMethods {
   accountBalance(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AttoXL1>
   accountBalanceHistory(address: Address, headOrRange?: Hash | XL1BlockRange): Promisable<AccountBalanceHistoryItem[]>
 }
 
-export interface XyoViewer extends BlockViewer, XyoViewerMethods {
+export const XyoViewerMoniker = 'XyoViewer' as const
+export type XyoViewerMoniker = typeof XyoViewerMoniker
+
+export interface XyoViewer extends Omit<BlockViewer, 'moniker'>, XyoViewerMethods,
+  Omit<StakeViewerMethods, 'moniker'>, Provider<XyoViewerMoniker> {
   account?: {
     balance?: AccountBalanceViewer
   }

package/src/services/Chain/ChainService.ts

@@ -3,4 +3,4 @@ import type {
 } from '../../viewers/index.ts'
 import type { BaseChainService } from './BaseChainService.ts'
 
-export interface ChainService extends ChainContractViewer, ChainStakeViewer, ChainViewer, BaseChainService {}
+export interface ChainService extends Omit<ChainContractViewer, 'moniker'>, Omit<ChainStakeViewer, 'moniker'>, Omit<ChainViewer, 'moniker'>, BaseChainService {}

package/src/simple/accountBalance/SimpleAccountBalanceViewer.ts

@@ -1,12 +1,8 @@
-import type {
-  Address, CreatableParams, Hash,
-} from '@xylabs/sdk-js'
+import type { Address, Hash } from '@xylabs/sdk-js'
 import {
-  AbstractCreatable,
   asHash,
-  assertEx, exists, isDefined,
+  assertEx, exists, isDefined, spanRootAsync,
 } from '@xylabs/sdk-js'
-import { spanRootAsync } from '@xylabs/telemetry'
 import type { WithHashMeta, WithStorageMeta } from '@xyo-network/payload-model'
 import type {
   SignedBlockBoundWitnessWithHashMeta, Transfer, XL1BlockNumber, XL1BlockRange,
@@ -18,7 +14,9 @@ import {
 } from '@xyo-network/xl1-protocol'
 
 import { deepCalculateFramesFromRange } from '../../block/index.ts'
-import type { Qualified } from '../../model/index.ts'
+import type { CreatableProviderParams } from '../../CreatableProvider/index.ts'
+import { AbstractCreatableProvider, creatableProvider } from '../../CreatableProvider/index.ts'
+import type { ProviderMoniker, Qualified } from '../../model/index.ts'
 import type {
   BalanceStepSummaryContext, TransfersStepSummary,
   TransfersStepSummaryContext,
@@ -27,17 +25,23 @@ import {
   balancesSummary,
   transfersStepSummaryFromRange,
 } from '../../summary/index.ts'
-import type {
-  AccountBalanceHistoryItem, AccountBalanceViewer, BlockViewer,
+import {
+  type AccountBalanceHistoryItem, type AccountBalanceViewer, AccountBalanceViewerMoniker,
+  type BlockViewer,
 } from '../../viewers/index.ts'
 
-export interface SimpleAccountBalanceViewerParams extends CreatableParams {
+export interface SimpleAccountBalanceViewerParams extends CreatableProviderParams {
   blockViewer: BlockViewer
   context: BalanceStepSummaryContext
   transfersSummaryContext: TransfersStepSummaryContext
 }
 
-export class SimpleAccountBalanceViewer extends AbstractCreatable<SimpleAccountBalanceViewerParams> implements AccountBalanceViewer {
+@creatableProvider()
+export class SimpleAccountBalanceViewer extends AbstractCreatableProvider<SimpleAccountBalanceViewerParams> implements AccountBalanceViewer {
+  static readonly defaultMoniker = AccountBalanceViewerMoniker
+  static readonly monikers = [AccountBalanceViewerMoniker]
+  moniker = SimpleAccountBalanceViewer.defaultMoniker
+
   get blockViewer(): BlockViewer {
     return this.params.blockViewer!
   }

package/src/simple/block/SimpleBlockViewer.ts

@@ -1,6 +1,5 @@
-import type { CreatableParams, Hash } from '@xylabs/sdk-js'
+import type { Hash } from '@xylabs/sdk-js'
 import {
-  AbstractCreatable,
   assertEx,
   exists,
   isDefined,
@@ -16,6 +15,8 @@ import {
 } from '@xyo-network/xl1-protocol'
 
 import { hydrateBlock } from '../../block/index.ts'
+import type { CreatableProviderParams } from '../../CreatableProvider/index.ts'
+import { AbstractCreatableProvider, creatableProvider } from '../../CreatableProvider/index.ts'
 import { LruCacheMap } from '../../driver/index.ts'
 import type {
   ChainContextRead,
@@ -23,14 +24,19 @@ import type {
 } from '../../model/index.ts'
 import { findMostRecentBlock, hydratedBlockByNumber } from '../../primitives/index.ts'
 import { HydratedCache } from '../../utils/index.ts'
-import type { BlockViewer } from '../../viewers/index.ts'
+import { type BlockViewer, BlockViewerMoniker } from '../../viewers/index.ts'
 
-export interface SimpleBlockViewerParams extends CreatableParams {
+export interface SimpleBlockViewerParams extends CreatableProviderParams {
   context: ChainContextRead
-  finalizedArchivist?: ReadArchivist
+  finalizedArchivist: ReadArchivist
 }
 
-export class SimpleBlockViewer extends AbstractCreatable<SimpleBlockViewerParams> implements BlockViewer {
+@creatableProvider()
+export class SimpleBlockViewer extends AbstractCreatableProvider<SimpleBlockViewerParams> implements BlockViewer {
+  static readonly defaultMoniker = BlockViewerMoniker
+  static readonly monikers = [BlockViewerMoniker]
+  moniker = SimpleBlockViewer.defaultMoniker
+
   private _payloadCache: PayloadMap<WithHashMeta<Payload>> | undefined
   private _signedHydratedBlockCache: HydratedCache<SignedHydratedBlockWithHashMeta> | undefined
 

package/src/simple/blockReward/SimpleBlockRewardViewer.ts

@@ -1,13 +1,13 @@
-import {
-  AbstractCreatable,
-  creatable, CreatableParams, Promisable,
-} from '@xylabs/sdk-js'
+import { Promisable } from '@xylabs/sdk-js'
 import { AttoXL1, XL1BlockNumber } from '@xyo-network/xl1-protocol'
 
+import {
+  AbstractCreatableProvider, creatableProvider, CreatableProviderParams,
+} from '../../CreatableProvider/index.ts'
 import { rewardFromBlockNumber } from '../../primitives/index.ts'
-import { BlockRewardViewer } from '../../viewers/index.ts'
+import { BlockRewardViewer, BlockRewardViewerMoniker } from '../../viewers/index.ts'
 
-export interface SimpleBlockRewardViewerParams extends CreatableParams {
+export interface SimpleBlockRewardViewerParams extends CreatableProviderParams {
   creatorReward: AttoXL1
   initialReward: AttoXL1
   minRewardPerBlock: AttoXL1
@@ -16,8 +16,12 @@ export interface SimpleBlockRewardViewerParams extends CreatableParams {
   stepSize: XL1BlockNumber
 }
 
-@creatable()
-export class SimpleBlockRewardViewer extends AbstractCreatable<SimpleBlockRewardViewerParams> implements BlockRewardViewer {
+@creatableProvider()
+export class SimpleBlockRewardViewer extends AbstractCreatableProvider<SimpleBlockRewardViewerParams> implements BlockRewardViewer {
+  static readonly defaultMoniker = BlockRewardViewerMoniker
+  static readonly monikers = [BlockRewardViewerMoniker]
+  moniker = SimpleBlockRewardViewer.defaultMoniker
+
   protected rewardFromBlockNumber = rewardFromBlockNumber(18)
 
   allowedRewardForBlock(block: XL1BlockNumber): Promisable<AttoXL1> {

package/src/simple/chain/SimpleChainViewer.ts

@@ -1,20 +1,23 @@
 import {
   type Address, asHex, Promisable,
 } from '@xylabs/sdk-js'
-import {
-  AbstractCreatable,
-  creatable, CreatableParams,
-} from '@xylabs/sdk-js'
 import { ChainId } from '@xyo-network/xl1-protocol'
 
-import { ChainViewer } from '../../viewers/index.ts'
+import {
+  AbstractCreatableProvider, creatableProvider, CreatableProviderParams,
+} from '../../CreatableProvider/index.ts'
+import { ChainViewer, ChainViewerMoniker } from '../../viewers/index.ts'
 
-export interface SimpleChainParams extends CreatableParams {
+export interface SimpleChainParams extends CreatableProviderParams {
   chainId: Address
 }
 
-@creatable()
-export class SimpleChainViewer extends AbstractCreatable<SimpleChainParams> implements ChainViewer {
+@creatableProvider()
+export class SimpleChainViewer extends AbstractCreatableProvider<SimpleChainParams> implements ChainViewer {
+  static readonly defaultMoniker = ChainViewerMoniker
+  static readonly monikers = [ChainViewerMoniker]
+  moniker = SimpleChainViewer.defaultMoniker
+
   static override async paramsHandler(params?: Partial<SimpleChainParams>) {
     return ({ ...await super.paramsHandler(params), chainId: asHex(params?.chainId, () => 'chainId not set') }) as SimpleChainParams
   }