@hiero-ledger/sdk 2.70.0

package/src/topic/TopicId.js

@@ -0,0 +1,204 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import * as EntityIdHelper from "../EntityIdHelper.js";
+import * as HieroProto from "@hashgraph/proto";
+import EvmAddress from "../EvmAddress.js";
+import * as util from "../util.js";
+
+/**
+ * @typedef {import("long")} Long
+ * @typedef {import("../client/Client.js").default<*, *>} Client
+ */
+
+/**
+ * Unique identifier for a topic (used by the consensus service).
+ */
+export default class TopicId {
+    /**
+     * @param {number | Long | import("../EntityIdHelper").IEntityId} props
+     * @param {(number | Long)=} realm
+     * @param {(number | Long)=} num
+     */
+    constructor(props, realm, num) {
+        const result = EntityIdHelper.constructor(props, realm, num);
+
+        this.shard = result.shard;
+        this.realm = result.realm;
+        this.num = result.num;
+
+        /**
+         * @type {string | null}
+         */
+        this._checksum = null;
+    }
+
+    /**
+     * @param {string} text
+     * @returns {TopicId}
+     */
+    static fromString(text) {
+        const result = EntityIdHelper.fromString(text);
+        const id = new TopicId(result);
+        id._checksum = result.checksum;
+        return id;
+    }
+
+    /**
+     * @internal
+     * @param {HieroProto.proto.ITopicID} id
+     * @returns {TopicId}
+     */
+    static _fromProtobuf(id) {
+        const topicId = new TopicId(
+            id.shardNum != null ? id.shardNum : 0,
+            id.realmNum != null ? id.realmNum : 0,
+            id.topicNum != null ? id.topicNum : 0,
+        );
+
+        return topicId;
+    }
+
+    /**
+     * @returns {string | null}
+     */
+    get checksum() {
+        return this._checksum;
+    }
+
+    /**
+     * @deprecated - Use `validateChecksum` instead
+     * @param {Client} client
+     */
+    validate(client) {
+        console.warn("Deprecated: Use `validateChecksum` instead");
+        this.validateChecksum(client);
+    }
+
+    /**
+     * @param {Client} client
+     */
+    validateChecksum(client) {
+        EntityIdHelper.validateChecksum(
+            this.shard,
+            this.realm,
+            this.num,
+            this._checksum,
+            client,
+        );
+    }
+
+    /**
+     * @param {Uint8Array} bytes
+     * @returns {TopicId}
+     */
+    static fromBytes(bytes) {
+        return TopicId._fromProtobuf(HieroProto.proto.TopicID.decode(bytes));
+    }
+
+    /**
+     * @param {string} address
+     * @deprecated - Use `fromEvmAddress` instead
+     * @returns {TopicId}
+     */
+    static fromSolidityAddress(address) {
+        const [shard, realm, topic] =
+            EntityIdHelper.fromSolidityAddress(address);
+        return new TopicId(shard, realm, topic);
+    }
+
+    /**
+     * @param {number} shard
+     * @param {number} realm
+     * @param {string} address
+     * @returns {TopicId}
+     */
+    static fromEvmAddress(shard, realm, address) {
+        const addressBytes = EvmAddress.fromString(address).toBytes();
+        const isLongZero = util.isLongZeroAddress(addressBytes);
+
+        if (!isLongZero) {
+            throw new Error(
+                "TopicId.fromEvmAddress does not support non-long-zero addresses",
+            );
+        }
+
+        const [shardLong, realmLong, topicLong] = EntityIdHelper.fromEvmAddress(
+            shard,
+            realm,
+            address,
+        );
+        return new TopicId(shardLong, realmLong, topicLong);
+    }
+
+    /**
+     * @deprecated - Use `toEvmAddress` instead
+     * @returns {string}
+     */
+    toSolidityAddress() {
+        return EntityIdHelper.toSolidityAddress([
+            this.shard,
+            this.realm,
+            this.num,
+        ]);
+    }
+
+    /**
+     * @returns {string} EVM-compatible address representation of the entity
+     */
+    toEvmAddress() {
+        return EntityIdHelper.toEvmAddress(this.num);
+    }
+
+    /**
+     * @returns {HieroProto.proto.ITopicID}
+     */
+    _toProtobuf() {
+        return {
+            topicNum: this.num,
+            shardNum: this.shard,
+            realmNum: this.realm,
+        };
+    }
+
+    /**
+     * @returns {string}
+     */
+    toString() {
+        return `${this.shard.toString()}.${this.realm.toString()}.${this.num.toString()}`;
+    }
+
+    /**
+     * @param {Client} client
+     * @returns {string}
+     */
+    toStringWithChecksum(client) {
+        return EntityIdHelper.toStringWithChecksum(this.toString(), client);
+    }
+
+    /**
+     * @returns {Uint8Array}
+     */
+    toBytes() {
+        return HieroProto.proto.TopicID.encode(this._toProtobuf()).finish();
+    }
+
+    /**
+     * @returns {TopicId}
+     */
+    clone() {
+        const id = new TopicId(this);
+        id._checksum = this._checksum;
+        return id;
+    }
+
+    /**
+     * @param {TopicId} other
+     * @returns {number}
+     */
+    compare(other) {
+        return EntityIdHelper.compare(
+            [this.shard, this.realm, this.num],
+            [other.shard, other.realm, other.num],
+        );
+    }
+}

package/src/topic/TopicInfo.js

@@ -0,0 +1,254 @@
+// 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();
+    }
+}

package/src/topic/TopicInfoQuery.js

@@ -0,0 +1,190 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import Query, { QUERY_REGISTRY } from "../query/Query.js";
+import TopicId from "./TopicId.js";
+import TopicInfo from "./TopicInfo.js";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import Hbar from "../Hbar.js";
+
+/**
+ * @namespace proto
+ * @typedef {import("@hashgraph/proto").proto.IQuery} HieroProto.proto.IQuery
+ * @typedef {import("@hashgraph/proto").proto.IQueryHeader} HieroProto.proto.IQueryHeader
+ * @typedef {import("@hashgraph/proto").proto.IResponse} HieroProto.proto.IResponse
+ * @typedef {import("@hashgraph/proto").proto.IResponseHeader} HieroProto.proto.IResponseHeader
+ * @typedef {import("@hashgraph/proto").proto.IConsensusGetTopicInfoResponse} HieroProto.proto.IConsensusGetTopicInfoResponse
+ * @typedef {import("@hashgraph/proto").proto.IConsensusGetTopicInfoQuery} HieroProto.proto.IConsensusGetTopicInfoQuery
+ */
+
+/**
+ * @namespace com
+ * @typedef {import("@hashgraph/proto").com.hedera.mirror.api.proto.IConsensusTopicResponse} com.hedera.mirror.api.proto.IConsensusTopicResponse
+ */
+
+/**
+ * @typedef {import("../channel/Channel.js").default} Channel
+ * @typedef {import("../client/Client.js").default<*, *>} Client
+ * @typedef {import("../account/AccountId.js").default} AccountId
+ */
+
+/**
+ * Retrieve the latest state of a topic.
+ *
+ * @augments {Query<TopicInfo>}
+ */
+export default class TopicInfoQuery extends Query {
+    /**
+     * @param {object} [props]
+     * @param {TopicId | string} [props.topicId]
+     */
+    constructor(props = {}) {
+        super();
+
+        /**
+         * @private
+         * @type {?TopicId}
+         */
+        this._topicId = null;
+
+        if (props.topicId != null) {
+            this.setTopicId(props.topicId);
+        }
+    }
+
+    /**
+     * @internal
+     * @param {HieroProto.proto.IQuery} query
+     * @returns {TopicInfoQuery}
+     */
+    static _fromProtobuf(query) {
+        const info =
+            /** @type {HieroProto.proto.IConsensusGetTopicInfoQuery} */ (
+                query.consensusGetTopicInfo
+            );
+
+        return new TopicInfoQuery({
+            topicId:
+                info.topicID != null
+                    ? TopicId._fromProtobuf(info.topicID)
+                    : undefined,
+        });
+    }
+
+    /**
+     * @returns {?TopicId}
+     */
+    get topicId() {
+        return this._topicId;
+    }
+
+    /**
+     * Set the topic ID for which the info is being requested.
+     *
+     * @param {TopicId | string} topicId
+     * @returns {TopicInfoQuery}
+     */
+    setTopicId(topicId) {
+        this._topicId =
+            typeof topicId === "string"
+                ? TopicId.fromString(topicId)
+                : topicId.clone();
+
+        return this;
+    }
+
+    /**
+     * @override
+     * @param {import("../client/Client.js").default<Channel, *>} client
+     * @returns {Promise<Hbar>}
+     */
+    async getCost(client) {
+        return super.getCost(client);
+    }
+
+    /**
+     * @param {Client} client
+     */
+    _validateChecksums(client) {
+        if (this._topicId != null) {
+            this._topicId.validateChecksum(client);
+        }
+    }
+
+    /**
+     * @override
+     * @internal
+     * @param {Channel} channel
+     * @param {HieroProto.proto.IQuery} request
+     * @returns {Promise<HieroProto.proto.IResponse>}
+     */
+    _execute(channel, request) {
+        return channel.consensus.getTopicInfo(request);
+    }
+
+    /**
+     * @override
+     * @internal
+     * @param {HieroProto.proto.IResponse} response
+     * @returns {HieroProto.proto.IResponseHeader}
+     */
+    _mapResponseHeader(response) {
+        const consensusGetTopicInfo =
+            /** @type {HieroProto.proto.IConsensusGetTopicInfoResponse} */ (
+                response.consensusGetTopicInfo
+            );
+        return /** @type {HieroProto.proto.IResponseHeader} */ (
+            consensusGetTopicInfo.header
+        );
+    }
+
+    /**
+     * @protected
+     * @override
+     * @param {HieroProto.proto.IResponse} response
+     * @param {AccountId} nodeAccountId
+     * @param {HieroProto.proto.IQuery} request
+     * @returns {Promise<TopicInfo>}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _mapResponse(response, nodeAccountId, request) {
+        return Promise.resolve(
+            TopicInfo._fromProtobuf(
+                /** @type {HieroProto.proto.IConsensusGetTopicInfoResponse} */ (
+                    response.consensusGetTopicInfo
+                ),
+            ),
+        );
+    }
+
+    /**
+     * @override
+     * @internal
+     * @param {HieroProto.proto.IQueryHeader} header
+     * @returns {HieroProto.proto.IQuery}
+     */
+    _onMakeRequest(header) {
+        return {
+            consensusGetTopicInfo: {
+                header,
+                topicID:
+                    this._topicId != null ? this._topicId._toProtobuf() : null,
+            },
+        };
+    }
+
+    /**
+     * @returns {string}
+     */
+    _getLogId() {
+        const timestamp =
+            this._paymentTransactionId != null &&
+            this._paymentTransactionId.validStart != null
+                ? this._paymentTransactionId.validStart
+                : this._timestamp;
+
+        return `TopicInfoQuery:${timestamp.toString()}`;
+    }
+}
+
+// eslint-disable-next-line @typescript-eslint/unbound-method
+QUERY_REGISTRY.set("consensusGetTopicInfo", TopicInfoQuery._fromProtobuf);