ripple-binary-codec 1.0.2 → 1.0.3-mpt-beta

package/README.md

@@ -98,10 +98,10 @@ Encode the transaction object for multi-signing.
 
 Run unit tests with:
 
-    yarn test
+    npm test
 
 Use `--coverage` to generate and display code coverage information:
 
-    yarn test --coverage
+    npm test --coverage
 
-This tells jest to output code coverage info in the `./coverage` directory, in addition to showing it on the command line.
+This tells jest to output code coverage info in the `./coverage` directory, in addition to showing it on the command line.

package/dist/binary.d.ts

@@ -1,56 +1,66 @@
-/// <reference types="node" />
-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 { JsonObject } from "./types/serialized-type";
+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';
 /**
  * Construct a BinaryParser
  *
- * @param bytes hex-string to construct BinaryParser from
- * @returns 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
  */
-declare const makeParser: (bytes: string) => BinaryParser;
+declare const makeParser: (bytes: string | Uint8Array, 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
  *
  * @field set signingFieldOnly to true if you want to serialize only signing fields
  */
 interface OptionObject {
-    prefix?: Buffer;
-    suffix?: Buffer;
+    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, and signingFieldOnly
- * @returns A Buffer containing the serialized object
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
+ * @returns A Uint8Array containing the serialized object
  */
-declare function serializeObject(object: JsonObject, opts?: OptionObject): Buffer;
+declare function serializeObject(object: JsonObject, opts?: OptionObject): Uint8Array;
 /**
  * Serialize an object for signing
  *
  * @param transaction Transaction to serialize
  * @param prefix Prefix bytes to put before the serialized object
- * @returns A Buffer with 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
  */
-declare function signingData(transaction: JsonObject, prefix?: Buffer): Buffer;
+declare function signingData(transaction: JsonObject, prefix?: Uint8Array, opts?: {
+    definitions?: XrplDefinitionsBase;
+}): Uint8Array;
 /**
  * Interface describing fields required for a Claim
  */
@@ -62,15 +72,19 @@ interface ClaimObject extends JsonObject {
  * 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;
+declare function signingClaimData(claim: ClaimObject): Uint8Array;
 /**
  * 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
  */
-declare function multiSigningData(transaction: JsonObject, signingAccount: string | AccountID): Buffer;
+declare function multiSigningData(transaction: JsonObject, signingAccount: string | AccountID, opts?: {
+    definitions: XrplDefinitionsBase;
+}): Uint8Array;
 export { BinaryParser, BinarySerializer, BytesList, ClaimObject, makeParser, serializeObject, readJSON, multiSigningData, signingData, signingClaimData, binaryToJSON, sha512Half, transactionID, };

package/dist/binary.js

@@ -2,60 +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 utils_1 = require("@xrplf/isomorphic/utils");
+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; } });
+const enums_1 = require("./enums");
 /**
  * Construct a BinaryParser
  *
- * @param bytes hex-string to construct BinaryParser from
- * @returns 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
  */
-var makeParser = function (bytes) { return new binary_parser_1.BinaryParser(bytes); };
+const makeParser = (bytes, definitions) => new binary_parser_1.BinaryParser(bytes instanceof Uint8Array ? (0, utils_1.bytesToHex)(bytes) : 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
- * @returns A Buffer containing the serialized object
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
+ * @returns A Uint8Array 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);
     }
@@ -67,24 +74,30 @@ exports.serializeObject = serializeObject;
  *
  * @param transaction Transaction to serialize
  * @param prefix Prefix bytes to put before the serialized object
- * @returns A Buffer with 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, 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 prefix = hash_prefixes_1.HashPrefix.paymentChannelClaim;
-    var channel = types_1.coreTypes.Hash256.from(claim.channel).toBytes();
-    var amount = types_1.coreTypes.UInt64.from(BigInt(claim.amount)).toBytes();
-    var bytesList = new binary_serializer_1.BytesList();
+    const num = BigInt(String(claim.amount));
+    const prefix = hash_prefixes_1.HashPrefix.paymentChannelClaim;
+    const channel = types_1.coreTypes.Hash256.from(claim.channel).toBytes();
+    const amount = types_1.coreTypes.UInt64.from(num).toBytes();
+    const bytesList = new binary_serializer_1.BytesList();
     bytesList.put(prefix);
     bytesList.put(channel);
     bytesList.put(amount);
