@bitgo-beta/deser-lib 1.0.0

package/.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+.idea
+public
+dist
+

package/.mocharc.json

@@ -0,0 +1,9 @@
+{
+  "require": ["ts-node/register", "should"],
+  "timeout": "20000",
+  "reporter": "min",
+  "reporter-option": ["cdn=true", "json=false"],
+  "exit": true,
+  "spec": ["test/unit/**/*.ts"],
+  "extension": [".js", ".ts"]
+}

package/.prettierignore

@@ -0,0 +1,2 @@
+.nyc_output/
+dist/

package/.prettierrc.yml

@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2022 BitGo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,3 @@
+# Deser Lib
+
+This library will be used to centralize all the serialization and de-serialization schemes used in the bitgojs modules.

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@bitgo-beta/deser-lib",
+  "version": "1.0.0",
+  "description": "BitGo serialization and deseralization library",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "test": "yarn unit-test",
+    "unit-test": "nyc -- mocha --recursive test",
+    "build": "yarn tsc --build --incremental --verbose .",
+    "fmt": "prettier --write .",
+    "check-fmt": "prettier --check .",
+    "clean": "rm -r ./dist",
+    "lint": "eslint --quiet .",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/deser-lib"
+  },
+  "author": "BitGo SDK Team <sdkteam@bitgo.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bitgo/bitgojs/issues"
+  },
+  "homepage": "https://github.com/bitgo/bitgojs#readme",
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "cbor": "^9.0.1"
+  },
+  "gitHead": "689fe50b412b5de986ab341fe9418d1b8b9eebbb"
+}

package/src/cbor.ts

