Added support for calling Soroban RPC server. #492

overcat · 2023-07-21T15:26:57Z

Closes #485, Closes #479, Closes #495

sreuland · 2023-07-21T20:15:28Z

make sure to change merge target on this to 'soroban' branch

sreuland · 2023-07-21T20:17:21Z

assume this depends on #481 to merge first as it will bring in all the new xdr definitions?

overcat · 2023-07-22T03:50:19Z

assume this depends on #481 to merge first as it will bring in all the new xdr definitions?

Yes, let's merge #481 first.

sreuland · 2023-07-27T20:17:03Z

src/main/java/org/stellar/sdk/LedgerEntryNotFoundException.java

@@ -0,0 +1,14 @@
+package org.stellar.sdk;
+
+public class LedgerEntryNotFoundException extends Exception {


maybe a style guideline to add, for any public class at minimum, add a javadoc for the class level, and would be nice to have javadoc on any public methods.

sreuland · 2023-07-27T20:20:17Z

src/main/java/org/stellar/sdk/SorobanServer.java

+  private static final int SUBMIT_TRANSACTION_TIMEOUT = 60; // seconds
+  private static final int CONNECT_TIMEOUT = 10; // seconds
+  private final HttpUrl serverURI;
+  private final OkHttpClient httpClient;


maybe this could be an opportunity to replace OkHttpClient because it's really bloated and it pulls in kotlin as a dependency even though it's not used here at all.

If you want to evaluate http clients a bit, the other alternatives are apache HttpClient or bump the java jdk level of project to 11 and then can use the jdk's built-in java.net.http.HttpClient

oh, skip taking that on in here, we should just carve out changing the jdk level and updating library deps to a separate 'tech debt' ticket so it doesn't conflate the effort here, thanks!

#496

cc @mollykarcher , @tamirms

sreuland · 2023-07-27T20:22:13Z

src/main/java/org/stellar/sdk/SorobanServer.java

+    this.httpClient = httpClient;
+  }
+
+  public TransactionBuilderAccount getAccount(String accountId)


would be helpful to javadoc the public methods, both for readability of source and also for client usage.

sreuland · 2023-07-27T20:25:18Z

src/main/java/org/stellar/sdk/SorobanServer.java

