Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Aug 14, 2023
1 parent f4213a1 commit 9acb455
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions src/main/java/org/stellar/sdk/TransactionBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,13 @@ public static org.stellar.sdk.xdr.TimeBounds buildTimeBounds(long minTime, long
}

/**
* Sets Soroban data to the transaction. TODO: After adding SorobanServer, add more descriptions.
* Sets the transaction's internal Soroban transaction data (resources, footprint, etc.).
*
* <p>For non-contract(non-Soroban) transactions, this setting has no effect. In the case of
* Soroban transactions, this is either an instance of {@link SorobanTransactionData} or a
* base64-encoded string of said structure. This is usually obtained from the simulation response
* based on a transaction with a Soroban operation (e.g. {@link InvokeHostFunctionOperation},
* providing necessary resource and storage footprint estimations for contract invocation.
*
* @param sorobanData Soroban data to set
* @return Builder object so you can chain methods.
Expand All @@ -274,7 +280,13 @@ public TransactionBuilder setSorobanData(SorobanTransactionData sorobanData) {
}

/**
* Sets Soroban data to the transaction. TODO: After adding SorobanServer, add more descriptions.
* Sets the transaction's internal Soroban transaction data (resources, footprint, etc.).
*
* <p>For non-contract(non-Soroban) transactions, this setting has no effect. In the case of
* Soroban transactions, this is either an instance of {@link SorobanTransactionData} or a
* base64-encoded string of said structure. This is usually obtained from the simulation response
* based on a transaction with a Soroban operation (e.g. {@link InvokeHostFunctionOperation},
* providing necessary resource and storage footprint estimations for contract invocation.
*
* @param sorobanData Soroban data to set
* @return Builder object so you can chain methods.
Expand Down

0 comments on commit 9acb455

Please sign in to comment.