Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 46618c7

Browse files
authored
fix: loosen input type for swarm.connect and swarm.disconnect (#3673)
Accept peer ids as strings or multiaddrs as Multiaddrs. Fixes #3638
1 parent 5eb32a7 commit 46618c7

File tree

6 files changed

+11
-12
lines changed

6 files changed

+11
-12
lines changed

packages/ipfs-core-types/src/bitswap/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface API<OptionExtension = {}> {
2424
* // [ CID('QmHash') ]
2525
* ```
2626
*/
27-
wantlistForPeer: (peerId: CID | string, options?: AbortOptions & OptionExtension) => Promise<CID[]>
27+
wantlistForPeer: (peerId: string, options?: AbortOptions & OptionExtension) => Promise<CID[]>
2828

2929
/**
3030
* Removes one or more CIDs from the wantlist

packages/ipfs-core-types/src/dht/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface API<OptionExtension = {}> {
2121
* // '/ip4/147.75.94.115/tcp/4001'
2222
* ```
2323
*/
24-
findPeer: (peerId: CID | string, options?: AbortOptions & OptionExtension) => Promise<PeerResult>
24+
findPeer: (peerId: string, options?: AbortOptions & OptionExtension) => Promise<PeerResult>
2525

2626
/**
2727
* Find peers in the DHT that can provide a specific value, given a CID.
@@ -59,7 +59,7 @@ export interface API<OptionExtension = {}> {
5959
/**
6060
* Find the closest peers to a given `PeerId`, by querying the DHT.
6161
*/
62-
query: (peerId: CID | string, options?: AbortOptions & OptionExtension) => AsyncIterable<PeerResult>
62+
query: (peerId: string, options?: AbortOptions & OptionExtension) => AsyncIterable<PeerResult>
6363
}
6464

6565
export interface PeerResult {

packages/ipfs-core-types/src/root.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export interface API<OptionExtension = {}> {
8282
* }
8383
* ```
8484
*/
85-
ping: (peerId: CID | string, options?: PingOptions & OptionExtension) => AsyncIterable<PingResult>
85+
ping: (peerId: string, options?: PingOptions & OptionExtension) => AsyncIterable<PingResult>
8686

8787
/**
8888
* Resolve the value of names to IPFS

packages/ipfs-core-types/src/stats/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export interface API<OptionExtension = {}> {
1414
}
1515

1616
export interface BWOptions extends AbortOptions {
17-
peer?: CID | string
17+
peer?: string
1818
proto?: string
1919
poll?: boolean
2020
interval?: number

packages/ipfs-core-types/src/swarm/index.d.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ import type CID from 'cids'
55
import type { Multiaddr } from 'multiaddr'
66

77
export interface API<OptionExtension = {}> {
8-
/**
8+
/**
99
* List of known addresses of each peer connected
1010
*/
1111
addrs: (options?: AbortOptions & OptionExtension) => Promise<AddrsResult[]>
1212

1313
/**
14-
* Open a connection to a given address
14+
* Open a connection to a given address or peer id
1515
*/
16-
connect: (addr: Multiaddr, options?: AbortOptions & OptionExtension) => Promise<void>
16+
connect: (addr: Multiaddr | string, options?: AbortOptions & OptionExtension) => Promise<void>
1717

1818
/**
19-
* Close a connection to a given address
19+
* Close a connection to a given address or peer id
2020
*/
21-
disconnect: (addr: Multiaddr, options?: AbortOptions & OptionExtension) => Promise<void>
21+
disconnect: (addr: Multiaddr | string, options?: AbortOptions & OptionExtension) => Promise<void>
2222

2323
/**
2424
* Local addresses this node is listening on

packages/ipfs-http-client/src/dht/find-peer.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
'use strict'
22

3-
const CID = require('cids')
43
const { Multiaddr } = require('multiaddr')
54
const configure = require('../lib/configure')
65
const toUrlSearchParams = require('../lib/to-url-search-params')
@@ -20,7 +19,7 @@ module.exports = configure(api => {
2019
timeout: options.timeout,
2120
signal: options.signal,
2221
searchParams: toUrlSearchParams({
23-
arg: `${peerId instanceof Uint8Array ? new CID(peerId) : peerId}`,
22+
arg: peerId,
2423
...options
2524
}),
2625
headers: options.headers

0 commit comments

Comments
 (0)