@xyo-network/network 0.57.0 → 2.20.18

package/dist/index.js

@@ -1,88 +0,0 @@
-"use strict";
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 20th November 2018 10:18:42 am
- * @Email:  developer@xyfindables.com
- * @Filename: index.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Wednesday, 13th February 2019 1:28:15 pm
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const catalogue_item_1 = require("./catalogue-item");
-var catalogue_item_2 = require("./catalogue-item");
-exports.CatalogueItem = catalogue_item_2.CatalogueItem;
-var xyo_mock_network_pipe_1 = require("./xyo-mock-network-pipe");
-exports.XyoMockNetworkPipe = xyo_mock_network_pipe_1.XyoMockNetworkPipe;
-/**
- * Some very important numbers that factor into the catalogue negotiation protocol
- */
-/** The current number of bytes that encode the length if the catalogue */
-exports.CATALOGUE_LENGTH_IN_BYTES = 4;
-/** This number of bytes allowed to encode how big the catalogue can be */
-exports.CATALOGUE_SIZE_OF_SIZE_BYTES = 1;
-/**
- * When a payload is passed it is padded with the length of bytes of the payload.
- * It gets 4 bytes to do so
- */
-exports.CATALOGUE_SIZE_OF_PAYLOAD_BYTES = 4;
-/**
- * A utility function for translating a buffer to a list of catalogues items
- * that another node is willing to do.
- *
- * @param buffer The data buffer to read and translate
- */
-function bufferToCatalogueItems(buffer) {
-    const values = readNumberFromBufferCatalogue(buffer);
-    return [
-        (catalogue_item_1.CatalogueItem.BOUND_WITNESS & values) > 0 ? catalogue_item_1.CatalogueItem.BOUND_WITNESS : null,
-        (catalogue_item_1.CatalogueItem.TAKE_ORIGIN_CHAIN & values) > 0 ? catalogue_item_1.CatalogueItem.TAKE_ORIGIN_CHAIN : null,
-        (catalogue_item_1.CatalogueItem.GIVE_ORIGIN_CHAIN & values) > 0 ? catalogue_item_1.CatalogueItem.GIVE_ORIGIN_CHAIN : null
-    ]
-        .filter(catalogueItem => catalogueItem !== null);
-}
-exports.bufferToCatalogueItems = bufferToCatalogueItems;
-function flipChoice(choice) {
-    if (catalogue_item_1.CatalogueItem.GIVE_ORIGIN_CHAIN === choice) {
-        return catalogue_item_1.CatalogueItem.TAKE_ORIGIN_CHAIN;
-    }
-    if (catalogue_item_1.CatalogueItem.TAKE_ORIGIN_CHAIN === choice) {
-        return catalogue_item_1.CatalogueItem.GIVE_ORIGIN_CHAIN;
-    }
-    return choice;
-}
-exports.flipChoice = flipChoice;
-const readNumberFromBufferCatalogue = (buffer) => {
-    if (buffer.length === 4) {
-        return buffer.readUInt32BE(0);
-    }
-    if (buffer.length === 2) {
-        return buffer.readUInt16BE(0);
-    }
-    if (buffer.length === 1) {
-        return buffer.readUInt8(0);
-    }
-    return 0;
-};
-/** Returns a number, which is feature-mask representing CatalogueItems */
-function catalogueItemsToMask(catalogueItems) {
-    return catalogueItems.reduce((sum, item) => sum + item, 0);
-}
-exports.catalogueItemsToMask = catalogueItemsToMask;
-class XyoNetworkProcedureCatalogue {
-    constructor() {
-        this.catalogue = [];
-    }
-    canDo(catalogueItem) {
-        return this.catalogue.indexOf(catalogueItem) > -1;
-    }
-    getCurrentCatalogue() {
-        return this.catalogue;
-    }
-    setCatalogue(catalogue) {
-        this.catalogue = catalogue;
-    }
-}
-exports.XyoNetworkProcedureCatalogue = XyoNetworkProcedureCatalogue;
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;AAEH,qDAAgD;AAGhD,mDAAgD;AAAvC,yCAAA,aAAa,CAAA;AACtB,iEAA4D;AAAnD,qDAAA,kBAAkB,CAAA;AAG3B;;GAEG;AAEH,0EAA0E;AAC7D,QAAA,yBAAyB,GAAG,CAAC,CAAA;AAE1C,0EAA0E;AAC7D,QAAA,4BAA4B,GAAG,CAAC,CAAA;AAE7C;;;GAGG;AACU,QAAA,+BAA+B,GAAG,CAAC,CAAA;AAEhD;;;;;GAKG;AAEH,SAAgB,sBAAsB,CAAC,MAAc;IACnD,MAAM,MAAM,GAAG,6BAA6B,CAAC,MAAM,CAAC,CAAA;IAEpD,OAAO;QACL,CAAC,8BAAa,CAAC,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,8BAAa,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI;QAC/E,CAAC,8BAAa,CAAC,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,8BAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI;QACvF,CAAC,8BAAa,CAAC,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,8BAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI;KACxF;SACA,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,aAAa,KAAK,IAAI,CAAoB,CAAA;AACrE,CAAC;AATD,wDASC;AAED,SAAgB,UAAU,CAAC,MAAqB;IAC9C,IAAI,8BAAa,CAAC,iBAAiB,KAAK,MAAM,EAAE;QAC9C,OAAO,8BAAa,CAAC,iBAAiB,CAAA;KACvC;IAED,IAAI,8BAAa,CAAC,iBAAiB,KAAK,MAAM,EAAE;QAC9C,OAAO,8BAAa,CAAC,iBAAiB,CAAA;KACvC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAVD,gCAUC;AAED,MAAM,6BAA6B,GAAG,CAAC,MAAc,EAAU,EAAE;IAC/D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;KAC9B;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;KAC9B;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;KAC3B;IAED,OAAO,CAAC,CAAA;AACV,CAAC,CAAA;AAED,0EAA0E;AAC1E,SAAgB,oBAAoB,CAAC,cAA+B;IAClE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;AAC5D,CAAC;AAFD,oDAEC;AAED,MAAa,4BAA4B;IAAzC;QAEU,cAAS,GAAoB,EAAE,CAAA;IAczC,CAAC;IAZQ,KAAK,CAAC,aAA4B;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACnD,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAEM,YAAY,CAAC,SAA0B;QAC5C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CAEF;AAhBD,oEAgBC"}

