@atproto/common 0.2.0 → 0.3.1

package/dist/ipld.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import crypto from 'crypto';
+import { Transform, TransformCallback } from 'stream';
 import { CID } from 'multiformats/cid';
 import * as Block from 'multiformats/block';
 import * as cborCodec from '@ipld/dag-cbor';
@@ -5,7 +10,20 @@ export declare const cborEncode: typeof cborCodec.encode;
 export declare const cborDecode: typeof cborCodec.decode;
 export declare const dataToCborBlock: (data: unknown) => Promise<Block.Block<unknown>>;
 export declare const cidForCbor: (data: unknown) => Promise<CID>;
+export declare const isValidCid: (cidStr: string) => Promise<boolean>;
 export declare const cborBytesToRecord: (bytes: Uint8Array) => Record<string, unknown>;
 export declare const verifyCidForBytes: (cid: CID, bytes: Uint8Array) => Promise<void>;
 export declare const sha256ToCid: (hash: Uint8Array, codec: number) => CID;
 export declare const sha256RawToCid: (hash: Uint8Array) => CID;
+export declare class VerifyCidTransform extends Transform {
+    cid: CID;
+    hasher: crypto.Hash;
+    constructor(cid: CID);
+    _transform(chunk: Uint8Array, _enc: BufferEncoding, cb: TransformCallback): void;
+    _flush(cb: TransformCallback): void;
+}
+export declare class VerifyCidError extends Error {
+    expected: CID;
+    actual: CID;
+    constructor(expected: CID, actual: CID);
+}

package/dist/streams.d.ts

@@ -4,6 +4,8 @@ import { Stream, Readable, Transform, TransformCallback } from 'stream';
 export declare const forwardStreamErrors: (...streams: Stream[]) => void;
 export declare const cloneStream: (stream: Readable) => Readable;
 export declare const streamSize: (stream: Readable) => Promise<number>;
+export declare const streamToBytes: (stream: Readable) => Promise<Uint8Array>;
+export declare const byteIterableToStream: (iter: AsyncIterable<Uint8Array>) => Readable;
 export declare const bytesToStream: (bytes: Uint8Array) => Readable;
 export declare class MaxSizeChecker extends Transform {
     maxSize: number;

package/package.json

@@ -1,28 +1,32 @@
 {
   "name": "@atproto/common",
-  "version": "0.2.0",
-  "main": "dist/index.js",
+  "version": "0.3.1",
   "license": "MIT",
+  "description": "Shared web-platform-friendly code for atproto libraries",
+  "keywords": [
+    "atproto"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/common"
+  },
+  "main": "dist/index.js",
+  "dependencies": {
+    "@ipld/dag-cbor": "^7.0.3",
+    "cbor-x": "^1.5.1",
+    "iso-datestring-validator": "^2.2.2",
+    "multiformats": "^9.9.0",
+    "pino": "^8.15.0",
+    "zod": "3.21.4",
+    "@atproto/common-web": "^0.2.1"
+  },
   "scripts": {
     "test": "jest",
-    "prettier": "prettier --check src/",
-    "prettier:fix": "prettier --write src/",
-    "lint": "eslint . --ext .ts,.tsx",
-    "lint:fix": "yarn lint --fix",
-    "verify": "run-p prettier lint",
-    "verify:fix": "yarn prettier:fix && yarn lint:fix",
     "build": "node ./build.js",
     "postbuild": "tsc --build tsconfig.build.json",
-    "update-main-to-dist": "node ./update-pkg.js --update-main-to-dist",
-    "update-main-to-src": "node ./update-pkg.js --update-main-to-src",
-    "prepublish": "npm run update-main-to-dist",
-    "postpublish": "npm run update-main-to-src"
+    "update-main-to-dist": "node ../../update-main-to-dist.js packages/common"
   },
-  "dependencies": {
-    "@atproto/common-web": "*",
-    "@ipld/dag-cbor": "^7.0.3",
-    "cbor-x": "^1.5.1",
-    "multiformats": "^9.6.4",
-    "pino": "^8.6.1"
-  }
-}
+  "types": "dist/index.d.ts"
+}

package/src/buffers.ts

@@ -0,0 +1,10 @@
+export function ui8ToBuffer(bytes: Uint8Array): Buffer {
+  return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength)
+}
+
+export function ui8ToArrayBuffer(bytes: Uint8Array): ArrayBuffer {
+  return bytes.buffer.slice(
+    bytes.byteOffset,
+    bytes.byteLength + bytes.byteOffset,
+  )
+}

