@xyo-network/chain-api 1.16.21 → 1.16.23

package/dist/node/manifest/public/WithoutMempool/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/manifest/public/WithoutMempool/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAA0B,MAAM,6BAA6B,CAAA;AAazF;;GAEG;AACH,eAAO,MAAM,kCAAkC,EAAE,cAAc,EAG9D,CAAA"}

package/dist/node/manifest/public/index.d.ts

@@ -1,3 +0,0 @@
-export * from './WithMempool/index.ts';
-export * from './WithoutMempool/index.ts';
-//# sourceMappingURL=index.d.ts.map

package/dist/node/manifest/public/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/manifest/public/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,2BAA2B,CAAA"}

package/src/manifest/getLocator.ts

@@ -1,137 +0,0 @@
-import { BaseMongoSdk, type BaseMongoSdkPrivateConfig } from '@xylabs/mongo'
-import type { Hash, Logger } from '@xylabs/sdk-js'
-import {
-  asAddress, assertEx, isDefined,
-  ZERO_ADDRESS,
-} from '@xylabs/sdk-js'
-import { MemoryArchivist } from '@xyo-network/archivist-memory'
-import { MongoDBArchivistV2 } from '@xyo-network/archivist-mongodb'
-import { ViewArchivist } from '@xyo-network/archivist-view'
-import {
-  AddressBalanceDivinerV2, AddressTransferDiviner, ArchivistSyncDiviner, HeadValidationDiviner,
-} from '@xyo-network/chain-modules'
-import { MongoMap } from '@xyo-network/chain-protocol'
-import { initTelemetry } from '@xyo-network/chain-telemetry'
-import { AbstractModule, LoggerModuleStatusReporter } from '@xyo-network/module-abstract'
-import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
-import type { MongoDBModuleParamsV2 } from '@xyo-network/module-model-mongodb'
-import type { WithStorageMeta } from '@xyo-network/payload-model'
-import { MemorySentinel } from '@xyo-network/sentinel-memory'
-import { StepSizes } from '@xyo-network/xl1-protocol'
-import type {
-  BalancesStepSummary, Config, MapType, TransfersStepSummary,
-} from '@xyo-network/xl1-protocol-sdk'
-import { hasMongoConfig, MemoryMap } from '@xyo-network/xl1-protocol-sdk'
-import { Semaphore } from 'async-mutex'
-
-export interface GetLocatorContext {
-  config: Config
-  logger?: Logger
-}
-
-export async function getTransferSummaryMap(config: Config): Promise<MapType<string, WithStorageMeta<TransfersStepSummary>>> {
-  const mongoConfig = config.storage?.mongo
-  if (hasMongoConfig(mongoConfig)) {
-    // Create the MongoDB SDK from the configuration
-    const {
-      connectionString: dbConnectionString, database: dbName, domain: dbDomain, password: dbPassword, username: dbUserName,
-    } = mongoConfig
-    const payloadSdkConfig: BaseMongoSdkPrivateConfig = {
-      dbConnectionString, dbDomain, dbName, dbPassword, dbUserName,
-    }
-
-    const sdkTransferSummaryMap = new BaseMongoSdk<WithStorageMeta<TransfersStepSummary>>({ ...payloadSdkConfig, collection: 'transfer_summary_map' })
-    const result = await MongoMap.create<MongoMap<Hash, WithStorageMeta<TransfersStepSummary>>>({
-      sdk: sdkTransferSummaryMap,
-      getCache: { enabled: true, maxEntries: 5000 },
-    })
-    assertEx(await result.start(), () => 'Failed to start transfer summary map')
-    return result
-  } else {
-    console.warn('[API] Mongo configuration not found. Using MemoryMap for TransferSummaryMap.')
-    return new MemoryMap<string, WithStorageMeta<TransfersStepSummary>>()
-  }
-}
-
-/**
- * Used for retrieving a locator with the necessary modules registered for testing
- * operation of the node (entirely in memory)
- * @returns A locator with the necessary modules registered
- */
-export const getLocator = async (context: GetLocatorContext) => {
-  const { config, logger } = context
-  const { otlpEndpoint } = config.telemetry?.otel ?? {}
-  const { traceProvider, meterProvider } = await initTelemetry({
-    attributes: {
-      serviceName: 'xl1-api',
-      serviceVersion: '1.0.0',
-    },
-    otlpEndpoint,
-    metricsConfig: {
-      endpoint: '/metrics',
-      port: 9465,
-    },
-  })
-
-  if (isDefined(logger)) AbstractModule.defaultLogger = logger
-  const statusReporter = logger ? new LoggerModuleStatusReporter(logger) : undefined
-
-  const locator = new ModuleFactoryLocator()
-  let balanceSummaryMap: MapType<string, WithStorageMeta<BalancesStepSummary>> | undefined
-  let transferSummaryMap = await getTransferSummaryMap(config)
-  // If there's a MongoDB configuration
-  const mongoConfig = config.storage?.mongo
-  if (hasMongoConfig(mongoConfig)) {
-    // Create the MongoDB SDK from the configuration
-    const {
-      connectionString: dbConnectionString, database: dbName, domain: dbDomain, password: dbPassword, username: dbUserName,
-    } = mongoConfig
-    const payloadSdkConfig: BaseMongoSdkPrivateConfig = {
-      dbConnectionString, dbDomain, dbName, dbPassword, dbUserName,
-    }
-    const params: Partial<MongoDBModuleParamsV2> = {
-      meterProvider, payloadSdkConfig, statusReporter, traceProvider,
-    }
-    // Register the MongoDB Archivist as the default
-    locator.register(MongoDBArchivistV2.factory(params), undefined, true)
-
-    // Use a persistent MongoMap for the summary repository if MongoDB is configured
-    const sdkBalanceSummaryMap = new BaseMongoSdk<WithStorageMeta<BalancesStepSummary>>({ ...payloadSdkConfig, collection: 'balance_summary_map' })
-    balanceSummaryMap = await MongoMap.create<MongoMap<Hash, WithStorageMeta<BalancesStepSummary>>>({
-      sdk: sdkBalanceSummaryMap,
-      getCache: { enabled: true, maxEntries: 5000 },
-    })
-  }
-
-  locator.register(AddressBalanceDivinerV2.factory<AddressBalanceDivinerV2>({
-    traceProvider, meterProvider, statusReporter, summaryMap: balanceSummaryMap, stepSemaphores: StepSizes.map(() => new Semaphore(20)),
-  }))
-
-  locator.register(AddressTransferDiviner.factory<AddressTransferDiviner>({
-    traceProvider, meterProvider, statusReporter, summaryMap: transferSummaryMap, stepSemaphores: StepSizes.map(() => new Semaphore(20)),
-  }))
-
-  const chainId = isDefined(config.chain.id)
-    ? assertEx(asAddress(config.chain.id), () => 'chain.id must be an Address')
-    : ZERO_ADDRESS
-  locator.register(HeadValidationDiviner.factory<HeadValidationDiviner>({
-    traceProvider,
-    meterProvider,
-    statusReporter,
-    chainId,
-    allowedProducers: config.producer.allowlist,
-  }))
-  locator.register(MemoryArchivist.factory({
-    traceProvider, meterProvider, statusReporter,
-  }))
-  locator.register(MemorySentinel.factory({
-    traceProvider, meterProvider, statusReporter,
-  }))
-  locator.register(ViewArchivist.factory({
-    traceProvider, meterProvider, statusReporter,
-  }))
-  locator.register(ArchivistSyncDiviner.factory({
-    traceProvider, meterProvider, statusReporter,
-  }))
-  return locator
-}

