Merge pull request #143 from manishdait/issue-98

feat: Implemented TokenRepository to interact with MirrorNodeClient API
OpenElements · Jan 16, 2025 · 625f3be · 625f3be
2 parents 1eaf6e3 + 01c1e86
commit 625f3be
Show file tree

Hide file tree

Showing 23 changed files with 1,464 additions and 5 deletions.
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/Balance.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/Balance.java
@@ -0,0 +1,12 @@
+package com.openelements.hiero.base.data;
+
+import com.hedera.hashgraph.sdk.AccountId;
+import org.jspecify.annotations.NonNull;
+
+import java.util.Objects;
+
+public record Balance(@NonNull AccountId accountId, long balance, long decimals) {
+    public Balance {
+        Objects.requireNonNull(accountId, "accountId must not be null");
+    }
+}
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/CustomFee.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/CustomFee.java
@@ -0,0 +1,18 @@
+package com.openelements.hiero.base.data;
+
+import org.jspecify.annotations.NonNull;
+
+import java.util.List;
+import java.util.Objects;
+
+public record CustomFee(
+        @NonNull List<FixedFee> fixedFees,
+        @NonNull List<FractionalFee> fractionalFees,
+        @NonNull List<RoyaltyFee> royaltyFees
+) {
+    public CustomFee {
+        Objects.requireNonNull(fixedFees, "fixedFees must not be null");
+        Objects.requireNonNull(fractionalFees, "fractionalFees must not be null");
+        Objects.requireNonNull(royaltyFees, "royaltyFees must not be null");
+    }
+}
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/FixedFee.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/FixedFee.java
@@ -0,0 +1,9 @@
+package com.openelements.hiero.base.data;
+
+import com.hedera.hashgraph.sdk.AccountId;
+import com.hedera.hashgraph.sdk.TokenId;
+import org.jspecify.annotations.Nullable;
+
+public record FixedFee(long amount, @Nullable AccountId collectorAccountId, @Nullable TokenId denominatingTokenId) {
+    public FixedFee {}
+}
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/FractionalFee.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/FractionalFee.java
@@ -0,0 +1,21 @@
+package com.openelements.hiero.base.data;
+
+import com.hedera.hashgraph.sdk.AccountId;
+import com.hedera.hashgraph.sdk.TokenId;
+import org.jspecify.annotations.Nullable;
+
+public record FractionalFee(
+        long numeratorAmount,
+        long denominatorAmount,
+        @Nullable AccountId collectorAccountId,
+        @Nullable TokenId denominatingTokenId
+) {
+    public FractionalFee {
+        if (numeratorAmount < 0) {
+            throw new IllegalArgumentException("numeratorAmount must be greater than or equal to 0");
+        }
+        if (denominatorAmount < 0) {
+            throw new IllegalArgumentException("denominatorAmount must be greater than or equal to 0");
+        }
+    }
+}
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/RoyaltyFee.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/RoyaltyFee.java
@@ -0,0 +1,22 @@
+package com.openelements.hiero.base.data;
+
+import com.hedera.hashgraph.sdk.AccountId;
+import com.hedera.hashgraph.sdk.TokenId;
+import org.jspecify.annotations.Nullable;
+
+public record RoyaltyFee(
+        long numeratorAmount,
+        long denominatorAmount,
+        long fallbackFeeAmount,
+        @Nullable AccountId collectorAccountId,
+        @Nullable TokenId denominatingTokenId
+) {
+    public RoyaltyFee {
+        if (numeratorAmount < 0) {
+            throw new IllegalArgumentException("numeratorAmount must be greater than or equal to 0");
+        }
+        if (denominatorAmount < 0) {
+            throw new IllegalArgumentException("denominatorAmount must be greater than or equal to 0");
+        }
+    }
+}
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/Token.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/Token.java
@@ -0,0 +1,24 @@
+package com.openelements.hiero.base.data;
+
+import com.hedera.hashgraph.sdk.TokenId;
+import com.hedera.hashgraph.sdk.TokenType;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
+import java.util.Objects;
+
+public record Token(
+        long decimals,
+        byte[] metadata,
+        @NonNull String name,
+        @NonNull String symbol,
+        @Nullable TokenId tokenId,
+        @NonNull TokenType type
+) {
+    public Token {
+        Objects.requireNonNull(type, "type must not be null");
+        Objects.requireNonNull(name, "name must not be null");
+        Objects.requireNonNull(symbol, "symbol must not be null");
+        Objects.requireNonNull(metadata, "metadata must not be null");
+    }
+}
diff --git a/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/TokenInfo.java b/hiero-enterprise-base/src/main/java/com/openelements/hiero/base/data/TokenInfo.java
@@ -0,0 +1,47 @@
+package com.openelements.hiero.base.data;
+
+import com.hedera.hashgraph.sdk.AccountId;
+import com.hedera.hashgraph.sdk.TokenId;
+import com.hedera.hashgraph.sdk.TokenSupplyType;
+import com.hedera.hashgraph.sdk.TokenType;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
+import java.time.Instant;
+import java.util.Objects;
+
+public record TokenInfo(
+        @NonNull TokenId tokenId,
+        @NonNull TokenType type,
+        @NonNull String name,
+        @NonNull String symbol,
+        @Nullable String memo,
+        long decimals,
+        byte[] metadata,
+        @NonNull Instant createdTimestamp,
+        @NonNull Instant modifiedTimestamp,
+        @Nullable Instant expiryTimestamp,
+        @NonNull TokenSupplyType supplyType,
+        @NonNull String initialSupply,
+        @NonNull String totalSupply,
+        @NonNull String maxSupply,
+        @NonNull AccountId treasuryAccountId,
+        boolean deleted,
+        @NonNull CustomFee customFees
+) {
+    public TokenInfo {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        Objects.requireNonNull(type, "type must not be null");
+        Objects.requireNonNull(name, "name must not be null");
+        Objects.requireNonNull(symbol, "symbol must not be null");
+        Objects.requireNonNull(metadata, "metadata must not be null");
+        Objects.requireNonNull(createdTimestamp, "createdTimestamp must not be null");
+        Objects.requireNonNull(modifiedTimestamp, "modifiedTimestamp must not be null");
+        Objects.requireNonNull(supplyType, "supplyType must not be null");
+        Objects.requireNonNull(initialSupply, "initialSupply must not be null");
+        Objects.requireNonNull(totalSupply, "totalSupply must not be null");
+        Objects.requireNonNull(maxSupply, "maxSupply must not be null");
+        Objects.requireNonNull(treasuryAccountId, "treasuryAccountId must not be null");
+        Objects.requireNonNull(customFees, "customFees must not be null");
+    }
+}
diff --git a/...se/src/main/java/com/openelements/hiero/base/implementation/AbstractMirrorNodeClient.java b/...se/src/main/java/com/openelements/hiero/base/implementation/AbstractMirrorNodeClient.java
@@ -10,6 +10,7 @@
 import com.openelements.hiero.base.data.NetworkSupplies;
 import com.openelements.hiero.base.data.Nft;
 import com.openelements.hiero.base.data.NftMetadata;
