@bithomp/xrpl-api 2.6.7 → 2.7.1

package/lib/ledger/transaction.d.ts

@@ -26,7 +26,7 @@ interface LegacyPaymentInterface {
     destinationValue: string;
     destinationCurrency: string;
     networkID?: number;
-    memos: FormattedMemo[];
+    memos?: FormattedMemo[];
     secret: string;
     fee?: string;
 }

package/lib/parse/outcome/channel_changes.js

@@ -40,7 +40,7 @@ function summarizePaymentChannel(node) {
             .toString(10);
     }
     if (node.PreviousTxnID) {
-        summary.previousTxnId = node.PreviousTxnID;
+        summary.previousTxnID = node.PreviousTxnID;
     }
     return summary;
 }

package/lib/parse/outcome/escrow_changes.d.ts

@@ -0,0 +1,16 @@
+import { FormattedSourceAddress, FormattedDestinationAddress } from "../../v1/common/types/objects/account";
+interface FormattedEscrowInterface {
+    status?: string;
+    escrowIndex?: number;
+    escrowSequence?: number;
+    amount?: string;
+    condition?: string;
+    source?: FormattedSourceAddress;
+    destination?: FormattedDestinationAddress;
+    allowCancelAfter?: string;
+    allowExecuteAfter?: string;
+    previousTxnID?: string;
+    previousTxnLgrSeq?: number;
+}
+declare function parseEscrowChanges(tx: any): FormattedEscrowInterface | undefined;
+export { parseEscrowChanges };

package/lib/parse/outcome/escrow_changes.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseEscrowChanges = void 0;
+const common_1 = require("../../common");
+const utils_1 = require("../../v1/common/utils");
+const utils_2 = require("../utils");
+function parseEscrowStatus(tx, node) {
+    if (node.diffType === "CreatedNode") {
+        return "created";
+    }
+    if (node.diffType === "DeletedNode") {
+        if (tx.TransactionType === "EscrowCancel") {
+            return "cancelled";
+        }
+        if (tx.TransactionType === "EscrowFinish") {
+            return "executed";
+        }
+        return "deleted";
+    }
+    return undefined;
+}
+function parseEscrowSequence(tx) {
+    if (tx.TransactionType === "EscrowCreate") {
+        return tx.Sequence || tx.TicketSequence;
+    }
+    if (tx.TransactionType === "EscrowCancel" || tx.TransactionType === "EscrowFinish") {
+        return tx.OfferSequence;
+    }
+    return undefined;
+}
+function summarizeEscrow(tx, node) {
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    const source = {
+        address: final.Account,
+        tag: final.SourceTag,
+    };
+    const destination = {
+        address: final.Destination,
+        tag: final.DestinationTag,
+    };
+    const summary = {
+        status: parseEscrowStatus(tx, node),
+        escrowIndex: node.ledgerIndex,
+        escrowSequence: parseEscrowSequence(tx),
+        amount: final.Amount,
+        condition: final.Condition,
+        source: (0, common_1.removeUndefined)(source),
+        destination: (0, common_1.removeUndefined)(destination),
+        allowCancelAfter: (0, utils_2.parseTimestamp)(final.CancelAfter),
+        allowExecuteAfter: (0, utils_2.parseTimestamp)(final.FinishAfter),
+    };
+    if (final.PreviousTxnID) {
+        summary.previousTxnID = final.PreviousTxnID;
+    }
+    else if (node.diffType === "CreatedNode") {
+        summary.previousTxnID = tx.hash;
+    }
+    if (final.PreviousTxnLgrSeq) {
+        summary.previousTxnLgrSeq = final.PreviousTxnLgrSeq;
+    }
+    else if (node.diffType === "CreatedNode") {
+        summary.previousTxnLgrSeq = tx.ledger_index;
+    }
+    return (0, common_1.removeUndefined)(summary);
+}
+function parseEscrowChanges(tx) {
+    const escrows = (0, utils_1.normalizeNodes)(tx.meta).filter((n) => {
+        return n.entryType === "Escrow";
+    });
+    return escrows.length === 1 ? summarizeEscrow(tx, escrows[0]) : undefined;
+}
+exports.parseEscrowChanges = parseEscrowChanges;

package/lib/parse/outcome/index.d.ts

@@ -9,3 +9,4 @@ export { parseChannelChanges } from "./channel_changes";
 export { parseOrderbookChanges } from "./orderbook_changes";
 export { parseHooksExecutions } from "./hooks_executions";
 export { parseEmittedTxns } from "./emitted_txns";
+export { parseEscrowChanges } from "./escrow_changes";