package/src/dates.ts

@@ -0,0 +1,16 @@
+import { isValidISODateString } from 'iso-datestring-validator'
+
+// Normalize date strings to simplified ISO so that the lexical sort preserves temporal sort.
+// Rather than failing on an invalid date format, returns valid unix epoch.
+export function toSimplifiedISOSafe(dateStr: string) {
+  const date = new Date(dateStr)
+  if (isNaN(date.getTime())) {
+    return new Date(0).toISOString()
+  }
+  const iso = date.toISOString()
+  if (!isValidISODateString(iso)) {
+    // Occurs in rare cases, e.g. where resulting UTC year is negative. These also don't preserve lexical sort.
+    return new Date(0).toISOString()
+  }
+  return iso // YYYY-MM-DDTHH:mm:ss.sssZ
+}

package/src/fs.ts

@@ -1,9 +1,10 @@
 import { isErrnoException } from '@atproto/common-web'
+import { constants } from 'fs'
 import fs from 'fs/promises'
 
 export const fileExists = async (location: string): Promise<boolean> => {
   try {
-    await fs.access(location, fs.constants.F_OK)
+    await fs.access(location, constants.F_OK)
     return true
   } catch (err) {
     if (isErrnoException(err) && err.code === 'ENOENT') {

package/src/index.ts

@@ -1,6 +1,8 @@
 export * from '@atproto/common-web'
+export * from './dates'
 export * from './fs'
 export * from './ipld'
 export * from './ipld-multi'
 export * from './logger'
 export * from './streams'
+export * from './buffers'

package/src/ipld.ts

@@ -1,3 +1,5 @@
+import crypto from 'crypto'
+import { Transform, TransformCallback } from 'stream'
 import { check, schema } from '@atproto/common-web'
 import { CID } from 'multiformats/cid'
 import * as Block from 'multiformats/block'
@@ -22,6 +24,15 @@ export const cidForCbor = async (data: unknown): Promise<CID> => {
   return block.cid
 }
 
+export const isValidCid = async (cidStr: string): Promise<boolean> => {
+  try {
+    const parsed = CID.parse(cidStr)
+    return parsed.toString() === cidStr
+  } catch (err) {
+    return false
+  }
+}
+
 export const cborBytesToRecord = (
   bytes: Uint8Array,
 ): Record<string, unknown> => {
@@ -50,3 +61,38 @@ export const sha256ToCid = (hash: Uint8Array, codec: number): CID => {
 export const sha256RawToCid = (hash: Uint8Array): CID => {
   return sha256ToCid(hash, rawCodec.code)
 }
+
+export class VerifyCidTransform extends Transform {
+  hasher = crypto.createHash('sha256')
+  constructor(public cid: CID) {
+    super()
+  }
+
+  _transform(chunk: Uint8Array, _enc: BufferEncoding, cb: TransformCallback) {
+    this.hasher.update(chunk)
+    cb(null, chunk)
+  }
+
+  _flush(cb: TransformCallback) {
+    try {
+      const cid = sha256RawToCid(this.hasher.digest())
+      if (this.cid.equals(cid)) {
+        return cb()
+      } else {
+        return cb(new VerifyCidError(this.cid, cid))
+      }
+    } catch (_err) {
+      const err =
+        _err instanceof Error
+          ? _err
+          : new Error('Unexpected error', { cause: _err })
+      return cb(err)
+    }
+  }
+}
+
+export class VerifyCidError extends Error {
+  constructor(public expected: CID, public actual: CID) {
+    super('Bad cid check')
+  }
+}

package/src/streams.ts

@@ -30,6 +30,20 @@ export const streamSize = async (stream: Readable): Promise<number> => {
   return size
 }
 
+export const streamToBytes = async (stream: Readable): Promise<Uint8Array> => {
+  const bufs: Buffer[] = []
+  for await (const bytes of stream) {
+    bufs.push(bytes)
+  }
+  return new Uint8Array(Buffer.concat(bufs))
+}
+
+export const byteIterableToStream = (
+  iter: AsyncIterable<Uint8Array>,
+): Readable => {
+  return Readable.from(iter, { objectMode: false })
+}
+
 export const bytesToStream = (bytes: Uint8Array): Readable => {
   const stream = new Readable()
   stream.push(bytes)

package/tests/ipld-vectors.ts

@@ -0,0 +1,279 @@
+import { CID } from 'multiformats/cid'
+
+export const vectors = [
+  {
+    name: 'basic',
+    json: {
+      string: 'abc',
+      unicode: 'a~öñ©⽘☎𓋓😀👨‍👩‍👧‍👧',
+      integer: 123,
+      bool: true,
+      null: null,
+      array: ['abc', 'def', 'ghi'],
+      object: {
+        string: 'abc',
+        number: 123,
+        bool: true,
+        arr: ['abc', 'def', 'ghi'],
+      },
+    },
+    ipld: {
+      string: 'abc',
+      unicode: 'a~öñ©⽘☎𓋓😀👨‍👩‍👧‍👧',
+      integer: 123,
+      bool: true,
+      null: null,
+      array: ['abc', 'def', 'ghi'],
+      object: {
+        string: 'abc',
+        number: 123,
+        bool: true,
+        arr: ['abc', 'def', 'ghi'],
+      },
+    },
+    cbor: new Uint8Array([
+      167, 100, 98, 111, 111, 108, 245, 100, 110, 117, 108, 108, 246, 101, 97,
+      114, 114, 97, 121, 131, 99, 97, 98, 99, 99, 100, 101, 102, 99, 103, 104,
+      105, 102, 111, 98, 106, 101, 99, 116, 164, 99, 97, 114, 114, 131, 99, 97,
+      98, 99, 99, 100, 101, 102, 99, 103, 104, 105, 100, 98, 111, 111, 108, 245,
+      102, 110, 117, 109, 98, 101, 114, 24, 123, 102, 115, 116, 114, 105, 110,
+      103, 99, 97, 98, 99, 102, 115, 116, 114, 105, 110, 103, 99, 97, 98, 99,
+      103, 105, 110, 116, 101, 103, 101, 114, 24, 123, 103, 117, 110, 105, 99,
+      111, 100, 101, 120, 47, 97, 126, 195, 182, 195, 177, 194, 169, 226, 189,
+      152, 226, 152, 142, 240, 147, 139, 147, 240, 159, 152, 128, 240, 159, 145,
+      168, 226, 128, 141, 240, 159, 145, 169, 226, 128, 141, 240, 159, 145, 167,
+      226, 128, 141, 240, 159, 145, 167,
+    ]),
+    cid: 'bafyreiclp443lavogvhj3d2ob2cxbfuscni2k5jk7bebjzg7khl3esabwq',
+  },
+  {
+    name: 'ipld',
+    json: {
+      a: {
+        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      },
+      b: {
+        $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+      },
+      c: {
+        $type: 'blob',
+        ref: {
+          $link: 'bafkreiccldh766hwcnuxnf2wh6jgzepf2nlu2lvcllt63eww5p6chi4ity',
+        },
+        mimeType: 'image/jpeg',
+        size: 10000,
+      },
+    },
+    ipld: {
+      a: CID.parse(
+        'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      ),
+      b: new Uint8Array([
+        156, 81, 17, 142, 242, 203, 139, 15, 106, 155, 142, 73, 174, 161, 253,
+        65, 60, 242, 11, 98, 238, 213, 118, 248, 157, 238, 190, 176, 26, 194,
+        204, 141,
+      ]),
+      c: {
+        $type: 'blob',
+        ref: CID.parse(
+          'bafkreiccldh766hwcnuxnf2wh6jgzepf2nlu2lvcllt63eww5p6chi4ity',
+        ),
+        mimeType: 'image/jpeg',
+        size: 10000,
+      },
+    },
+    cbor: new Uint8Array([
+      163, 97, 97, 216, 42, 88, 37, 0, 1, 113, 18, 32, 101, 6, 42, 90, 90, 0,
+      252, 22, 215, 60, 105, 68, 35, 124, 203, 193, 91, 28, 74, 114, 52, 72,
+      147, 54, 137, 29, 9, 23, 65, 162, 57, 208, 97, 98, 88, 32, 156, 81, 17,
+      142, 242, 203, 139, 15, 106, 155, 142, 73, 174, 161, 253, 65, 60, 242, 11,
+      98, 238, 213, 118, 248, 157, 238, 190, 176, 26, 194, 204, 141, 97, 99,
+      164, 99, 114, 101, 102, 216, 42, 88, 37, 0, 1, 85, 18, 32, 66, 88, 207,
+      255, 120, 246, 19, 105, 118, 151, 86, 63, 146, 108, 145, 229, 211, 87, 77,
+      46, 162, 90, 231, 237, 146, 214, 235, 252, 35, 163, 136, 158, 100, 115,
+      105, 122, 101, 25, 39, 16, 101, 36, 116, 121, 112, 101, 100, 98, 108, 111,
+      98, 104, 109, 105, 109, 101, 84, 121, 112, 101, 106, 105, 109, 97, 103,
+      101, 47, 106, 112, 101, 103,
+    ]),
+    cid: 'bafyreihldkhcwijkde7gx4rpkkuw7pl6lbyu5gieunyc7ihactn5bkd2nm',
+  },
+  {
+    name: 'ipldArray',
+    json: [
+      {
+        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      },
+      {
+        $link: 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+      },
+      {
+        $link: 'bafyreiaizynclnqiolq7byfpjjtgqzn4sfrsgn7z2hhf6bo4utdwkin7ke',
+      },
+      {
+        $link: 'bafyreifd4w4tcr5tluxz7osjtnofffvtsmgdqcfrfi6evjde4pl27lrjpy',
+      },
+    ],
+    ipld: [
+      CID.parse('bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a'),
+      CID.parse('bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q'),
+      CID.parse('bafyreiaizynclnqiolq7byfpjjtgqzn4sfrsgn7z2hhf6bo4utdwkin7ke'),
+      CID.parse('bafyreifd4w4tcr5tluxz7osjtnofffvtsmgdqcfrfi6evjde4pl27lrjpy'),
+    ],
+    cbor: new Uint8Array([
+      132, 216, 42, 88, 37, 0, 1, 113, 18, 32, 101, 6, 42, 90, 90, 0, 252, 22,
+      215, 60, 105, 68, 35, 124, 203, 193, 91, 28, 74, 114, 52, 72, 147, 54,
+      137, 29, 9, 23, 65, 162, 57, 208, 216, 42, 88, 37, 0, 1, 113, 18, 32, 206,
+      188, 253, 200, 24, 248, 158, 85, 31, 33, 95, 133, 103, 145, 125, 120, 196,
+      209, 14, 220, 33, 139, 148, 27, 165, 214, 150, 172, 255, 213, 142, 244,
+      216, 42, 88, 37, 0, 1, 113, 18, 32, 8, 206, 26, 37, 182, 8, 114, 225, 240,
+      224, 175, 74, 102, 104, 101, 188, 145, 99, 35, 55, 249, 209, 206, 95, 5,
+      220, 164, 199, 101, 33, 191, 81, 216, 42, 88, 37, 0, 1, 113, 18, 32, 163,
+      229, 185, 49, 71, 179, 93, 47, 159, 186, 73, 155, 92, 82, 150, 179, 147,
+      12, 56, 8, 177, 42, 60, 74, 164, 100, 227, 215, 175, 174, 41, 126,
+    ]),
+    cid: 'bafyreiaj3udmqlqrcbjxjayzuxwp64gt64olcbjfrkldzoqponpru6gq4m',
+  },
+  {
+    name: 'ipldNested',
+    json: {
+      a: {
+        b: [
+          {
+            d: [
+              {
+                $link:
+                  'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              },
+              {
+                $link:
+                  'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              },
+            ],
+            e: [
+              {
+                $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+              },
+              {
+                $bytes: 'iE+sPoHobU9tSIqGI+309LLCcWQIRmEXwxcoDt19tas',
+              },
+            ],
+          },
+        ],
+      },
+    },
+    ipld: {
+      a: {
+        b: [
+          {
+            d: [
+              CID.parse(
+                'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              ),
+              CID.parse(
+                'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              ),
+            ],
+            e: [
+              new Uint8Array([
+                156, 81, 17, 142, 242, 203, 139, 15, 106, 155, 142, 73, 174,
+                161, 253, 65, 60, 242, 11, 98, 238, 213, 118, 248, 157, 238,
+                190, 176, 26, 194, 204, 141,
+              ]),
+              new Uint8Array([
+                136, 79, 172, 62, 129, 232, 109, 79, 109, 72, 138, 134, 35, 237,
+                244, 244, 178, 194, 113, 100, 8, 70, 97, 23, 195, 23, 40, 14,
+                221, 125, 181, 171,
+              ]),
+            ],
+          },
+        ],
+      },
+    },
+    cbor: new Uint8Array([
+      161, 97, 97, 161, 97, 98, 129, 162, 97, 100, 130, 216, 42, 88, 37, 0, 1,
+      113, 18, 32, 101, 6, 42, 90, 90, 0, 252, 22, 215, 60, 105, 68, 35, 124,
+      203, 193, 91, 28, 74, 114, 52, 72, 147, 54, 137, 29, 9, 23, 65, 162, 57,
+      208, 216, 42, 88, 37, 0, 1, 113, 18, 32, 101, 6, 42, 90, 90, 0, 252, 22,
+      215, 60, 105, 68, 35, 124, 203, 193, 91, 28, 74, 114, 52, 72, 147, 54,
+      137, 29, 9, 23, 65, 162, 57, 208, 97, 101, 130, 88, 32, 156, 81, 17, 142,
+      242, 203, 139, 15, 106, 155, 142, 73, 174, 161, 253, 65, 60, 242, 11, 98,
+      238, 213, 118, 248, 157, 238, 190, 176, 26, 194, 204, 141, 88, 32, 136,
+      79, 172, 62, 129, 232, 109, 79, 109, 72, 138, 134, 35, 237, 244, 244, 178,
+      194, 113, 100, 8, 70, 97, 23, 195, 23, 40, 14, 221, 125, 181, 171,
+    ]),
+    cid: 'bafyreid3imdulnhgeytpf6uk7zahjvrsqlofkmm5b5ub2maw4kqus6jp4i',
+  },
+  {
+    name: 'poorlyFormatted',
+    json: {
+      a: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      b: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+      c: {
+        $link: 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+        another: 'bad value',
+      },
+      d: {
+        $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        another: 'bad value',
+      },
+      e: {
+        '/': 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+      },
+      f: {
+        '/': {
+          bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        },
+      },
+    },
+    ipld: {
+      a: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      b: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+      c: {
+        $link: 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+        another: 'bad value',
+      },
+      d: {
+        $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        another: 'bad value',
+      },
+      e: {
+        '/': 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+      },
+      f: {
+        '/': {
+          bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        },
+      },
+    },
+    cbor: new Uint8Array([
+      166, 97, 97, 120, 59, 98, 97, 102, 121, 114, 101, 105, 100, 102, 97, 121,
+      118, 102, 117, 119, 113, 97, 55, 113, 108, 110, 111, 112, 100, 106, 105,
+      113, 114, 120, 122, 115, 54, 98, 108, 109, 111, 101, 117, 52, 114, 117,
+      106, 99, 106, 116, 110, 99, 105, 53, 98, 101, 108, 117, 100, 105, 114,
+      122, 50, 97, 97, 98, 120, 43, 110, 70, 69, 82, 106, 118, 76, 76, 105, 119,
+      57, 113, 109, 52, 53, 74, 114, 113, 72, 57, 81, 84, 122, 121, 67, 50, 76,
+      117, 49, 88, 98, 52, 110, 101, 54, 43, 115, 66, 114, 67, 122, 73, 48, 97,
+      99, 162, 101, 36, 108, 105, 110, 107, 120, 59, 98, 97, 102, 121, 114, 101,
+      105, 103, 111, 120, 116, 54, 52, 113, 103, 104, 121, 116, 122, 107, 114,
+      54, 105, 107, 55, 113, 118, 116, 122, 99, 55, 108, 121, 121, 116, 105,
+      113, 53, 120, 98, 98, 114, 111, 107, 98, 120, 106, 111, 119, 115, 50, 119,
+      112, 55, 118, 109, 111, 54, 113, 103, 97, 110, 111, 116, 104, 101, 114,
+      105, 98, 97, 100, 32, 118, 97, 108, 117, 101, 97, 100, 162, 102, 36, 98,
+      121, 116, 101, 115, 120, 43, 110, 70, 69, 82, 106, 118, 76, 76, 105, 119,
+      57, 113, 109, 52, 53, 74, 114, 113, 72, 57, 81, 84, 122, 121, 67, 50, 76,
+      117, 49, 88, 98, 52, 110, 101, 54, 43, 115, 66, 114, 67, 122, 73, 48, 103,
+      97, 110, 111, 116, 104, 101, 114, 105, 98, 97, 100, 32, 118, 97, 108, 117,
+      101, 97, 101, 161, 97, 47, 120, 59, 98, 97, 102, 121, 114, 101, 105, 103,
+      111, 120, 116, 54, 52, 113, 103, 104, 121, 116, 122, 107, 114, 54, 105,
+      107, 55, 113, 118, 116, 122, 99, 55, 108, 121, 121, 116, 105, 113, 53,
+      120, 98, 98, 114, 111, 107, 98, 120, 106, 111, 119, 115, 50, 119, 112, 55,
+      118, 109, 111, 54, 113, 97, 102, 161, 97, 47, 161, 101, 98, 121, 116, 101,
+      115, 120, 43, 110, 70, 69, 82, 106, 118, 76, 76, 105, 119, 57, 113, 109,
+      52, 53, 74, 114, 113, 72, 57, 81, 84, 122, 121, 67, 50, 76, 117, 49, 88,
+      98, 52, 110, 101, 54, 43, 115, 66, 114, 67, 122, 73, 48,
+    ]),
+    cid: 'bafyreico7wgbbfe6dpfsuednrtrlh6t2yjl6xq5rf32gl3pgwhwxk77cn4',
+  },
+]
+
+export default vectors

package/tests/ipld.test.ts

@@ -1,89 +1,29 @@
-import { CID } from 'multiformats/cid'
 import * as ui8 from 'uint8arrays'
-import { ipldToJson, jsonToIpld } from '../src'
+import vectors from './ipld-vectors'
+import {
+  cborDecode,
+  cborEncode,
+  cidForCbor,
+  ipldEquals,
+  ipldToJson,
+  jsonToIpld,
+} from '../src'
 
 describe('ipld', () => {
-  it('converts ipld to json', () => {
-    const ipld = {
-      one: 1,
-      two: CID.parse(
-        'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-      ),
-      three: new Uint8Array([0, 1, 2, 3]),
-    }
-    const json = ipldToJson(ipld)
-    expect(json).toEqual({
-      one: 1,
-      two: {
-        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-      },
-      three: {
-        $bytes: 'AAECAw',
-      },
+  for (const vector of vectors) {
+    it(`passes test vector: ${vector.name}`, async () => {
+      const ipld = jsonToIpld(vector.json)
+      const json = ipldToJson(ipld)
+      const cbor = cborEncode(ipld)
+      const ipldAgain = cborDecode(cbor)
+      const jsonAgain = ipldToJson(ipldAgain)
+      const cid = await cidForCbor(ipld)
+      expect(json).toEqual(vector.json)
+      expect(jsonAgain).toEqual(vector.json)
+      expect(ipldEquals(ipld, vector.ipld)).toBeTruthy()
+      expect(ipldEquals(ipldAgain, vector.ipld)).toBeTruthy()
+      expect(ui8.equals(cbor, vector.cbor)).toBeTruthy()
+      expect(cid.toString()).toEqual(vector.cid)
     })
-  })
-
-  it('converts json to ipld', () => {
-    const json = {
-      one: 1,
-      two: {
-        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-      },
-      three: {
-        $bytes: 'AAECAw',
-      },
-    }
-    const expectedCid = CID.parse(
-      'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-    )
-
-    const ipld = jsonToIpld(json)
-    if (!ipld) {
-      throw new Error()
-    }
-    expect(ipld['one']).toBe(1)
-    expect(expectedCid.equals(ipld['two'])).toBeTruthy()
-    expect(ui8.equals(ipld['three'], new Uint8Array([0, 1, 2, 3]))).toBeTruthy()
-  })
-
-  it('converts nested ipld to json', () => {
-    const ipld = {
-      a: {
-        b: [
-          CID.parse(
-            'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-          ),
-        ],
-      },
-    }
-    const json = ipldToJson(ipld)
-    expect(json).toEqual({
-      a: {
-        b: [
-          {
-            $link:
-              'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-          },
-        ],
-      },
-    })
-  })
-
-  it('converts nested json to ipld', () => {
-    const json = {
-      a: {
-        b: [
-          {
-            $link:
-              'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-          },
-        ],
-      },
-    }
-    const ipld = jsonToIpld(json)
-    const expectedCid = CID.parse(
-      'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-    )
-    expect(ipld && expectedCid.equals(ipld['a']['b']))
-  })
+  }
 })