@xyo-network/chain-orchestration 1.20.15 → 1.20.17

package/README.md

@@ -1,192 +1,24 @@
 # @xyo-network/chain-orchestration
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![socket-badge][]][socket-link]
+> XYO Layer One SDK Orchestration
 
-XYO Layer One SDK Orchestration
+## Install
 
-
-
-## Reference
-
-**@xyo-network/chain-orchestration**
-
-***
-
-## Variables
-
-- [DefaultReadCachingArchivistConfig](#variables/DefaultReadCachingArchivistConfig)
-- [initBridgedModule](#variables/initBridgedModule)
-- [initBridgedArchivistModule](#variables/initBridgedArchivistModule)
-
-## Functions
-
-- [initArchivistSync](#functions/initArchivistSync)
-- [wrapWithReadCachingArchivist](#functions/wrapWithReadCachingArchivist)
-- [initBridge](#functions/initBridge)
-
-### functions
-
-  ### <a id="initArchivistSync"></a>initArchivistSync
-
-[**@xyo-network/chain-orchestration**](#../README)
-
-***
-
-```ts
-function initArchivistSync(
-   name, 
-   inArchivist, 
-   outArchivist, 
-   frequency, 
-   max, 
-traceProvider?): Promise<MemoryNode<MemoryNodeParams, NodeModuleEventData>>;
-```
-
-## Parameters
-
-### name
-
-`ModuleIdentifier`
-
-### inArchivist
-
-`ArchivistInstance`
-
-### outArchivist
-
-`ArchivistInstance`
-
-### frequency
-
-`number` = `1000`
-
-### max
-
-`number` = `1000`
-
-### traceProvider?
-
-`TracerProvider`
-
-## Returns
-
-`Promise`\<`MemoryNode`\<`MemoryNodeParams`, `NodeModuleEventData`\>\>
-
-  ### <a id="initBridge"></a>initBridge
-
-[**@xyo-network/chain-orchestration**](#../README)
-
-***
-
-```ts
-function initBridge(nodeUrl): Promise<AttachableBridgeInstance<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
-```
-
-## Parameters
-
-### nodeUrl
-
-`string`
-
-## Returns
-
-`Promise`\<`AttachableBridgeInstance`\<`BridgeParams`\<`AnyConfigSchema`\<`BridgeConfig`\>\>, `BridgeModuleEventData`\>\>
-
-  ### <a id="wrapWithReadCachingArchivist"></a>wrapWithReadCachingArchivist
-
-[**@xyo-network/chain-orchestration**](#../README)
-
-***
-
-```ts
-function wrapWithReadCachingArchivist(archivist, config): Promise<AttachableArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
-```
-
-## Parameters
-
-### archivist
-
-`AttachableArchivistInstance`
-
-### config
-
-`Partial`\<`MemoryArchivistConfig`\> = `DefaultReadCachingArchivistConfig`
-
-## Returns
-
-`Promise`\<`AttachableArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
-
-### variables
-
-  ### <a id="DefaultReadCachingArchivistConfig"></a>DefaultReadCachingArchivistConfig
-
-[**@xyo-network/chain-orchestration**](#../README)
-
-***
-
-```ts
-const DefaultReadCachingArchivistConfig: MemoryArchivistConfig;
-```
-
-  ### <a id="initBridgedArchivistModule"></a>initBridgedArchivistModule
-
-[**@xyo-network/chain-orchestration**](#../README)
-
-***
-
-```ts
-const initBridgedArchivistModule: Initializable<{
-  bridge: BridgeInstance;
-  logger?: Logger;
-  moduleName: ModuleIdentifier;
-}, AttachableArchivistInstance>;
-```
-
-  ### <a id="initBridgedModule"></a>initBridgedModule
-
-[**@xyo-network/chain-orchestration**](#../README)
-
-***
-
-```ts
-const initBridgedModule: Initializable<{
-  bridge: BridgeInstance;
-  moduleName: ModuleIdentifier;
-}, AttachableModuleInstance>;
+```sh
+{{pm}} add {{name}}
 ```
 
 
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
-
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Credits
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
-
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
 
 [npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-orchestration.svg
 [npm-link]: https://www.npmjs.com/package/@xyo-network/chain-orchestration
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/chain-orchestration
-[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-orchestration
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/chain-orchestration/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-orchestration
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/chain-orchestration
-[socket-link]: https://socket.dev/npm/package/@xyo-network/chain-orchestration
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-orchestration.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/dist/browser/index.mjs

@@ -354,140 +354,6 @@ var isValidatorConfigContext = zodIsFactory6(ValidatorConfigContext);
 var asValidatorConfigContext = zodAsFactory6(ValidatorConfigContext, "asValidatorConfigContext");
 var toValidatorConfigContext = zodToFactory6(ValidatorConfigContext, "toValidatorConfigContext");
 
-// src/shared/config/locators/basicRemoteRunnerLocator.ts
-import { isDefined as isDefined2 } from "@xylabs/sdk-js";
-import { JsonRpcXyoRunner, JsonRpcXyoSigner, ProviderFactoryLocator as ProviderFactoryLocator4, RestDataLakeViewer as RestDataLakeViewer2, SimpleXyoConnectionRunner, SimpleXyoGatewayRunner } from "@xyo-network/xl1-sdk";
-
-// src/shared/config/locators/basicRemoteViewerLocator.ts
-import { isDefined } from "@xylabs/sdk-js";
-import { ActorConfigZod as ActorConfigZod2, ProviderFactoryLocator as ProviderFactoryLocator3, RestDataLakeViewer, SimpleTransactionViewer as SimpleTransactionViewer2, SimpleXyoConnectionViewer, SimpleXyoGateway } from "@xyo-network/xl1-sdk";
-
-// src/shared/config/locators/commonLocatorFromConfig.ts
-import { ProviderFactoryLocator, SimpleBlockRewardViewer, SimpleNetworkStakeViewer, SimpleStepRewardsByPositionViewer, SimpleStepRewardsByStakerViewer, SimpleStepRewardsByStepViewer, SimpleStepRewardsTotalViewer, SimpleStepRewardsViewer, SimpleStepViewer, SimpleTimeSyncViewer, SimpleTransactionValidationViewer, SimpleTransactionViewer, SimpleWindowedBlockViewer } from "@xyo-network/xl1-sdk";
-function commonLocatorFromConfig(context, validateDepsOnRegister = false) {
-  const locator = new ProviderFactoryLocator(context, {}, validateDepsOnRegister);
-  locator.registerMany([
-    SimpleNetworkStakeViewer.factory(SimpleNetworkStakeViewer.dependencies, {}),
-    SimpleTimeSyncViewer.factory(SimpleTimeSyncViewer.dependencies, {}),
-    SimpleStepViewer.factory(SimpleStepViewer.dependencies, {}),
-    SimpleStepRewardsViewer.factory(SimpleStepRewardsViewer.dependencies, {}),
-    SimpleStepRewardsByPositionViewer.factory(SimpleStepRewardsByPositionViewer.dependencies, {}),
-    SimpleStepRewardsByStakerViewer.factory(SimpleStepRewardsByStakerViewer.dependencies, {}),
-    SimpleStepRewardsByStepViewer.factory(SimpleStepRewardsByStepViewer.dependencies, {}),
-    SimpleStepRewardsTotalViewer.factory(SimpleStepRewardsTotalViewer.dependencies, {}),
-    SimpleWindowedBlockViewer.factory(SimpleWindowedBlockViewer.dependencies, {
-      maxWindowSize: 1e3,
-      syncInterval: 1e4
-    }),
-    SimpleBlockRewardViewer.factory(SimpleBlockRewardViewer.dependencies, {}),
-    SimpleTransactionViewer.factory(SimpleTransactionViewer.dependencies, {}),
-    SimpleTransactionValidationViewer.factory(SimpleTransactionValidationViewer.dependencies, {})
-  ]);
-  return locator;
-}
-__name(commonLocatorFromConfig, "commonLocatorFromConfig");
-
-// src/shared/config/locators/remoteLocatorFromConfig.ts
-import { validateHydratedBlock, validateHydratedBlockState } from "@xyo-network/chain-validation";
-import { BlockCumulativeBalanceValidatorFactory, JsonRpcAccountBalanceViewer, JsonRpcBlockViewer, JsonRpcFinalizationViewer, JsonRpcMempoolRunner, JsonRpcMempoolViewer, JsonRpcNetworkStakeViewer, JsonRpcStakeViewer, JsonRpcTransactionViewer, JsonRpcXyoViewer, ProviderFactoryLocator as ProviderFactoryLocator2, SimpleBlockValidationViewer, SimpleStakeEventsViewer } from "@xyo-network/xl1-sdk";
-var cumulativeBalanceValidator = BlockCumulativeBalanceValidatorFactory();
-var validateHydratedBlockStateWithCumulativeBalance = /* @__PURE__ */ __name(async (context, block) => {
-  const [stateErrors, cumulativeErrors] = await Promise.all([
-    validateHydratedBlockState(context, block),
-    cumulativeBalanceValidator(context, block)
-  ]);
-  return [
-    ...stateErrors,
-    ...cumulativeErrors
-  ];
-}, "validateHydratedBlockStateWithCumulativeBalance");
-function remoteLocatorFromConfig(context, validateDepsOnRegister = false) {
-  const locator = new ProviderFactoryLocator2(context, {}, validateDepsOnRegister);
-  locator.registerMany([
-    JsonRpcMempoolViewer.factory(JsonRpcMempoolViewer.dependencies, {}),
-    JsonRpcMempoolRunner.factory(JsonRpcMempoolRunner.dependencies, {}),
-    JsonRpcAccountBalanceViewer.factory(JsonRpcAccountBalanceViewer.dependencies, {}),
-    JsonRpcFinalizationViewer.factory(JsonRpcFinalizationViewer.dependencies, {}),
-    JsonRpcBlockViewer.factory(JsonRpcBlockViewer.dependencies, {}),
-    JsonRpcTransactionViewer.factory(JsonRpcTransactionViewer.dependencies, {}),
-    JsonRpcNetworkStakeViewer.factory(JsonRpcNetworkStakeViewer.dependencies, {}),
-    JsonRpcStakeViewer.factory(JsonRpcStakeViewer.dependencies, {}),
-    SimpleStakeEventsViewer.factory(SimpleStakeEventsViewer.dependencies, {
-      positions: []
-    }),
-    JsonRpcXyoViewer.factory(JsonRpcXyoViewer.dependencies, {}),
-    SimpleBlockValidationViewer.factory(SimpleBlockValidationViewer.dependencies, {
-      state: validateHydratedBlockStateWithCumulativeBalance,
-      protocol: validateHydratedBlock
-    })
-  ]);
-  return locator;
-}
-__name(remoteLocatorFromConfig, "remoteLocatorFromConfig");
-
-// src/shared/config/locators/basicRemoteViewerLocator.ts
-async function baseBasicRemoteViewerLocator(name, remoteConfig, dataLakeEndpoint, options) {
-  const config = ActorConfigZod2.parse({
-    name,
-    remote: remoteConfig
-  });
-  const rootLocator = await commonLocatorFromConfig({
-    config,
-    singletons: {},
-    caches: {}
-  });
-  const remoteLocator = await remoteLocatorFromConfig(rootLocator.context);
-  const locator = new ProviderFactoryLocator3(remoteLocator.context, {});
-  locator.registerMany([
-    SimpleXyoGateway.factory(SimpleXyoGateway.dependencies, {}),
-    SimpleXyoConnectionViewer.factory(SimpleXyoConnectionViewer.dependencies, {}),
-    SimpleTransactionViewer2.factory(SimpleTransactionViewer2.dependencies, {}),
-    ...options?.additionalProviders ?? []
-  ]);
-  if (isDefined(dataLakeEndpoint)) {
-    const dataLakeViewerParams = {
-      endpoint: dataLakeEndpoint
-    };
-    locator.register(RestDataLakeViewer.factory(RestDataLakeViewer.dependencies, dataLakeViewerParams));
-  }
-  locator.freeze();
-  return locator;
-}
-__name(baseBasicRemoteViewerLocator, "baseBasicRemoteViewerLocator");
-
-// src/shared/config/locators/basicRemoteRunnerLocator.ts
-async function baseBasicRemoteRunnerLocator(name, remoteConfig, signerTransport, dataLakeEndpoint, options) {
-  const remoteViewerLocator = await baseBasicRemoteViewerLocator(name, remoteConfig, dataLakeEndpoint, options);
-  const locator = new ProviderFactoryLocator4(remoteViewerLocator.context, {});
-  const providers = [
-    SimpleXyoConnectionRunner.factory(SimpleXyoConnectionRunner.dependencies, {}),
-    JsonRpcXyoRunner.factory(JsonRpcXyoRunner.dependencies, {})
-  ];
-  if (!options?.skipGatewayRunner) {
-    providers.push(SimpleXyoGatewayRunner.factory(SimpleXyoGatewayRunner.dependencies, {}));
-  }
-  locator.registerMany([
-    ...providers,
-    ...options?.additionalRunnerProviders ?? []
-  ]);
-  if (options?.signerFactory) {
-    locator.register(options.signerFactory);
-  } else {
-    locator.register(JsonRpcXyoSigner.factory(JsonRpcXyoSigner.dependencies, {
-      transport: signerTransport
-    }));
-  }
-  if (isDefined2(dataLakeEndpoint)) {
-    const dataLakeViewerParams = {
-      endpoint: dataLakeEndpoint
-    };
-    locator.register(RestDataLakeViewer2.factory(RestDataLakeViewer2.dependencies, dataLakeViewerParams));
-  }
-  locator.freeze();
-  return locator;
-}
-__name(baseBasicRemoteRunnerLocator, "baseBasicRemoteRunnerLocator");
-
 // src/shared/config/mergeConfig.ts
 import { deepMerge } from "@xylabs/sdk-js";
 function mergeConfig({ actors, ...baseConfig }) {
@@ -553,13 +419,13 @@ var ServiceLifetime = {
 };
 
 // src/shared/init/initActorAccount.ts
-import { isDefined as isDefined3, isUndefined } from "@xylabs/sdk-js";
+import { isDefined, isUndefined } from "@xylabs/sdk-js";
 import { HDWallet } from "@xyo-network/sdk-js";
 import { ADDRESS_INDEX, generateXyoBaseWalletFromPhrase } from "@xyo-network/xl1-sdk";
 var actorAccountSingletons = {};
 async function initActorAccount({ config, logger }) {
   const actorName = config.name;
-  if (isDefined3(actorAccountSingletons[actorName])) return actorAccountSingletons[actorName];
+  if (isDefined(actorAccountSingletons[actorName])) return actorAccountSingletons[actorName];
   let walletPhrase = config.mnemonic;
   if (isUndefined(walletPhrase)) {
     logger?.warn(`[${actorName}}] No wallet mnemonic specified!`);
@@ -655,12 +521,12 @@ function initStatusReporter({ logger }) {
 __name(initStatusReporter, "initStatusReporter");
 
 // src/shared/init/initWallet.ts
-import { isDefined as isDefined4 } from "@xylabs/sdk-js";
+import { isDefined as isDefined2 } from "@xylabs/sdk-js";
 import { boot } from "@xyo-network/bios";
 import { HDWallet as HDWallet3 } from "@xyo-network/sdk-js";
 async function initActorWallet(context, mnemonic) {
   const bios = await boot();
-  const seedPhrase = isDefined4(mnemonic) ? mnemonic : await initActorSeedPhrase(context, bios);
+  const seedPhrase = isDefined2(mnemonic) ? mnemonic : await initActorSeedPhrase(context, bios);
   return await HDWallet3.fromPhrase(seedPhrase);
 }
 __name(initActorWallet, "initActorWallet");
@@ -731,19 +597,26 @@ Orchestrator = _ts_decorate2([
 ], Orchestrator);
 
 // src/neutral/config/locators/basicRemoteRunnerLocator.ts
-function basicRemoteRunnerLocator(name, remoteConfig, signerTransport, dataLakeEndpoint) {
-  return baseBasicRemoteRunnerLocator(name, remoteConfig, signerTransport, dataLakeEndpoint);
+import { basicRemoteRunnerLocator as sdkBasicRemoteRunnerLocator } from "@xyo-network/xl1-sdk";
+function basicRemoteRunnerLocator(name, remoteConfig, signerTransport, dataLakeEndpoint, validators) {
+  return sdkBasicRemoteRunnerLocator(name, remoteConfig, signerTransport, dataLakeEndpoint, {
+    validators
+  });
 }
 __name(basicRemoteRunnerLocator, "basicRemoteRunnerLocator");
 
 // src/neutral/config/locators/basicRemoteViewerLocator.ts
-function basicRemoteViewerLocator(name, remoteConfig, dataLakeEndpoint) {
-  return baseBasicRemoteViewerLocator(name, remoteConfig, dataLakeEndpoint);
+import { basicRemoteViewerLocator as sdkBasicRemoteViewerLocator } from "@xyo-network/xl1-sdk";
+function basicRemoteViewerLocator(name, remoteConfig, dataLakeEndpoint, validators) {
+  return sdkBasicRemoteViewerLocator(name, remoteConfig, dataLakeEndpoint, {
+    validators
+  });
 }
 __name(basicRemoteViewerLocator, "basicRemoteViewerLocator");
 
 // src/neutral/config/locators/rootLocatorFromConfig.ts
 import { assertEx as assertEx3 } from "@xylabs/sdk-js";
+import { commonLocatorFromConfig, remoteLocatorFromConfig } from "@xyo-network/xl1-sdk";
 async function rootLocatorFromConfig(context, validateDepsOnRegister = false) {
   const { config } = context;
   let locator = await commonLocatorFromConfig(context, validateDepsOnRegister);
@@ -785,12 +658,9 @@ export {
   asRewardRedemptionConfigContext,
   asValidatorConfig,
   asValidatorConfigContext,
-  baseBasicRemoteRunnerLocator,
-  baseBasicRemoteViewerLocator,
   basicRemoteRunnerLocator,
   basicRemoteViewerLocator,
   buildTelemetryConfig,
-  commonLocatorFromConfig,
   createProducerChainStakeIntentBlock,
   initActorAccount,
   initActorSeedPhrase,
@@ -811,7 +681,6 @@ export {
   isValidatorConfig,
   isValidatorConfigContext,
   mergeConfig,
-  remoteLocatorFromConfig,
   rootLocatorFromConfig,
   toApiConfig,
   toApiConfigContext,