org.stellar.sdk.contract

Class ContractClient

java.lang.Object

org.stellar.sdk.contract.ContractClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ContractClient
extends java.lang.Object
implements java.io.Closeable

A client to interact with Soroban smart contracts.

This client is a wrapper for SorobanServer and TransactionBuilder to make it easier to interact with Soroban smart contracts. If you need more fine-grained control, please consider using them directly.

Constructor Summary

Constructors

Constructor and Description
ContractClient(java.lang.String contractId, java.lang.String rpcUrl, Network network) Creates a new ContractClient with the given contract ID, RPC URL, and network.

Method Summary

Modifier and Type	Method and Description
void	close()
<T> AssembledTransaction<T>	invoke(java.lang.String functionName, java.util.Collection<SCVal> parameters, java.lang.String source, KeyPair signer, java.util.function.Function<SCVal,T> parseResultXdrFn, int baseFee, int transactionTimeout, int submitTimeout, boolean simulate, boolean restore) Build an AssembledTransaction to invoke a function on the contract.
<T> AssembledTransaction<T>	invoke(java.lang.String functionName, java.util.List<SCVal> parameters, java.lang.String source, KeyPair signer, java.util.function.Function<SCVal,T> parseResultXdrFn, int baseFee) Build an AssembledTransaction to invoke a function on the contract.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContractClient

public ContractClient(java.lang.String contractId,
                      java.lang.String rpcUrl,
                      Network network)

Creates a new ContractClient with the given contract ID, RPC URL, and network.

Parameters:

contractId - The contract ID to interact with.

rpcUrl - The RPC URL of the Soroban server.

network - The network to interact with.

Method Detail

invoke

public <T> AssembledTransaction<T> invoke(java.lang.String functionName,
                                          java.util.List<SCVal> parameters,
                                          java.lang.String source,
                                          KeyPair signer,
                                          java.util.function.Function<SCVal,T> parseResultXdrFn,
                                          int baseFee)

Build an AssembledTransaction to invoke a function on the contract.

An alias for invoke(String, Collection, String, KeyPair, Function, int, int, int, boolean, boolean).

Parameters:

functionName - The name of the function to invoke.

parameters - The parameters to pass to the function.

source - The source account to use for the transaction.

signer - The key pair to sign the transaction with.

parseResultXdrFn - A function to parse the result XDR of the transaction.

baseFee - The base fee for the transaction.

invoke

public <T> AssembledTransaction<T> invoke(java.lang.String functionName,
                                          java.util.Collection<SCVal> parameters,
                                          java.lang.String source,
                                          @Nullable
                                          KeyPair signer,
                                          @Nullable
                                          java.util.function.Function<SCVal,T> parseResultXdrFn,
                                          int baseFee,
                                          int transactionTimeout,
                                          int submitTimeout,
                                          boolean simulate,
                                          boolean restore)

Build an AssembledTransaction to invoke a function on the contract.

Parameters:

functionName - The name of the function to invoke.

parameters - The parameters to pass to the function.

source - The source account to use for the transaction.

signer - The key pair to sign the transaction with.

parseResultXdrFn - A function to parse the result XDR of the transaction.

baseFee - The base fee for the transaction.

transactionTimeout - The timeout for the transaction.

submitTimeout - The timeout for submitting the transaction.

simulate - Whether to simulate the transaction.

restore - Whether to restore the transaction, only valid when simulate is true, and the signer is provided.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException