better service definitions

Author: hendrikebbers

hedera-base/src/main/java/com/openelements/hedera/base/ContractVerificationClient.java

@@ -37,7 +37,7 @@ public interface ContractVerificationClient {
      * @param contractName contract name
      * @param contractSource contract source code
      * @param contractMetadata contract metadata
-     * @return
+     * @return verification state
      * @throws IllegalStateException if contract is already verified
      * @throws HederaException if an error happens in communication with the Hedera network
      */

hedera-base/src/main/java/com/openelements/hedera/base/NftClient.java

@@ -3,6 +3,8 @@
 import com.hedera.hashgraph.sdk.AccountId;
 import com.hedera.hashgraph.sdk.PrivateKey;
 import com.hedera.hashgraph.sdk.TokenId;
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
@@ -41,6 +43,22 @@ public interface NftClient {
     TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull PrivateKey supplierKey)
             throws HederaException;
 
+    /**
+     * Create a new NFT type. The operator account is used as treasury account for the NFT type.
+     *
+     * @param name        the name of the NFT type
+     * @param symbol      the symbol of the NFT type
+     * @param supplierKey the private key of the supplier account
+     * @return the ID of the new NFT type
+     * @throws HederaException if the NFT type could not be created
+     */
+    @NonNull
+    default TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull String supplierKey)
+            throws HederaException {
+        Objects.requireNonNull(supplierKey, "supplierKey must not be null");
+        return createNftType(name, symbol, PrivateKey.fromString(supplierKey));
+    }
+
     /**
      * Create a new NFT type. The operator account is used as supplier account for the NFT type.
      *
@@ -55,6 +73,24 @@ TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull Pri
     TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull AccountId treasuryAccountId,
             @NonNull PrivateKey treasuryKey) throws HederaException;
 
+    /**
+     * Create a new NFT type. The operator account is used as supplier account for the NFT type.
+     *
+     * @param name              the name of the NFT type
+     * @param symbol            the symbol of the NFT type
+     * @param treasuryAccountId the ID of the treasury account
+     * @param treasuryKey       the private key of the treasury account
+     * @return the ID of the new NFT type
+     * @throws HederaException if the NFT type could not be created
+     */
+    @NonNull
+    default TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull String treasuryAccountId,
+            @NonNull String treasuryKey) throws HederaException {
+        Objects.requireNonNull(treasuryAccountId, "treasuryAccountId must not be null");
+        Objects.requireNonNull(treasuryKey, "treasuryKey must not be null");
+        return createNftType(name, symbol, AccountId.fromString(treasuryAccountId), PrivateKey.fromString(treasuryKey));
+    }
+
     /**
      * Create a new NFT type. The operator account is used as supplier account for the NFT type.
      *
@@ -87,6 +123,27 @@ default TokenId createNftType(@NonNull String name, @NonNull String symbol, @Non
     TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull AccountId treasuryAccountId,
             @NonNull PrivateKey treasuryKey, @NonNull PrivateKey supplierKey) throws HederaException;
 
+    /**
+     * Create a new NFT type.
+     *
+     * @param name              the name of the NFT type
+     * @param symbol            the symbol of the NFT type
+     * @param treasuryAccountId the ID of the treasury account
+     * @param treasuryKey       the private key of the treasury account
+     * @param supplierKey       the private key of the supplier account
+     * @return the ID of the new NFT type
+     * @throws HederaException if the NFT type could not be created
+     */
+    @NonNull
+    default TokenId createNftType(@NonNull String name, @NonNull String symbol, @NonNull String treasuryAccountId,
+            @NonNull String treasuryKey, @NonNull String supplierKey) throws HederaException {
+        Objects.requireNonNull(treasuryAccountId, "treasuryAccountId must not be null");
+        Objects.requireNonNull(treasuryKey, "treasuryKey must not be null");
+        Objects.requireNonNull(supplierKey, "supplierKey must not be null");
+        return createNftType(name, symbol, AccountId.fromString(treasuryAccountId), PrivateKey.fromString(treasuryKey),
+                PrivateKey.fromString(supplierKey));
+    }
+
     /**
      * Create a new NFT type.
      *
@@ -117,6 +174,23 @@ default TokenId createNftType(@NonNull String name, @NonNull String symbol, @Non
     void associateNft(@NonNull TokenId tokenId, @NonNull AccountId accountId, @NonNull PrivateKey accountKey)
             throws HederaException;
 
+    /**
+     * Associate an account with an NFT type. If an account is associated with an NFT type, the account can hold NFTs of
+     * that type. Otherwise, the account cannot hold NFTs of that type and tranfer NFTs of that type will fail.
+     *
+     * @param tokenId    the ID of the NFT type
+     * @param accountId  the ID of the account
+     * @param accountKey the private key of the account
+     * @throws HederaException if the account could not be associated with the NFT type
+     */
+    default void associateNft(@NonNull String tokenId, @NonNull String accountId, @NonNull String accountKey)
+            throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        Objects.requireNonNull(accountId, "accountId must not be null");
+        Objects.requireNonNull(accountKey, "accountKey must not be null");
+        associateNft(TokenId.fromString(tokenId), AccountId.fromString(accountId), PrivateKey.fromString(accountKey));
+    }
+
     /**
      * Associate an account with an NFT type. If an account is associated with an NFT type, the account can hold NFTs of
      * that type. Otherwise, the account cannot hold NFTs of that type and tranfer NFTs of that type will fail.
@@ -139,7 +213,21 @@ default void associateNft(@NonNull TokenId tokenId, @NonNull Account account) th
      * @return the serial number of the new NFT
      * @throws HederaException if the NFT could not be minted
      */
