@xyo-network/os-runtime 4.0.2 → 4.0.4

package/dist/node/stack/Base.d.ts

@@ -1,8 +1,13 @@
 import type { BaseParams } from '@xylabs/object';
-import { BaseEmitter } from '@xyo-network/module-abstract';
+import { BaseEmitter } from '@xyo-network/module-event-emitter';
 import type { ModuleIdentifier } from '@xyo-network/module-model';
 import type { AttachableNodeInstance } from '@xyo-network/node-model';
 import type { AdapterSetCreator, NodeAdapter, StackBaseEvents, StackInitializer, XyOsContext } from '@xyo-network/os-model';
+/**
+ * Stack Base Class
+ *
+ * Listens for changes in adapter connections, update the stack node, and emits events when the stack is ready
+ */
 export declare class StackBase extends BaseEmitter<BaseParams, StackBaseEvents> implements StackInitializer {
     initialized: boolean;
     private _adapterSet;
@@ -17,7 +22,16 @@ export declare class StackBase extends BaseEmitter<BaseParams, StackBaseEvents>
     get stack(): AttachableNodeInstance;
     get stackNodeModuleId(): ModuleIdentifier;
     initialize(): void;
+    /**
+     * Stops the stack
+     */
     stop(): void;
+    /**
+     * Adds a node to the stack. Idempotent to avoid adding the
+     * same node multiple times
+     * @param node The node to add to the stack
+     * @returns
+     */
     private addNodeToStackNode;
     private assignStack;
     private getStackNode;

package/dist/node/stack/Base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Base.d.ts","sourceRoot":"","sources":["../../../src/stack/Base.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAC1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAA;AAErE,OAAO,KAAK,EACV,iBAAiB,EAAE,WAAW,EAAyB,eAAe,EAAE,gBAAgB,EAAE,WAAW,EACtG,MAAM,uBAAuB,CAAA;AAO9B,qBAAa,SAAU,SAAQ,WAAW,CAAC,UAAU,EAAE,eAAe,CAAE,YAAW,gBAAgB;IAEjG,WAAW,UAAQ;IAGnB,OAAO,CAAC,WAAW,CAAe;IAElC,OAAO,CAAC,QAAQ,CAAa;IAG7B,OAAO,CAAC,MAAM,CAAoC;IAGlD,OAAO,CAAC,kBAAkB,CAAkB;IAG5C,OAAO,CAAC,gBAAgB,CAA+B;IAIvD,OAAO,CAAC,SAAS,CAKT;gBAEI,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,gBAAgB;IAOpG,IAAI,UAAU,IAAI,WAAW,EAAE,CAE9B;IAED,IAAI,OAAO,IAAI,WAAW,CAEzB;IAED,IAAI,KAAK,IAAI,sBAAsB,CAElC;IAED,IAAI,iBAAiB,IAAI,gBAAgB,CAExC;IAED,UAAU;IA8BV,IAAI;YAeU,kBAAkB;IAahC,OAAO,CAAC,WAAW;YAQL,YAAY;YAKZ,iBAAiB;YAcjB,yBAAyB;CAYxC"}
+{"version":3,"file":"Base.d.ts","sourceRoot":"","sources":["../../../src/stack/Base.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAA;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAA;AAErE,OAAO,KAAK,EACV,iBAAiB,EAAE,WAAW,EAAyB,eAAe,EAAE,gBAAgB,EAAE,WAAW,EACtG,MAAM,uBAAuB,CAAA;AAE9B;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,WAAW,CAAC,UAAU,EAAE,eAAe,CAAE,YAAW,gBAAgB;IAEjG,WAAW,UAAQ;IAGnB,OAAO,CAAC,WAAW,CAAe;IAElC,OAAO,CAAC,QAAQ,CAAa;IAG7B,OAAO,CAAC,MAAM,CAAoC;IAGlD,OAAO,CAAC,kBAAkB,CAAkB;IAG5C,OAAO,CAAC,gBAAgB,CAA+B;IAIvD,OAAO,CAAC,SAAS,CAKT;gBAEI,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,gBAAgB;IAOpG,IAAI,UAAU,IAAI,WAAW,EAAE,CAE9B;IAED,IAAI,OAAO,IAAI,WAAW,CAEzB;IAED,IAAI,KAAK,IAAI,sBAAsB,CAElC;IAED,IAAI,iBAAiB,IAAI,gBAAgB,CAExC;IAED,UAAU;IA2BV;;OAEG;IACH,IAAI;IASJ;;;;;OAKG;YACW,kBAAkB;IAahC,OAAO,CAAC,WAAW;YAQL,YAAY;YAKZ,iBAAiB;YAcjB,yBAAyB;CAYxC"}

package/dist/node/utils/buildWalletSeedPhrasePayload.d.ts

@@ -1,11 +1,28 @@
 import type { Hash } from '@xylabs/hex';
 import type { WalletSeedPhrase } from '@xyo-network/os-model';
+/**
+ * The label for the user wallet
+ */
 export declare const userWalletLabel = "userWallet";
+/**
+ * The valid wallet labels
+ */
 export type WalletLabel = typeof userWalletLabel;
+/**
+ * Builds a WalletSeedPhrase payload from the supplied mnemonic seed phrase and label
+ * @param mnemonic The mnemonic seed phrase
+ * @param label The wallet label
+ * @returns A WalletSeedPhrase payload and its root hash
+ */
 export declare const buildWalletSeedPhrasePayload: (mnemonic: string, label: WalletLabel) => Promise<{
     payload: WalletSeedPhrase;
     rootHash: Hash;
 }>;
+/**
+ * Builds a user WalletSeedPhrase payload from the supplied mnemonic seed phrase and label
+ * @param mnemonic The mnemonic seed phrase
+ * @returns A user WalletSeedPhrase payload and its root hash
+ */
 export declare const buildUserWalletSeedPhrasePayload: (mnemonic: string) => Promise<{
     payload: WalletSeedPhrase;
     rootHash: Hash;

package/dist/node/utils/buildWalletSeedPhrasePayload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buildWalletSeedPhrasePayload.d.ts","sourceRoot":"","sources":["../../../src/utils/buildWalletSeedPhrasePayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAU7D,eAAO,MAAM,eAAe,eAAe,CAAA;AAK3C,MAAM,MAAM,WAAW,GAAG,OAAO,eAAe,CAAA;AAQhD,eAAO,MAAM,4BAA4B,aAAoB,MAAM,SAAS,WAAW,KAAG,OAAO,CAAC;IAChG,OAAO,EAAE,gBAAgB,CAAA;IACzB,QAAQ,EAAE,IAAI,CAAA;CACf,CAaA,CAAA;AAOD,eAAO,MAAM,gCAAgC,aAAc,MAAM,KAAG,OAAO,CAAC;IAC1E,OAAO,EAAE,gBAAgB,CAAA;IACzB,QAAQ,EAAE,IAAI,CAAA;CACf,CAEA,CAAA"}
+{"version":3,"file":"buildWalletSeedPhrasePayload.d.ts","sourceRoot":"","sources":["../../../src/utils/buildWalletSeedPhrasePayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAO7D;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,eAAe,CAAA;AAEhD;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,aAAoB,MAAM,SAAS,WAAW,KAAG,OAAO,CAAC;IAChG,OAAO,EAAE,gBAAgB,CAAA;IACzB,QAAQ,EAAE,IAAI,CAAA;CACf,CAaA,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,aAAc,MAAM,KAAG,OAAO,CAAC;IAC1E,OAAO,EAAE,gBAAgB,CAAA;IACzB,QAAQ,EAAE,IAAI,CAAA;CACf,CAEA,CAAA"}

package/dist/node/utils/renameObjKey.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Renames a key on an existing object by returning a new one with the same insertion order
+ *
+ * inspired by - https://stackoverflow.com/a/48110891/2803259
+ */
 export declare const renameObjKey: <T extends Record<string, unknown> = Record<string, unknown>>(oldObj: T, oldKey: keyof T, newKey: string) => T;
 //# sourceMappingURL=renameObjKey.d.ts.map

package/dist/node/utils/renameObjKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renameObjKey.d.ts","sourceRoot":"","sources":["../../../src/utils/renameObjKey.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,oCAAoC,CAAC,UAAU,MAAM,CAAC,UAAU,MAAM,KAejH,CAClB,CAAA"}
+{"version":3,"file":"renameObjKey.d.ts","sourceRoot":"","sources":["../../../src/utils/renameObjKey.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,oCAAoC,CAAC,UAAU,MAAM,CAAC,UAAU,MAAM,KAejH,CAClB,CAAA"}

package/dist/node/wallet/SeedPhraseRepository.d.ts

@@ -1,9 +1,29 @@
 import type { WalletId } from '@xyo-network/os-model';
+/** Convenience Types for Entities in the Repository */
 export type SeedPhraseId = string;
 export type SeedPhrase = string;
+/**
+ * A repository for storing wallet seed phrases and requesting them by walletIds (i.e. UUIDs)
+ */
 export interface SeedPhraseRepository {
+    /**
+     * Add a seed phrase for a given SeedPhraseId
+     * @param  {SeedPhraseId} id
+     * @returns Promise
+     */
     add(id: SeedPhraseId): Promise<string>;
+    /**
+     * For a given DappId, find its wallet or create a new wallet and return its walletId
+     * @param  {SeedPhraseId} dappName
+     * @returns Promise
+     */
     findOrCreate(dappName: SeedPhraseId): Promise<WalletId>;
+    /**
+     * Request a seed phrase by supplying a walletId. Note: In the future, the OS might require verification along side the walletId
+     *
+     * @param  {WalletId} walletId
+     * @returns DappWalletSeedPhrase
+     */
     request(walletId: WalletId): Promise<SeedPhrase | undefined>;
 }
 //# sourceMappingURL=SeedPhraseRepository.d.ts.map

package/dist/node/wallet/SeedPhraseRepository.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SeedPhraseRepository.d.ts","sourceRoot":"","sources":["../../../src/wallet/SeedPhraseRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAGrD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AACjC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAK/B,MAAM,WAAW,oBAAoB;IAMnC,GAAG,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAOtC,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAQvD,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;CAC7D"}
+{"version":3,"file":"SeedPhraseRepository.d.ts","sourceRoot":"","sources":["../../../src/wallet/SeedPhraseRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAErD,uDAAuD;AACvD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AACjC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEtC;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEvD;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;CAC7D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/os-runtime",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -36,44 +36,44 @@
     "xyos": "./dist/node/scripts/xyos/index.mjs"
   },
   "dependencies": {
-    "@xylabs/assert": "^4.1.0",
-    "@xylabs/forget": "^4.1.0",
-    "@xylabs/hex": "^4.1.0",
-    "@xylabs/lodash": "^4.1.0",
-    "@xylabs/object": "^4.1.0",
-    "@xylabs/promise": "^4.1.0",
-    "@xyo-network/account": "^3.2.0",
-    "@xyo-network/archivist": "^3.2.0",
-    "@xyo-network/archivist-indexeddb": "^3.2.0",
-    "@xyo-network/archivist-model": "^3.2.0",
-    "@xyo-network/bios": "^4.0.2",
-    "@xyo-network/bridge-model": "^3.2.0",
-    "@xyo-network/diviner-abstract": "^3.2.0",
-    "@xyo-network/diviner-model": "^3.2.0",
-    "@xyo-network/diviner-payload-generic": "^3.2.0",
-    "@xyo-network/diviner-payload-indexeddb": "^3.2.0",
-    "@xyo-network/diviner-payload-model": "^3.2.0",
-    "@xyo-network/diviner-temporal-indexing-model": "^3.2.0",
-    "@xyo-network/kernel": "^4.0.2",
-    "@xyo-network/kernel-model": "^4.0.2",
-    "@xyo-network/manifest": "^3.2.0",
-    "@xyo-network/manifest-wrapper": "^3.2.0",
-    "@xyo-network/module-abstract": "^3.2.0",
-    "@xyo-network/module-events": "^3.2.0",
-    "@xyo-network/module-factory-locator": "^3.2.0",
-    "@xyo-network/module-model": "^3.2.0",
-    "@xyo-network/module-resolver": "^3.2.0",
-    "@xyo-network/node-model": "^3.2.0",
-    "@xyo-network/os-model": "^4.0.2",
-    "@xyo-network/payload-builder": "^3.2.0",
-    "@xyo-network/payload-model": "^3.2.0",
-    "@xyo-network/storage-model": "^4.0.2",
-    "@xyo-network/wallet-model": "^3.2.0",
+    "@xylabs/assert": "^4.3.2",
+    "@xylabs/forget": "^4.3.2",
+    "@xylabs/hex": "^4.3.2",
+    "@xylabs/lodash": "^4.3.2",
+    "@xylabs/object": "^4.3.2",
+    "@xylabs/promise": "^4.3.2",
+    "@xyo-network/account": "^3.3.1",
+    "@xyo-network/archivist": "^3.3.1",
+    "@xyo-network/archivist-indexeddb": "^3.3.1",
+    "@xyo-network/archivist-model": "^3.3.1",
+    "@xyo-network/bios": "^4.0.4",
+    "@xyo-network/bridge-model": "^3.3.1",
+    "@xyo-network/diviner-abstract": "^3.3.1",
+    "@xyo-network/diviner-model": "^3.3.1",
+    "@xyo-network/diviner-payload-generic": "^3.3.1",
+    "@xyo-network/diviner-payload-indexeddb": "^3.3.1",
+    "@xyo-network/diviner-payload-model": "^3.3.1",
+    "@xyo-network/diviner-temporal-indexing-model": "^3.3.1",
+    "@xyo-network/kernel": "^4.0.4",
+    "@xyo-network/kernel-model": "^4.0.4",
+    "@xyo-network/manifest": "^3.3.1",
+    "@xyo-network/manifest-wrapper": "^3.3.1",
+    "@xyo-network/module-event-emitter": "^3.3.1",
+    "@xyo-network/module-events": "^3.3.1",
+    "@xyo-network/module-factory-locator": "^3.3.1",
+    "@xyo-network/module-model": "^3.3.1",
+    "@xyo-network/module-resolver": "^3.3.1",
+    "@xyo-network/node-model": "^3.3.1",
+    "@xyo-network/os-model": "^4.0.4",
+    "@xyo-network/payload-builder": "^3.3.1",
+    "@xyo-network/payload-model": "^3.3.1",
+    "@xyo-network/storage-model": "^4.0.4",
+    "@xyo-network/wallet-model": "^3.3.1",
     "async-mutex": "^0.5.0",
     "chalk": "^5.3.0",
     "cosmiconfig": "^9.0.0",
-    "cosmiconfig-typescript-loader": "^5.0.0",
-    "ethers": "^6.13.3",
+    "cosmiconfig-typescript-loader": "^6.0.0",
+    "ethers": "^6.13.4",
     "semver": "^7.6.3",
     "terminal-kit": "^3.1.1",
     "typescript": "^5.6.3",
@@ -85,11 +85,11 @@
     "@types/terminal-kit": "^2.5.6",
     "@types/uuid": "^10.0.0",
     "@types/yargs": "^17.0.33",
-    "@xylabs/ts-scripts-yarn3": "^4.1.0",
-    "@xylabs/tsconfig": "^4.1.0",
-    "@xyo-network/bios-model": "^4.0.2",
-    "@xyo-network/bios-nodejs": "^4.0.2",
-    "vitest": "^2.1.2"
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig": "^4.2.3",
+    "@xyo-network/bios-model": "^4.0.4",
+    "@xyo-network/bios-nodejs": "^4.0.4",
+    "vitest": "^2.1.3"
   },
   "publishConfig": {
     "access": "public"

package/src/XyOsBase.ts

@@ -4,7 +4,7 @@ import type { Promisable } from '@xylabs/promise'
 import type { WalletInstance } from '@xyo-network/account'
 import type { KernelExternal } from '@xyo-network/kernel-model'
 import type { PackageManifest } from '@xyo-network/manifest'
-import { BaseEmitter } from '@xyo-network/module-abstract'
+import { BaseEmitter } from '@xyo-network/module-event-emitter'
 import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
 import type { NodeInstance } from '@xyo-network/node-model'
 import type {

package/src/adapter/Base.ts

@@ -4,7 +4,7 @@ import type { BaseParams } from '@xylabs/object'
 import type { ArchivistModuleEventData } from '@xyo-network/archivist'
 import { asArchivistInstance } from '@xyo-network/archivist'
 import type { KernelExternal } from '@xyo-network/kernel-model'
-import { BaseEmitter } from '@xyo-network/module-abstract'
+import { BaseEmitter } from '@xyo-network/module-event-emitter'
 import { asAttachableNodeInstance } from '@xyo-network/node-model'
 import type { NodeAdapter, NodeAdapterBaseEvents } from '@xyo-network/os-model'
 import type { Payload, WithMeta } from '@xyo-network/payload-model'

package/src/event/bus/Connection.ts

@@ -1,6 +1,6 @@
 import { assertEx } from '@xylabs/assert'
 import type { BaseParams } from '@xylabs/object'
-import { BaseEmitter } from '@xyo-network/module-abstract'
+import { BaseEmitter } from '@xyo-network/module-event-emitter'
 import type { EventData } from '@xyo-network/module-events'
 import type {
   EventBusConnectionInterface, EventBusConnectionRequest, EventBusConnectionType,

package/src/stack/Base.ts

@@ -2,7 +2,7 @@ import { assertEx } from '@xylabs/assert'
 import { forget } from '@xylabs/forget'
 import type { BaseParams } from '@xylabs/object'
 import type { Promisable } from '@xylabs/promise'
-import { BaseEmitter } from '@xyo-network/module-abstract'
+import { BaseEmitter } from '@xyo-network/module-event-emitter'
 import type { ModuleIdentifier } from '@xyo-network/module-model'
 import { isModuleInstance } from '@xyo-network/module-model'
 import type { AttachableNodeInstance } from '@xyo-network/node-model'