@libp2p/peer-id 0.0.0 → 0.2.0

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,42 @@
+# libp2p-peer-id <!-- omit in toc -->
+
+> peer-ids in JavaScript
+
+## Table of Contents <!-- omit in toc -->
+
+- [Description](#description)
+- [Example](#example)
+- [Installation](#installation)
+  - [License](#license)
+    - [Contribution](#contribution)
+
+# Description
+
+A basic implementation of a peer id
+
+# Example
+
+```JavaScript
+import { PeerId } from '@libp2p/peer-id'
+
+const id = new PeerId(...)
+
+console.log(id.toCid())
+```
+
+# Installation
+
+```console
+$ npm i libp2p-peer-id
+```
+
+## 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,63 @@
+import { CID } from 'multiformats/cid';
+import type { MultibaseDecoder, MultibaseEncoder } from 'multiformats/types/bases/interface';
+import type { MultihashDigest } from 'multiformats/types/hashes/interface';
+interface PeerIdOptions {
+    type: 'RSA' | 'Ed25519' | 'secp256k1';
+    multihash: MultihashDigest;
+    privateKey?: Uint8Array;
+}
+interface RSAPeerIdOptions {
+    multihash: MultihashDigest;
+    privateKey?: Uint8Array;
+    publicKey?: Uint8Array;
+}
+interface Ed25519PeerIdOptions {
+    multihash: MultihashDigest;
+    privateKey?: Uint8Array;
+}
+interface Secp256k1PeerIdOptions {
+    multihash: MultihashDigest;
+    privateKey?: Uint8Array;
+}
+export declare class PeerId {
+    type: 'RSA' | 'Ed25519' | 'secp256k1';
+    readonly multihash: MultihashDigest;
+    readonly privateKey?: Uint8Array;
+    readonly publicKey?: Uint8Array;
+    constructor(opts: PeerIdOptions);
+    toString(codec?: MultibaseEncoder<any>): string;
+    toCID(): CID;
+    toBytes(): Uint8Array;
+    /**
+     * Checks the equality of `this` peer against a given PeerId.
+     *
+     * @param {Uint8Array|PeerId} id
+     * @returns {boolean}
+     */
+    equals(id: any): boolean;
+    static fromString(str: string, decoder?: MultibaseDecoder<any>): Ed25519PeerId | Secp256k1PeerId | RSAPeerId;
+    static fromBytes(buf: Uint8Array): Ed25519PeerId | Secp256k1PeerId | RSAPeerId;
+    static fromCID(cid: CID): Ed25519PeerId | Secp256k1PeerId | RSAPeerId;
+    /**
+     * @param publicKey - A marshalled public key
+     * @param privateKey - A marshalled private key
+     */
+    static fromKeys(publicKey: Uint8Array, privateKey?: Uint8Array): Promise<Ed25519PeerId | Secp256k1PeerId | RSAPeerId>;
+}
+export declare class RSAPeerId extends PeerId {
+    readonly type = "RSA";
+    readonly publicKey?: Uint8Array;
+    constructor(opts: RSAPeerIdOptions);
+}
+export declare class Ed25519PeerId extends PeerId {
+    readonly type = "Ed25519";
+    readonly publicKey: Uint8Array;
+    constructor(opts: Ed25519PeerIdOptions);
+}
+export declare class Secp256k1PeerId extends PeerId {
+    readonly type = "secp256k1";
+    readonly publicKey: Uint8Array;
+    constructor(opts: Secp256k1PeerIdOptions);
+}
+export {};
+//# 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":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAMtC,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAA;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AAe1E,UAAU,aAAa;IACrB,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,WAAW,CAAA;IACrC,SAAS,EAAE,eAAe,CAAA;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED,UAAU,gBAAgB;IACxB,SAAS,EAAE,eAAe,CAAA;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,SAAS,CAAC,EAAE,UAAU,CAAA;CACvB;AAED,UAAU,oBAAoB;IAC5B,SAAS,EAAE,eAAe,CAAA;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED,UAAU,sBAAsB;IAC9B,SAAS,EAAE,eAAe,CAAA;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED,qBAAa,MAAM;IACV,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,WAAW,CAAA;IAC5C,SAAgB,SAAS,EAAE,eAAe,CAAA;IAC1C,SAAgB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvC,SAAgB,SAAS,CAAC,EAAE,UAAU,CAAA;gBAEzB,IAAI,EAAE,aAAa;IAMhC,QAAQ,CAAE,KAAK,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC;IAUvC,KAAK;IAIL,OAAO;IAIP;;;;;OAKG;IACH,MAAM,CAAE,EAAE,EAAE,GAAG;IAUf,MAAM,CAAC,UAAU,CAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC;IAoB/D,MAAM,CAAC,SAAS,CAAE,GAAG,EAAE,UAAU;IAsBjC,MAAM,CAAC,OAAO,CAAE,GAAG,EAAE,GAAG;IAoBxB;;;OAGG;WACU,QAAQ,CAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,UAAU;CAWtE;AAED,qBAAa,SAAU,SAAQ,MAAM;IACnC,SAAgB,IAAI,SAAQ;IAC5B,SAAgB,SAAS,CAAC,EAAE,UAAU,CAAA;gBAEzB,IAAI,EAAE,gBAAgB;CAKpC;AAED,qBAAa,aAAc,SAAQ,MAAM;IACvC,SAAgB,IAAI,aAAY;IAChC,SAAgB,SAAS,EAAE,UAAU,CAAA;gBAExB,IAAI,EAAE,oBAAoB;CAKxC;AAED,qBAAa,eAAgB,SAAQ,MAAM;IACzC,SAAgB,IAAI,eAAc;IAClC,SAAgB,SAAS,EAAE,UAAU,CAAA;gBAExB,IAAI,EAAE,sBAAsB;CAK1C"}

package/dist/src/index.js

@@ -0,0 +1,145 @@
+import { CID } from 'multiformats/cid';
+import { bases } from 'multiformats/basics';
+import { base58btc } from 'multiformats/bases/base58';
+import * as Digest from 'multiformats/hashes/digest';
+import { identity } from 'multiformats/hashes/identity';
+import { equals as uint8ArrayEquals } from 'uint8arrays/equals';
+import { sha256 } from 'multiformats/hashes/sha2';
+const baseDecoder = Object
+    .values(bases)
+    .map(codec => codec.decoder)
+    // @ts-expect-error https://github.com/multiformats/js-multiformats/issues/141
+    .reduce((acc, curr) => acc.or(curr), bases.identity.decoder);
+// these values are from https://github.com/multiformats/multicodec/blob/master/table.csv
+const LIBP2P_KEY_CODE = 0x72;
+const MARSHALLED_ED225519_PUBLIC_KEY_LENGTH = 36;
+const MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH = 37;
+export class PeerId {
+    constructor(opts) {
+        this.type = opts.type;
+        this.multihash = opts.multihash;
+        this.privateKey = opts.privateKey;
+    }
+    toString(codec) {
+        if (codec == null) {
+            codec = base58btc;
+        }
+        return codec.encode(this.multihash.bytes).slice(1);
+    }
+    // return self-describing String representation
+    // in default format from RFC 0001: https://github.com/libp2p/specs/pull/209
+    toCID() {
+        return CID.createV1(LIBP2P_KEY_CODE, this.multihash);
+    }
+    toBytes() {
+        return this.multihash.bytes;
+    }
+    /**
+     * Checks the equality of `this` peer against a given PeerId.
+     *
+     * @param {Uint8Array|PeerId} id
+     * @returns {boolean}
+     */
+    equals(id) {
+        if (id instanceof Uint8Array) {
+            return uint8ArrayEquals(this.multihash.bytes, id);
+        }
+        else if (id?.multihash?.bytes != null) {
+            return uint8ArrayEquals(this.multihash.bytes, id.multihash.bytes);
+        }
+        else {
+            throw new Error('not valid Id');
+        }
+    }
+    static fromString(str, decoder) {
+        decoder = decoder ?? baseDecoder;
+        if (str.charAt(0) === '1' || str.charAt(0) === 'Q') {
+            // identity hash ed25519/secp256k1 key or sha2-256 hash of
+            // rsa public key - base58btc encoded either way
+            const multihash = Digest.decode(base58btc.decode(`z${str}`));
+            if (str.startsWith('12D')) {
+                return new Ed25519PeerId({ multihash });
+            }
+            else if (str.startsWith('16U')) {
+                return new Secp256k1PeerId({ multihash });
+            }
+            else {
+                return new RSAPeerId({ multihash });
+            }
+        }
+        return PeerId.fromBytes(baseDecoder.decode(str));
+    }
+    static fromBytes(buf) {
+        try {
+            const multihash = Digest.decode(buf);
+            if (multihash.code === identity.code) {
+                if (multihash.digest.length === MARSHALLED_ED225519_PUBLIC_KEY_LENGTH) {
+                    return new Ed25519PeerId({ multihash });
+                }
+                else if (multihash.digest.length === MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH) {
+                    return new Secp256k1PeerId({ multihash });
+                }
+            }
+            if (multihash.code === sha256.code) {
+                return new RSAPeerId({ multihash });
+            }
+        }
+        catch {
+            return PeerId.fromCID(CID.decode(buf));
+        }
+        throw new Error('Supplied PeerID CID is invalid');
+    }
+    static fromCID(cid) {
+        if (cid == null || cid.multihash == null || cid.version == null || (cid.version === 1 && cid.code !== LIBP2P_KEY_CODE)) {
+            throw new Error('Supplied PeerID CID is invalid');
+        }
+        const multihash = cid.multihash;
+        if (multihash.code === sha256.code) {
+            return new RSAPeerId({ multihash: cid.multihash });
+        }
+        else if (multihash.code === identity.code) {
+            if (multihash.bytes.length === MARSHALLED_ED225519_PUBLIC_KEY_LENGTH) {
+                return new Ed25519PeerId({ multihash: cid.multihash });
+            }
+            else if (multihash.bytes.length === MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH) {
+                return new Secp256k1PeerId({ multihash: cid.multihash });
+            }
+        }
+        throw new Error('Supplied PeerID CID is invalid');
+    }
+    /**
+     * @param publicKey - A marshalled public key
+     * @param privateKey - A marshalled private key
+     */
+    static async fromKeys(publicKey, privateKey) {
+        if (publicKey.length === MARSHALLED_ED225519_PUBLIC_KEY_LENGTH) {
+            return new Ed25519PeerId({ multihash: Digest.create(identity.code, publicKey), privateKey });
+        }
+        if (publicKey.length === MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH) {
+            return new Secp256k1PeerId({ multihash: Digest.create(identity.code, publicKey), privateKey });
+        }
+        return new RSAPeerId({ multihash: await sha256.digest(publicKey), publicKey, privateKey });
+    }
+}
+export class RSAPeerId extends PeerId {
+    constructor(opts) {
+        super({ ...opts, type: 'RSA' });
+        this.type = 'RSA';
+        this.publicKey = opts.publicKey;
+    }
+}
+export class Ed25519PeerId extends PeerId {
+    constructor(opts) {
+        super({ ...opts, type: 'Ed25519' });
+        this.type = 'Ed25519';
+        this.publicKey = opts.multihash.digest;
+    }
+}
+export class Secp256k1PeerId extends PeerId {
+    constructor(opts) {
+        super({ ...opts, type: 'secp256k1' });
+        this.type = 'secp256k1';
+        this.publicKey = opts.multihash.digest;
+    }
+}
+//# 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,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AACrD,OAAO,KAAK,MAAM,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAA;AACvD,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAG/D,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AAEjD,MAAM,WAAW,GAAG,MAAM;KACvB,MAAM,CAAC,KAAK,CAAC;KACb,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,8EAA8E;KAC7E,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;AAE9D,yFAAyF;AACzF,MAAM,eAAe,GAAG,IAAI,CAAA;AAE5B,MAAM,qCAAqC,GAAG,EAAE,CAAA;AAChD,MAAM,sCAAsC,GAAG,EAAE,CAAA;AAwBjD,MAAM,OAAO,MAAM;IAMjB,YAAa,IAAmB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;IACnC,CAAC;IAED,QAAQ,CAAE,KAA6B;QACrC,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,KAAK,GAAG,SAAS,CAAA;SAClB;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACpD,CAAC;IAED,+CAA+C;IAC/C,4EAA4E;IAC5E,KAAK;QACH,OAAO,GAAG,CAAC,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACtD,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAE,EAAO;QACb,IAAI,EAAE,YAAY,UAAU,EAAE;YAC5B,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;SAClD;aAAM,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,IAAI,IAAI,EAAE;YACvC,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;SAClE;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAA;SAChC;IACH,CAAC;IAED,MAAM,CAAC,UAAU,CAAE,GAAW,EAAE,OAA+B;QAC7D,OAAO,GAAG,OAAO,IAAI,WAAW,CAAA;QAEhC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;YAClD,0DAA0D;YAC1D,gDAAgD;YAChD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAA;YAE5D,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBACzB,OAAO,IAAI,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;aACxC;iBAAM,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAChC,OAAO,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;aAC1C;iBAAM;gBACL,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;aACpC;SACF;QAED,OAAO,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;IAClD,CAAC;IAED,MAAM,CAAC,SAAS,CAAE,GAAe;QAC/B,IAAI;YACF,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAEpC,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;gBACpC,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,KAAK,qCAAqC,EAAE;oBACrE,OAAO,IAAI,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;iBACxC;qBAAM,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,KAAK,sCAAsC,EAAE;oBAC7E,OAAO,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;iBAC1C;aACF;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE;gBAClC,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;aACpC;SACF;QAAC,MAAM;YACN,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;SACvC;QAED,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAAC,OAAO,CAAE,GAAQ;QACtB,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,SAAS,IAAI,IAAI,IAAI,GAAG,CAAC,OAAO,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC,EAAE;YACtH,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;SAClD;QAED,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAA;QAE/B,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE;YAClC,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAA;SACnD;aAAM,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;YAC3C,IAAI,SAAS,CAAC,KAAK,CAAC,MAAM,KAAK,qCAAqC,EAAE;gBACpE,OAAO,IAAI,aAAa,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAA;aACvD;iBAAM,IAAI,SAAS,CAAC,KAAK,CAAC,MAAM,KAAK,sCAAsC,EAAE;gBAC5E,OAAO,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAA;aACzD;SACF;QAED,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAE,SAAqB,EAAE,UAAuB;QACnE,IAAI,SAAS,CAAC,MAAM,KAAK,qCAAqC,EAAE;YAC9D,OAAO,IAAI,aAAa,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;SAC7F;QAED,IAAI,SAAS,CAAC,MAAM,KAAK,sCAAsC,EAAE;YAC/D,OAAO,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;SAC/F;QAED,OAAO,IAAI,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAA;IAC5F,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,MAAM;IAInC,YAAa,IAAsB;QACjC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;QAJjB,SAAI,GAAG,KAAK,CAAA;QAM1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;IACjC,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,MAAM;IAIvC,YAAa,IAA0B;QACrC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;QAJrB,SAAI,GAAG,SAAS,CAAA;QAM9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IACxC,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,MAAM;IAIzC,YAAa,IAA4B;QACvC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;QAJvB,SAAI,GAAG,WAAW,CAAA;QAMhC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;IACxC,CAAC;CACF"}

package/package.json

@@ -1,7 +1,57 @@
 {
   "name": "@libp2p/peer-id",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "license": "(Apache-2.0 OR MIT)"
+  "version": "0.2.0",
+  "description": "IPFS Peer Id implementation in Node.js",
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "src",
+    "dist/src",
+    "!**/*.tsbuildinfo"
+  ],
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "scripts": {
+    "pretest": "npm run build",
+    "test": "aegir test -f ./dist/test/**/*.js",
+    "test:browser": "aegir test -t browser -f ./dist/test/**/*.js",
+    "test:node": "aegir test -t node -f ./dist/test/**/*.js",
+    "test:electron-main": "aegir test -t electron-main -f ./dist/test/**/*.js",
+    "lint": "aegir ts -p check && aegir lint",
+    "build": "tsc",
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=15.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-interfaces.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-interfaces/issues"
+  },
+  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-peer-id#readme",
+  "devDependencies": {
+    "aegir": "^36.0.1"
+  },
+  "dependencies": {
+    "@libp2p/interfaces": "^0.2.0",
+    "multiformats": "^9.4.5",
+    "uint8arrays": "^3.0.0"
+  },
+  "gitHead": "899cb6a9390c748bccf9b6404f104efb011a0c9c"
 }

package/src/index.ts

@@ -0,0 +1,201 @@
+import { CID } from 'multiformats/cid'
+import { bases } from 'multiformats/basics'
+import { base58btc } from 'multiformats/bases/base58'
+import * as Digest from 'multiformats/hashes/digest'
+import { identity } from 'multiformats/hashes/identity'
+import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
+import type { MultibaseDecoder, MultibaseEncoder } from 'multiformats/types/bases/interface'
+import type { MultihashDigest } from 'multiformats/types/hashes/interface'
+import { sha256 } from 'multiformats/hashes/sha2'
+
+const baseDecoder = Object
+  .values(bases)
+  .map(codec => codec.decoder)
+  // @ts-expect-error https://github.com/multiformats/js-multiformats/issues/141
+  .reduce((acc, curr) => acc.or(curr), bases.identity.decoder)
+
+// these values are from https://github.com/multiformats/multicodec/blob/master/table.csv
+const LIBP2P_KEY_CODE = 0x72
+
+const MARSHALLED_ED225519_PUBLIC_KEY_LENGTH = 36
+const MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH = 37
+
+interface PeerIdOptions {
+  type: 'RSA' | 'Ed25519' | 'secp256k1'
+  multihash: MultihashDigest
+  privateKey?: Uint8Array
+}
+
+interface RSAPeerIdOptions {
+  multihash: MultihashDigest
+  privateKey?: Uint8Array
+  publicKey?: Uint8Array
+}
+
+interface Ed25519PeerIdOptions {
+  multihash: MultihashDigest
+  privateKey?: Uint8Array
+}
+
+interface Secp256k1PeerIdOptions {
+  multihash: MultihashDigest
+  privateKey?: Uint8Array
+}
+
+export class PeerId {
+  public type: 'RSA' | 'Ed25519' | 'secp256k1'
+  public readonly multihash: MultihashDigest
+  public readonly privateKey?: Uint8Array
+  public readonly publicKey?: Uint8Array
+
+  constructor (opts: PeerIdOptions) {
+    this.type = opts.type
+    this.multihash = opts.multihash
+    this.privateKey = opts.privateKey
+  }
+
+  toString (codec?: MultibaseEncoder<any>) {
+    if (codec == null) {
+      codec = base58btc
+    }
+
+    return codec.encode(this.multihash.bytes).slice(1)
+  }
+
+  // return self-describing String representation
+  // in default format from RFC 0001: https://github.com/libp2p/specs/pull/209
+  toCID () {
+    return CID.createV1(LIBP2P_KEY_CODE, this.multihash)
+  }
+
+  toBytes () {
+    return this.multihash.bytes
+  }
+
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   *
+   * @param {Uint8Array|PeerId} id
+   * @returns {boolean}
+   */
+  equals (id: any) {
+    if (id instanceof Uint8Array) {
+      return uint8ArrayEquals(this.multihash.bytes, id)
+    } else if (id?.multihash?.bytes != null) {
+      return uint8ArrayEquals(this.multihash.bytes, id.multihash.bytes)
+    } else {
+      throw new Error('not valid Id')
+    }
+  }
+
+  static fromString (str: string, decoder?: MultibaseDecoder<any>) {
+    decoder = decoder ?? baseDecoder
+
+    if (str.charAt(0) === '1' || str.charAt(0) === 'Q') {
+      // identity hash ed25519/secp256k1 key or sha2-256 hash of
+      // rsa public key - base58btc encoded either way
+      const multihash = Digest.decode(base58btc.decode(`z${str}`))
+
+      if (str.startsWith('12D')) {
+        return new Ed25519PeerId({ multihash })
+      } else if (str.startsWith('16U')) {
+        return new Secp256k1PeerId({ multihash })
+      } else {
+        return new RSAPeerId({ multihash })
+      }
+    }
+
+    return PeerId.fromBytes(baseDecoder.decode(str))
+  }
+
+  static fromBytes (buf: Uint8Array) {
+    try {
+      const multihash = Digest.decode(buf)
+
+      if (multihash.code === identity.code) {
+        if (multihash.digest.length === MARSHALLED_ED225519_PUBLIC_KEY_LENGTH) {
+          return new Ed25519PeerId({ multihash })
+        } else if (multihash.digest.length === MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH) {
+          return new Secp256k1PeerId({ multihash })
+        }
+      }
+
+      if (multihash.code === sha256.code) {
+        return new RSAPeerId({ multihash })
+      }
+    } catch {
+      return PeerId.fromCID(CID.decode(buf))
+    }
+
+    throw new Error('Supplied PeerID CID is invalid')
+  }
+
+  static fromCID (cid: CID) {
+    if (cid == null || cid.multihash == null || cid.version == null || (cid.version === 1 && cid.code !== LIBP2P_KEY_CODE)) {
+      throw new Error('Supplied PeerID CID is invalid')
+    }
+
+    const multihash = cid.multihash
+
+    if (multihash.code === sha256.code) {
+      return new RSAPeerId({ multihash: cid.multihash })
+    } else if (multihash.code === identity.code) {
+      if (multihash.bytes.length === MARSHALLED_ED225519_PUBLIC_KEY_LENGTH) {
+        return new Ed25519PeerId({ multihash: cid.multihash })
+      } else if (multihash.bytes.length === MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH) {
+        return new Secp256k1PeerId({ multihash: cid.multihash })
+      }
+    }
+
+    throw new Error('Supplied PeerID CID is invalid')
+  }
+
+  /**
+   * @param publicKey - A marshalled public key
+   * @param privateKey - A marshalled private key
+   */
+  static async fromKeys (publicKey: Uint8Array, privateKey?: Uint8Array) {
+    if (publicKey.length === MARSHALLED_ED225519_PUBLIC_KEY_LENGTH) {
+      return new Ed25519PeerId({ multihash: Digest.create(identity.code, publicKey), privateKey })
+    }
+
+    if (publicKey.length === MARSHALLED_SECP258K1_PUBLIC_KEY_LENGTH) {
+      return new Secp256k1PeerId({ multihash: Digest.create(identity.code, publicKey), privateKey })
+    }
+
+    return new RSAPeerId({ multihash: await sha256.digest(publicKey), publicKey, privateKey })
+  }
+}
+
+export class RSAPeerId extends PeerId {
+  public readonly type = 'RSA'
+  public readonly publicKey?: Uint8Array
+
+  constructor (opts: RSAPeerIdOptions) {
+    super({ ...opts, type: 'RSA' })
+
+    this.publicKey = opts.publicKey
+  }
+}
+
+export class Ed25519PeerId extends PeerId {
+  public readonly type = 'Ed25519'
+  public readonly publicKey: Uint8Array
+
+  constructor (opts: Ed25519PeerIdOptions) {
+    super({ ...opts, type: 'Ed25519' })
+
+    this.publicKey = opts.multihash.digest
+  }
+}
+
+export class Secp256k1PeerId extends PeerId {
+  public readonly type = 'secp256k1'
+  public readonly publicKey: Uint8Array
+
+  constructor (opts: Secp256k1PeerIdOptions) {
+    super({ ...opts, type: 'secp256k1' })
+
+    this.publicKey = opts.multihash.digest
+  }
+}