fix: replace node buffers with uint8arrays (#118)

* fix: replace node buffers with uint8arrays

All uses of node Buffers have been replaced with Uint8Arrays

BREAKING CHANGES:

- The `.data` and `.seq` properties of messages used to be node Buffers, now they are Uint8Arrays
- All deps of this module now use Uint8Arrays instead of Buffers

* chore: remove gh url from dep version

README.md

@@ -55,7 +55,7 @@ gsub.on('fruit', (data) => {
 })
 gsub.subscribe('fruit')
 
-gsub.publish('fruit', new Buffer('banana'))
+gsub.publish('fruit', new TextEncoder().encode('banana'))
 ```
 
 ## API

benchmarks/benchmarks.js

@@ -25,7 +25,7 @@ const suite = new Benchmark.Suite('gossipsub')
   suite
     .add('publish and receive', (deferred) => {
       peers[1].gs.once('Z', (msg) => deferred.resolve(msg))
-      peers[0].gs.publish('Z', Buffer.alloc(1024))
+      peers[0].gs.publish('Z', new Uint8Array(1024))
     }, {
       defer: true
     })

package.json

@@ -36,23 +36,22 @@
     "lint"
   ],
   "dependencies": {
-    "buffer": "^5.6.0",
     "debug": "^4.1.1",
     "err-code": "^2.0.0",
     "it-length-prefixed": "^3.0.0",
     "it-pipe": "^1.0.1",
-    "libp2p-pubsub": "~0.5.2",
+    "libp2p-pubsub": "^0.6.0",
     "p-map": "^4.0.0",
-    "peer-id": "~0.13.12",
-    "protons": "^1.0.1",
+    "peer-id": "^0.14.0",
+    "protons": "^2.0.0",
     "time-cache": "^0.3.0"
   },
   "devDependencies": {
     "@types/chai": "^4.2.3",
     "@types/mocha": "^7.0.2",
     "@typescript-eslint/eslint-plugin": "^3.0.2",
     "@typescript-eslint/parser": "^3.0.2",
-    "aegir": "^21.10.2",
+    "aegir": "^25.0.0",
     "benchmark": "^2.1.4",
     "chai": "^4.2.0",
     "chai-spies": "^1.0.0",
@@ -72,7 +71,8 @@
     "p-wait-for": "^3.1.0",
     "promisify-es6": "^1.0.3",
     "sinon": "^9.0.2",
-    "typescript": "^3.9.3"
+    "typescript": "^3.9.3",
+    "uint8arrays": "^1.1.0"
   },
   "contributors": [
     "Cayman <caymannava@gmail.com>",

test/2-nodes.spec.js

@@ -1,11 +1,12 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 chai.use(require('chai-spies'))
 const expect = chai.expect
+const uint8ArrayFromString = require('uint8arrays/from-string')
+
 
 const { multicodec } = require('../src')
 
@@ -151,7 +152,7 @@ describe('2 nodes', () => {
       const promise = new Promise((resolve) => nodes[1].once(topic, resolve))
       nodes[0].once(topic, (m) => shouldNotHappen)
 
-      nodes[0].publish(topic, Buffer.from('hey'))
+      nodes[0].publish(topic, uint8ArrayFromString('hey'))
 
       const msg = await promise
 
@@ -165,7 +166,7 @@ describe('2 nodes', () => {
       const promise = new Promise((resolve) => nodes[0].once(topic, resolve))
       nodes[1].once(topic, shouldNotHappen)
 
-      nodes[1].publish(topic, Buffer.from('banana'))
+      nodes[1].publish(topic, uint8ArrayFromString('banana'))
 
       const msg = await promise
 
@@ -185,7 +186,7 @@ describe('2 nodes', () => {
       function receivedMsg (msg) {
         expect(msg.data.toString()).to.equal('banana')
         expect(msg.from).to.be.eql(nodes[1].peerId.toB58String())
-        expect(Buffer.isBuffer(msg.seqno)).to.be.true()
+        expect(msg.seqno).to.be.a('Uint8Array')
         expect(msg.topicIDs).to.be.eql([topic])
 
         if (++counter === 10) {
@@ -196,7 +197,7 @@ describe('2 nodes', () => {
       }
 
       Array.from({ length: 10 }).forEach(() => {
-        nodes[1].publish(topic, Buffer.from('banana'))
+        nodes[1].publish(topic, uint8ArrayFromString('banana'))
       })
     })
 
@@ -210,7 +211,7 @@ describe('2 nodes', () => {
       function receivedMsg (msg) {
         expect(msg.data.toString()).to.equal('banana')
         expect(msg.from).to.be.eql(nodes[1].peerId.toB58String())
-        expect(Buffer.isBuffer(msg.seqno)).to.be.true()
+        expect(msg.seqno).to.be.a('Uint8Array')
         expect(msg.topicIDs).to.be.eql([topic])
 
         if (++counter === 10) {
@@ -222,7 +223,7 @@ describe('2 nodes', () => {
 
       const msgs = []
       Array.from({ length: 10 }).forEach(() => {
-        msgs.push(Buffer.from('banana'))
+        msgs.push(uint8ArrayFromString('banana'))
       })
       nodes[1].publish(topic, msgs)
     })
@@ -281,8 +282,8 @@ describe('2 nodes', () => {
         }, 100)
       })
 
-      nodes[1].publish('Z', Buffer.from('banana'))
-      nodes[0].publish('Z', Buffer.from('banana'))
+      nodes[1].publish('Z', uint8ArrayFromString('banana'))
+      nodes[0].publish('Z', uint8ArrayFromString('banana'))
 
       try {
         await promise

test/emit-self.spec.js

@@ -1,10 +1,11 @@
 /* eslint-env mocha */
 'use strict'
-const { Buffer } = require('buffer')
+
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 chai.use(require('chai-spies'))
 const expect = chai.expect
+const uint8ArrayFromString = require('uint8arrays/from-string')
 
 const {
   createGossipsub,
@@ -29,7 +30,7 @@ describe('emit self', () => {
     it('should emit to self on publish', async () => {
       const promise = new Promise((resolve) => gossipsub.once(topic, resolve))
 
-      gossipsub.publish(topic, Buffer.from('hey'))
+      gossipsub.publish(topic, uint8ArrayFromString('hey'))
 
       await promise
     })
@@ -46,7 +47,7 @@ describe('emit self', () => {
     it('should emit to self on publish', async () => {
       gossipsub.once(topic, (m) => shouldNotHappen)
 
-      gossipsub.publish(topic, Buffer.from('hey'))
+      gossipsub.publish(topic, uint8ArrayFromString('hey'))
 
       // Wait 1 second to guarantee that self is not noticed
       await new Promise((resolve) => setTimeout(() => resolve(), 1000))

test/floodsub.spec.js

@@ -1,9 +1,9 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
+const uint8ArrayFromString = require('uint8arrays/from-string')
 
 const expect = chai.expect
 const times = require('lodash/times')
@@ -228,7 +228,7 @@ describe('gossipsub fallbacks to floodsub', () => {
       const promise = new Promise((resolve) => nodeFs.once(topic, resolve))
       nodeGs.once(topic, (m) => shouldNotHappen)
 
-      nodeGs.publish(topic, Buffer.from('hey'))
+      nodeGs.publish(topic, uint8ArrayFromString('hey'))
 
       promise.then((msg) => {
         expect(msg.data.toString()).to.equal('hey')
@@ -242,7 +242,7 @@ describe('gossipsub fallbacks to floodsub', () => {
     it('Publish to a topic - nodeFs', async () => {
       const promise = new Promise((resolve) => nodeGs.once(topic, resolve))
 
-      nodeFs.publish(topic, Buffer.from('banana'))
+      nodeFs.publish(topic, uint8ArrayFromString('banana'))
 
       const msg = await promise
 
@@ -263,7 +263,7 @@ describe('gossipsub fallbacks to floodsub', () => {
       function receivedMsg (msg) {
         expect(msg.data.toString()).to.equal('banana ' + counter)
         expect(msg.from).to.be.eql(nodeGs.peerId.toB58String())
-        expect(Buffer.isBuffer(msg.seqno)).to.be.true()
+        expect(msg.seqno).to.be.a('Uint8Array')
         expect(msg.topicIDs).to.be.eql([topic])
 
         if (++counter === 10) {
@@ -273,7 +273,7 @@ describe('gossipsub fallbacks to floodsub', () => {
         }
       }
 
-      times(10, (index) => nodeGs.publish(topic, Buffer.from('banana ' + index)))
+      times(10, (index) => nodeGs.publish(topic, uint8ArrayFromString('banana ' + index)))
     })
 
     it('Publish 10 msg to a topic as array', (done) => {
@@ -290,7 +290,7 @@ describe('gossipsub fallbacks to floodsub', () => {
       function receivedMsg (msg) {
         expect(msg.data.toString()).to.equal('banana ' + counter)
         expect(msg.from).to.be.eql(nodeGs.peerId.toB58String())
-        expect(Buffer.isBuffer(msg.seqno)).to.be.true()
+        expect(msg.seqno).to.be.a('Uint8Array')
         expect(msg.topicIDs).to.be.eql([topic])
 
         if (++counter === 10) {
@@ -301,7 +301,7 @@ describe('gossipsub fallbacks to floodsub', () => {
       }
 
       const msgs = []
-      times(10, (index) => msgs.push(Buffer.from('banana ' + index)))
+      times(10, (index) => msgs.push(uint8ArrayFromString('banana ' + index)))
       nodeGs.publish(topic, msgs)
     })
   })
@@ -384,8 +384,8 @@ describe('gossipsub fallbacks to floodsub', () => {
         }, 100)
       })
 
-      nodeFs.publish('Z', Buffer.from('banana'))
-      nodeGs.publish('Z', Buffer.from('banana'))
+      nodeFs.publish('Z', uint8ArrayFromString('banana'))
+      nodeGs.publish('Z', uint8ArrayFromString('banana'))
 
       try {
         await promise

test/gossip-incoming.spec.js

@@ -1,11 +1,12 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 chai.use(require('chai-spies'))
 const expect = chai.expect
+const uint8ArrayFromString = require('uint8arrays/from-string')
+
 
 const { GossipsubID: multicodec } = require('../src/constants')
 const { createGossipsubConnectedNodes } = require('./utils')
@@ -43,7 +44,7 @@ describe('gossip incoming', () => {
       const promise = new Promise((resolve) => nodes[2].once(topic, resolve))
       nodes[0].once(topic, (m) => shouldNotHappen)
 
-      nodes[0].publish(topic, Buffer.from('hey'))
+      nodes[0].publish(topic, uint8ArrayFromString('hey'))
 
       const msg = await promise
 
@@ -80,7 +81,7 @@ describe('gossip incoming', () => {
     it('should not gossip incoming messages', async () => {
       nodes[2].once(topic, (m) => shouldNotHappen)
 
-      nodes[0].publish(topic, Buffer.from('hey'))
+      nodes[0].publish(topic, uint8ArrayFromString('hey'))
 
       await new Promise((resolve) => setTimeout(resolve, 1000))
 

test/gossip.js

@@ -1,9 +1,9 @@
 'use strict'
 /* eslint-env mocha */
 
-const { Buffer } = require('buffer')
 const { expect } = require('chai')
 const sinon = require('sinon')
+const uint8ArrayFromString = require('uint8arrays/from-string')
 
 const { GossipsubID: multicodec, GossipsubDhi } = require('../src/constants')
 const {
@@ -42,7 +42,7 @@ describe('gossip', () => {
     // set spy
     sinon.spy(nodeA, 'log')
 
-    await nodeA.publish(topic, Buffer.from('hey'))
+    await nodeA.publish(topic, uint8ArrayFromString('hey'))
 
     await new Promise((resolve) => nodeA.once('gossipsub:heartbeat', resolve))
 
@@ -84,7 +84,7 @@ describe('gossip', () => {
     // manually add control message to be sent to peerB
     nodeA.control.set(peerB, { graft: [{ topicID: topic }] })
 
-    await nodeA.publish(topic, Buffer.from('hey'))
+    await nodeA.publish(topic, uint8ArrayFromString('hey'))
 
     await new Promise((resolve) => nodeA.once('gossipsub:heartbeat', resolve))
     expect(nodeB.log.callCount).to.be.gt(1)

test/messageCache.spec.js

@@ -1,13 +1,14 @@
 /* eslint-env mocha */
 /* eslint-disable no-unused-expressions */
 'use strict'
-const { Buffer } = require('buffer')
+
 const chai = require('chai')
 const dirtyChai = require('dirty-chai')
 chai.use(dirtyChai)
 const chaiSpies = require('chai-spies')
 chai.use(chaiSpies)
 const expect = chai.expect
+const uint8ArrayFromString = require('uint8arrays/from-string')
 
 const { MessageCache } = require('../src/messageCache')
 const { utils } = require('libp2p-pubsub')
@@ -24,7 +25,7 @@ describe('Testing Message Cache Operations', () => {
     const makeTestMessage = (n) => {
       return {
         from: 'test',
-        data: Buffer.from(n.toString()),
+        data: uint8ArrayFromString(n.toString()),
         seqno: utils.randomSeqno(),
         topicIDs: ['test']
       }

test/multiple-nodes.spec.js

@@ -1,11 +1,12 @@
 /* eslint-env mocha */
 /* eslint max-nested-callbacks: ["error", 8] */
 'use strict'
-const { Buffer } = require('buffer')
+
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
 const promisify = require('promisify-es6')
+const uint8ArrayFromString = require('uint8arrays/from-string')
 
 const { GossipsubID: multicodec } = require('../src/constants')
 const {
@@ -192,7 +193,7 @@ describe('multiple nodes (more than 2)', () => {
           let msgB = new Promise((resolve) => b.once('Z', resolve))
           let msgC = new Promise((resolve) => c.once('Z', resolve))
 
-          a.publish('Z', Buffer.from('hey'))
+          a.publish('Z', uint8ArrayFromString('hey'))
           msgB = await msgB
           msgC = await msgC
 
@@ -222,7 +223,7 @@ describe('multiple nodes (more than 2)', () => {
             })
           })
 
-          a.publish('Z', [Buffer.from('hey'), Buffer.from('hey')])
+          a.publish('Z', [uint8ArrayFromString('hey'), uint8ArrayFromString('hey')])
           msgB = await msgB
           msgC = await msgC
 
@@ -318,7 +319,7 @@ describe('multiple nodes (more than 2)', () => {
         let msgA = new Promise((resolve) => a.once('Z', resolve))
         let msgC = new Promise((resolve) => c.once('Z', resolve))
 
-        b.publish('Z', Buffer.from('hey'))
+        b.publish('Z', uint8ArrayFromString('hey'))
         msgA = await msgA
         msgC = await msgC
 
@@ -460,7 +461,7 @@ describe('multiple nodes (more than 2)', () => {
         let msgE = new Promise((resolve) => e.once('Z', resolve))
 
         const msg = 'hey from c'
-        c.publish('Z', Buffer.from(msg))
+        c.publish('Z', uint8ArrayFromString(msg))
 
         msgA = await msgA
         msgB = await msgB