@ipld/car 3.2.4 → 4.0.0

package/README.md

@@ -240,6 +240,12 @@ be directly fed to a
  * [`async CarWriter.createAppender()`](#CarWriter__createAppender)
  * [`async CarWriter.updateRootsInBytes(bytes, roots)`](#CarWriter__updateRootsInBytes)
  * [`async CarWriter.updateRootsInFile(fd, roots)`](#CarWriter__updateRootsInFile)
+ * [`async decoder.readHeader(reader)`](#async__decoder__readHeader__reader__)
+ * [`async decoder.readBlockHead(reader)`](#async__decoder__readBlockHead__reader__)
+ * [`decoder.createDecoder(reader)`](#decoder__createDecoder__reader__)
+ * [`decoder.bytesReader(bytes)`](#decoder__bytesReader__bytes__)
+ * [`decoder.asyncIterableReader(asyncIterable)`](#decoder__asyncIterableReader__asyncIterable__)
+ * [`decoder.limitReader(reader, byteLimit)`](#decoder__limitReader__reader____byteLimit__)
 
 <a name="CarReader"></a>
 ### `class CarReader`
@@ -247,7 +253,7 @@ be directly fed to a
 Properties:
 
 * `version` `(number)`: The version number of the CAR referenced by this
-  reader (should be `1`).
+  reader (should be `1` or `2`).
 
 Provides blockstore-like access to a CAR.
 
@@ -748,7 +754,8 @@ upon successful modification.
 
 Update the list of roots in the header of an existing CAR file. The first
 argument must be a file descriptor for CAR file that is open in read and
-write mode (not append).
+write mode (not append), e.g. `fs.open` or `fs.promises.open` with `'r+'`
+mode.
 
 This operation is an _overwrite_, the total length of the CAR will not be
 modified. A rejection will occur if the new header will not be the same
@@ -759,6 +766,71 @@ replaced encode as the same length as the new roots.
 This function is **only available in Node.js** and not a browser
 environment.
 
+<a name="async__decoder__readHeader__reader__"></a>
+### `async decoder.readHeader(reader)`
+
+* `reader` `(BytesReader)`
+* `strictVersion` `(number, optional)`
+
+* Returns:  `Promise<(CarHeader|CarV2Header)>`
+
+Reads header data from a `BytesReader`. The header may either be in the form
+of a `CarHeader` or `CarV2Header` depending on the CAR being read.
+
+<a name="async__decoder__readBlockHead__reader__"></a>
+### `async decoder.readBlockHead(reader)`
+
+* `reader` `(BytesReader)`
+
+* Returns:  `Promise<BlockHeader>`
+
+Reads the leading data of an individual block from CAR data from a
+`BytesReader`. Returns a `BlockHeader` object which contains
+`{ cid, length, blockLength }` which can be used to either index the block
+or read the block binary data.
+
+<a name="decoder__createDecoder__reader__"></a>
+### `decoder.createDecoder(reader)`
+
+* `reader` `(BytesReader)`
+
+* Returns:  `CarDecoder`
+
+Creates a `CarDecoder` from a `BytesReader`. The `CarDecoder` is as async
+interface that will consume the bytes from the `BytesReader` to yield a
+`header()` and either `blocks()` or `blocksIndex()` data.
+
+<a name="decoder__bytesReader__bytes__"></a>
+### `decoder.bytesReader(bytes)`
+
+* `bytes` `(Uint8Array)`
+
+* Returns:  `BytesReader`
+
+Creates a `BytesReader` from a `Uint8Array`.
+
+<a name="decoder__asyncIterableReader__asyncIterable__"></a>
+### `decoder.asyncIterableReader(asyncIterable)`
+
+* `asyncIterable` `(AsyncIterable<Uint8Array>)`
+
+* Returns:  `BytesReader`
+
+Creates a `BytesReader` from an `AsyncIterable<Uint8Array>`, which allows for
+consumption of CAR data from a streaming source.
+
+<a name="decoder__limitReader__reader____byteLimit__"></a>
+### `decoder.limitReader(reader, byteLimit)`
+
+* `reader` `(BytesReader)`
+* `byteLimit` `(number)`
+
+* Returns:  `BytesReader`
+
+Wraps a `BytesReader` in a limiting `BytesReader` which limits maximum read
+to `byteLimit` bytes. It _does not_ update `pos` of the original
+`BytesReader`.
+
 ## License
 
 Licensed under either of

package/cjs/browser-test/common.js

@@ -214,12 +214,87 @@ const goCarIndex = [
     blockLength: 18
   }
 ];
+const goCarV2Bytes = multiformats.bytes.fromHex('0aa16776657273696f6e02000000000000000000000000000000003300000000000000c001000000000000f30100000000000038a265726f6f747381d82a5823001220fb16f5083412ef1371d031ed4aa239903d84efdadf1ba3cd678e6475b1a232f86776657273696f6e01511220fb16f5083412ef1371d031ed4aa239903d84efdadf1ba3cd678e6475b1a232f8122d0a221220d9c0d5376d26f1931f7ad52d7acc00fc1090d2edb0808bf61eeb0a152826f6261204f09f8da418a40185011220d9c0d5376d26f1931f7ad52d7acc00fc1090d2edb0808bf61eeb0a152826f62612310a221220d745b7757f5b4593eeab7820306c7bc64eb496a7410a0d07df7a34ffec4b97f1120962617272656c657965183a122e0a2401551220a2e1c40da1ae335d4dffe729eb4d5ca23b74b9e51fc535f4a804a261080c294d1204f09f90a11807581220d745b7757f5b4593eeab7820306c7bc64eb496a7410a0d07df7a34ffec4b97f112340a2401551220b474a99a2705e23cf905a484ec6d14ef58b56bbe62e9292783466ec363b5072d120a666973686d6f6e67657218042801551220b474a99a2705e23cf905a484ec6d14ef58b56bbe62e9292783466ec363b5072d666973682b01551220a2e1c40da1ae335d4dffe729eb4d5ca23b74b9e51fc535f4a804a261080c294d6c6f62737465720100000028000000c800000000000000a2e1c40da1ae335d4dffe729eb4d5ca23b74b9e51fc535f4a804a261080c294d9401000000000000b474a99a2705e23cf905a484ec6d14ef58b56bbe62e9292783466ec363b5072d6b01000000000000d745b7757f5b4593eeab7820306c7bc64eb496a7410a0d07df7a34ffec4b97f11201000000000000d9c0d5376d26f1931f7ad52d7acc00fc1090d2edb0808bf61eeb0a152826f6268b00000000000000fb16f5083412ef1371d031ed4aa239903d84efdadf1ba3cd678e6475b1a232f83900000000000000');
+const goCarV2Roots = [multiformats.CID.parse('QmfEoLyB5NndqeKieExd1rtJzTduQUPEV8TwAYcUiy3H5Z')];
+const goCarV2Index = [
+  {
+    blockLength: 47,
+    blockOffset: 143,
+    cid: multiformats.CID.parse('QmfEoLyB5NndqeKieExd1rtJzTduQUPEV8TwAYcUiy3H5Z'),
+    length: 82,
+    offset: 108
+  },
+  {
+    blockLength: 99,
+    blockOffset: 226,
+    cid: multiformats.CID.parse('QmczfirA7VEH7YVvKPTPoU69XM3qY4DC39nnTsWd4K3SkM'),
+    length: 135,
+    offset: 190
+  },
+  {
+    blockLength: 54,
+    blockOffset: 360,
+    cid: multiformats.CID.parse('Qmcpz2FHJD7VAhg1fxFXdYJKePtkx1BsHuCrAgWVnaHMTE'),
+    length: 89,
+    offset: 325
+  },
+  {
+    blockLength: 4,
+    blockOffset: 451,
+    cid: multiformats.CID.parse('bafkreifuosuzujyf4i6psbneqtwg2fhplc2wxptc5euspa2gn3bwhnihfu'),
+    length: 41,
+    offset: 414
+  },
+  {
+    blockLength: 7,
+    blockOffset: 492,
+    cid: multiformats.CID.parse('bafkreifc4hca3inognou377hfhvu2xfchn2ltzi7yu27jkaeujqqqdbjju'),
+    length: 44,
+    offset: 455
+  }
+];
+const goCarV2Contents = {
+  QmfEoLyB5NndqeKieExd1rtJzTduQUPEV8TwAYcUiy3H5Z: {
+    Links: [{
+        Hash: multiformats.CID.parse('QmczfirA7VEH7YVvKPTPoU69XM3qY4DC39nnTsWd4K3SkM'),
+        Name: '\uD83C\uDF64',
+        Tsize: 164
+      }]
+  },
+  QmczfirA7VEH7YVvKPTPoU69XM3qY4DC39nnTsWd4K3SkM: {
+    Links: [
+      {
+        Hash: multiformats.CID.parse('Qmcpz2FHJD7VAhg1fxFXdYJKePtkx1BsHuCrAgWVnaHMTE'),
+        Name: 'barreleye',
+        Tsize: 58
+      },
+      {
+        Hash: multiformats.CID.parse('bafkreifc4hca3inognou377hfhvu2xfchn2ltzi7yu27jkaeujqqqdbjju'),
+        Name: '\uD83D\uDC21',
+        Tsize: 7
+      }
+    ]
+  },
+  Qmcpz2FHJD7VAhg1fxFXdYJKePtkx1BsHuCrAgWVnaHMTE: {
+    Links: [{
+        Hash: multiformats.CID.parse('bafkreifuosuzujyf4i6psbneqtwg2fhplc2wxptc5euspa2gn3bwhnihfu'),
+        Name: 'fishmonger',
+        Tsize: 4
+      }]
+  },
+  bafkreifuosuzujyf4i6psbneqtwg2fhplc2wxptc5euspa2gn3bwhnihfu: 'fish',
+  bafkreifc4hca3inognou377hfhvu2xfchn2ltzi7yu27jkaeujqqqdbjju: 'lobster'
+};
 
 exports.assert = assert;
 exports.carBytes = carBytes;
 exports.goCarBytes = goCarBytes;
 exports.goCarIndex = goCarIndex;
 exports.goCarRoots = goCarRoots;
+exports.goCarV2Bytes = goCarV2Bytes;
+exports.goCarV2Contents = goCarV2Contents;
+exports.goCarV2Index = goCarV2Index;
+exports.goCarV2Roots = goCarV2Roots;
 exports.makeData = makeData;
 exports.makeIterable = makeIterable;
 exports.rndCid = rndCid;

package/cjs/browser-test/test-errors.js

@@ -26,42 +26,65 @@ describe('Misc errors', () => {
     });
   });
   it('bad version', async () => {
-    const buf2 = multiformats.bytes.fromHex('0aa16776657273696f6e02');
-    common.assert.strictEqual(multiformats.bytes.toHex(makeHeader({ version: 2 })), '0aa16776657273696f6e02');
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 2');
+    const buf2 = multiformats.bytes.fromHex('0aa16776657273696f6e03');
+    common.assert.strictEqual(multiformats.bytes.toHex(makeHeader({ version: 3 })), '0aa16776657273696f6e03');
+    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 3');
   });
-  it('bad header', async () => {
-    let buf2 = makeHeader({
-      version: 1,
-      roots: []
+  describe('bad header', async () => {
+    it('sanity check', async () => {
+      const buf2 = makeHeader({
+        version: 1,
+        roots: []
+      });
+      await common.assert.isFulfilled(readerBrowser.CarReader.fromBytes(buf2));
     });
-    await common.assert.isFulfilled(readerBrowser.CarReader.fromBytes(buf2));
-    buf2 = makeHeader({ roots: [] });
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR version: undefined');
-    buf2 = makeHeader({
-      version: '1',
-      roots: []
+    it('no \'version\' array', async () => {
+      const buf2 = makeHeader({ roots: [] });
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
     });
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR version: "1"');
-    buf2 = makeHeader({ version: 1 });
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    buf2 = makeHeader({
-      version: 1,
-      roots: {}
+    it('bad \'version\' type', async () => {
+      const buf2 = makeHeader({
+        version: '1',
+        roots: []
+      });
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
     });
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    buf2 = makeHeader({
-      version: 1,
-      roots: [],
-      blip: true
+    it('no \'roots\' array', async () => {
+      const buf2 = makeHeader({ version: 1 });
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('bad \'roots\' type', async () => {
+      const buf2 = makeHeader({
+        version: 1,
+        roots: {}
+      });
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('extraneous properties', async () => {
+      const buf2 = makeHeader({
+        version: 1,
+        roots: [],
+        blip: true
+      });
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('not an object', async () => {
+      const buf2 = makeHeader([
+        1,
+        []
+      ]);
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('not an object', async () => {
+      const buf2 = makeHeader(null);
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('recursive v2 header', async () => {
+      const v2Header = common.goCarV2Bytes.slice(0, 51);
+      const buf2 = new Uint8Array(51 * 2);
+      buf2.set(v2Header, 0);
+      buf2.set(v2Header, 51);
+      await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 2 (expected 1)');
     });
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    buf2 = makeHeader([
-      1,
-      []
-    ]);
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    buf2 = makeHeader(null);
-    await common.assert.isRejected(readerBrowser.CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
   });
 });

package/cjs/browser-test/test-indexer.js

@@ -15,6 +15,18 @@ describe('CarIndexer fromBytes()', () => {
     }
     common.assert.deepStrictEqual(indexData, common.goCarIndex);
   });
+  it('v2 complete', async () => {
+    const indexer$1 = await indexer.CarIndexer.fromBytes(common.goCarV2Bytes);
+    const roots = await indexer$1.getRoots();
+    common.assert.strictEqual(roots.length, 1);
+    common.assert(common.goCarV2Roots[0].equals(roots[0]));
+    common.assert.strictEqual(indexer$1.version, 2);
+    const indexData = [];
+    for await (const index of indexer$1) {
+      indexData.push(index);
+    }
+    common.assert.deepStrictEqual(indexData, common.goCarV2Index);
+  });
   it('bad argument', async () => {
     for (const arg of [
         true,

package/cjs/browser-test/test-reader.js

@@ -2,11 +2,16 @@
 
 var readerBrowser = require('../lib/reader-browser.js');
 var writerBrowser = require('../lib/writer-browser.js');
+var decoder = require('../lib/decoder.js');
 var Block = require('multiformats/block');
 var sha2 = require('multiformats/hashes/sha2');
 var raw = require('multiformats/codecs/raw');
+var base64 = require('multiformats/bases/base64');
+var dagPb = require('@ipld/dag-pb');
 var common = require('./common.js');
 var verifyStoreReader = require('./verify-store-reader.js');
+var fixtures = require('./fixtures.js');
+var fixturesExpectations = require('./fixtures-expectations.js');
 
 function _interopNamespace(e) {
   if (e && e.__esModule) return e;
@@ -28,6 +33,7 @@ function _interopNamespace(e) {
 
 var Block__namespace = /*#__PURE__*/_interopNamespace(Block);
 var raw__namespace = /*#__PURE__*/_interopNamespace(raw);
+var dagPb__namespace = /*#__PURE__*/_interopNamespace(dagPb);
 
 describe('CarReader fromBytes()', () => {
   it('complete', async () => {
@@ -66,6 +72,29 @@ describe('CarReader fromBytes()', () => {
       message: 'Unexpected end of data'
     });
   });
+  it('v2 complete', async () => {
+    const reader = await readerBrowser.CarReader.fromBytes(common.goCarV2Bytes);
+    const roots = await reader.getRoots();
+    common.assert.strictEqual(roots.length, 1);
+    common.assert(common.goCarV2Roots[0].equals(roots[0]));
+    common.assert.strictEqual(reader.version, 2);
+    for (const {cid} of common.goCarV2Index) {
+      const block = await reader.get(cid);
+      common.assert.isDefined(block);
+      if (block) {
+        common.assert(cid.equals(block.cid));
+        let content;
+        if (cid.code === dagPb__namespace.code) {
+          content = dagPb__namespace.decode(block.bytes);
+        } else if (cid.code === 85) {
+          content = new TextDecoder().decode(block.bytes);
+        } else {
+          common.assert.fail('Unexpected codec');
+        }
+        common.assert.deepStrictEqual(content, common.goCarV2Contents[cid.toString()]);
+      }
+    }
+  });
   it('decode error - trailing null bytes', async () => {
     const bytes = new Uint8Array(common.carBytes.length + 5);
     bytes.set(common.carBytes);
@@ -192,4 +221,58 @@ describe('CarReader fromIterable()', () => {
       message: 'Unexpected end of data'
     });
   });
+  it('v2 decode error - truncated', async () => {
+    const bytes = common.goCarV2Bytes.slice();
+    const dv = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+    dv.setBigUint64(35, BigInt(448 - 10), true);
+    await common.assert.isRejected(readerBrowser.CarReader.fromIterable(common.makeIterable(bytes, 64)), {
+      name: 'Error',
+      message: 'Unexpected end of data'
+    });
+  });
+});
+describe('Shared fixtures', () => {
+  describe('Header', () => {
+    for (const [name, {
+            version: expectedVersion,
+            err: expectedError
+          }] of Object.entries(fixturesExpectations.expectations)) {
+      it(name, async () => {
+        const data = base64.base64.baseDecode(fixtures.data[name]);
+        let header;
+        try {
+          header = await decoder.readHeader(decoder.bytesReader(data));
+        } catch (err) {
+          if (expectedError != null) {
+            common.assert.equal(err.message, expectedError);
+            return;
+          }
+          common.assert.ifError(err);
+        }
+        if (expectedError != null) {
+          common.assert.fail(`Expected error: ${ expectedError }`);
+        }
+        common.assert.isDefined(header, 'did not decode header');
+        if (expectedVersion != null && header != null) {
+          common.assert.strictEqual(header.version, expectedVersion);
+        }
+      });
+    }
+  });
+  describe('Contents', () => {
+    for (const [name, {cids: expectedCids}] of Object.entries(fixturesExpectations.expectations)) {
+      if (expectedCids == null) {
+        continue;
+      }
+      it(name, async () => {
+        const data = base64.base64.baseDecode(fixtures.data[name]);
+        const reader = await readerBrowser.CarReader.fromBytes(data);
+        let i = 0;
+        for await (const cid of reader.cids()) {
+          common.assert.strictEqual(cid.toString(), expectedCids[i++]);
+        }
+        common.assert.strictEqual(i, expectedCids.length);
+      });
+    }
+  });
 });

package/cjs/lib/decoder.js

@@ -6,6 +6,7 @@ var varint = require('varint');
 var cid = require('multiformats/cid');
 var Digest = require('multiformats/hashes/digest');
 var dagCbor = require('@ipld/dag-cbor');
+var headerValidator = require('./header-validator.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -35,13 +36,34 @@ const CIDV0_BYTES = {
   LENGTH: 32,
   DAG_PB: 112
 };
+const V2_HEADER_LENGTH = 16 + 8 + 8 + 8;
 async function readVarint(reader) {
   const bytes = await reader.upTo(8);
+  if (!bytes.length) {
+    throw new Error('Unexpected end of data');
+  }
   const i = varint__default["default"].decode(bytes);
   reader.seek(varint__default["default"].decode.bytes);
   return i;
 }
-async function readHeader(reader) {
+async function readV2Header(reader) {
+  const bytes = await reader.exactly(V2_HEADER_LENGTH);
+  const dv = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+  let offset = 0;
+  const header = {
+    version: 2,
+    characteristics: [
+      dv.getBigUint64(offset, true),
+      dv.getBigUint64(offset += 8, true)
+    ],
+    dataOffset: Number(dv.getBigUint64(offset += 8, true)),
+    dataSize: Number(dv.getBigUint64(offset += 8, true)),
+    indexOffset: Number(dv.getBigUint64(offset += 8, true))
+  };
+  reader.seek(V2_HEADER_LENGTH);
+  return header;
+}
+async function readHeader(reader, strictVersion) {
   const length = await readVarint(reader);
   if (length === 0) {
     throw new Error('Invalid CAR header (zero length)');
@@ -49,22 +71,23 @@ async function readHeader(reader) {
   const header = await reader.exactly(length);
   reader.seek(length);
   const block = dagCbor.decode(header);
-  if (block == null || Array.isArray(block) || typeof block !== 'object') {
+  if (!headerValidator.CarHeader(block)) {
     throw new Error('Invalid CAR header format');
   }
-  if (block.version !== 1) {
-    if (typeof block.version === 'string') {
-      throw new Error(`Invalid CAR version: "${ block.version }"`);
-    }
-    throw new Error(`Invalid CAR version: ${ block.version }`);
+  if (block.version !== 1 && block.version !== 2 || strictVersion !== undefined && block.version !== strictVersion) {
+    throw new Error(`Invalid CAR version: ${ block.version }${ strictVersion !== undefined ? ` (expected ${ strictVersion })` : '' }`);
   }
-  if (!Array.isArray(block.roots)) {
+  const hasRoots = Array.isArray(block.roots);
+  if (block.version === 1 && !hasRoots || block.version === 2 && hasRoots) {
     throw new Error('Invalid CAR header format');
   }
-  if (Object.keys(block).filter(p => p !== 'roots' && p !== 'version').length) {
-    throw new Error('Invalid CAR header format');
+  if (block.version === 1) {
+    return block;
   }
-  return block;
+  const v2Header = await readV2Header(reader);
+  reader.seek(v2Header.dataOffset - reader.pos);
+  const v1Header = await readHeader(reader, 1);
+  return Object.assign(v1Header, v2Header);
 }
 async function readMultihash(reader) {
   const bytes = await reader.upTo(8);
@@ -102,7 +125,7 @@ async function readBlockHead(reader) {
   }
   length += reader.pos - start;
   const cid = await readCid(reader);
-  const blockLength = length - (reader.pos - start);
+  const blockLength = length - Number(reader.pos - start);
   return {
     cid,
     length,
@@ -132,7 +155,14 @@ async function readBlockIndex(reader) {
   return index;
 }
 function createDecoder(reader) {
-  const headerPromise = readHeader(reader);
+  const headerPromise = (async () => {
+    const header = await readHeader(reader);
+    if (header.version === 2) {
+      const v1length = reader.pos - header.dataOffset;
+      reader = limitReader(reader, header.dataSize - v1length);
+    }
+    return header;
+  })();
   return {
     header: () => headerPromise,
     async *blocks() {
@@ -235,10 +265,37 @@ function asyncIterableReader(asyncIterable) {
   }
   return chunkReader(readChunk);
 }
+function limitReader(reader, byteLimit) {
+  let bytesRead = 0;
+  return {
+    async upTo(length) {
+      let bytes = await reader.upTo(length);
+      if (bytes.length + bytesRead > byteLimit) {
+        bytes = bytes.subarray(0, byteLimit - bytesRead);
+      }
+      return bytes;
+    },
+    async exactly(length) {
+      const bytes = await reader.exactly(length);
+      if (bytes.length + bytesRead > byteLimit) {
+        throw new Error('Unexpected end of data');
+      }
+      return bytes;
+    },
+    seek(length) {
+      bytesRead += length;
+      reader.seek(length);
+    },
+    get pos() {
+      return reader.pos;
+    }
+  };
+}
 
 exports.asyncIterableReader = asyncIterableReader;
 exports.bytesReader = bytesReader;
 exports.chunkReader = chunkReader;
 exports.createDecoder = createDecoder;
+exports.limitReader = limitReader;
 exports.readBlockHead = readBlockHead;
 exports.readHeader = readHeader;

package/cjs/lib/header-validator.js

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const Kinds = {
+  Null: obj => obj === null,
+  Int: obj => Number.isInteger(obj),
+  Float: obj => typeof obj === 'number' && Number.isFinite(obj),
+  String: obj => typeof obj === 'string',
+  Bool: obj => typeof obj === 'boolean',
+  Bytes: obj => obj instanceof Uint8Array,
+  Link: obj => !Kinds.Null(obj) && typeof obj === 'object' && obj.asCID === obj,
+  List: obj => Array.isArray(obj),
+  Map: obj => !Kinds.Null(obj) && typeof obj === 'object' && obj.asCID !== obj && !Kinds.List(obj) && !Kinds.Bytes(obj)
+};
+const Types = {
+  Int: Kinds.Int,
+  'CarHeader > version': obj => Types.Int(obj),
+  'CarHeader > roots (anon) > valueType (anon)': Kinds.Link,
+  'CarHeader > roots (anon)': obj => Kinds.List(obj) && Array.prototype.every.call(obj, Types['CarHeader > roots (anon) > valueType (anon)']),
+  'CarHeader > roots': obj => Types['CarHeader > roots (anon)'](obj),
+  CarHeader: obj => {
+    const keys = obj && Object.keys(obj);
+    return Kinds.Map(obj) && ['version'].every(k => keys.includes(k)) && Object.entries(obj).every(([name, value]) => Types['CarHeader > ' + name] && Types['CarHeader > ' + name](value));
+  }
+};
+const CarHeader = Types.CarHeader;
+
+exports.CarHeader = CarHeader;

package/cjs/lib/reader-browser.js

@@ -5,17 +5,16 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var decoder = require('./decoder.js');
 
 class CarReader {
-  constructor(version, roots, blocks) {
-    this._version = version;
-    this._roots = roots;
+  constructor(header, blocks) {
+    this._header = header;
     this._blocks = blocks;
     this._keys = blocks.map(b => b.cid.toString());
   }
   get version() {
-    return this._version;
+    return this._header.version;
   }
   async getRoots() {
-    return this._roots;
+    return this._header.roots;
   }
   async has(key) {
     return this._keys.indexOf(key.toString()) > -1;
@@ -49,14 +48,15 @@ class CarReader {
 }
 async function decodeReaderComplete(reader) {
   const decoder$1 = decoder.createDecoder(reader);
-  const {version, roots} = await decoder$1.header();
+  const header = await decoder$1.header();
   const blocks = [];
   for await (const block of decoder$1.blocks()) {
     blocks.push(block);
   }
-  return new CarReader(version, roots, blocks);
+  return new CarReader(header, blocks);
 }
 const __browser = true;
 
 exports.CarReader = CarReader;
 exports.__browser = __browser;
+exports.decodeReaderComplete = decodeReaderComplete;

package/cjs/lib/writer-browser.js

@@ -62,7 +62,7 @@ class CarWriter {
     const reader = decoder.bytesReader(bytes);
     await decoder.readHeader(reader);
     const newHeader = encoder.createHeader(roots);
-    if (reader.pos !== newHeader.length) {
+    if (Number(reader.pos) !== newHeader.length) {
       throw new Error(`updateRoots() can only overwrite a header of the same length (old header is ${ reader.pos } bytes, new header is ${ newHeader.length } bytes)`);
     }
     bytes.set(newHeader, 0);