@hashgraph/sdk
Version:
472 lines (427 loc) • 13.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _AccountId = _interopRequireDefault(require("../account/AccountId.cjs"));
var _CustomFixedFee = _interopRequireDefault(require("../token/CustomFixedFee.cjs"));
var _Transaction = _interopRequireWildcard(require("../transaction/Transaction.cjs"));
var _Duration = _interopRequireDefault(require("../Duration.cjs"));
var _Key = _interopRequireDefault(require("../Key.cjs"));
var _Hbar = _interopRequireDefault(require("../Hbar.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
/**
* @namespace proto
* @typedef {import("@hashgraph/proto").proto.IConsensusCreateTopicTransactionBody} HieroProto.proto.IConsensusCreateTopicTransactionBody
* @typedef {import("@hashgraph/proto").proto.ITransaction} HieroProto.proto.ITransaction
* @typedef {import("@hashgraph/proto").proto.ISignedTransaction} HieroProto.proto.ISignedTransaction
* @typedef {import("@hashgraph/proto").proto.TransactionBody} HieroProto.proto.TransactionBody
* @typedef {import("@hashgraph/proto").proto.ITransactionBody} HieroProto.proto.ITransactionBody
* @typedef {import("@hashgraph/proto").proto.ITransactionResponse} HieroProto.proto.ITransactionResponse
*/
/**
* @typedef {import("../channel/Channel.js").default} Channel
* @typedef {import("../client/Client.js").default<*, *>} Client
* @typedef {import("../transaction/TransactionId.js").default} TransactionId
*/
/**
* Create a topic to be used for consensus.
*/
class TopicCreateTransaction extends _Transaction.default {
/**
* @param {object} props
* @param {Key} [props.adminKey]
* @param {Key} [props.submitKey]
* @param {Key} [props.feeScheduleKey]
* @param {Duration | Long | number} [props.autoRenewPeriod]
* @param {AccountId | string} [props.autoRenewAccountId]
* @param {CustomFixedFee[]} [props.customFees]
* @param {Key[]} [props.feeExemptKeys]
* @param {string} [props.topicMemo]
*/
constructor(props = {}) {
super();
this._defaultMaxTransactionFee = new _Hbar.default(25);
/**
* @private
* @type {?Key}
*/
this._adminKey = null;
/**
* @private
* @type {?Key}
*/
this._submitKey = null;
/**
* @private
* @type {?Key}
*/
this._feeScheduleKey = null;
/**
* @private
* @type {Key[]}
*/
this._feeExemptKeys = [];
/**
* @private
* @type {?AccountId}
*/
this._autoRenewAccountId = null;
/**
* @private
* @type {Duration}
*/
this._autoRenewPeriod = new _Duration.default(_Transaction.DEFAULT_AUTO_RENEW_PERIOD);
/**
* @private
* @type {CustomFixedFee[]}
*/
this._customFees = [];
/**
* @private
* @type {?string}
*/
this._topicMemo = null;
if (props.adminKey != null) {
this.setAdminKey(props.adminKey);
}
if (props.submitKey != null) {
this.setSubmitKey(props.submitKey);
}
if (props.feeScheduleKey != null) {
this.setFeeScheduleKey(props.feeScheduleKey);
}
if (props.feeExemptKeys != null) {
this.setFeeExemptKeys(props.feeExemptKeys);
}
if (props.autoRenewAccountId != null) {
this.setAutoRenewAccountId(props.autoRenewAccountId);
}
if (props.autoRenewPeriod != null) {
this.setAutoRenewPeriod(props.autoRenewPeriod);
}
if (props.customFees != null) {
this.setCustomFees(props.customFees);
}
if (props.topicMemo != null) {
this.setTopicMemo(props.topicMemo);
}
}
/**
* @internal
* @param {HieroProto.proto.ITransaction[]} transactions
* @param {HieroProto.proto.ISignedTransaction[]} signedTransactions
* @param {TransactionId[]} transactionIds
* @param {AccountId[]} nodeIds
* @param {HieroProto.proto.ITransactionBody[]} bodies
* @returns {TopicCreateTransaction}
*/
static _fromProtobuf(transactions, signedTransactions, transactionIds, nodeIds, bodies) {
const body = bodies[0];
const create = /** @type {HieroProto.proto.IConsensusCreateTopicTransactionBody} */
body.consensusCreateTopic;
return _Transaction.default._fromProtobufTransactions(new TopicCreateTransaction({
adminKey: create.adminKey != null ? _Key.default._fromProtobufKey(create.adminKey) : undefined,
submitKey: create.submitKey != null ? _Key.default._fromProtobufKey(create.submitKey) : undefined,
feeScheduleKey: create.feeScheduleKey != null ? _Key.default._fromProtobufKey(create.feeScheduleKey) : undefined,
feeExemptKeys: create.feeExemptKeyList != null ? create.feeExemptKeyList.map(key => _Key.default._fromProtobufKey(key)) : undefined,
autoRenewAccountId: create.autoRenewAccount != null ? _AccountId.default._fromProtobuf(create.autoRenewAccount) : undefined,
autoRenewPeriod: create.autoRenewPeriod != null ? create.autoRenewPeriod.seconds != null ? create.autoRenewPeriod.seconds : undefined : undefined,
customFees: create.customFees != null ? create.customFees.map(customFee => _CustomFixedFee.default._fromProtobuf(customFee)) : undefined,
topicMemo: create.memo != null ? create.memo : undefined
}), transactions, signedTransactions, transactionIds, nodeIds, bodies);
}
/**
* @deprecated - Use `getTopicMemo()` instead
* @returns {?string}
*/
get topicMemo() {
return this._topicMemo;
}
/**
* @returns {?string}
*/
getTopicMemo() {
return this._topicMemo;
}
/**
* @param {string} topicMemo
* @returns {this}
*/
setTopicMemo(topicMemo) {
this._requireNotFrozen();
this._topicMemo = topicMemo;
return this;
}
/**
* @deprecated - Use `getAdminKey()` instead
* @returns {?Key}
*/
get adminKey() {
return this._adminKey;
}
/**
* @returns {?Key}
*/
getAdminKey() {
return this._adminKey;
}
/**
* @param {Key} adminKey
* @returns {this}
*/
setAdminKey(adminKey) {
this._requireNotFrozen();
this._adminKey = adminKey;
return this;
}
/**
* @deprecated - Use `getSubmitKey()` instead
* @returns {?Key}
*/
get submitKey() {
return this._submitKey;
}
/**
* @returns {?Key}
*/
getSubmitKey() {
return this._submitKey;
}
/**
* @param {Key} submitKey
* @returns {this}
*/
setSubmitKey(submitKey) {
this._requireNotFrozen();
this._submitKey = submitKey;
return this;
}
/**
* Returns the key which allows updates to the new topic’s fees.
* @returns {?Key}
*/
getFeeScheduleKey() {
return this._feeScheduleKey;
}
/**
* Sets the key which allows updates to the new topic’s fees.
* @param {Key} feeScheduleKey
* @returns {this}
*/
setFeeScheduleKey(feeScheduleKey) {
this._requireNotFrozen();
this._feeScheduleKey = feeScheduleKey;
return this;
}
/**
* Returns the keys that will be exempt from paying fees.
* @returns {Key[]}
*/
getFeeExemptKeys() {
return this._feeExemptKeys;
}
/**
* Sets the keys that will be exempt from paying fees.
* @param {Key[]} feeExemptKeys
* @returns {this}
*/
setFeeExemptKeys(feeExemptKeys) {
this._requireNotFrozen();
this._feeExemptKeys = feeExemptKeys;
return this;
}
/**
* Adds a key that will be exempt from paying fees.
* @param {Key} key
* @returns {this}
*/
addFeeExemptKey(key) {
this._requireNotFrozen();
this._feeExemptKeys.push(key);
return this;
}
/**
* Clears all keys that will be exempt from paying fees.
* @returns {this}
*/
clearFeeExemptKeys() {
this._requireNotFrozen();
this._feeExemptKeys = [];
return this;
}
/**
* @deprecated - Use `getAutoRenewAccountId()` instead
* @returns {?AccountId}
*/
get autoRenewAccountId() {
return this._autoRenewAccountId;
}
/**
* @returns {?AccountId}
*/
getAutoRenewAccountId() {
return this._autoRenewAccountId;
}
/**
* @param {AccountId | string} autoRenewAccountId
* @returns {this}
*/
setAutoRenewAccountId(autoRenewAccountId) {
this._requireNotFrozen();
this._autoRenewAccountId = autoRenewAccountId instanceof _AccountId.default ? autoRenewAccountId : _AccountId.default.fromString(autoRenewAccountId);
return this;
}
/**
* @deprecated - Use `getAutoRenewPeriod()` instead
* @returns {Duration}
*/
get autoRenewPeriod() {
return this._autoRenewPeriod;
}
/**
* @returns {Duration}
*/
getAutoRenewPeriod() {
return this._autoRenewPeriod;
}
/**
* Set the auto renew period for this account.
*
* @param {Duration | Long | number} autoRenewPeriod
* @returns {this}
*/
setAutoRenewPeriod(autoRenewPeriod) {
this._requireNotFrozen();
this._autoRenewPeriod = autoRenewPeriod instanceof _Duration.default ? autoRenewPeriod : new _Duration.default(autoRenewPeriod);
return this;
}
/**
* Returns the fixed fees to assess when a message is submitted to the new topic.
* @returns {CustomFixedFee[]}
*/
getCustomFees() {
return this._customFees;
}
/**
* Sets the fixed fees to assess when a message is submitted to the new topic.
*
* @param {CustomFixedFee[]} customFees
* @returns {this}
*/
setCustomFees(customFees) {
this._requireNotFrozen();
this._customFees = customFees;
return this;
}
/**
* Adds fixed fee to assess when a message is submitted to the new topic.
*
* @param {CustomFixedFee} customFee
* @returns {this}
*/
addCustomFee(customFee) {
this._requireNotFrozen();
this._customFees.push(customFee);
return this;
}
/**
* Clears fixed fees.
*
* @returns {this}
*/
clearCustomFees() {
this._requireNotFrozen();
this._customFees = [];
return this;
}
/**
* @param {Client} client
*/
_validateChecksums(client) {
if (this._autoRenewAccountId != null) {
this._autoRenewAccountId.validateChecksum(client);
}
}
/*
* Temporarily disabled due to issues with consensus node version 0.60.
* This will be reintroduced once all networks (previewnet, testnet, mainnet)
* are on version 0.60.
*
* @override
* @param {?import("../client/Client.js").default<Channel, *>} client
* @returns {this}
*/
/*
freezeWith(client) {
if (!this._autoRenewAccountId && this.transactionId?.accountId) {
this.setAutoRenewAccountId(this.transactionId?.accountId);
} else if (!this._autoRenewAccountId && client?.operatorAccountId) {
this.setAutoRenewAccountId(client.operatorAccountId);
}
return super.freezeWith(client);
}
*/
/**
* @override
* @param {?import("../client/Client.js").default<Channel, *>} client
* @returns {this}
*/
freezeWith(client) {
if (!this._autoRenewAccountId && this.transactionId?.accountId) {
this.setAutoRenewAccountId(this.transactionId?.accountId);
} else if (!this._autoRenewAccountId && client?.operatorAccountId) {
this.setAutoRenewAccountId(client.operatorAccountId);
}
return super.freezeWith(client);
}
/**
* @override
* @internal
* @param {Channel} channel
* @param {HieroProto.proto.ITransaction} request
* @returns {Promise<HieroProto.proto.ITransactionResponse>}
*/
_execute(channel, request) {
return channel.consensus.createTopic(request);
}
/**
* @override
* @protected
* @returns {NonNullable<HieroProto.proto.TransactionBody["data"]>}
*/
_getTransactionDataCase() {
return "consensusCreateTopic";
}
/**
* @override
* @protected
* @returns {HieroProto.proto.IConsensusCreateTopicTransactionBody}
*/
_makeTransactionData() {
return {
adminKey: this._adminKey != null ? this._adminKey._toProtobufKey() : null,
submitKey: this._submitKey != null ? this._submitKey._toProtobufKey() : null,
feeScheduleKey: this._feeScheduleKey != null ? this._feeScheduleKey._toProtobufKey() : null,
feeExemptKeyList: this._feeExemptKeys.map(key => key._toProtobufKey()),
autoRenewAccount: this._autoRenewAccountId != null ? this._autoRenewAccountId._toProtobuf() : null,
autoRenewPeriod: this._autoRenewPeriod._toProtobuf(),
customFees: this._customFees.map(customFee => customFee._toTopicFeeProtobuf()),
memo: this._topicMemo
};
}
/**
* @returns {string}
*/
_getLogId() {
const timestamp = /** @type {import("../Timestamp.js").default} */
this._transactionIds.current.validStart;
return `TopicCreateTransaction:${timestamp.toString()}`;
}
}
exports.default = TopicCreateTransaction;
_Transaction.TRANSACTION_REGISTRY.set("consensusCreateTopic",
// eslint-disable-next-line @typescript-eslint/unbound-method
TopicCreateTransaction._fromProtobuf);