libp2p 0.35.8 → 0.36.0

package/dist/src/peer-store/persistent/index.d.ts

@@ -1,129 +0,0 @@
-export = PersistentPeerStore;
-/**
- * @typedef {import('interface-datastore').Batch} Batch
- * @typedef {import('../address-book.js').Address} Address
- */
-/**
- * @typedef {Object} PersistentPeerStoreProperties
- * @property {PeerId} peerId
- * @property {import('interface-datastore').Datastore} datastore
- *
- * @typedef {Object} PersistentPeerStoreOptions
- * @property {number} [threshold = 5] - Number of dirty peers allowed before commit data.
- */
-/**
- * Responsible for managing the persistence of data in the PeerStore.
- */
-declare class PersistentPeerStore extends PeerStore {
-    /**
-     * @class
-     * @param {PersistentPeerStoreProperties & PersistentPeerStoreOptions} properties
-     */
-    constructor({ peerId, datastore, threshold }: PersistentPeerStoreProperties & PersistentPeerStoreOptions);
-    /**
-     * Backend datastore used to persist data.
-     */
-    _datastore: import("interface-datastore").Datastore;
-    /**
-     * Peers modified after the latest data persisted.
-     */
-    _dirtyPeers: Set<any>;
-    /**
-     * Peers metadata changed mapping peer identifers to metadata changed.
-     *
-     * @type {Map<string, Set<string>>}
-     */
-    _dirtyMetadata: Map<string, Set<string>>;
-    threshold: number;
-    /**
-     * Add modified peer to the dirty set
-     *
-     * @private
-     * @param {Object} params
-     * @param {PeerId} params.peerId
-     */
-    private _addDirtyPeer;
-    /**
-     * Add modified peer key to the dirty set
-     *
-     * @private
-     * @param {Object} params
-     * @param {PeerId} params.peerId
-     */
-    private _addDirtyPeerKey;
-    /**
-     * Add modified metadata peer to the set.
-     *
-     * @private
-     * @param {Object} params
-     * @param {PeerId} params.peerId
-     * @param {string} params.metadata
-     */
-    private _addDirtyPeerMetadata;
-    /**
-     * Add all the peers current data to a datastore batch and commit it.
-     *
-     * @private
-     * @returns {Promise<void>}
-     */
-    private _commitData;
-    /**
-     * Add address book data of the peer to the batch.
-     *
-     * @private
-     * @param {PeerId} peerId
-     * @param {Batch} batch
-     */
-    private _batchAddressBook;
-    /**
-     * Add Key book data of the peer to the batch.
-     *
-     * @private
-     * @param {PeerId} peerId
-     * @param {Batch} batch
-     */
-    private _batchKeyBook;
-    /**
-     * Add metadata book data of the peer to the batch.
-     *
-     * @private
-     * @param {PeerId} peerId
-     * @param {Batch} batch
-     */
-    private _batchMetadataBook;
-    /**
-     * Add proto book data of the peer to the batch.
-     *
-     * @private
-     * @param {PeerId} peerId
-     * @param {Batch} batch
-     */
-    private _batchProtoBook;
-    /**
-     * Process datastore entry and add its data to the correct book.
-     *
-     * @private
-     * @param {Object} params
-     * @param {Key} params.key - datastore key
-     * @param {Uint8Array} params.value - datastore value stored
-     * @returns {Promise<void>}
-     */
-    private _processDatastoreEntry;
-}
-declare namespace PersistentPeerStore {
-    export { Batch, Address, PersistentPeerStoreProperties, PersistentPeerStoreOptions };
-}
-import PeerStore = require("..");
-type PersistentPeerStoreProperties = {
-    peerId: PeerId;
-    datastore: import('interface-datastore').Datastore;
-};
-type PersistentPeerStoreOptions = {
-    /**
-     * - Number of dirty peers allowed before commit data.
-     */
-    threshold?: number | undefined;
-};
-type Batch = import('interface-datastore').Batch;
-type Address = import('../address-book.js').Address;
-//# sourceMappingURL=index.d.ts.map