package/src/manifest/getNode.ts

@@ -1,34 +0,0 @@
-import type { Logger } from '@xylabs/sdk-js'
-import { ManifestWrapper } from '@xyo-network/manifest-wrapper'
-import type { WalletInstance } from '@xyo-network/wallet-model'
-import type { Config } from '@xyo-network/xl1-protocol-sdk'
-
-import { getLocator } from './getLocator.ts'
-import { NodeManifest } from './nodeManifest.ts'
-import { PrivateChildManifests } from './private/index.ts'
-import { PublicChildManifestsWithMempool, PublicChildManifestsWithoutMempool } from './public/index.ts'
-
-export interface GetNodeContext {
-  config: Config
-  logger?: Logger
-  wallet: WalletInstance
-}
-
-/**
- * Creates a node with the xyo-chain modules registered
- * @param context The context to use for the node
- * @returns A node with the xyo-chain modules registered
- */
-export const getNode = async (context: GetNodeContext) => {
-  const { wallet, config } = context
-  const { enabled: mempoolEnabled } = config.mempool
-  const PublicChildManifests = mempoolEnabled ? PublicChildManifestsWithoutMempool : PublicChildManifestsWithMempool
-  const locator = await getLocator(context)
-  const wrapper = new ManifestWrapper(NodeManifest, wallet, locator, PublicChildManifests, PrivateChildManifests)
-  const [node, ...childNodes] = await wrapper.loadNodes()
-  if (childNodes?.length > 0) {
-    await Promise.all(childNodes.map(childNode => node.register(childNode)))
-    await Promise.all(childNodes.map(childNode => node.attach(childNode.address, true)))
-  }
-  return node
-}