@@ -0,0 +1,216 @@
+import { decodeFirstSync, encodeCanonical } from 'cbor';
+
+/**
+ * Return a string describing value as a type.
+ * @param value - Any javascript value to type.
+ * @returns String describing value type.
+ */
+function getType(value: unknown): string {
+  if (value === null || value === undefined) {
+    return 'null';
+  }
+  if (value instanceof Array) {
+    const types = value.map(getType);
+    if (!types.slice(1).every((value) => value === types[0])) {
+      throw new Error('Array elements are not of the same type');
+    }
+    return JSON.stringify([types[0]]);
+  }
+  if (value instanceof Object) {
+    const properties = Object.getOwnPropertyNames(value);
+    properties.sort();
+    return JSON.stringify(
+      properties.reduce((acc, name) => {
+        acc[name] = getType(value[name]);
+        return acc;
+      }, {})
+    );
+  }
+  if (typeof value === 'string') {
+    if (value.startsWith('0x')) {
+      return 'bytes';
+    }
+    return 'string';
+  }
+  return JSON.stringify(typeof value);
+}
+
+/**
+ * Compare two buffers for sorting.
+ * @param a - left buffer to compare to right buffer.
+ * @param b - right buffer to compare to left buffer.
+ * @returns Negative if a < b, positive if b > a, 0 if equal.
+ */
+function bufferCompare(a: Buffer, b: Buffer): number {
+  let i = 0;
+  while (i < a.length && i < b.length && a[i] == b[i]) {
+    i++;
+  }
+  if (i === a.length && i === b.length) {
+    return 0;
+  }
+  if (i === a.length || i === b.length) {
+    return a.length - b.length;
+  }
+  return a[i] - b[i];
+}
+
+/** A sortable array element. */
+type Sortable = {
+  weight: number;
+  value?: unknown;
+};
+
+/**
+ * Type check for sortable array element.
+ * @param value - Value to type check.
+ * @returns True if value is a sortable array element.
+ */
+function isSortable(value: unknown): value is Sortable {
+  return value instanceof Object && 'weight' in value && typeof (value as Sortable).weight === 'number';
+}
+
+/**
+ * Convert number to base 256 and return as a big-endian Buffer.
+ * @param value - Value to convert.
+ * @returns Buffer representation of the number.
+ */
+function numberToBufferBE(value: number): Buffer {
+  // Normalize value so that negative numbers aren't compared higher
+  // than positive numbers when accounting for two's complement.
+  value += Math.pow(2, 52);
+  const byteCount = Math.floor((value.toString(2).length + 7) / 8);
+  const buffer = Buffer.alloc(byteCount);
+  let i = 0;
+  while (value) {
+    buffer[i++] = value % 256;
+    value = Math.floor(value / 256);
+  }
+  return buffer.reverse();
+}
+
+/**
+ * Compare two array elements for sorting.
+ * @param a - left element to compare to right element.
+ * @param b - right element to compare to left element.
+ * @returns Negative if a < b, positive if b > a, 0 if equal.
+ */
+function elementCompare(a: unknown, b: unknown): number {
+  if (!isSortable(a) || !isSortable(b)) {
+    throw new Error('Array elements must be sortable');
+  }
+  if (a.weight === b.weight) {
+    if (a.value === undefined && b.value === undefined) {
+      throw new Error('Array elements must be sortable');
+    }
+    const aVal = transform(a.value);
+    const bVal = transform(b.value);
+    if (
+      (!Buffer.isBuffer(aVal) && typeof aVal !== 'string' && typeof aVal !== 'number') ||
+      (!Buffer.isBuffer(bVal) && typeof bVal !== 'string' && typeof bVal !== 'number')
+    ) {
+      throw new Error('Array element value cannot be compared');
+    }
+    let aBuf, bBuf;
+    if (typeof aVal === 'number') {
+      aBuf = numberToBufferBE(aVal);
+    } else {
+      aBuf = Buffer.from(aVal);
+    }
+    if (typeof bVal === 'number') {
+      bBuf = numberToBufferBE(bVal);
+    } else {
+      bBuf = Buffer.from(bVal);
+    }
+    return bufferCompare(aBuf, bBuf);
+  }
+  return a.weight - b.weight;
+}
+
+/**
+ * Transform value into its canonical, serializable form.
+ * @param value - Value to transform.
+ * @returns Canonical, serializable form of value.
+ */
+export function transform<T>(value: T): T | Buffer {
+  if (value === null || value === undefined) {
+    return value;
+  }
+  if (typeof value === 'string') {
+    // Transform hex strings to buffers.
+    if (value.startsWith('0x')) {
+      if (!value.match(/^0x([0-9a-fA-F]{2})*$/)) {
+        throw new Error('0x prefixed string contains non-hex characters.');
+      }
+      return Buffer.from(value.slice(2), 'hex');
+    } else if (value.startsWith('\\0x')) {
+      return value.slice(1) as unknown as T;
+    }
+  } else if (value instanceof Array) {
+    // Enforce array elements are same type.
+    getType(value);
+    value = [...value] as unknown as T;
+    (value as unknown as Array<unknown>).sort(elementCompare);
+    return (value as unknown as Array<unknown>).map(transform) as unknown as T;
+  } else if (value instanceof Object) {
+    const properties = Object.getOwnPropertyNames(value);
+    properties.sort();
+    return properties.reduce((acc, name) => {
+      acc[name] = transform(value[name]);
+      return acc;
+    }, {}) as unknown as T;
+  }
+  return value;
+}
+
+/**
+ * Untransform value into its human readable form.
+ * @param value - Value to untransform.
+ * @returns Untransformed, human readable form of value.
+ */
+export function untransform<T>(value: T): T | string {
+  if (Buffer.isBuffer(value)) {
+    return '0x' + value.toString('hex');
+  } else if (typeof value === 'string') {
+    if (value.startsWith('0x')) {
+      return '\\' + value;
+    }
+  } else if (value instanceof Array && value.length > 1) {
+    for (let i = 1; i < value.length; i++) {
+      if (value[i - 1].weight > value[i].weight) {
+        throw new Error('Array elements are not in canonical order');
+      }
+    }
+    return value.map(untransform) as unknown as T;
+  } else if (value instanceof Object) {
+    const properties = Object.getOwnPropertyNames(value);
+    for (let i = 1; i < properties.length; i++) {
+      if (properties[i - 1].localeCompare(properties[i]) > 0) {
+        throw new Error('Object properties are not in caonical order');
+      }
+    }
+    return properties.reduce((acc, name) => {
+      acc[name] = untransform(value[name]);
+      return acc;
+    }, {}) as unknown as T;
+  }
+  return value;
+}
+
+/**
+ * Serialize a value.
+ * @param value - Value to serialize.
+ * @returns Buffer representing serialized value.
+ */
+export function serialize<T>(value: T): Buffer {
+  return encodeCanonical(transform(value));
+}
+
+/**
+ * Deserialize a value.
+ * @param value - Buffer to deserialize.
+ * @returns Deserialized value.
+ */
+export function deserialize(value: Buffer): unknown {
+  return untransform(decodeFirstSync(value));
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * as Cbor from './cbor';

package/test/cbor/fixtures.json

@@ -0,0 +1,96 @@
+[
+  {
+    "deserialized": {
+      "keys": [
+        {
+          "key": "0x010203",
+          "weight": 0
+        },
+        {
+          "key": "0x040506",
+          "weight": 1
+        }
+      ]
+    },
+    "serialized": "a1646b65797382a2636b6579430102036677656967687400a2636b6579430405066677656967687401"
+  },
+  {
+    "deserialized": {
+      "a": "0xffffffff",
+      "b": "0x00000000",
+      "c": "0xffffffff",
+      "d": [
+        {
+          "weight": 0
+        },
+        {
+          "weight": 1
+        },
+        {
+          "weight": 2
+        },
+        {
+          "weight": 3
+        }
+      ]
+    },
+    "serialized": "a4616144ffffffff61624400000000616344ffffffff616484a16677656967687400a16677656967687401a16677656967687402a16677656967687403"
+  },
+  {
+    "deserialized": {
+      "a": [
+        {
+          "value": "a",
+          "weight": 0
+        },
+        {
+          "value": "b",
+          "weight": 0
+        },
+        {
+          "value": "c",
+          "weight": 0
+        }
+      ]
+    },
+    "serialized": "a1616183a26576616c756561616677656967687400a26576616c756561626677656967687400a26576616c756561636677656967687400"
+  },
+  {
+    "deserialized": {
+      "a": [
+        {
+          "value": "0x0a",
+          "weight": 0
+        },
+        {
+          "value": "0x0b",
+          "weight": 0
+        },
+        {
+          "value": "0x0c",
+          "weight": 0
+        }
+      ]
+    },
+    "serialized": "a1616183a26576616c7565410a6677656967687400a26576616c7565410b6677656967687400a26576616c7565410c6677656967687400"
+  },
+  {
+    "deserialized": {
+      "a": [
+        {
+          "value": 1,
+          "weight": 0
+        },
+        {
+          "value": 2,
+          "weight": 0
+        },
+        {
+          "value": 3,
+          "weight": 0
+        }
+      ]
+    },
+    "serialized": "a1616183a26576616c7565016677656967687400a26576616c7565026677656967687400a26576616c7565036677656967687400"
+  }
+]

package/test/unit/deser-lib.ts

@@ -0,0 +1,326 @@
+import { Cbor } from '../..';
+import * as cborFixtures from '../cbor/fixtures.json';
+
+describe('deser-lib', function () {
+  describe('cbor', function () {
+    describe('transform', function () {
+      it('orders object properties canonically', function () {
+        const res = Cbor.transform({ b: 'second', a: 'first' }) as any;
+        const properties = Object.getOwnPropertyNames(res);
+        properties[0].should.equal('a');
+        properties[1].should.equal('b');
+        res.a.should.equal('first');
+        res.b.should.equal('second');
+      });
+
+      describe('canonical ordering', function () {
+        it('orders by weight', function () {
+          const res = Cbor.transform([
+            { weight: 2, value: null },
+            { weight: 1, value: null },
+          ]) as any;
+          res[0].weight.should.equal(1);
+          res[1].weight.should.equal(2);
+        });
+
+        it('groups equal elements', function () {
+          const res = Cbor.transform([
+            {
+              weight: 2,
+              value: 'b',
+            },
+            {
+              weight: 1,
+              value: 'a',
+            },
+            {
+              weight: 3,
+              value: 'c',
+            },
+            {
+              weight: 2,
+              value: 'b',
+            },
+          ]) as any;
+          res[0].weight.should.equal(1);
+          res[1].weight.should.equal(2);
+          res[2].weight.should.equal(2);
+          res[3].weight.should.equal(3);
+        });
+
+        it('orders number values', function () {
+          const res = Cbor.transform([
+            { weight: 1, value: 2 },
+            { weight: 1, value: 1 },
+          ]) as any;
+          res[0].value.should.equal(1);
+          res[1].value.should.equal(2);
+        });
+
+        it('orders string values', function () {
+          const res = Cbor.transform([
+            { weight: 1, value: 'ab' },
+            { weight: 1, value: 'aa' },
+          ]) as any;
+          res[0].value.should.equal('aa');
+          res[1].value.should.equal('ab');
+        });
+
+        it('orders byte values', function () {
+          const res = Cbor.transform([
+            { weight: 1, value: '0x0b' },
+            { weight: 1, value: '0x0a' },
+          ]) as any;
+          res[0].value.equals(Buffer.from([0x0a])).should.equal(true);
+          res[1].value.equals(Buffer.from([0x0b])).should.equal(true);
+        });
+
+        it('orders string values of different lengths', function () {
+          const res = Cbor.transform([
+            { weight: 1, value: 'ab' },
+            { weight: 1, value: 'a' },
+          ]) as any;
+          res[0].value.should.equal('a');
+          res[1].value.should.equal('ab');
+        });
+
+        it('throws for elements without weight', function () {
+          (() => Cbor.transform([{}, {}])).should.throw();
+        });
+
+        it('throws for elements without value', function () {
+          (() => Cbor.transform([{ weight: 1 }, { weight: 1 }])).should.throw();
+        });
+
+        it('throws for values that cannot be compared', function () {
+          (() =>
+            Cbor.transform([
+              { weight: 1, value: {} },
+              { weight: 1, value: 1 },
+            ])).should.throw();
+          (() =>
+            Cbor.transform([
+              { weight: 1, value: undefined },
+              { weight: 1, value: null },
+            ])).should.throw();
+        });
+
+        it('throws for elements of mixed type', function () {
+          (() =>
+            Cbor.transform([
+              { weight: 0, value: '0' },
+              { weight: 0, value: 0 },
+            ])).should.throw();
+        });
+      });
+
+      it('preserves null values', function () {
+        const res = Cbor.transform({ value: null }) as any;
+        res.should.have.property('value').which.is.null();
+      });
+
+      it('replaces prefixed hex strings with Buffers', function () {
+        const hex = '00010203';
+        const res = Cbor.transform({ value: '0x' + hex }) as any;
+        Buffer.isBuffer(res.value).should.equal(true);
+        res.value.equals(Buffer.from(hex, 'hex')).should.equal(true);
+      });
+
+      it('preserves non-prefixed hex strings', function () {
+        const string = '00010203';
+        const res = Cbor.transform({ value: string }) as any;
+        res.value.should.equal(string);
+      });
+
+      it('preserves escaped strings', function () {
+        const string = '0xPrefixedString';
+        const res = Cbor.transform({ value: '\\' + string }) as any;
+        res.value.should.equal(string);
+      });
+
+      it('transforms object recursively', function () {
+        const res = Cbor.transform({ value: { b: 'second', a: 'first' } }) as any;
+        const properties = Object.getOwnPropertyNames(res.value);
+        properties[0].should.equal('a');
+        properties[1].should.equal('b');
+        res.value.a.should.equal('first');
+        res.value.b.should.equal('second');
+      });
+
+      it('transforms array recursively', function () {
+        const res = Cbor.transform([{ weight: 0, value: { b: 'second', a: 'first' } }]) as any;
+        const properties = Object.getOwnPropertyNames(res[0].value);
+        properties[0].should.equal('a');
+        properties[1].should.equal('b');
+        res[0].value.a.should.equal('first');
+        res[0].value.b.should.equal('second');
+      });
+
+      it('throws for invalid hex strings', function () {
+        (() => Cbor.transform('0x0g')).should.throw();
+      });
+    });
+
+    describe('untransform', function () {
+      it('untransforms object', function () {
+        const res = Cbor.untransform({ a: 'first', b: 'second' }) as any;
+        const properties = Object.getOwnPropertyNames(res);
+        properties[0].should.equal('a');
+        properties[1].should.equal('b');
+        res.a.should.equal('first');
+        res.b.should.equal('second');
+      });
+
+      it('enforces canonical object property order', function () {
+        (() => Cbor.untransform({ b: 'second', a: 'first' })).should.throw();
+      });
+
+      it('enforces canonical array element order', function () {
+        (() => Cbor.untransform([{ weight: 2 }, { weight: 1 }])).should.throw();
+      });
+
+      it('replaces Buffers with prefixed hex strings', function () {
+        const hex = '00010203';
+        const res = Cbor.untransform({ value: Buffer.from(hex, 'hex') }) as any;
+        res.value.should.equal('0x' + hex);
+      });
+
+      it('preserves non-prefixed hex strings', function () {
+        const string = '00010203';
+        const res = Cbor.untransform({ value: string }) as any;
+        res.value.should.equal(string);
+      });
+
+      it('escapes prefixed string', function () {
+        const string = '0xPrefixedString';
+        const res = Cbor.untransform({ value: string }) as any;
+        res.value.should.equal('\\' + string);
+      });
+
+      it('untransforms object recursively', function () {
+        const hex = '00010203';
+        const res = Cbor.untransform({ value: { value: Buffer.from(hex, 'hex') } }) as any;
+        res.value.value.should.equal('0x' + hex);
+      });
+
+      it('untransforms array recursively', function () {
+        const hex = '00010203';
+        const res = Cbor.untransform([{ value: Buffer.from(hex, 'hex'), weight: 0 }]) as any;
+        res[0].value.should.equal('0x' + hex);
+      });
+    });
+
+    describe('fixtures', function () {
+      xit('creates test vectors', function () {
+        const { writeFileSync } = require('fs');
+        const deserialized = [
+          {
+            keys: [
+              {
+                key: '0x010203',
+                weight: 0,
+              },
+              {
+                key: '0x040506',
+                weight: 1,
+              },
+            ],
+          },
+          {
+            a: '0xffffffff',
+            b: '0x00000000',
+            c: '0xffffffff',
+            d: [
+              {
+                weight: 0,
+              },
+              {
+                weight: 1,
+              },
+              {
+                weight: 2,
+              },
+              {
+                weight: 3,
+              },
+            ],
+          },
+          {
+            a: [
+              {
+                value: 'a',
+                weight: 0,
+              },
+              {
+                value: 'b',
+                weight: 0,
+              },
+              {
+                value: 'c',
+                weight: 0,
+              },
+            ],
+          },
+          {
+            a: [
+              {
+                weight: 0,
+                value: '0x0a',
+              },
+              {
+                weight: 0,
+                value: '0x0b',
+              },
+              {
+                weight: 0,
+                value: '0x0c',
+              },
+            ],
+          },
+          {
+            a: [
+              {
+                weight: 0,
+                value: 1,
+              },
+              {
+                weight: 0,
+                value: 2,
+              },
+              {
+                weight: 0,
+                value: 3,
+              },
+            ],
+          },
+        ];
+        const serialized = deserialized.map((x) => Cbor.serialize(x).toString('hex'));
+        writeFileSync(
+          'test/cbor/fixtures.json',
+          JSON.stringify(
+            deserialized.map((deserialized, i) => ({
+              deserialized: Cbor.untransform(Cbor.transform(deserialized)),
+              serialized: serialized[i],
+            })),
+            null,
+            2
+          )
+        );
+      });
+
+      for (let i = 0; i < cborFixtures.length; i++) {
+        it(`deserializes vector[${i}]`, function () {
+          const { deserialized, serialized } = cborFixtures[i];
+          Cbor.serialize(deserialized).equals(Buffer.from(serialized, 'hex')).should.equal(true);
+        });
+      }
+
+      for (let i = 0; i < cborFixtures.length; i++) {
+        it(`serializes vector[${i}]`, function () {
+          const { deserialized, serialized } = cborFixtures[i];
+          JSON.stringify(Cbor.deserialize(Buffer.from(serialized, 'hex'))).should.equal(JSON.stringify(deserialized));
+        });
+      }
+    });
+  });
+});

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "."
+  },
+  "include": ["src/**/*", "package.json"]
+}