From 9acb4552df8cfdf2a2b462ed5e6cc4c9d431a066 Mon Sep 17 00:00:00 2001 From: overcat <4catcode@gmail.com> Date: Mon, 14 Aug 2023 08:07:25 +0800 Subject: [PATCH] improve docs --- .../java/org/stellar/sdk/TransactionBuilder.java | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/stellar/sdk/TransactionBuilder.java b/src/main/java/org/stellar/sdk/TransactionBuilder.java index 8459dd934..c1b900697 100644 --- a/src/main/java/org/stellar/sdk/TransactionBuilder.java +++ b/src/main/java/org/stellar/sdk/TransactionBuilder.java @@ -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.). + * + *
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. @@ -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.). + * + *
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.