ripple-binary-codec 2.0.0-beta.0 → 2.0.0

package/dist/src/shamap.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShaMapLeaf = exports.ShaMapNode = exports.ShaMap = void 0;
+const types_1 = require("./types");
+const hash_prefixes_1 = require("./hash-prefixes");
+const hashes_1 = require("./hashes");
+/**
+ * Abstract class describing a SHAMapNode
+ */
+class ShaMapNode {
+}
+exports.ShaMapNode = ShaMapNode;
+/**
+ * Class describing a Leaf of SHAMap
+ */
+class ShaMapLeaf extends ShaMapNode {
+    constructor(index, item) {
+        super();
+        this.index = index;
+        this.item = item;
+    }
+    /**
+     * @returns true as ShaMapLeaf is a leaf node
+     */
+    isLeaf() {
+        return true;
+    }
+    /**
+     * @returns false as ShaMapLeaf is not an inner node
+     */
+    isInner() {
+        return false;
+    }
+    /**
+     * Get the prefix of the this.item
+     *
+     * @returns The hash prefix, unless this.item is undefined, then it returns an empty Uint8Array
+     */
+    hashPrefix() {
+        return this.item === undefined ? new Uint8Array(0) : this.item.hashPrefix();
+    }
+    /**
+     * Hash the bytes representation of this
+     *
+     * @returns hash of this.item concatenated with this.index
+     */
+    hash() {
+        const hash = hashes_1.Sha512Half.put(this.hashPrefix());
+        this.toBytesSink(hash);
+        return hash.finish();
+    }
+    /**
+     * Write the bytes representation of this to a BytesList
+     * @param list BytesList to write bytes to
+     */
+    toBytesSink(list) {
+        if (this.item !== undefined) {
+            this.item.toBytesSink(list);
+        }
+        this.index.toBytesSink(list);
+    }
+}
+exports.ShaMapLeaf = ShaMapLeaf;
+/**
+ * Class defining an Inner Node of a SHAMap
+ */
+class ShaMapInner extends ShaMapNode {
+    constructor(depth = 0) {
+        super();
+        this.depth = depth;
+        this.slotBits = 0;
+        this.branches = Array(16);
+    }
+    /**
+     * @returns true as ShaMapInner is an inner node
+     */
+    isInner() {
+        return true;
+    }
+    /**
+     * @returns false as ShaMapInner is not a leaf node
+     */
+    isLeaf() {
+        return false;
+    }
+    /**
+     * Get the hash prefix for this node
+     *
+     * @returns hash prefix describing an inner node
+     */
+    hashPrefix() {
+        return hash_prefixes_1.HashPrefix.innerNode;
+    }
+    /**
+     * Set a branch of this node to be another node
+     *
+     * @param slot Slot to add branch to this.branches
+     * @param branch Branch to add
+     */
+    setBranch(slot, branch) {
+        this.slotBits = this.slotBits | (1 << slot);
+        this.branches[slot] = branch;
+    }
+    /**
+     * @returns true if node is empty
+     */
+    empty() {
+        return this.slotBits === 0;
+    }
+    /**
+     * Compute the hash of this node
+     *
+     * @returns The hash of this node
+     */
+    hash() {
+        if (this.empty()) {
+            return types_1.coreTypes.Hash256.ZERO_256;
+        }
+        const hash = hashes_1.Sha512Half.put(this.hashPrefix());
+        this.toBytesSink(hash);
+        return hash.finish();
+    }
+    /**
+     * Writes the bytes representation of this node to a BytesList
+     *
+     * @param list BytesList to write bytes to
+     */
+    toBytesSink(list) {
+        for (let i = 0; i < this.branches.length; i++) {
+            const branch = this.branches[i];
+            const hash = branch
+                ? branch.hash()
+                : types_1.coreTypes.Hash256.ZERO_256;
+            hash.toBytesSink(list);
+        }
+    }
+    /**
+     * Add item to the SHAMap
+     *
+     * @param index Hash of the index of the item being inserted
+     * @param item Item to insert in the map
+     * @param leaf Leaf node to insert when branch doesn't exist
+     */
+    addItem(index, item, leaf) {
+        if (index === undefined) {
+            throw new Error();
+        }
+        if (index !== undefined) {
+            const nibble = index.nibblet(this.depth);
+            const existing = this.branches[nibble];
+            if (existing === undefined) {
+                this.setBranch(nibble, leaf || new ShaMapLeaf(index, item));
+            }
+            else if (existing instanceof ShaMapLeaf) {
+                const newInner = new ShaMapInner(this.depth + 1);
+                newInner.addItem(existing.index, undefined, existing);
+                newInner.addItem(index, item, leaf);
+                this.setBranch(nibble, newInner);
+            }
+            else if (existing instanceof ShaMapInner) {
+                existing.addItem(index, item, leaf);
+            }
+            else {
+                throw new Error('invalid ShaMap.addItem call');
+            }
+        }
+    }
+}
+class ShaMap extends ShaMapInner {
+}
+exports.ShaMap = ShaMap;
+//# sourceMappingURL=shamap.js.map