package/dist/src/peer-store/persistent/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/peer-store/persistent/index.js"],"names":[],"mappings":";AAwBA;;;GAGG;AAEH;;;;;;;GAOG;AAEH;;GAEG;AACH;IACE;;;OAGG;IACH,8CAFW,6BAA6B,GAAG,0BAA0B,EAwBpE;IAnBC;;OAEG;IACH,oDAA2B;IAE3B;;OAEG;IACH,sBAA4B;IAE5B;;;;OAIG;IACH,gBAFU,IAAI,MAAM,EAAE,IAAI,MAAM,CAAC,CAAC,CAEH;IAE/B,kBAA0B;IAsC5B;;;;;;OAMG;IACH,sBAYC;IAED;;;;;;OAMG;IACH,yBAiBC;IAED;;;;;;;OAOG;IACH,8BAiBC;IAED;;;;;OAKG;IACH,oBA+BC;IAED;;;;;;OAMG;IACH,0BA8BC;IAED;;;;;;OAMG;IACH,sBAiBC;IAED;;;;;;OAMG;IACH,2BAkBC;IAED;;;;;;OAMG;IACH,wBAmBC;IAED;;;;;;;;OAQG;IACH,+BA0DC;CACF;;;;;;YAtXa,MAAM;eACN,OAAO,qBAAqB,EAAE,SAAS;;;;;;;;aAPxC,OAAO,qBAAqB,EAAE,KAAK;eACnC,OAAO,oBAAoB,EAAE,OAAO"}

package/dist/src/peer-store/persistent/pb/address-book.d.ts

@@ -1,198 +0,0 @@
-import * as $protobuf from "protobufjs";
-/** Properties of an Addresses. */
-export interface IAddresses {
-
-    /** Addresses addrs */
-    addrs?: (Addresses.IAddress[]|null);
-
-    /** Addresses certifiedRecord */
-    certifiedRecord?: (Addresses.ICertifiedRecord|null);
-}
-
-/** Represents an Addresses. */
-export class Addresses implements IAddresses {
-
-    /**
-     * Constructs a new Addresses.
-     * @param [p] Properties to set
-     */
-    constructor(p?: IAddresses);
-
-    /** Addresses addrs. */
-    public addrs: Addresses.IAddress[];
-
-    /** Addresses certifiedRecord. */
-    public certifiedRecord?: (Addresses.ICertifiedRecord|null);
-
-    /**
-     * Encodes the specified Addresses message. Does not implicitly {@link Addresses.verify|verify} messages.
-     * @param m Addresses message or plain object to encode
-     * @param [w] Writer to encode to
-     * @returns Writer
-     */
-    public static encode(m: IAddresses, w?: $protobuf.Writer): $protobuf.Writer;
-
-    /**
-     * Decodes an Addresses message from the specified reader or buffer.
-     * @param r Reader or buffer to decode from
-     * @param [l] Message length if known beforehand
-     * @returns Addresses
-     * @throws {Error} If the payload is not a reader or valid buffer
-     * @throws {$protobuf.util.ProtocolError} If required fields are missing
-     */
-    public static decode(r: ($protobuf.Reader|Uint8Array), l?: number): Addresses;
-
-    /**
-     * Creates an Addresses message from a plain object. Also converts values to their respective internal types.
-     * @param d Plain object
-     * @returns Addresses
-     */
-    public static fromObject(d: { [k: string]: any }): Addresses;
-
-    /**
-     * Creates a plain object from an Addresses message. Also converts values to other types if specified.
-     * @param m Addresses
-     * @param [o] Conversion options
-     * @returns Plain object
-     */
-    public static toObject(m: Addresses, o?: $protobuf.IConversionOptions): { [k: string]: any };
-
-    /**
-     * Converts this Addresses to JSON.
-     * @returns JSON object
-     */
-    public toJSON(): { [k: string]: any };
-}
-
-export namespace Addresses {
-
-    /** Properties of an Address. */
-    interface IAddress {
-
-        /** Address multiaddr */
-        multiaddr?: (Uint8Array|null);
-
-        /** Address isCertified */
-        isCertified?: (boolean|null);
-    }
-
-    /** Represents an Address. */
-    class Address implements IAddress {
-
-        /**
-         * Constructs a new Address.
-         * @param [p] Properties to set
-         */
-        constructor(p?: Addresses.IAddress);
-
-        /** Address multiaddr. */
-        public multiaddr: Uint8Array;
-
-        /** Address isCertified. */
-        public isCertified: boolean;
-
-        /**
-         * Encodes the specified Address message. Does not implicitly {@link Addresses.Address.verify|verify} messages.
-         * @param m Address message or plain object to encode
-         * @param [w] Writer to encode to
-         * @returns Writer
-         */
-        public static encode(m: Addresses.IAddress, w?: $protobuf.Writer): $protobuf.Writer;
-
-        /**
-         * Decodes an Address message from the specified reader or buffer.
-         * @param r Reader or buffer to decode from
-         * @param [l] Message length if known beforehand
-         * @returns Address
-         * @throws {Error} If the payload is not a reader or valid buffer
-         * @throws {$protobuf.util.ProtocolError} If required fields are missing
-         */
-        public static decode(r: ($protobuf.Reader|Uint8Array), l?: number): Addresses.Address;
-
-        /**
-         * Creates an Address message from a plain object. Also converts values to their respective internal types.
-         * @param d Plain object
-         * @returns Address
-         */
-        public static fromObject(d: { [k: string]: any }): Addresses.Address;
-
-        /**
-         * Creates a plain object from an Address message. Also converts values to other types if specified.
-         * @param m Address
-         * @param [o] Conversion options
-         * @returns Plain object
-         */
-        public static toObject(m: Addresses.Address, o?: $protobuf.IConversionOptions): { [k: string]: any };
-
-        /**
-         * Converts this Address to JSON.
-         * @returns JSON object
-         */
-        public toJSON(): { [k: string]: any };
-    }
-
-    /** Properties of a CertifiedRecord. */
-    interface ICertifiedRecord {
-
-        /** CertifiedRecord seq */
-        seq?: (number|null);
-
-        /** CertifiedRecord raw */
-        raw?: (Uint8Array|null);
-    }
-
-    /** Represents a CertifiedRecord. */
-    class CertifiedRecord implements ICertifiedRecord {
-
-        /**
-         * Constructs a new CertifiedRecord.
-         * @param [p] Properties to set
-         */
-        constructor(p?: Addresses.ICertifiedRecord);
-
-        /** CertifiedRecord seq. */
-        public seq: number;
-
-        /** CertifiedRecord raw. */
-        public raw: Uint8Array;
-
-        /**
-         * Encodes the specified CertifiedRecord message. Does not implicitly {@link Addresses.CertifiedRecord.verify|verify} messages.
-         * @param m CertifiedRecord message or plain object to encode
-         * @param [w] Writer to encode to
-         * @returns Writer
-         */
-        public static encode(m: Addresses.ICertifiedRecord, w?: $protobuf.Writer): $protobuf.Writer;
-
-        /**
-         * Decodes a CertifiedRecord message from the specified reader or buffer.
-         * @param r Reader or buffer to decode from
-         * @param [l] Message length if known beforehand
-         * @returns CertifiedRecord
-         * @throws {Error} If the payload is not a reader or valid buffer
-         * @throws {$protobuf.util.ProtocolError} If required fields are missing
-         */
-        public static decode(r: ($protobuf.Reader|Uint8Array), l?: number): Addresses.CertifiedRecord;
-
-        /**
-         * Creates a CertifiedRecord message from a plain object. Also converts values to their respective internal types.
-         * @param d Plain object
-         * @returns CertifiedRecord
-         */
-        public static fromObject(d: { [k: string]: any }): Addresses.CertifiedRecord;
-
-        /**
-         * Creates a plain object from a CertifiedRecord message. Also converts values to other types if specified.
-         * @param m CertifiedRecord
-         * @param [o] Conversion options
-         * @returns Plain object
-         */
-        public static toObject(m: Addresses.CertifiedRecord, o?: $protobuf.IConversionOptions): { [k: string]: any };
-
-        /**
-         * Converts this CertifiedRecord to JSON.
-         * @returns JSON object
-         */
-        public toJSON(): { [k: string]: any };
-    }
-}