@@ -96,15 +109,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,iCAAoC;AACpC,wDAAsD;AAsIpD,6FAtIO,4BAAY,OAsIP;AApId,iDAA6C;AAC7C,gEAAyE;AAoIvE,iGApIO,oCAAgB,OAoIP;AAChB,0FArIyB,6BAAS,OAqIzB;AApIX,mCAAqD;AA6InD,2FA7IO,mBAAU,OA6IP;AACV,8FA9ImB,sBAAa,OA8InB;AAzIf;;;;;GAKG;AACH,IAAM,UAAU,GAAG,UAAC,KAAa,IAAmB,OAAA,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAvB,CAAuB,CAAC;AA2H1E,gCAAU;AAzHZ;;;;;GAKG;AACH,IAAM,QAAQ,GAAG,UAAC,MAAoB;IACpC,OAAC,MAAM,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,CAAc,CAAC,MAAM,EAAE;AAA1D,CAA0D,CAAC;AAoH3D,4BAAQ;AAlHV;;;;;GAKG;AACH,IAAM,YAAY,GAAG,UAAC,KAAa,IAAiB,OAAA,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAA3B,CAA2B,CAAC;AAgH9E,oCAAY;AAnGd;;;;;;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,CAAU;IAC3D,IAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAC;IAElC,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KACvB;IAED,IAAM,MAAM,GAAG,iBAAiB;QAC9B,CAAC,CAAC,UAAC,CAAgB,IAAc,OAAA,CAAC,CAAC,cAAc,EAAhB,CAAgB;QACjD,CAAC,CAAC,SAAS,CAAC;IACd,iBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAE/D,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KACvB;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC;AAC7B,CAAC;AAqEC,0CAAe;AAnEjB;;;;;;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,CAAC;AAC3E,CAAC;AA0DC,kCAAW;AAhDb;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,IAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAC;IAC9C,IAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IAChE,IAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAErE,IAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAC;IAElC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,OAAO,SAAS,CAAC,OAAO,EAAE,CAAC;AAC7B,CAAC;AAgCC,4CAAgB;AA9BlB;;;;;;GAMG;AACH,SAAS,gBAAgB,CACvB,WAAuB,EACvB,cAAkC;IAElC,IAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAC;IAC9C,IAAM,MAAM,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAC;IAClE,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM,QAAA;QACN,MAAM,QAAA;QACN,iBAAiB,EAAE,IAAI;KACxB,CAAC,CAAC;AACL,CAAC;AAUC,4CAAgB"}
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../src/binary.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,mDAAoD;AACpD,mCAAmC;AACnC,0DAAqD;AAgLnD,6FAhLO,4BAAY,OAgLP;AA9Kd,mDAA4C;AAC5C,kEAAwE;AA8KtE,iGA9KO,oCAAgB,OA8KP;AAChB,0FA/KyB,6BAAS,OA+KzB;AA9KX,qCAAoD;AAuLlD,2FAvLO,mBAAU,OAuLP;AACV,8FAxLmB,sBAAa,OAwLnB;AAvLf,mCAIgB;AAIhB;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CACjB,KAA0B,EAC1B,WAAiC,EACnB,EAAE,CAChB,IAAI,4BAAY,CACd,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EACvD,WAAW,CACZ,CAAA;AAwJD,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,CACtB,MAAkB,EAClB,OAAqB,EAAE;IAEvB,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;AAkFC,0CAAe;AAhFjB;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,WAAuB,EACvB,SAAqB,0BAAU,CAAC,cAAc,EAC9C,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;AAiEC,kCAAW;AAvDb;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IACxC,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,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;IAEnD,MAAM,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;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,9 +1,9 @@
-import { 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, Field, TransactionType, LedgerEntryType, Type, TransactionResult, quality, HashPrefix, ShaMap, types, };
+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/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,iCAMiB;AAaf,sFAlBA,aAAK,OAkBA;AACL,gGAlBA,uBAAe,OAkBA;AACf,gGAlBA,uBAAe,OAkBA;AACf,qFAlBA,YAAI,OAkBA;AACJ,kGAlBA,yBAAiB,OAkBA;AAhBnB,+BAAiC;AAoB/B,sBAAK;AAnBP,iCAAmC;AASjC,wBAAM;AARR,mCAAkC;AAiBhC,uFAjBO,eAAM,OAiBP;AAhBR,8CAAgD;AAQ9C,oCAAY;AAPd,iCAAmC;AAKjC,wBAAM;AAJR,qCAAoC;AAYlC,wFAZO,iBAAO,OAYP;AAXT,iDAA6C;AAY3C,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,25 @@
+import { BytesList, BinaryParser } from '../binary';
+export declare class Bytes {
+    readonly name: string;
+    readonly ordinal: number;
+    readonly ordinalWidth: number;
+    readonly bytes: Uint8Array;
+    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,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BytesLookup = exports.Bytes = void 0;
+/*
+ * @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 = new Uint8Array(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":";;;AAEA;;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,IAAI,UAAU,CAAC,YAAY,CAAC,CAAA;QACzC,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"}