@ipld/car 3.2.2 → 4.0.0

package/esm/lib/decoder.js

@@ -2,18 +2,40 @@ import varint from 'varint';
 import { CID } from 'multiformats/cid';
 import * as Digest from 'multiformats/hashes/digest';
 import { decode as decodeDagCbor } from '@ipld/dag-cbor';
+import { CarHeader as headerValidator } from './header-validator.js';
 const CIDV0_BYTES = {
   SHA2_256: 18,
   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.decode(bytes);
   reader.seek(varint.decode.bytes);
   return i;
 }
-export 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;
+}
+export async function readHeader(reader, strictVersion) {
   const length = await readVarint(reader);
   if (length === 0) {
     throw new Error('Invalid CAR header (zero length)');
@@ -21,22 +43,23 @@ export async function readHeader(reader) {
   const header = await reader.exactly(length);
   reader.seek(length);
   const block = decodeDagCbor(header);
-  if (block == null || Array.isArray(block) || typeof block !== 'object') {
+  if (!headerValidator(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);
@@ -74,7 +97,7 @@ export 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,
@@ -104,7 +127,14 @@ async function readBlockIndex(reader) {
   return index;
 }
 export 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() {
@@ -206,4 +236,30 @@ export function asyncIterableReader(asyncIterable) {
     return next.value;
   }
   return chunkReader(readChunk);
+}
+export 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;
+    }
+  };
 }

package/esm/lib/header-validator.js

@@ -0,0 +1,23 @@
+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));
+  }
+};
+export const CarHeader = Types.CarHeader;

package/esm/lib/reader-browser.js

@@ -4,17 +4,16 @@ import {
   createDecoder
 } from './decoder.js';
 export 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;
@@ -46,13 +45,13 @@ export class CarReader {
     return decodeReaderComplete(asyncIterableReader(asyncIterable));
   }
 }
