feat(TCK): implement TokenInfoQuery endpoint (#3593)

Signed-off-by: Mario Dimitrov <mario.dimitrov@limechain.tech>

Author: mariodimitrovv

tck/methods/token.ts

@@ -23,6 +23,8 @@ import {
     PendingAirdropId,
     TokenRejectTransaction,
     TokenCancelAirdropTransaction,
+    TokenInfoQuery,
+    Hbar,
 } from "@hiero-ledger/sdk";
 import Long from "long";
 
@@ -35,6 +37,7 @@ import {
     configureTokenManagementTransaction,
     createCustomFees,
     executeTokenManagementTransaction,
+    mapTokenInfoResponse,
 } from "../utils/helpers/token";
 
 import { applyCommonTransactionParams } from "../params/common-tx-params";
@@ -54,12 +57,14 @@ import {
     AirdropCancelTokenParams,
     AirdropClaimTokenParams,
     RejectTokenParams,
+    GetTokenInfoParams,
 } from "../params/token";
 
 import {
     TokenResponse,
     TokenBurnResponse,
     TokenMintResponse,
+    TokenInfoQueryResponse,
 } from "../response/token";
 
 // buildCreateToken builds a TokenCreateTransaction from parameters
@@ -860,3 +865,38 @@ export const cancelAirdrop = async ({
         status: receipt.status.toString(),
     };
 };
+
+export const getTokenInfo = async ({
+    tokenId,
+    queryPayment,
+    maxQueryPayment,
+    getCost,
+    sessionId,
+}: GetTokenInfoParams): Promise<TokenInfoQueryResponse> => {
+    const client = sdk.getClient(sessionId);
+    const query = new TokenInfoQuery().setGrpcDeadline(DEFAULT_GRPC_DEADLINE);
+
+    if (tokenId != null) {
+        query.setTokenId(tokenId);
+    }
+
+    if (queryPayment != null) {
+        query.setQueryPayment(Hbar.fromTinybars(queryPayment));
+    }
+
+    if (maxQueryPayment != null) {
+        query.setMaxQueryPayment(Hbar.fromTinybars(maxQueryPayment));
+    }
+
+    if (getCost) {
+        const cost = await query.getCost(client);
+
+        return {
+            cost: cost.toTinybars().toString(),
+        };
+    }
+
+    const response = await query.execute(client);
+
+    return mapTokenInfoResponse(response);
+};

tck/params/token.ts

@@ -1,4 +1,4 @@
-import { BaseTransactionParams } from "./base";
+import { BaseParams, BaseTransactionParams } from "./base";
 
 import {
     CustomFixedFee,
@@ -137,3 +137,10 @@ export interface RejectTokenParams extends BaseTransactionParams {
     readonly nftIds?: string[];
     readonly serialNumbers?: string[];
 }
+
+export interface GetTokenInfoParams extends BaseParams {
+    readonly tokenId?: string;
+    readonly queryPayment?: string;
+    readonly maxQueryPayment?: string;
+    readonly getCost?: boolean;
+}

tck/response/token.ts

@@ -15,3 +15,35 @@ export interface TokenBurnResponse {
     readonly newTotalSupply?: string;
     readonly status: string;
 }
+
+export interface TokenInfoQueryResponse {
+    readonly tokenId?: string;
+    readonly name?: string;
+    readonly symbol?: string;
+    readonly decimals?: number;
+    readonly totalSupply?: string;
+    readonly treasuryAccountId?: string;
+    readonly adminKey?: string;
+    readonly kycKey?: string;
+    readonly freezeKey?: string;
+    readonly pauseKey?: string;
+    readonly wipeKey?: string;
+    readonly supplyKey?: string;
+    readonly feeScheduleKey?: string;
+    readonly metadataKey?: string;
+    readonly defaultFreezeStatus?: boolean | null;
+    readonly defaultKycStatus?: boolean | null;
+    readonly pauseStatus?: string;
+    readonly isDeleted?: boolean;
+    readonly autoRenewAccountId?: string;
+    readonly autoRenewPeriod?: string;
+    readonly expirationTime?: string;
+    readonly tokenMemo?: string;
+    readonly customFees?: any[];
+    readonly tokenType?: string;
+    readonly supplyType?: string;
+    readonly maxSupply?: string;
+    readonly metadata?: string;
+    readonly ledgerId?: string;
+    readonly cost?: string;
+}

tck/utils/helpers/token.ts

@@ -7,12 +7,14 @@ import {
     CustomRoyaltyFee,
     FeeAssessmentMethod,
     Transaction,
+    TokenInfo,
 } from "@hiero-ledger/sdk";
 import Long from "long";
 
 import { DEFAULT_GRPC_DEADLINE } from "../../utils/constants/config";
 
 import { applyCommonTransactionParams } from "../../params/common-tx-params";
+import { TokenInfoQueryResponse } from "../../response/token";
 
 export const executeTokenManagementTransaction = async (
     transaction: Transaction,
@@ -144,3 +146,103 @@ export const createCustomFees = (customFees: Array<Record<string, any>>) => {
 
     return customFeeList;
 };
+
+// Helper function to map TokenInfo to TokenInfoQueryResponse
+export const mapTokenInfoResponse = (
+    info: TokenInfo,
+): TokenInfoQueryResponse => {
+    // Helper function to convert pause status
+    const getPauseStatusString = (pauseStatus: boolean | null): string => {
+        if (pauseStatus === null) {
+            return "NOT_APPLICABLE";
+        }
+        return pauseStatus ? "PAUSED" : "UNPAUSED";
+    };
+
+    // Helper function to serialize custom fees
+    const serializeCustomFees = (customFees: CustomFee[]): any[] => {
+        return customFees.map((fee) => {
+            if (fee instanceof CustomFixedFee) {
+                return {
+                    feeCollectorAccountId:
+                        fee.feeCollectorAccountId?.toString(),
+                    allCollectorsAreExempt: fee.allCollectorsAreExempt,
+                    fixedFee: {
+                        amount: fee.amount?.toString(),
+                        denominatingTokenId:
+                            fee.denominatingTokenId?.toString() || null,
+                    },
+                };
+            } else if (fee instanceof CustomFractionalFee) {
+                return {
+                    feeCollectorAccountId:
+                        fee.feeCollectorAccountId?.toString(),
+                    allCollectorsAreExempt: fee.allCollectorsAreExempt,
+                    fractionalFee: {
+                        numerator: fee.numerator.toString(),
+                        denominator: fee.denominator.toString(),
+                        minimumAmount: fee.min?.toString() || "0",
+                        maximumAmount: fee.max?.toString() || "0",
+                        assessmentMethod:
+                            fee.assessmentMethod?.toString().toLowerCase() ||
+                            "inclusive",
+                    },
+                };
+            } else if (fee instanceof CustomRoyaltyFee) {
+                const result: any = {
+                    feeCollectorAccountId:
+                        fee.feeCollectorAccountId?.toString(),
+                    allCollectorsAreExempt: fee.allCollectorsAreExempt,
+                    royaltyFee: {
+                        numerator: fee.numerator.toString(),
+                        denominator: fee.denominator.toString(),
+                        fallbackFee: fee.fallbackFee
+                            ? {
+                                  amount: fee.fallbackFee.amount?.toString(),
+                                  denominatingTokenId:
+                                      fee.fallbackFee.denominatingTokenId?.toString() ||
+                                      null,
+                              }
+                            : null,
+                    },
+                };
+                return result;
+            }
+            return fee;
+        });
+    };
+
+    return {
+        tokenId: info.tokenId?.toString(),
+        name: info.name,
+        symbol: info.symbol,
+        decimals: info.decimals,
+        totalSupply: info.totalSupply?.toString(),
+        treasuryAccountId: info.treasuryAccountId?.toString(),
+        adminKey: info.adminKey?.toString(),
+        kycKey: info.kycKey?.toString(),
+        freezeKey: info.freezeKey?.toString(),
+        pauseKey: info.pauseKey?.toString(),
+        wipeKey: info.wipeKey?.toString(),
+        supplyKey: info.supplyKey?.toString(),
+        feeScheduleKey: info.feeScheduleKey?.toString(),
+        metadataKey: info.metadataKey?.toString(),
+        defaultFreezeStatus: info.defaultFreezeStatus,
+        defaultKycStatus: info.defaultKycStatus,
+        pauseStatus: getPauseStatusString(info.pauseStatus),
+        isDeleted: info.isDeleted,
+        autoRenewAccountId: info.autoRenewAccountId?.toString(),
+        autoRenewPeriod: info.autoRenewPeriod?.seconds.toString(),
+        expirationTime: info.expirationTime?.seconds.toString(),
+        tokenMemo: info.tokenMemo,
+        customFees: serializeCustomFees(info.customFees),
+        tokenType: info.tokenType?.toString(),
+        supplyType: info.supplyType?.toString(),
+        maxSupply: info.maxSupply?.toString(),
+        metadata:
+            info.metadata && info.metadata.length > 0
+                ? Buffer.from(info.metadata).toString("hex")
+                : "",
+        ledgerId: info.ledgerId?.toString(),
+    };
+};