ripple-binary-codec 1.5.0-beta.2 → 1.5.0-beta.4

package/dist/binary.d.ts

@@ -2,29 +2,37 @@ import { BinaryParser } from './serdes/binary-parser';
 import { AccountID } from './types/account-id';
 import { BinarySerializer, BytesList } from './serdes/binary-serializer';
 import { sha512Half, transactionID } from './hashes';
+import { type XrplDefinitionsBase } from './enums';
 import { JsonObject } from './types/serialized-type';
 import { Buffer } from 'buffer/';
+import { AmountObject } from './types/amount';
 /**
  * Construct a BinaryParser
  *
  * @param bytes hex-string 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 A BinaryParser
  */
-declare const makeParser: (bytes: string) => BinaryParser;
+declare const makeParser: (bytes: string, definitions?: XrplDefinitionsBase) => BinaryParser;
 /**
  * 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
  */
-declare const readJSON: (parser: BinaryParser) => JsonObject;
+declare const readJSON: (parser: BinaryParser, definitions?: XrplDefinitionsBase) => JsonObject;
 /**
  * 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
  */
-declare const binaryToJSON: (bytes: string) => JsonObject;
+declare const binaryToJSON: (bytes: string, definitions?: XrplDefinitionsBase) => JsonObject;
 /**
  * Interface for passing parameters to SerializeObject
  *
@@ -34,12 +42,13 @@ interface OptionObject {
     prefix?: Buffer;
     suffix?: Buffer;
     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, and signingFieldOnly
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
  * @returns A Buffer containing the serialized object
  */
 declare function serializeObject(object: JsonObject, opts?: OptionObject): Buffer;
@@ -48,20 +57,24 @@ declare function serializeObject(object: JsonObject, opts?: OptionObject): Buffe
  *
  * @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 Buffer with the serialized object
  */
-declare function signingData(transaction: JsonObject, prefix?: Buffer): Buffer;
+declare function signingData(transaction: JsonObject, prefix?: Buffer, opts?: {
+    definitions?: XrplDefinitionsBase;
+}): Buffer;
 /**
  * Interface describing fields required for a Claim
  */
 interface ClaimObject extends JsonObject {
     channel: string;
-    amount: string | number;
+    amount: AmountObject;
 }
 /**
  * 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
  */
 declare function signingClaimData(claim: ClaimObject): Buffer;
@@ -70,7 +83,10 @@ declare function signingClaimData(claim: ClaimObject): Buffer;
  *
  * @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
  */
-declare function multiSigningData(transaction: JsonObject, signingAccount: string | AccountID): Buffer;
+declare function multiSigningData(transaction: JsonObject, signingAccount: string | AccountID, opts?: {
+    definitions: XrplDefinitionsBase;
+}): Buffer;
 export { BinaryParser, BinarySerializer, BytesList, ClaimObject, makeParser, serializeObject, readJSON, multiSigningData, signingData, signingClaimData, binaryToJSON, sha512Half, transactionID, };

package/dist/binary.js

@@ -2,61 +2,67 @@
 /* eslint-disable func-style */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transactionID = exports.sha512Half = exports.binaryToJSON = exports.signingClaimData = exports.signingData = exports.multiSigningData = exports.readJSON = exports.serializeObject = exports.makeParser = exports.BytesList = exports.BinarySerializer = exports.BinaryParser = void 0;
-var types_1 = require("./types");
-var binary_parser_1 = require("./serdes/binary-parser");
+const types_1 = require("./types");
+const binary_parser_1 = require("./serdes/binary-parser");
 Object.defineProperty(exports, "BinaryParser", { enumerable: true, get: function () { return binary_parser_1.BinaryParser; } });
-var hash_prefixes_1 = require("./hash-prefixes");
-var binary_serializer_1 = require("./serdes/binary-serializer");
+const hash_prefixes_1 = require("./hash-prefixes");
+const binary_serializer_1 = require("./serdes/binary-serializer");
 Object.defineProperty(exports, "BinarySerializer", { enumerable: true, get: function () { return binary_serializer_1.BinarySerializer; } });
 Object.defineProperty(exports, "BytesList", { enumerable: true, get: function () { return binary_serializer_1.BytesList; } });
