@libp2p/interface 0.1.2 → 0.1.3-68504939

package/src/index.ts

@@ -418,7 +418,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * // [ <Multiaddr 047f00000106f9ba - /ip4/127.0.0.1/tcp/63930> ]
    * ```
    */
-  getMultiaddrs: () => Multiaddr[]
+  getMultiaddrs(): Multiaddr[]
 
   /**
    * Returns a list of supported protocols
@@ -430,7 +430,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * // [ '/ipfs/ping/1.0.0', '/ipfs/id/1.0.0' ]
    * ```
    */
-  getProtocols: () => string[]
+  getProtocols(): string[]
 
   /**
    * Return a list of all connections this node has open, optionally filtering
@@ -445,7 +445,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * }
    * ```
    */
-  getConnections: (peerId?: PeerId) => Connection[]
+  getConnections(peerId?: PeerId): Connection[]
 
   /**
    * Return the list of dials currently in progress or queued to start
@@ -458,12 +458,12 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * }
    * ```
    */
-  getDialQueue: () => PendingDial[]
+  getDialQueue(): PendingDial[]
 
   /**
    * Return a list of all peers we currently have a connection open to
    */
-  getPeers: () => PeerId[]
+  getPeers(): PeerId[]
 
   /**
    * Dials to the provided peer. If successful, the known metadata of the
@@ -485,7 +485,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * await conn.close()
    * ```
    */
