@xyo-network/node-wrapper 2.53.19

package/dist/esm/NodeWrapper.js

@@ -0,0 +1,46 @@
+import { assertEx } from '@xylabs/assert';
+import { AddressSchema } from '@xyo-network/address-payload-plugin';
+import { ModuleWrapper } from '@xyo-network/module';
+import { XyoNodeAttachedQuerySchema, XyoNodeAttachQuerySchema, XyoNodeDetachQuerySchema, XyoNodeRegisteredQuerySchema, } from '@xyo-network/node-model';
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model';
+import { PayloadWrapper } from '@xyo-network/payload-wrapper';
+export class NodeWrapper extends ModuleWrapper {
+    static requiredQueries = [XyoNodeAttachQuerySchema, ...ModuleWrapper.requiredQueries];
+    static isNodeModule(module) {
+        const missingRequiredQueries = this.missingRequiredQueries(module);
+        return missingRequiredQueries.length === 0;
+    }
+    static tryWrap(module, account) {
+        if (module) {
+            const missingRequiredQueries = this.missingRequiredQueries(module);
+            if (missingRequiredQueries.length > 0) {
+                this.defaultLogger?.debug(`Missing queries: ${JSON.stringify(missingRequiredQueries, null, 2)}`);
+            }
+            else {
+                return new NodeWrapper({ account, module });
+            }
+        }
+    }
+    static wrap(module, account) {
+        return assertEx(this.tryWrap(module, account), 'Unable to wrap module as NodeWrapper');
+    }
+    async attach(address, external) {
+        const queryPayload = PayloadWrapper.parse({ address, external, schema: XyoNodeAttachQuerySchema });
+        await this.sendQuery(queryPayload);
+    }
+    async attached() {
+        const queryPayload = PayloadWrapper.parse({ schema: XyoNodeAttachedQuerySchema });
+        const payloads = (await this.sendQuery(queryPayload)).filter(isPayloadOfSchemaType(AddressSchema));
+        return payloads.map((p) => p.address);
+    }
+    async detach(address) {
+        const queryPayload = PayloadWrapper.parse({ address, schema: XyoNodeDetachQuerySchema });
+        await this.sendQuery(queryPayload);
+    }
+    async registered() {
+        const queryPayload = PayloadWrapper.parse({ schema: XyoNodeRegisteredQuerySchema });
+        const payloads = (await this.sendQuery(queryPayload)).filter(isPayloadOfSchemaType(AddressSchema));
+        return payloads.map((p) => p.address);
+    }
+}
+//# sourceMappingURL=NodeWrapper.js.map

package/dist/esm/NodeWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeWrapper.js","sourceRoot":"","sources":["../../src/NodeWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAkB,aAAa,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAU,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAGL,0BAA0B,EAE1B,wBAAwB,EAExB,wBAAwB,EAExB,4BAA4B,GAC7B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAE7D,MAAM,OAAO,WAA4D,SAAQ,aAA6B;IAC5G,MAAM,CAAU,eAAe,GAAG,CAAC,wBAAwB,EAAE,GAAG,aAAa,CAAC,eAAe,CAAC,CAAA;IAE9F,MAAM,CAAC,YAAY,CAAC,MAAc;QAChC,MAAM,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;QAClE,OAAO,sBAAsB,CAAC,MAAM,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED,MAAM,CAAU,OAAO,CAA0C,MAAgB,EAAE,OAAyB;QAC1G,IAAI,MAAM,EAAE;YACV,MAAM,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;YAClE,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;aACjG;iBAAM;gBACL,OAAO,IAAI,WAAW,CAAU,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;aACrD;SACF;IACH,CAAC;IAED,MAAM,CAAU,IAAI,CAA0C,MAAgB,EAAE,OAAyB;QACvG,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,sCAAsC,CAAC,CAAA;IACxF,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,QAAkB;QAC9C,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAqB,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAA;QACtH,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAuB,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAC,CAAA;QACvG,MAAM,QAAQ,GAAqB,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAiB,aAAa,CAAC,CAAC,CAAA;QACpI,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IACvC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAqB,EAAE,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAA;QAC5G,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAyB,EAAE,MAAM,EAAE,4BAA4B,EAAE,CAAC,CAAA;QAC3G,MAAM,QAAQ,GAAqB,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAiB,aAAa,CAAC,CAAC,CAAA;QACpI,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IACvC,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './NodeWrapper';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}

package/dist/types/NodeWrapper.d.ts

@@ -0,0 +1,14 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { Module, ModuleWrapper } from '@xyo-network/module';
+import { NodeModule } from '@xyo-network/node-model';
+export declare class NodeWrapper<TWrappedModule extends NodeModule = NodeModule> extends ModuleWrapper<TWrappedModule> {
+    static requiredQueries: string[];
+    static isNodeModule(module: Module): boolean;
+    static tryWrap<TModule extends NodeModule = NodeModule>(module?: TModule, account?: AccountInstance): NodeWrapper<TModule> | undefined;
+    static wrap<TModule extends NodeModule = NodeModule>(module?: TModule, account?: AccountInstance): NodeWrapper<TModule>;
+    attach(address: string, external?: boolean): Promise<void>;
+    attached(): Promise<string[]>;
+    detach(address: string): Promise<void>;
+    registered(): Promise<string[]>;
+}
+//# sourceMappingURL=NodeWrapper.d.ts.map