-async function decodeReaderComplete(reader) {
+export async function decodeReaderComplete(reader) {
   const decoder = createDecoder(reader);
-  const {version, roots} = await decoder.header();
+  const header = await decoder.header();
   const blocks = [];
   for await (const block of decoder.blocks()) {
     blocks.push(block);
   }
-  return new CarReader(version, roots, blocks);
+  return new CarReader(header, blocks);
 }
 export const __browser = true;

package/esm/lib/writer-browser.js

@@ -63,7 +63,7 @@ export class CarWriter {
     const reader = bytesReader(bytes);
     await readHeader(reader);
     const newHeader = 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);

package/esm/node-test/common.js

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

package/esm/node-test/test-errors.js

@@ -4,7 +4,8 @@ import { encode as vEncode } from 'varint';
 import { CarReader } from '../lib/reader.js';
 import {
   carBytes,
-  assert
+  assert,
+  goCarV2Bytes
 } from './common.js';
 function makeHeader(block) {
   const u = cbEncode(block);
@@ -26,42 +27,65 @@ describe('Misc errors', () => {
     });
   });
   it('bad version', async () => {
-    const buf2 = bytes.fromHex('0aa16776657273696f6e02');
-    assert.strictEqual(bytes.toHex(makeHeader({ version: 2 })), '0aa16776657273696f6e02');
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 2');
+    const buf2 = bytes.fromHex('0aa16776657273696f6e03');
+    assert.strictEqual(bytes.toHex(makeHeader({ version: 3 })), '0aa16776657273696f6e03');
+    await assert.isRejected(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 assert.isFulfilled(CarReader.fromBytes(buf2));
     });
-    await assert.isFulfilled(CarReader.fromBytes(buf2));
-    buf2 = makeHeader({ roots: [] });
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR version: undefined');
-    buf2 = makeHeader({
-      version: '1',
-      roots: []
+    it('no \'version\' array', async () => {
+      const buf2 = makeHeader({ roots: [] });
+      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
     });
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR version: "1"');
-    buf2 = makeHeader({ version: 1 });
-    await assert.isRejected(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 assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
     });
-    await assert.isRejected(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 assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('bad \'roots\' type', async () => {
+      const buf2 = makeHeader({
+        version: 1,
+        roots: {}
+      });
+      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('extraneous properties', async () => {
+      const buf2 = makeHeader({
+        version: 1,
+        roots: [],
+        blip: true
+      });
+      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('not an object', async () => {
+      const buf2 = makeHeader([
+        1,
+        []
+      ]);
+      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('not an object', async () => {
+      const buf2 = makeHeader(null);
+      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
+    });
+    it('recursive v2 header', async () => {
+      const v2Header = goCarV2Bytes.slice(0, 51);
+      const buf2 = new Uint8Array(51 * 2);
+      buf2.set(v2Header, 0);
+      buf2.set(v2Header, 51);
+      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 2 (expected 1)');
     });
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    buf2 = makeHeader([
-      1,
-      []
-    ]);
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    buf2 = makeHeader(null);
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
   });
 });

package/esm/node-test/test-indexer.js

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

package/esm/node-test/test-reader.js

@@ -1,12 +1,22 @@
 import { CarReader } from '../lib/reader.js';
 import { CarWriter } from '../lib/writer.js';
+import {
+  bytesReader,
+  readHeader
+} from '../lib/decoder.js';
 import * as Block from 'multiformats/block';
 import { sha256 } from 'multiformats/hashes/sha2';
 import * as raw from 'multiformats/codecs/raw';
+import { base64 } from 'multiformats/bases/base64';
+import * as dagPb from '@ipld/dag-pb';
 import {
   carBytes,
   makeIterable,
-  assert
+  assert,
+  goCarV2Bytes,
+  goCarV2Roots,
+  goCarV2Index,
+  goCarV2Contents
 } from './common.js';
 import {
   verifyRoots,
@@ -15,6 +25,8 @@ import {
   verifyBlocks,
   verifyCids
 } from './verify-store-reader.js';
+import { data as fixtures } from './fixtures.js';
+import { expectations as fixtureExpectations } from './fixtures-expectations.js';
 describe('CarReader fromBytes()', () => {
   it('complete', async () => {
     const reader = await CarReader.fromBytes(carBytes);
@@ -52,6 +64,29 @@ describe('CarReader fromBytes()', () => {
       message: 'Unexpected end of data'
     });
   });
+  it('v2 complete', async () => {
+    const reader = await CarReader.fromBytes(goCarV2Bytes);
+    const roots = await reader.getRoots();
+    assert.strictEqual(roots.length, 1);
+    assert(goCarV2Roots[0].equals(roots[0]));
+    assert.strictEqual(reader.version, 2);
+    for (const {cid} of goCarV2Index) {
+      const block = await reader.get(cid);
+      assert.isDefined(block);
+      if (block) {
+        assert(cid.equals(block.cid));
+        let content;
+        if (cid.code === dagPb.code) {
+          content = dagPb.decode(block.bytes);
+        } else if (cid.code === 85) {
+          content = new TextDecoder().decode(block.bytes);
+        } else {
+          assert.fail('Unexpected codec');
+        }
+        assert.deepStrictEqual(content, goCarV2Contents[cid.toString()]);
+      }
+    }
+  });
   it('decode error - trailing null bytes', async () => {
     const bytes = new Uint8Array(carBytes.length + 5);
     bytes.set(carBytes);
@@ -178,4 +213,58 @@ describe('CarReader fromIterable()', () => {
       message: 'Unexpected end of data'
     });
   });
+  it('v2 decode error - truncated', async () => {
+    const bytes = goCarV2Bytes.slice();
+    const dv = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+    dv.setBigUint64(35, BigInt(448 - 10), true);
+    await assert.isRejected(CarReader.fromIterable(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(fixtureExpectations)) {
+      it(name, async () => {
+        const data = base64.baseDecode(fixtures[name]);
+        let header;
+        try {
+          header = await readHeader(bytesReader(data));
+        } catch (err) {
+          if (expectedError != null) {
+            assert.equal(err.message, expectedError);
+            return;
+          }
+          assert.ifError(err);
+        }
+        if (expectedError != null) {
+          assert.fail(`Expected error: ${ expectedError }`);
+        }
+        assert.isDefined(header, 'did not decode header');
+        if (expectedVersion != null && header != null) {
+          assert.strictEqual(header.version, expectedVersion);
+        }
+      });
+    }
+  });
+  describe('Contents', () => {
+    for (const [name, {cids: expectedCids}] of Object.entries(fixtureExpectations)) {
+      if (expectedCids == null) {
+        continue;
+      }
+      it(name, async () => {
+        const data = base64.baseDecode(fixtures[name]);
+        const reader = await CarReader.fromBytes(data);
+        let i = 0;
+        for await (const cid of reader.cids()) {
+          assert.strictEqual(cid.toString(), expectedCids[i++]);
+        }
+        assert.strictEqual(i, expectedCids.length);
+      });
+    }
+  });
 });

package/examples/car-to-fixture.js

@@ -42,10 +42,7 @@ async function run () {
   const indexer = await CarIndexer.fromBytes(bytes)
   const reader = await CarReader.fromBytes(bytes)
   const fixture = {
-    header: {
-      roots: await reader.getRoots(),
-      version: reader.version
-    },
+    header: reader._header, // a little naughty but we need gory details
     blocks: []
   }
   let i = 0

package/examples/dump-index.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+// Take a .car file and dump its index in DAG-JSON format, one line per block
+
+import fs from 'fs'
+import { CarIndexer } from '@ipld/car/indexer'
+import * as dagJson from '@ipld/dag-json'
+
+if (!process.argv[2]) {
+  console.log('Usage: dump-index.js <path/to/car>')
+  process.exit(1)
+}
+
+async function run () {
+  const indexer = await CarIndexer.fromIterable(fs.createReadStream(process.argv[2]))
+  for await (const blockIndex of indexer) {
+    console.log(new TextDecoder().decode(dagJson.encode(blockIndex)))
+  }
+}
+
+run().catch((err) => {
+  console.error(err)
+  process.exit(1)
+})

package/examples/package.json

@@ -16,7 +16,7 @@
   "license": "(Apache-2.0 AND MIT)",
   "dependencies": {
     "@ipld/car": "file:..",
-    "@ipld/dag-cbor": "^6.0.4",
+    "@ipld/dag-cbor": "^7.0.0",
     "@ipld/dag-json": "^8.0.0",
     "@ipld/dag-pb": "^2.0.2",
     "@multiformats/blake2": "^1.0.1",

package/examples/test-examples.js

@@ -76,6 +76,39 @@ Blocks:
     assert.strictEqual(stdout, '{"blocks":[{"blockLength":55,"blockOffset":137,"cid":{"/":"bafyreihyrpefhacm6kkp4ql6j6udakdit7g3dmkzfriqfykhjw6cad5lrm"},"content":{"link":{"/":"QmNX6Tffavsya4xgBi2VJQnSuqy9GsxongxZZ9uZBqp16d"},"name":"blip"},"length":92,"offset":100},{"blockLength":97,"blockOffset":228,"cid":{"/":"QmNX6Tffavsya4xgBi2VJQnSuqy9GsxongxZZ9uZBqp16d"},"content":{"Links":[{"Hash":{"/":"bafkreifw7plhl6mofk6sfvhnfh64qmkq73oeqwl6sloru6rehaoujituke"},"Name":"bear","Tsize":4},{"Hash":{"/":"QmWXZxVQ9yZfhQxLD35eDR8LiMRsYtHxYqTFCBbJoiJVys"},"Name":"second","Tsize":149}]},"length":133,"offset":192},{"blockLength":4,"blockOffset":362,"cid":{"/":"bafkreifw7plhl6mofk6sfvhnfh64qmkq73oeqwl6sloru6rehaoujituke"},"content":{"/":{"bytes":"Y2NjYw"}},"length":41,"offset":325},{"blockLength":94,"blockOffset":402,"cid":{"/":"QmWXZxVQ9yZfhQxLD35eDR8LiMRsYtHxYqTFCBbJoiJVys"},"content":{"Links":[{"Hash":{"/":"bafkreiebzrnroamgos2adnbpgw5apo3z4iishhbdx77gldnbk57d4zdio4"},"Name":"dog","Tsize":4},{"Hash":{"/":"QmdwjhxpxzcMsR3qUuj7vUL8pbA7MgR3GAxWi2GLHjsKCT"},"Name":"first","Tsize":51}]},"length":130,"offset":366},{"blockLength":4,"blockOffset":533,"cid":{"/":"bafkreiebzrnroamgos2adnbpgw5apo3z4iishhbdx77gldnbk57d4zdio4"},"content":{"/":{"bytes":"YmJiYg"}},"length":41,"offset":496},{"blockLength":47,"blockOffset":572,"cid":{"/":"QmdwjhxpxzcMsR3qUuj7vUL8pbA7MgR3GAxWi2GLHjsKCT"},"content":{"Links":[{"Hash":{"/":"bafkreidbxzk2ryxwwtqxem4l3xyyjvw35yu4tcct4cqeqxwo47zhxgxqwq"},"Name":"cat","Tsize":4}]},"length":82,"offset":537},{"blockLength":4,"blockOffset":656,"cid":{"/":"bafkreidbxzk2ryxwwtqxem4l3xyyjvw35yu4tcct4cqeqxwo47zhxgxqwq"},"content":{"/":{"bytes":"YWFhYQ"}},"length":41,"offset":619},{"blockLength":18,"blockOffset":697,"cid":{"/":"bafyreidj5idub6mapiupjwjsyyxhyhedxycv4vihfsicm2vt46o7morwlm"},"content":{"link":null,"name":"limbo"},"length":55,"offset":660}],"header":{"roots":[{"/":"bafyreihyrpefhacm6kkp4ql6j6udakdit7g3dmkzfriqfykhjw6cad5lrm"},{"/":"bafyreidj5idub6mapiupjwjsyyxhyhedxycv4vihfsicm2vt46o7morwlm"}],"version":1}}\n')
     console.log('\u001b[32m✔\u001b[39m [example] car-to-fixture ../test/go.car')
   })
+}).then(async () => {
+  await runExample('dump-index', ['example.car']).then(({ stdout, stderr }) => {
+    assert.strictEqual(stderr, '')
+    assert.strictEqual(stdout, '{"blockLength":24,"blockOffset":96,"cid":{"/":"bafkreihwkf6mtnjobdqrkiksr7qhp6tiiqywux64aylunbvmfhzeql2coa"},"length":61,"offset":59}\n')
+    console.log('\u001b[32m✔\u001b[39m [example] dump-index example.car')
+  })
+}).then(async () => {
+  await runExample('dump-index', ['../test/go.car']).then(({ stdout, stderr }) => {
+    assert.strictEqual(stderr, '')
+    assert.strictEqual(stdout,
+`{"blockLength":55,"blockOffset":137,"cid":{"/":"bafyreihyrpefhacm6kkp4ql6j6udakdit7g3dmkzfriqfykhjw6cad5lrm"},"length":92,"offset":100}
+{"blockLength":97,"blockOffset":228,"cid":{"/":"QmNX6Tffavsya4xgBi2VJQnSuqy9GsxongxZZ9uZBqp16d"},"length":133,"offset":192}
+{"blockLength":4,"blockOffset":362,"cid":{"/":"bafkreifw7plhl6mofk6sfvhnfh64qmkq73oeqwl6sloru6rehaoujituke"},"length":41,"offset":325}
+{"blockLength":94,"blockOffset":402,"cid":{"/":"QmWXZxVQ9yZfhQxLD35eDR8LiMRsYtHxYqTFCBbJoiJVys"},"length":130,"offset":366}
+{"blockLength":4,"blockOffset":533,"cid":{"/":"bafkreiebzrnroamgos2adnbpgw5apo3z4iishhbdx77gldnbk57d4zdio4"},"length":41,"offset":496}
+{"blockLength":47,"blockOffset":572,"cid":{"/":"QmdwjhxpxzcMsR3qUuj7vUL8pbA7MgR3GAxWi2GLHjsKCT"},"length":82,"offset":537}
+{"blockLength":4,"blockOffset":656,"cid":{"/":"bafkreidbxzk2ryxwwtqxem4l3xyyjvw35yu4tcct4cqeqxwo47zhxgxqwq"},"length":41,"offset":619}
+{"blockLength":18,"blockOffset":697,"cid":{"/":"bafyreidj5idub6mapiupjwjsyyxhyhedxycv4vihfsicm2vt46o7morwlm"},"length":55,"offset":660}
+`)
+    console.log('\u001b[32m✔\u001b[39m [example] dump-index ../test/go.carv2')
+  })
+}).then(async () => {
+  await runExample('dump-index', ['../test/go.carv2']).then(({ stdout, stderr }) => {
+    assert.strictEqual(stderr, '')
+    assert.strictEqual(stdout,
+`{"blockLength":47,"blockOffset":143,"cid":{"/":"QmfEoLyB5NndqeKieExd1rtJzTduQUPEV8TwAYcUiy3H5Z"},"length":82,"offset":108}
+{"blockLength":99,"blockOffset":226,"cid":{"/":"QmczfirA7VEH7YVvKPTPoU69XM3qY4DC39nnTsWd4K3SkM"},"length":135,"offset":190}
+{"blockLength":54,"blockOffset":360,"cid":{"/":"Qmcpz2FHJD7VAhg1fxFXdYJKePtkx1BsHuCrAgWVnaHMTE"},"length":89,"offset":325}
+{"blockLength":4,"blockOffset":451,"cid":{"/":"bafkreifuosuzujyf4i6psbneqtwg2fhplc2wxptc5euspa2gn3bwhnihfu"},"length":41,"offset":414}
+{"blockLength":7,"blockOffset":492,"cid":{"/":"bafkreifc4hca3inognou377hfhvu2xfchn2ltzi7yu27jkaeujqqqdbjju"},"length":44,"offset":455}
+`)
+    console.log('\u001b[32m✔\u001b[39m [example] dump-index ../test/go.carv2')
+  })
 }).catch((err) => {
   console.error(err.stack)
   process.exit(1)