+  public GetLedgerEntriesResponse getLedgerEntries(Collection<LedgerKey> keys) throws IOException {
+    List<String> xdrKeys =
+        keys.stream().map(SorobanServer::ledgerKeyToXdrBase64).collect(Collectors.toList());
+    GetLedgerEntriesRequest params = new GetLedgerEntriesRequest(xdrKeys);


is an empty keys list a valid request and/or should this check for empty list on xdrKeys, to avoid sending to rpc in any case?

sreuland · 2023-07-27T20:29:27Z

src/main/java/org/stellar/sdk/SorobanServer.java

+  }
+
+  public GetHealthResponse getHealth() throws IOException {
+    return this.<Void, GetHealthResponse>sendRequest(


can remove the this references, that scope is implied when any non-static method invokes another non-static method of class.

Yes, but I think adding "this" is also very common. If you insist on removing it, I can do that.

it's not common to use this when the variable scope doesn't require it, one example of usage is when a method level variable shadows a class variable, but the usage here in this scope is not required and results in some code bloat.

sreuland · 2023-07-27T20:38:51Z

src/main/java/org/stellar/sdk/requests/sorobanrpc/SorobanRpcErrorResponse.java

+import lombok.Getter;
+
+@Getter
+public class SorobanRpcErrorResponse extends RuntimeException {


i expected this to be checked exception, forcing callers to handle it, what was the reason for coercing this to unchecked with extends RuntimeException?

hmm, after more review, I don't think we want to model an rpc error response as an exception, rather it is conveyed as an attribute in the SorobanRpcResponse instead, thinking this SorobanRpcErrorResponse can be removed?

After the discussion in #492 (comment), I think it would be better to directly return the result instead of SorobanRpcErrorResponse. What do you think?

sreuland · 2023-07-27T20:51:11Z

src/main/java/org/stellar/sdk/SorobanServer.java

+    Request request = new Request.Builder().url(this.serverURI).post(requestBody).build();
+    try (Response response = this.httpClient.newCall(request).execute()) {
+      SorobanRpcResponse<R> sorobanRpcResponse = responseHandler.handleResponse(response);
+      if (sorobanRpcResponse.getError() != null) {


thinking about this, not sure that a successful http response with json-rpc error in the response payload should be elevated to an exception, instead, just return the sorobanRpcResponse in all cases if you get it, as it has result and error attributes, that way clients only have to catch the IOException as a fatal type problem, otherwise they will inspect the response result/error for further application meaning. I commented similar on SorobanRpcErrorResponse

Yes, personally I prefer returning the entire SorobanRpcResponse, but after reading the code of other libraries (including js-soroban-sdk), I found that they directly return RpcResponse.result.

I have a question, is it necessary to expose the "id" field in jsonrpc to users? In other words, when making a jsonrpc request via http, is the "id" field almost useless?

just in case, I'd wire it in for allowing it to be set by caller in sdk, but accepting null,etc so that a default hardcoded id can be applied, just so we don't get stuck.

If that's the case, I will still stick to the current design, which is to throw a SorobanRpcErrorResponse exception if the response contains an error.

However, I will wrap the returned result, for example:

@Value @AllArgsConstructor class WrappedResponse<T> { String id; T result; } public WrappedResponse<TransactionBuilderAccount> getAccount(String accountId, String requestId)

Because interfaces like getAccount and prepareTransaction call RPC interfaces internally, but these interfaces do not directly return the data returned by Soroban-RPC to the user. This modification helps users obtain the ID.

After careful consideration, I suggest sticking with the current design. If there is a need to expose the id in the future, we can add it without introducing any breaking changes..

src/main/java/org/stellar/sdk/requests/sorobanrpc/SorobanRpcRequest.java

sreuland · 2023-07-27T20:57:31Z

src/main/java/org/stellar/sdk/responses/sorobanrpc/SendTransactionResponse.java

+@AllArgsConstructor
+@Value
+public class SendTransactionResponse {
+  @SerializedName("status")


can remove the @SerializedName annotations when it matches the java class member name, gson will by default serialize to that name.

overcat · 2023-07-27T23:03:47Z

Hi @sreuland, this PR is still in WIP status. I will let you know when it is ready for review. Thank you!

overcat · 2023-07-28T16:27:28Z

This PR is almost complete, of course there are still a few documents and test cases waiting to be added, welcome to leave comments.

overcat · 2023-07-28T16:35:33Z

Click to view an example of creating and submitting a Soroban transaction.

Click me.

package org.stellar.sdk;

import java.io.IOException;
import org.junit.Test;
import org.stellar.sdk.requests.sorobanrpc.SorobanRpcErrorResponse;
import org.stellar.sdk.responses.sorobanrpc.SendTransactionResponse;
import org.stellar.sdk.xdr.HostFunction;
import org.stellar.sdk.xdr.HostFunctionType;
import org.stellar.sdk.xdr.SCSymbol;
import org.stellar.sdk.xdr.SCVal;
import org.stellar.sdk.xdr.SCValType;
import org.stellar.sdk.xdr.SCVec;
import org.stellar.sdk.xdr.Uint32;
import org.stellar.sdk.xdr.XdrString;

public class DemoTest {
  @Test
  public void demo()
      throws IOException,
          SorobanRpcErrorResponse,
          AccountNotFoundException,
          PrepareTransactionException {
    SorobanServer sorobanServer = new SorobanServer("http://100.83.15.43:8000/soroban/rpc");

    String contractId = "CDCYWK73YTYFJZZSJ5V7EDFNHYBG4QN3VUNG2IGD27KJDDPNCZKBCBXK";
    KeyPair txSubmitterKp =
        KeyPair.fromSecretSeed("SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV");
    KeyPair opInvokerKp =
        KeyPair.fromSecretSeed("SAEZSI6DY7AXJFIYA4PM6SIBNEYYXIEM2MSOTHFGKHDW32MBQ7KVO6EN");

    TransactionBuilderAccount source = sorobanServer.getAccount(txSubmitterKp.getAccountId());

    Transaction transaction =
        new TransactionBuilder(AccountConverter.enableMuxed(), source, Network.STANDALONE)
            .setBaseFee(50000)
            .addPreconditions(
                TransactionPreconditions.builder().timeBounds(new TimeBounds(0, 0)).build())
            .addOperation(
                InvokeHostFunctionOperation.builder()
                    .sourceAccount(opInvokerKp.getAccountId())
                    .hostFunction(
                        new HostFunction.Builder()
                            .discriminant(HostFunctionType.HOST_FUNCTION_TYPE_INVOKE_CONTRACT)
                            .invokeContract(
                                new SCVec(
                                    new SCVal[] {
                                      new Address(contractId).toSCVal(),
                                      new SCVal.Builder()
                                          .discriminant(SCValType.SCV_SYMBOL)
                                          .sym(new SCSymbol(new XdrString("increment")))
                                          .build(),
                                      new Address(opInvokerKp.getAccountId()).toSCVal(),
                                      new SCVal.Builder()
                                          .discriminant(SCValType.SCV_U32)
                                          .u32(new Uint32(10))
                                          .build()
                                    }))
                            .build())
                    .build())
            .build();

    Transaction newTx = sorobanServer.prepareTransaction(transaction);

    newTx.sign(txSubmitterKp);
    newTx.sign(opInvokerKp);

    SendTransactionResponse resp = sorobanServer.sendTransaction(newTx);
    System.out.println(resp);
  }
}

overcat · 2023-07-31T02:51:39Z

Hi @sreuland, this PR is ready.

overcat changed the base branch from master to soroban July 21, 2023 22:42

overcat force-pushed the soroban-server branch 3 times, most recently from 21c7c89 to c2b0a09 Compare July 27, 2023 12:37

sreuland mentioned this pull request Jul 27, 2023

Add support for BumpFootprintExpirationOperation and RestoreFootprintOperation #491

Merged

sreuland reviewed Jul 27, 2023

View reviewed changes

src/main/java/org/stellar/sdk/requests/sorobanrpc/SorobanRpcRequest.java Show resolved Hide resolved

sreuland reviewed Jul 27, 2023

View reviewed changes

overcat added 3 commits July 28, 2023 09:25

Added support for calling Soroban RPC server.

681ddc7

Remove unnecessary SerializedName

880b21f

add docs & fix bugs.

e3e2490

overcat force-pushed the soroban-server branch from c2b0a09 to e3e2490 Compare July 28, 2023 08:44

overcat added 7 commits July 28, 2023 16:56

check keys

179a25b

improve exception.

b868e1b

add test

96813a4

add Network.FUTURENET

dd23dc9

add network passphrases

88aa3c3

bug fix

6c2d2b3

add test

8da37f7

fix style

b70494c

overcat added 5 commits July 29, 2023 14:53

add docs

3ddee58

add docs.

3c2cd1c

add tests

d619cc2

add tests

543c2a7

add tests

be3809f

overcat changed the title ~~[WIP] Added support for calling Soroban RPC server.~~ Added support for calling Soroban RPC server. Jul 29, 2023

overcat marked this pull request as ready for review July 29, 2023 15:50

tamirms approved these changes Jul 31, 2023

View reviewed changes

tamirms merged commit 25dc8a8 into lightsail-network:soroban Aug 2, 2023

overcat deleted the soroban-server branch August 11, 2023 08:38

This was referenced Aug 22, 2023

java-stellar-sdk: add support for fees #479

Closed

Submit Soroban Tx with operations #495

Closed

overcat mentioned this pull request Aug 23, 2023

Add support for Soroban RPC server. #485

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for calling Soroban RPC server. #492

Added support for calling Soroban RPC server. #492

overcat commented Jul 21, 2023 •

edited

Loading

sreuland commented Jul 21, 2023

sreuland commented Jul 21, 2023

overcat commented Jul 22, 2023

sreuland Jul 27, 2023

overcat Jul 31, 2023

sreuland Jul 27, 2023

sreuland Jul 27, 2023

sreuland Jul 27, 2023

overcat Jul 31, 2023

sreuland Jul 27, 2023

overcat Jul 31, 2023

sreuland Jul 27, 2023

overcat Jul 31, 2023

sreuland Aug 4, 2023

sreuland Jul 27, 2023

sreuland Jul 27, 2023

overcat Jul 31, 2023

sreuland Jul 27, 2023

overcat Jul 28, 2023

overcat Jul 28, 2023

sreuland Jul 28, 2023

overcat Jul 28, 2023 •

edited

Loading

overcat Jul 31, 2023

sreuland Jul 27, 2023

overcat Jul 31, 2023

overcat commented Jul 27, 2023

overcat commented Jul 28, 2023

overcat commented Jul 28, 2023

overcat commented Jul 31, 2023

		@@ -0,0 +1,14 @@
		package org.stellar.sdk;

		public class LedgerEntryNotFoundException extends Exception {

Added support for calling Soroban RPC server. #492

Added support for calling Soroban RPC server. #492

Conversation

overcat commented Jul 21, 2023 • edited Loading

sreuland commented Jul 21, 2023

sreuland commented Jul 21, 2023

overcat commented Jul 22, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

overcat Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

overcat commented Jul 27, 2023

overcat commented Jul 28, 2023

overcat commented Jul 28, 2023

overcat commented Jul 31, 2023

overcat commented Jul 21, 2023 •

edited

Loading

overcat Jul 28, 2023 •

edited

Loading