+import com.openelements.hiero.base.data.TokenInfo;
 import com.openelements.hiero.base.mirrornode.MirrorNodeClient;
 import java.util.List;
 import java.util.Objects;
@@ -68,6 +69,12 @@ final Optional<NetworkSupplies> queryNetworkSupplies() throws HieroException {
         return getJsonConverter().toNetworkSupplies(json);
     }
 
+    @NonNull
+    public final Optional<TokenInfo> queryTokenById(@NonNull TokenId tokenId) throws HieroException {
+        final JSON json = getRestClient().queryTokenById(tokenId);
+        return getJsonConverter().toTokenInfo(json);
+    }
+
     @Override
     public @NonNull Optional<NftMetadata> getNftMetadata(TokenId tokenId) throws HieroException {
         throw new UnsupportedOperationException("Not yet implemented");

diff --git a/...ase/src/main/java/com/openelements/hiero/base/implementation/MirrorNodeJsonConverter.java b/...ase/src/main/java/com/openelements/hiero/base/implementation/MirrorNodeJsonConverter.java
@@ -7,6 +7,10 @@
 import com.openelements.hiero.base.data.NetworkSupplies;
 import com.openelements.hiero.base.data.Nft;
 import com.openelements.hiero.base.data.TransactionInfo;
+import com.openelements.hiero.base.data.Token;
+import com.openelements.hiero.base.data.TokenInfo;
+import com.openelements.hiero.base.data.Balance;
+
 import java.util.List;
 import java.util.Optional;
 import org.jspecify.annotations.NonNull;
@@ -36,4 +40,9 @@ public interface MirrorNodeJsonConverter<JSON> {
 
     List<Nft> toNfts(@NonNull JSON json);
 
+    Optional<TokenInfo> toTokenInfo(JSON json);
+
+    List<Balance> toBalances(JSON node);
+
+    List<Token> toTokens(JSON node);
 }
diff --git a/...e-base/src/main/java/com/openelements/hiero/base/implementation/MirrorNodeRestClient.java b/...e-base/src/main/java/com/openelements/hiero/base/implementation/MirrorNodeRestClient.java
@@ -50,6 +50,11 @@ default JSON queryNetworkSupplies() throws HieroException {
         return doGetCall("/api/v1/network/supply");
     }
 
+    @NonNull
+    default  JSON queryTokenById(TokenId tokenId) throws HieroException {
+        return doGetCall("/api/v1/tokens/" + tokenId);
+    }
+
     @NonNull
     JSON doGetCall(@NonNull String path) throws HieroException;
 }
