@libp2p/record 0.10.6

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,40 @@
+# js-libp2p-record
+
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/project-libp2p-blue.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23libp2p-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-record/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-record?branch=master)
+[![Build Status](https://github.com/libp2p/js-libp2p-record/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-record/actions/workflows/js-test-and-release.yml)
+[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-record.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-record) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
+
+> JavaScript implementation of libp2p record.
+
+## Description
+
+Implementation of [go-libp2p-record](https://github.com/libp2p/go-libp2p-record) in JavaScript.
+
+## Usage
+
+See https://libp2p.github.io/js-libp2p-record/
+
+## Contribute
+
+The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
+
+ - Go through the modules and **check out existing issues**. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
+ - **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
+
+## License
+
+Licensed under either of
+
+ * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/src/index.d.ts

@@ -0,0 +1,24 @@
+export declare class Libp2pRecord {
+    key: Uint8Array;
+    value: Uint8Array;
+    timeReceived?: Date;
+    constructor(key: Uint8Array, value: Uint8Array, timeReceived?: Date);
+    serialize(): Uint8Array;
+    /**
+     * Return the object format ready to be given to the protobuf library.
+     */
+    prepareSerialize(): {
+        key: Uint8Array;
+        value: Uint8Array;
+        timeReceived: string | undefined;
+    };
+    /**
+     * Decode a protobuf encoded record
+     */
+    static deserialize(raw: Uint8Array): Libp2pRecord;
+    /**
+     * Create a record from the raw object returned from the protobuf library
+     */
+    static fromDeserialized(obj: Record<string, any>): Libp2pRecord;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAKA,qBAAa,YAAY;IAChB,GAAG,EAAE,UAAU,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,IAAI,CAAA;gBAEb,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,IAAI;IAcpE,SAAS;IAIT;;OAEG;IACH,gBAAgB;;;;;IAQhB;;OAEG;IACH,MAAM,CAAC,WAAW,CAAE,GAAG,EAAE,UAAU;IAUnC;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAYlD"}

package/dist/src/index.js

@@ -0,0 +1,52 @@
+import { Record as PBRecord } from './record.js';
+import * as utils from './utils.js';
+export class Libp2pRecord {
+    constructor(key, value, timeReceived) {
+        if (!(key instanceof Uint8Array)) {
+            throw new Error('key must be a Uint8Array');
+        }
+        if (!(value instanceof Uint8Array)) {
+            throw new Error('value must be a Uint8Array');
+        }
+        this.key = key;
+        this.value = value;
+        this.timeReceived = timeReceived;
+    }
+    serialize() {
+        return PBRecord.encode(this.prepareSerialize()).finish();
+    }
+    /**
+     * Return the object format ready to be given to the protobuf library.
+     */
+    prepareSerialize() {
+        return {
+            key: this.key,
+            value: this.value,
+            timeReceived: this.timeReceived != null ? utils.toRFC3339(this.timeReceived) : undefined
+        };
+    }
+    /**
+     * Decode a protobuf encoded record
+     */
+    static deserialize(raw) {
+        const message = PBRecord.decode(raw);
+        return Libp2pRecord.fromDeserialized(PBRecord.toObject(message, {
+            defaults: false,
+            arrays: true,
+            longs: Number,
+            objects: false
+        }));
+    }
+    /**
+     * Create a record from the raw object returned from the protobuf library
+     */
+    static fromDeserialized(obj) {
+        let recvtime;
+        if (obj.timeReceived != null) {
+            recvtime = utils.parseRFC3339(obj.timeReceived);
+        }
+        const rec = new Libp2pRecord(obj.key, obj.value, recvtime);
+        return rec;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,IAAI,QAAQ,EACnB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,MAAM,OAAO,YAAY;IAKvB,YAAa,GAAe,EAAE,KAAiB,EAAE,YAAmB;QAClE,IAAI,CAAC,CAAC,GAAG,YAAY,UAAU,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;SAC9C;QAED,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAED,SAAS;QACP,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAA;IAC1D,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SACzF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAE,GAAe;QACjC,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACpC,OAAO,YAAY,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE;YAC9D,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,KAAK;SACf,CAAC,CAAC,CAAA;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAE,GAAwB;QAC/C,IAAI,QAAQ,CAAA;QACZ,IAAI,GAAG,CAAC,YAAY,IAAI,IAAI,EAAE;YAC5B,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;SAChD;QAED,MAAM,GAAG,GAAG,IAAI,YAAY,CAC1B,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,CAC7B,CAAA;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;CACF"}

package/dist/src/record.d.ts

@@ -0,0 +1,71 @@
+import * as $protobuf from "protobufjs";
+/** Properties of a Record. */
+export interface IRecord {
+
+    /** Record key */
+    key?: (Uint8Array|null);
+
+    /** Record value */
+    value?: (Uint8Array|null);
+
+    /** Record timeReceived */
+    timeReceived?: (string|null);
+}
+
+/** Represents a Record. */
+export class Record implements IRecord {
+
+    /**
+     * Constructs a new Record.
+     * @param [p] Properties to set
+     */
+    constructor(p?: IRecord);
+
+    /** Record key. */
+    public key: Uint8Array;
+
+    /** Record value. */
+    public value: Uint8Array;
+
+    /** Record timeReceived. */
+    public timeReceived: string;
+
+    /**
+     * Encodes the specified Record message. Does not implicitly {@link Record.verify|verify} messages.
+     * @param m Record message or plain object to encode
+     * @param [w] Writer to encode to
+     * @returns Writer
+     */
+    public static encode(m: IRecord, w?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes a Record message from the specified reader or buffer.
+     * @param r Reader or buffer to decode from
+     * @param [l] Message length if known beforehand
+     * @returns Record
+     * @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): Record;
+
+    /**
+     * Creates a Record message from a plain object. Also converts values to their respective internal types.
+     * @param d Plain object
+     * @returns Record
+     */
+    public static fromObject(d: { [k: string]: any }): Record;
+
+    /**
+     * Creates a plain object from a Record message. Also converts values to other types if specified.
+     * @param m Record
+     * @param [o] Conversion options
+     * @returns Plain object
+     */
+    public static toObject(m: Record, o?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this Record to JSON.
+     * @returns JSON object
+     */
+    public toJSON(): { [k: string]: any };
+}

package/dist/src/record.js

@@ -0,0 +1,202 @@
+/*eslint-disable*/
+import $protobuf from "protobufjs/minimal.js";
+
+// Common aliases
+const $Reader = $protobuf.Reader, $Writer = $protobuf.Writer, $util = $protobuf.util;
+
+// Exported root namespace
+const $root = $protobuf.roots["libp2p-record"] || ($protobuf.roots["libp2p-record"] = {});
+
+export const Record = $root.Record = (() => {
+
+    /**
+     * Properties of a Record.
+     * @exports IRecord
+     * @interface IRecord
+     * @property {Uint8Array|null} [key] Record key
+     * @property {Uint8Array|null} [value] Record value
+     * @property {string|null} [timeReceived] Record timeReceived
+     */
+
+    /**
+     * Constructs a new Record.
+     * @exports Record
+     * @classdesc Represents a Record.
+     * @implements IRecord
+     * @constructor
+     * @param {IRecord=} [p] Properties to set
+     */
+    function Record(p) {
+        if (p)
+            for (var ks = Object.keys(p), i = 0; i < ks.length; ++i)
+                if (p[ks[i]] != null)
+                    this[ks[i]] = p[ks[i]];
+    }
+
+    /**
+     * Record key.
+     * @member {Uint8Array} key
+     * @memberof Record
+     * @instance
+     */
+    Record.prototype.key = $util.newBuffer([]);
+
+    /**
+     * Record value.
+     * @member {Uint8Array} value
+     * @memberof Record
+     * @instance
+     */
+    Record.prototype.value = $util.newBuffer([]);
+
+    /**
+     * Record timeReceived.
+     * @member {string} timeReceived
+     * @memberof Record
+     * @instance
+     */
+    Record.prototype.timeReceived = "";
+
+    /**
+     * Encodes the specified Record message. Does not implicitly {@link Record.verify|verify} messages.
+     * @function encode
+     * @memberof Record
+     * @static
+     * @param {IRecord} m Record message or plain object to encode
+     * @param {$protobuf.Writer} [w] Writer to encode to
+     * @returns {$protobuf.Writer} Writer
+     */
+    Record.encode = function encode(m, w) {
+        if (!w)
+            w = $Writer.create();
+        if (m.key != null && Object.hasOwnProperty.call(m, "key"))
+            w.uint32(10).bytes(m.key);
+        if (m.value != null && Object.hasOwnProperty.call(m, "value"))
+            w.uint32(18).bytes(m.value);
+        if (m.timeReceived != null && Object.hasOwnProperty.call(m, "timeReceived"))
+            w.uint32(42).string(m.timeReceived);
+        return w;
+    };
+
+    /**
+     * Decodes a Record message from the specified reader or buffer.
+     * @function decode
+     * @memberof Record
+     * @static
+     * @param {$protobuf.Reader|Uint8Array} r Reader or buffer to decode from
+     * @param {number} [l] Message length if known beforehand
+     * @returns {Record} Record
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    Record.decode = function decode(r, l) {
+        if (!(r instanceof $Reader))
+            r = $Reader.create(r);
+        var c = l === undefined ? r.len : r.pos + l, m = new $root.Record();
+        while (r.pos < c) {
+            var t = r.uint32();
+            switch (t >>> 3) {
+            case 1:
+                m.key = r.bytes();
+                break;
+            case 2:
+                m.value = r.bytes();
+                break;
+            case 5:
+                m.timeReceived = r.string();
+                break;
+            default:
+                r.skipType(t & 7);
+                break;
+            }
+        }
+        return m;
+    };
+
+    /**
+     * Creates a Record message from a plain object. Also converts values to their respective internal types.
+     * @function fromObject
+     * @memberof Record
+     * @static
+     * @param {Object.<string,*>} d Plain object
+     * @returns {Record} Record
+     */
+    Record.fromObject = function fromObject(d) {
+        if (d instanceof $root.Record)
+            return d;
+        var m = new $root.Record();
+        if (d.key != null) {
+            if (typeof d.key === "string")
+                $util.base64.decode(d.key, m.key = $util.newBuffer($util.base64.length(d.key)), 0);
+            else if (d.key.length)
+                m.key = d.key;
+        }
+        if (d.value != null) {
+            if (typeof d.value === "string")
+                $util.base64.decode(d.value, m.value = $util.newBuffer($util.base64.length(d.value)), 0);
+            else if (d.value.length)
+                m.value = d.value;
+        }
+        if (d.timeReceived != null) {
+            m.timeReceived = String(d.timeReceived);
+        }
+        return m;
+    };
+
+    /**
+     * Creates a plain object from a Record message. Also converts values to other types if specified.
+     * @function toObject
+     * @memberof Record
+     * @static
+     * @param {Record} m Record
+     * @param {$protobuf.IConversionOptions} [o] Conversion options
+     * @returns {Object.<string,*>} Plain object
+     */
+    Record.toObject = function toObject(m, o) {
+        if (!o)
+            o = {};
+        var d = {};
+        if (o.defaults) {
+            if (o.bytes === String)
+                d.key = "";
+            else {
+                d.key = [];
+                if (o.bytes !== Array)
+                    d.key = $util.newBuffer(d.key);
+            }
+            if (o.bytes === String)
+                d.value = "";
+            else {
+                d.value = [];
+                if (o.bytes !== Array)
+                    d.value = $util.newBuffer(d.value);
+            }
+            d.timeReceived = "";
+        }
+        if (m.key != null && m.hasOwnProperty("key")) {
+            d.key = o.bytes === String ? $util.base64.encode(m.key, 0, m.key.length) : o.bytes === Array ? Array.prototype.slice.call(m.key) : m.key;
+        }
+        if (m.value != null && m.hasOwnProperty("value")) {
+            d.value = o.bytes === String ? $util.base64.encode(m.value, 0, m.value.length) : o.bytes === Array ? Array.prototype.slice.call(m.value) : m.value;
+        }
+        if (m.timeReceived != null && m.hasOwnProperty("timeReceived")) {
+            d.timeReceived = m.timeReceived;
+        }
+        return d;
+    };
+
+    /**
+     * Converts this Record to JSON.
+     * @function toJSON
+     * @memberof Record
+     * @instance
+     * @returns {Object.<string,*>} JSON object
+     */
+    Record.prototype.toJSON = function toJSON() {
+        return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
+    };
+
+    return Record;
+})();
+
+export { $root as default };

package/dist/src/record.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+// Record represents a dht record that contains a value
+// for a key value pair
+message Record {
+  // The key that references this record
+  bytes key = 1;
+
+  // The actual value this record is storing
+  bytes value = 2;
+
+  // Note: These fields were removed from the Record message
+  // hash of the authors public key
+  // optional bytes author = 3;
+  // A PKI signature for the key+value+author
+  // optional bytes signature = 4;
+
+  // Time the record was received, set by receiver
+  string timeReceived = 5;
+}

package/dist/src/selectors.d.ts

@@ -0,0 +1,16 @@
+import type { Selectors } from '@libp2p/interfaces/dht';
+/**
+ * Select the best record out of the given records
+ */
+export declare function bestRecord(selectors: Selectors, k: Uint8Array, records: Uint8Array[]): number;
+/**
+ * Best record selector, for public key records.
+ * Simply returns the first record, as all valid public key
+ * records are equal
+ */
+declare function publickKey(k: Uint8Array, records: Uint8Array[]): number;
+export declare const selectors: {
+    publickKey: typeof publickKey;
+};
+export {};
+//# sourceMappingURL=selectors.d.ts.map

package/dist/src/selectors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAEvD;;GAEG;AACH,wBAAgB,UAAU,CAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,UA6BrF;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,UAExD;AAED,eAAO,MAAM,SAAS;;CAErB,CAAA"}

package/dist/src/selectors.js

@@ -0,0 +1,38 @@
+import errcode from 'err-code';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+/**
+ * Select the best record out of the given records
+ */
+export function bestRecord(selectors, k, records) {
+    if (records.length === 0) {
+        const errMsg = 'No records given';
+        throw errcode(new Error(errMsg), 'ERR_NO_RECORDS_RECEIVED');
+    }
+    const kStr = uint8ArrayToString(k);
+    const parts = kStr.split('/');
+    if (parts.length < 3) {
+        const errMsg = 'Record key does not have a selector function';
+        throw errcode(new Error(errMsg), 'ERR_NO_SELECTOR_FUNCTION_FOR_RECORD_KEY');
+    }
+    const selector = selectors[parts[1].toString()];
+    if (selector == null) {
+        const errMsg = `Unrecognized key prefix: ${parts[1]}`;
+        throw errcode(new Error(errMsg), 'ERR_UNRECOGNIZED_KEY_PREFIX');
+    }
+    if (records.length === 1) {
+        return 0;
+    }
+    return selector(k, records);
+}
+/**
+ * Best record selector, for public key records.
+ * Simply returns the first record, as all valid public key
+ * records are equal
+ */
+function publickKey(k, records) {
+    return 0;
+}
+export const selectors = {
+    publickKey
+};
+//# sourceMappingURL=selectors.js.map

package/dist/src/selectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAGtE;;GAEG;AACH,MAAM,UAAU,UAAU,CAAE,SAAoB,EAAE,CAAa,EAAE,OAAqB;IACpF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,MAAM,MAAM,GAAG,kBAAkB,CAAA;QAEjC,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,yBAAyB,CAAC,CAAA;KAC5D;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE7B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACpB,MAAM,MAAM,GAAG,8CAA8C,CAAA;QAE7D,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,yCAAyC,CAAC,CAAA;KAC5E;IAED,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAE/C,IAAI,QAAQ,IAAI,IAAI,EAAE;QACpB,MAAM,MAAM,GAAG,4BAA4B,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;QAErD,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,6BAA6B,CAAC,CAAA;KAChE;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,CAAC,CAAA;KACT;IAED,OAAO,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAE,CAAa,EAAE,OAAqB;IACvD,OAAO,CAAC,CAAA;AACV,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,UAAU;CACX,CAAA"}

package/dist/src/utils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Convert a JavaScript date into an `RFC3339Nano` formatted
+ * string
+ */
+export declare function toRFC3339(time: Date): string;
+/**
+ * Parses a date string formatted as `RFC3339Nano` into a
+ * JavaScript Date object
+ */
+export declare function parseRFC3339(time: string): Date;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,SAAS,CAAE,IAAI,EAAE,IAAI,UAWpC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAE,IAAI,EAAE,MAAM,QAwBzC"}

package/dist/src/utils.js

@@ -0,0 +1,41 @@
+/**
+ * Convert a JavaScript date into an `RFC3339Nano` formatted
+ * string
+ */
+export function toRFC3339(time) {
+    const year = time.getUTCFullYear();
+    const month = String(time.getUTCMonth() + 1).padStart(2, '0');
+    const day = String(time.getUTCDate()).padStart(2, '0');
+    const hour = String(time.getUTCHours()).padStart(2, '0');
+    const minute = String(time.getUTCMinutes()).padStart(2, '0');
+    const seconds = String(time.getUTCSeconds()).padStart(2, '0');
+    const milliseconds = time.getUTCMilliseconds();
+    const nanoseconds = milliseconds * 1000 * 1000;
+    return `${year}-${month}-${day}T${hour}:${minute}:${seconds}.${nanoseconds}Z`;
+}
+/**
+ * Parses a date string formatted as `RFC3339Nano` into a
+ * JavaScript Date object
+ */
+export function parseRFC3339(time) {
+    const rfc3339Matcher = new RegExp(
+    // 2006-01-02T
+    '(\\d{4})-(\\d{2})-(\\d{2})T' +
+        // 15:04:05
+        '(\\d{2}):(\\d{2}):(\\d{2})' +
+        // .999999999Z
+        '\\.(\\d+)Z');
+    const m = String(time).trim().match(rfc3339Matcher);
+    if (m == null) {
+        throw new Error('Invalid format');
+    }
+    const year = parseInt(m[1], 10);
+    const month = parseInt(m[2], 10) - 1;
+    const date = parseInt(m[3], 10);
+    const hour = parseInt(m[4], 10);
+    const minute = parseInt(m[5], 10);
+    const second = parseInt(m[6], 10);
+    const millisecond = parseInt(m[7].slice(0, -6), 10);
+    return new Date(Date.UTC(year, month, date, hour, minute, second, millisecond));
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAE,IAAU;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACtD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACxD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC5D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC7D,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC9C,MAAM,WAAW,GAAG,YAAY,GAAG,IAAI,GAAG,IAAI,CAAA;IAE9C,OAAO,GAAG,IAAI,IAAI,KAAK,IAAI,GAAG,IAAI,IAAI,IAAI,MAAM,IAAI,OAAO,IAAI,WAAW,GAAG,CAAA;AAC/E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAE,IAAY;IACxC,MAAM,cAAc,GAAG,IAAI,MAAM;IAC/B,cAAc;IACd,6BAA6B;QAC7B,WAAW;QACX,4BAA4B;QAC5B,cAAc;QACd,YAAY,CACb,CAAA;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAEnD,IAAI,CAAC,IAAI,IAAI,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;KAClC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;IACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IACjC,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAEnD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAA;AACjF,CAAC"}

package/dist/src/validators.d.ts

@@ -0,0 +1,15 @@
+import type { Libp2pRecord } from './index.js';
+import type { Validators } from '@libp2p/interfaces/dht';
+/**
+ * Checks a record and ensures it is still valid.
+ * It runs the needed validators.
+ * If verification fails the returned Promise will reject with the error.
+ */
+export declare function verifyRecord(validators: Validators, record: Libp2pRecord): Promise<void> | undefined;
+export declare const validators: {
+    publicKey: {
+        func: (key: Uint8Array, publicKey: Uint8Array) => Promise<void>;
+        sign: boolean;
+    };
+};
+//# sourceMappingURL=validators.d.ts.map

package/dist/src/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../src/validators.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAIxD;;;;GAIG;AACH,wBAAgB,YAAY,CAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,6BAmBzE;AAwCD,eAAO,MAAM,UAAU;;oBA7BqB,UAAU,aAAa,UAAU;;;CA+B5E,CAAA"}

package/dist/src/validators.js

@@ -0,0 +1,58 @@
+import errcode from 'err-code';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+import { sha256 } from 'multiformats/hashes/sha2';
+import { equals as uint8ArrayEquals } from 'uint8arrays/equals';
+/**
+ * Checks a record and ensures it is still valid.
+ * It runs the needed validators.
+ * If verification fails the returned Promise will reject with the error.
+ */
+export function verifyRecord(validators, record) {
+    const key = record.key;
+    const keyString = uint8ArrayToString(key);
+    const parts = keyString.split('/');
+    if (parts.length < 3) {
+        // No validator available
+        return;
+    }
+    const validator = validators[parts[1].toString()];
+    if (validator == null) {
+        const errMsg = 'Invalid record keytype';
+        throw errcode(new Error(errMsg), 'ERR_INVALID_RECORD_KEY_TYPE');
+    }
+    return validator.func(key, record.value);
+}
+/**
+ * Validator for public key records.
+ * Verifies that the passed in record value is the PublicKey
+ * that matches the passed in key.
+ * If validation fails the returned Promise will reject with the error.
+ *
+ * @param {Uint8Array} key - A valid key is of the form `'/pk/<keymultihash>'`
+ * @param {Uint8Array} publicKey - The public key to validate against (protobuf encoded).
+ */
+const validatePublicKeyRecord = async (key, publicKey) => {
+    if (!(key instanceof Uint8Array)) {
+        throw errcode(new Error('"key" must be a Uint8Array'), 'ERR_INVALID_RECORD_KEY_NOT_BUFFER');
+    }
+    if (key.byteLength < 5) {
+        throw errcode(new Error('invalid public key record'), 'ERR_INVALID_RECORD_KEY_TOO_SHORT');
+    }
+    const prefix = uint8ArrayToString(key.subarray(0, 4));
+    if (prefix !== '/pk/') {
+        throw errcode(new Error('key was not prefixed with /pk/'), 'ERR_INVALID_RECORD_KEY_BAD_PREFIX');
+    }
+    const keyhash = key.slice(4);
+    const publicKeyHash = await sha256.digest(publicKey);
+    if (!uint8ArrayEquals(keyhash, publicKeyHash.bytes)) {
+        throw errcode(new Error('public key does not match passed in key'), 'ERR_INVALID_RECORD_HASH_MISMATCH');
+    }
+};
+const publicKey = {
+    func: validatePublicKeyRecord,
+    sign: false
+};
+export const validators = {
+    publicKey
+};
+//# sourceMappingURL=validators.js.map

package/dist/src/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAGtE,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE/D;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAE,UAAsB,EAAE,MAAoB;IACxE,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAA;IACtB,MAAM,SAAS,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAA;IACzC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAElC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACpB,yBAAyB;QACzB,OAAM;KACP;IAED,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAEjD,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,MAAM,MAAM,GAAG,wBAAwB,CAAA;QAEvC,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,6BAA6B,CAAC,CAAA;KAChE;IAED,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,uBAAuB,GAAG,KAAK,EAAE,GAAe,EAAE,SAAqB,EAAE,EAAE;IAC/E,IAAI,CAAC,CAAC,GAAG,YAAY,UAAU,CAAC,EAAE;QAChC,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,4BAA4B,CAAC,EAAE,mCAAmC,CAAC,CAAA;KAC5F;IAED,IAAI,GAAG,CAAC,UAAU,GAAG,CAAC,EAAE;QACtB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,EAAE,kCAAkC,CAAC,CAAA;KAC1F;IAED,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAErD,IAAI,MAAM,KAAK,MAAM,EAAE;QACrB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,gCAAgC,CAAC,EAAE,mCAAmC,CAAC,CAAA;KAChG;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAE5B,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAEpD,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;QACnD,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,yCAAyC,CAAC,EAAE,kCAAkC,CAAC,CAAA;KACxG;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAG;IAChB,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,KAAK;CACZ,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,SAAS;CACV,CAAA"}