@hashgraph/sdk
Version:
370 lines (345 loc) • 11.4 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _fs = _interopRequireDefault(require("fs"));
var _util = _interopRequireDefault(require("util"));
var _Client = _interopRequireDefault(require("./Client.cjs"));
var _NodeChannel = _interopRequireDefault(require("../channel/NodeChannel.cjs"));
var _NodeMirrorChannel = _interopRequireDefault(require("../channel/NodeMirrorChannel.cjs"));
var _LedgerId = _interopRequireDefault(require("../LedgerId.cjs"));
var _NodeAddressBook = _interopRequireDefault(require("../address_book/NodeAddressBook.cjs"));
var mainnet = _interopRequireWildcard(require("./addressbooks/mainnet.cjs"));
var testnet = _interopRequireWildcard(require("./addressbooks/testnet.cjs"));
var previewnet = _interopRequireWildcard(require("./addressbooks/previewnet.cjs"));
var hex = _interopRequireWildcard(require("../encoding/hex.cjs"));
var _ClientConstants = require("../constants/ClientConstants.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
const readFileAsync = _util.default.promisify(_fs.default.readFile);
/**
* @typedef {import("./Client.js").ClientConfiguration} ClientConfiguration
* @typedef {import("../account/AccountId.js").default} AccountId
*/
/**
* @augments {Client<NodeChannel, NodeMirrorChannel>}
* Client for interacting with the Hedera network using Node.js.
* Extends the base Client class with Node.js specific implementations.
*/
class NodeClient extends _Client.default {
/**
* @param {ClientConfiguration} [props]
*/
constructor(props) {
super(props);
/** @private */
this._maxExecutionTime = 10000;
if (props != null) {
if (typeof props.network === "string") {
this._setNetworkFromName(props.network);
} else if (props.network != null) {
_Client.default._validateNetworkConsistency(props.network);
const {
shard,
realm
} = _Client.default._extractShardRealm(props.network);
// Shard and realm are inferred from the network, so we need to set them here
// to ensure that the client is properly configured.
this._shard = shard;
this._realm = realm;
this.setNetwork(props.network);
}
if (typeof props.mirrorNetwork === "string") {
switch (props.mirrorNetwork) {
case "mainnet":
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.MAINNET);
break;
case "testnet":
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.TESTNET);
break;
case "previewnet":
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.PREVIEWNET);
break;
default:
this.setMirrorNetwork([props.mirrorNetwork]);
break;
}
} else if (props.mirrorNetwork != null) {
this.setMirrorNetwork(props.mirrorNetwork);
}
}
}
/**
* @param {string | ClientConfiguration} data
* @returns {NodeClient}
*/
static fromConfig(data) {
return new NodeClient(typeof data === "string" ? (/** @type {ClientConfiguration | undefined} */
JSON.parse(data)) : data);
}
/**
* @param {string} filename
* @returns {Promise<NodeClient>}
*/
static async fromConfigFile(filename) {
return NodeClient.fromConfig(await readFileAsync(filename, "utf8"));
}
/**
* Construct a client for a specific network.
*
* It is the responsibility of the caller to ensure that all nodes in the map are part of the
* same Hedera network. Failure to do so will result in undefined behavior.
*
* The client will load balance all requests to Hedera using a simple round-robin scheme to
* chose nodes to send transactions to. For one transaction, at most 1/3 of the nodes will be
* tried.
*
* @param {{[key: string]: (string | AccountId)}} network
* @param {ClientConfiguration} [props]
* @returns {NodeClient}
*/
static forNetwork(network, props) {
return new NodeClient({
network,
...props
});
}
/**
* @param {string} network
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {NodeClient}
*/
static forName(network, props = {}) {
return new NodeClient({
network,
...props
});
}
/**
* Construct a Hedera client pre-configured for Mainnet access.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {NodeClient}
*/
static forMainnet(props = {}) {
return new NodeClient({
network: "mainnet",
...props
});
}
/**
* Construct a Hedera client pre-configured for Testnet access.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {NodeClient}
*/
static forTestnet(props = {}) {
return new NodeClient({
network: "testnet",
...props
});
}
/**
* @param {string[] | string} mirrorNetwork
* @param {number} [shard]
* @param {number} [realm]
* @returns {Promise<NodeClient>}
*/
static async forMirrorNetwork(mirrorNetwork, shard, realm) {
const client = new NodeClient({
mirrorNetwork,
shard,
realm
});
await client.updateNetwork();
return client;
}
/**
* Construct a Hedera client pre-configured for Previewnet access.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {NodeClient}
*/
static forPreviewnet(props = {}) {
return new NodeClient({
network: "previewnet",
...props
});
}
/**
* Construct a Hedera client pre-configured for local-node access.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {NodeClient}
*/
static forLocalNode(props = {
scheduleNetworkUpdate: false
}) {
return new NodeClient({
network: "local-node",
...props
});
}
/**
* Construct a Hedera client pre-configured for Mainnet access with network update.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {Promise<NodeClient>}
*/
static async forMainnetAsync(props = {}) {
return new NodeClient({
network: "mainnet",
...props
}).updateNetwork();
}
/**
* Construct a Hedera client pre-configured for Testnet access with network update.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {Promise<NodeClient>}
*/
static async forTestnetAsync(props = {}) {
return new NodeClient({
network: "testnet",
...props
}).updateNetwork();
}
/**
* Construct a Hedera client pre-configured for Previewnet access with network update.
*
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {Promise<NodeClient>}
*/
static async forPreviewnetAsync(props = {}) {
return new NodeClient({
network: "previewnet",
...props
}).updateNetwork();
}
/**
* Construct a client for a specific network with optional network update.
* Updates network only if the network is not "local-node".
*
* @param {string} network
* @param {object} [props]
* @param {boolean} [props.scheduleNetworkUpdate]
* @returns {Promise<NodeClient>}
*/
static async forNameAsync(network, props = {}) {
const client = new NodeClient({
network,
...props
});
if (network !== "local-node") {
await client.updateNetwork();
}
return client;
}
/**
* @param {{[key: string]: (string | AccountId)} | string} network
* @returns {void}
*/
setNetwork(network) {
if (typeof network === "string") {
this._setNetworkFromName(network);
} else {
this._network.setNetwork(network);
}
}
/**
* Available only for NodeClient
*
* @param {number} maxExecutionTime
* @returns {this}
*/
setMaxExecutionTime(maxExecutionTime) {
this._maxExecutionTime = maxExecutionTime;
return this;
}
/**
* @private
* @param {string} name
* @returns {this}
*/
_setNetworkFromName(name) {
switch (name) {
case "mainnet":
this.setNetworkFromAddressBook(_NodeAddressBook.default.fromBytes(hex.decode(mainnet.addressBook)));
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.MAINNET);
this.setLedgerId(_LedgerId.default.MAINNET);
break;
case "testnet":
this.setNetworkFromAddressBook(_NodeAddressBook.default.fromBytes(hex.decode(testnet.addressBook)));
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.TESTNET);
this.setLedgerId(_LedgerId.default.TESTNET);
break;
case "previewnet":
this.setNetworkFromAddressBook(_NodeAddressBook.default.fromBytes(hex.decode(previewnet.addressBook)));
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.PREVIEWNET);
this.setLedgerId(_LedgerId.default.PREVIEWNET);
break;
case "local-node":
this.setNetwork(_ClientConstants.LocalNodeNetwork);
this.setMirrorNetwork(_ClientConstants.MirrorNetwork.LOCAL_NODE);
this.setLedgerId(_LedgerId.default.LOCAL_NODE);
break;
default:
throw new Error(
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
`unknown network: ${name}`);
}
return this;
}
/**
* @param {string[] | string} mirrorNetwork
* @returns {this}
*/
setMirrorNetwork(mirrorNetwork) {
if (typeof mirrorNetwork === "string") {
switch (mirrorNetwork) {
case "local-node":
this._mirrorNetwork.setNetwork(_ClientConstants.MirrorNetwork.LOCAL_NODE);
break;
case "previewnet":
this._mirrorNetwork.setNetwork(_ClientConstants.MirrorNetwork.PREVIEWNET);
break;
case "testnet":
this._mirrorNetwork.setNetwork(_ClientConstants.MirrorNetwork.TESTNET);
break;
case "mainnet":
this._mirrorNetwork.setNetwork(_ClientConstants.MirrorNetwork.MAINNET);
break;
default:
this._mirrorNetwork.setNetwork([mirrorNetwork]);
}
} else {
this._mirrorNetwork.setNetwork(mirrorNetwork);
}
return this;
}
/**
* @override
* @returns {(address: string, cert?: string) => NodeChannel}
*/
_createNetworkChannel() {
return address => new _NodeChannel.default(address, this._maxExecutionTime);
}
/**
* @override
* @returns {(address: string) => NodeMirrorChannel}
*/
_createMirrorNetworkChannel() {
return address => new _NodeMirrorChannel.default(address);
}
}
exports.default = NodeClient;