package/lib/parse/outcome/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
+exports.parseEscrowChanges = exports.parseEmittedTxns = exports.parseHooksExecutions = exports.parseOrderbookChanges = exports.parseChannelChanges = exports.parseLockedBalanceChanges = exports.parseBalanceChanges = exports.parseURITokenSellOfferChanges = exports.parseURITokenChanges = exports.parseNFTokenOfferChanges = exports.parseNFTokenChanges = exports.parseAffectedObjects = void 0;
 var affected_objects_1 = require("./affected_objects");
 Object.defineProperty(exports, "parseAffectedObjects", { enumerable: true, get: function () { return affected_objects_1.parseAffectedObjects; } });
 var nftoken_changes_1 = require("./nftoken_changes");
@@ -23,3 +23,5 @@ var hooks_executions_1 = require("./hooks_executions");
 Object.defineProperty(exports, "parseHooksExecutions", { enumerable: true, get: function () { return hooks_executions_1.parseHooksExecutions; } });
 var emitted_txns_1 = require("./emitted_txns");
 Object.defineProperty(exports, "parseEmittedTxns", { enumerable: true, get: function () { return emitted_txns_1.parseEmittedTxns; } });
+var escrow_changes_1 = require("./escrow_changes");
+Object.defineProperty(exports, "parseEscrowChanges", { enumerable: true, get: function () { return escrow_changes_1.parseEscrowChanges; } });

package/lib/parse/outcome/nftoken_offer_changes.js

@@ -55,8 +55,8 @@ class NFTokenOfferChanges {
         const owner = affectedNode.CreatedNode.NewFields.Owner;
         const index = affectedNode.CreatedNode.LedgerIndex;
         const destination = affectedNode.CreatedNode.NewFields.Destination;
-        const prevTxHash = affectedNode.CreatedNode.NewFields.PreviousTxnID;
-        const prevLedgerIndex = affectedNode.CreatedNode.NewFields.PreviousTxnLgrSeq;
+        const previousTxnID = affectedNode.CreatedNode.NewFields.PreviousTxnID;
+        const previousTxnLgrSeq = affectedNode.CreatedNode.NewFields.PreviousTxnLgrSeq;
         let expiration = affectedNode.CreatedNode.NewFields.Expiration;
         if (typeof expiration === "number") {
             expiration = (0, ledger_1.ledgerTimeToUnixTime)(expiration);
@@ -70,8 +70,8 @@ class NFTokenOfferChanges {
             destination,
             expiration,
             index,
-            prevTxHash,
-            prevLedgerIndex,
+            previousTxnID,
+            previousTxnLgrSeq,
         });
     }
     isNFTokensDeleteOfferNode(affectedNode) {
@@ -85,8 +85,8 @@ class NFTokenOfferChanges {
         const owner = affectedNode.DeletedNode.FinalFields.Owner;
         const index = affectedNode.DeletedNode.LedgerIndex;
         const destination = affectedNode.DeletedNode.FinalFields.Destination;
-        const prevTxHash = affectedNode.DeletedNode.FinalFields.PreviousTxnID;
-        const prevLedgerIndex = affectedNode.DeletedNode.FinalFields.PreviousTxnLgrSeq;
+        const previousTxnID = affectedNode.DeletedNode.FinalFields.PreviousTxnID;
+        const previousTxnLgrSeq = affectedNode.DeletedNode.FinalFields.PreviousTxnLgrSeq;
         let expiration = affectedNode.DeletedNode.FinalFields.Expiration;
         if (typeof expiration === "number") {
             expiration = (0, ledger_1.ledgerTimeToUnixTime)(expiration);
@@ -100,8 +100,8 @@ class NFTokenOfferChanges {
             destination,
             expiration,
             index,
-            prevTxHash,
-            prevLedgerIndex,
+            previousTxnID,
+            previousTxnLgrSeq,
         });
     }
 }

package/lib/parse/outcome.js

@@ -69,6 +69,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
     const lockedBalanceChanges = (0, index_1.parseLockedBalanceChanges)(metadata);
     const orderbookChanges = (0, index_1.parseOrderbookChanges)(metadata);
     const channelChanges = (0, index_1.parseChannelChanges)(metadata);
+    const escrowChanges = (0, index_1.parseEscrowChanges)(tx);
     const nftokenChanges = (0, index_1.parseNFTokenChanges)(tx);
     const nftokenOfferChanges = (0, index_1.parseNFTokenOfferChanges)(tx);
     const uritokenChanges = (0, index_1.parseURITokenChanges)(tx);
