@xyo-network/xl1-cli-lib 1.16.13 → 1.16.15

package/README.md

@@ -58,6 +58,7 @@ XYO Layer One CLI Library
 - [initBlockProducer](#variables/initBlockProducer)
 - [initBlockRewardService](#variables/initBlockRewardService)
 - [initTimeService](#variables/initTimeService)
+- [initTransferService](#variables/initTransferService)
 - [initValidator](#variables/initValidator)
 
 ## Functions
@@ -142,6 +143,14 @@ protected readonly _intervals: Map<string, Timeout>;
 
 ***
 
+### \_semaphores
+
+```ts
+protected readonly _semaphores: Map<string, Semaphore>;
+```
+
+***
+
 ### \_timeouts
 
 ```ts
@@ -387,6 +396,18 @@ protected readonly _intervals: Map<string, Timeout>;
 
 ***
 
+### \_semaphores
+
+```ts
+protected readonly _semaphores: Map<string, Semaphore>;
+```
+
+### Inherited from
+
+[`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
+
+***
+
 ### \_timeouts
 
 ```ts
@@ -404,12 +425,12 @@ protected readonly _timeouts: Map<string, Timeout>;
 ### Get Signature
 
 ```ts
-get protected balanceService(): AccountBalanceServiceV2;
+get protected balanceService(): AccountBalanceService;
 ```
 
 #### Returns
 
-`AccountBalanceServiceV2`
+`AccountBalanceService`
 
 ***
 
@@ -714,6 +735,18 @@ protected readonly _intervals: Map<string, Timeout>;
 
 ***
 
+### \_semaphores
+
+```ts
+protected readonly _semaphores: Map<string, Semaphore>;
+```
+
+### Inherited from
+
+[`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
+
+***
+
 ### \_timeouts
 
 ```ts
@@ -1107,7 +1140,7 @@ protected actors: IActor[] = [];
 ### keepAliveHandle
 
 ```ts
-protected keepAliveHandle: null | Timeout = null;
+protected keepAliveHandle: Timeout | null = null;
 ```
 
 ***
@@ -1220,7 +1253,7 @@ protected new ProducerActor(params): ProducerActor;
 ### \_lastProducedBlock
 
 ```ts
-protected _lastProducedBlock: undefined | HydratedBlock;
+protected _lastProducedBlock: HydratedBlock | undefined;
 ```
 
 ***
@@ -1228,7 +1261,7 @@ protected _lastProducedBlock: undefined | HydratedBlock;
 ### \_lastRedeclarationIntent
 
 ```ts
-protected _lastRedeclarationIntent: undefined | ChainStakeIntent;
+protected _lastRedeclarationIntent: ChainStakeIntent | undefined;
 ```
 
 ***
@@ -1245,6 +1278,18 @@ protected readonly _intervals: Map<string, Timeout>;
 
 ***
 
+### \_semaphores
+
+```ts
+protected readonly _semaphores: Map<string, Semaphore>;
+```
+
+### Inherited from
+
+[`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
+
+***
+
 ### \_timeouts
 
 ```ts
@@ -1276,12 +1321,12 @@ get protected account(): WalletInstance;
 ### Get Signature
 
 ```ts
-get protected balanceService(): AccountBalanceServiceV2;
+get protected balanceService(): AccountBalanceService;
 ```
 
 #### Returns
 
-`AccountBalanceServiceV2`
+`AccountBalanceService`
 
 ***
 
@@ -1318,16 +1363,12 @@ get protected chainStakeViewer(): ChainStakeViewer;
 ### Get Signature
 
 ```ts
-get protected chainSubmissionsArchivistWrite(): WriteArchivist<Payload, Payload, Payload, Brand<Brand<Lowercase<string>, {
-}>, {
-}>>;
+get protected chainSubmissionsArchivistWrite(): WriteArchivist<Payload, Payload, Payload, Hash>;
 ```
 
 #### Returns
 
-`WriteArchivist`\<`Payload`, `Payload`, `Payload`, `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-\}\>, \{
-\}\>\>
+`WriteArchivist`\<`Payload`, `Payload`, `Payload`, `Hash`\>
 
 ***
 
@@ -1499,6 +1540,30 @@ protected calculateBlocksUntilProducerDeclarationExpiration(currentBlock): Promi
 
 ***
 
+### produceBlock()
+
+```ts
+protected produceBlock(): Promise<void>;
+```
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### redeclareIntent()
+
+```ts
+protected redeclareIntent(): Promise<void>;
+```
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
 ### submitRedeclarationIntent()
 
 ```ts
@@ -1739,7 +1804,7 @@ getGlobalStatus(): CreatableStatus;
 ### getStatus()
 
 ```ts
-getStatus(name): undefined | CreatableStatus;
+getStatus(name): CreatableStatus | undefined;
 ```
 
 ### Parameters
@@ -1750,7 +1815,7 @@ getStatus(name): undefined | CreatableStatus;
 
 ### Returns
 
-`undefined` \| `CreatableStatus`
+`CreatableStatus` \| `undefined`
 
 ***
 
@@ -1884,7 +1949,7 @@ protected new ValidatorActor(params): ValidatorActor;
 ### \_lastValidatedBlock
 
 ```ts
-protected _lastValidatedBlock: undefined | BlockBoundWitness;
+protected _lastValidatedBlock: BlockBoundWitness | undefined;
 ```
 
 ***
@@ -1892,11 +1957,7 @@ protected _lastValidatedBlock: undefined | BlockBoundWitness;
 ### \_lastValidatedBlockHash
 
 ```ts
-protected _lastValidatedBlockHash: 
-  | undefined
-  | Brand<Brand<Lowercase<string>, {
-}>, {
-}>;
+protected _lastValidatedBlockHash: Hash | undefined;
 ```
 
 ***
@@ -1913,6 +1974,18 @@ protected readonly _intervals: Map<string, Timeout>;
 
 ***
 
+### \_semaphores
+
+```ts
+protected readonly _semaphores: Map<string, Semaphore>;
+```
+
+### Inherited from
+
+[`Actor`](#Actor).[`_semaphores`](Actor.md#_semaphores)
+
+***
+
 ### \_timeouts
 
 ```ts
@@ -1944,12 +2017,12 @@ get protected account(): WalletInstance;
 ### Get Signature
 
 ```ts
-get protected balanceService(): AccountBalanceServiceV2;
+get protected balanceService(): AccountBalanceService;
 ```
 
 #### Returns
 
-`AccountBalanceServiceV2`
+`AccountBalanceService`
 
 ***
 
@@ -1986,16 +2059,12 @@ get protected chainStakeViewer(): ChainStakeViewer;
 ### Get Signature
 
 ```ts
-get protected chainSubmissionsArchivistWrite(): WriteArchivist<Payload, Payload, Payload, Brand<Brand<Lowercase<string>, {
-}>, {
-}>>;
+get protected chainSubmissionsArchivistWrite(): WriteArchivist<Payload, Payload, Payload, Hash>;
 ```
 
 #### Returns
 
-`WriteArchivist`\<`Payload`, `Payload`, `Payload`, `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-\}\>, \{
-\}\>\>
+`WriteArchivist`\<`Payload`, `Payload`, `Payload`, `Hash`\>
 
 ***
 
@@ -2310,268 +2379,7 @@ function canUseEvmProvider(__namedParameters): boolean;
 
 ### config
 
-\{
-  `api`: \{
-     `host`: `string`;
-     `mnemonic?`: `string`;
-     `port`: `number`;
-  \};
-  `app`: \{
-     `port`: `number`;
-  \};
-  `chain`: \{
-     `id?`: `string`;
-  \};
-  `evm`: \{
-     `chainId?`: `string`;
-     `infura?`: \{
-        `projectId?`: `string`;
-        `projectSecret?`: `string`;
-     \};
-     `jsonRpc?`: \{
-        `url?`: `string`;
-     \};
-  \};
-  `producer`: \{
-     `allowlist?`: `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-        `__hex`: `true`;
-      \}\>, \{
-        `__address`: `true`;
-     \}\>[];
-     `disableIntentRedeclaration?`: `boolean`;
-     `healthCheckPort?`: `number`;
-     `heartbeatInterval`: `number`;
-     `minStake`: `number`;
-     `mnemonic?`: `string`;
-     `port`: `number`;
-     `rewardAddress?`: `string`;
-  \};
-  `storage`: \{
-     `mongo?`: \{
-        `connectionString?`: `string`;
-        `database?`: `string`;
-        `domain?`: `string`;
-        `password?`: `string`;
-        `username?`: `string`;
-     \};
-     `root?`: `string`;
-  \};
-  `telemetry`: \{
-     `otel?`: \{
-        `otlpEndpoint?`: `string`;
-     \};
-  \};
-  `logLevel`: `"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"debug"` \| `"trace"`;
-  `silent`: `boolean`;
-\}
-
-### config.api
-
-\{
-  `host`: `string`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-\}
-
-### config.api.host
-
-`string`
-
-### config.api.mnemonic?
-
-`string`
-
-### config.api.port
-
-`number`
-
-### config.app
-
-\{
-  `port`: `number`;
-\}
-
-### config.app.port
-
-`number`
-
-### config.chain
-
-\{
-  `id?`: `string`;
-\}
-
-### config.chain.id?
-
-`string`
-
-### config.evm
-
-\{
-  `chainId?`: `string`;
-  `infura?`: \{
-     `projectId?`: `string`;
-     `projectSecret?`: `string`;
-  \};
-  `jsonRpc?`: \{
-     `url?`: `string`;
-  \};
-\}
-
-### config.evm.chainId?
-
-`string`
-
-### config.evm.infura?
-
-\{
-  `projectId?`: `string`;
-  `projectSecret?`: `string`;
-\}
-
-### config.evm.infura.projectId?
-
-`string`
-
-### config.evm.infura.projectSecret?
-
-`string`
-
-### config.evm.jsonRpc?
-
-\{
-  `url?`: `string`;
-\}
-
-### config.evm.jsonRpc.url?
-
-`string`
-
-### config.producer
-
-\{
-  `allowlist?`: `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-     `__hex`: `true`;
-   \}\>, \{
-     `__address`: `true`;
-  \}\>[];
-  `disableIntentRedeclaration?`: `boolean`;
-  `healthCheckPort?`: `number`;
-  `heartbeatInterval`: `number`;
-  `minStake`: `number`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-  `rewardAddress?`: `string`;
-\}
-
-### config.producer.allowlist?
-
-`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-  `__hex`: `true`;
-\}\>, \{
-  `__address`: `true`;
-\}\>[]
-
-### config.producer.disableIntentRedeclaration?
-
-`boolean`
-
-### config.producer.healthCheckPort?
-
-`number`
-
-### config.producer.heartbeatInterval
-
-`number`
-
-### config.producer.minStake
-
-`number`
-
-### config.producer.mnemonic?
-
-`string`
-
-### config.producer.port
-
-`number`
-
-### config.producer.rewardAddress?
-
-`string`
-
-### config.storage
-
-\{
-  `mongo?`: \{
-     `connectionString?`: `string`;
-     `database?`: `string`;
-     `domain?`: `string`;
-     `password?`: `string`;
-     `username?`: `string`;
-  \};
-  `root?`: `string`;
-\}
-
-### config.storage.mongo?
-
-\{
-  `connectionString?`: `string`;
-  `database?`: `string`;
-  `domain?`: `string`;
-  `password?`: `string`;
-  `username?`: `string`;
-\}
-
-### config.storage.mongo.connectionString?
-
-`string`
-
-### config.storage.mongo.database?
-
-`string`
-
-### config.storage.mongo.domain?
-
-`string`
-
-### config.storage.mongo.password?
-
-`string`
-
-### config.storage.mongo.username?
-
-`string`
-
-### config.storage.root?
-
-`string`
-
-### config.telemetry
-
-\{
-  `otel?`: \{
-     `otlpEndpoint?`: `string`;
-  \};
-\}
-
-### config.telemetry.otel?
-
-\{
-  `otlpEndpoint?`: `string`;
-\}
-
-### config.telemetry.otel.otlpEndpoint?
-
-`string`
-
-### config.logLevel
-
-`"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"debug"` \| `"trace"`
-
-### config.silent
-
-`boolean`
+`Pick`\<`Config`, `"evm"`\>
 
 ## Returns
 
@@ -2593,268 +2401,7 @@ function initEvmProvider(__namedParameters): Promise<Provider>;
 
 ### config
 
-\{
-  `api`: \{
-     `host`: `string`;
-     `mnemonic?`: `string`;
-     `port`: `number`;
-  \};
-  `app`: \{
-     `port`: `number`;
-  \};
-  `chain`: \{
-     `id?`: `string`;
-  \};
-  `evm`: \{
-     `chainId?`: `string`;
-     `infura?`: \{
-        `projectId?`: `string`;
-        `projectSecret?`: `string`;
-     \};
-     `jsonRpc?`: \{
-        `url?`: `string`;
-     \};
-  \};
-  `producer`: \{
-     `allowlist?`: `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-        `__hex`: `true`;
-      \}\>, \{
-        `__address`: `true`;
-     \}\>[];
-     `disableIntentRedeclaration?`: `boolean`;
-     `healthCheckPort?`: `number`;
-     `heartbeatInterval`: `number`;
-     `minStake`: `number`;
-     `mnemonic?`: `string`;
-     `port`: `number`;
-     `rewardAddress?`: `string`;
-  \};
-  `storage`: \{
-     `mongo?`: \{
-        `connectionString?`: `string`;
-        `database?`: `string`;
-        `domain?`: `string`;
-        `password?`: `string`;
-        `username?`: `string`;
-     \};
-     `root?`: `string`;
-  \};
-  `telemetry`: \{
-     `otel?`: \{
-        `otlpEndpoint?`: `string`;
-     \};
-  \};
-  `logLevel`: `"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"debug"` \| `"trace"`;
-  `silent`: `boolean`;
-\}
-
-### config.api
-
-\{
-  `host`: `string`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-\}
-
-### config.api.host
-
-`string`
-
-### config.api.mnemonic?
-
-`string`
-
-### config.api.port
-
-`number`
-
-### config.app
-
-\{
-  `port`: `number`;
-\}
-
-### config.app.port
-
-`number`
-
-### config.chain
-
-\{
-  `id?`: `string`;
-\}
-
-### config.chain.id?
-
-`string`
-
-### config.evm
-
-\{
-  `chainId?`: `string`;
-  `infura?`: \{
-     `projectId?`: `string`;
-     `projectSecret?`: `string`;
-  \};
-  `jsonRpc?`: \{
-     `url?`: `string`;
-  \};
-\}
-
-### config.evm.chainId?
-
-`string`
-
-### config.evm.infura?
-
-\{
-  `projectId?`: `string`;
-  `projectSecret?`: `string`;
-\}
-
-### config.evm.infura.projectId?
-
-`string`
-
-### config.evm.infura.projectSecret?
-
-`string`
-
-### config.evm.jsonRpc?
-
-\{
-  `url?`: `string`;
-\}
-
-### config.evm.jsonRpc.url?
-
-`string`
-
-### config.producer
-
-\{
-  `allowlist?`: `Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-     `__hex`: `true`;
-   \}\>, \{
-     `__address`: `true`;
-  \}\>[];
-  `disableIntentRedeclaration?`: `boolean`;
-  `healthCheckPort?`: `number`;
-  `heartbeatInterval`: `number`;
-  `minStake`: `number`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-  `rewardAddress?`: `string`;
-\}
-
-### config.producer.allowlist?
-
-`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-  `__hex`: `true`;
-\}\>, \{
-  `__address`: `true`;
-\}\>[]
-
-### config.producer.disableIntentRedeclaration?
-
-`boolean`
-
-### config.producer.healthCheckPort?
-
-`number`
-
-### config.producer.heartbeatInterval
-
-`number`
-
-### config.producer.minStake
-
-`number`
-
-### config.producer.mnemonic?
-
-`string`
-
-### config.producer.port
-
-`number`
-
-### config.producer.rewardAddress?
-
-`string`
-
-### config.storage
-
-\{
-  `mongo?`: \{
-     `connectionString?`: `string`;
-     `database?`: `string`;
-     `domain?`: `string`;
-     `password?`: `string`;
-     `username?`: `string`;
-  \};
-  `root?`: `string`;
-\}
-
-### config.storage.mongo?
-
-\{
-  `connectionString?`: `string`;
-  `database?`: `string`;
-  `domain?`: `string`;
-  `password?`: `string`;
-  `username?`: `string`;
-\}
-
-### config.storage.mongo.connectionString?
-
-`string`
-
-### config.storage.mongo.database?
-
-`string`
-
-### config.storage.mongo.domain?
-
-`string`
-
-### config.storage.mongo.password?
-
-`string`
-
-### config.storage.mongo.username?
-
-`string`
-
-### config.storage.root?
-
-`string`
-
-### config.telemetry
-
-\{
-  `otel?`: \{
-     `otlpEndpoint?`: `string`;
-  \};
-\}
-
-### config.telemetry.otel?
-
-\{
-  `otlpEndpoint?`: `string`;
-\}
-
-### config.telemetry.otel.otlpEndpoint?
-
-`string`
-
-### config.logLevel
-
-`"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"debug"` \| `"trace"`
-
-### config.silent
-
-`boolean`
+`Pick`\<`Config`, `"evm"`\>
 
 ### logger?
 
@@ -2983,12 +2530,15 @@ stop(): Promise<void>;
 ***
 
 ```ts
-type ActorParams = BaseParams<{
-  config: Config;
-  traceProvider?: TracerProvider;
-}>;
+type ActorParams<T> = BaseParams<object & T extends void ? EmptyObject : T>;
 ```
 
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` \| `void` = `void`
+
   ### <a id="BalanceActorParams"></a>BalanceActorParams
 
 [**@xyo-network/xl1-cli-lib**](#../README)
@@ -2996,7 +2546,7 @@ type ActorParams = BaseParams<{
 ***
 
 ```ts
-type BalanceActorParams = BaseParams<Pick<ChainServiceCollectionV2, "balance" | "chainIterator"> & object>;
+type BalanceActorParams = ActorParams<Pick<ChainServiceCollectionV2, "balance" | "chainIterator"> & object>;
 ```
 
   ### <a id="ChainHeadUpdateActorParams"></a>ChainHeadUpdateActorParams
@@ -3006,7 +2556,7 @@ type BalanceActorParams = BaseParams<Pick<ChainServiceCollectionV2, "balance" |
 ***
 
 ```ts
-type ChainHeadUpdateActorParams = BaseParams<Pick<ChainServiceCollectionV2, "chainIterator" | "chainArchivist"> & object>;
+type ChainHeadUpdateActorParams = ActorParams<Pick<ChainServiceCollectionV2, "chainIterator" | "chainArchivist"> & object>;
 ```
 
   ### <a id="GlobalTransitionHandler"></a>GlobalTransitionHandler
@@ -3064,7 +2614,7 @@ optional to: CreatableStatus;
 ***
 
 ```ts
-type ProducerActorParams = BaseParams<Pick<ChainServiceCollectionV2, 
+type ProducerActorParams = ActorParams<Pick<ChainServiceCollectionV2, 
   | "account"
   | "balance"
   | "chainIterator"
@@ -3100,7 +2650,7 @@ optional name: string;
 ***
 
 ```ts
-type ValidatorActorParams = BaseParams<Pick<ChainServiceCollectionV2, 
+type ValidatorActorParams = ActorParams<Pick<ChainServiceCollectionV2, 
   | "account"
   | "balance"
   | "chainIterator"
@@ -3131,7 +2681,7 @@ const initAccount: Initializable<InitializableParams<{
 ***
 
 ```ts
-const initBalanceService: Initializable<BaseAccountBalanceServiceParams, AccountBalanceServiceV2>;
+const initBalanceService: Initializable<BaseAccountBalanceServiceParams, AccountBalanceService>;
 ```
 
   ### <a id="initBlockProducer"></a>initBlockProducer
@@ -3151,7 +2701,9 @@ const initBlockProducer: Initializable<BaseBlockProducerServiceParams, BlockProd
 ***
 
 ```ts
-const initBlockRewardService: Initializable<BaseBlockRewardServiceParams | EvmBlockRewardServiceParams, BlockRewardService>;
+const initBlockRewardService: Initializable<
+  | BaseBlockRewardServiceParams<Pick<Config, "evm">>
+| EvmBlockRewardServiceParams, BlockRewardService>;
 ```
 
   ### <a id="initChainIterator"></a>initChainIterator
@@ -3171,7 +2723,7 @@ const initChainIterator: Initializable<XyoChainIteratorParams, EventingChainBloc
 ***
 
 ```ts
-const initChainService: Initializable<BaseAccountableServiceParams, ChainService>;
+const initChainService: Initializable<BaseAccountableServiceParams<Pick<Config, "chain" | "evm" | "producer">>, ChainService>;
 ```
 
   ### <a id="initElectionService"></a>initElectionService
@@ -3240,7 +2792,17 @@ const initStakeIntentService: Initializable<XyoStakeIntentServiceParams, StakeIn
 ***
 
 ```ts
-const initTimeService: Initializable<BaseTimeServiceParams, TimeSyncServiceV2>;
+const initTimeService: Initializable<BaseTimeServiceParams<Pick<Config, "evm">>, TimeSyncViewer>;
+```
+
+  ### <a id="initTransferService"></a>initTransferService
+
+[**@xyo-network/xl1-cli-lib**](#../README)
+
+***
+
+```ts
+const initTransferService: Initializable<BaseAccountTransferServiceParams, AccountTransfersService>;
 ```
 
   ### <a id="initValidator"></a>initValidator