package/src/manifest/index.ts

@@ -1,5 +0,0 @@
-export * from './getLocator.ts'
-export * from './getNode.ts'
-export * from './nodeManifest.ts'
-export * from './private/index.ts'
-export * from './public/index.ts'

package/src/manifest/node.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "accountPath": "44'/60'/1",
-        "name": "XYOChain",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "private": [],
-        "public": []
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/manifest/nodeManifest.ts

@@ -1,8 +0,0 @@
-import type { PackageManifestPayload } from '@xyo-network/manifest-model'
-
-import node from './node.json' with { type: 'json' }
-
-/**
- * Root Node Manifest
- */
-export const NodeManifest = node as PackageManifestPayload

package/src/manifest/private/index.ts

@@ -1,4 +0,0 @@
-/**
- * Private Child Manifests
- */
-export const PrivateChildManifests = []

package/src/manifest/public/WithMempool/Chain.json

@@ -1,175 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "accountPath": "1",
-        "name": "Chain",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "private": [
-          {
-            "config": {
-              "accountPath": "1/1'/1'",
-              "name": "Validated",
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 5000
-              },
-              "payloadSdkConfig": {
-                "collection": "chain_validated"
-              },
-              "schema": "network.xyo.archivist.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1'/2'",
-              "schema": "network.xyo.diviner.chain.head.validation.config",
-              "eventSubscriptions": [
-                {
-                  "sourceEvent": "inserted",
-                  "sourceModule": "Submissions",
-                  "targetModuleFunction": "divine"
-                }
-              ],
-              "inArchivist": "Submissions",
-              "outArchivist": "Validated",
-              "name": "HeadValidationDiviner"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1'/3'",
-              "automations": [
-                {
-                  "frequency": 1000,
-                  "frequencyUnits": "millis",
-                  "schema": "network.xyo.automation.interval",
-                  "type": "interval"
-                }
-              ],
-              "name": "ChainValidationSentinel",
-              "schema": "network.xyo.sentinel.config",
-              "synchronous": true,
-              "tasks": [
-                {
-                  "mod": "HeadValidationDiviner",
-                  "endPoint": "divine"
-                }
-              ]
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1'/4'",
-              "automations": [
-                {
-                  "frequency": 10000,
-                  "frequencyUnits": "millis",
-                  "schema": "network.xyo.automation.interval",
-                  "type": "interval"
-                }
-              ],
-              "name": "AddressBalancePollingSentinel",
-              "schema": "network.xyo.sentinel.config",
-              "synchronous": true,
-              "tasks": [
-                {
-                  "mod": "AddressBalanceDiviner",
-                  "endPoint": "divine"
-                }
-              ]
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1'/5'",
-              "automations": [
-                {
-                  "frequency": 10000,
-                  "frequencyUnits": "millis",
-                  "schema": "network.xyo.automation.interval",
-                  "type": "interval"
-                }
-              ],
-              "name": "AddressTransferPollingSentinel",
-              "schema": "network.xyo.sentinel.config",
-              "synchronous": true,
-              "tasks": [
-                {
-                  "mod": "AddressTransferDiviner",
-                  "endPoint": "divine"
-                }
-              ]
-            }
-          }
-        ],
-        "public": [
-          {
-            "config": {
-              "accountPath": "1/1/1",
-              "name": "Submissions",
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 5000
-              },
-              "payloadSdkConfig": {
-                "collection": "chain_submissions"
-              },
-              "schema": "network.xyo.archivist.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1/2",
-              "name": "Finalized",
-              "allowedQueries": [
-                "network.xyo.query.archivist.get",
-                "network.xyo.query.archivist.next"
-              ],
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 50000
-              },
-              "originArchivist": "Validated",
-              "schema": "network.xyo.archivist.view.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1/3'",
-              "name": "AddressBalanceDiviner",
-              "schema": "network.xyo.diviner.chain.address.balance.config",
-              "map": {
-                "lmdb": {
-                  "dbName": "summaries",
-                  "storeName": "address_balance",
-                  "location": ".store"
-                }
-              },
-              "archivist": "Validated"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1/4'",
-              "name": "AddressTransferDiviner",
-              "schema": "network.xyo.diviner.chain.address.transfer.config",
-              "map": {
-                "lmdb": {
-                  "dbName": "summaries",
-                  "storeName": "address_transfer",
-                  "location": ".store"
-                }
-              },
-              "archivist": "Validated"
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/manifest/public/WithMempool/Pending.json

@@ -1,35 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "accountPath": "2",
-        "name": "Pending",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "private": [],
-        "public": [
-          {
-            "config": {
-              "accountPath": "2/1/1",
-              "name": "PendingTransactions",
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 5000
-              },
-              "labels": {
-                "network.xyo.storage.class": "mongodb"
-              },
-              "payloadSdkConfig": {
-                "collection": "pending_bundles"
-              },
-              "schema": "network.xyo.archivist.config"
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/manifest/public/WithMempool/index.ts

@@ -1,20 +0,0 @@
-import type { ModuleManifest, PackageManifestPayload } from '@xyo-network/manifest-model'
-
-import Chain from './Chain.json' with { type: 'json' }
-import Pending from './Pending.json' with { type: 'json' }
-
-/**
- * Chain Node Manifest
- */
-const ChainNodeManifest = Chain as PackageManifestPayload
-/**
- * Pending Node Manifest
- */
-const PendingNodeManifest = Pending as PackageManifestPayload
-/**
- * Public Child Manifests
- */
-export const PublicChildManifestsWithMempool: ModuleManifest[] = [
-  ...ChainNodeManifest.nodes,
-  ...PendingNodeManifest.nodes,
-]

package/src/manifest/public/WithoutMempool/Chain.json

@@ -1,97 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "accountPath": "1",
-        "name": "Chain",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "private": [
-          {
-            "config": {
-              "accountPath": "1/1'/1'",
-              "name": "Validated",
-              "allowedQueries": [
-                "network.xyo.query.archivist.get",
-                "network.xyo.query.archivist.next"
-              ],
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 5000
-              },
-              "payloadSdkConfig": {
-                "collection": "chain_validated"
-              },
-              "schema": "network.xyo.archivist.config"
-            }
-          }
-        ],
-        "public": [
-          {
-            "config": {
-              "accountPath": "1/1/1",
-              "name": "Submissions",
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 5000
-              },
-              "payloadSdkConfig": {
-                "collection": "chain_submissions"
-              },
-              "schema": "network.xyo.archivist.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1/2",
-              "name": "Finalized",
-              "allowedQueries": [
-                "network.xyo.query.archivist.get",
-                "network.xyo.query.archivist.next"
-              ],
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 50000
-              },
-              "originArchivist": "Validated",
-              "schema": "network.xyo.archivist.view.config"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1/3'",
-              "name": "AddressBalanceDiviner",
-              "schema": "network.xyo.diviner.chain.address.balance.config",
-              "map": {
-                "lmdb": {
-                  "dbName": "summaries",
-                  "storeName": "address_balance",
-                  "location": ".store"
-                }
-              },
-              "archivist": "Validated"
-            }
-          },
-          {
-            "config": {
-              "accountPath": "1/1/4'",
-              "name": "AddressTransferDiviner",
-              "schema": "network.xyo.diviner.chain.address.transfer.config",
-              "map": {
-                "lmdb": {
-                  "dbName": "summaries",
-                  "storeName": "address_transfer",
-                  "location": ".store"
-                }
-              },
-              "archivist": "Validated"
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/manifest/public/WithoutMempool/Pending.json

@@ -1,35 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "accountPath": "2",
-        "name": "Pending",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "private": [],
-        "public": [
-          {
-            "config": {
-              "accountPath": "2/1/1",
-              "name": "PendingTransactions",
-              "getCache": {
-                "enabled": true,
-                "maxEntries": 5000
-              },
-              "labels": {
-                "network.xyo.storage.class": "mongodb"
-              },
-              "payloadSdkConfig": {
-                "collection": "pending_bundles"
-              },
-              "schema": "network.xyo.archivist.config"
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/manifest/public/WithoutMempool/index.ts

@@ -1,20 +0,0 @@
-import type { ModuleManifest, PackageManifestPayload } from '@xyo-network/manifest-model'
-
-import Chain from './Chain.json' with { type: 'json' }
-import Pending from './Pending.json' with { type: 'json' }
-
-/**
- * Chain Node Manifest
- */
- const ChainNodeManifest = Chain as PackageManifestPayload
-/**
- * Pending Node Manifest
- */
- const PendingNodeManifest = Pending as PackageManifestPayload
-/**
- * Public Child Manifests
- */
-export const PublicChildManifestsWithoutMempool: ModuleManifest[] = [
-  ...ChainNodeManifest.nodes,
-  ...PendingNodeManifest.nodes,
-]

package/src/manifest/public/index.ts

@@ -1,2 +0,0 @@
-export * from './WithMempool/index.ts'
-export * from './WithoutMempool/index.ts'