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

package/dist/neutral/viewers/StepViewer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StepViewer.d.ts","sourceRoot":"","sources":["../../../src/viewers/StepViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAEzE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAA;AAEzE,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAGhC,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAErD,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;IAGtF,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAGlD,KAAK,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAG7C,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAEnD,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IAGjF,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;CACxE;AAED,MAAM,WAAW,UAAW,SAAQ,iBAAiB;IACnD,OAAO,CAAC,EAAE,6BAA6B,CAAA;CACxC"}
+{"version":3,"file":"StepViewer.d.ts","sourceRoot":"","sources":["../../../src/viewers/StepViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAEzE,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAA;AAEzE,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAGhC,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAErD,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;IAGtF,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAGlD,KAAK,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAG7C,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAEnD,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IAGjF,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;CACxE;AAED,eAAO,MAAM,iBAAiB,EAAG,YAAqB,CAAA;AACtD,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAExD,MAAM,WAAW,UAAW,SAAQ,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAChF,OAAO,CAAC,EAAE,6BAA6B,CAAA;CACxC"}

package/dist/neutral/viewers/TimeSync.d.ts

@@ -1,5 +1,6 @@
 import type { Promisable } from '@xylabs/sdk-js';
 import type { TimeDomain, TimePayload } from '@xyo-network/xl1-protocol';
+import type { Provider } from '../model/index.ts';
 export interface TimeSyncViewerMethods {
     /** Convert time between different domains */
     convertTime(fromDomain: TimeDomain, toDomain: TimeDomain, from: number): Promisable<number>;
@@ -10,6 +11,8 @@ export interface TimeSyncViewerMethods {
     /** Create a TimePayload with the current time from all configured domains */
     currentTimePayload(): Promisable<TimePayload>;
 }
-export interface TimeSyncViewer extends TimeSyncViewerMethods {
+export declare const TimeSyncViewerMoniker: "TimeSyncViewer";
+export type TimeSyncViewerMoniker = typeof TimeSyncViewerMoniker;
+export interface TimeSyncViewer extends TimeSyncViewerMethods, Provider<TimeSyncViewerMoniker> {
 }
 //# sourceMappingURL=TimeSync.d.ts.map

package/dist/neutral/viewers/TimeSync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TimeSync.d.ts","sourceRoot":"","sources":["../../../src/viewers/TimeSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAExE,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAE3F,8CAA8C;IAC9C,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAE7D,8CAA8C;IAC9C,kBAAkB,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;IAE3E,6EAA6E;IAC7E,kBAAkB,IAAI,UAAU,CAAC,WAAW,CAAC,CAAA;CAC9C;AAED,MAAM,WAAW,cAAe,SAAQ,qBAAqB;CAAG"}
+{"version":3,"file":"TimeSync.d.ts","sourceRoot":"","sources":["../../../src/viewers/TimeSync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAExE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAEjD,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAE3F,8CAA8C;IAC9C,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAE7D,8CAA8C;IAC9C,kBAAkB,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;IAE3E,6EAA6E;IAC7E,kBAAkB,IAAI,UAAU,CAAC,WAAW,CAAC,CAAA;CAC9C;AAED,eAAO,MAAM,qBAAqB,EAAG,gBAAyB,CAAA;AAC9D,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAA;AAEhE,MAAM,WAAW,cAAe,SAAQ,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,CAAC;CAAG"}

package/dist/neutral/viewers/TransferBalance.d.ts

@@ -1,19 +1,22 @@
 import type { Address, Promisable } from '@xylabs/sdk-js';
 import type { Signed } from '@xyo-network/boundwitness-model';
 import type { AttoXL1, BlockBoundWitness, TransactionBoundWitness, Transfer, XL1BlockRange } from '@xyo-network/xl1-protocol';
+import type { Provider } from '../model/index.ts';
 export type TransferBalanceHistoryItem = [
     Signed<BlockBoundWitness>,
     Signed<TransactionBoundWitness> | null,
     Transfer
 ];
-export type TransferPair = [/* from */ Address, /* to */ Address];
+export type TransferPair = [Address, Address];
 export interface TransferBalancesViewerMethods {
     transferBalances(address: Address[]): Promisable<Partial<Record<Address, Record<Address, AttoXL1>>>>;
     transferBalancesHistories(address: Address[]): Promisable<Partial<Record<Address, Record<Address, TransferBalanceHistoryItem[]>>>>;
     transferPairBalances(address: TransferPair[]): Promisable<Partial<Record<Address, Record<Address, AttoXL1>>>>;
     transferPairBalancesHistories(address: TransferPair[]): Promisable<Partial<Record<Address, Record<Address, TransferBalanceHistoryItem[]>>>>;
 }
-export interface TransferBalanceViewerMethods {
+export declare const TransferBalanceViewerMoniker: "TransferBalanceViewer";
+export type TransferBalanceViewerMoniker = typeof TransferBalanceViewerMoniker;
+export interface TransferBalanceViewer extends TransferBalancesViewerMethods, Provider<TransferBalanceViewerMoniker> {
     transferBalance(address: Address): Promisable<AttoXL1>;
     transferBalanceHistory(address: Address, range?: XL1BlockRange): Promisable<TransferBalanceHistoryItem[]>;
     transferPairBalance(address: TransferPair): Promisable<AttoXL1>;

package/dist/neutral/viewers/TransferBalance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TransferBalance.d.ts","sourceRoot":"","sources":["../../../src/viewers/TransferBalance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,KAAK,EACV,OAAO,EACP,iBAAiB,EAAE,uBAAuB,EAAE,QAAQ,EACpD,aAAa,EACd,MAAM,2BAA2B,CAAA;AAElC,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,iBAAiB,CAAC;IACzB,MAAM,CAAC,uBAAuB,CAAC,GAAG,IAAI;IACtC,QAAQ;CACT,CAAA;AACD,MAAM,MAAM,YAAY,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAA,OAAO,CAAC,CAAA;AAEhE,MAAM,WAAW,6BAA6B;IAC5C,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;IACpG,yBAAyB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IAClI,oBAAoB,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7G,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5I;AAED,MAAM,WAAW,4BAA4B;IAC3C,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACtD,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,aAAa,GAAG,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;IACzG,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IAC/D,0BAA0B,CAAC,OAAO,EAAE,YAAY,GAAG,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;CAC5F"}
+{"version":3,"file":"TransferBalance.d.ts","sourceRoot":"","sources":["../../../src/viewers/TransferBalance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,KAAK,EACV,OAAO,EACP,iBAAiB,EAAE,uBAAuB,EAAE,QAAQ,EACpD,aAAa,EACd,MAAM,2BAA2B,CAAA;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAEjD,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,iBAAiB,CAAC;IACzB,MAAM,CAAC,uBAAuB,CAAC,GAAG,IAAI;IACtC,QAAQ;CACT,CAAA;AACD,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAE7C,MAAM,WAAW,6BAA6B;IAC5C,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;IACpG,yBAAyB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IAClI,oBAAoB,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7G,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5I;AAED,eAAO,MAAM,4BAA4B,EAAG,uBAAgC,CAAA;AAC5E,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAA;AAE9E,MAAM,WAAW,qBAAsB,SAAQ,6BAA6B,EAAE,QAAQ,CAAC,4BAA4B,CAAC;IAClH,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACtD,sBAAsB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,aAAa,GAAG,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;IACzG,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IAC/D,0BAA0B,CAAC,OAAO,EAAE,YAAY,GAAG,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAA;CAC5F"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol-sdk",
-  "version": "1.17.2",
+  "version": "1.17.6",
   "description": "XYO Layer One SDK Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -39,8 +39,8 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/sdk-js": "~5.0.50",
-    "@xylabs/telemetry": "~5.0.50",
+    "@xylabs/hex": "~5.0.51",
+    "@xylabs/sdk-js": "~5.0.51",
     "@xyo-network/account": "~5.2.17",
     "@xyo-network/account-model": "~5.2.17",
     "@xyo-network/archivist-memory": "~5.2.17",
@@ -51,17 +51,18 @@
     "@xyo-network/payload-model": "~5.2.17",
     "@xyo-network/wallet": "~5.2.17",
     "@xyo-network/wallet-model": "~5.2.17",
-    "@xyo-network/xl1-protocol": "~1.14.16",
+    "@xyo-network/xl1-protocol": "~1.14.17",
     "async-mutex": "~0.5.0",
     "ethers": "^6.16.0",
     "lru-cache": "^11.2.4",
     "zod": "~4.1.13"
   },
   "devDependencies": {
-    "@types/node": "~24.10.1",
+    "@types/node": "~24.10.3",
+    "@xylabs/events": "~5.0.51",
     "@xylabs/ts-scripts-yarn3": "~7.2.8",
     "@xylabs/tsconfig": "~7.2.8",
-    "@xylabs/vitest-extended": "~5.0.50",
+    "@xylabs/vitest-extended": "~5.0.51",
     "@xyo-network/account": "~5.2.17",
     "@xyo-network/boundwitness-validator": "~5.2.17",
     "axios": "^1.13.2",
@@ -79,4 +80,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/CreatableProvider/AbstractCreatableProvider.ts

@@ -0,0 +1,17 @@
+import { AbstractCreatable } from '@xylabs/sdk-js'
+
+import type {
+  CreatableProvider,
+  CreatableProviderEventData, CreatableProviderFactory, CreatableProviderInstance, CreatableProviderParams,
+} from './CreatableProvider.ts'
+import { ProviderFactory } from './ProviderFactory.ts'
+
+export abstract class AbstractCreatableProvider<TParams extends CreatableProviderParams = CreatableProviderParams,
+  TEventData extends CreatableProviderEventData = CreatableProviderEventData> extends AbstractCreatable<TParams, TEventData> {
+  static factory<TModule extends CreatableProviderInstance>(
+    this: CreatableProvider<TModule>,
+    params?: Partial<TModule['params']>,
+  ): CreatableProviderFactory<TModule> {
+    return ProviderFactory.withParams<TModule>(this, params)
+  }
+}

package/src/CreatableProvider/CreatableProvider.ts

@@ -0,0 +1,68 @@
+import type { EventData } from '@xylabs/events'
+import type {
+  Creatable, CreatableInstance, CreatableParams, EmptyObject,
+  Labels, WithOptionalLabels,
+} from '@xylabs/sdk-js'
+
+import type { ProviderMoniker } from '../model/index.ts'
+import type { LabeledCreatableProviderFactory } from './LabeledCreatableProviderFactory.ts'
+import type { ProviderFactoryLocatorInstance } from './ProviderFactoryLocatorInstance.ts'
+
+export interface CreatableProviderParams<TConfig extends EmptyObject = EmptyObject> extends CreatableParams {
+  config?: TConfig
+  locator?: ProviderFactoryLocatorInstance
+}
+export interface CreatableProviderEventData extends EventData {}
+
+export interface CreatableProviderInstance<TParams extends CreatableProviderParams = CreatableProviderParams,
+  TEventData extends CreatableProviderEventData = CreatableProviderEventData>
+  extends CreatableInstance<TParams, TEventData> {}
+
+export interface CreatableProviderFactory<T extends CreatableProviderInstance = CreatableProviderInstance>
+  extends Omit<CreatableProvider<T>, 'create' | 'createHandler' | 'paramsHandler'> {
+  creatableProvider: CreatableProvider<T>
+  defaultParams?: Partial<T['params']>
+
+  labels?: Labels
+
+  create(
+    this: CreatableProviderFactory<T>,
+    params?: Partial<T['params']>): Promise<T>
+
+}
+
+export interface LabeledCreatableProvider<T extends CreatableProviderInstance = CreatableProviderInstance> extends CreatableProvider<T>, WithOptionalLabels {
+  factory(params?: Partial<T['params']>): LabeledCreatableProviderFactory<T>
+}
+
+export interface CreatableProvider<T extends CreatableProviderInstance = CreatableProviderInstance> extends Creatable<T> {
+  defaultMoniker: ProviderMoniker
+  monikers: ProviderMoniker[]
+  factory(params?: Partial<T['params']>): CreatableProviderFactory<T>
+}
+
+/**
+ * Class annotation to be used to decorate Providers which support
+ * an asynchronous creation pattern
+ * @returns The decorated Provider requiring it implement the members
+ * of the CreatableProvider as statics properties/methods
+ */
+export function creatableProvider<TProvider extends CreatableProviderInstance = CreatableProviderInstance>() {
+  return <U extends CreatableProvider<TProvider>>(constructor: U) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    constructor
+  }
+}
+
+/**
+ * Class annotation to be used to decorate Providers which support
+ * an asynchronous creation pattern
+ * @returns The decorated Provider requiring it implement the members
+ * of the CreatableProvider as statics properties/methods
+ */
+export function labeledCreatableProvider<TProvider extends CreatableProviderInstance = CreatableProviderInstance>() {
+  return <U extends LabeledCreatableProvider<TProvider>>(constructor: U) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    constructor
+  }
+}

package/src/CreatableProvider/CreatableProviderRegistry.ts

@@ -0,0 +1,85 @@
+import type { Labels } from '@xylabs/sdk-js'
+import { isTruthy } from '@xylabs/sdk-js'
+
+import type { ProviderMoniker } from '../model/index.ts'
+import type { CreatableProviderFactory, CreatableProviderInstance } from './CreatableProvider.ts'
+import type { LabeledCreatableProviderFactory } from './LabeledCreatableProviderFactory.ts'
+
+export interface CreatableProviderRegistry {
+  [key: string]: (CreatableProviderFactory | LabeledCreatableProviderFactory)[] | undefined
+}
+
+const buildProviderFactory = <TProvider extends CreatableProviderInstance>(
+  provider: CreatableProviderFactory<TProvider>,
+  labels?: Labels,
+): LabeledCreatableProviderFactory<TProvider> => {
+  const factory: LabeledCreatableProviderFactory<TProvider> = {
+    // Destructure instance properties
+    ...provider,
+
+    monikers: provider.monikers,
+    // Copy static methods
+    create: provider.create.bind(provider) as LabeledCreatableProviderFactory<TProvider>['create'],
+
+    // Merge module & supplied labels
+    labels: { ...(provider as LabeledCreatableProviderFactory).labels, ...labels },
+  }
+  return factory
+}
+
+export const registerCreatableProviderFactory = <TProvider extends CreatableProviderInstance>(
+  registry: CreatableProviderRegistry,
+  factory: CreatableProviderFactory<TProvider> | LabeledCreatableProviderFactory<TProvider>,
+  labels?: Labels,
+  /** register this as the primary factory for every schema it supports */
+  primary: boolean | ProviderMoniker | ProviderMoniker[] = false,
+) => {
+  const primaryMonikers
+    = primary !== true && isTruthy(primary)
+      ? Array.isArray(primary)
+        ? primary
+        : [primary]
+      : []
+
+  for (const primaryMoniker of primaryMonikers) {
+    if (!factory.monikers.includes(primaryMoniker)) {
+      console.warn(`Primary moniker ${primary} not found in factory monikers`)
+    }
+  }
+
+  const isPrimaryForMoniker = (moniker: ProviderMoniker) => {
+    switch (typeof primary) {
+      case 'boolean': {
+        return primary
+      }
+      case 'string': {
+        return moniker === primary
+      }
+      case 'object': {
+        if (Array.isArray(primary)) {
+          return primary.includes(moniker)
+        }
+      }
+    }
+    throw new Error(`Invalid primary value: ${primary}`)
+  }
+
+  const factoryClone: LabeledCreatableProviderFactory<TProvider> = buildProviderFactory(factory, labels)
+
+  // add this default moniker as the first entry
+  registry[factoryClone.defaultMoniker] = [factoryClone, ...(registry[factoryClone.defaultMoniker] ?? [])]
+  for (const moniker of factoryClone.monikers) {
+    registry[moniker] = isPrimaryForMoniker(moniker) ? [factoryClone, ...(registry[moniker] ?? [])] : [...(registry[moniker] ?? []), factoryClone]
+  }
+}
+
+export const registerCreatableProviderFactories = (
+  factories: (CreatableProviderFactory | LabeledCreatableProviderFactory)[],
+  registry: CreatableProviderRegistry = {},
+  primary = false,
+) => {
+  for (const factory of factories) {
+    registerCreatableProviderFactory(registry, factory, undefined, primary)
+  }
+  return registry
+}

package/src/CreatableProvider/LabeledCreatableProviderFactory.ts

@@ -0,0 +1,22 @@
+import type { WithOptionalLabels } from '@xylabs/sdk-js'
+
+import type { CreatableProviderFactory, CreatableProviderInstance } from './CreatableProvider.ts'
+
+export type LabeledCreatableProviderFactory<T extends CreatableProviderInstance = CreatableProviderInstance> = CreatableProviderFactory<T> & WithOptionalLabels
+
+export const hasLabels = (factory: CreatableProviderFactory | LabeledCreatableProviderFactory): factory is LabeledCreatableProviderFactory => {
+  return (factory as LabeledCreatableProviderFactory).labels !== undefined
+}
+
+/**
+ * Class annotation to be used to decorate Providers which support
+ * an asynchronous labeled creation factory pattern
+ * @returns The decorated Provider requiring it implement the members
+ * of the CreatableProvider as statics properties/methods
+ */
+export function labeledCreatableProviderFactory<TProvider extends CreatableProviderInstance = CreatableProviderInstance>() {
+  return <U extends LabeledCreatableProviderFactory<TProvider>>(constructor: U) => {
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+    constructor
+  }
+}

package/src/CreatableProvider/ProviderFactory.ts

@@ -0,0 +1,59 @@
+import type { Labels, WithOptionalLabels } from '@xylabs/sdk-js'
+import { assertEx } from '@xylabs/sdk-js'
+
+import type {
+  CreatableProvider, CreatableProviderFactory, CreatableProviderInstance,
+} from './CreatableProvider.ts'
+
+export class ProviderFactory<TProvider extends CreatableProviderInstance> implements CreatableProviderFactory<TProvider> {
+  creatableProvider: CreatableProvider<TProvider>
+
+  defaultMoniker: CreatableProvider<TProvider>['monikers'][number]
+
+  defaultParams?: Partial<TProvider['params']>
+
+  labels?: Labels
+
+  monikers: CreatableProvider<TProvider>['monikers']
+
+  constructor(
+    creatableProvider: CreatableProvider<TProvider>,
+    params?: Partial<TProvider['params']>,
+    labels: Labels = {},
+  ) {
+    this.creatableProvider = creatableProvider
+    this.defaultParams = params
+    this.defaultMoniker = creatableProvider.defaultMoniker
+    this.monikers = creatableProvider.monikers
+    assertEx(this.monikers.includes(this.defaultMoniker), () => 'defaultMoniker must be in monikers')
+    this.labels = Object.assign({}, (creatableProvider as WithOptionalLabels).labels ?? {}, labels ?? {})
+  }
+
+  static withParams<T extends CreatableProviderInstance>(
+    creatableProvider: CreatableProvider<T>,
+    params?: Partial<T['params']>,
+    labels: Labels = {},
+  ) {
+    return new ProviderFactory<T>(creatableProvider, params, labels)
+  }
+
+  create(this: CreatableProviderFactory<TProvider>, params?: Partial<TProvider['params']>): Promise<TProvider> {
+    const mergedParams: TProvider['params'] = {
+      ...this.defaultParams,
+      ...params,
+      config: {
+        ...this.defaultParams?.config,
+        ...params?.config,
+      },
+    } as TProvider['params']
+    return this.creatableProvider.create<TProvider>(mergedParams)
+  }
+
+  factory<T extends CreatableProviderInstance>(
+    this: CreatableProviderFactory<T>,
+    params?: Partial<T['params']>,
+    labels: Labels = {},
+  ): CreatableProviderFactory<T> {
+    return new ProviderFactory<T>(this.creatableProvider, params, labels)
+  }
+}

package/src/CreatableProvider/ProviderFactoryLocator.ts

@@ -0,0 +1,102 @@
+import { hasAllLabels, type Labels } from '@xylabs/sdk-js'
+import { assertEx } from '@xylabs/sdk-js'
+
+import type { ProviderMoniker } from '../model/index.ts'
+import type { CreatableProviderFactory } from './CreatableProvider.ts'
+import { type CreatableProviderRegistry, registerCreatableProviderFactory } from './CreatableProviderRegistry.ts'
+import { hasLabels, type LabeledCreatableProviderFactory } from './LabeledCreatableProviderFactory.ts'
+import type { ProviderFactoryLocatorInstance } from './ProviderFactoryLocatorInstance.ts'
+
+/**
+ * A class which encapsulates the Service Locator Pattern for Provider Factories
+ */
+export class ProviderFactoryLocator implements ProviderFactoryLocatorInstance {
+  protected readonly _registry: CreatableProviderRegistry
+
+  private _frozen = false
+
+  constructor(registry: CreatableProviderRegistry = {}) {
+    this._registry = registry
+  }
+
+  /**
+   * The current registry for the module factory
+   */
+  get registry(): Readonly<CreatableProviderRegistry> {
+    return this._registry
+  }
+
+  static empty() {
+    return new ProviderFactoryLocator({})
+  }
+
+  static standard() {
+    return new ProviderFactoryLocator({})
+  }
+
+  freeze() {
+    this._frozen = true
+  }
+
+  /**
+   * Locates a provider factory that matches the supplied schema and labels
+   * @param schema The config schema for the provider
+   * @param labels The labels for the provider factory
+   * @returns A provider factory that matches the supplied schema and labels or throws if one is not found
+   */
+  locate(moniker: ProviderMoniker, labels?: Labels): CreatableProviderFactory | LabeledCreatableProviderFactory {
+    return assertEx(
+      this.tryLocate(moniker, labels),
+
+      () => `No module factory for the supplied config schema [${moniker}]${labels ? ` & labels [${JSON.stringify(labels)}]` : ''} registered`,
+    )
+  }
+
+  merge(locator: ProviderFactoryLocatorInstance): ProviderFactoryLocatorInstance {
+    const registry = { ...this.registry }
+    for (const moniker in locator.registry) {
+      if (registry[moniker]) {
+        registry[moniker].push(...(locator.registry[moniker] ?? []))
+      } else {
+        registry[moniker] = locator.registry[moniker]
+      }
+    }
+    return new ProviderFactoryLocator(registry)
+  }
+
+  /**
+   * Registers a single module factory (with optional tags) with the locator
+   * @param factory The factory to register
+   * @param labels The labels for the module factory
+   */
+  register(factory: CreatableProviderFactory, labels?: Labels, primary: boolean | ProviderMoniker | ProviderMoniker[] = false): this {
+    assertEx(!this._frozen, () => 'Cannot register a module factory after the locator has been frozen')
+    registerCreatableProviderFactory(this._registry, factory, labels, primary)
+    return this
+  }
+
+  /**
+   * Registers multiple module factories with the locator
+   * @param factories The factories to register
+   */
+  registerMany(factories: CreatableProviderFactory[]): this {
+    for (const factory of factories) {
+      this.register(factory)
+    }
+    return this
+  }
+
+  /**
+   * Tries to locate a module factory that matches the supplied schema and labels
+   * @param schema The config schema for the module
+   * @param labels The labels for the module factory
+   * @returns A module factory that matches the supplied schema and labels or undefined
+   */
+  tryLocate(moniker: ProviderMoniker, labels?: Labels): CreatableProviderFactory | LabeledCreatableProviderFactory | undefined {
+    return labels
+      // Find the first factory that has labels and has all the labels provided
+      ? (this._registry[moniker]?.filter(hasLabels).find(factory => hasAllLabels(factory?.labels, labels)) ?? this._registry[moniker]?.[0])
+      // Otherwise, return the first factory
+      : this._registry[moniker]?.[0]
+  }
+}

package/src/CreatableProvider/ProviderFactoryLocatorInstance.ts

@@ -0,0 +1,47 @@
+import type { Labels } from '@xylabs/sdk-js'
+
+import type { ProviderMoniker } from '../model/index.ts'
+import type { CreatableProviderFactory } from './CreatableProvider.ts'
+import type { CreatableProviderRegistry } from './CreatableProviderRegistry.ts'
+import type { LabeledCreatableProviderFactory } from './LabeledCreatableProviderFactory.ts'
+
+export interface ProviderFactoryLocatorInstance {
+
+  /**
+   * The current registry for the module factory
+   */
+  registry: Readonly<CreatableProviderRegistry>
+
+  freeze(): void
+
+  /**
+   * Locates a module factory that matches the supplied schema and labels
+   * @param schema The config schema for the module
+   * @param labels The labels for the module factory
+   * @returns A module factory that matches the supplied schema and labels or throws if one is not found
+   */
+  locate(schema: string, labels?: Labels): CreatableProviderFactory | LabeledCreatableProviderFactory
+
+  merge(locator: ProviderFactoryLocatorInstance): ProviderFactoryLocatorInstance
+
+  /**
+   * Registers a single module factory (with optional tags) with the locator
+   * @param factory The factory to register
+   * @param labels The labels for the module factory
+   */
+  register(factory: CreatableProviderFactory, labels?: Labels, primary?: boolean | ProviderMoniker | ProviderMoniker[]): ProviderFactoryLocatorInstance
+
+  /**
+   * Registers multiple module factories with the locator
+   * @param factories The factories to register
+   */
+  registerMany(factories: CreatableProviderFactory[]): ProviderFactoryLocatorInstance
+
+  /**
+   * Tries to locate a module factory that matches the supplied schema and labels
+   * @param schema The config schema for the module
+   * @param labels The labels for the module factory
+   * @returns A module factory that matches the supplied schema and labels or undefined
+   */
+  tryLocate(schema: string, labels?: Labels): CreatableProviderFactory | LabeledCreatableProviderFactory | undefined
+}

package/src/CreatableProvider/index.ts

@@ -0,0 +1,7 @@
+export * from './AbstractCreatableProvider.ts'
+export * from './CreatableProvider.ts'
+export * from './CreatableProviderRegistry.ts'
+export * from './LabeledCreatableProviderFactory.ts'
+export * from './ProviderFactory.ts'
+export * from './ProviderFactoryLocator.ts'
+export * from './ProviderFactoryLocatorInstance.ts'

package/src/block/hydrate/flattenHydratedBlock.ts

@@ -1,7 +1,25 @@
 import type { Payload } from '@xyo-network/payload-model'
-import type { BlockBoundWitness } from '@xyo-network/xl1-protocol'
+import { type BlockBoundWitness, toHydratedBlock } from '@xyo-network/xl1-protocol'
 
 export const flattenHydratedBlock = <B extends BlockBoundWitness, P extends Payload>(hydratedBlock: [B, P[]]): (P | B)[] => {
   const [blk, blkPayloads] = hydratedBlock
   return [...blkPayloads, blk]
 }
+
+export const tryUnflattenHydratedBlock = <
+  B extends BlockBoundWitness,
+  P extends Payload,
+>(flattened: (P | B)[]): [B, P[]] | undefined => {
+  // Last element is the block
+  const blk = flattened.at(-1) as B
+
+  // All previous elements are payloads
+  const payloads = flattened.slice(0, -1) as P[]
+
+  return toHydratedBlock([blk, payloads])
+}
+
+export const unflattenHydratedBlock = <
+  B extends BlockBoundWitness,
+  P extends Payload,
+>(flattened: (P | B)[]): [B, P[]] => toHydratedBlock(tryUnflattenHydratedBlock(flattened), true) as [B, P[]]