diff --git a/...se-base/src/main/java/com/openelements/hiero/base/implementation/TokenRepositoryImpl.java b/...se-base/src/main/java/com/openelements/hiero/base/implementation/TokenRepositoryImpl.java
@@ -0,0 +1,43 @@
+package com.openelements.hiero.base.implementation;
+
+import com.hedera.hashgraph.sdk.AccountId;
+import com.hedera.hashgraph.sdk.TokenId;
+import com.openelements.hiero.base.HieroException;
+import com.openelements.hiero.base.data.Balance;
+import com.openelements.hiero.base.data.Page;
+import com.openelements.hiero.base.data.Token;
+import com.openelements.hiero.base.data.TokenInfo;
+import com.openelements.hiero.base.mirrornode.MirrorNodeClient;
+import com.openelements.hiero.base.mirrornode.TokenRepository;
+import org.jspecify.annotations.NonNull;
+
+import java.util.Objects;
+import java.util.Optional;
+
+public class TokenRepositoryImpl implements TokenRepository {
+    private final MirrorNodeClient mirrorNodeClient;
+
+    public TokenRepositoryImpl(@NonNull final MirrorNodeClient mirrorNodeClient) {
+        this.mirrorNodeClient = Objects.requireNonNull(mirrorNodeClient, "mirrorNodeClient must not be null");
+    }
+
+    @Override
+    public Page<Token> findByAccount(@NonNull AccountId accountId) throws HieroException {
+        return mirrorNodeClient.queryTokensForAccount(accountId);
+    }
+
+    @Override
+    public Optional<TokenInfo> findById(@NonNull TokenId tokenId) throws HieroException {
+        return mirrorNodeClient.queryTokenById(tokenId);
+    }
+
+    @Override
+    public Page<Balance> getBalances(@NonNull TokenId tokenId) throws HieroException {
+        return mirrorNodeClient.queryTokenBalances(tokenId);
+    }
+
+    @Override
+    public Page<Balance> getBalancesForAccount(@NonNull TokenId tokenId, @NonNull AccountId accountId) throws HieroException {
+        return mirrorNodeClient.queryTokenBalancesForAccount(tokenId, accountId);
+    }
+}
diff --git a/...nterprise-base/src/main/java/com/openelements/hiero/base/mirrornode/MirrorNodeClient.java b/...nterprise-base/src/main/java/com/openelements/hiero/base/mirrornode/MirrorNodeClient.java
@@ -12,6 +12,9 @@
 import com.openelements.hiero.base.data.NftMetadata;
 import com.openelements.hiero.base.data.Page;
 import com.openelements.hiero.base.data.TransactionInfo;
