@bithomp/xrpl-api 3.6.4 → 3.6.8

package/lib/models/index.d.ts

@@ -33,4 +33,5 @@ import parseURITokenFlags from "../parse/ledger/uritoken-flags";
 import parseTrustlineFlags from "../parse/ledger/trustline-flags";
 import parseOfferFlags from "../parse/ledger/offer-flags";
 import parseCredentialFlags from "../parse/ledger/credential-flags";
-export { parseNFTokenMint, parseNFTokenBurn, parseNFTokenFlags, parseNFTOfferFlags, parseNFTokenAcceptOffer, parseNFTokenCancelOffer, parseNFTokenCreateOffer, parseURITokenFlags, parseTrustlineFlags, parseOfferFlags, parseCredentialFlags, };
+import parseMPTokenIssuanceFlags from "../parse/ledger/mptoken-issuance-flags";
+export { parseNFTokenMint, parseNFTokenBurn, parseNFTokenFlags, parseNFTOfferFlags, parseNFTokenAcceptOffer, parseNFTokenCancelOffer, parseNFTokenCreateOffer, parseURITokenFlags, parseTrustlineFlags, parseOfferFlags, parseCredentialFlags, parseMPTokenIssuanceFlags, };

package/lib/models/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCredentialFlags = exports.parseOfferFlags = exports.parseTrustlineFlags = exports.parseURITokenFlags = exports.parseNFTokenCreateOffer = exports.parseNFTokenCancelOffer = exports.parseNFTokenAcceptOffer = exports.parseNFTOfferFlags = exports.parseNFTokenFlags = exports.parseNFTokenBurn = exports.parseNFTokenMint = exports.parseMPTokenChanges = exports.parseMPTokenIssuanceChanges = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseFinalBalances = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
+exports.parseMPTokenIssuanceFlags = exports.parseCredentialFlags = exports.parseOfferFlags = exports.parseTrustlineFlags = exports.parseURITokenFlags = exports.parseNFTokenCreateOffer = exports.parseNFTokenCancelOffer = exports.parseNFTokenAcceptOffer = exports.parseNFTOfferFlags = exports.parseNFTokenFlags = exports.parseNFTokenBurn = exports.parseNFTokenMint = exports.parseMPTokenChanges = exports.parseMPTokenIssuanceChanges = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseFinalBalances = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
 __exportStar(require("./account_info"), exports);
 __exportStar(require("./account_nfts"), exports);
 __exportStar(require("./account_object"), exports);
@@ -76,3 +76,5 @@ const offer_flags_1 = __importDefault(require("../parse/ledger/offer-flags"));
 exports.parseOfferFlags = offer_flags_1.default;
 const credential_flags_1 = __importDefault(require("../parse/ledger/credential-flags"));
 exports.parseCredentialFlags = credential_flags_1.default;
+const mptoken_issuance_flags_1 = __importDefault(require("../parse/ledger/mptoken-issuance-flags"));
+exports.parseMPTokenIssuanceFlags = mptoken_issuance_flags_1.default;

package/lib/parse/ledger/mptoken-issuance-flags.d.ts

@@ -0,0 +1,6 @@
+import { MPTokenIssuanceFlagsKeysInterface } from "../../types/mptokens";
+declare function parseMPTokenIssuanceFlags(value: number, options?: {
+    excludeFalse?: boolean;
+    nativeCurrency?: string;
+}): MPTokenIssuanceFlagsKeysInterface;
+export default parseMPTokenIssuanceFlags;

package/lib/parse/ledger/mptoken-issuance-flags.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mptokens_1 = require("../../types/mptokens");
+const flags_1 = require("./flags");
+function parseMPTokenIssuanceFlags(value, options = {}) {
+    return (0, flags_1.parseFlags)(value, mptokens_1.MPTokenIssuanceFlagsKeys, options);
+}
+exports.default = parseMPTokenIssuanceFlags;

package/lib/parse/outcome/balance_changes.js

@@ -10,6 +10,7 @@ const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const common_1 = require("../../common");
 const client_1 = require("../../client");
 const utils_1 = require("../utils");