package/dist/xyo-mock-network-pipe.d.ts

@@ -1,18 +0,0 @@
-/// <reference types="node" />
-import { IXyoNetworkPipe, IXyoNetworkPeer } from './@types';
-import { IXyoSerializableObject } from "@xyo-network/serialization";
-export declare class XyoMockNetworkPipe implements IXyoNetworkPipe {
-    private readonly intercepts;
-    private readonly expectedMessages;
-    networkHeuristics: IXyoSerializableObject[];
-    sendCount: number;
-    peer: IXyoNetworkPeer;
-    initiationData: Buffer;
-    constructor(intercepts: {
-        [s: string]: (data: Buffer, awaitResponse?: boolean) => Promise<Buffer>;
-    }, expectedMessages: Buffer[]);
-    onPeerDisconnect(callback: (hasError: boolean) => void): () => void;
-    send(data: Buffer, awaitResponse?: boolean): Promise<Buffer>;
-    close(): Promise<void>;
-}
-//# sourceMappingURL=xyo-mock-network-pipe.d.ts.map

package/dist/xyo-mock-network-pipe.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"xyo-mock-network-pipe.d.ts","sourceRoot":"","sources":["../src/xyo-mock-network-pipe.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAEnE,qBAAa,kBAAmB,YAAW,eAAe;IAWtD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAX5B,iBAAiB,EAAE,sBAAsB,EAAE,CAAK;IAEhD,SAAS,SAAI;IAEb,IAAI,EAAE,eAAe,CAAK;IAG1B,cAAc,EAAE,MAAM,CAAA;gBAGV,UAAU,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KAAC,EACtF,gBAAgB,EAAE,MAAM,EAAE;IAGtC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI;IAK7D,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAe5D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGpC"}

package/dist/xyo-mock-network-pipe.js