-  dial: (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions) => Promise<Connection>
+  dial(peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<Connection>
 
   /**
    * Dials to the provided peer and tries to handshake with the given protocols in order.
@@ -503,7 +503,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * pipe([1, 2, 3], stream, consume)
    * ```
    */
-  dialProtocol: (peer: PeerId | Multiaddr | Multiaddr[], protocols: string | string[], options?: NewStreamOptions) => Promise<Stream>
+  dialProtocol(peer: PeerId | Multiaddr | Multiaddr[], protocols: string | string[], options?: NewStreamOptions): Promise<Stream>
 
   /**
    * Attempts to gracefully close an open connection to the given peer. If the
@@ -518,7 +518,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * await libp2p.hangUp(remotePeerId)
    * ```
    */
-  hangUp: (peer: PeerId | Multiaddr, options?: AbortOptions) => Promise<void>
+  hangUp(peer: PeerId | Multiaddr, options?: AbortOptions): Promise<void>
 
   /**
    * Sets up [multistream-select routing](https://github.com/multiformats/multistream-select) of protocols to their application handlers. Whenever a stream is opened on one of the provided protocols, the handler will be called. `handle` must be called in order to register a handler and support for a given protocol. This also informs other peers of the protocols you support.
@@ -540,7 +540,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * })
    * ```
    */
-  handle: (protocol: string | string[], handler: StreamHandler, options?: StreamHandlerOptions) => Promise<void>
+  handle(protocol: string | string[], handler: StreamHandler, options?: StreamHandlerOptions): Promise<void>
 
   /**
    * Removes the handler for each protocol. The protocol
@@ -552,7 +552,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * libp2p.unhandle(['/echo/1.0.0'])
    * ```
    */
-  unhandle: (protocols: string[] | string) => Promise<void>
+  unhandle(protocols: string[] | string): Promise<void>
 
   /**
    * Register a topology to be informed when peers are encountered that
@@ -571,7 +571,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * })
    * ```
    */
-  register: (protocol: string, topology: Topology) => Promise<string>
+  register(protocol: string, topology: Topology): Promise<string>
 
   /**
    * Unregister topology to no longer be informed when peers connect or
@@ -585,14 +585,14 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ev
    * libp2p.unregister(id)
    * ```
    */
-  unregister: (id: string) => void
+  unregister(id: string): void
 
   /**
    * Returns the public key for the passed PeerId. If the PeerId is of the 'RSA' type
    * this may mean searching the DHT if the key is not present in the KeyStore.
    * A set of user defined services
    */
-  getPublicKey: (peer: PeerId, options?: AbortOptions) => Promise<Uint8Array>
+  getPublicKey(peer: PeerId, options?: AbortOptions): Promise<Uint8Array>
 
   /**
    * A set of user defined services

package/src/keychain/index.ts

@@ -47,7 +47,7 @@ export interface KeyChain {
    * const pemKey = await libp2p.keychain.exportKey('keyTest', 'password123')
    * ```
    */
-  exportKey: (name: string, password: string) => Promise<Multibase<'m'>>
+  exportKey(name: string, password: string): Promise<Multibase<'m'>>
 
   /**
    * Import a new key from a PEM encoded PKCS #8 string.
@@ -60,7 +60,7 @@ export interface KeyChain {
    * const keyInfo = await libp2p.keychain.importKey('keyTestImport', pemKey, 'password123')
    * ```
    */
-  importKey: (name: string, pem: string, password: string) => Promise<KeyInfo>
+  importKey(name: string, pem: string, password: string): Promise<KeyInfo>
 
   /**
    * Import a new key from a PeerId with a private key component
@@ -71,7 +71,7 @@ export interface KeyChain {
    * const keyInfo = await libp2p.keychain.importPeer('keyTestImport', peerIdFromString('12D3Foo...'))
    * ```
    */
-  importPeer: (name: string, peerId: PeerId) => Promise<KeyInfo>
+  importPeer(name: string, peerId: PeerId): Promise<KeyInfo>
 
   /**
    * Export an existing key as a PeerId
@@ -82,7 +82,7 @@ export interface KeyChain {
    * const peerId = await libp2p.keychain.exportPeerId('key-name')
    * ```
    */
-  exportPeerId: (name: string) => Promise<PeerId>
+  exportPeerId(name: string): Promise<PeerId>
 
   /**
    * Create a key in the keychain.
@@ -93,7 +93,7 @@ export interface KeyChain {
    * const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
    * ```
    */
-  createKey: (name: string, type: KeyType, size?: number) => Promise<KeyInfo>
+  createKey(name: string, type: KeyType, size?: number): Promise<KeyInfo>
 
   /**
    * List all the keys.
@@ -104,7 +104,7 @@ export interface KeyChain {
    * const keyInfos = await libp2p.keychain.listKeys()
    * ```
    */
-  listKeys: () => Promise<KeyInfo[]>
+  listKeys(): Promise<KeyInfo[]>
 
   /**
    * Removes a key from the keychain.
@@ -116,7 +116,7 @@ export interface KeyChain {
    * const keyInfo = await libp2p.keychain.removeKey('keyTest')
    * ```
    */
-  removeKey: (name: string) => Promise<KeyInfo>
+  removeKey(name: string): Promise<KeyInfo>
 
   /**
    * Rename a key in the keychain.
@@ -128,7 +128,7 @@ export interface KeyChain {
    * const keyInfo = await libp2p.keychain.renameKey('keyTest', 'keyNewNtest')
    * ```
    */
-  renameKey: (oldName: string, newName: string) => Promise<KeyInfo>
+  renameKey(oldName: string, newName: string): Promise<KeyInfo>
 
   /**
    * Find a key by it's id.
@@ -140,7 +140,7 @@ export interface KeyChain {
    * const keyInfo2 = await libp2p.keychain.findKeyById(keyInfo.id)
    * ```
    */
-  findKeyById: (id: string) => Promise<KeyInfo>
+  findKeyById(id: string): Promise<KeyInfo>
 
   /**
    * Find a key by it's name.
@@ -152,7 +152,7 @@ export interface KeyChain {
    * const keyInfo2 = await libp2p.keychain.findKeyByName('keyTest')
    * ```
    */
-  findKeyByName: (name: string) => Promise<KeyInfo>
+  findKeyByName(name: string): Promise<KeyInfo>
 
   /**
    * Rotate keychain password and re-encrypt all associated keys
@@ -163,5 +163,5 @@ export interface KeyChain {
    * await libp2p.keychain.rotateKeychainPass('oldPassword', 'newPassword')
    * ```
    */
-  rotateKeychainPass: (oldPass: string, newPass: string) => Promise<void>
+  rotateKeychainPass(oldPass: string, newPass: string): Promise<void>
 }