+const mptoken_1 = require("../../models/mptoken");
 function groupByAddress(balanceChanges) {
     const grouped = lodash_1.default.groupBy(balanceChanges, function (node) {
         return node.address;
@@ -27,7 +28,7 @@ function parseValue(value) {
     if (typeof value === "string" || typeof value === "number") {
         return new bignumber_js_1.default(value);
     }
-    return new bignumber_js_1.default(value.value ?? value.MPTAmount ?? 0);
+    return new bignumber_js_1.default(value.value ?? 0);
 }
 function computeBalanceChange(node) {
     let value = null;
@@ -41,7 +42,16 @@ function computeBalanceChange(node) {
         value = parseValue(node.finalFields.Balance).minus(parseValue(node.previousFields.Balance));
     }
     else if (node.previousFields.MPTAmount || node.finalFields.MPTAmount) {
-        value = parseValue(node.finalFields).minus(parseValue(node.previousFields));
+        value = parseValue(node.finalFields.MPTAmount ?? 0).minus(parseValue(node.previousFields.MPTAmount ?? 0));
+    }
+    else if (node.newFields.MaximumAmount) {
+        value = parseValue(node.newFields.MaximumAmount);
+    }
+    else if (node.diffType === "DeletedNode" && node.finalFields.MaximumAmount) {
+        value = parseValue(node.finalFields.MaximumAmount).multipliedBy(-1);
+    }
+    else if (node.previousFields.OutstandingAmount) {
+        value = parseValue(node.previousFields.OutstandingAmount ?? 0).minus(parseValue(node.finalFields.OutstandingAmount ?? 0));
     }
     return value === null ? null : value.isZero() ? null : value;
 }
@@ -53,7 +63,16 @@ function parseFinalBalance(node) {
         return parseValue(node.finalFields.Balance);
     }
     else if (node.finalFields.MPTAmount) {
-        return parseValue(node.finalFields);
+        return parseValue(node.finalFields.MPTAmount);
+    }
+    else if (node.newFields.MaximumAmount) {
+        return parseValue(node.newFields.MaximumAmount);
+    }
+    else if (node.diffType === "DeletedNode" && node.finalFields.MaximumAmount) {
+        return new bignumber_js_1.default(0);
+    }
+    else if (node.finalFields.MaximumAmount) {
+        return parseValue(node.finalFields.MaximumAmount).minus(parseValue(node.finalFields.OutstandingAmount));
     }
     return null;
 }
@@ -125,10 +144,24 @@ function parseMPTQuantity(node, valueParser) {
         },
     };
 }
