@smartledger/bsv 5.4.2 → 5.5.1

package/test/encoding/base58check.js

@@ -0,0 +1,136 @@
+'use strict'
+
+var should = require('chai').should()
+var bsv = require('../..')
+var Base58Check = bsv.encoding.Base58Check
+var Base58 = bsv.encoding.Base58
+
+describe('Base58Check', function () {
+  var buf = Buffer.from([0, 1, 2, 3, 253, 254, 255])
+  var enc = '14HV44ipwoaqfg'
+
+  it('should make an instance with "new"', function () {
+    var b58 = new Base58Check()
+    should.exist(b58)
+  })
+
+  it('can validate a serialized string', function () {
+    var address = '3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy'
+    Base58Check.validChecksum(address).should.equal(true)
+    address = address + 'a'
+    Base58Check.validChecksum(address).should.equal(false)
+  })
+
+  it('should make an instance without "new"', function () {
+    var b58 = Base58Check()
+    should.exist(b58)
+  })
+
+  it('should allow this handy syntax', function () {
+    Base58Check(buf).toString().should.equal(enc)
+    Base58Check(enc).toBuffer().toString('hex').should.equal(buf.toString('hex'))
+  })
+
+  describe('#set', function () {
+    it('should set a buf', function () {
+      should.exist(Base58Check().set({ buf: buf }).buf)
+    })
+  })
+
+  describe('@encode', function () {
+    it('should encode the buffer accurately', function () {
+      Base58Check.encode(buf).should.equal(enc)
+    })
+
+    it('should throw an error when the input is not a buffer', function () {
+      (function () {
+        Base58Check.encode('string')
+      }).should.throw('Input must be a buffer')
+    })
+  })
+
+  describe('@decode', function () {
+    it('should decode this encoded value correctly', function () {
+      Base58Check.decode(enc).toString('hex').should.equal(buf.toString('hex'))
+    })
+
+    it('should throw an error when input is not a string', function () {
+      (function () {
+        Base58Check.decode(5)
+      }).should.throw('Input must be a string')
+    })
+
+    it('should throw an error when input is too short', function () {
+      (function () {
+        Base58Check.decode(enc.slice(0, 1))
+      }).should.throw('Input string too short')
+    })
+
+    it('should throw an error when there is a checksum mismatch', function () {
+      var buf2 = Base58.decode(enc)
+      buf2[0] = buf2[0] + 1
+      var enc2 = Base58.encode(buf2);
+      (function () {
+        Base58Check.decode(enc2)
+      }).should.throw('Checksum mismatch')
+    })
+  })
+
+  describe('#fromBuffer', function () {
+    it('should not fail', function () {
+      should.exist(Base58Check().fromBuffer(buf))
+    })
+
+    it('should set buffer', function () {
+      var b58 = Base58Check().fromBuffer(buf)
+      b58.toHex().should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('@fromBuffer', function () {
+    it('should set buffer', function () {
+      var b58 = Base58Check.fromBuffer(buf)
+      b58.buf.toString('hex').should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('@fromHex', function () {
+    it('should set hex', function () {
+      var b58 = Base58Check.fromHex(buf.toString('hex'))
+      b58.buf.toString('hex').should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('#fromString', function () {
+    it('should convert this known string to a buffer', function () {
+      Base58Check().fromString(enc).toBuffer().toString('hex').should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('@fromString', function () {
+    it('should convert this known string to a buffer', function () {
+      Base58Check.fromString(enc).toBuffer().toString('hex').should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('#toBuffer', function () {
+    it('should return the buffer', function () {
+      var b58 = Base58Check(buf)
+      b58.toBuffer().toString('hex').should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('#toHex', function () {
+    it('should return the hex', function () {
+      var b58 = Base58Check(buf)
+      b58.toHex().should.equal(buf.toString('hex'))
+    })
+  })
+
+  describe('#toString', function () {
+    it('should return the buffer', function () {
+      var b58 = Base58Check(buf)
+      b58.toString().should.equal(enc)
+    })
+  })
+})

package/test/encoding/bufferreader.js

@@ -0,0 +1,328 @@
+'use strict'
+
+var should = require('chai').should()
+var bsv = require('../..')
+var BufferWriter = bsv.encoding.BufferWriter
+var BufferReader = bsv.encoding.BufferReader
+var BN = bsv.crypto.BN
+
+describe('BufferReader', function () {
+  it('should make a new BufferReader', function () {
+    var br = new BufferReader()
+    should.exist(br)
+    br = BufferReader()
+    should.exist(br)
+  })
+
+  it('should create a new bufferreader with a buffer', function () {
+    var buf = Buffer.alloc(0)
+    var br = new BufferReader(buf)
+    should.exist(br)
+    Buffer.isBuffer(br.buf).should.equal(true)
+  })
+  it('should fail for invalid object', function () {
+    var fail = function () {
+      return new BufferReader(5)
+    }
+    fail.should.throw('Unrecognized argument for BufferReader')
+  })
+
+  describe('#set', function () {
+    it('should set pos', function () {
+      should.exist(BufferReader().set({
+        pos: 1
+      }).pos)
+    })
+  })
+
+  describe('#eof', function () {
+    it('should return true for a blank br', function () {
+      var br = new BufferReader(Buffer.from([]))
+      br.finished().should.equal(true)
+    })
+  })
+
+  describe('read', function () {
+    it('should return the same buffer', function () {
+      var buf = Buffer.from([0])
+      var br = new BufferReader(buf)
+      br.readAll().toString('hex').should.equal(buf.toString('hex'))
+    })
+
+    it('should return a buffer of this length', function () {
+      var buf = Buffer.alloc(10)
+      buf.fill(0)
+      var br = new BufferReader(buf)
+      var buf2 = br.read(2)
+      buf2.length.should.equal(2)
+      br.finished().should.equal(false)
+      br.pos.should.equal(2)
+    })
+
+    it('should work with 0 length', function () {
+      var buf = Buffer.alloc(10)
+      buf.fill(1)
+      var br = new BufferReader(buf)
+      var buf2 = br.read(0)
+      buf2.length.should.equal(0)
+      br.finished().should.equal(false)
+      buf2.toString('hex').should.equal('')
+    })
+  })
+
+  describe('readVarLengthBuffer', function () {
+    it('returns correct buffer', function () {
+      var buf = Buffer.from('73010000003766404f00000000b305434f00000000f203' +
+        '0000f1030000001027000048ee00000064000000004653656520626974636f696' +
+        'e2e6f72672f666562323020696620796f7520686176652074726f75626c652063' +
+        '6f6e6e656374696e6720616674657220323020466562727561727900473045022' +
+        '1008389df45f0703f39ec8c1cc42c13810ffcae14995bb648340219e353b63b53' +
+        'eb022009ec65e1c1aaeec1fd334c6b684bde2b3f573060d5b70c3a46723326e4e' +
+        '8a4f1', 'hex')
+      var br = new BufferReader(buf)
+      var b1 = br.readVarLengthBuffer()
+      b1.toString('hex').should.equal('010000003766404f00000000b305434f000' +
+        '00000f2030000f1030000001027000048ee000000640000000046536565206269' +
+        '74636f696e2e6f72672f666562323020696620796f7520686176652074726f756' +
+        '26c6520636f6e6e656374696e6720616674657220323020466562727561727900')
+      var b2 = br.readVarLengthBuffer()
+      b2.toString('hex').should.equal('30450221008389df45f0703f39ec8c1cc42' +
+        'c13810ffcae14995bb648340219e353b63b53eb022009ec65e1c1aaeec1fd334c' +
+        '6b684bde2b3f573060d5b70c3a46723326e4e8a4f1')
+    })
+    it('fails on length too big', function () {
+      var buf = Buffer.from('0a00', 'hex')
+      var br = new BufferReader(buf)
+      br.readVarLengthBuffer.bind(br).should.throw('Invalid length while reading varlength buffer')
+    })
+  })
+
+  describe('#readUInt8', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(1)
+      buf.writeUInt8(1, 0)
+      var br = new BufferReader(buf)
+      br.readUInt8().should.equal(1)
+    })
+  })
+
+  describe('#readUInt16BE', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(2)
+      buf.writeUInt16BE(1, 0)
+      var br = new BufferReader(buf)
+      br.readUInt16BE().should.equal(1)
+    })
+  })
+
+  describe('#readUInt16LE', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(2)
+      buf.writeUInt16LE(1, 0)
+      var br = new BufferReader(buf)
+      br.readUInt16LE().should.equal(1)
+    })
+  })
+
+  describe('#readUInt32BE', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(4)
+      buf.writeUInt32BE(1, 0)
+      var br = new BufferReader(buf)
+      br.readUInt32BE().should.equal(1)
+    })
+  })
+
+  describe('#readUInt32LE', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(4)
+      buf.writeUInt32LE(1, 0)
+      var br = new BufferReader(buf)
+      br.readUInt32LE().should.equal(1)
+    })
+  })
+
+  describe('#readUInt64BEBN', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(8)
+      buf.fill(0)
+      buf.writeUInt32BE(1, 4)
+      var br = new BufferReader(buf)
+      br.readUInt64BEBN().toNumber().should.equal(1)
+    })
+
+    it('should return 2^64', function () {
+      var buf = Buffer.alloc(8)
+      buf.fill(0xff)
+      var br = new BufferReader(buf)
+      br.readUInt64BEBN().toNumber().should.equal(Math.pow(2, 64))
+    })
+  })
+
+  describe('#readUInt64LEBN', function () {
+    it('should return 1', function () {
+      var buf = Buffer.alloc(8)
+      buf.fill(0)
+      buf.writeUInt32LE(1, 0)
+      var br = new BufferReader(buf)
+      br.readUInt64LEBN().toNumber().should.equal(1)
+    })
+
+    it('should return 10 BSV', function () {
+      var tenbsv = 10 * 1e8
+      var tenbsvBuffer = Buffer.from('00ca9a3b00000000', 'hex')
+      var br = new BufferReader(tenbsvBuffer)
+      br.readUInt64LEBN().toNumber().should.equal(tenbsv)
+    })
+
+    it('should return 2^30', function () {
+      var buf = Buffer.alloc(8)
+      buf.fill(0)
+      buf.writeUInt32LE(Math.pow(2, 30), 0)
+      var br = new BufferReader(buf)
+      br.readUInt64LEBN().toNumber().should.equal(Math.pow(2, 30))
+    })
+
+    it('should return 2^32 + 1', function () {
+      var num = Math.pow(2, 32) + 1
+      var numBuffer = Buffer.from('0100000001000000', 'hex')
+      var br = new BufferReader(numBuffer)
+      br.readUInt64LEBN().toNumber().should.equal(num)
+    })
+
+    it('should return max number of satoshis', function () {
+      var maxSatoshis = 21000000 * 1e8
+      var maxSatoshisBuffer = Buffer.from('0040075af0750700', 'hex')
+      var br = new BufferReader(maxSatoshisBuffer)
+      br.readUInt64LEBN().toNumber().should.equal(maxSatoshis)
+    })
+
+    it('should return 2^53 - 1', function () {
+      var maxSafe = Math.pow(2, 53) - 1
+      var maxSafeBuffer = Buffer.from('ffffffffffff1f00', 'hex')
+      var br = new BufferReader(maxSafeBuffer)
+      br.readUInt64LEBN().toNumber().should.equal(maxSafe)
+    })
+
+    it('should return 2^53', function () {
+      var bn = new BN('20000000000000', 16)
+      var bnBuffer = Buffer.from('0000000000002000', 'hex')
+      var br = new BufferReader(bnBuffer)
+      var readbn = br.readUInt64LEBN()
+      readbn.cmp(bn).should.equal(0)
+    })
+
+    it('should return 0', function () {
+      var buf = Buffer.alloc(8)
+      buf.fill(0)
+      var br = new BufferReader(buf)
+      br.readUInt64LEBN().toNumber().should.equal(0)
+    })
+
+    it('should return 2^64', function () {
+      var buf = Buffer.alloc(8)
+      buf.fill(0xff)
+      var br = new BufferReader(buf)
+      br.readUInt64LEBN().toNumber().should.equal(Math.pow(2, 64))
+    })
+  })
+
+  describe('#readVarintBuf', function () {
+    it('should read a 1 byte varint', function () {
+      var buf = Buffer.from([50])
+      var br = new BufferReader(buf)
+      br.readVarintBuf().length.should.equal(1)
+    })
+
+    it('should read a 3 byte varint', function () {
+      var buf = Buffer.from([253, 253, 0])
+      var br = new BufferReader(buf)
+      br.readVarintBuf().length.should.equal(3)
+    })
+
+    it('should read a 5 byte varint', function () {
+      var buf = Buffer.from([254, 0, 0, 0, 0])
+      buf.writeUInt32LE(50000, 1)
+      var br = new BufferReader(buf)
+      br.readVarintBuf().length.should.equal(5)
+    })
+
+    it('should read a 9 byte varint', function () {
+      var buf = BufferWriter().writeVarintBN(new BN(Math.pow(2, 54).toString())).concat()
+      var br = new BufferReader(buf)
+      br.readVarintBuf().length.should.equal(9)
+    })
+  })
+
+  describe('#readVarintNum', function () {
+    it('should read a 1 byte varint', function () {
+      var buf = Buffer.from([50])
+      var br = new BufferReader(buf)
+      br.readVarintNum().should.equal(50)
+    })
+
+    it('should read a 3 byte varint', function () {
+      var buf = Buffer.from([253, 253, 0])
+      var br = new BufferReader(buf)
+      br.readVarintNum().should.equal(253)
+    })
+
+    it('should read a 5 byte varint', function () {
+      var buf = Buffer.from([254, 0, 0, 0, 0])
+      buf.writeUInt32LE(50000, 1)
+      var br = new BufferReader(buf)
+      br.readVarintNum().should.equal(50000)
+    })
+
+    it('should throw an error on a 9 byte varint over the javascript uint precision limit', function () {
+      var buf = BufferWriter().writeVarintBN(new BN(Math.pow(2, 54).toString())).concat()
+      var br = new BufferReader(buf);
+      (function () {
+        br.readVarintNum()
+      }).should.throw('number too large to retain precision - use readVarintBN')
+    })
+
+    it('should not throw an error on a 9 byte varint not over the javascript uint precision limit', function () {
+      var buf = BufferWriter().writeVarintBN(new BN(Math.pow(2, 53).toString())).concat()
+      var br = new BufferReader(buf);
+      (function () {
+        br.readVarintNum()
+      }).should.not.throw('number too large to retain precision - use readVarintBN')
+    })
+  })
+
+  describe('#readVarintBN', function () {
+    it('should read a 1 byte varint', function () {
+      var buf = Buffer.from([50])
+      var br = new BufferReader(buf)
+      br.readVarintBN().toNumber().should.equal(50)
+    })
+
+    it('should read a 3 byte varint', function () {
+      var buf = Buffer.from([253, 253, 0])
+      var br = new BufferReader(buf)
+      br.readVarintBN().toNumber().should.equal(253)
+    })
+
+    it('should read a 5 byte varint', function () {
+      var buf = Buffer.from([254, 0, 0, 0, 0])
+      buf.writeUInt32LE(50000, 1)
+      var br = new BufferReader(buf)
+      br.readVarintBN().toNumber().should.equal(50000)
+    })
+
+    it('should read a 9 byte varint', function () {
+      var buf = Buffer.concat([Buffer.from([255]), Buffer.from('ffffffffffffffff', 'hex')])
+      var br = new BufferReader(buf)
+      br.readVarintBN().toNumber().should.equal(Math.pow(2, 64))
+    })
+  })
+
+  describe('#reverse', function () {
+    it('should reverse this [0, 1]', function () {
+      var buf = Buffer.from([0, 1])
+      var br = new BufferReader(buf)
+      br.reverse().readAll().toString('hex').should.equal('0100')
+    })
+  })
+})

package/test/encoding/bufferwriter.js

@@ -0,0 +1,160 @@
+'use strict'
+
+var bsv = require('../..')
+var should = require('chai').should()
+var BufferWriter = bsv.encoding.BufferWriter
+var BufferReader = bsv.encoding.BufferReader
+var BN = bsv.crypto.BN
+
+describe('BufferWriter', function () {
+  it('should create a new buffer writer', function () {
+    var bw = new BufferWriter()
+    should.exist(bw)
+  })
+
+  describe('#set', function () {
+    it('set bufs', function () {
+      var buf1 = Buffer.from([0])
+      var buf2 = Buffer.from([1])
+      var bw = new BufferWriter().set({ bufs: [buf1, buf2] })
+      bw.concat().toString('hex').should.equal('0001')
+    })
+  })
+
+  describe('#toBuffer', function () {
+    it('should concat these two bufs', function () {
+      var buf1 = Buffer.from([0])
+      var buf2 = Buffer.from([1])
+      var bw = new BufferWriter({ bufs: [buf1, buf2] })
+      bw.toBuffer().toString('hex').should.equal('0001')
+    })
+  })
+
+  describe('#concat', function () {
+    it('should concat these two bufs', function () {
+      var buf1 = Buffer.from([0])
+      var buf2 = Buffer.from([1])
+      var bw = new BufferWriter({ bufs: [buf1, buf2] })
+      bw.concat().toString('hex').should.equal('0001')
+    })
+  })
+
+  describe('#write', function () {
+    it('should write a buffer', function () {
+      var buf = Buffer.from([0])
+      var bw = new BufferWriter()
+      bw.write(buf)
+      bw.concat().toString('hex').should.equal('00')
+    })
+  })
+
+  describe('#writeUInt8', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt8(1).concat().toString('hex').should.equal('01')
+    })
+  })
+
+  describe('#writeUInt16BE', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt16BE(1).concat().toString('hex').should.equal('0001')
+    })
+  })
+
+  describe('#writeUInt16LE', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt16LE(1).concat().toString('hex').should.equal('0100')
+    })
+  })
+
+  describe('#writeUInt32BE', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt32BE(1).concat().toString('hex').should.equal('00000001')
+    })
+  })
+
+  describe('#writeUInt32LE', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt32LE(1).concat().toString('hex').should.equal('01000000')
+    })
+  })
+
+  describe('#writeUInt64BEBN', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt64BEBN(new BN(1)).concat().toString('hex').should.equal('0000000000000001')
+    })
+  })
+
+  describe('#writeUInt64LEBN', function () {
+    it('should write 1', function () {
+      var bw = new BufferWriter()
+      bw.writeUInt64LEBN(new BN(1)).concat().toString('hex').should.equal('0100000000000000')
+    })
+  })
+
+  describe('#writeVarint', function () {
+    it('should write a 1 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintNum(1)
+      bw.concat().length.should.equal(1)
+    })
+
+    it('should write a 3 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintNum(1000)
+      bw.concat().length.should.equal(3)
+    })
+
+    it('should write a 5 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintNum(Math.pow(2, 16 + 1))
+      bw.concat().length.should.equal(5)
+    })
+
+    it('should write a 9 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintNum(Math.pow(2, 32 + 1))
+      bw.concat().length.should.equal(9)
+    })
+
+    it('should read back the same value it wrote for a 9 byte varint', function () {
+      var bw = new BufferWriter()
+      var n = Math.pow(2, 53)
+      n.should.equal(n + 1) // javascript number precision limit
+      bw.writeVarintNum(n)
+      var br = new BufferReader({ buf: bw.concat() })
+      br.readVarintBN().toNumber().should.equal(n)
+    })
+  })
+
+  describe('#writeVarintBN', function () {
+    it('should write a 1 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintBN(new BN(1))
+      bw.concat().length.should.equal(1)
+    })
+
+    it('should write a 3 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintBN(new BN(1000))
+      bw.concat().length.should.equal(3)
+    })
+
+    it('should write a 5 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintBN(new BN(Math.pow(2, 16 + 1)))
+      bw.concat().length.should.equal(5)
+    })
+
+    it('should write a 9 byte varint', function () {
+      var bw = new BufferWriter()
+      bw.writeVarintBN(new BN(Math.pow(2, 32 + 1)))
+      bw.concat().length.should.equal(9)
+    })
+  })
+})