package/src/keys/index.ts

@@ -1,9 +1,9 @@
 export interface PublicKey {
   readonly bytes: Uint8Array
-  verify: (data: Uint8Array, sig: Uint8Array) => Promise<boolean>
-  marshal: () => Uint8Array
-  equals: (key: PublicKey) => boolean
-  hash: () => Promise<Uint8Array>
+  verify(data: Uint8Array, sig: Uint8Array): Promise<boolean>
+  marshal(): Uint8Array
+  equals(key: PublicKey): boolean
+  hash(): Promise<Uint8Array>
 }
 
 /**
@@ -12,10 +12,10 @@ export interface PublicKey {
 export interface PrivateKey {
   readonly public: PublicKey
   readonly bytes: Uint8Array
-  sign: (data: Uint8Array) => Promise<Uint8Array>
-  marshal: () => Uint8Array
-  equals: (key: PrivateKey) => boolean
-  hash: () => Promise<Uint8Array>
+  sign(data: Uint8Array): Promise<Uint8Array>
+  marshal(): Uint8Array
+  equals(key: PrivateKey): boolean
+  hash(): Promise<Uint8Array>
   /**
    * Gets the ID of the key.
    *
@@ -23,11 +23,11 @@ export interface PrivateKey {
    * The public key is a protobuf encoding containing a type and the DER encoding
    * of the PKCS SubjectPublicKeyInfo.
    */
-  id: () => Promise<string>
+  id(): Promise<string>
   /**
    * Exports the password protected key in the format specified.
    */
-  export: (password: string, format?: 'pkcs-8' | string) => Promise<string>
+  export(password: string, format?: 'pkcs-8' | string): Promise<string>
 }
 
 export const Ed25519 = 'Ed25519'

package/src/metrics/index.ts

@@ -48,28 +48,28 @@ export interface Metric {
   /**
    * Update the stored metric to the passed value
    */
-  update: (value: number) => void
+  update(value: number): void
 
   /**
    * Increment the metric by the passed value or 1
    */
-  increment: (value?: number) => void
+  increment(value?: number): void
 
   /**
    * Decrement the metric by the passed value or 1
    */
-  decrement: (value?: number) => void
+  decrement(value?: number): void
 
   /**
    * Reset this metric to its default value
    */
-  reset: () => void
+  reset(): void
 
   /**
    * Start a timed metric, call the returned function to
    * stop the timer
    */
-  timer: () => StopTimer
+  timer(): StopTimer
 }
 
 /**
@@ -80,31 +80,31 @@ export interface MetricGroup {
   /**
    * Update the stored metric group to the passed value
    */
-  update: (values: Record<string, number>) => void
+  update(values: Record<string, number>): void
 
   /**
    * Increment the metric group keys by the passed number or
    * any non-numeric value to increment by 1
    */
-  increment: (values: Record<string, number | unknown>) => void
+  increment(values: Record<string, number | unknown>): void
 
   /**
    * Decrement the metric group keys by the passed number or
    * any non-numeric value to decrement by 1
    */
-  decrement: (values: Record<string, number | unknown>) => void
+  decrement(values: Record<string, number | unknown>): void
 
   /**
    * Reset the passed key in this metric group to its default value
    * or all keys if no key is passed
    */
-  reset: () => void
+  reset(): void
 
   /**
    * Start a timed metric for the named key in the group, call
    * the returned function to stop the timer
    */
-  timer: (key: string) => StopTimer
+  timer(key: string): StopTimer
 }
 
 /**
@@ -115,12 +115,12 @@ export interface Counter {
   /**
    * Increment the metric by the passed value or 1
    */