package/dist/src/shamap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shamap.js","sourceRoot":"","sources":["../../src/shamap.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,mDAA4C;AAC5C,qCAAqC;AAIrC;;GAEG;AACH,MAAe,UAAU;CAMxB;AA0KgB,gCAAU;AAxK3B;;GAEG;AACH,MAAM,UAAW,SAAQ,UAAU;IACjC,YAAmB,KAAc,EAAS,IAAiB;QACzD,KAAK,EAAE,CAAA;QADU,UAAK,GAAL,KAAK,CAAS;QAAS,SAAI,GAAJ,IAAI,CAAa;IAE3D,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAA;IAC7E,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,MAAM,IAAI,GAAG,mBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAC9C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACtB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;IACtB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,IAAe;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;YAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SAC5B;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;CACF;AAoH4B,gCAAU;AAlHvC;;GAEG;AACH,MAAM,WAAY,SAAQ,UAAU;IAIlC,YAAoB,QAAgB,CAAC;QACnC,KAAK,EAAE,CAAA;QADW,UAAK,GAAL,KAAK,CAAY;QAH7B,aAAQ,GAAG,CAAC,CAAA;QACZ,aAAQ,GAAsB,KAAK,CAAC,EAAE,CAAC,CAAA;IAI/C,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,0BAAU,CAAC,SAAS,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAY,EAAE,MAAkB;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAA;QAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE;YAChB,OAAQ,iBAAS,CAAC,OAA0B,CAAC,QAAQ,CAAA;SACtD;QACD,MAAM,IAAI,GAAG,mBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAC9C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACtB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAe;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;YAC/B,MAAM,IAAI,GAAG,MAAM;gBACjB,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;gBACf,CAAC,CAAE,iBAAS,CAAC,OAA0B,CAAC,QAAQ,CAAA;YAClD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;SACvB;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,KAAe,EAAE,IAAiB,EAAE,IAAiB;QAC3D,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,IAAI,KAAK,EAAE,CAAA;SAClB;QACD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YAEtC,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;aAC5D;iBAAM,IAAI,QAAQ,YAAY,UAAU,EAAE;gBACzC,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;gBAChD,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;gBACrD,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;gBACnC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;aACjC;iBAAM,IAAI,QAAQ,YAAY,WAAW,EAAE;gBAC1C,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;aACpC;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;aAC/C;SACF;IACH,CAAC;CACF;AAED,MAAM,MAAO,SAAQ,WAAW;CAAG;AAE1B,wBAAM"}

package/dist/src/types/account-id.d.ts

@@ -0,0 +1,35 @@
+import { Hash160 } from './hash-160';
+/**
+ * Class defining how to encode and decode an AccountID
+ */
+declare class AccountID extends Hash160 {
+    static readonly defaultAccountID: AccountID;
+    constructor(bytes?: Uint8Array);
+    /**
+     * Defines how to construct an AccountID
+     *
+     * @param value either an existing AccountID, a hex-string, or a base58 r-Address
+     * @returns an AccountID object
+     */
+    static from<T extends Hash160 | string>(value: T): AccountID;
+    /**
+     * Defines how to build an AccountID from a base58 r-Address
+     *
+     * @param value a base58 r-Address
+     * @returns an AccountID object
+     */
+    static fromBase58(value: string): AccountID;
+    /**
+     * Overload of toJSON
+     *
+     * @returns the base58 string for this AccountID
+     */
+    toJSON(): string;
+    /**
+     * Defines how to encode AccountID into a base58 address
+     *
+     * @returns the base58 string defined by this.bytes
+     */
+    toBase58(): string;
+}
+export { AccountID };