@@ -1,52 +0,0 @@
-"use strict";
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Thursday, 29th November 2018 4:23:34 pm
- * @Email:  developer@xyfindables.com
- * @Filename: xyo-mock-network-pipe.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Tuesday, 11th December 2018 9:34:57 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-class XyoMockNetworkPipe {
-    constructor(intercepts, expectedMessages) {
-        this.intercepts = intercepts;
-        this.expectedMessages = expectedMessages;
-        this.networkHeuristics = [];
-        this.sendCount = 0;
-        // @ts-ignore
-        this.peer = {};
-    }
-    onPeerDisconnect(callback) {
-        // tslint:disable-next-line:no-empty
-        return () => { };
-    }
-    send(data, awaitResponse) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const expected = this.expectedMessages.length > this.sendCount ? this.expectedMessages[this.sendCount] : undefined;
-            if (expected) {
-                expect(expected.equals(data)).toBe(true);
-            }
-            const returnMsg = (this.intercepts[this.sendCount] && this.intercepts[this.sendCount](data, awaitResponse)) || Buffer.alloc(0);
-            this.sendCount += 1;
-            return returnMsg;
-        });
-    }
-    close() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return;
-        });
-    }
-}
-exports.XyoMockNetworkPipe = XyoMockNetworkPipe;
-//# sourceMappingURL=xyo-mock-network-pipe.js.map

package/dist/xyo-mock-network-pipe.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"xyo-mock-network-pipe.js","sourceRoot":"","sources":["../src/xyo-mock-network-pipe.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;AAMH,MAAa,kBAAkB;IAU7B,YACmB,UAAsF,EACtF,gBAA0B;QAD1B,eAAU,GAAV,UAAU,CAA4E;QACtF,qBAAgB,GAAhB,gBAAgB,CAAU;QAXtC,sBAAiB,GAA6B,EAAE,CAAA;QAEhD,cAAS,GAAG,CAAC,CAAA;QACpB,aAAa;QACN,SAAI,GAAoB,EAAE,CAAA;IAQ9B,CAAC;IAEG,gBAAgB,CAAC,QAAqC;QAC3D,oCAAoC;QACpC,OAAO,GAAG,EAAE,GAAG,CAAC,CAAA;IAClB,CAAC;IAEY,IAAI,CAAC,IAAY,EAAE,aAAuB;;YACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YAClH,IAAI,QAAQ,EAAE;gBACZ,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;aACzC;YAED,MAAM,SAAS,GAAG,CAChB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,CACxF,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAEpB,IAAI,CAAC,SAAS,IAAI,CAAC,CAAA;YAEnB,OAAO,SAAS,CAAA;QAClB,CAAC;KAAA;IAEY,KAAK;;YAChB,OAAM;QACR,CAAC;KAAA;CACF;AAtCD,gDAsCC"}

package/src/@types/index.ts

@@ -1,97 +0,0 @@
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 11th December 2018 9:32:12 am
- * @Email:  developer@xyfindables.com
- * @Filename: index.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Wednesday, 13th February 2019 1:28:35 pm
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-
-import { CatalogueItem } from "../catalogue-item"
-import { IXyoSerializableObject } from "@xyo-network/serialization"
-
-/**
- * The necessary communication interfaces that xyo-nodes will
- * use to communicate to other nodes on a `network`
- */
-
-/**
- * A peer, meant to represent the meaningful attributes of the
- * node on the other side of the network pipe
- */
-export interface IXyoNetworkPeer {
-
-  /**
-   * Returns an id for a peer that should be consistent across multiple connections
-   * to the same node
-   */
-  getTemporaryPeerId(): Buffer
-}
-
-/**
- * An interface that allows the network to delegate to implementer of
- * this interface as to which operations the xyo-node supports
- */
-export interface IXyoNetworkProcedureCatalogue {
-
-  /**
-   * Since not all operations are symmetric, a `canDo` interface
-   * is required so that an XyoNode can agree to partake in operation
-   * where one party is one role and the other party is the other role.
-   *
-   * For example, an archivist can take origin-chains but does not
-   * want to give origin-chains. So if an archivist is queried with
-   * `canDo(TAKE_ORIGIN_CHAIN)` it should return true
-   */
-
-  canDo(catalogueItem: CatalogueItem): boolean
-
-  /**
-   * The list of current `CatalogueItems` the `XyoNode` can perform
-   */
-
-  getCurrentCatalogue(): CatalogueItem[]
-
-  setCatalogue(catalogue: CatalogueItem[]): void
-}
-
-/**
- * An XyoNetworkPipe is a communication channel between two
- * nodes and will be used the fundamental way that two
- * nodes communicate with one another
- */
-export interface IXyoNetworkPipe {
-
-  /** A representation of the peer on the other side of the pipe */
-  peer: IXyoNetworkPeer
-
-  /** Any data that was initially passed to start an interaction */
-  initiationData: Buffer | undefined
-
-  networkHeuristics: IXyoSerializableObject[]
-
-  /** A consumer may register a handler for when the other peer disconnects */
-  onPeerDisconnect(callback: (hasError: boolean) => void): () => void
-
-  /** Sends message to the peer. If awaitResponse is true it will wait for a message from the other node */
-  send (data: Buffer, awaitResponse?: boolean): Promise<Buffer | undefined>
-
-  /** Closes the connection to the peer */
-  close(): Promise<void>
-
-}
-
-/**
- * A network-provider will try to find peers who are compatible with the catalogue passed in.
- * Once a peer is found, it returns a pipe to send messages on.
- */
-export interface IXyoNetworkProvider {
-
-  /** Attempts to find a peer with a compatible catalogue. */
-  find(catalogue: IXyoNetworkProcedureCatalogue): Promise<IXyoNetworkPipe>
-
-  /** Tells the network-provider to stop finding peers */
-  stopServer(): Promise<void>
-}