-var hashes_1 = require("./hashes");
+const hashes_1 = require("./hashes");
 Object.defineProperty(exports, "sha512Half", { enumerable: true, get: function () { return hashes_1.sha512Half; } });
 Object.defineProperty(exports, "transactionID", { enumerable: true, get: function () { return hashes_1.transactionID; } });
-var bigInt = require("big-integer");
+const enums_1 = require("./enums");
+const bigInt = require("big-integer");
 /**
  * Construct a BinaryParser
  *
  * @param bytes hex-string 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 A BinaryParser
  */
-var makeParser = function (bytes) { return new binary_parser_1.BinaryParser(bytes); };
+const makeParser = (bytes, definitions) => new binary_parser_1.BinaryParser(bytes, definitions);
 exports.makeParser = makeParser;
 /**
  * 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
  */
-var readJSON = function (parser) {
-    return parser.readType(types_1.coreTypes.STObject).toJSON();
-};
+const readJSON = (parser, definitions = enums_1.DEFAULT_DEFINITIONS) => parser.readType(types_1.coreTypes.STObject).toJSON(definitions);
 exports.readJSON = readJSON;
 /**
  * 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
  */
-var binaryToJSON = function (bytes) { return readJSON(makeParser(bytes)); };
+const binaryToJSON = (bytes, definitions) => readJSON(makeParser(bytes, definitions), definitions);
 exports.binaryToJSON = binaryToJSON;
 /**
  * Function to serialize JSON object representing a transaction
  *
  * @param object JSON object to serialize
- * @param opts options for serializing, including optional prefix, suffix, and signingFieldOnly
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
  * @returns A Buffer containing the serialized object
  */