package/dist/src/types/account-id.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountID = void 0;
+const ripple_address_codec_1 = require("ripple-address-codec");
+const hash_160_1 = require("./hash-160");
+const utils_1 = require("@xrplf/isomorphic/utils");
+const HEX_REGEX = /^[A-F0-9]{40}$/;
+/**
+ * Class defining how to encode and decode an AccountID
+ */
+class AccountID extends hash_160_1.Hash160 {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : AccountID.defaultAccountID.bytes);
+    }
+    /**
+     * Defines how to construct an AccountID
+     *
+     * @param value either an existing AccountID, a hex-string, or a base58 r-Address
+     * @returns an AccountID object
+     */
+    static from(value) {
+        if (value instanceof AccountID) {
+            return value;
+        }
+        if (typeof value === 'string') {
+            if (value === '') {
+                return new AccountID();
+            }
+            return HEX_REGEX.test(value)
+                ? new AccountID((0, utils_1.hexToBytes)(value))
+                : this.fromBase58(value);
+        }
+        throw new Error('Cannot construct AccountID from value given');
+    }
+    /**
+     * Defines how to build an AccountID from a base58 r-Address
+     *
+     * @param value a base58 r-Address
+     * @returns an AccountID object
+     */
+    static fromBase58(value) {
+        if ((0, ripple_address_codec_1.isValidXAddress)(value)) {
+            const classic = (0, ripple_address_codec_1.xAddressToClassicAddress)(value);
+            if (classic.tag !== false)
+                throw new Error('Only allowed to have tag on Account or Destination');
+            value = classic.classicAddress;
+        }
+        return new AccountID(Uint8Array.from((0, ripple_address_codec_1.decodeAccountID)(value)));
+    }
+    /**
+     * Overload of toJSON
+     *
+     * @returns the base58 string for this AccountID
+     */
+    toJSON() {
+        return this.toBase58();
+    }
+    /**
+     * Defines how to encode AccountID into a base58 address
+     *
+     * @returns the base58 string defined by this.bytes
+     */
+    toBase58() {
+        return (0, ripple_address_codec_1.encodeAccountID)(this.bytes);
+    }
+}
+exports.AccountID = AccountID;
+AccountID.defaultAccountID = new AccountID(new Uint8Array(20));
+//# sourceMappingURL=account-id.js.map

package/dist/src/types/account-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-id.js","sourceRoot":"","sources":["../../../src/types/account-id.ts"],"names":[],"mappings":";;;AAAA,+DAK6B;AAC7B,yCAAoC;AACpC,mDAAoD;AAEpD,MAAM,SAAS,GAAG,gBAAgB,CAAA;AAElC;;GAEG;AACH,MAAM,SAAU,SAAQ,kBAAO;IAK7B,YAAY,KAAkB;QAC5B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAA6B,KAAQ;QAC9C,IAAI,KAAK,YAAY,SAAS,EAAE;YAC9B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,KAAK,KAAK,EAAE,EAAE;gBAChB,OAAO,IAAI,SAAS,EAAE,CAAA;aACvB;YAED,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC1B,CAAC,CAAC,IAAI,SAAS,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC;gBAClC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;SAC3B;QAED,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAChE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,KAAa;QAC7B,IAAI,IAAA,sCAAe,EAAC,KAAK,CAAC,EAAE;YAC1B,MAAM,OAAO,GAAG,IAAA,+CAAwB,EAAC,KAAK,CAAC,CAAA;YAE/C,IAAI,OAAO,CAAC,GAAG,KAAK,KAAK;gBACvB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;YAEvE,KAAK,GAAG,OAAO,CAAC,cAAc,CAAA;SAC/B;QAED,OAAO,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAA,sCAAe,EAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC/D,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IACxB,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,IAAA,sCAAe,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;;AAGM,8BAAS;AAtEA,0BAAgB,GAAc,IAAI,SAAS,CACzD,IAAI,UAAU,CAAC,EAAE,CAAC,CACnB,CAAA"}

package/dist/src/types/amount.d.ts