-    long mintNft(@NonNull TokenId tokenId, @NonNull String metadata) throws HederaException;
+    long mintNft(@NonNull TokenId tokenId, @NonNull byte[] metadata) throws HederaException;
+
+    /**
+     * Mint a new NFT of the given type. The NFT is minted by the operator account. The operator account is used as
+     * supply account for the NFT.
+     *
+     * @param tokenId  the ID of the NFT type
+     * @param metadata the metadata of the NFT
+     * @return the serial number of the new NFT
+     * @throws HederaException if the NFT could not be minted
+     */
+    default long mintNft(@NonNull String tokenId, @NonNull byte[] metadata) throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return mintNft(TokenId.fromString(tokenId), metadata);
+    }
 
     /**
      * Mint a new NFT of the given type.
@@ -150,9 +238,25 @@ default void associateNft(@NonNull TokenId tokenId, @NonNull Account account) th
      * @return the serial number of the new NFT
      * @throws HederaException if the NFT could not be minted
      */
-    long mintNft(@NonNull TokenId tokenId, @NonNull String metadata, @NonNull PrivateKey supplyKey)
+    long mintNft(@NonNull TokenId tokenId, @NonNull PrivateKey supplyKey, @NonNull byte[] metadata)
             throws HederaException;
 
+    /**
+     * Mint a new NFT of the given type.
+     *
+     * @param tokenId   the ID of the NFT type
+     * @param metadata  the metadata of the NFT
+     * @param supplyKey the private key of the supply account
+     * @return the serial number of the new NFT
+     * @throws HederaException if the NFT could not be minted
+     */
+    default long mintNft(@NonNull String tokenId, @NonNull String supplyKey, @NonNull byte[] metadata)
+            throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        Objects.requireNonNull(supplyKey, "supplyKey must not be null");
+        return mintNft(TokenId.fromString(tokenId), PrivateKey.fromString(supplyKey), metadata);
+    }
+
     /**
      * Mint new NFTs of the given type. The NFTs are minted by the operator account. The operator account is used as
      * supply account for the NFTs.
@@ -163,7 +267,22 @@ long mintNft(@NonNull TokenId tokenId, @NonNull String metadata, @NonNull Privat
      * @throws HederaException if the NFTs could not be minted
      */
     @NonNull
-    List<Long> mintNfts(@NonNull TokenId tokenId, @NonNull List<String> metadata) throws HederaException;
+    List<Long> mintNfts(@NonNull TokenId tokenId, @NonNull byte[]... metadata) throws HederaException;
+
+    /**
+     * Mint new NFTs of the given type. The NFTs are minted by the operator account. The operator account is used as
+     * supply account for the NFTs.
+     *
+     * @param tokenId  the ID of the NFT type
+     * @param metadata the metadata of the NFTs
+     * @return the serial numbers of the new NFTs
+     * @throws HederaException if the NFTs could not be minted
+     */
+    @NonNull
+    default List<Long> mintNfts(@NonNull String tokenId, @NonNull byte[]... metadata) throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return mintNfts(TokenId.fromString(tokenId), metadata);
+    }
 
     /**
      * Mint new NFTs of the given type.
@@ -175,9 +294,26 @@ long mintNft(@NonNull TokenId tokenId, @NonNull String metadata, @NonNull Privat
      * @throws HederaException if the NFTs could not be minted
      */
     @NonNull
-    List<Long> mintNfts(@NonNull TokenId tokenId, @NonNull List<String> metadata, @NonNull PrivateKey supplyKey)
+    List<Long> mintNfts(@NonNull TokenId tokenId, @NonNull PrivateKey supplyKey, @NonNull byte[]... metadata)
             throws HederaException;
 
