Smart Contract Client¶

SmartContractClient provides APIs for managing smart contracts on a Hiero network, including contract deployment and function execution.

Note

Smart contract operations that submit transactions to the Hiero network require HBAR to pay transaction fees. The configured operator account is used as the transaction payer and must have sufficient HBAR balance.

Methods¶

Method	Description
`createContract(String fileId, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode stored in a file ID string.
`createContract(FileId fileId, ContractParam<?>... constructorParams)`	Creates a smart contract using an existing bytecode file.
`createContract(byte[] contents, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode contents.
`createContract(Path pathToBin, ContractParam<?>... constructorParams)`	Creates a smart contract using a bytecode file path.
`createContract(String fileId, Hbar maxTransactionFee, int gas, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode stored in a file ID string with a custom maximum transaction fee and gas limit.
`createContract(FileId fileId, Hbar maxTransactionFee, int gas, ContractParam<?>... constructorParams)`	Creates a smart contract using an existing bytecode file with a custom maximum transaction fee and gas limit.
`createContract(byte[] contents, Hbar maxTransactionFee, int gas, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode contents with a custom maximum transaction fee and gas limit.
`createContract(Path pathToBin, Hbar maxTransactionFee, int gas, ContractParam<?>... constructorParams)`	Creates a smart contract using a bytecode file path with a custom maximum transaction fee and gas limit.
`createContract(String fileId, String adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode stored in a file ID string and sets the specified private key as the contract admin key.
`createContract(FileId fileId, PrivateKey adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using an existing bytecode file and sets the specified private key as the contract admin key.
`createContract(byte[] contents, PrivateKey adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode contents and sets the specified private key as the contract admin key.
`createContract(Path pathToBin, PrivateKey adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using a bytecode file path and sets the specified private key as the contract admin key.
`createContract(String fileId, Hbar maxTransactionFee, int gas, String adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode stored in a file ID string with a custom maximum transaction fee, gas limit, and admin key.
`createContract(FileId fileId, Hbar maxTransactionFee, int gas, PrivateKey adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using an existing bytecode file with a custom maximum transaction fee, gas limit, and admin key.
`createContract(byte[] contents, Hbar maxTransactionFee, int gas, PrivateKey adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using bytecode contents with a custom maximum transaction fee, gas limit, and admin key.
`createContract(Path pathToBin, Hbar maxTransactionFee, int gas, PrivateKey adminKey, ContractParam<?>... constructorParams)`	Creates a smart contract using a bytecode file path with a custom maximum transaction fee, gas limit, and admin key.
`callContractFunction(String contractId, String functionName, ContractParam<?>... params)`	Executes a contract function using a contract ID string.
`callContractFunction(ContractId contractId, String functionName, ContractParam<?>... params)`	Executes a contract function using a contract ID.
`callContractFunction(String contractId, String functionName, Hbar maxTransactionFee, int gas, ContractParam<?>... params)`	Executes a smart contract function using a contract ID string with a custom maximum transaction fee and gas limit.
`callContractFunction(ContractId contractId, String functionName, Hbar maxTransactionFee, int gas, ContractParam<?>... params)`	Executes a smart contract function using a contract ID with a custom maximum transaction fee and gas limit.
`deleteContract(String contractId, String adminKey)`	Marks the specified smart contract as deleted using the specified DER-encoded private key as the admin key. The remaining balance is transfer to operator account.
`deleteContract(ContractId contractId, PrivateKey adminKey)`	Marks the specified smart contract as deleted using the specified private key as the admin key. The remaining balance is transfer to operator account.
`deleteContract(ContractId contractId, ContractId toContractId, PrivateKey adminKey)`	Marks the specified smart contract as deleted using the specified private key as the admin key and transfers its remaining balance to another contract.
`deleteContract(ContractId contractId, AccountId toAccountId, PrivateKey adminKey)`	Marks the specified smart contract as deleted using the specified private key as the admin key and transfers its remaining balance to an account.

Create Contract¶

Deploys a smart contract to the Hiero network.

createContract(FileId fileId, ContractParam<?>... constructorParams)

FileId fileId =
    FileId.fromString("0.0.1234");


ContractId contractId =
    smartContractClient.createContract(
        fileId,
        ContractParam.string("Hello Hiero")
    );

createContract(byte[] contents, ContractParam<?>... constructorParams)

byte[] bytecode =
    Files.readAllBytes(
        Path.of("contract.bin")
    );

ContractId contractId =
    smartContractClient.createContract(
        bytecode,
        ContractParam.string("Hello Hiero")
    );

createContract(Path pathToBin, ContractParam<?>... constructorParams)

ContractId contractId =
    smartContractClient.createContract(
        Path.of("contract.bin"),
        ContractParam.string("Hello Hiero")
    );

Info

When maxTransactionFee and gas are not specified, the client uses 100 HBAR as the default maximum transaction fee and 5_000_000 as the default gas limit. You can also override these values by using the overload that accepts maxTransactionFee and gas.

createContract(FileId fileId, Hbar maxTransactionFee, int gas, ContractParam<?>... constructorParams)

FileId fileId =
    FileId.fromString("0.0.1234");

ContractId contractId =
    smartContractClient.createContract(
        fileId,
        Hbar.from(20),
        10_000_000,
        ContractParam.string("Hello Hiero")
    );

Info

A contract can be deployed with an admin key by using the createContract overloads that accept a PrivateKey. The admin key can be used to authorize administrative operations on the contract, for deleting the contract.

createContract(FileId fileId, PrivateKey adminKey, ContractParam<?>... constructorParams)

FileId fileId =
    FileId.fromString("0.0.1234");

PrivateKey adminKey =
    PrivateKey.fromStringDER("...");

ContractId contractId =
    smartContractClient.createContract(
        fileId,
        adminKey,
        ContractParam.string("Hello Hiero")
    );

createContract(FileId fileId, Hbar maxTransactionFee, int gas, PrivateKey adminKey, ContractParam<?>... constructorParams)

FileId fileId =
    FileId.fromString("0.0.1234");

PrivateKey adminKey =
    PrivateKey.fromStringDER("...");

ContractId contractId =
    smartContractClient.createContract(
        fileId,
        Hbar.from(20),
        10_000_000,
        adminKey,
        ContractParam.string("Hello Hiero")
    );

Delete Contract¶

Marks a smart contract as deleted on the Hiero network.

Note

Deleting a smart contract marks the contract as deleted, but does not remove its bytecode from the network.

Subsequent function calls to the deleted contract may complete without an error, but will not return any data produced by the called function.

Info

The remaining balance of the deleted contract can optionally be transferred to another contract or account.

deleteContract(ContractId contractId, PrivateKey adminKey)

ContractId contractId =
    ContractId.fromString("0.0.5678");

PrivateKey adminKey = PrivateKey.fromStringDER("...");

smartContractClient.deleteContract(contractId, adminKey);

deleteContract(ContractId contractId, ContractId toContractId)

ContractId contractId =
    ContractId.fromString("0.0.5678");

ContractId toContractId =
    ContractId.fromString("0.0.1234");

PrivateKey adminKey = PrivateKey.fromStringDER("...");

smartContractClient.deleteContract(contractId, toContractId, adminKey);

deleteContract(ContractId contractId, AccountId toAccountId)

ContractId contractId =
    ContractId.fromString("0.0.5678");

AccountId toAccountId =
    AccountId.fromString("0.0.1001");

PrivateKey adminKey = PrivateKey.fromStringDER("...");

smartContractClient.deleteContract(contractId, toAccountId, adminKey);

Call Contract Function¶

Executes a function on an existing smart contract.

callContractFunction(ContractId contractId, String functionName, ContractParam<?>... params)

ContractId contractId =
    ContractId.fromString("0.0.5678");

ContractCallResult result =
    smartContractClient.callContractFunction(
        contractId,
        "getValue",
        ContractParam.string("Hello Hiero")
    );

Info

When maxTransactionFee and gas are not specified, the client uses 100 HBAR as the default maximum transaction fee and 5_000_000 as the default gas limit. You can also override these values by using the overload that accepts maxTransactionFee and gas.

callContractFunction(ContractId contractId, String functionName, Hbar maxTransactionFee, int gas, ContractParam<?>... params)

ContractId contractId =
    ContractId.fromString("0.0.5678");

ContractCallResult result =
    smartContractClient.callContractFunction(
        contractId,
        "getValue",
        Hbar.from(20),
        10_000_000,
        ContractParam.string("Hello Hiero")
    );

Warning

The maximum gas that can be specified for a contract execution is 15_000_000.
The maxTransactionFee and gas values determine the maximum amount you are willing to pay for the transaction. If the required gas exceeds the specified limit or the maximum transaction fee is too low, the transaction may fail.

Tip

See the Contract Parameters documentation for all supported Solidity parameter types, including strings, addresses, booleans, bytes, and numeric types.