@@ -0,0 +1,67 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { JsonObject, SerializedType } from './serialized-type';
+/**
+ * Interface for JSON objects that represent amounts
+ */
+interface AmountObject extends JsonObject {
+    value: string;
+    currency: string;
+    issuer: string;
+}
+/**
+ * Class for serializing/Deserializing Amounts
+ */
+declare class Amount extends SerializedType {
+    static defaultAmount: Amount;
+    constructor(bytes: Uint8Array);
+    /**
+     * Construct an amount from an IOU or string amount
+     *
+     * @param value An Amount, object representing an IOU, or a string
+     *     representing an integer amount
+     * @returns An Amount object
+     */
+    static from<T extends Amount | AmountObject | string>(value: T): Amount;
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @returns An Amount object
+     */
+    static fromParser(parser: BinaryParser): Amount;
+    /**
+     * Get the JSON representation of this Amount
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON(): AmountObject | string;
+    /**
+     * Validate XRP amount
+     *
+     * @param amount String representing XRP amount
+     * @returns void, but will throw if invalid amount
+     */
+    private static assertXrpIsValid;
+    /**
+     * Validate IOU.value amount
+     *
+     * @param decimal BigNumber object representing IOU.value
+     * @returns void, but will throw if invalid amount
+     */
+    private static assertIouIsValid;
+    /**
+     * Ensure that the value after being multiplied by the exponent does not
+     * contain a decimal.
+     *
+     * @param decimal a Decimal object
+     * @returns a string of the object without a decimal
+     */
+    private static verifyNoDecimal;
+    /**
+     * Test if this amount is in units of Native Currency(XRP)
+     *
+     * @returns true if Native (XRP)
+     */
+    private isNative;
+}
+export { Amount, AmountObject };

package/dist/src/types/amount.js