+import com.openelements.hiero.base.data.TokenInfo;
+import com.openelements.hiero.base.data.Balance;
+import com.openelements.hiero.base.data.Token;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
@@ -237,6 +240,99 @@ default Optional<AccountInfo> queryAccount(@NonNull String accountId) throws Hie
     @NonNull
     Optional<NetworkSupplies> queryNetworkSupplies() throws HieroException;
 
+    /**
+     * Return Tokens associated with given accountId.
+     *
+     * @param accountId id of the account
+     * @return Optional of TokenInfo
+     * @throws HieroException if the search fails
+     */
+    Page<Token> queryTokensForAccount(@NonNull AccountId accountId) throws HieroException;
+
+    /**
+     * Return Tokens associated with given accountId.
+     *
+     * @param accountId id of the account
+     * @return Optional of TokenInfo
+     * @throws HieroException if the search fails
+     */
+    default Page<Token> queryTokensForAccount(@NonNull String accountId) throws HieroException {
+        Objects.requireNonNull(accountId, "accountId must not be null");
+        return queryTokensForAccount(AccountId.fromString(accountId));
+    }
+
+    /**
+     * Return Token Info for given tokenID.
+     *
+     * @param tokenId id of the token
+     * @return Optional of Token
+     * @throws HieroException if the search fails
+     */
+    @NonNull
+    Optional<TokenInfo> queryTokenById(@NonNull TokenId tokenId) throws HieroException;
+
+    /**
+     * Return Token Info for given tokenID.
+     *
+     * @param tokenId id of the token
+     * @return Optional of Token
+     * @throws HieroException if the search fails
+     */
+    @NonNull
+    default Optional<TokenInfo> queryTokenById(@NonNull String tokenId) throws HieroException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return queryTokenById(TokenId.fromString(tokenId));
+    }
+
+    /**
+     * Return Balance Info for given tokenID.
+     *
+     * @param tokenId id of the token
+     * @return Page of Balance
+     * @throws HieroException if the search fails
+     */
+    @NonNull
+    Page<Balance> queryTokenBalances(@NonNull TokenId tokenId) throws HieroException;
+
+    /**
+     * Return Balance Info for given tokenID.
+     *
+     * @param tokenId id of the token
+     * @return Page of Balance
+     * @throws HieroException if the search fails
+     */
+    @NonNull
+    default Page<Balance> queryTokenBalances(@NonNull String tokenId) throws HieroException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return queryTokenBalances(TokenId.fromString(tokenId));
+    }
+
+    /**
+     * Return Balance Info for given tokenID and accountId.
+     *
+     * @param tokenId id of the token
+     * @param accountId id of the account
+     * @return Page of Balance
+     * @throws HieroException if the search fails
+     */
+    @NonNull
+    Page<Balance> queryTokenBalancesForAccount(@NonNull TokenId tokenId, @NonNull AccountId accountId) throws HieroException;
+
+    /**
+     * Return Balance Info for given tokenID and accountId.
+     *
+     * @param tokenId id of the token
+     * @param accountId id of the account
+     * @return Page of Balance
+     * @throws HieroException if the search fails
+     */
+    @NonNull
+    default Page<Balance> queryTokenBalancesForAccount(@NonNull String tokenId, @NonNull String accountId) throws HieroException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        Objects.requireNonNull(accountId, "accountId must not be null");
+        return queryTokenBalancesForAccount(TokenId.fromString(tokenId), AccountId.fromString(accountId));
+    }
+
     @NonNull
     Optional<NftMetadata> getNftMetadata(TokenId tokenId) throws HieroException;