-  increment: (value?: number) => void
+  increment(value?: number): void
 
   /**
    * Reset this metric to its default value
    */
-  reset: () => void
+  reset(): void
 }
 
 /**
@@ -133,13 +133,13 @@ export interface CounterGroup {
    * Increment the metric group keys by the passed number or
    * any non-numeric value to increment by 1
    */
-  increment: (values: Record<string, number | unknown>) => void
+  increment(values: Record<string, number | unknown>): void
 
   /**
    * Reset the passed key in this metric group to its default value
    * or all keys if no key is passed
    */
-  reset: () => void
+  reset(): void
 }
 
 /**
@@ -151,12 +151,12 @@ export interface Metrics {
   /**
    * Track a newly opened multiaddr connection
    */
-  trackMultiaddrConnection: (maConn: MultiaddrConnection) => void
+  trackMultiaddrConnection(maConn: MultiaddrConnection): void
 
   /**
    * Track a newly opened protocol stream
    */
-  trackProtocolStream: (stream: Stream, connection: Connection) => void
+  trackProtocolStream(stream: Stream, connection: Connection): void
 
   /**
    * Register an arbitrary metric. Call this to set help/labels for metrics

package/src/peer-id/index.ts

@@ -9,10 +9,10 @@ interface BasePeerId {
   readonly privateKey?: Uint8Array
   readonly publicKey?: Uint8Array
 
-  toString: () => string
-  toCID: () => CID
-  toBytes: () => Uint8Array
-  equals: (other: PeerId | Uint8Array | string) => boolean
+  toString(): string
+  toCID(): CID
+  toBytes(): Uint8Array
+  equals(other: PeerId | Uint8Array | string): boolean
 }
 
 export interface RSAPeerId extends BasePeerId {

package/src/peer-routing/index.ts

@@ -34,7 +34,7 @@ export interface PeerRouting {
    * const peer = await peerRouting.findPeer(peerId, options)
    * ```
    */
-  findPeer: (peerId: PeerId, options?: AbortOptions) => Promise<PeerInfo>
+  findPeer(peerId: PeerId, options?: AbortOptions): Promise<PeerInfo>
 
   /**
    * Search the network for peers that are closer to the passed key. Peer
@@ -49,5 +49,5 @@ export interface PeerRouting {
    * }
    * ```
    */
-  getClosestPeers: (key: Uint8Array, options?: AbortOptions) => AsyncIterable<PeerInfo>
+  getClosestPeers(key: Uint8Array, options?: AbortOptions): AsyncIterable<PeerInfo>
 }

package/src/peer-store/index.ts

@@ -156,7 +156,7 @@ export interface PeerStore {
    * })
    * ```
    */
-  forEach: (fn: (peer: Peer) => void, query?: PeerQuery) => Promise<void>
+  forEach(fn: (peer: Peer) => void, query?: PeerQuery): Promise<void>
 
   /**
    * Returns all peers in the peer store.
@@ -169,7 +169,7 @@ export interface PeerStore {
    * }
    * ```
    */
-  all: (query?: PeerQuery) => Promise<Peer[]>
+  all(query?: PeerQuery): Promise<Peer[]>
 
   /**
    * Delete all data stored for the passed peer
@@ -187,7 +187,7 @@ export interface PeerStore {
    * // []
    * ```
    */
-  delete: (peerId: PeerId) => Promise<void>
+  delete(peerId: PeerId): Promise<void>
 
   /**
    * Returns true if the passed PeerId is in the peer store
@@ -202,7 +202,7 @@ export interface PeerStore {
    * // true
    * ```
    */
-  has: (peerId: PeerId) => Promise<boolean>
+  has(peerId: PeerId): Promise<boolean>
 
   /**
    * Returns all data stored for the passed PeerId
@@ -214,7 +214,7 @@ export interface PeerStore {
    * // { .. }
    * ```
    */
