@libp2p/interface 0.1.6 → 1.0.0

package/dist/src/keychain/index.js

@@ -1,23 +0,0 @@
-/**
- * @packageDocumentation
- *
- * The libp2p keychain provides an API to store keys in a datastore in
- * an encrypted format.
- *
- * @example
- *
- * ```typescript
- * import { createLibp2p } from 'libp2p'
- * import { FsDatastore } from 'datastore-fs'
- *
- * const node = await createLibp2p({
- *   datastore: new FsDatastore('/path/to/dir')
- * })
- *
- * const info = await node.keychain.createKey('my-new-key', 'Ed25519')
- *
- * console.info(info) // { id: '...', name: 'my-new-key' }
- * ```
- */
-export {};
-//# sourceMappingURL=index.js.map

package/dist/src/keychain/index.js.map

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

package/dist/src/metrics/tracked-map.d.ts

@@ -1,17 +0,0 @@
-import type { Metrics } from './index.js';
-export interface TrackedMapInit {
-    name: string;
-    metrics: Metrics;
-}
-export interface CreateTrackedMapInit {
-    /**
-     * The metric name to use
-     */
-    name: string;
-    /**
-     * A metrics implementation
-     */
-    metrics?: Metrics;
-}
-export declare function trackedMap<K, V>(config: CreateTrackedMapInit): Map<K, V>;
-//# sourceMappingURL=tracked-map.d.ts.map

package/dist/src/metrics/tracked-map.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracked-map.d.ts","sourceRoot":"","sources":["../../../src/metrics/tracked-map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,OAAO,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;CACjB;AAoCD,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,wBAAgB,UAAU,CAAE,CAAC,EAAE,CAAC,EAAG,MAAM,EAAE,oBAAoB,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAW1E"}

package/dist/src/metrics/tracked-map.js

@@ -1,38 +0,0 @@
-class TrackedMap extends Map {
-    metric;
-    constructor(init) {
-        super();
-        const { name, metrics } = init;
-        this.metric = metrics.registerMetric(name);
-        this.updateComponentMetric();
-    }
-    set(key, value) {
-        super.set(key, value);
-        this.updateComponentMetric();
-        return this;
-    }
-    delete(key) {
-        const deleted = super.delete(key);
-        this.updateComponentMetric();
-        return deleted;
-    }
-    clear() {
-        super.clear();
-        this.updateComponentMetric();
-    }
-    updateComponentMetric() {
-        this.metric.update(this.size);
-    }
-}
-export function trackedMap(config) {
-    const { name, metrics } = config;
-    let map;
-    if (metrics != null) {
-        map = new TrackedMap({ name, metrics });
-    }
-    else {
-        map = new Map();
-    }
-    return map;
-}
-//# sourceMappingURL=tracked-map.js.map

package/dist/src/metrics/tracked-map.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracked-map.js","sourceRoot":"","sources":["../../../src/metrics/tracked-map.ts"],"names":[],"mappings":"AAOA,MAAM,UAAiB,SAAQ,GAAS;IACrB,MAAM,CAAQ;IAE/B,YAAa,IAAoB;QAC/B,KAAK,EAAE,CAAA;QAEP,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QAE9B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC1C,IAAI,CAAC,qBAAqB,EAAE,CAAA;IAC9B,CAAC;IAED,GAAG,CAAE,GAAM,EAAE,KAAQ;QACnB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACrB,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAE,GAAM;QACZ,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACjC,IAAI,CAAC,qBAAqB,EAAE,CAAA;QAC5B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,KAAK;QACH,KAAK,CAAC,KAAK,EAAE,CAAA;QACb,IAAI,CAAC,qBAAqB,EAAE,CAAA;IAC9B,CAAC;IAEO,qBAAqB;QAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;CACF;AAcD,MAAM,UAAU,UAAU,CAAS,MAA4B;IAC7D,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;IAChC,IAAI,GAAc,CAAA;IAElB,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,GAAG,GAAG,IAAI,UAAU,CAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;KAC9C;SAAM;QACL,GAAG,GAAG,IAAI,GAAG,EAAQ,CAAA;KACtB;IAED,OAAO,GAAG,CAAA;AACZ,CAAC"}

package/src/keychain/index.ts