package/src/catalogue-item.ts

@@ -1,21 +0,0 @@
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Tuesday, 11th December 2018 9:33:01 am
- * @Email:  developer@xyfindables.com
- * @Filename: catalogue-item.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Tuesday, 22nd January 2019 10:19:26 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-
-/**
- * The catalogue items this node knows about
- */
-export enum CatalogueItem  {
-  BOUND_WITNESS = Math.pow(2, 0),
-  TAKE_ORIGIN_CHAIN = Math.pow(2, 1),
-  GIVE_ORIGIN_CHAIN = Math.pow(2, 2),
-  TAKE_REQUESTED_BLOCKS = Math.pow(2, 3),
-  GIVE_REQUESTED_BLOCKS = Math.pow(2, 4)
-}

package/src/xyo-mock-network-pipe.ts

@@ -1,54 +0,0 @@
-/*
- * @Author: XY | The Findables Company <ryanxyo>
- * @Date:   Thursday, 29th November 2018 4:23:34 pm
- * @Email:  developer@xyfindables.com
- * @Filename: xyo-mock-network-pipe.ts
- * @Last modified by: ryanxyo
- * @Last modified time: Tuesday, 11th December 2018 9:34:57 am
- * @License: All Rights Reserved
- * @Copyright: Copyright XY | The Findables Company
- */
-
-import { IXyoNetworkPipe, IXyoNetworkPeer } from './@types'
-import { CatalogueItem } from './catalogue-item'
-import { IXyoSerializableObject } from "@xyo-network/serialization"
-
-export class XyoMockNetworkPipe implements IXyoNetworkPipe {
-  public networkHeuristics: IXyoSerializableObject[] = []
-
-  public sendCount = 0
-  // @ts-ignore
-  public peer: IXyoNetworkPeer = {}
-
-  // @ts-ignore
-  public initiationData: Buffer
-
-  constructor(
-    private readonly intercepts: { [s: string]: (data: Buffer, awaitResponse?: boolean) => Promise<Buffer>},
-    private readonly expectedMessages: Buffer[]
-  ) {}
-
-  public onPeerDisconnect(callback: (hasError: boolean) => void): () => void {
-    // tslint:disable-next-line:no-empty
-    return () => { }
-  }
-
-  public async send(data: Buffer, awaitResponse?: boolean): Promise<Buffer> {
-    const expected = this.expectedMessages.length > this.sendCount ? this.expectedMessages[this.sendCount] : undefined
-    if (expected) {
-      expect(expected.equals(data)).toBe(true)
-    }
-
-    const returnMsg = (
-      this.intercepts[this.sendCount] && this.intercepts[this.sendCount](data, awaitResponse)
-    ) || Buffer.alloc(0)
-
-    this.sendCount += 1
-
-    return returnMsg
-  }
-
-  public async close(): Promise<void> {
-    return
-  }
-}

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-      "target": "es6",
-      "module": "commonjs",
-      "lib": ["esnext"],
-      "declaration": true,
-      "declarationMap": true,
-      "sourceMap": true,
-      "strict": true,
-      "composite": true,
-      "esModuleInterop": true,
-      "noImplicitAny": true,
-      "moduleResolution": "node",
-      "outDir": "dist",
-      "rootDir": "src"
-  },
-  "exclude": [
-    "node_modules",
-    "src/**/test/*",
-    "src/**/spec",
-    "src/**/*.spec.ts"
-  ],
-  "include": ["src/**/*"]
-}