@@ -0,0 +1,212 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Amount = void 0;
+const binary_parser_1 = require("../serdes/binary-parser");
+const account_id_1 = require("./account-id");
+const currency_1 = require("./currency");
+const serialized_type_1 = require("./serialized-type");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const utils_1 = require("@xrplf/isomorphic/utils");
+const utils_2 = require("../utils");
+/**
+ * Constants for validating amounts
+ */
+const MIN_IOU_EXPONENT = -96;
+const MAX_IOU_EXPONENT = 80;
+const MAX_IOU_PRECISION = 16;
+const MAX_DROPS = new bignumber_js_1.default('1e17');
+const MIN_XRP = new bignumber_js_1.default('1e-6');
+const mask = BigInt(0x00000000ffffffff);
+/**
+ * BigNumber configuration for Amount IOUs
+ */
+bignumber_js_1.default.config({
+    EXPONENTIAL_AT: [
+        MIN_IOU_EXPONENT - MAX_IOU_PRECISION,
+        MAX_IOU_EXPONENT + MAX_IOU_PRECISION,
+    ],
+});
+/**
+ * Type guard for AmountObject
+ */
+function isAmountObject(arg) {
+    const keys = Object.keys(arg).sort();
+    return (keys.length === 3 &&
+        keys[0] === 'currency' &&
+        keys[1] === 'issuer' &&
+        keys[2] === 'value');
+}
+/**
+ * Class for serializing/Deserializing Amounts
+ */
+class Amount extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : Amount.defaultAmount.bytes);
+    }
+    /**
+     * Construct an amount from an IOU or string amount
+     *
+     * @param value An Amount, object representing an IOU, or a string
+     *     representing an integer amount
+     * @returns An Amount object
+     */
+    static from(value) {
+        if (value instanceof Amount) {
+            return value;
+        }
+        let amount = new Uint8Array(8);
+        if (typeof value === 'string') {
+            Amount.assertXrpIsValid(value);
+            const number = BigInt(value);
+            const intBuf = [new Uint8Array(4), new Uint8Array(4)];
+            (0, utils_2.writeUInt32BE)(intBuf[0], Number(number >> BigInt(32)), 0);
+            (0, utils_2.writeUInt32BE)(intBuf[1], Number(number & BigInt(mask)), 0);
+            amount = (0, utils_1.concat)(intBuf);
+            amount[0] |= 0x40;
+            return new Amount(amount);
+        }
+        if (isAmountObject(value)) {
+            const number = new bignumber_js_1.default(value.value);
+            Amount.assertIouIsValid(number);
+            if (number.isZero()) {
+                amount[0] |= 0x80;
+            }
+            else {
+                const integerNumberString = number
+                    .times(`1e${-((number.e || 0) - 15)}`)
+                    .abs()
+                    .toString();
+                const num = BigInt(integerNumberString);
+                const intBuf = [new Uint8Array(4), new Uint8Array(4)];
+                (0, utils_2.writeUInt32BE)(intBuf[0], Number(num >> BigInt(32)), 0);
+                (0, utils_2.writeUInt32BE)(intBuf[1], Number(num & BigInt(mask)), 0);
+                amount = (0, utils_1.concat)(intBuf);
+                amount[0] |= 0x80;
+                if (number.gt(new bignumber_js_1.default(0))) {
+                    amount[0] |= 0x40;
+                }
+                const exponent = (number.e || 0) - 15;
+                const exponentByte = 97 + exponent;
+                amount[0] |= exponentByte >>> 2;
+                amount[1] |= (exponentByte & 0x03) << 6;
+            }
+            const currency = currency_1.Currency.from(value.currency).toBytes();
+            const issuer = account_id_1.AccountID.from(value.issuer).toBytes();
+            return new Amount((0, utils_1.concat)([amount, currency, issuer]));
+        }
+        throw new Error('Invalid type to construct an Amount');
+    }
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @returns An Amount object
+     */
+    static fromParser(parser) {
+        const isXRP = parser.peek() & 0x80;
+        const numBytes = isXRP ? 48 : 8;
+        return new Amount(parser.read(numBytes));
+    }
+    /**
+     * Get the JSON representation of this Amount
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON() {
+        if (this.isNative()) {
+            const bytes = this.bytes;
+            const isPositive = bytes[0] & 0x40;
+            const sign = isPositive ? '' : '-';
+            bytes[0] &= 0x3f;
+            const msb = BigInt((0, utils_2.readUInt32BE)(bytes.slice(0, 4), 0));
+            const lsb = BigInt((0, utils_2.readUInt32BE)(bytes.slice(4), 0));
+            const num = (msb << BigInt(32)) | lsb;
+            return `${sign}${num.toString()}`;
+        }
+        else {
+            const parser = new binary_parser_1.BinaryParser(this.toString());
+            const mantissa = parser.read(8);
+            const currency = currency_1.Currency.fromParser(parser);
+            const issuer = account_id_1.AccountID.fromParser(parser);
+            const b1 = mantissa[0];
+            const b2 = mantissa[1];
+            const isPositive = b1 & 0x40;
+            const sign = isPositive ? '' : '-';
+            const exponent = ((b1 & 0x3f) << 2) + ((b2 & 0xff) >> 6) - 97;
+            mantissa[0] = 0;
+            mantissa[1] &= 0x3f;
+            const value = new bignumber_js_1.default(`${sign}0x${(0, utils_1.bytesToHex)(mantissa)}`).times(`1e${exponent}`);
+            Amount.assertIouIsValid(value);
+            return {
+                value: value.toString(),
+                currency: currency.toJSON(),
+                issuer: issuer.toJSON(),
+            };
+        }
+    }
+    /**
+     * Validate XRP amount
+     *
+     * @param amount String representing XRP amount
+     * @returns void, but will throw if invalid amount
+     */
+    static assertXrpIsValid(amount) {
+        if (amount.indexOf('.') !== -1) {
+            throw new Error(`${amount.toString()} is an illegal amount`);
+        }
+        const decimal = new bignumber_js_1.default(amount);
+        if (!decimal.isZero()) {
+            if (decimal.lt(MIN_XRP) || decimal.gt(MAX_DROPS)) {
+                throw new Error(`${amount.toString()} is an illegal amount`);
+            }
+        }
+    }
+    /**
+     * Validate IOU.value amount
+     *
+     * @param decimal BigNumber object representing IOU.value
+     * @returns void, but will throw if invalid amount
+     */
+    static assertIouIsValid(decimal) {
+        if (!decimal.isZero()) {
+            const p = decimal.precision();
+            const e = (decimal.e || 0) - 15;
+            if (p > MAX_IOU_PRECISION ||
+                e > MAX_IOU_EXPONENT ||
+                e < MIN_IOU_EXPONENT) {
+                throw new Error('Decimal precision out of range');
+            }
+            this.verifyNoDecimal(decimal);
+        }
+    }
+    /**
+     * Ensure that the value after being multiplied by the exponent does not
+     * contain a decimal.
+     *
+     * @param decimal a Decimal object
+     * @returns a string of the object without a decimal
+     */
+    static verifyNoDecimal(decimal) {
+        const integerNumberString = decimal
+            .times(`1e${-((decimal.e || 0) - 15)}`)
+            .abs()
+            .toString();
+        if (integerNumberString.indexOf('.') !== -1) {
+            throw new Error('Decimal place found in integerNumberString');
+        }
+    }
+    /**
+     * Test if this amount is in units of Native Currency(XRP)
+     *
+     * @returns true if Native (XRP)
+     */
+    isNative() {
+        return (this.bytes[0] & 0x80) === 0;
+    }
+}
+exports.Amount = Amount;
+Amount.defaultAmount = new Amount((0, utils_1.hexToBytes)('4000000000000000'));
+//# sourceMappingURL=amount.js.map