@@ -1,167 +0,0 @@
-/**
- * @packageDocumentation
- *
- * The libp2p keychain provides an API to store keys in a datastore in
- * an encrypted format.
- *
- * @example
- *
- * ```typescript
- * import { createLibp2p } from 'libp2p'
- * import { FsDatastore } from 'datastore-fs'
- *
- * const node = await createLibp2p({
- *   datastore: new FsDatastore('/path/to/dir')
- * })
- *
- * const info = await node.keychain.createKey('my-new-key', 'Ed25519')
- *
- * console.info(info) // { id: '...', name: 'my-new-key' }
- * ```
- */
-
-import type { KeyType } from '../keys/index.js'
-import type { PeerId } from '../peer-id/index.js'
-import type { Multibase } from 'multiformats/bases/interface'
-
-export interface KeyInfo {
-  /**
-   * The universally unique key id
-   */
-  id: string
-
-  /**
-   * The local key name
-   */
-  name: string
-}
-
-export interface KeyChain {
-  /**
-   * Export an existing key as a PEM encrypted PKCS #8 string.
-   *
-   * @example
-   *
-   * ```js
-   * await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * const pemKey = await libp2p.keychain.exportKey('keyTest', 'password123')
-   * ```
-   */
-  exportKey(name: string, password: string): Promise<Multibase<'m'>>
-
-  /**
-   * Import a new key from a PEM encoded PKCS #8 string.
-   *
-   * @example
-   *
-   * ```js
-   * await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * const pemKey = await libp2p.keychain.exportKey('keyTest', 'password123')
-   * const keyInfo = await libp2p.keychain.importKey('keyTestImport', pemKey, 'password123')
-   * ```
-   */
-  importKey(name: string, pem: string, password: string): Promise<KeyInfo>
-
-  /**
-   * Import a new key from a PeerId with a private key component
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfo = await libp2p.keychain.importPeer('keyTestImport', peerIdFromString('12D3Foo...'))
-   * ```
-   */
-  importPeer(name: string, peerId: PeerId): Promise<KeyInfo>
-
-  /**
-   * Export an existing key as a PeerId
-   *
-   * @example
-   *
-   * ```js
-   * const peerId = await libp2p.keychain.exportPeerId('key-name')
-   * ```
-   */
-  exportPeerId(name: string): Promise<PeerId>
-
-  /**
-   * Create a key in the keychain.
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * ```
-   */
-  createKey(name: string, type: KeyType, size?: number): Promise<KeyInfo>
-
-  /**
-   * List all the keys.
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfos = await libp2p.keychain.listKeys()
-   * ```
-   */
-  listKeys(): Promise<KeyInfo[]>
-
-  /**
-   * Removes a key from the keychain.
-   *
-   * @example
-   *
-   * ```js
-   * await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * const keyInfo = await libp2p.keychain.removeKey('keyTest')
-   * ```
-   */
-  removeKey(name: string): Promise<KeyInfo>
-
-  /**
-   * Rename a key in the keychain.
-   *
-   * @example
-   *
-   * ```js
-   * await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * const keyInfo = await libp2p.keychain.renameKey('keyTest', 'keyNewNtest')
-   * ```
-   */
-  renameKey(oldName: string, newName: string): Promise<KeyInfo>
-
-  /**
-   * Find a key by it's id.
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * const keyInfo2 = await libp2p.keychain.findKeyById(keyInfo.id)
-   * ```
-   */
-  findKeyById(id: string): Promise<KeyInfo>
-
-  /**
-   * Find a key by it's name.
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
-   * const keyInfo2 = await libp2p.keychain.findKeyByName('keyTest')
-   * ```
-   */
-  findKeyByName(name: string): Promise<KeyInfo>
-
-  /**
-   * Rotate keychain password and re-encrypt all associated keys
-   *
-   * @example
-   *
-   * ```js
-   * await libp2p.keychain.rotateKeychainPass('oldPassword', 'newPassword')
-   * ```
-   */
-  rotateKeychainPass(oldPass: string, newPass: string): Promise<void>
-}

package/src/metrics/tracked-map.ts

@@ -1,65 +0,0 @@
-import type { Metric, Metrics } from './index.js'
-
-export interface TrackedMapInit {
-  name: string
-  metrics: Metrics
-}
-
-class TrackedMap<K, V> extends Map<K, V> {
-  private readonly metric: Metric
-
-  constructor (init: TrackedMapInit) {
-    super()
-
-    const { name, metrics } = init
-
-    this.metric = metrics.registerMetric(name)
-    this.updateComponentMetric()
-  }
-
-  set (key: K, value: V): this {
-    super.set(key, value)
-    this.updateComponentMetric()
-    return this
-  }
-
-  delete (key: K): boolean {
-    const deleted = super.delete(key)
-    this.updateComponentMetric()
-    return deleted
-  }
-
-  clear (): void {
-    super.clear()
-    this.updateComponentMetric()
-  }
-
-  private updateComponentMetric (): void {
-    this.metric.update(this.size)
-  }
-}
-
-export interface CreateTrackedMapInit {
-  /**
-   * The metric name to use
-   */
-  name: string
-
-  /**
-   * A metrics implementation
-   */
-  metrics?: Metrics
-}
-
-export function trackedMap <K, V> (config: CreateTrackedMapInit): Map<K, V> {
-  const { name, metrics } = config
-  let map: Map<K, V>
-
-  if (metrics != null) {
-    map = new TrackedMap<K, V>({ name, metrics })
-  } else {
-    map = new Map<K, V>()
-  }
-
-  return map
-}