@hashgraph/sdk
Version:
255 lines (235 loc) • 8.23 kB
JavaScript
// SPDX-License-Identifier: Apache-2.0
import TopicId from "./TopicId.js";
import AccountId from "../account/AccountId.js";
import Timestamp from "../Timestamp.js";
import Long from "long";
import Duration from "../Duration.js";
import * as HieroProto from "@hashgraph/proto";
import Key from "../Key.js";
import LedgerId from "../LedgerId.js";
import CustomFixedFee from "../token/CustomFixedFee.js";
/**
* Current state of a topic.
*/
export default class TopicInfo {
/**
* @private
* @param {object} props
* @param {TopicId} props.topicId
* @param {string} props.topicMemo
* @param {Uint8Array} props.runningHash
* @param {Long} props.sequenceNumber
* @param {?Timestamp} props.expirationTime
* @param {?Key} props.adminKey
* @param {?Key} props.submitKey
* @param {?Key} props.feeScheduleKey
* @param {?Key[]} props.feeExemptKeys
* @param {?Duration} props.autoRenewPeriod
* @param {?AccountId} props.autoRenewAccountId
* @param {?CustomFixedFee[]} props.customFees
* @param {LedgerId|null} props.ledgerId
*/
constructor(props) {
/**
* The ID of the topic for which information is requested.
*
* @readonly
*/
this.topicId = props.topicId;
/**
* Short publicly visible memo about the topic. No guarantee of uniqueness.
*
* @readonly
*/
this.topicMemo = props.topicMemo;
/**
* SHA-384 running hash of (previousRunningHash, topicId, consensusTimestamp, sequenceNumber, message).
*
* @readonly
*/
this.runningHash = props.runningHash;
/**
* Sequence number (starting at 1 for the first submitMessage) of messages on the topic.
*
* @readonly
*/
this.sequenceNumber = props.sequenceNumber;
/**
* Effective consensus timestamp at (and after) which submitMessage calls will no longer succeed on the topic.
*
* @readonly
*/
this.expirationTime = props.expirationTime;
/**
* Access control for update/delete of the topic. Null if there is no key.
*
* @readonly
*/
this.adminKey = props.adminKey;
/**
* Access control for ConsensusService.submitMessage. Null if there is no key.
*
* @readonly
*/
this.submitKey = props.submitKey;
/**
* Access control for updating topic fees. Null If there is no key.
*
* @readonly
*/
this.feeScheduleKey = props.feeScheduleKey;
/**
* The keys that will are exempt from paying fees.
* @readonly
*/
this.feeExemptKeys = props.feeExemptKeys;
/**
* @readonly
*/
this.autoRenewPeriod = props.autoRenewPeriod;
/**
* @readonly
*/
this.autoRenewAccountId = props.autoRenewAccountId;
/**
* The fixed fees assessed when a message is submitted to the topic.
* @readonly
*/
this.customFees = props.customFees;
this.ledgerId = props.ledgerId;
Object.freeze(this);
}
/**
* @internal
* @param {HieroProto.proto.IConsensusGetTopicInfoResponse} infoResponse
* @returns {TopicInfo}
*/
static _fromProtobuf(infoResponse) {
const info = /** @type {HieroProto.proto.IConsensusTopicInfo} */ (
infoResponse.topicInfo
);
return new TopicInfo({
topicId: TopicId._fromProtobuf(
/** @type {HieroProto.proto.ITopicID} */ (infoResponse.topicID),
),
topicMemo: info.memo != null ? info.memo : "",
runningHash:
info.runningHash != null ? info.runningHash : new Uint8Array(),
sequenceNumber:
info.sequenceNumber != null
? info.sequenceNumber instanceof Long
? info.sequenceNumber
: Long.fromValue(info.sequenceNumber)
: Long.ZERO,
expirationTime:
info.expirationTime != null
? Timestamp._fromProtobuf(info.expirationTime)
: null,
adminKey:
info.adminKey != null
? Key._fromProtobufKey(info.adminKey)
: null,
submitKey:
info.submitKey != null
? Key._fromProtobufKey(info.submitKey)
: null,
feeScheduleKey:
info.feeScheduleKey != null
? Key._fromProtobufKey(info.feeScheduleKey)
: null,
feeExemptKeys:
info.feeExemptKeyList != null
? info.feeExemptKeyList.map((key) =>
Key._fromProtobufKey(key),
)
: null,
autoRenewPeriod:
info.autoRenewPeriod != null
? new Duration(
/** @type {Long} */ (info.autoRenewPeriod.seconds),
)
: null,
autoRenewAccountId:
info.autoRenewAccount != null
? AccountId._fromProtobuf(info.autoRenewAccount)
: null,
customFees:
info.customFees != null
? info.customFees.map((customFee) =>
CustomFixedFee._fromProtobuf(customFee),
)
: null,
ledgerId:
info.ledgerId != null
? LedgerId.fromBytes(info.ledgerId)
: null,
});
}
/**
* @internal
* @returns {HieroProto.proto.IConsensusGetTopicInfoResponse}
*/
_toProtobuf() {
return {
topicID: this.topicId._toProtobuf(),
topicInfo: {
memo: this.topicMemo,
runningHash: this.runningHash,
sequenceNumber: this.sequenceNumber,
expirationTime:
this.expirationTime != null
? this.expirationTime._toProtobuf()
: null,
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 != null
? this.feeExemptKeys.map((key) => key._toProtobufKey())
: null,
autoRenewPeriod:
this.autoRenewPeriod != null
? this.autoRenewPeriod._toProtobuf()
: null,
autoRenewAccount:
this.autoRenewAccountId != null
? this.autoRenewAccountId._toProtobuf()
: null,
customFees:
this.customFees != null
? this.customFees.map((customFee) =>
customFee._toProtobuf(),
)
: null,
},
};
}
/**
* @param {Uint8Array} bytes
* @returns {TopicInfo}
*/
static fromBytes(bytes) {
return TopicInfo._fromProtobuf(
HieroProto.proto.ConsensusGetTopicInfoResponse.decode(bytes),
);
}
/**
* @returns {Uint8Array}
*/
toBytes() {
return HieroProto.proto.ConsensusGetTopicInfoResponse.encode(
/** @type {HieroProto.proto.ConsensusGetTopicInfoResponse} */ (
this._toProtobuf()
),
).finish();
}
}