@xyo-network/xl1-protocol 1.5.0 → 1.5.2

package/dist/types/services/ChainServiceCollection.d.ts

@@ -8,6 +8,9 @@ import type { ChainContractViewer, ChainStaker, ChainStakeViewer } from './Chain
 import type { ElectionService } from './Election.ts';
 import type { StakeIntentService } from './StakeIntentService/index.ts';
 export interface ChainServiceCollection {
+    /**
+     * The account which is used to sign transactions
+     */
     account: WalletInstance;
     /**
      * Services for working with account balances
@@ -17,16 +20,43 @@ export interface ChainServiceCollection {
      * The archivist which the chain data is stored in
      */
     chainArchivist: ArchivistInstance;
+    /**
+     * Service for viewing codified chain information
+     * from a contract
+     */
     chainContractViewer: ChainContractViewer;
     /**
      * The chain iterator
      */
     chainIterator?: EventingChainBlockNumberIterator;
+    /**
+     * Service for viewing stake information
+     */
     chainStakeViewer: ChainStakeViewer;
+    /**
+     * Service for staking
+     */
     chainStaker: ChainStaker;
+    /**
+     * The archivist which the chain submissions are stored in
+     */
     chainSubmissionsArchivistWrite: WriteArchivist;
+    /**
+     * Service for determining leader election
+     */
     electionService: ElectionService;
+    /**
+     * The archivist which the pending transactions are stored
+     * as bundled transactions
+     */
+    pendingBundledTransactionsArchivistWrite: ArchivistInstance;
+    /**
+     * The block producer service
+     */
     producer: BlockProducerService;
+    /**
+     * Service response for calculating block rewards
+     */
     rewardService: BlockRewardService;
     /**
      * Services for working with staked intents

package/dist/types/services/ChainServiceCollection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChainServiceCollection.d.ts","sourceRoot":"","sources":["../../../src/services/ChainServiceCollection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE/D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAC5E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,EACV,mBAAmB,EAAE,WAAW,EAAE,gBAAgB,EACnD,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEvE,MAAM,WAAW,sBAAsB;IAErC,OAAO,EAAE,cAAc,CAAA;IACvB;;OAEG;IACH,cAAc,EAAE,qBAAqB,CAAA;IACrC;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAA;IACjC,mBAAmB,EAAE,mBAAmB,CAAA;IACxC;;OAEG;IACH,aAAa,CAAC,EAAE,gCAAgC,CAAA;IAChD,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,WAAW,EAAE,WAAW,CAAA;IACxB,8BAA8B,EAAE,cAAc,CAAA;IAC9C,eAAe,EAAE,eAAe,CAAA;IAChC,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAA;CACvC"}
+{"version":3,"file":"ChainServiceCollection.d.ts","sourceRoot":"","sources":["../../../src/services/ChainServiceCollection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE/D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAA;AAC5E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,EACV,mBAAmB,EAAE,WAAW,EAAE,gBAAgB,EACnD,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEvE,MAAM,WAAW,sBAAsB;IAErC;;OAEG;IACH,OAAO,EAAE,cAAc,CAAA;IACvB;;OAEG;IACH,cAAc,EAAE,qBAAqB,CAAA;IACrC;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAA;IACjC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IACxC;;OAEG;IACH,aAAa,CAAC,EAAE,gCAAgC,CAAA;IAChD;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAA;IAClC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IACxB;;OAEG;IACH,8BAA8B,EAAE,cAAc,CAAA;IAC9C;;OAEG;IACH,eAAe,EAAE,eAAe,CAAA;IAChC;;;OAGG;IACH,wCAAwC,EAAE,iBAAiB,CAAA;IAC3D;;OAEG;IACH,QAAQ,EAAE,oBAAoB,CAAA;IAC9B;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAA;CACvC"}

package/dist/types/services/Params.d.ts

@@ -1,11 +1,8 @@
-import type { BaseParams } from '@xylabs/base';
+import type { CreatableParams } from '@xylabs/creatable';
 import type { EmptyObject } from '@xylabs/object';
 import type { AccountInstance } from '@xyo-network/account-model';
 import type { OpenTelemetryProviders } from '../OpenTelemetryProviders.ts';
-import type { ServiceStatusReporter } from './Service.ts';
-export type BaseServiceParams<TAdditionalParams extends EmptyObject = EmptyObject> = BaseParams<TAdditionalParams & OpenTelemetryProviders & {
-    statusReporter?: ServiceStatusReporter;
-}>;
+export type BaseServiceParams<TAdditionalParams extends EmptyObject = EmptyObject> = CreatableParams<TAdditionalParams & OpenTelemetryProviders>;
 export type BaseAccountableServiceParams = BaseServiceParams<{
     account: AccountInstance;
 }>;

package/dist/types/services/Params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../../src/services/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEzD,MAAM,MAAM,iBAAiB,CAAC,iBAAiB,SAAS,WAAW,GAAG,WAAW,IAAI,UAAU,CAAC,iBAAiB,GAAG,sBAAsB,GAAG;IAC3I,cAAc,CAAC,EAAE,qBAAqB,CAAA;CACvC,CAAC,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC3D,OAAO,EAAE,eAAe,CAAA;CACzB,CAAC,CAAA"}
+{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../../src/services/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AAE1E,MAAM,MAAM,iBAAiB,CAAC,iBAAiB,SAAS,WAAW,GAAG,WAAW,IAAI,eAAe,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,CAAA;AAEhJ,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC3D,OAAO,EAAE,eAAe,CAAA;CACzB,CAAC,CAAA"}

package/dist/types/services/Service.d.ts

@@ -1,10 +1,6 @@
-export type ServiceName = Exclude<string, 'reserved-service-name-value'>;
-export type ServiceStatus = 'starting' | 'started' | 'stopping' | 'stopped';
-export interface ServiceStatusReporter {
-    reportStatus: (name: ServiceName, status: ServiceStatus, progress?: number) => void;
-}
-export interface Service {
+import type { CreatableInstance, CreatableName } from '@xylabs/creatable';
+export type ServiceName = Exclude<string, 'reserved-service-name-value'> & CreatableName;
+export type Service = CreatableInstance<{
     name: ServiceName;
-    statusReporter?: ServiceStatusReporter;
-}
+}>;
 //# sourceMappingURL=Service.d.ts.map

package/dist/types/services/Service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Service.d.ts","sourceRoot":"","sources":["../../../src/services/Service.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAA;AAExE,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAA;AAE3E,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CACpF;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,WAAW,CAAA;IACjB,cAAc,CAAC,EAAE,qBAAqB,CAAA;CACvC"}
+{"version":3,"file":"Service.d.ts","sourceRoot":"","sources":["../../../src/services/Service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAEzE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,6BAA6B,CAAC,GAAG,aAAa,CAAA;AAExF,MAAM,MAAM,OAAO,GAAG,iBAAiB,CAAC;IACtC,IAAI,EAAE,WAAW,CAAA;CAClB,CAAC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "XYO Layer One Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -38,12 +38,13 @@
   "types": "./dist/types/index.d.ts",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@xylabs/base": "^4.12.1",
-    "@xylabs/events": "^4.12.1",
-    "@xylabs/hex": "^4.12.1",
-    "@xylabs/object": "^4.12.1",
-    "@xylabs/promise": "^4.12.1",
-    "@xylabs/typeof": "^4.12.1",
+    "@xylabs/base": "^4.12.10",
+    "@xylabs/creatable": "^4.12.10",
+    "@xylabs/events": "^4.12.10",
+    "@xylabs/hex": "^4.12.10",
+    "@xylabs/object": "^4.12.10",
+    "@xylabs/promise": "^4.12.10",
+    "@xylabs/typeof": "^4.12.10",
     "@xyo-network/account-model": "^3.18.10",
     "@xyo-network/archivist-model": "^3.18.10",
     "@xyo-network/boundwitness-model": "^3.18.10",
@@ -71,6 +72,10 @@
     "node": ">=22.3 <23"
   },
   "engineStrict": true,
+  "volta": {
+    "node": "22.3.0",
+    "yarn": "4.9.2"
+  },
   "publishConfig": {
     "access": "public"
   }

package/src/services/ChainServiceCollection.ts

@@ -13,6 +13,9 @@ import type { StakeIntentService } from './StakeIntentService/index.ts'
 
 export interface ChainServiceCollection {
 
+  /**
+   * The account which is used to sign transactions
+   */
   account: WalletInstance
   /**
    * Services for working with account balances
@@ -22,16 +25,43 @@ export interface ChainServiceCollection {
    * The archivist which the chain data is stored in
    */
   chainArchivist: ArchivistInstance
+  /**
+   * Service for viewing codified chain information
+   * from a contract
+   */
   chainContractViewer: ChainContractViewer
   /**
    * The chain iterator
    */
   chainIterator?: EventingChainBlockNumberIterator
+  /**
+   * Service for viewing stake information
+   */
   chainStakeViewer: ChainStakeViewer
+  /**
+   * Service for staking
+   */
   chainStaker: ChainStaker
+  /**
+   * The archivist which the chain submissions are stored in
+   */
   chainSubmissionsArchivistWrite: WriteArchivist
+  /**
+   * Service for determining leader election
+   */
   electionService: ElectionService
+  /**
+   * The archivist which the pending transactions are stored
+   * as bundled transactions
+   */
+  pendingBundledTransactionsArchivistWrite: ArchivistInstance
+  /**
+   * The block producer service
+   */
   producer: BlockProducerService
+  /**
+   * Service response for calculating block rewards
+   */
   rewardService: BlockRewardService
   /**
    * Services for working with staked intents

package/src/services/Params.ts

@@ -1,13 +1,10 @@
-import type { BaseParams } from '@xylabs/base'
+import type { CreatableParams } from '@xylabs/creatable'
 import type { EmptyObject } from '@xylabs/object'
 import type { AccountInstance } from '@xyo-network/account-model'
 
 import type { OpenTelemetryProviders } from '../OpenTelemetryProviders.ts'
-import type { ServiceStatusReporter } from './Service.ts'
 
-export type BaseServiceParams<TAdditionalParams extends EmptyObject = EmptyObject> = BaseParams<TAdditionalParams & OpenTelemetryProviders & {
-  statusReporter?: ServiceStatusReporter
-}>
+export type BaseServiceParams<TAdditionalParams extends EmptyObject = EmptyObject> = CreatableParams<TAdditionalParams & OpenTelemetryProviders>
 
 export type BaseAccountableServiceParams = BaseServiceParams<{
   account: AccountInstance

package/src/services/Service.ts

@@ -1,12 +1,7 @@
-export type ServiceName = Exclude<string, 'reserved-service-name-value'>
+import type { CreatableInstance, CreatableName } from '@xylabs/creatable'
 
-export type ServiceStatus = 'starting' | 'started' | 'stopping' | 'stopped'
+export type ServiceName = Exclude<string, 'reserved-service-name-value'> & CreatableName
 
-export interface ServiceStatusReporter {
-  reportStatus: (name: ServiceName, status: ServiceStatus, progress?: number) => void
-}
-
-export interface Service {
+export type Service = CreatableInstance<{
   name: ServiceName
-  statusReporter?: ServiceStatusReporter
-}
+}>