package/dist/src/peer-store/persistent/pb/proto-book.d.ts

@@ -1,59 +0,0 @@
-import * as $protobuf from "protobufjs";
-/** Properties of a Protocols. */
-export interface IProtocols {
-
-    /** Protocols protocols */
-    protocols?: (string[]|null);
-}
-
-/** Represents a Protocols. */
-export class Protocols implements IProtocols {
-
-    /**
-     * Constructs a new Protocols.
-     * @param [p] Properties to set
-     */
-    constructor(p?: IProtocols);
-
-    /** Protocols protocols. */
-    public protocols: string[];
-
-    /**
-     * Encodes the specified Protocols message. Does not implicitly {@link Protocols.verify|verify} messages.
-     * @param m Protocols message or plain object to encode
-     * @param [w] Writer to encode to
-     * @returns Writer
-     */
-    public static encode(m: IProtocols, w?: $protobuf.Writer): $protobuf.Writer;
-
-    /**
-     * Decodes a Protocols message from the specified reader or buffer.
-     * @param r Reader or buffer to decode from
-     * @param [l] Message length if known beforehand
-     * @returns Protocols
-     * @throws {Error} If the payload is not a reader or valid buffer
-     * @throws {$protobuf.util.ProtocolError} If required fields are missing
-     */
-    public static decode(r: ($protobuf.Reader|Uint8Array), l?: number): Protocols;
-
-    /**
-     * Creates a Protocols message from a plain object. Also converts values to their respective internal types.
-     * @param d Plain object
-     * @returns Protocols
-     */
-    public static fromObject(d: { [k: string]: any }): Protocols;
-
-    /**
-     * Creates a plain object from a Protocols message. Also converts values to other types if specified.
-     * @param m Protocols
-     * @param [o] Conversion options
-     * @returns Plain object
-     */
-    public static toObject(m: Protocols, o?: $protobuf.IConversionOptions): { [k: string]: any };
-
-    /**
-     * Converts this Protocols to JSON.
-     * @returns JSON object
-     */
-    public toJSON(): { [k: string]: any };
-}

