Skip to content
This repository was archived by the owner on Jul 21, 2023. It is now read-only.

Commit df47658

Browse files
deps(dev): bump aegir from 37.12.1 to 38.1.6 (#66)
* deps(dev): bump aegir from 37.12.1 to 38.1.6 Bumps [aegir](https://github.com/ipfs/aegir) from 37.12.1 to 38.1.6. - [Release notes](https://github.com/ipfs/aegir/releases) - [Changelog](https://github.com/ipfs/aegir/blob/master/CHANGELOG.md) - [Commits](ipfs/aegir@v37.12.1...v38.1.6) --- updated-dependencies: - dependency-name: aegir dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * chore: fix linting and deps --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alex Potsides <[email protected]>
1 parent aa8fc54 commit df47658

8 files changed

+47
-48
lines changed

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
"scripts": {
131131
"clean": "aegir clean",
132132
"lint": "aegir lint",
133-
"dep-check": "aegir dep-check",
133+
"dep-check": "aegir dep-check -i protons",
134134
"generate": "protons src/pb/peer.proto src/pb/tags.proto",
135135
"build": "aegir build",
136136
"test": "aegir test",
@@ -166,10 +166,9 @@
166166
"uint8arrays": "^4.0.2"
167167
},
168168
"devDependencies": {
169-
"@libp2p/interface-compliance-tests": "^3.0.2",
170169
"@libp2p/peer-id-factory": "^2.0.0",
171170
"@libp2p/utils": "^3.0.2",
172-
"aegir": "^37.9.1",
171+
"aegir": "^38.1.6",
173172
"datastore-core": "^8.0.1",
174173
"delay": "^5.0.0",
175174
"p-defer": "^4.0.0",

src/address-book.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import map from 'it-map'
1010
import each from 'it-foreach'
1111
import { peerIdFromPeerId } from '@libp2p/peer-id'
1212
import { CustomEvent } from '@libp2p/interfaces/events'
13-
import type { AddressFilter, Peer, PeerMultiaddrsChangeData, PeerStore } from '@libp2p/interface-peer-store'
13+
import type { Address, AddressFilter, Peer, PeerMultiaddrsChangeData, PeerStore } from '@libp2p/interface-peer-store'
1414
import type { Store } from './store.js'
1515
import type { Envelope } from '@libp2p/interface-record'
1616
import type { PeerId } from '@libp2p/interface-peer-id'
@@ -20,7 +20,7 @@ import type { Multiaddr } from '@multiformats/multiaddr'
2020
const log = logger('libp2p:peer-store:address-book')
2121
const EVENT_NAME = 'change:multiaddrs'
2222

23-
async function allowAll () {
23+
async function allowAll (): Promise<boolean> {
2424
return true
2525
}
2626

@@ -40,7 +40,7 @@ export class PeerStoreAddressBook {
4040
* This will return a boolean that indicates if the record was successfully processed and added
4141
* into the AddressBook.
4242
*/
43-
async consumePeerRecord (envelope: Envelope) {
43+
async consumePeerRecord (envelope: Envelope): Promise<boolean> {
4444
log.trace('consumePeerRecord await write lock')
4545
const release = await this.store.lock.writeLock()
4646
log.trace('consumePeerRecord got write lock')
@@ -113,7 +113,7 @@ export class PeerStoreAddressBook {
113113
return true
114114
}
115115

116-
async getRawEnvelope (peerId: PeerId) {
116+
async getRawEnvelope (peerId: PeerId): Promise<Uint8Array | undefined> {
117117
log.trace('getRawEnvelope await read lock')
118118
const release = await this.store.lock.readLock()
119119
log.trace('getRawEnvelope got read lock')
@@ -136,7 +136,7 @@ export class PeerStoreAddressBook {
136136
* Get an Envelope containing a PeerRecord for the given peer.
137137
* Returns undefined if no record exists.
138138
*/
139-
async getPeerRecord (peerId: PeerId) {
139+
async getPeerRecord (peerId: PeerId): Promise<RecordEnvelope | undefined> {
140140
const raw = await this.getRawEnvelope(peerId)
141141

142142
if (raw == null) {
@@ -146,7 +146,7 @@ export class PeerStoreAddressBook {
146146
return await RecordEnvelope.createFromProtobuf(raw)
147147
}
148148

149-
async get (peerId: PeerId) {
149+
async get (peerId: PeerId): Promise<Address[]> {
150150
peerId = peerIdFromPeerId(peerId)
151151

152152
log.trace('get wait for read lock')
@@ -169,7 +169,7 @@ export class PeerStoreAddressBook {
169169
return []
170170
}
171171

172-
async set (peerId: PeerId, multiaddrs: Multiaddr[]) {
172+
async set (peerId: PeerId, multiaddrs: Multiaddr[]): Promise<void> {
173173
peerId = peerIdFromPeerId(peerId)
174174

175175
if (!Array.isArray(multiaddrs)) {
@@ -239,7 +239,7 @@ export class PeerStoreAddressBook {
239239
}
240240
}
241241

242-
async add (peerId: PeerId, multiaddrs: Multiaddr[]) {
242+
async add (peerId: PeerId, multiaddrs: Multiaddr[]): Promise<void> {
243243
peerId = peerIdFromPeerId(peerId)
244244

245245
if (!Array.isArray(multiaddrs)) {
@@ -307,7 +307,7 @@ export class PeerStoreAddressBook {
307307
}
308308
}
309309

310-
async delete (peerId: PeerId) {
310+
async delete (peerId: PeerId): Promise<void> {
311311
peerId = peerIdFromPeerId(peerId)
312312

313313
log.trace('delete await write lock')
@@ -345,7 +345,7 @@ export class PeerStoreAddressBook {
345345
}
346346
}
347347

348-
async function filterMultiaddrs (peerId: PeerId, multiaddrs: Multiaddr[], addressFilter: AddressFilter, isCertified: boolean = false) {
348+
async function filterMultiaddrs (peerId: PeerId, multiaddrs: Multiaddr[], addressFilter: AddressFilter, isCertified: boolean = false): Promise<Address[]> {
349349
return await pipe(
350350
multiaddrs,
351351
(source) => each(source, (multiaddr) => {

src/index.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
4141
this.protoBook = new PeerStoreProtoBook(this.dispatchEvent.bind(this), this.store)
4242
}
4343

44-
async forEach (fn: (peer: Peer) => void) {
44+
async forEach (fn: (peer: Peer) => void): Promise<void> {
4545
log.trace('getPeers await read lock')
4646
const release = await this.store.lock.readLock()
4747
log.trace('getPeers got read lock')
@@ -74,7 +74,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
7474
/**
7575
* Delete the information of the given peer in every book
7676
*/
77-
async delete (peerId: PeerId) {
77+
async delete (peerId: PeerId): Promise<void> {
7878
log.trace('delete await write lock')
7979
const release = await this.store.lock.writeLock()
8080
log.trace('delete got write lock')
@@ -90,7 +90,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
9090
/**
9191
* Get the stored information of a given peer
9292
*/
93-
async get (peerId: PeerId) {
93+
async get (peerId: PeerId): Promise<Peer> {
9494
log.trace('get await read lock')
9595
const release = await this.store.lock.readLock()
9696
log.trace('get got read lock')
@@ -106,7 +106,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
106106
/**
107107
* Returns true if we have a record of the peer
108108
*/
109-
async has (peerId: PeerId) {
109+
async has (peerId: PeerId): Promise<boolean> {
110110
log.trace('has await read lock')
111111
const release = await this.store.lock.readLock()
112112
log.trace('has got read lock')
@@ -119,7 +119,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
119119
}
120120
}
121121

122-
async tagPeer (peerId: PeerId, tag: string, options: TagOptions = {}) {
122+
async tagPeer (peerId: PeerId, tag: string, options: TagOptions = {}): Promise<void> {
123123
const providedValue = options.value ?? 0
124124
const value = Math.round(providedValue)
125125
const ttl = options.ttl ?? undefined
@@ -147,7 +147,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
147147
await this.metadataBook.setValue(peerId, 'tags', Tags.encode({ tags }).subarray())
148148
}
149149

150-
async unTagPeer (peerId: PeerId, tag: string) {
150+
async unTagPeer (peerId: PeerId, tag: string): Promise<void> {
151151
const buf = await this.metadataBook.getValue(peerId, 'tags')
152152
let tags: Tag[] = []
153153

@@ -160,7 +160,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
160160
await this.metadataBook.setValue(peerId, 'tags', Tags.encode({ tags }).subarray())
161161
}
162162

163-
async getTags (peerId: PeerId) {
163+
async getTags (peerId: PeerId): Promise<Array<{ name: string, value: number }>> {
164164
const buf = await this.metadataBook.getValue(peerId, 'tags')
165165
let tags: Tag[] = []
166166

src/key-book.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export class PeerStoreKeyBook implements KeyBook {
2727
/**
2828
* Set the Peer public key
2929
*/
30-
async set (peerId: PeerId, publicKey: Uint8Array) {
30+
async set (peerId: PeerId, publicKey: Uint8Array): Promise<void> {
3131
peerId = peerIdFromPeerId(peerId)
3232

3333
if (!(publicKey instanceof Uint8Array)) {
@@ -68,7 +68,7 @@ export class PeerStoreKeyBook implements KeyBook {
6868
this.dispatchEvent(new CustomEvent<PeerPublicKeyChangeData>(EVENT_NAME, {
6969
detail: {
7070
peerId,
71-
publicKey: publicKey,
71+
publicKey,
7272
oldPublicKey: peer == null ? undefined : peer.pubKey
7373
}
7474
}))
@@ -78,7 +78,7 @@ export class PeerStoreKeyBook implements KeyBook {
7878
/**
7979
* Get Public key of the given PeerId, if stored
8080
*/
81-
async get (peerId: PeerId) {
81+
async get (peerId: PeerId): Promise<Uint8Array | undefined> {
8282
peerId = peerIdFromPeerId(peerId)
8383

8484
log.trace('get await write lock')
@@ -99,7 +99,7 @@ export class PeerStoreKeyBook implements KeyBook {
9999
}
100100
}
101101

102-
async delete (peerId: PeerId) {
102+
async delete (peerId: PeerId): Promise<void> {
103103
peerId = peerIdFromPeerId(peerId)
104104

105105
log.trace('delete await write lock')

src/metadata-book.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
2828
/**
2929
* Get the known data of a provided peer
3030
*/
31-
async get (peerId: PeerId) {
31+
async get (peerId: PeerId): Promise<Map<string, Uint8Array>> {
3232
peerId = peerIdFromPeerId(peerId)
3333

3434
log.trace('get await read lock')
@@ -54,7 +54,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
5454
/**
5555
* Get specific metadata value, if it exists
5656
*/
57-
async getValue (peerId: PeerId, key: string) {
57+
async getValue (peerId: PeerId, key: string): Promise<Uint8Array | undefined> {
5858
peerId = peerIdFromPeerId(peerId)
5959

6060
log.trace('getValue await read lock')
@@ -75,7 +75,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
7575
}
7676
}
7777

78-
async set (peerId: PeerId, metadata: Map<string, Uint8Array>) {
78+
async set (peerId: PeerId, metadata: Map<string, Uint8Array>): Promise<void> {
7979
peerId = peerIdFromPeerId(peerId)
8080

8181
if (!(metadata instanceof Map)) {
@@ -118,7 +118,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
118118
/**
119119
* Set metadata key and value of a provided peer
120120
*/
121-
async setValue (peerId: PeerId, key: string, value: Uint8Array) {
121+
async setValue (peerId: PeerId, key: string, value: Uint8Array): Promise<void> {
122122
peerId = peerIdFromPeerId(peerId)
123123

124124
if (typeof key !== 'string' || !(value instanceof Uint8Array)) {
@@ -164,7 +164,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
164164
}))
165165
}
166166

167-
async delete (peerId: PeerId) {
167+
async delete (peerId: PeerId): Promise<void> {
168168
peerId = peerIdFromPeerId(peerId)
169169

170170
log.trace('delete await write lock')
@@ -203,7 +203,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
203203
}
204204
}
205205

206-
async deleteValue (peerId: PeerId, key: string) {
206+
async deleteValue (peerId: PeerId, key: string): Promise<void> {
207207
peerId = peerIdFromPeerId(peerId)
208208

209209
log.trace('deleteValue await write lock')

src/proto-book.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export class PeerStoreProtoBook implements ProtoBook {
2424
this.store = store
2525
}
2626

27-
async get (peerId: PeerId) {
27+
async get (peerId: PeerId): Promise<string[]> {
2828
log.trace('get wait for read lock')
2929
const release = await this.store.lock.readLock()
3030
log.trace('get got read lock')
@@ -45,7 +45,7 @@ export class PeerStoreProtoBook implements ProtoBook {
4545
return []
4646
}
4747

48-
async set (peerId: PeerId, protocols: string[]) {
48+
async set (peerId: PeerId, protocols: string[]): Promise<void> {
4949
peerId = peerIdFromPeerId(peerId)
5050

5151
if (!Array.isArray(protocols)) {
@@ -94,7 +94,7 @@ export class PeerStoreProtoBook implements ProtoBook {
9494
}))
9595
}
9696

97-
async add (peerId: PeerId, protocols: string[]) {
97+
async add (peerId: PeerId, protocols: string[]): Promise<void> {
9898
peerId = peerIdFromPeerId(peerId)
9999

100100
if (!Array.isArray(protocols)) {
@@ -144,7 +144,7 @@ export class PeerStoreProtoBook implements ProtoBook {
144144
}))
145145
}
146146

147-
async remove (peerId: PeerId, protocols: string[]) {
147+
async remove (peerId: PeerId, protocols: string[]): Promise<void> {
148148
peerId = peerIdFromPeerId(peerId)
149149

150150
if (!Array.isArray(protocols)) {
@@ -196,7 +196,7 @@ export class PeerStoreProtoBook implements ProtoBook {
196196
}))
197197
}
198198

199-
async delete (peerId: PeerId) {
199+
async delete (peerId: PeerId): Promise<void> {
200200
peerId = peerIdFromPeerId(peerId)
201201

202202
log.trace('delete await write lock')

src/store.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export class PersistentStore {
4545
})
4646
}
4747

48-
_peerIdToDatastoreKey (peerId: PeerId) {
48+
_peerIdToDatastoreKey (peerId: PeerId): Key {
4949
if (peerId.type == null) {
5050
log.error('peerId must be an instance of peer-id to store data')
5151
throw new CodeError('peerId must be an instance of peer-id', codes.ERR_INVALID_PARAMETERS)
@@ -55,11 +55,11 @@ export class PersistentStore {
5555
return new Key(`${NAMESPACE_COMMON}${b32key}`)
5656
}
5757

58-
async has (peerId: PeerId) {
58+
async has (peerId: PeerId): Promise<boolean> {
5959
return await this.components.datastore.has(this._peerIdToDatastoreKey(peerId))
6060
}
6161

62-
async delete (peerId: PeerId) {
62+
async delete (peerId: PeerId): Promise<void> {
6363
await this.components.datastore.delete(this._peerIdToDatastoreKey(peerId))
6464
}
6565

@@ -87,7 +87,7 @@ export class PersistentStore {
8787
}
8888
}
8989

90-
async save (peer: Peer) {
90+
async save (peer: Peer): Promise<Peer> {
9191
if (peer.pubKey != null && peer.id.publicKey != null && !uint8arrayEquals(peer.pubKey, peer.id.publicKey)) {
9292
log.error('peer publicKey bytes do not match peer id publicKey bytes')
9393
throw new CodeError('publicKey bytes do not match peer id publicKey bytes', codes.ERR_INVALID_PARAMETERS)
@@ -135,13 +135,13 @@ export class PersistentStore {
135135
return await this.load(peer.id)
136136
}
137137

138-
async patch (peerId: PeerId, data: Partial<Peer>) {
138+
async patch (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
139139
const peer = await this.load(peerId)
140140

141141
return await this._patch(peerId, data, peer)
142142
}
143143

144-
async patchOrCreate (peerId: PeerId, data: Partial<Peer>) {
144+
async patchOrCreate (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
145145
let peer: Peer
146146

147147
try {
@@ -157,21 +157,21 @@ export class PersistentStore {
157157
return await this._patch(peerId, data, peer)
158158
}
159159

160-
async _patch (peerId: PeerId, data: Partial<Peer>, peer: Peer) {
160+
async _patch (peerId: PeerId, data: Partial<Peer>, peer: Peer): Promise<Peer> {
161161
return await this.save({
162162
...peer,
163163
...data,
164164
id: peerId
165165
})
166166
}
167167

168-
async merge (peerId: PeerId, data: Partial<Peer>) {
168+
async merge (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
169169
const peer = await this.load(peerId)
170170

171171
return await this._merge(peerId, data, peer)
172172
}
173173

174-
async mergeOrCreate (peerId: PeerId, data: Partial<Peer>) {
174+
async mergeOrCreate (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
175175
/** @type {Peer} */
176176
let peer
177177

@@ -188,7 +188,7 @@ export class PersistentStore {
188188
return await this._merge(peerId, data, peer)
189189
}
190190

191-
async _merge (peerId: PeerId, data: Partial<Peer>, peer: Peer) {
191+
async _merge (peerId: PeerId, data: Partial<Peer>, peer: Peer): Promise<Peer> {
192192
// if the peer has certified addresses, use those in
193193
// favour of the supplied versions
194194
const addresses = new Map<string, boolean>()
@@ -227,7 +227,7 @@ export class PersistentStore {
227227
})
228228
}
229229

230-
async * all () {
230+
async * all (): AsyncGenerator<Peer, void, unknown> {
231231
for await (const key of this.components.datastore.queryKeys({
232232
prefix: NAMESPACE_COMMON
233233
})) {

0 commit comments

Comments
 (0)