-function serializeObject(object, opts) {
-    if (opts === void 0) { opts = {}; }
-    var prefix = opts.prefix, suffix = opts.suffix, _a = opts.signingFieldsOnly, signingFieldsOnly = _a === void 0 ? false : _a;
-    var bytesList = new binary_serializer_1.BytesList();
+function serializeObject(object, opts = {}) {
+    const { prefix, suffix, signingFieldsOnly = false, definitions } = opts;
+    const bytesList = new binary_serializer_1.BytesList();
     if (prefix) {
         bytesList.put(prefix);
     }
-    var filter = signingFieldsOnly
-        ? function (f) { return f.isSigningField; }
+    const filter = signingFieldsOnly
+        ? (f) => f.isSigningField
         : undefined;
-    types_1.coreTypes.STObject.from(object, filter).toBytesSink(bytesList);
+    types_1.coreTypes.STObject
+        .from(object, filter, definitions)
+        .toBytesSink(bytesList);
     if (suffix) {
         bytesList.put(suffix);
     }
@@ -68,28 +74,39 @@ exports.serializeObject = serializeObject;
  *
  * @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 Buffer with the serialized object
  */
-function signingData(transaction, prefix) {
-    if (prefix === void 0) { prefix = hash_prefixes_1.HashPrefix.transactionSig; }
-    return serializeObject(transaction, { prefix: prefix, signingFieldsOnly: true });
+function signingData(transaction, prefix = hash_prefixes_1.HashPrefix.transactionSig, opts = {}) {
+    return serializeObject(transaction, {
+        prefix,
+        signingFieldsOnly: true,
+        definitions: opts.definitions,
+    });
 }
 exports.signingData = signingData;
 /**
  * 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) {
-    var num = bigInt(String(claim.amount));
-    var prefix = hash_prefixes_1.HashPrefix.paymentChannelClaim;
-    var channel = types_1.coreTypes.Hash256.from(claim.channel).toBytes();
-    var amount = types_1.coreTypes.UInt64.from(num).toBytes();
-    var bytesList = new binary_serializer_1.BytesList();
+    const prefix = hash_prefixes_1.HashPrefix.paymentChannelClaim;
+    const channel = types_1.coreTypes.Hash256.from(claim.channel).toBytes();
+    const bytesList = new binary_serializer_1.BytesList();
     bytesList.put(prefix);
     bytesList.put(channel);
-    bytesList.put(amount);
+    if (typeof claim.amount === 'string') {
+        const num = bigInt(String(claim.amount));
+        const amount = types_1.coreTypes.UInt64.from(num).toBytes();
+        bytesList.put(amount);
+    }
+    else {
+        const amount = types_1.coreTypes.Amount.from(claim.amount).toBytes();
+        bytesList.put(amount);
+    }
     return bytesList.toBytes();
 }
 exports.signingClaimData = signingClaimData;
@@ -98,15 +115,19 @@ exports.signingClaimData = signingClaimData;
  *
  * @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, signingAccount) {
-    var prefix = hash_prefixes_1.HashPrefix.transactionMultiSig;
-    var suffix = types_1.coreTypes.AccountID.from(signingAccount).toBytes();
+function multiSigningData(transaction, signingAccount, opts = {
+    definitions: enums_1.DEFAULT_DEFINITIONS,
+}) {
+    const prefix = hash_prefixes_1.HashPrefix.transactionMultiSig;
+    const suffix = types_1.coreTypes.AccountID.from(signingAccount).toBytes();
     return serializeObject(transaction, {
-        prefix: prefix,
-        suffix: suffix,
+        prefix,
+        suffix,
         signingFieldsOnly: true,
+        definitions: opts.definitions,
     });
 }
 exports.multiSigningData = multiSigningData;

package/dist/binary.js.map

@@ -1 +1 @@
-{"version":3,"file":"binary.js","sourceRoot":"","sources":["../src/binary.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,iCAAmC;AACnC,wDAAqD;AA0InD,6FA1IO,4BAAY,OA0IP;AAxId,iDAA4C;AAC5C,gEAAwE;AAwItE,iGAxIO,oCAAgB,OAwIP;AAChB,0FAzIyB,6BAAS,OAyIzB;AAxIX,mCAAoD;AAiJlD,2FAjJO,mBAAU,OAiJP;AACV,8FAlJmB,sBAAa,OAkJnB;AA7If,oCAAqC;AAErC;;;;;GAKG;AACH,IAAM,UAAU,GAAG,UAAC,KAAa,IAAmB,OAAA,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAvB,CAAuB,CAAA;AA6HzE,gCAAU;AA3HZ;;;;;GAKG;AACH,IAAM,QAAQ,GAAG,UAAC,MAAoB;IACpC,OAAC,MAAM,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,CAAc,CAAC,MAAM,EAAE;AAA1D,CAA0D,CAAA;AAsH1D,4BAAQ;AApHV;;;;;GAKG;AACH,IAAM,YAAY,GAAG,UAAC,KAAa,IAAiB,OAAA,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAA3B,CAA2B,CAAA;AAkH7E,oCAAY;AArGd;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAkB,EAAE,IAAuB;IAAvB,qBAAA,EAAA,SAAuB;IAC1D,IAAA,MAAM,GAAwC,IAAI,OAA5C,EAAE,MAAM,GAAgC,IAAI,OAApC,EAAE,KAA8B,IAAI,kBAAT,EAAzB,iBAAiB,mBAAG,KAAK,KAAA,CAAS;IAC1D,IAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,IAAM,MAAM,GAAG,iBAAiB;QAC9B,CAAC,CAAC,UAAC,CAAgB,IAAc,OAAA,CAAC,CAAC,cAAc,EAAhB,CAAgB;QACjD,CAAC,CAAC,SAAS,CAAA;IAEb,iBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;IAE9D,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAsEC,0CAAe;AApEjB;;;;;;GAMG;AACH,SAAS,WAAW,CAClB,WAAuB,EACvB,MAA0C;IAA1C,uBAAA,EAAA,SAAiB,0BAAU,CAAC,cAAc;IAE1C,OAAO,eAAe,CAAC,WAAW,EAAE,EAAE,MAAM,QAAA,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAA;AAC1E,CAAC;AA2DC,kCAAW;AAjDb;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,IAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IACxC,IAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,IAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;IAC/D,IAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;IAEnD,IAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAgCC,4CAAgB;AA9BlB;;;;;;GAMG;AACH,SAAS,gBAAgB,CACvB,WAAuB,EACvB,cAAkC;IAElC,IAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,IAAM,MAAM,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAA;IACjE,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM,QAAA;QACN,MAAM,QAAA;QACN,iBAAiB,EAAE,IAAI;KACxB,CAAC,CAAA;AACJ,CAAC;AAUC,4CAAgB"}
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../src/binary.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,mCAAmC;AACnC,0DAAqD;AA+KnD,6FA/KO,4BAAY,OA+KP;AA7Kd,mDAA4C;AAC5C,kEAAwE;AA6KtE,iGA7KO,oCAAgB,OA6KP;AAChB,0FA9KyB,6BAAS,OA8KzB;AA7KX,qCAAoD;AAsLlD,2FAtLO,mBAAU,OAsLP;AACV,8FAvLmB,sBAAa,OAuLnB;AAtLf,mCAIgB;AAIhB,sCAAsC;AAGtC;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CACjB,KAAa,EACb,WAAiC,EACnB,EAAE,CAAC,IAAI,4BAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;AAwJrD,gCAAU;AAtJZ;;;;;;;GAOG;AACH,MAAM,QAAQ,GAAG,CACf,MAAoB,EACpB,cAAmC,2BAAmB,EAC1C,EAAE,CACb,MAAM,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,CAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AA4IrE,4BAAQ;AA1IV;;;;;;;GAOG;AACH,MAAM,YAAY,GAAG,CACnB,KAAa,EACb,WAAiC,EACrB,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAA;AAmIpE,oCAAY;AArHd;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAkB,EAAE,OAAqB,EAAE;IAClE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IACvE,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,MAAM,MAAM,GAAG,iBAAiB;QAC9B,CAAC,CAAC,CAAC,CAAgB,EAAW,EAAE,CAAC,CAAC,CAAC,cAAc;QACjD,CAAC,CAAC,SAAS,CACZ;IAAC,iBAAS,CAAC,QAA4B;SACrC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC;SACjC,WAAW,CAAC,SAAS,CAAC,CAAA;IAEzB,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAqFC,0CAAe;AAnFjB;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,WAAuB,EACvB,SAAiB,0BAAU,CAAC,cAAc,EAC1C,OAA8C,EAAE;IAEhD,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAoEC,kCAAW;AA1Db;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;IAC/D,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IACjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE;QACpC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;QACxC,MAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;QACnD,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;SAAM;QACL,MAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;QAC5D,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IACD,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAqCC,4CAAgB;AAnClB;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,WAAuB,EACvB,cAAkC,EAClC,OAA6C;IAC3C,WAAW,EAAE,2BAAmB;CACjC;IAED,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,MAAM,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAA;IACjE,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAUC,4CAAgB"}

package/dist/coretypes.d.ts

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

package/dist/coretypes.js

@@ -1,24 +1,48 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.types = exports.ShaMap = exports.HashPrefix = exports.quality = exports.TransactionResult = exports.Type = exports.LedgerEntryType = exports.TransactionType = exports.Field = exports.ledgerHashes = exports.binary = exports.hashes = void 0;
-var enums_1 = require("./enums");
+exports.types = exports.ShaMap = exports.HashPrefix = exports.quality = exports.TransactionResult = exports.Type = exports.LedgerEntryType = exports.TransactionType = exports.Field = exports.DEFAULT_DEFINITIONS = exports.ledgerHashes = exports.binary = exports.hashes = void 0;
+const enums_1 = require("./enums");
+Object.defineProperty(exports, "DEFAULT_DEFINITIONS", { enumerable: true, get: function () { return enums_1.DEFAULT_DEFINITIONS; } });
 Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return enums_1.Field; } });
 Object.defineProperty(exports, "TransactionType", { enumerable: true, get: function () { return enums_1.TransactionType; } });
 Object.defineProperty(exports, "LedgerEntryType", { enumerable: true, get: function () { return enums_1.LedgerEntryType; } });
 Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return enums_1.Type; } });
 Object.defineProperty(exports, "TransactionResult", { enumerable: true, get: function () { return enums_1.TransactionResult; } });
-var types = require("./types");
+const types = __importStar(require("./types"));
 exports.types = types;
-var binary = require("./binary");
+const binary = __importStar(require("./binary"));
 exports.binary = binary;
-var shamap_1 = require("./shamap");
+const shamap_1 = require("./shamap");
 Object.defineProperty(exports, "ShaMap", { enumerable: true, get: function () { return shamap_1.ShaMap; } });
-var ledgerHashes = require("./ledger-hashes");
+const ledgerHashes = __importStar(require("./ledger-hashes"));
 exports.ledgerHashes = ledgerHashes;
-var hashes = require("./hashes");
+const hashes = __importStar(require("./hashes"));
 exports.hashes = hashes;
-var quality_1 = require("./quality");
+const quality_1 = require("./quality");
 Object.defineProperty(exports, "quality", { enumerable: true, get: function () { return quality_1.quality; } });
-var hash_prefixes_1 = require("./hash-prefixes");
+const hash_prefixes_1 = require("./hash-prefixes");
 Object.defineProperty(exports, "HashPrefix", { enumerable: true, get: function () { return hash_prefixes_1.HashPrefix; } });
 //# sourceMappingURL=coretypes.js.map

package/dist/coretypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"coretypes.js","sourceRoot":"","sources":["../src/coretypes.ts"],"names":[],"mappings":";;;AAAA,iCAMgB;AAad,sFAlBA,aAAK,OAkBA;AACL,gGAlBA,uBAAe,OAkBA;AACf,gGAlBA,uBAAe,OAkBA;AACf,qFAlBA,YAAI,OAkBA;AACJ,kGAlBA,yBAAiB,OAkBA;AAhBnB,+BAAgC;AAoB9B,sBAAK;AAnBP,iCAAkC;AAShC,wBAAM;AARR,mCAAiC;AAiB/B,uFAjBO,eAAM,OAiBP;AAhBR,8CAA+C;AAQ7C,oCAAY;AAPd,iCAAkC;AAKhC,wBAAM;AAJR,qCAAmC;AAYjC,wFAZO,iBAAO,OAYP;AAXT,iDAA4C;AAY1C,2FAZO,0BAAU,OAYP"}
+{"version":3,"file":"coretypes.js","sourceRoot":"","sources":["../src/coretypes.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAOgB;AAad,oGAnBA,2BAAmB,OAmBA;AACnB,sFAnBA,aAAK,OAmBA;AACL,gGAnBA,uBAAe,OAmBA;AACf,gGAnBA,uBAAe,OAmBA;AACf,qFAnBA,YAAI,OAmBA;AACJ,kGAnBA,yBAAiB,OAmBA;AAjBnB,+CAAgC;AAqB9B,sBAAK;AApBP,iDAAkC;AAShC,wBAAM;AARR,qCAAiC;AAkB/B,uFAlBO,eAAM,OAkBP;AAjBR,8DAA+C;AAQ7C,oCAAY;AAPd,iDAAkC;AAKhC,wBAAM;AAJR,uCAAmC;AAajC,wFAbO,iBAAO,OAaP;AAZT,mDAA4C;AAa1C,2FAbO,0BAAU,OAaP"}

package/dist/enums/bytes.d.ts

@@ -0,0 +1,26 @@
+import { BytesList, BinaryParser } from '../binary';
+import { Buffer } from 'buffer/';
+export declare class Bytes {
+    readonly name: string;
+    readonly ordinal: number;
+    readonly ordinalWidth: number;
+    readonly bytes: Buffer;
+    constructor(name: string, ordinal: number, ordinalWidth: number);
+    toJSON(): string;
+    toBytesSink(sink: BytesList): void;
+    toBytes(): Uint8Array;
+}
+export declare class BytesLookup {
+    readonly ordinalWidth: number;
+    constructor(types: Record<string, number>, ordinalWidth: number);
+    /**
+     * Add a new name value pair to the BytesLookup.
+     *
+     * @param name - A human readable name for the field.
+     * @param value - The numeric value for the field.
+     * @throws if the name or value already exist in the lookup because it's unclear how to decode.
+     */
+    add(name: string, value: number): void;
+    from(value: Bytes | string): Bytes;
+    fromParser(parser: BinaryParser): Bytes;
+}

package/dist/enums/bytes.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BytesLookup = exports.Bytes = void 0;
+const buffer_1 = require("buffer/");
+/*
+ * @brief: Bytes, name, and ordinal representing one type, ledger_type, transaction type, or result
+ */
+class Bytes {
+    constructor(name, ordinal, ordinalWidth) {
+        this.name = name;
+        this.ordinal = ordinal;
+        this.ordinalWidth = ordinalWidth;
+        this.bytes = buffer_1.Buffer.alloc(ordinalWidth);
+        for (let i = 0; i < ordinalWidth; i++) {
+            this.bytes[ordinalWidth - i - 1] = (ordinal >>> (i * 8)) & 0xff;
+        }
+    }
+    toJSON() {
+        return this.name;
+    }
+    toBytesSink(sink) {
+        sink.put(this.bytes);
+    }
+    toBytes() {
+        return this.bytes;
+    }
+}
+exports.Bytes = Bytes;
+/*
+ * @brief: Collection of Bytes objects, mapping bidirectionally
+ */
+class BytesLookup {
+    constructor(types, ordinalWidth) {
+        this.ordinalWidth = ordinalWidth;
+        Object.entries(types).forEach(([k, v]) => {
+            this.add(k, v);
+        });
+    }
+    /**
+     * Add a new name value pair to the BytesLookup.
+     *
+     * @param name - A human readable name for the field.
+     * @param value - The numeric value for the field.
+     * @throws if the name or value already exist in the lookup because it's unclear how to decode.
+     */
+    add(name, value) {
+        if (this[name]) {
+            throw new SyntaxError(`Attempted to add a value with a duplicate name "${name}". This is not allowed because it is unclear how to decode.`);
+        }
+        if (this[value.toString()]) {
+            throw new SyntaxError(`Attempted to add a duplicate value under a different name (Given name: "${name}" and previous name: "${this[value.toString()]}. This is not allowed because it is unclear how to decode.\nGiven value: ${value.toString()}`);
+        }
+        this[name] = new Bytes(name, value, this.ordinalWidth);
+        this[value.toString()] = this[name];
+    }
+    from(value) {
+        return value instanceof Bytes ? value : this[value];
+    }
+    fromParser(parser) {
+        return this.from(parser.readUIntN(this.ordinalWidth).toString());
+    }
+}
+exports.BytesLookup = BytesLookup;
+//# sourceMappingURL=bytes.js.map

package/dist/enums/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../src/enums/bytes.ts"],"names":[],"mappings":";;;AACA,oCAAgC;AAEhC;;GAEG;AACH,MAAa,KAAK;IAGhB,YACW,IAAY,EACZ,OAAe,EACf,YAAoB;QAFpB,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAQ;QACf,iBAAY,GAAZ,YAAY,CAAQ;QAE7B,IAAI,CAAC,KAAK,GAAG,eAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE;YACrC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;SAChE;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,WAAW,CAAC,IAAe;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;CACF;AAzBD,sBAyBC;AAED;;GAEG;AACH,MAAa,WAAW;IACtB,YAAY,KAA6B,EAAW,YAAoB;QAApB,iBAAY,GAAZ,YAAY,CAAQ;QACtE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACvC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,IAAY,EAAE,KAAa;QAC7B,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE;YACd,MAAM,IAAI,WAAW,CACnB,mDAAmD,IAAI,6DAA6D,CACrH,CAAA;SACF;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,EAAE;YAC1B,MAAM,IAAI,WAAW,CACnB,2EAA2E,IAAI,yBAC7E,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CACvB,4EAA4E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAC/F,CAAA;SACF;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;QACtD,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,IAAI,CAAC,KAAqB;QACxB,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAW,CAAA;IAChE,CAAC;IAED,UAAU,CAAC,MAAoB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAClE,CAAC;CACF;AAtCD,kCAsCC"}

package/dist/enums/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const TYPE_WIDTH = 2;
+export declare const LEDGER_ENTRY_WIDTH = 2;
+export declare const TRANSACTION_TYPE_WIDTH = 2;
+export declare const TRANSACTION_RESULT_WIDTH = 1;

package/dist/enums/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRANSACTION_RESULT_WIDTH = exports.TRANSACTION_TYPE_WIDTH = exports.LEDGER_ENTRY_WIDTH = exports.TYPE_WIDTH = void 0;
+exports.TYPE_WIDTH = 2;
+exports.LEDGER_ENTRY_WIDTH = 2;
+exports.TRANSACTION_TYPE_WIDTH = 2;
+exports.TRANSACTION_RESULT_WIDTH = 1;
+//# sourceMappingURL=constants.js.map

package/dist/enums/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/enums/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAG,CAAC,CAAA;AACd,QAAA,kBAAkB,GAAG,CAAC,CAAA;AACtB,QAAA,sBAAsB,GAAG,CAAC,CAAA;AAC1B,QAAA,wBAAwB,GAAG,CAAC,CAAA"}