@bithomp/xrpl-api 3.1.12 → 3.1.14

package/README.md

@@ -75,7 +75,7 @@ BithompXRPL.Client.setup(config);
 // connect
 await BithompXRPL.Client.connect();
 
-// validator secrets, should not belong to any validators keys.
+// validator(master) secrets, should not belong to any validators keys.
 // can be any ed25519 (publicKey starts on `ED`) or secp256k1 could be used,
 // can ne generated with BithompXRPL.Validator.generateSecrets() or by generateSeed from ripple-keypairs
 const vk = {
@@ -83,7 +83,7 @@ const vk = {
   publicKey: "ED________________________________",
 };
 
-// signing secrets, should not belong to any validators keys.
+// signing secrets, should not belong to any validators keys and should be different from vk.
 // can be any ed25519 (publicKey starts on `ED`) or secp256k1 could be used,
 // can ne generated with BithompXRPL.Validator.generateSecrets() or by generateSeed from ripple-keypairs
 const sk = {
@@ -108,6 +108,9 @@ const vl = await BithompXRPL.Client.createVL(vk, sk, sequence, expiration, valid
 //   "public_key": "..." // vk.publicKey
 // }
 
+// NOTE: to be able rippled to accept the validator list, you have to add validator(master) public key
+// to [validator_list_keys] in rippled.cfg
+
 //  disconnect
 BithompXRPL.Client.disconnect();
 ```
@@ -131,7 +134,7 @@ BithompXRPL.Client.setup(config);
 // connect
 await BithompXRPL.Client.connect();
 
-// validator secrets, should not belong to any validators keys.
+// validator(master) secrets, should not belong to any validators keys.
 // can be any ed25519 (publicKey starts on `ED`) or secp256k1 could be used,
 // can ne generated with BithompXRPL.Validator.generateSecrets() or by generateSeed from ripple-keypairs
 const vk = {
@@ -139,7 +142,7 @@ const vk = {
   publicKey: "ED________________________________",
 };
 
-// signing secrets, should not belong to any validators keys.
+// signing secrets, should not belong to any validators keys and should be different from vk.
 // can be any ed25519 (publicKey starts on `ED`) or secp256k1 could be used,
 // can ne generated with BithompXRPL.Validator.generateSecrets() or by generateSeed from ripple-keypairs
 const sk = {
@@ -171,6 +174,9 @@ const vl = await BithompXRPL.Client.createVLv2(vk, sk, [publishBlob, publishBlob
 //   "public_key": "..." // vk.publicKey
 // }
 
+// NOTE: to be able rippled to accept the validator list, you have to add validator(master) public key
+// to [validator_list_keys] in rippled.cfg
+
 //  disconnect
 BithompXRPL.Client.disconnect();
 ```

package/lib/connection.js

@@ -109,11 +109,14 @@ class Connection extends events_1.EventEmitter {
                 url: this.url,
                 error: err?.message || err?.name || err,
             });
-            if (err.data) {
+            if (err.name === "TimeoutError") {
+                return { error: "timeout", error_message: "Request timeout.", status: "error" };
+            }
+            else if (err.data) {
                 return err.data;
             }
             else {
-                return { error: err?.message || err?.name || err };
+                return { error: err?.message || err?.name || err, status: "error" };
             }
         }
     }
@@ -204,6 +207,7 @@ class Connection extends events_1.EventEmitter {
                 this.logger?.warn({
                     service: "Bithomp::XRPL::Connection",
                     function: "reconnect",
+                    url: this.url,
                     error: e.message,
                 });
             }
@@ -252,6 +256,7 @@ class Connection extends events_1.EventEmitter {
                     service: "Bithomp::XRPL::Connection",
                     emit: "error",
                     source,
+                    url: this.url,
                     error: message || error?.name || error,
                 });
                 this.emit("error", source, message, error);