package/src/peer-store/book.js

@@ -1,124 +0,0 @@
-'use strict'
-
-const errcode = require('err-code')
-const PeerId = require('peer-id')
-const { codes } = require('../errors')
-
-/**
- * @param {any} data
- */
-const passthrough = data => data
-
-/**
- * @typedef {import('./')} PeerStore
- */
-
-class Book {
-  /**
-   * The Book is the skeleton for the PeerStore books.
-   *
-   * @class
-   * @param {Object} properties
-   * @param {PeerStore} properties.peerStore - PeerStore instance.
-   * @param {string} properties.eventName - Name of the event to emit by the PeerStore.
-   * @param {string} properties.eventProperty - Name of the property to emit by the PeerStore.
-   * @param {(data: any) => any[]} [properties.eventTransformer] - Transformer function of the provided data for being emitted.
-   */
-  constructor ({ peerStore, eventName, eventProperty, eventTransformer = passthrough }) {
-    this._ps = peerStore
-    this.eventName = eventName
-    this.eventProperty = eventProperty
-    this.eventTransformer = eventTransformer
-
-    /**
-     * Map known peers to their data.
-     *
-     * @type {Map<string, any[]|any>}
-     */
-    this.data = new Map()
-  }
-
-  /**
-   * Set known data of a provided peer.
-   *
-   * @param {PeerId} peerId
-   * @param {any[]|any} data
-   */
-  set (peerId, data) {
-    throw errcode(new Error('set must be implemented by the subclass'), codes.ERR_NOT_IMPLEMENTED)
-  }
-
-  /**
-   * Set data into the datastructure, persistence and emit it using the provided transformers.
-   *
-   * @protected
-   * @param {PeerId} peerId - peerId of the data to store
-   * @param {any} data - data to store.
-   * @param {Object} [options] - storing options.
-   * @param {boolean} [options.emit = true] - emit the provided data.
-   * @returns {void}
-   */
-  _setData (peerId, data, { emit = true } = {}) {
-    const b58key = peerId.toB58String()
-
-    // Store data in memory
-    this.data.set(b58key, data)
-
-    // Emit event
-    emit && this._emit(peerId, data)
-  }
-
-  /**
-   * Emit data.
-   *
-   * @protected
-   * @param {PeerId} peerId
-   * @param {any} [data]
-   */
-  _emit (peerId, data) {
-    this._ps.emit(this.eventName, {
-      peerId,
-      [this.eventProperty]: this.eventTransformer(data)
-    })
-  }
-
-  /**
-   * Get the known data of a provided peer.
-   * Returns `undefined` if there is no available data for the given peer.
-   *
-   * @param {PeerId} peerId
-   * @returns {any[]|any|undefined}
-   */
-  get (peerId) {
-    if (!PeerId.isPeerId(peerId)) {
-      throw errcode(new Error('peerId must be an instance of peer-id'), codes.ERR_INVALID_PARAMETERS)
-    }
-
-    const rec = this.data.get(peerId.toB58String())
-
-    // @ts-ignore
-    return rec ? [...rec] : undefined
-  }
-
-  /**
-   * Deletes the provided peer from the book.
-   *
-   * @param {PeerId} peerId
-   * @returns {boolean}
-   */
-  delete (peerId) {
-    if (!PeerId.isPeerId(peerId)) {
-      throw errcode(new Error('peerId must be an instance of peer-id'), codes.ERR_INVALID_PARAMETERS)
-    }
-
-    if (!this.data.delete(peerId.toB58String())) {
-      return false
-    }
-
-    this._emit(peerId, [])
-
-    return true
-  }
-}
-
-module.exports = Book

package/src/peer-store/persistent/consts.js

@@ -1,15 +0,0 @@
-'use strict'
-
-module.exports.NAMESPACE_COMMON = '/peers/'
-
-// /peers/protos/<b32 peer id no padding>
-module.exports.NAMESPACE_ADDRESS = '/peers/addrs/'
-
-// /peers/keys/<b32 peer id no padding>
-module.exports.NAMESPACE_KEYS = '/peers/keys/'
-
-// /peers/metadata/<b32 peer id no padding>/<key>
-module.exports.NAMESPACE_METADATA = '/peers/metadata/'
-
-// /peers/addrs/<b32 peer id no padding>
-module.exports.NAMESPACE_PROTOCOL = '/peers/protos/'