+function parseMPTokenIssuanceQuantity(node, valueParser) {
+    const value = valueParser(node);
+    if (value === null) {
+        return null;
+    }
+    const fields = lodash_1.default.isEmpty(node.newFields) ? node.finalFields : node.newFields;
+    return {
+        address: fields.Issuer,
+        balance: {
+            value: value.toString(),
+            mpt_issuance_id: (0, mptoken_1.buildMPTokenIssuanceID)(fields.Sequence, fields.Issuer),
+        },
+    };
+}
 function parseQuantities(metadata, valueParser, nativeCurrency) {
     const values = metadata.AffectedNodes.map(function (affectedNode) {
         const node = affectedNode.CreatedNode || affectedNode.ModifiedNode || affectedNode.DeletedNode;
-        if (!["AccountRoot", "RippleState", "MPToken"].includes(node.LedgerEntryType)) {
+        if (!["AccountRoot", "RippleState", "MPToken", "MPTokenIssuance"].includes(node.LedgerEntryType)) {
             return [];
         }
         const normalizedNode = (0, utils_1.normalizeNode)(affectedNode);
@@ -141,6 +174,9 @@ function parseQuantities(metadata, valueParser, nativeCurrency) {
         else if (node.LedgerEntryType === "MPToken") {
             return [parseMPTQuantity(normalizedNode, valueParser)];
         }
+        else if (node.LedgerEntryType === "MPTokenIssuance") {
+            return [parseMPTokenIssuanceQuantity(normalizedNode, valueParser)];
+        }
         return [];
     });
     return groupByAddress(lodash_1.default.compact(lodash_1.default.flatten(values)));

package/lib/parse/outcome/mptoken_issuance_changes.js

@@ -7,6 +7,7 @@ exports.parseMPTokenIssuanceChanges = parseMPTokenIssuanceChanges;
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const common_1 = require("../../common");
 const mptoken_1 = require("../../models/mptoken");
+const mptoken_issuance_flags_1 = __importDefault(require("../ledger/mptoken-issuance-flags"));
 function parseMPTokenIssuanceChanges(tx) {
     return new MPTokenIssuanceChanges(tx).call();
 }
@@ -42,7 +43,7 @@ class MPTokenIssuanceChanges {
                     const mptIssuanceID = (0, mptoken_1.buildMPTokenIssuanceID)(node.NewFields.Sequence, node.NewFields.Issuer);
                     this.addChange(mptIssuanceID, {
                         status: "added",
-                        flags: node.NewFields.Flags,
+                        flags: (0, mptoken_issuance_flags_1.default)(node.NewFields.Flags),
                         mptIssuanceID,
                         issuer: node.NewFields.Issuer,
                         sequence: node.NewFields.Sequence,
@@ -63,7 +64,7 @@ class MPTokenIssuanceChanges {
                     }
                     this.addChange(mptIssuanceID, {
                         status: "modified",
-                        flags: node.FinalFields.Flags,
+                        flags: (0, mptoken_issuance_flags_1.default)(node.FinalFields.Flags),
                         mptIssuanceID,
                         issuer: node.FinalFields.Issuer,
                         sequence: node.FinalFields.Sequence,
@@ -73,14 +74,14 @@ class MPTokenIssuanceChanges {
                         metadata: node.FinalFields.Metadata,
                         scale: node.FinalFields.AssetScale,
                         outstandingAmountChange,
-                        flagsChange: node.PreviousFields.Flags,
+                        flagsChange: node.PreviousFields.hasOwnProperty("Flags") ? (0, mptoken_issuance_flags_1.default)(node.PreviousFields.Flags) : undefined,
                     });
                 }
                 if (affectedNode.DeletedNode) {
                     const mptIssuanceID = (0, mptoken_1.buildMPTokenIssuanceID)(node.FinalFields.Sequence, node.FinalFields.Issuer);
                     this.addChange(mptIssuanceID, {
                         status: "removed",
-                        flags: node.FinalFields.Flags,
+                        flags: (0, mptoken_issuance_flags_1.default)(node.FinalFields.Flags),
                         mptIssuanceID,
                         issuer: node.FinalFields.Issuer,
                         sequence: node.FinalFields.Sequence,

package/lib/types/mptokens.d.ts

@@ -1,6 +1,24 @@
 import { MPTokenIssuanceCreateFlags, MPTokenIssuanceSetFlags, MPTokenAuthorizeFlags } from "xrpl";
 import { FormattedBaseSpecification } from "./specification";
 import { TxGlobalFlagsKeysInterface } from "./global";
+export declare const MPTokenIssuanceFlagsKeys: {
+    locked: number;
+    canLock: MPTokenIssuanceCreateFlags;
+    requireAuth: MPTokenIssuanceCreateFlags;
+    canEscrow: MPTokenIssuanceCreateFlags;
+    canTrade: MPTokenIssuanceCreateFlags;
+    canTransfer: MPTokenIssuanceCreateFlags;
+    canClawback: MPTokenIssuanceCreateFlags;
+};
+export interface MPTokenIssuanceFlagsKeysInterface {
+    locked?: boolean;
+    canLock?: boolean;
+    requireAuth?: boolean;
+    canEscrow?: boolean;
+    canTrade?: boolean;
+    canTransfer?: boolean;
+    canClawback?: boolean;
+}
 export declare const MPTokenIssuanceCreateFlagsKeys: {
     canLock: MPTokenIssuanceCreateFlags;
     requireAuth: MPTokenIssuanceCreateFlags;

package/lib/types/mptokens.js

@@ -1,12 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MPTokenAuthorizeFlagsKeys = exports.MPTokenIssuanceSetFlagsKeys = exports.MPTokenIssuanceCreateFlagsKeys = void 0;
+exports.MPTokenAuthorizeFlagsKeys = exports.MPTokenIssuanceSetFlagsKeys = exports.MPTokenIssuanceCreateFlagsKeys = exports.MPTokenIssuanceFlagsKeys = void 0;
 exports.getMPTokenIssuanceCreateFlagsKeys = getMPTokenIssuanceCreateFlagsKeys;
 exports.getMPTokenIssuanceSetFlagsKeys = getMPTokenIssuanceSetFlagsKeys;
 exports.getMPTokenAuthorizeFlagsKeys = getMPTokenAuthorizeFlagsKeys;
 const xrpl_1 = require("xrpl");
 const global_1 = require("./global");
 const common_1 = require("../common");
+exports.MPTokenIssuanceFlagsKeys = {
+    locked: 0x00000001,
+    canLock: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTCanLock,
+    requireAuth: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTRequireAuth,
+    canEscrow: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTCanEscrow,
+    canTrade: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTCanTrade,
+    canTransfer: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTCanTransfer,
+    canClawback: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTCanClawback,
+};
 exports.MPTokenIssuanceCreateFlagsKeys = {
     canLock: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTCanLock,
     requireAuth: xrpl_1.MPTokenIssuanceCreateFlags.tfMPTRequireAuth,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.6.4",
+  "version": "3.6.8",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -43,7 +43,7 @@
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "eslint",
     "prepare": "npm run build",
-    "prepublishOnly": "npm test && npm run lint",
+    "-prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"