@@ -87,6 +88,7 @@ function parseOutcome(tx, nativeCurrency, definitions) {
         lockedBalanceChanges: Object.keys(lockedBalanceChanges).length > 0 ? lockedBalanceChanges : undefined,
         orderbookChanges: Object.keys(orderbookChanges).length > 0 ? orderbookChanges : undefined,
         channelChanges,
+        escrowChanges,
         nftokenChanges: Object.keys(nftokenChanges).length > 0 ? nftokenChanges : undefined,
         nftokenOfferChanges: Object.keys(nftokenOfferChanges).length > 0 ? nftokenOfferChanges : undefined,
         uritokenChanges: Object.keys(uritokenChanges).length > 0 ? uritokenChanges : undefined,

package/lib/parse/specification/escrow-cancel.js

@@ -31,10 +31,15 @@ const common_1 = require("../../common");
 const memos_1 = __importDefault(require("../ledger/memos"));
 function parseEscrowCancel(tx) {
     assert.ok(tx.TransactionType === "EscrowCancel");
+    const source = {
+        address: tx.Account,
+        tag: tx.SourceTag,
+    };
     return (0, common_1.removeUndefined)({
-        memos: (0, memos_1.default)(tx),
+        source: (0, common_1.removeUndefined)(source),
         owner: tx.Owner,
         escrowSequence: tx.OfferSequence,
+        memos: (0, memos_1.default)(tx),
     });
 }
 exports.default = parseEscrowCancel;

package/lib/parse/specification/escrow-create.js

@@ -28,20 +28,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const assert = __importStar(require("assert"));
 const common_1 = require("../../common");
-const ripple_amount_1 = __importDefault(require("../ledger/ripple-amount"));
 const utils_1 = require("../utils");
 const memos_1 = __importDefault(require("../ledger/memos"));
 function parseEscrowCreation(tx) {
     assert.ok(tx.TransactionType === "EscrowCreate");
+    const source = {
+        address: tx.Account,
+        tag: tx.SourceTag,
+    };
+    const destination = {
+        address: tx.Destination,
+        tag: tx.DestinationTag,
+    };
     return (0, common_1.removeUndefined)({
-        amount: (0, ripple_amount_1.default)(tx.Amount),
-        destination: tx.Destination,
-        memos: (0, memos_1.default)(tx),
+        amount: tx.Amount,
+        source: (0, common_1.removeUndefined)(source),
+        destination: (0, common_1.removeUndefined)(destination),
         condition: tx.Condition,
         allowCancelAfter: (0, utils_1.parseTimestamp)(tx.CancelAfter),
         allowExecuteAfter: (0, utils_1.parseTimestamp)(tx.FinishAfter),
-        sourceTag: tx.SourceTag,
-        destinationTag: tx.DestinationTag,
+        memos: (0, memos_1.default)(tx),
     });
 }
 exports.default = parseEscrowCreation;

package/lib/parse/specification/escrow-finish.js

@@ -31,12 +31,17 @@ const common_1 = require("../../common");
 const memos_1 = __importDefault(require("../ledger/memos"));
 function parseEscrowFinish(tx) {
     assert.ok(tx.TransactionType === "EscrowFinish");
+    const source = {
+        address: tx.Account,
+        tag: tx.SourceTag,
+    };
     return (0, common_1.removeUndefined)({
-        memos: (0, memos_1.default)(tx),
+        source: (0, common_1.removeUndefined)(source),
         owner: tx.Owner,
         escrowSequence: tx.OfferSequence,
         condition: tx.Condition,
         fulfillment: tx.Fulfillment,
+        memos: (0, memos_1.default)(tx),
     });
 }
 exports.default = parseEscrowFinish;

package/lib/v1/common/types/objects/escrows.d.ts

@@ -1,19 +1,21 @@
 import { FormattedBaseSpecification } from "./specification";
-import { FormattedAmount } from "../../../../types";
+import { Amount } from "../../../../types";
+import { FormattedSourceAddress, FormattedDestinationAddress } from "./account";
 export type FormattedEscrowCancelSpecification = {
+    source: FormattedSourceAddress;
     owner: string;
     escrowSequence: number;
 } & FormattedBaseSpecification;
 export type FormattedEscrowCreateSpecification = {
-    amount?: FormattedAmount;
-    destination: string;
+    amount?: Amount;
+    source: FormattedSourceAddress;
+    destination: FormattedDestinationAddress;
     condition: string;
     allowCancelAfter?: string;
     allowExecuteAfter?: string;
-    sourceTag?: number;
-    destinationTag?: number;
 } & FormattedBaseSpecification;
 export type FormattedEscrowFinishSpecification = {
+    source: FormattedSourceAddress;
     owner: string;
     escrowSequence: number;
     condition?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "2.6.7",
+  "version": "2.7.1",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -47,7 +47,7 @@
     "lib/**/*"
   ],
   "dependencies": {
-    "axios": "^1.6.1",
+    "axios": "^1.6.2",
     "base-x": "^4.0.0",
     "bignumber.js": "^9.1.2",
     "elliptic": "^6.5.4",
@@ -63,8 +63,8 @@
     "@types/mocha": "^10.0.4",
     "@types/nconf": "^0.10.6",
     "@types/node": "^20.9.0",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "mocha": "^10.2.0",