-  get: (peerId: PeerId) => Promise<Peer>
+  get(peerId: PeerId): Promise<Peer>
 
   /**
    * Adds a peer to the peer store, overwriting any existing data
@@ -227,7 +227,7 @@ export interface PeerStore {
    * })
    * ```
    */
-  save: (id: PeerId, data: PeerData) => Promise<Peer>
+  save(id: PeerId, data: PeerData): Promise<Peer>
 
   /**
    * Adds a peer to the peer store, overwriting only the passed fields
@@ -240,7 +240,7 @@ export interface PeerStore {
    * })
    * ```
    */
-  patch: (id: PeerId, data: PeerData) => Promise<Peer>
+  patch(id: PeerId, data: PeerData): Promise<Peer>
 
   /**
    * Adds a peer to the peer store, deeply merging any existing data.
@@ -253,7 +253,7 @@ export interface PeerStore {
    * })
    * ```
    */
-  merge: (id: PeerId, data: PeerData) => Promise<Peer>
+  merge(id: PeerId, data: PeerData): Promise<Peer>
 
   /**
    * Unmarshal and verify a signed peer record, extract the multiaddrs and
@@ -268,5 +268,5 @@ export interface PeerStore {
    * await peerStore.consumePeerRecord(buf, expectedPeer)
    * ```
    */
-  consumePeerRecord: (buf: Uint8Array, expectedPeer?: PeerId) => Promise<boolean>
+  consumePeerRecord(buf: Uint8Array, expectedPeer?: PeerId): Promise<boolean>
 }

package/src/pubsub/index.ts