@@ -494,6 +499,7 @@ class Connection extends events_1.EventEmitter {
             this.logger?.warn({
                 service: "Bithomp::XRPL::Connection",
                 function: "connectionValidationTimeout",
+                url: this.url,
                 error: e.message,
             });
             this.connectionValidation();

package/lib/ledger/vl-v2.js

@@ -38,6 +38,9 @@ async function createVLv2(masterKey, ephemeralKey, publishBlobs) {
     if (!ephemeralKey) {
         throw new Error("Ephemeral key is required");
     }
+    if (masterKey.publicKey === ephemeralKey.publicKey) {
+        throw new Error("Master and ephemeral keys must be different.");
+    }
     let globalSequence;
     const blobs = [];
     for (const publishBlob of publishBlobs) {

package/lib/ledger/vl.js

@@ -40,6 +40,9 @@ async function createVL(masterKey, ephemeralKey, sequence, expiration, validator
     if (!ephemeralKey) {
         throw new Error("Ephemeral key is required");
     }
+    if (masterKey.publicKey === ephemeralKey.publicKey) {
+        throw new Error("Master and ephemeral keys must be different.");
+    }
     if (typeof sequence !== "number") {
         throw new Error("sequence must be a number.");
     }

package/lib/models/manifest.js

@@ -145,6 +145,10 @@ function parseManifest(manifest) {
         decoded.error = "Master signature does not match";
         return decoded;
     }
+    if (decoded.SigningPubKey && decoded.PublicKey && decoded.SigningPubKey === decoded.PublicKey) {
+        decoded.error = "Master and ephemeral public keys must be different";
+        return decoded;
+    }
     return decoded;
 }
 function generateManifest(manifest) {

package/lib/parse/outcome/amm_changes.js

@@ -61,6 +61,8 @@ function summarizeVoteSlotsChanges(node) {
             return acc.concat((0, common_1.removeUndefined)({
                 status: "modified",
                 account: slot.VoteEntry.Account,
+                tradingFee: slot.VoteEntry.TradingFee,
+                voteWeight: slot.VoteEntry.VoteWeight,
                 tradingFeeChange: tradingFeeChange || undefined,
                 voteWeightChange: voteWeightChange || undefined,
             }));

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

@@ -0,0 +1,13 @@
+interface FormattedDIDSummaryInterface {
+    status?: "created" | "modified" | "deleted";
+    didID?: string;
+    account?: string;
+    uri: string;
+    data: string;
+    didDocument: string;
+    uriChange?: string;
+    dataChanges?: string;
+    didDocumentChanges?: string;
+}
+declare function parseDIDChanges(metadata: any): FormattedDIDSummaryInterface | undefined;
+export { parseDIDChanges };

package/lib/parse/outcome/did_changes.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDIDChanges = parseDIDChanges;
+const utils_1 = require("../utils");
+const common_1 = require("../../common");
+function parseDIDStatus(node) {
+    if (node.diffType === "CreatedNode") {
+        return "created";
+    }
+    if (node.diffType === "ModifiedNode") {
+        return "modified";
+    }
+    if (node.diffType === "DeletedNode") {
+        return "deleted";
+    }
+    return undefined;
+}
+function summarizeDID(node) {
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    const prev = node.previousFields || {};
+    const summary = {
+        status: parseDIDStatus(node),
+        didID: node.LedgerIndex,
+        account: final.Account,
+        uri: final.URI,
+        data: final.Data,
+        didDocument: final.DIDDocument,
+    };
+    if (prev.URI) {
+        summary.uriChange = prev.URI;
+    }
+    if (prev.Data) {
+        summary.dataChanges = prev.Data;
+    }
+    if (prev.DIDDocument) {
+        summary.didDocumentChanges = prev.DIDDocument;
+    }
+    return (0, common_1.removeUndefined)(summary);
+}
+function parseDIDChanges(metadata) {
+    const dids = (0, utils_1.normalizeNodes)(metadata).filter((n) => {
+        return n.entryType === "DID";
+    });
+    return dids.length === 1 ? summarizeDID(dids[0]) : undefined;
+}

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

@@ -12,3 +12,5 @@ export { parseEmittedTxns } from "./emitted_txns";
 export { parseEscrowChanges } from "./escrow_changes";
 export { parseUNLReportChanges } from "./unl_report_changes";
 export { parseAmmChanges } from "./amm_changes";
+export { parseDIDChanges } from "./did_changes";
+export { parseOracleChanges } from "./oracle_changes";

package/lib/parse/outcome/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseAmmChanges = exports.parseUNLReportChanges = 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;
+exports.parseOracleChanges = exports.parseDIDChanges = exports.parseAmmChanges = exports.parseUNLReportChanges = 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");
@@ -29,3 +29,7 @@ var unl_report_changes_1 = require("./unl_report_changes");
 Object.defineProperty(exports, "parseUNLReportChanges", { enumerable: true, get: function () { return unl_report_changes_1.parseUNLReportChanges; } });
 var amm_changes_1 = require("./amm_changes");
 Object.defineProperty(exports, "parseAmmChanges", { enumerable: true, get: function () { return amm_changes_1.parseAmmChanges; } });
+var did_changes_1 = require("./did_changes");
+Object.defineProperty(exports, "parseDIDChanges", { enumerable: true, get: function () { return did_changes_1.parseDIDChanges; } });
+var oracle_changes_1 = require("./oracle_changes");
+Object.defineProperty(exports, "parseOracleChanges", { enumerable: true, get: function () { return oracle_changes_1.parseOracleChanges; } });

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

@@ -0,0 +1,28 @@
+import { OraclePriceDataSeriesInterface, FormattedOraclePriceDataSeriesInterface } from "../../types";
+interface FormattedOracleSummaryInterface {
+    status?: "created" | "modified" | "deleted";
+    oracleID?: string;
+    oracleDocumentID?: number;
+    provider: string;
+    uri?: string;
+    assetClass: string;
+    lastUpdateTime: number;
+    priceDataSeries: FormattedOraclePriceDataSeriesInterface[];
+    uriChanges?: string;
+    lastUpdateTimeChanges?: number;
+    priceDataSeriesChanges?: FormattedPriceDataSeriesChanges[];
+}
+interface FormattedPriceDataSeriesChanges {
+    status: "added" | "modified" | "removed";
+    baseAsset: string;
+    quoteAsset: string;
+    assetPrice?: string;
+    scale?: number;
+    originalAssetPrice?: string;
+    assetPriceChange?: string;
+    scaleChange?: number;
+    originalPriceChange?: string;
+}
+declare function parsePriceDataSeries(series: OraclePriceDataSeriesInterface): FormattedOraclePriceDataSeriesInterface;
+declare function parseOracleChanges(metadata: any): FormattedOracleSummaryInterface | undefined;
+export { parseOracleChanges, parsePriceDataSeries };

package/lib/parse/outcome/oracle_changes.js

@@ -0,0 +1,145 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseOracleChanges = parseOracleChanges;
+exports.parsePriceDataSeries = parsePriceDataSeries;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const utils_1 = require("../utils");
+const common_1 = require("../../common");
+function parseOracleStatus(node) {
+    if (node.diffType === "CreatedNode") {
+        return "created";
+    }
+    if (node.diffType === "ModifiedNode") {
+        return "modified";
+    }
+    if (node.diffType === "DeletedNode") {
+        return "deleted";
+    }
+    return undefined;
+}
+function hexPriceToBigNumber(hex) {
+    if (hex === undefined) {
+        return undefined;
+    }
+    if (typeof hex !== "string") {
+        throw new Error("Price must be a string.");
+    }
+    return new bignumber_js_1.default(`0x${hex}`);
+}
+function getOriginalAssetPrice(assetPrice, scale) {
+    if (assetPrice === undefined || scale === undefined) {
+        return undefined;
+    }
+    if (assetPrice.isZero()) {
+        return assetPrice;
+    }
+    if (scale === 0) {
+        return assetPrice;
+    }
+    return assetPrice.dividedBy(new bignumber_js_1.default(10).pow(scale));
+}
+function parsePriceDataSeries(series) {
+    const assetPrice = hexPriceToBigNumber(series.PriceData.AssetPrice);
+    const scale = series.PriceData.Scale;
+    const originalAssetPrice = getOriginalAssetPrice(assetPrice, scale);
+    return (0, common_1.removeUndefined)({
+        baseAsset: series.PriceData.BaseAsset,
+        quoteAsset: series.PriceData.QuoteAsset,
+        assetPrice: assetPrice?.toString(),
+        scale: series.PriceData.Scale,
+        originalAssetPrice: originalAssetPrice?.toString(),
+    });
+}
+function summarizePriceDataSeriesChanges(node) {
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    const prev = node.previousFields || {};
+    const changes = final.PriceDataSeries.reduce((acc, series) => {
+        const prevSeries = prev.PriceDataSeries.find((s) => s.PriceData.BaseAsset === series.PriceData.BaseAsset && s.PriceData.QuoteAsset === series.PriceData.QuoteAsset);
+        const priceFinal = hexPriceToBigNumber(series.PriceData.AssetPrice) || new bignumber_js_1.default(0);
+        const scaleFinal = series.PriceData.Scale || 0;
+        const originalPriceFinal = getOriginalAssetPrice(priceFinal, scaleFinal);
+        if (!prevSeries) {
+            return acc.concat({
+                status: "added",
+                baseAsset: series.PriceData.BaseAsset,
+                quoteAsset: series.PriceData.QuoteAsset,
+                assetPrice: priceFinal?.toString(),
+                scale: scaleFinal,
+                originalAssetPrice: originalPriceFinal?.toString(),
+            });
+        }
+        const pricePrev = hexPriceToBigNumber(prevSeries.PriceData.AssetPrice) || new bignumber_js_1.default(0);
+        const scalePrev = prevSeries.PriceData.Scale || 0;
+        const assetPriceChange = (priceFinal || new bignumber_js_1.default(0)).minus(pricePrev);
+        const scaleChange = (scaleFinal ?? 0) - scalePrev;
+        if (!assetPriceChange.isZero() || scaleChange !== 0) {
+            const originalPricePrev = getOriginalAssetPrice(pricePrev, scalePrev) || new bignumber_js_1.default(0);
+            const originalPriceChange = (originalPriceFinal || new bignumber_js_1.default(0)).minus(originalPricePrev);
+            return acc.concat((0, common_1.removeUndefined)({
+                status: "modified",
+                baseAsset: series.PriceData.BaseAsset,
+                quoteAsset: series.PriceData.QuoteAsset,
+                assetPrice: priceFinal?.toString(),
+                scale: scaleFinal,
+                originalAssetPrice: originalPriceFinal?.toString(),
+                assetPriceChange: assetPriceChange.isZero() ? undefined : assetPriceChange?.toString(),
+                scaleChange: scaleChange || undefined,
+                originalPriceChange: originalPriceChange.isZero() ? undefined : originalPriceChange.toString(),
+            }));
+        }
+        return acc;
+    }, []);
+    const removed = prev.PriceDataSeries.filter((s) => {
+        return !final.PriceDataSeries.find((series) => series.PriceData.BaseAsset === s.PriceData.BaseAsset && series.PriceData.QuoteAsset === s.PriceData.QuoteAsset);
+    });
+    if (removed.length > 0) {
+        return changes.concat(removed.map((s) => {
+            const price = hexPriceToBigNumber(s.PriceData.AssetPrice);
+            return {
+                status: "removed",
+                baseAsset: s.PriceData.BaseAsset,
+                quoteAsset: s.PriceData.QuoteAsset,
+                assetPrice: price?.toString(),
+                scale: s.PriceData.Scale,
+                originalAssetPrice: getOriginalAssetPrice(price, s.PriceData.Scale),
+            };
+        }));
+    }
+    if (changes.length === 0) {
+        return undefined;
+    }
+    return changes;
+}
+function summarizeOracle(node) {
+    const final = node.diffType === "CreatedNode" ? node.newFields : node.finalFields;
+    const prev = node.previousFields || {};
+    const summary = {
+        status: parseOracleStatus(node),
+        oracleID: node.LedgerIndex,
+        oracleDocumentID: final.OracleDocumentID,
+        provider: final.Provider,
+        uri: final.URI,
+        assetClass: final.AssetClass,
+        lastUpdateTime: final.LastUpdateTime,
+        priceDataSeries: final.PriceDataSeries.map(parsePriceDataSeries),
+    };
+    if (prev.URI) {
+        summary.uriChanges = final.URI;
+    }
+    if (prev.LastUpdateTime) {
+        summary.lastUpdateTimeChanges = final.LastUpdateTime - (prev.LastUpdateTime || 0);
+    }
+    if (prev.PriceDataSeries) {
+        summary.priceDataSeriesChanges = summarizePriceDataSeriesChanges(node);
+    }
+    return (0, common_1.removeUndefined)(summary);
+}
+function parseOracleChanges(metadata) {
+    const oracles = (0, utils_1.normalizeNodes)(metadata).filter((n) => {
+        return n.entryType === "Oracle";
+    });
+    return oracles.length === 1 ? summarizeOracle(oracles[0]) : undefined;
+}

package/lib/parse/outcome.js

@@ -79,6 +79,8 @@ function parseOutcome(tx, nativeCurrency, definitions) {
     const emittedTxns = (0, index_1.parseEmittedTxns)(tx, definitions);
     const unlReportChanges = (0, index_1.parseUNLReportChanges)(tx);
     const ammChanges = (0, index_1.parseAmmChanges)(metadata);
+    const didChanges = (0, index_1.parseDIDChanges)(metadata);
+    const oracleChanges = (0, index_1.parseOracleChanges)(metadata);
     removeEmptyCounterpartyInBalanceChanges(balanceChanges);
     removeEmptyCounterpartyInBalanceChanges(lockedBalanceChanges);
     removeEmptyCounterpartyInOrderbookChanges(orderbookChanges);
@@ -97,6 +99,8 @@ function parseOutcome(tx, nativeCurrency, definitions) {
         uritokenSellOfferChanges: Object.keys(uritokenSellOfferChanges).length > 0 ? uritokenSellOfferChanges : undefined,
         affectedObjects: affectedObjects ? (0, common_1.removeUndefined)(affectedObjects) : undefined,
         ammChanges: ammChanges ? (0, common_1.removeUndefined)(ammChanges) : undefined,
+        didChanges: didChanges ? (0, common_1.removeUndefined)(didChanges) : undefined,
+        oracleChanges: oracleChanges ? (0, common_1.removeUndefined)(oracleChanges) : undefined,
         unlReportChanges,
         hooksExecutions,
         emittedTxns,

package/lib/parse/specification/did-delete.d.ts

@@ -0,0 +1,3 @@
+import { FormattedDIDDeleteSpecification } from "../../types/did";
+declare function parseDidDelete(tx: any): FormattedDIDDeleteSpecification;
+export default parseDidDelete;

package/lib/parse/specification/did-delete.js

@@ -0,0 +1,43 @@
+"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 });
+const assert = __importStar(require("assert"));
+const common_1 = require("../../common");
+const emit_details_1 = require("../ledger/emit_details");
+const memos_1 = require("../ledger/memos");
+const account_1 = require("../ledger/account");
+function parseDidDelete(tx) {
+    assert.ok(tx.TransactionType === "DIDDelete");
+    const source = (0, common_1.removeUndefined)({
+        address: (0, account_1.parseAccount)(tx.Account),
+        tag: tx.SourceTag,
+    });
+    return (0, common_1.removeUndefined)({
+        source: Object.keys(source).length > 0 ? source : undefined,
+        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
+        memos: (0, memos_1.parseMemos)(tx),
+    });
+}
+exports.default = parseDidDelete;

package/lib/parse/specification/did-set.d.ts

@@ -0,0 +1,3 @@
+import { FormattedDIDSetSpecification } from "../../types/did";
+declare function parseDidSet(tx: any): FormattedDIDSetSpecification;
+export default parseDidSet;

package/lib/parse/specification/did-set.js

@@ -0,0 +1,46 @@
+"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 });
+const assert = __importStar(require("assert"));
+const common_1 = require("../../common");
+const emit_details_1 = require("../ledger/emit_details");
+const memos_1 = require("../ledger/memos");
+const account_1 = require("../ledger/account");
+function parseDidSet(tx) {
+    assert.ok(tx.TransactionType === "DIDSet");
+    const source = (0, common_1.removeUndefined)({
+        address: (0, account_1.parseAccount)(tx.Account),
+        tag: tx.SourceTag,
+    });
+    return (0, common_1.removeUndefined)({
+        source: Object.keys(source).length > 0 ? source : undefined,
+        uri: tx.URI,
+        data: tx.Data,
+        didDocument: tx.DIDDocument,
+        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
+        memos: (0, memos_1.parseMemos)(tx),
+    });
+}
+exports.default = parseDidSet;

package/lib/parse/specification/oracle-delete.d.ts

@@ -0,0 +1,3 @@
+import { FormattedOracleDeleteSpecification } from "../../types/oracle";
+declare function parseDidDelete(tx: any): FormattedOracleDeleteSpecification;
+export default parseDidDelete;

package/lib/parse/specification/oracle-delete.js

@@ -0,0 +1,44 @@
+"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 });
+const assert = __importStar(require("assert"));
+const common_1 = require("../../common");
+const emit_details_1 = require("../ledger/emit_details");
+const memos_1 = require("../ledger/memos");
+const account_1 = require("../ledger/account");
+function parseDidDelete(tx) {
+    assert.ok(tx.TransactionType === "OracleDelete");
+    const source = (0, common_1.removeUndefined)({
+        address: (0, account_1.parseAccount)(tx.Account),
+        tag: tx.SourceTag,
+    });
+    return (0, common_1.removeUndefined)({
+        source: Object.keys(source).length > 0 ? source : undefined,
+        oracleDocumentID: tx.OracleDocumentID,
+        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
+        memos: (0, memos_1.parseMemos)(tx),
+    });
+}
+exports.default = parseDidDelete;

package/lib/parse/specification/oracle-set.d.ts

@@ -0,0 +1,3 @@
+import { FormattedOracleSetSpecification } from "../../types/oracle";
+declare function parseDidSet(tx: any): FormattedOracleSetSpecification;
+export default parseDidSet;

package/lib/parse/specification/oracle-set.js

@@ -0,0 +1,50 @@
+"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 });
+const assert = __importStar(require("assert"));
+const common_1 = require("../../common");
+const emit_details_1 = require("../ledger/emit_details");
+const memos_1 = require("../ledger/memos");
+const account_1 = require("../ledger/account");
+const oracle_changes_1 = require("../outcome/oracle_changes");
+function parseDidSet(tx) {
+    assert.ok(tx.TransactionType === "OracleSet");
+    const source = (0, common_1.removeUndefined)({
+        address: (0, account_1.parseAccount)(tx.Account),
+        tag: tx.SourceTag,
+    });
+    return (0, common_1.removeUndefined)({
+        source: Object.keys(source).length > 0 ? source : undefined,
+        oracleDocumentID: tx.OracleDocumentID,
+        provider: tx.Provider,
+        uri: tx.URI,
+        assetClass: tx.AssetClass,
+        lastUpdateTime: tx.LastUpdateTime,
+        priceDataSeries: tx.PriceDataSeries ? tx.PriceDataSeries.map(oracle_changes_1.parsePriceDataSeries) : undefined,
+        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
+        memos: (0, memos_1.parseMemos)(tx),
+    });
+}
+exports.default = parseDidSet;

package/lib/parse/transaction.js

@@ -46,6 +46,10 @@ const amm_delete_1 = __importDefault(require("./specification/amm-delete"));
 const amm_deposit_1 = __importDefault(require("./specification/amm-deposit"));
 const amm_withdraw_1 = __importDefault(require("./specification/amm-withdraw"));
 const amm_vote_1 = __importDefault(require("./specification/amm-vote"));
+const did_set_1 = __importDefault(require("./specification/did-set"));
+const did_delete_1 = __importDefault(require("./specification/did-delete"));
+const oracle_set_1 = __importDefault(require("./specification/oracle-set"));
+const oracle_delete_1 = __importDefault(require("./specification/oracle-delete"));
 const genesis_mint_1 = __importDefault(require("./specification/genesis-mint"));
 const amendment_1 = __importDefault(require("./specification/amendment"));
 const fee_update_1 = __importDefault(require("./specification/fee-update"));
@@ -90,6 +94,10 @@ const transactionTypeToType = {
     AMMDeposit: "ammDeposit",
     AMMWithdraw: "ammWithdraw",
     AMMVote: "ammVote",
+    DIDSet: "didSet",
+    DIDDelete: "didDelete",
+    OracleSet: "oracleSet",
+    OracleDelete: "oracleDelete",
     GenesisMint: "genesisMint",
     EnableAmendment: "amendment",
     SetFee: "feeUpdate",
@@ -136,6 +144,10 @@ const parserTypeFunc = {
     ammDeposit: amm_deposit_1.default,
     ammWithdraw: amm_withdraw_1.default,
     ammVote: amm_vote_1.default,
+    didSet: did_set_1.default,
+    didDelete: did_delete_1.default,
+    oracleSet: oracle_set_1.default,
+    oracleDelete: oracle_delete_1.default,
     genesisMint: genesis_mint_1.default,
     amendment: amendment_1.default,
     feeUpdate: fee_update_1.default,

package/lib/types/did.d.ts

@@ -0,0 +1,7 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedDIDSetSpecification = {
+    uri: string;
+    data: string;
+    didDocument: string;
+} & FormattedBaseSpecification;
+export type FormattedDIDDeleteSpecification = {} & FormattedBaseSpecification;

package/lib/types/did.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./amounts";
 export * from "./amm";
 export * from "./checks";
 export * from "./deposits";
+export * from "./did";
 export * from "./escrows";
 export * from "./fees";
 export * from "./gateway_balances";
@@ -13,6 +14,7 @@ export * from "./ledger_data";
 export * from "./ledger_entries";
 export * from "./memos";
 export * from "./offers";
+export * from "./oracle";
 export * from "./queue_data";
 export * from "./settings";
 export * from "./signers";

package/lib/types/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./amounts"), exports);
 __exportStar(require("./amm"), exports);
 __exportStar(require("./checks"), exports);
 __exportStar(require("./deposits"), exports);
+__exportStar(require("./did"), exports);
 __exportStar(require("./escrows"), exports);
 __exportStar(require("./fees"), exports);
 __exportStar(require("./gateway_balances"), exports);
@@ -29,6 +30,7 @@ __exportStar(require("./ledger_data"), exports);
 __exportStar(require("./ledger_entries"), exports);
 __exportStar(require("./memos"), exports);
 __exportStar(require("./offers"), exports);
+__exportStar(require("./oracle"), exports);
 __exportStar(require("./queue_data"), exports);
 __exportStar(require("./settings"), exports);
 __exportStar(require("./signers"), exports);

package/lib/types/oracle.d.ts

@@ -0,0 +1,27 @@
+import { FormattedBaseSpecification } from "./specification";
+export interface OraclePriceDataSeriesInterface {
+    PriceData: {
+        BaseAsset: string;
+        QuoteAsset: string;
+        AssetPrice?: string;
+        Scale?: number;
+    };
+}
+export interface FormattedOraclePriceDataSeriesInterface {
+    baseAsset: string;
+    quoteAsset: string;
+    assetPrice?: string;
+    scale?: number;
+    originalAssetPriceChange?: string;
+}
+export type FormattedOracleSetSpecification = {
+    oracleDocumentID: number;
+    provider: string;
+    uri?: string;
+    assetClass: string;
+    lastUpdateTime: number;
+    priceDataSeries: FormattedOraclePriceDataSeriesInterface[];
+} & FormattedBaseSpecification;
+export type FormattedOracleDeleteSpecification = {
+    oracleDocumentID: number;
+} & FormattedBaseSpecification;

package/lib/types/oracle.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.1.12",
+  "version": "3.1.14",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -55,7 +55,7 @@
     "axios": "^1.7.7",
     "base-x": "^5.0.0",
     "bignumber.js": "^9.1.2",
-    "elliptic": "^6.5.7",
+    "elliptic": "^6.6.0",
     "lodash": "^4.17.21",
     "ripple-address-codec": "^5.0.0",
     "ripple-binary-codec": "^2.1.0",
@@ -64,7 +64,7 @@
   "devDependencies": {
     "@types/chai": "^4.3.19",
     "@types/chai-as-promised": "^7.1.8",
-    "@types/lodash": "^4.17.11",
+    "@types/lodash": "^4.17.12",
     "@types/mocha": "^10.0.9",
     "@types/nconf": "^0.10.7",
     "@types/node": "^20.14.15",