@hashgraph/sdk
Version:
217 lines (200 loc) • 7.36 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _Query = _interopRequireDefault(require("../query/Query.cjs"));
var _NodeAddress = _interopRequireDefault(require("../address_book/NodeAddress.cjs"));
var _NodeAddressBook = _interopRequireDefault(require("../address_book/NodeAddressBook.cjs"));
var HieroProto = _interopRequireWildcard(require("@hashgraph/proto"));
var _FileId = _interopRequireDefault(require("../file/FileId.cjs"));
var _Executable = require("../Executable.cjs");
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
// SPDX-License-Identifier: Apache-2.0
/**
* @typedef {import("../channel/Channel.js").default} Channel
* @typedef {import("../channel/MirrorChannel.js").default} MirrorChannel
* @typedef {import("../channel/MirrorChannel.js").MirrorError} MirrorError
*/
/**
* @template {Channel} ChannelT
* @typedef {import("../client/Client.js").default<ChannelT, MirrorChannel>} Client<ChannelT, MirrorChannel>
*/
/**
* Query to get a list of Hedera network node addresses from a mirror node.
*
* This query can be used to retrieve node addresses either from a specific file ID
* or from the most recent address book if no file ID is specified. The response
* contains node metadata including IP addresses and ports for both node and mirror
* node services.
* @augments {Query<NodeAddressBook>}
*/
class AddressBookQuery extends _Query.default {
/**
* @param {object} props
* @param {FileId | string} [props.fileId]
* @param {number} [props.limit]
*/
constructor(props = {}) {
super();
/**
* @private
* @type {?FileId}
*/
this._fileId = null;
if (props.fileId != null) {
this.setFileId(props.fileId);
}
/**
* @private
* @type {?number}
*/
this._limit = null;
if (props.limit != null) {
this.setLimit(props.limit);
}
/**
* @private
* @type {(error: MirrorError | Error | null) => boolean}
*/
this._retryHandler = error => {
if (error != null) {
if (error instanceof Error) {
// Retry on all errors which are not `MirrorError` because they're
// likely lower level HTTP/2 errors
return true;
} else {
// Retry on `NOT_FOUND`, `RESOURCE_EXHAUSTED`, `UNAVAILABLE`, and conditionally on `INTERNAL`
// if the message matches the right regex.
switch (error.code) {
// INTERNAL
// eslint-disable-next-line no-fallthrough
case 13:
return _Executable.RST_STREAM.test(error.details.toString());
// NOT_FOUND
// eslint-disable-next-line no-fallthrough
case 5:
// RESOURCE_EXHAUSTED
// eslint-disable-next-line no-fallthrough
case 8:
// UNAVAILABLE
// eslint-disable-next-line no-fallthrough
case 14:
case 17:
return true;
default:
return false;
}
}
}
return false;
};
/** @type {NodeAddress[]} */
this._addresses = [];
/**
* @private
* @type {number}
*/
this._attempt = 0;
}
/**
* @returns {?FileId}
*/
get fileId() {
return this._fileId;
}
/**
* @param {FileId | string} fileId
* @returns {AddressBookQuery}
*/
setFileId(fileId) {
this._fileId = typeof fileId === "string" ? _FileId.default.fromString(fileId) : fileId.clone();
return this;
}
/**
* @returns {?number}
*/
get limit() {
return this._limit;
}
/**
* @param {number} limit
* @returns {AddressBookQuery}
*/
setLimit(limit) {
this._limit = limit;
return this;
}
/**
* @param {number} attempts
* @returns {this}
*/
setMaxAttempts(attempts) {
this._maxAttempts = attempts;
return this;
}
/**
* @param {number} backoff
* @returns {this}
*/
setMaxBackoff(backoff) {
this._maxBackoff = backoff;
return this;
}
/**
* @param {Client<Channel>} client
* @param {number=} requestTimeout
* @returns {Promise<NodeAddressBook>}
*/
execute(client, requestTimeout) {
// Extra validation when initializing the client with only a mirror network
if (client._network._network.size === 0 && !client._timer) {
throw new Error("The client's network update period is required. Please set it using the setNetworkUpdatePeriod method.");
}
return new Promise((resolve, reject) => {
this._makeServerStreamRequest(client, /** @type {(value: NodeAddressBook) => void} */resolve, reject, requestTimeout);
});
}
/**
* @private
* @param {Client<Channel>} client
* @param {(value: NodeAddressBook) => void} resolve
* @param {(error: Error) => void} reject
* @param {number=} requestTimeout
*/
_makeServerStreamRequest(client, resolve, reject, requestTimeout) {
const request = HieroProto.com.hedera.mirror.api.proto.AddressBookQuery.encode({
fileId: this._fileId != null ? this._fileId._toProtobuf() : null,
limit: this._limit
}).finish();
client._mirrorNetwork.getNextMirrorNode().getChannel().makeServerStreamRequest("NetworkService", "getNodes", request, data => {
this._addresses.push(_NodeAddress.default._fromProtobuf(HieroProto.proto.NodeAddress.decode(data)));
if (this._limit != null && this._limit > 0) {
this._limit = this._limit - 1;
}
}, error => {
const message = error instanceof Error ? error.message : error.details;
if (this._attempt < this._maxAttempts && !client.isClientShutDown && this._retryHandler(error)) {
const delay = Math.min(250 * 2 ** this._attempt, this._maxBackoff);
if (this._attempt >= this._maxAttempts) {
console.warn(`Error getting nodes from mirror for file ${this._fileId != null ? this._fileId.toString() : "UNKNOWN"} during attempt ${this._attempt}. Waiting ${delay} ms before next attempt: ${message}`);
}
if (this._logger) {
this._logger.debug(`Error getting nodes from mirror for file ${this._fileId != null ? this._fileId.toString() : "UNKNOWN"} during attempt ${this._attempt}. Waiting ${delay} ms before next attempt: ${message}`);
}
this._attempt += 1;
setTimeout(() => {
this._makeServerStreamRequest(client, resolve, reject, requestTimeout);
}, delay);
} else {
reject(new Error("failed to query address book"));
}
}, () => {
resolve(new _NodeAddressBook.default({
nodeAddresses: this._addresses
}));
});
}
}
exports.default = AddressBookQuery;