Struct Contract

pub struct Contract { /* private fields */ }

Represents a Soroban smart contract

Provides functionality to deploy and interact with Soroban smart contracts. A Contract instance can represent either an undeployed contract (with just WASM bytecode) or a deployed contract (with client configuration for interacting with it).

Implementations

impl Contract

pub fn new( wasm_path: &str, client_configs: Option<ClientContractConfigs>, ) -> Result<Self, SorobanHelperError>

Creates a new Contract instance from a WASM file path

Parameters

• wasm_path - Path to the contract’s WASM file
• client_configs - Optional configuration for interacting with an already deployed instance

Returns

A new Contract instance or an error if the file couldn’t be read

pub fn from_configs(client_configs: ClientContractConfigs) -> Self

Creates a new Contract instance from a deployed contract

Parameters

• client_configs - Configuration for interacting with the deployed contract

Returns

A new Contract instance

pub fn new_with_reader<T: FileReader>( wasm_path: &str, client_configs: Option<ClientContractConfigs>, file_reader: T, ) -> Result<Self, SorobanHelperError>

Creates a new Contract instance from a WASM file path and custom file reader

Parameters

• wasm_path - Path to the contract’s WASM file
• client_configs - Optional configuration for interacting with an already deployed instance
• file_reader - Custom file reader for reading the WASM file adopting the FileReader trait.

Returns

A new Contract instance or an error if the file couldn’t be read

pub async fn deploy( self, env: &Env, account: &mut Account, constructor_args: Option<Vec<ScVal>>, ) -> Result<Self, SorobanHelperError>

Deploys the contract to the Soroban network

This method performs two operations:

1. Uploads the contract WASM bytecode if it doesn’t exist on the network
2. Creates a contract instance with the uploaded WASM

If the contract has a constructor function, the provided constructor arguments will be passed to it during deployment.

Parameters

• env - The environment to use for deployment
• account - The account that will deploy the contract and pay for the transaction
• constructor_args - Optional arguments to pass to the contract’s constructor

Returns

The Contract instance updated with client configuration for the deployed contract

pub fn contract_id(&self) -> Option<ContractId>

Returns the contract ID if the contract has been deployed

Returns

The contract ID or None if the contract has not been deployed

pub async fn invoke( &mut self, function_name: &str, args: Vec<ScVal>, ) -> Result<SorobanTransactionResponse, SorobanHelperError>

Invokes a function on the deployed contract

Parameters

• function_name - The name of the function to invoke
• args - The arguments to pass to the function

Returns

The transaction response from the network

Errors

Returns an error if the contract has not been deployed or if there’s an issue with the invocation

Trait Implementations

impl Clone for Contract

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.