@@ -72,10 +72,10 @@ export interface PeerStreams extends EventEmitter<PeerStreamEvents> {
   inboundStream?: AsyncIterable<Uint8ArrayList>
   isWritable: boolean
 
-  close: () => void
-  write: (buf: Uint8Array | Uint8ArrayList) => void
-  attachInboundStream: (stream: Stream) => AsyncIterable<Uint8ArrayList>
-  attachOutboundStream: (stream: Stream) => Promise<Pushable<Uint8ArrayList>>
+  close(): void
+  write(buf: Uint8Array | Uint8ArrayList): void
+  attachInboundStream(stream: Stream): AsyncIterable<Uint8ArrayList>
+  attachOutboundStream(stream: Stream): Promise<Pushable<Uint8ArrayList>>
 }
 
 export interface PubSubInit {
@@ -189,7 +189,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    */
   topicValidators: Map<string, TopicValidatorFn>
 
-  getPeers: () => PeerId[]
+  getPeers(): PeerId[]
 
   /**
    * Gets a list of topics the node is subscribed to.
@@ -198,7 +198,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    * const topics = libp2p.pubsub.getTopics()
    * ```
    */
-  getTopics: () => string[]
+  getTopics(): string[]
 
   /**
    * Subscribes to a pubsub topic.
@@ -217,7 +217,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    * libp2p.pubsub.subscribe(topic)
    * ```
    */
-  subscribe: (topic: string) => void
+  subscribe(topic: string): void
 
   /**
    * Unsubscribes from a pubsub topic.
@@ -234,7 +234,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    * libp2p.pubsub.unsubscribe(topic)
    * ```
    */
-  unsubscribe: (topic: string) => void
+  unsubscribe(topic: string): void
 
   /**
    * Gets a list of the PeerIds that are subscribed to one topic.
@@ -245,7 +245,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    * const peerIds = libp2p.pubsub.getSubscribers(topic)
    * ```
    */
-  getSubscribers: (topic: string) => PeerId[]
+  getSubscribers(topic: string): PeerId[]
 
   /**
    * Publishes messages to the given topic.
@@ -259,7 +259,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    * await libp2p.pubsub.publish(topic, data)
    * ```
    */
-  publish: (topic: string, data: Uint8Array) => Promise<PublishResult>
+  publish(topic: string, data: Uint8Array): Promise<PublishResult>
 }
 
 export interface PeerStreamEvents {

package/src/record/index.ts

@@ -16,11 +16,11 @@ export interface Record {
   /**
    * Marshal a record to be used in an envelope.
    */
-  marshal: () => Uint8Array
+  marshal(): Uint8Array
   /**
    * Verifies if the other provided Record is identical to this one.
    */
-  equals: (other: Record) => boolean
+  equals(other: Record): boolean
 }
 
 export interface Envelope {
@@ -29,7 +29,7 @@ export interface Envelope {
   payload: Uint8Array
   signature: Uint8Array | Uint8ArrayList
 
-  marshal: () => Uint8Array
-  validate: (domain: string) => Promise<boolean>
-  equals: (other: Envelope) => boolean
+  marshal(): Uint8Array
+  validate(domain: string): Promise<boolean>
+  equals(other: Envelope): boolean
 }

package/src/startable.ts

@@ -2,49 +2,49 @@
  * Implemented by components that have a lifecycle
  */
 export interface Startable {
-  isStarted: () => boolean
+  isStarted(): boolean
 
   /**
    * If implemented, this method will be invoked before the start method.
    *
    * It should not assume any other components have been started.
    */
-  beforeStart?: () => void | Promise<void>
+  beforeStart?(): void | Promise<void>
 
   /**
    * This method will be invoked to start the component.
    *
    * It should not assume that any other components have been started.
    */
-  start: () => void | Promise<void>
+  start(): void | Promise<void>
 
   /**
    * If implemented, this method will be invoked after the start method.
    *
    * All other components will have had their start method invoked before this method is called.
    */
-  afterStart?: () => void | Promise<void>
+  afterStart?(): void | Promise<void>
 
   /**
    * If implemented, this method will be invoked before the stop method.
    *
    * Any other components will still be running when this method is called.
    */
-  beforeStop?: () => void | Promise<void>
+  beforeStop?(): void | Promise<void>
 
   /**
    * This method will be invoked to stop the component.
    *
    * It should not assume any other components are running when it is called.
    */
-  stop: () => void | Promise<void>
+  stop(): void | Promise<void>
 
   /**
    * If implemented, this method will be invoked after the stop method.
    *
    * All other components will have had their stop method invoked before this method is called.
    */
-  afterStop?: () => void | Promise<void>
+  afterStop?(): void | Promise<void>
 }
 
 export function isStartable (obj: any): obj is Startable {

package/src/stream-muxer/index.ts

@@ -12,7 +12,7 @@ export interface StreamMuxerFactory {
   /**
    * Creates a new stream muxer to be used with a new connection
    */
-  createStreamMuxer: (init?: StreamMuxerInit) => StreamMuxer
+  createStreamMuxer(init?: StreamMuxerInit): StreamMuxer
 }
 
 /**
@@ -32,29 +32,29 @@ export interface StreamMuxer extends Duplex<AsyncGenerator<Uint8Array>, Source<U
    * Initiate a new stream with the given name. If no name is
    * provided, the id of the stream will be used.
    */
-  newStream: (name?: string) => Stream | Promise<Stream>
+  newStream(name?: string): Stream | Promise<Stream>
 
   /**
    * Close or abort all tracked streams and stop the muxer
    */
-  close: (options?: AbortOptions) => Promise<void>
+  close(options?: AbortOptions): Promise<void>
 
   /**
    * Close or abort all tracked streams and stop the muxer
    */
-  abort: (err: Error) => void
+  abort(err: Error): void
 }
 
 export interface StreamMuxerInit {
   /**
    * A callback function invoked every time an incoming stream is opened
    */
-  onIncomingStream?: (stream: Stream) => void
+  onIncomingStream?(stream: Stream): void
 
   /**
    * A callback function invoke every time a stream ends
    */
-  onStreamEnd?: (stream: Stream) => void
+  onStreamEnd?(stream: Stream): void
 
   /**
    * Outbound stream muxers are opened by the local node, inbound stream muxers are opened by the remote