WIP

CHANGELOG.md

@@ -3,6 +3,9 @@ Release History
 
 ### Pending
 
+#### Update
+- feat: add `stellar_sdk.contract.ContractClient` and `stellar_sdk.contract.ContractClientAsync`, this greatly reduces the difficulty of calling contracts, and you can learn more through the documentation and [examples](https://github.com/StellarCN/py-stellar-base/blob/main/examples/soroban_invoke_contract_function.py). ([#998](https://github.com/StellarCN/py-stellar-base/pull/998))
+
 ### Version 12.0.0-beta3
 
 Released on November 14, 2024

docs/en/api.rst

@@ -292,7 +292,39 @@ Response
 .. autoclass:: stellar_sdk.client.response.Response
    :members:
 
+Contract
+^^^^^^^^
 
+ContractClient
+---------------
+
+.. autoclass:: stellar_sdk.contract.ContractClient
+   :members:
+
+AssembledTransaction
+--------------------
+
+.. autoclass:: stellar_sdk.contract.AssembledTransaction
+   :members:
+
+
+ContractClientAsync
+-------------------
+
+.. autoclass:: stellar_sdk.contract.ContractClientAsync
+   :members:
+
+AssembledTransactionAsync
+-------------------------
+
+.. autoclass:: stellar_sdk.contract.AssembledTransactionAsync
+   :members:
+
+Exceptions
+----------
+
+.. automodule:: stellar_sdk.contract.exceptions
+   :members:
 
 Exceptions
 ^^^^^^^^^^

examples/soroban_invoke_contract_function.py

@@ -26,6 +26,9 @@ def parse_result_xdr(result):
 
 
 te: AssembledTransaction[List[str]] = ContractClient(
-    contract_id, rpc_server_url, network_passphrase
-).invoke("hello", [scval.to_string("world")])
-te.result()
+    contract_id, rpc_server_url, network_passphrase,
+).invoke("hello", [scval.to_string("world")], parse_result_xdr_fn=parse_result_xdr)
+print(f"Result from simulation: {te.result}")
+
+# hello is a read-only function, so we don't need to sign and submit the transaction.
+# You can check `soroban_auth_atomic_swap.py` for an example of a function that requires signing and submitting.

stellar_sdk/contract/assembled_transaction.py

@@ -30,10 +30,10 @@ class AssembledTransaction(Generic[T]):
     """A class representing an assembled Soroban transaction that can be simulated and sent.
 
     The lifecycle of a transaction typically follows these steps:
-    1. Construct the transaction (usually via a Client)
-    2. Simulate the transaction
-    3. Sign the transaction
-    4. Submit the transaction
+        1. Construct the transaction (usually via a Client)
+        2. Simulate the transaction
+        3. Sign the transaction
+        4. Submit the transaction
 
     :param transaction_builder: The transaction builder including the operation to invoke
     :param server: The Soroban server instance to use

stellar_sdk/contract/assembled_transaction_async.py

@@ -30,10 +30,10 @@ class AssembledTransactionAsync(Generic[T]):
     """A class representing an assembled Soroban transaction that can be simulated and sent.
 
     The lifecycle of a transaction typically follows these steps:
-    1. Construct the transaction (usually via a Client)
-    2. Simulate the transaction
-    3. Sign the transaction
-    4. Submit the transaction
+        1. Construct the transaction (usually via a Client)
+        2. Simulate the transaction
+        3. Sign the transaction
+        4. Submit the transaction
 
     :param transaction_builder: The transaction builder including the operation to invoke
     :param server: The Soroban server instance to use