package/dist/src/types/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../../../src/types/amount.ts"],"names":[],"mappings":";;;;;;AAAA,2DAAsD;AAEtD,6CAAwC;AACxC,yCAAqC;AACrC,uDAA8D;AAC9D,gEAAoC;AACpC,mDAAwE;AACxE,oCAAsD;AAEtD;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,EAAE,CAAA;AAC5B,MAAM,gBAAgB,GAAG,EAAE,CAAA;AAC3B,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAC5B,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC,MAAM,CAAC,CAAA;AACvC,MAAM,OAAO,GAAG,IAAI,sBAAS,CAAC,MAAM,CAAC,CAAA;AACrC,MAAM,IAAI,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAEvC;;GAEG;AACH,sBAAS,CAAC,MAAM,CAAC;IACf,cAAc,EAAE;QACd,gBAAgB,GAAG,iBAAiB;QACpC,gBAAgB,GAAG,iBAAiB;KACrC;CACF,CAAC,CAAA;AAWF;;GAEG;AACH,SAAS,cAAc,CAAC,GAAG;IACzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,CAAC;QACjB,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU;QACtB,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ;QACpB,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO,CACpB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,MAAO,SAAQ,gCAAc;IAGjC,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAA2C,KAAQ;QAC5D,IAAI,KAAK,YAAY,MAAM,EAAE;YAC3B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;QAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;YAE5B,MAAM,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;YACrD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YACzD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAE1D,MAAM,GAAG,IAAA,cAAM,EAAC,MAAM,CAAC,CAAA;YAEvB,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;YAEjB,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAA;SAC1B;QAED,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE;YACzB,MAAM,MAAM,GAAG,IAAI,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACzC,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;YAE/B,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE;gBACnB,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;aAClB;iBAAM;gBACL,MAAM,mBAAmB,GAAG,MAAM;qBAC/B,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;qBACrC,GAAG,EAAE;qBACL,QAAQ,EAAE,CAAA;gBAEb,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;gBACvC,MAAM,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;gBACrD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBACtD,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBAEvD,MAAM,GAAG,IAAA,cAAM,EAAC,MAAM,CAAC,CAAA;gBAEvB,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;gBAEjB,IAAI,MAAM,CAAC,EAAE,CAAC,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC/B,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;iBAClB;gBAED,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAA;gBACrC,MAAM,YAAY,GAAG,EAAE,GAAG,QAAQ,CAAA;gBAClC,MAAM,CAAC,CAAC,CAAC,IAAI,YAAY,KAAK,CAAC,CAAA;gBAC/B,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;aACxC;YAED,MAAM,QAAQ,GAAG,mBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAA;YACxD,MAAM,MAAM,GAAG,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;YACrD,OAAO,IAAI,MAAM,CAAC,IAAA,cAAM,EAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;SACtD;QAED,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAA;QAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/B,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;YACxB,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;YAClC,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;YAClC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;YAEhB,MAAM,GAAG,GAAG,MAAM,CAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YACtD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YACnD,MAAM,GAAG,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAA;YAErC,OAAO,GAAG,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAA;SAClC;aAAM;YACL,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;YAChD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/B,MAAM,QAAQ,GAAG,mBAAQ,CAAC,UAAU,CAAC,MAAM,CAAa,CAAA;YACxD,MAAM,MAAM,GAAG,sBAAS,CAAC,UAAU,CAAC,MAAM,CAAc,CAAA;YAExD,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;YACtB,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;YAEtB,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,CAAA;YAC5B,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;YAClC,MAAM,QAAQ,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAA;YAE7D,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;YACf,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;YACnB,MAAM,KAAK,GAAG,IAAI,sBAAS,CAAC,GAAG,IAAI,KAAK,IAAA,kBAAU,EAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CACnE,KAAK,QAAQ,EAAE,CAChB,CAAA;YACD,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAE9B,OAAO;gBACL,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;gBACvB,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE;gBAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;aACxB,CAAA;SACF;IACH,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC5C,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAA;SAC7D;QAED,MAAM,OAAO,GAAG,IAAI,sBAAS,CAAC,MAAM,CAAC,CAAA;QACrC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE;YACrB,IAAI,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE;gBAChD,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAA;aAC7D;SACF;IACH,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAAC,OAAkB;QAChD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE;YACrB,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,EAAE,CAAA;YAC7B,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAA;YAC/B,IACE,CAAC,GAAG,iBAAiB;gBACrB,CAAC,GAAG,gBAAgB;gBACpB,CAAC,GAAG,gBAAgB,EACpB;gBACA,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;aAClD;YACD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;SAC9B;IACH,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,eAAe,CAAC,OAAkB;QAC/C,MAAM,mBAAmB,GAAG,OAAO;aAChC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;aACtC,GAAG,EAAE;aACL,QAAQ,EAAE,CAAA;QAEb,IAAI,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;SAC9D;IACH,CAAC;IAED;;;;OAIG;IACK,QAAQ;QACd,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACrC,CAAC;;AAGM,wBAAM;AAvMN,oBAAa,GAAW,IAAI,MAAM,CAAC,IAAA,kBAAU,EAAC,kBAAkB,CAAC,CAAC,CAAA"}