package/dist/types/NodeWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeWrapper.d.ts","sourceRoot":"","sources":["../../src/NodeWrapper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAE5D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EACL,UAAU,EASX,MAAM,yBAAyB,CAAA;AAIhC,qBAAa,WAAW,CAAC,cAAc,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,aAAa,CAAC,cAAc,CAAC;IAC5G,OAAgB,eAAe,WAA+D;IAE9F,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM;WAKlB,OAAO,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS;WAW/H,IAAI,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC;IAI1H,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1D,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAM7B,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtC,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAKtC"}

package/dist/types/index.d.ts

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

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@xyo-network/node-wrapper",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.7.6",
+    "@xyo-network/account-model": "^2.53.19",
+    "@xyo-network/address-payload-plugin": "^2.53.19",
+    "@xyo-network/module": "^2.53.19",
+    "@xyo-network/node-model": "^2.53.19",
+    "@xyo-network/payload-model": "^2.53.19",
+    "@xyo-network/payload-wrapper": "^2.53.19"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^2.16.1",
+    "@xylabs/tsconfig": "^2.16.1",
+    "typescript": "^4.9.5"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "version": "2.53.19"
+}

package/src/NodeWrapper.ts

@@ -0,0 +1,63 @@
+import { assertEx } from '@xylabs/assert'
+import { AccountInstance } from '@xyo-network/account-model'
+import { AddressPayload, AddressSchema } from '@xyo-network/address-payload-plugin'
+import { Module, ModuleWrapper } from '@xyo-network/module'
+import {
+  NodeModule,
+  XyoNodeAttachedQuery,
+  XyoNodeAttachedQuerySchema,
+  XyoNodeAttachQuery,
+  XyoNodeAttachQuerySchema,
+  XyoNodeDetachQuery,
+  XyoNodeDetachQuerySchema,
+  XyoNodeRegisteredQuery,
+  XyoNodeRegisteredQuerySchema,
+} from '@xyo-network/node-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+
+export class NodeWrapper<TWrappedModule extends NodeModule = NodeModule> extends ModuleWrapper<TWrappedModule> {
+  static override requiredQueries = [XyoNodeAttachQuerySchema, ...ModuleWrapper.requiredQueries]
+
+  static isNodeModule(module: Module) {
+    const missingRequiredQueries = this.missingRequiredQueries(module)
+    return missingRequiredQueries.length === 0
+  }
+
+  static override tryWrap<TModule extends NodeModule = NodeModule>(module?: TModule, account?: AccountInstance): NodeWrapper<TModule> | undefined {
+    if (module) {
+      const missingRequiredQueries = this.missingRequiredQueries(module)
+      if (missingRequiredQueries.length > 0) {
+        this.defaultLogger?.debug(`Missing queries: ${JSON.stringify(missingRequiredQueries, null, 2)}`)
+      } else {
+        return new NodeWrapper<TModule>({ account, module })
+      }
+    }
+  }
+
+  static override wrap<TModule extends NodeModule = NodeModule>(module?: TModule, account?: AccountInstance): NodeWrapper<TModule> {
+    return assertEx(this.tryWrap(module, account), 'Unable to wrap module as NodeWrapper')
+  }
+
+  async attach(address: string, external?: boolean): Promise<void> {
+    const queryPayload = PayloadWrapper.parse<XyoNodeAttachQuery>({ address, external, schema: XyoNodeAttachQuerySchema })
+    await this.sendQuery(queryPayload)
+  }
+
+  async attached(): Promise<string[]> {
+    const queryPayload = PayloadWrapper.parse<XyoNodeAttachedQuery>({ schema: XyoNodeAttachedQuerySchema })
+    const payloads: AddressPayload[] = (await this.sendQuery(queryPayload)).filter(isPayloadOfSchemaType<AddressPayload>(AddressSchema))
+    return payloads.map((p) => p.address)
+  }
+
+  async detach(address: string): Promise<void> {
+    const queryPayload = PayloadWrapper.parse<XyoNodeDetachQuery>({ address, schema: XyoNodeDetachQuerySchema })
+    await this.sendQuery(queryPayload)
+  }
+
+  async registered(): Promise<string[]> {
+    const queryPayload = PayloadWrapper.parse<XyoNodeRegisteredQuery>({ schema: XyoNodeRegisteredQuerySchema })
+    const payloads: AddressPayload[] = (await this.sendQuery(queryPayload)).filter(isPayloadOfSchemaType<AddressPayload>(AddressSchema))
+    return payloads.map((p) => p.address)
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './NodeWrapper'