com.openelements.hiero.base.verification.ContractVerificationClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hiero-enterprise-base Show documentation
Base Library to work with Hiero in Spring and JakartaEE
The newest version!
package com.openelements.hiero.base.verification;

import com.hedera.hashgraph.sdk.ContractId;
import com.openelements.hiero.base.HieroException;
import java.util.Map;
import org.jspecify.annotations.NonNull;

/**
 * Client for verifying contracts on a Hiero network. This client is used to check the verification state of a smart
 * contract and to verify a smart contract. Currently only the Hedera mainnet, testnet and previewnet is supported.
 */
public interface ContractVerificationClient {

    /**
     * Check the verification state of a contract.
     *
     * @param contractId contract to check
     * @return verification state
     * @throws HieroException if an error happens in communication with a Hiero network
     */
    @NonNull
    ContractVerificationState checkVerification(@NonNull ContractId contractId) throws HieroException;

    /**
     * Check the verification state of a file that is part of a contract.
     *
     * @param contractId  contract to check
     * @param fileName    file name
     * @param fileContent file content
     * @return true if the contract contains is verified and contains a file with the given name and content
     * @throws IllegalStateException if contract is not verified
     * @throws HieroException        if an error happens in communication with a Hiero network
     */
    boolean checkVerification(@NonNull ContractId contractId, @NonNull String fileName, @NonNull String fileContent)
            throws HieroException;

    /**
     * Try to verify a contract.
     *
     * @param contractId       contract to verify
     * @param contractName     contract name
     * @param contractSource   contract source code
     * @param contractMetadata contract metadata
     * @return verification state
     * @throws IllegalStateException if contract is already verified
     * @throws HieroException        if an error happens in communication with a Hiero network
     */
    @NonNull
    default ContractVerificationState verify(@NonNull final ContractId contractId, @NonNull final String contractName,
            @NonNull final String contractSource, final String contractMetadata) throws HieroException {
        return verify(contractId, contractName,
                Map.of(contractName + ".sol", contractSource, "metadata.json", contractMetadata));
    }

    /**
     * Try to verify a contract.
     *
     * @param contractId   contract to verify
     * @param contractName contract name
     * @param files        contract files
     * @return verification state
     * @throws IllegalStateException if contract is already verified
     * @throws HieroException        if an error happens in communication with a Hiero network
     */
    @NonNull
    ContractVerificationState verify(@NonNull ContractId contractId, @NonNull String contractName,
            @NonNull Map files) throws HieroException;
}