+    /**
+     * Mint new NFTs of the given type.
+     *
+     * @param tokenId   the ID of the NFT type
+     * @param metadata  the metadata of the NFTs
+     * @param supplyKey the private key of the supply account
+     * @return the serial numbers of the new NFTs
+     * @throws HederaException if the NFTs could not be minted
+     */
+    @NonNull
+    default List<Long> mintNfts(@NonNull String tokenId, @NonNull String supplyKey, @NonNull byte[]... metadata)
+            throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        Objects.requireNonNull(supplyKey, "supplyKey must not be null");
+        return mintNfts(TokenId.fromString(tokenId), PrivateKey.fromString(supplyKey), metadata);
+    }
+
     default void burnNft(@NonNull TokenId tokenId, long serialNumber) throws HederaException {
         burnNfts(tokenId, Set.of(serialNumber));
     }

hedera-base/src/main/java/com/openelements/hedera/base/NftRepository.java

@@ -4,6 +4,7 @@
 import com.hedera.hashgraph.sdk.TokenId;
 import com.openelements.hedera.base.mirrornode.Page;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 import org.jspecify.annotations.NonNull;
 
@@ -22,6 +23,19 @@ public interface NftRepository {
     @NonNull
     List<Nft> findByOwner(@NonNull AccountId ownerId) throws HederaException;
 
+    /**
+     * Return all NFTs that are owned by the given owner.
+     *
+     * @param ownerId id of the owner account
+     * @return list of NFTs
+     * @throws HederaException if the search fails
+     */
+    @NonNull
+    default List<Nft> findByOwner(@NonNull String ownerId) throws HederaException {
+        Objects.requireNonNull(ownerId, "ownerId must not be null");
+        return findByOwner(AccountId.fromString(ownerId));
+    }
+
     /**
      * Return all NFTs of a given type.
      *
@@ -32,6 +46,19 @@ public interface NftRepository {
     @NonNull
     Page<Nft> findByType(@NonNull TokenId tokenId) throws HederaException;
 
+    /**
+     * Return all NFTs of a given type.
+     *
+     * @param tokenId id of the token type
+     * @return list of NFTs
+     * @throws HederaException if the search fails
+     */
+    @NonNull
+    default Page<Nft> findByType(@NonNull String tokenId) throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return findByType(TokenId.fromString(tokenId));
+    }
+
     /**
      * Return the NFTs of a given type with the given serial.
      *
@@ -43,6 +70,20 @@ public interface NftRepository {
     @NonNull
     Optional<Nft> findByTypeAndSerial(@NonNull TokenId tokenId, long serialNumber) throws HederaException;
 
+    /**
+     * Return the NFTs of a given type with the given serial.
+     *
+     * @param tokenId      id of the token type
+     * @param serialNumber serial of the nft instance
+     * @return {@link Optional} containing the found NFT or null
+     * @throws HederaException if the search fails
+     */
+    @NonNull
+    default Optional<Nft> findByTypeAndSerial(@NonNull String tokenId, long serialNumber) throws HederaException {
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return findByTypeAndSerial(TokenId.fromString(tokenId), serialNumber);
+    }
+
     /**
      * Return all NFTs of a given type owned by a specific account.
      *
@@ -54,6 +95,21 @@ public interface NftRepository {
     @NonNull
     List<Nft> findByOwnerAndType(@NonNull AccountId ownerId, @NonNull TokenId tokenId) throws HederaException;
 
+    /**
+     * Return all NFTs of a given type owned by a specific account.
+     *
+     * @param ownerId id of the owner
+     * @param tokenId id of the token type
+     * @return list of NFTs
+     * @throws HederaException if the search fails
+     */
+    @NonNull
+    default List<Nft> findByOwnerAndType(@NonNull String ownerId, @NonNull String tokenId) throws HederaException {
+        Objects.requireNonNull(ownerId, "ownerId must not be null");
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return findByOwnerAndType(AccountId.fromString(ownerId), TokenId.fromString(tokenId));
+    }
+
     /**
      * Return the NFT of a given type and serial owned by a specific account.
      *
@@ -66,4 +122,21 @@ public interface NftRepository {
     @NonNull
     Optional<Nft> findByOwnerAndTypeAndSerial(@NonNull AccountId owner, @NonNull TokenId tokenId, long serialNumber)
             throws HederaException;
+
+    /**
+     * Return the NFT of a given type and serial owned by a specific account.
+     *
+     * @param owner        id of the owner
+     * @param tokenId      id of the token type
+     * @param serialNumber serial of the nft instance
+     * @return {@link Optional} containing the found NFT or null
+     * @throws HederaException if the search fails
+     */
+    @NonNull
+    default Optional<Nft> findByOwnerAndTypeAndSerial(@NonNull String owner, @NonNull String tokenId, long serialNumber)
+            throws HederaException {
+        Objects.requireNonNull(owner, "owner must not be null");
+        Objects.requireNonNull(tokenId, "tokenId must not be null");
+        return findByOwnerAndTypeAndSerial(AccountId.fromString(owner), TokenId.fromString(tokenId), serialNumber);
+    }
 }