@transia/ripple-binary-codec 1.4.6-alpha.8 → 2.5.1

package/dist/utils.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compare = exports.equal = exports.readInt64BE = exports.readInt32BE = exports.readUInt32BE = exports.readUInt16BE = exports.writeInt64BE = exports.writeInt32BE = exports.writeUInt32BE = exports.writeUInt16BE = exports.writeUInt8 = void 0;
+/**
+ * Writes value to array at the specified offset. The value must be a valid unsigned 8-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+function writeUInt8(array, value, offset) {
+    value = Number(value);
+    array[offset] = value;
+}
+exports.writeUInt8 = writeUInt8;
+/**
+ * Writes value to array at the specified offset as big-endian. The value must be a valid unsigned 16-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+function writeUInt16BE(array, value, offset) {
+    value = Number(value);
+    array[offset] = value >>> 8;
+    array[offset + 1] = value;
+}
+exports.writeUInt16BE = writeUInt16BE;
+/**
+ * Writes value to array at the specified offset as big-endian. The value must be a valid unsigned 32-bit integer.
+ * @param array Uint8Array to be written to
+ * @param value Number to be written to array.
+ * @param offset plus the number of bytes written.
+ */
+function writeUInt32BE(array, value, offset) {
+    array[offset] = (value >>> 24) & 0xff;
+    array[offset + 1] = (value >>> 16) & 0xff;
+    array[offset + 2] = (value >>> 8) & 0xff;
+    array[offset + 3] = value & 0xff;
+}
+exports.writeUInt32BE = writeUInt32BE;
+/**
+ * Writes a signed 32-bit integer to a Uint8Array at the specified offset (big-endian).
+ *
+ * @param array - The Uint8Array to write to.
+ * @param value - The signed 32-bit integer to write.
+ * @param offset - The offset at which to write.
+ */
+function writeInt32BE(array, value, offset) {
+    new DataView(array.buffer, array.byteOffset, array.byteLength).setInt32(offset, value, false);
+}
+exports.writeInt32BE = writeInt32BE;
+/**
+ * Writes a signed 64-bit integer (BigInt) to a Uint8Array at the specified offset (big-endian).
+ *
+ * @param array - The Uint8Array to write to.
+ * @param value - The signed 64-bit integer (BigInt) to write.
+ * @param offset - The offset at which to write.
+ */
+function writeInt64BE(array, value, offset) {
+    new DataView(array.buffer, array.byteOffset, array.byteLength).setBigInt64(offset, value, false);
+}
+exports.writeInt64BE = writeInt64BE;
+/**
+ * Reads an unsigned, big-endian 16-bit integer from the array at the specified offset.
+ * @param array Uint8Array to read
+ * @param offset Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2
+ */
+function readUInt16BE(array, offset) {
+    return new DataView(array.buffer).getUint16(offset, false).toString(10);
+}
+exports.readUInt16BE = readUInt16BE;
+/**
+ * Reads an unsigned, big-endian 16-bit integer from the array at the specified offset.
+ * @param array Uint8Array to read
+ * @param offset Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4
+ */
+function readUInt32BE(array, offset) {
+    return new DataView(array.buffer).getUint32(offset, false).toString(10);
+}
+exports.readUInt32BE = readUInt32BE;
+/**
+ * Reads a signed 32-bit integer from a Uint8Array at the specified offset (big-endian).
+ *
+ * @param array - The Uint8Array to read from.
+ * @param offset - The offset at which to start reading.
+ * @returns The signed 32-bit integer.
+ */
+function readInt32BE(array, offset) {
+    return new DataView(array.buffer, array.byteOffset, array.byteLength).getInt32(offset, false);
+}
+exports.readInt32BE = readInt32BE;
+/**
+ * Reads a signed 64-bit integer (BigInt) from a Uint8Array at the specified offset (big-endian).
+ *
+ * @param array - The Uint8Array to read from.
+ * @param offset - The offset at which to start reading.
+ * @returns The signed 64-bit integer (BigInt).
+ */
+function readInt64BE(array, offset) {
+    return new DataView(array.buffer, array.byteOffset, array.byteLength).getBigInt64(offset, false);
+}
+exports.readInt64BE = readInt64BE;
+/**
+ * Compares two Uint8Array or ArrayBuffers
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function equal(a, b) {
+    const aUInt = a instanceof ArrayBuffer ? new Uint8Array(a, 0) : a;
+    const bUInt = b instanceof ArrayBuffer ? new Uint8Array(b, 0) : b;
+    if (aUInt.byteLength != bUInt.byteLength)
+        return false;
+    if (aligned32(aUInt) && aligned32(bUInt))
+        return compare32(aUInt, bUInt) === 0;
+    if (aligned16(aUInt) && aligned16(bUInt))
+        return compare16(aUInt, bUInt) === 0;
+    return compare8(aUInt, bUInt) === 0;
+}
+exports.equal = equal;
+/**
+ * Compares two 8 bit aligned arrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare8(a, b) {
+    const ua = new Uint8Array(a.buffer, a.byteOffset, a.byteLength);
+    const ub = new Uint8Array(b.buffer, b.byteOffset, b.byteLength);
+    return compare(ua, ub);
+}
+/**
+ * Compares two 16 bit aligned arrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare16(a, b) {
+    const ua = new Uint16Array(a.buffer, a.byteOffset, a.byteLength / 2);
+    const ub = new Uint16Array(b.buffer, b.byteOffset, b.byteLength / 2);
+    return compare(ua, ub);
+}
+/**
+ * Compares two 32 bit aligned arrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare32(a, b) {
+    const ua = new Uint32Array(a.buffer, a.byteOffset, a.byteLength / 4);
+    const ub = new Uint32Array(b.buffer, b.byteOffset, b.byteLength / 4);
+    return compare(ua, ub);
+}
+/**
+ * Compare two TypedArrays
+ * @param a first array to compare
+ * @param b second array to compare
+ */
+function compare(a, b) {
+    if (a.byteLength !== b.byteLength) {
+        throw new Error('Cannot compare arrays of different length');
+    }
+    for (let i = 0; i < a.length - 1; i += 1) {
+        if (a[i] > b[i])
+            return 1;
+        if (a[i] < b[i])
+            return -1;
+    }
+    return 0;
+}
+exports.compare = compare;
+/**
+ * Determine if TypedArray is 16 bit aligned
+ * @param array The array to check
+ */
+function aligned16(array) {
+    return array.byteOffset % 2 === 0 && array.byteLength % 2 === 0;
+}
+/**
+ * Determine if TypedArray is 32 bit aligned
+ * @param array The array to check
+ */
+function aligned32(array) {
+    return array.byteOffset % 4 === 0 && array.byteLength % 4 === 0;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAGA;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACrB,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAA;AACvB,CAAC;AAPD,gCAOC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IAErB,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,KAAK,CAAC,CAAA;IAC3B,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAA;AAC3B,CAAC;AATD,sCASC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IACrC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC,GAAG,IAAI,CAAA;IACzC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,IAAI,CAAA;IACxC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAA;AAClC,CAAC;AATD,sCASC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,QAAQ,CACrE,MAAM,EACN,KAAK,EACL,KAAK,CACN,CAAA;AACH,CAAC;AAVD,oCAUC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,KAAiB,EACjB,KAAa,EACb,MAAc;IAEd,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,WAAW,CACxE,MAAM,EACN,KAAK,EACL,KAAK,CACN,CAAA;AACH,CAAC;AAVD,oCAUC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAiB,EAAE,MAAc;IAC5D,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AACzE,CAAC;AAFD,oCAEC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAiB,EAAE,MAAc;IAC5D,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AACzE,CAAC;AAFD,oCAEC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,KAAiB,EAAE,MAAc;IAC3D,OAAO,IAAI,QAAQ,CACjB,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,UAAU,CACjB,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC3B,CAAC;AAND,kCAMC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,KAAiB,EAAE,MAAc;IAC3D,OAAO,IAAI,QAAQ,CACjB,KAAK,CAAC,MAAM,EACZ,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,UAAU,CACjB,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC9B,CAAC;AAND,kCAMC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CACnB,CAA2B,EAC3B,CAA2B;IAE3B,MAAM,KAAK,GAAG,CAAC,YAAY,WAAW,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACjE,MAAM,KAAK,GAAG,CAAC,YAAY,WAAW,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACjE,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IACtD,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC9E,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC9E,OAAO,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;AACrC,CAAC;AAVD,sBAUC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,CAAC,EAAE,CAAC;IACpB,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAA;IAC/D,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAA;IAC/D,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,CAAa,EAAE,CAAa;IAC7C,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,CAAa,EAAE,CAAa;IAC7C,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,MAAM,EAAE,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,OAAO,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAC,CAAa,EAAE,CAAa;IAClD,IAAI,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;KAC7D;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;QACxC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAA;QACzB,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAA;KAC3B;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAVD,0BAUC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,KAAiB;IAClC,OAAO,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,KAAiB;IAClC,OAAO,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,CAAA;AACjE,CAAC"}

package/package.json

@@ -1,34 +1,38 @@
 {
   "name": "@transia/ripple-binary-codec",
-  "version": "1.4.6-alpha.8",
+  "version": "2.5.1",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",
-    "bin/*",
-    "test/*"
+    "src/*"
   ],
   "main": "dist/",
   "directories": {
     "test": "test"
   },
   "dependencies": {
-    "@transia/ripple-address-codec": "^4.2.8-alpha.0",
-    "assert": "^2.0.0",
-    "big-integer": "^1.6.48",
-    "buffer": "5.6.0",
-    "create-hash": "^1.2.0",
-    "decimal.js": "^10.2.0"
+    "@transia/isomorphic": "^1.0.1",
+    "@transia/ripple-address-codec": "^5.0.0",
+    "bignumber.js": "^9.0.0"
   },
   "scripts": {
-    "build": "tsc -b && copyfiles ./src/enums/definitions.json ./dist/enums/",
-    "clean": "rm -rf ./dist && rm -rf tsconfig.tsbuildinfo",
-    "prepare": "npm run build && npm test",
-    "test": "jest --verbose false --silent=false ./test/*.test.js",
-    "lint": "eslint . --ext .ts --ext .test.js"
+    "build": "tsc --build tsconfig.build.json && copyfiles ./src/enums/definitions.json ./dist/enums/",
+    "clean": "rm -rf ./dist ./coverage ./test/testCompiledForWeb tsconfig.build.tsbuildinfo",
+    "prepublishOnly": "npm test",
+    "test": "npm run build && jest --verbose false --silent=false ./test/*.test.ts",
+    "test:browser": "npm run build && karma start ./karma.config.js",
+    "lint": "eslint . --max-warnings 0",
+    "generateDefinitions": "node ./tools/generateDefinitions.js"
   },
+  "keywords": [
+    "ripple",
+    "xrp",
+    "xrp ledger",
+    "xrpl"
+  ],
   "repository": {
     "type": "git",
-    "url": "git@github.com/Transia-RnD/xrpl.js/tree/beta"
+    "url": "git@github.com:XRPLF/xrpl.js.git"
   },
   "bugs": {
     "url": "https://github.com/XRPLF/xrpl.js/issues"
@@ -38,7 +42,7 @@
   "readmeFilename": "README.md",
   "prettier": "@xrplf/prettier-config",
   "engines": {
-    "node": ">= 10"
+    "node": ">= 18"
   },
-  "gitHead": "036312d3616ebc761b0096ba6828a29764f01221"
+  "gitHead": "cdaeed0dc8ccb726deb35aaaddcc229eb9aabe6c"
 }

package/src/README.md

@@ -0,0 +1,5 @@
+# ripple-binary-codec
+
+Serialize and deserialize transactions according to the XRP Ledger protocol.
+
+If you'd like to add a new transaction, data type, or generally modify this library, please read the [CONTRIBUTING.md](CONTRIBUTING.md)

package/src/binary.ts

@@ -0,0 +1,235 @@
+/* eslint-disable func-style */
+
+import { bytesToHex } from '@transia/isomorphic/utils'
+import { coreTypes } from './types'
+import { BinaryParser } from './serdes/binary-parser'
+import { AccountID } from './types/account-id'
+import { HashPrefix } from './hash-prefixes'
+import { BinarySerializer, BytesList } from './serdes/binary-serializer'
+import { sha512Half, transactionID } from './hashes'
+import {
+  type XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
+  type FieldInstance,
+} from './enums'
+import { STObject } from './types/st-object'
+import { JsonObject } from './types/serialized-type'
+
+/**
+ * Construct a BinaryParser
+ *
+ * @param bytes hex-string or Uint8Array to construct BinaryParser from
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns BinaryParser
+ */
+const makeParser = (
+  bytes: string | Uint8Array,
+  definitions?: XrplDefinitionsBase,
+): BinaryParser =>
+  new BinaryParser(
+    bytes instanceof Uint8Array ? bytesToHex(bytes) : bytes,
+    definitions,
+  )
+
+/**
+ * Parse BinaryParser into JSON
+ *
+ * @param parser BinaryParser object
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON for the bytes in the BinaryParser
+ */
+const readJSON = (
+  parser: BinaryParser,
+  definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
+): JsonObject =>
+  (parser.readType(coreTypes.STObject) as STObject).toJSON(definitions)
+
+/**
+ * Parse a hex-string into its JSON interpretation
+ *
+ * @param bytes hex-string to parse into JSON
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
+ * @returns JSON
+ */
+const binaryToJSON = (
+  bytes: string,
+  definitions?: XrplDefinitionsBase,
+): JsonObject => readJSON(makeParser(bytes, definitions), definitions)
+
+/**
+ * Interface for passing parameters to SerializeObject
+ *
+ * @field set signingFieldOnly to true if you want to serialize only signing fields
+ */
+interface OptionObject {
+  prefix?: Uint8Array
+  suffix?: Uint8Array
+  signingFieldsOnly?: boolean
+  definitions?: XrplDefinitionsBase
+}
+
+/**
+ * Function to serialize JSON object representing a transaction
+ *
+ * @param object JSON object to serialize
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
+ * @returns A Uint8Array containing the serialized object
+ */
+function serializeObject(
+  object: JsonObject,
+  opts: OptionObject = {},
+): Uint8Array {
+  const { prefix, suffix, signingFieldsOnly = false, definitions } = opts
+  const bytesList = new BytesList()
+
+  if (prefix) {
+    bytesList.put(prefix)
+  }
+
+  const filter = signingFieldsOnly
+    ? (f: FieldInstance): boolean => f.isSigningField
+    : undefined
+  ;(coreTypes.STObject as typeof STObject)
+    .from(object, filter, definitions)
+    .toBytesSink(bytesList)
+
+  if (suffix) {
+    bytesList.put(suffix)
+  }
+
+  return bytesList.toBytes()
+}
+
+/**
+ * Serialize an object for signing
+ *
+ * @param transaction Transaction to serialize
+ * @param prefix Prefix bytes to put before the serialized object
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns A Uint8Array with the serialized object
+ */
+function signingData(
+  transaction: JsonObject,
+  prefix: Uint8Array = HashPrefix.transactionSig,
+  opts: { definitions?: XrplDefinitionsBase } = {},
+): Uint8Array {
+  return serializeObject(transaction, {
+    prefix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
+}
+
+/**
+ * Interface describing fields required for a Claim
+ */
+interface ClaimObject extends JsonObject {
+  channel: string
+  amount: string | number
+}
+
+/**
+ * Serialize a signingClaim
+ *
+ * @param claim A claim object to serialize
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns the serialized object with appropriate prefix
+ */
+function signingClaimData(claim: ClaimObject): Uint8Array {
+  const num = BigInt(String(claim.amount))
+  const prefix = HashPrefix.paymentChannelClaim
+  const channel = coreTypes.Hash256.from(claim.channel).toBytes()
+  const amount = coreTypes.UInt64.from(num).toBytes()
+
+  const bytesList = new BytesList()
+
+  bytesList.put(prefix)
+  bytesList.put(channel)
+  bytesList.put(amount)
+  return bytesList.toBytes()
+}
+
+/**
+ * Serialize a transaction object for multiSigning
+ *
+ * @param transaction transaction to serialize
+ * @param signingAccount Account to sign the transaction with
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ * @returns serialized transaction with appropriate prefix and suffix
+ */
+function multiSigningData(
+  transaction: JsonObject,
+  signingAccount: string | AccountID,
+  opts: { definitions: XrplDefinitionsBase } = {
+    definitions: DEFAULT_DEFINITIONS,
+  },
+): Uint8Array {
+  const prefix = HashPrefix.transactionMultiSig
+  const suffix = coreTypes.AccountID.from(signingAccount).toBytes()
+  return serializeObject(transaction, {
+    prefix,
+    suffix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
+}
+
+/**
+ * Interface describing fields required for a Batch signer
+ * @property flags - Flags indicating Batch transaction properties
+ * @property txIDs - Array of transaction IDs included in the Batch
+ */
+interface BatchObject extends JsonObject {
+  flags: number
+  txIDs: string[]
+}
+
+/**
+ * Serialize a signingClaim
+ *
+ * @param batch A Batch object to serialize.
+ * @returns the serialized object with appropriate prefix
+ */
+function signingBatchData(batch: BatchObject): Uint8Array {
+  if (batch.flags == null) {
+    throw Error("No field `flags'")
+  }
+  if (batch.txIDs == null) {
+    throw Error('No field `txIDs`')
+  }
+  const prefix = HashPrefix.batch
+  const flags = coreTypes.UInt32.from(batch.flags).toBytes()
+  const txIDsLength = coreTypes.UInt32.from(batch.txIDs.length).toBytes()
+
+  const bytesList = new BytesList()
+
+  bytesList.put(prefix)
+  bytesList.put(flags)
+  bytesList.put(txIDsLength)
+  batch.txIDs.forEach((txID: string) => {
+    bytesList.put(coreTypes.Hash256.from(txID).toBytes())
+  })
+
+  return bytesList.toBytes()
+}
+
+export {
+  BinaryParser,
+  BinarySerializer,
+  BytesList,
+  ClaimObject,
+  BatchObject,
+  makeParser,
+  serializeObject,
+  readJSON,
+  multiSigningData,
+  signingData,
+  signingClaimData,
+  binaryToJSON,
+  sha512Half,
+  transactionID,
+  signingBatchData,
+}

package/src/coretypes.ts

@@ -0,0 +1,31 @@
+import {
+  DEFAULT_DEFINITIONS,
+  Field,
+  TransactionType,
+  LedgerEntryType,
+  Type,
+  TransactionResult,
+} from './enums'
+import * as types from './types'
+import * as binary from './binary'
+import { ShaMap } from './shamap'
+import * as ledgerHashes from './ledger-hashes'
+import * as hashes from './hashes'
+import { quality } from './quality'
+import { HashPrefix } from './hash-prefixes'
+
+export {
+  hashes,
+  binary,
+  ledgerHashes,
+  DEFAULT_DEFINITIONS,
+  Field,
+  TransactionType,
+  LedgerEntryType,
+  Type,
+  TransactionResult,
+  quality,
+  HashPrefix,
+  ShaMap,
+  types,
+}

package/src/enums/README.md

@@ -0,0 +1,144 @@
+# Definitions
+
+This file is used to serialize/deserialize transactions and ledger objects for the XRPL. It's broken into 5 sections laid out below.
+
+At the bottom of this README you can find instructions and examples for how to define your own types in a definitions file in order to work on a custom sidechain or develop new amendments.
+
+## Types
+
+These are the [types](https://xrpl.org/serialization.html#type-list) associated with a given Serialization Field. Each type has an arbitrary [type_code](https://xrpl.org/serialization.html#type-codes), with lower codes sorting first.
+
+## Ledger Entry Types
+
+Each ledger's state tree contain [ledger objects](https://xrpl.org/ledger-object-types.html), which represent all settings, balances, and relationships in the shared ledger.
+
+## Fields
+
+These are Serialization Fields (`sf`) [defined in rippled's SField.cpp](https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/impl/SField.cpp). Fields with undefined values are omitted before encoding.
+
+### Key
+
+The key is the string defined in the rippled source code, such as "LedgerEntry", "Transaction", etc.
+
+### nth
+
+`nth` is the sort code, meaning "nth of type." It is is combined with the type code in order to construct the Field ID of this field. The Field ID is only used for sorting the fields. Since there are multiple fields with the same data type, the `nth` is used to deterministically order each field among other fields of the same data type.
+
+Each field has a Field ID, which is used to sort fields that have the same type as one another with lower codes sorting first.
+
+- [Field definitions](https://github.com/ripple/rippled/blob/72e6005f562a8f0818bc94803d222ac9345e1e40/src/ripple/protocol/impl/SField.cpp#L72-L266)
+- [Constructing the `SField` field codes](https://github.com/ripple/rippled/blob/eaff9a0e6aec0ad077f118501791c7684debcfd5/src/ripple/protocol/SField.h#L95-L98)
+
+For example, the `Account` field has sort code (nth) `1`, so it comes before the `Destination` field which has sort code `3`.
+
+Sort code numbers are reused for fields of different types, but different fields of the same type never have the same sort code. When you combine the type code with the sort code, you get the field's unique _Field ID_.
+
+The unique [Field ID](https://xrpl.org/serialization.html#field-ids) is prefixed before the field in the final serialized blob. The size of the Field ID is one to three bytes depending on the type code and the field codes it combines.
+
+### isVLEncoded
+
+If true, the field is Variable Length encoded and [length-prefixed](https://xrpl.org/serialization.html#length-prefixing). The variable-length encoded fields are `STI_VL`/`Blob`, `STI_ACCOUNT`/`AccountID`, and `STI_VECTOR256`/`Vector256`.
+
+### isSerialized
+
+Fields are serialized if they are not [one of these](https://github.com/ripple/rippled/blob/eaff9a0e6aec0ad077f118501791c7684debcfd5/src/ripple/protocol/impl/SField.cpp#L71-L78) or if they are not an SField.
+
+- https://github.com/ripple/ripple-binary-codec/blob/14e76e68ead7e4bcd83c942dbdc9064d5a66869b/src/enums/definitions.json#L832
+- https://github.com/ripple/rippled/search?utf8=%E2%9C%93&q=taker_gets_funded&type=
+
+### isSigningField
+
+True unless the field is [specified with `SField::notSigning`](https://github.com/ripple/rippled/blob/eaff9a0e6aec0ad077f118501791c7684debcfd5/src/ripple/protocol/impl/SField.cpp#L198).
+
+## Transaction Results
+
+See:
+
+- https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/TER.h
+- https://xrpl.org/transaction-results.html
+
+To generate a new definitions file from rippled source code, use [this tool](../../tools/generateDefinitions.js).
+
+## Transaction Types
+
+See https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/TxFormats.h
+
+# Defining Your Own Definitions
+
+If you're building your own sidechain or writing an amendment for the XRPL, you may need to create new XRPL definitions.
+
+To do that there are a couple things you need to do:
+
+1. Generate your own `definitions.json` file from rippled source code using [this tool](../../tools/generateDefinitions.js). The default `definitions.json` for mainnet can be found [here](https://github.com/XRPLF/xrpl.js/blob/main/packages/ripple-binary-codec/src/enums/definitions.json).
+2. Create new SerializedType classes for any new Types (So that encode/decode behavior is defined). The SerializedType classes correspond to "ST..." classes in Rippled. Note: This is very rarely required.
+
+- For examples of how to implement that you can look at objects in the [`types` folder](../types/), such as `Amount`, `UInt8`, or `STArray`.
+
+3. Import your `definitions.json` file to construct your own `XrplDefinitions` object.
+4. Pass the `XrplDefinitions` object whenever you `encode` or `decode` a transaction.
+5. If you added any new transaction types, you should create an `interface` for the transaction that extends `BaseTransaction` from the `xrpl` repo to use it with the functions on `Client` (See the below example of adding a new transaction type)
+
+## Example of adding a new Transaction type
+
+```
+// newDefinitionsJson is where you can import your custom defined definitions.json file
+const newDefinitionsJson = require('./new-transaction-type-definitions.json')
+const { XrplDefinitions, Client } = require('xrpl')
+
+const newDefs = new XrplDefinitions(newDefinitionsJson)
+
+// Change to point at the server you care about
+const serverAddress = 'wss://s.devnet.rippletest.net:51233'
+const client = new Client(serverAddress)
+const wallet1 = await client.fundWallet()
+
+// Extending BaseTransaction allows typescript to recognize this as a transaction type
+interface NewTx extends BaseTransaction {
+    Amount: Amount
+}
+
+const tx: NewTx = {
+    // The TransactionType here needs to match what you added in your newDefinitionsJson file
+    TransactionType: 'NewTx',
+    Account: wallet1.address,
+    Amount: '100',
+}
+
+// By passing in your newDefs, your new transaction should be serializable.
+// Rippled will still throw an error though if it's not a supported transaction type.
+const result = await client.submitAndWait(tx, {
+    wallet: wallet1,
+    definitions: newDefs,
+})
+```
+
+## Example of adding a new serializable Type
+
+```
+const { XrplDefinitions } = require('../dist/coretypes')
+
+// newDefinitionsJson is where you can import your custom defined definitions.json file
+const newDefinitionsJson = require('./fixtures/new-definitions.json')
+
+
+// For any new Types you create, you'll need to make a class with the same name which extends a SerializedType object
+// In order to define how to serialize/deserialize that field. Here we simply make our NewType act like a UInt32.
+
+const { UInt32 } = require('../dist/types/uint-32')
+class NewType extends UInt32 {
+  // Should be the same as UInt32
+}
+
+const extendedCoreTypes = { NewType }
+
+const newDefs = new XrplDefinitions(newDefinitionsJson, extendedCoreTypes)
+
+// From this point on, we should be able to serialize / deserialize Transactions with fields that have 'NewType' as their Type.
+
+const encoded = encode(my_tx, newDefs)
+const decoded = decode(encoded, newDefs)
+```
+
+## Other examples
+
+You can find other examples of how to modify `definitions.json` in `definition.test.js` which contains tests for this feature, and uses various example modified `definition` files. You can find the tests and the corresponding example `definition` files in [this folder of test cases](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec/test)