package/dist/src/types/blob.d.ts

@@ -0,0 +1,24 @@
+import { SerializedType } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Variable length encoded type
+ */
+declare class Blob extends SerializedType {
+    constructor(bytes: Uint8Array);
+    /**
+     * Defines how to read a Blob from a BinaryParser
+     *
+     * @param parser The binary parser to read the Blob from
+     * @param hint The length of the blob, computed by readVariableLengthLength() and passed in
+     * @returns A Blob object
+     */
+    static fromParser(parser: BinaryParser, hint: number): Blob;
+    /**
+     * Create a Blob object from a hex-string
+     *
+     * @param value existing Blob object or a hex-string
+     * @returns A Blob object
+     */
+    static from<T extends Blob | string>(value: T): Blob;
+}
+export { Blob };

package/dist/src/types/blob.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Blob = void 0;
+const serialized_type_1 = require("./serialized-type");
+const utils_1 = require("@xrplf/isomorphic/utils");
+/**
+ * Variable length encoded type
+ */
+class Blob extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes);
+    }
+    /**
+     * Defines how to read a Blob from a BinaryParser
+     *
+     * @param parser The binary parser to read the Blob from
+     * @param hint The length of the blob, computed by readVariableLengthLength() and passed in
+     * @returns A Blob object
+     */
+    static fromParser(parser, hint) {
+        return new Blob(parser.read(hint));
+    }
+    /**
+     * Create a Blob object from a hex-string
+     *
+     * @param value existing Blob object or a hex-string
+     * @returns A Blob object
+     */
+    static from(value) {
+        if (value instanceof Blob) {
+            return value;
+        }
+        if (typeof value === 'string') {
+            return new Blob((0, utils_1.hexToBytes)(value));
+        }
+        throw new Error('Cannot construct Blob from value given');
+    }
+}
+exports.Blob = Blob;
+//# sourceMappingURL=blob.js.map

package/dist/src/types/blob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blob.js","sourceRoot":"","sources":["../../../src/types/blob.ts"],"names":[],"mappings":";;;AAAA,uDAAkD;AAElD,mDAAoD;AAEpD;;GAEG;AACH,MAAM,IAAK,SAAQ,gCAAc;IAC/B,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAY;QAClD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACpC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAA0B,KAAQ;QAC3C,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,OAAO,KAAK,CAAA;SACb;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,IAAI,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAA;SACnC;QAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;IAC3D,CAAC;CACF;AAEQ,oBAAI"}

package/dist/src/types/currency.d.ts

@@ -0,0 +1,28 @@
+import { Hash160 } from './hash-160';
+/**
+ * Class defining how to encode and decode Currencies
+ */
+declare class Currency extends Hash160 {
+    static readonly XRP: Currency;
+    private readonly _iso;
+    constructor(byteBuf: Uint8Array);
+    /**
+     * Return the ISO code of this currency
+     *
+     * @returns ISO code if it exists, else null
+     */
+    iso(): string | null;
+    /**
+     * Constructs a Currency object
+     *
+     * @param val Currency object or a string representation of a currency
+     */
+    static from<T extends Hash160 | string>(value: T): Currency;
+    /**
+     * Gets the JSON representation of a currency
+     *
+     * @returns JSON representation
+     */
+    toJSON(): string;
+}
+export { Currency };