ClientOptions
in package
Client configuration options for Soroban smart contract interactions
This class defines the core configuration required for a SorobanClient to interact with smart contracts on the Stellar network. It specifies the source account, target contract, network parameters, and RPC endpoint.
Tags
Table of Contents
Properties
- $contractId : string
- $enableServerLogging : bool
- $network : Network
- $rpcUrl : string
- $sourceAccountKeyPair : KeyPair
Methods
- __construct() : mixed
Properties
$contractId
public
string
$contractId
$enableServerLogging
public
bool
$enableServerLogging
= false
$network
public
Network
$network
$rpcUrl
public
string
$rpcUrl
$sourceAccountKeyPair
public
KeyPair
$sourceAccountKeyPair
Methods
__construct()
public
__construct(KeyPair $sourceAccountKeyPair, string $contractId, Network $network, string $rpcUrl[, bool $enableServerLogging = false ]) : mixed
Parameters
- $sourceAccountKeyPair : KeyPair
-
Keypair of the Stellar account that will send transactions. For read-only operations, only the public key is required. For write operations and automatic restore, the private key (secret seed) must be included for transaction signing.
- $contractId : string
-
The address of the contract the client will interact with.
- $network : Network
-
The Stellar network this contract is deployed to.
- $rpcUrl : string
-
The URL of the RPC instance that will be used to interact with this contract.
- $enableServerLogging : bool = false
-
Enable soroban server logging (helpful for debugging). Default: false.