Skip to content

fix: replace node buffers with uint8arrays #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jacobheun merged 2 commits into from
Aug 23, 2020
Merged

fix: replace node buffers with uint8arrays #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
351effd
fix: replace node buffers with uint8arrays
achingbrain Aug 19, 2020
ab9135f
chore: bump daemon dep
jacobheun Aug 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ const client = new Client(defaultSock)
try {
await client.connect(peerId, addrs)
} catch (err) {
//
//
}
```

Expand Down Expand Up @@ -118,7 +118,7 @@ let identify
try {
identify = await client.identify()
} catch (err) {
//
//
}
```

Expand All @@ -145,7 +145,7 @@ let identify
try {
identify = await client.identify()
} catch (err) {
//
//
}
```

Expand Down Expand Up @@ -182,7 +182,7 @@ try {
//
}

socket.write(Buffer.from('data'))
socket.write(uint8ArrayFromString('data'))
```

## registerStreamHandler
Expand Down Expand Up @@ -217,21 +217,21 @@ Write a value to a key in the DHT.

| Name | Type | Description |
|------|------|-------------|
| key | `String` | key to add to the dht |
| value | `Buffer` | value to add to the dht |
| key | `Uint8Array` | key to add to the dht |
| value | `Uint8Array` | value to add to the dht |

#### Example

```js
const client = new Client(defaultSock)

const key = '/key'
const value = Buffer.from('oh hello there')
const value = uint8ArrayFromString('oh hello there')

try {
await client.dht.put(key, value)
} catch (err) {
//
//
}
```

Expand All @@ -245,13 +245,13 @@ Query the DHT for a value stored through a key in the DHT.

| Name | Type | Description |
|------|------|-------------|
| key | `String` | key to get from the dht |
| key | `Uint8Array` | key to get from the dht |

#### Returns

| Type | Description |
|------|-------------|
| `Buffer` | Value obtained from the DHT |
| `Uint8Array` | Value obtained from the DHT |

#### Example

Expand All @@ -264,7 +264,7 @@ let value
try {
value = await client.dht.get(key, value)
} catch (err) {
//
//
}
```

Expand Down Expand Up @@ -296,7 +296,7 @@ let peerInfo
try {
peerInfo = await client.dht.findPeer(peerId)
} catch (err) {
//
//
}
```

Expand All @@ -320,7 +320,7 @@ const client = new Client(defaultSock)
try {
await client.dht.provide(cid)
} catch (err) {
//
//
}
```

Expand Down Expand Up @@ -354,7 +354,7 @@ let peerInfos
try {
peerInfos = await client.dht.findProviders(cid)
} catch (err) {
//
//
}
```

Expand All @@ -368,7 +368,7 @@ Query the DHT routing table for peers that are closest to a provided key.

| Name | Type | Description |
|------|------|-------------|
| key | `String` | key to get from the dht |
| key | `Uint8Array` | key to get from the dht |

#### Returns

Expand All @@ -387,7 +387,7 @@ let peerInfos
try {
peerInfos = await client.dht.getClosestPeers(key)
} catch (err) {
//
//
}
```

Expand Down Expand Up @@ -419,7 +419,7 @@ let publicKey
try {
publicKey = await client.dht.getPublicKey(peerId)
} catch (err) {
//
//
}
```

Expand All @@ -441,7 +441,7 @@ let topics
try {
topics = await client.pubsub.getTopics()
} catch (err) {
//
//
}
```

Expand All @@ -452,7 +452,7 @@ try {
| Name | Type | Description |
|------|------|-------------|
| topic | `string` | topic to publish |
| data | `Buffer` | data to publish |
| data | `Uint8Array` | data to publish |

#### Returns

Expand All @@ -464,13 +464,13 @@ try {

```js
const topic = 'topic'
const data = Buffer.from('data')
const data = uint8ArrayFromString('data')
const client = new Client(defaultSock)

try {
await client.pubsub.publish(topic, data)
} catch (err) {
//
//
}
```

Expand Down
15 changes: 8 additions & 7 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
],
"license": "MIT",
"devDependencies": {
"aegir": "^24.0.0",
"aegir": "^26.0.0",
"chai": "^4.2.0",
"chai-as-promised": "^7.1.1",
"chai-bytes": "~0.1.2",
Expand All @@ -44,17 +44,18 @@
"it-pushable": "^1.4.0",
"mocha": "^8.0.1",
"sinon": "^9.0.0",
"streaming-iterables": "^5.0.2"
"streaming-iterables": "^5.0.2",
"uint8arrays": "^1.1.0"
},
"dependencies": {
"cids": "~0.8.0",
"cids": "^1.0.0",
"err-code": "^2.0.0",
"it-handshake": "^1.0.1",
"it-length-prefixed": "^3.0.0",
"libp2p-daemon": "^0.4.0",
"libp2p-tcp": "^0.14.2",
"multiaddr": "^7.2.1",
"peer-id": "~0.13.3"
"libp2p-daemon": "^0.5.0",
"libp2p-tcp": "^0.15.1",
"multiaddr": "^8.0.0",
"peer-id": "^0.14.0"
},
"contributors": [
"Vasco Santos <vasco.santos@moxy.studio>",
Expand Down
24 changes: 12 additions & 12 deletions src/dht.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ class DHT {

/**
* Write a value to a key in the DHT.
* @param {String} key
* @param {Buffer} value
* @param {Uint8Array} key
* @param {Uint8Array} value
*/
async put (key, value) {
if (typeof key !== 'string') {
if (!(key instanceof Uint8Array)) {
throw errcode(new Error('invalid key received'), 'ERR_INVALID_KEY')
}

if (!Buffer.isBuffer(value)) {
throw errcode(new Error('value received is not a buffer'), 'ERR_INVALID_VALUE')
if (!(value instanceof Uint8Array)) {
throw errcode(new Error('value received is not a Uint8Array'), 'ERR_INVALID_VALUE')
}

const sh = await this._client.send({
Expand All @@ -56,11 +56,11 @@ class DHT {

/**
* Query the DHT for a value stored at a key in the DHT.
* @param {String} key
* @returns {Buffer}
* @param {Uint8Array} key
* @returns {Uint8Array}
*/
async get (key) {
if (typeof key !== 'string') {
if (!(key instanceof Uint8Array)) {
throw errcode(new Error('invalid key received'), 'ERR_INVALID_KEY')
}

Expand Down Expand Up @@ -130,7 +130,7 @@ class DHT {
type: Request.Type.DHT,
dht: {
type: DHTRequest.Type.PROVIDE,
cid: cid.buffer
cid: cid.bytes
}
})

Expand Down Expand Up @@ -159,7 +159,7 @@ class DHT {
type: Request.Type.DHT,
dht: {
type: DHTRequest.Type.FIND_PROVIDERS,
cid: cid.buffer,
cid: cid.bytes,
count
}
})
Expand Down Expand Up @@ -200,11 +200,11 @@ class DHT {

/**
* Query the DHT routing table for peers that are closest to a provided key.
* @param {string} key
* @param {Uint8Array} key
* @returns {Array<PeerInfo>}
*/
async * getClosestPeers (key) {
if (typeof key !== 'string') {
if (!(key instanceof Uint8Array)) {
throw errcode(new Error('invalid key received'), 'ERR_INVALID_KEY')
}

Expand Down
6 changes: 3 additions & 3 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ class Client {
type: Request.Type.CONNECT,
connect: {
peer: peerId.toBytes(),
addrs: addrs.map((a) => a.buffer)
addrs: addrs.map((a) => a.bytes)
}
})

Expand Down Expand Up @@ -186,7 +186,7 @@ class Client {
const sh = await this.send({
type: Request.Type.STREAM_OPEN,
streamOpen: {
peer: Buffer.from(peerId.toB58String()),
peer: peerId.toBytes(),
proto: [protocol]
}
})
Expand Down Expand Up @@ -221,7 +221,7 @@ class Client {
type: Request.Type.STREAM_HANDLER,
streamOpen: null,
streamHandler: {
addr: addr.buffer,
addr: addr.bytes,
proto: [protocol]
}
})
Expand Down
4 changes: 2 additions & 2 deletions src/pubsub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ class Pubsub {
throw errcode(new Error('invalid topic received'), 'ERR_INVALID_TOPIC')
}

if (!Buffer.isBuffer(data)) {
throw errcode(new Error('data received is not a buffer'), 'ERR_INVALID_DATA')
if (!(data instanceof Uint8Array)) {
throw errcode(new Error('data received is not a Uint8Array'), 'ERR_INVALID_DATA')
}

const sh = await this._client.send({
Expand Down
21 changes: 11 additions & 10 deletions test/dht.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ chai.use(dirtyChai)
chai.use(chaiBytes)

const sinon = require('sinon')
const uint8ArrayFromString = require('uint8arrays/from-string')

const { createDaemon } = require('libp2p-daemon/src/daemon')
const Client = require('../src')
Expand Down Expand Up @@ -40,8 +41,8 @@ describe('daemon dht client', function () {
let daemon
let client

const key = '/key'
const value = Buffer.from('oh hello there')
const key = uint8ArrayFromString('/key')
const value = uint8ArrayFromString('oh hello there')

before(async function () {
daemon = await createDaemon(daemonOpts())
Expand All @@ -52,7 +53,7 @@ describe('daemon dht client', function () {
return daemon.stop()
})

it('should be able to put a value to the dth', async function () {
it('should be able to put a value to the dht', async function () {
client = new Client(defaultMultiaddr)

try {
Expand Down Expand Up @@ -91,7 +92,7 @@ describe('daemon dht client', function () {
client = new Client(defaultMultiaddr)

try {
await client.dht.put(value, value)
await client.dht.put(5, value)
expect.fail('should have thrown')
} catch (err) {
expect(err).to.exist()
Expand All @@ -105,7 +106,7 @@ describe('daemon dht client', function () {
client = new Client(defaultMultiaddr)

try {
await client.dht.put(key, key)
await client.dht.put(key, 5)
expect.fail('should have thrown')
} catch (err) {
expect(err).to.exist()
Expand Down Expand Up @@ -134,8 +135,8 @@ describe('daemon dht client', function () {
})

it('should be able to get a value from the dth', async function () {
const key = '/key'
const value = Buffer.from('oh hello there')
const key = uint8ArrayFromString('/key')
const value = uint8ArrayFromString('oh hello there')

client = new Client(defaultMultiaddr)

Expand All @@ -160,7 +161,7 @@ describe('daemon dht client', function () {
client = new Client(defaultMultiaddr)

try {
await client.dht.get(Buffer.from('/key'))
await client.dht.get(uint8ArrayFromString('/key'))
expect('should have thrown')
} catch (err) {
expect(err).to.exist()
Expand All @@ -172,7 +173,7 @@ describe('daemon dht client', function () {
client = new Client(defaultMultiaddr)

try {
await client.dht.get('/unavailable-key')
await client.dht.get(uint8ArrayFromString('/unavailable-key'))
expect.fail('should have thrown')
} catch (err) {
expect(err).to.exist()
Expand Down Expand Up @@ -418,7 +419,7 @@ describe('daemon dht client', function () {
let daemonB
let client

const key = 'foobar'
const key = uint8ArrayFromString('foobar')

before(async function () {
[daemonA, daemonB] = await Promise.all([
Expand Down
Loading