examples: add restore footprint and bump footprint expiration example…

…s. (#771)

examples/soroban_auth_with_transaction_invoke.py

@@ -8,7 +8,7 @@
 from stellar_sdk import Keypair, Network, SorobanServer, TransactionBuilder, scval
 from stellar_sdk import xdr as stellar_xdr
 from stellar_sdk.exceptions import PrepareTransactionException
-from stellar_sdk.soroban_rpc import GetTransactionStatus
+from stellar_sdk.soroban_rpc import GetTransactionStatus, SendTransactionStatus
 
 rpc_server_url = "https://rpc-futurenet.stellar.org:443/"
 soroban_server = SorobanServer(rpc_server_url)
@@ -46,6 +46,8 @@
 
 send_transaction_data = soroban_server.send_transaction(tx)
 print(f"sent transaction: {send_transaction_data}")
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
 
 while True:
     print("waiting for transaction to be confirmed...")

examples/soroban_bump_footprint_expiration.py

@@ -0,0 +1,72 @@
+"""This example shows how to bump footprint expiration.
+
+See https://soroban.stellar.org/docs/fundamentals-and-concepts/state-expiration#bumpfootprintexpirationop
+"""
+import time
+
+from stellar_sdk import (
+    Address,
+    Keypair,
+    Network,
+    SorobanDataBuilder,
+    SorobanServer,
+    TransactionBuilder,
+)
+from stellar_sdk import xdr as stellar_xdr
+from stellar_sdk.exceptions import PrepareTransactionException
+from stellar_sdk.soroban_rpc import GetTransactionStatus
+
+secret = "SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV"
+rpc_server_url = "https://rpc-futurenet.stellar.org:443/"
+contract_id = "CBQHNAXSI55GX2GN6D67GK7BHVPSLJUGZQEU7WJ5LKR5PNUCGLIMAO4K"
+network_passphrase = Network.FUTURENET_NETWORK_PASSPHRASE
+
+kp = Keypair.from_secret(secret)
+soroban_server = SorobanServer(rpc_server_url)
+source = soroban_server.load_account(kp.public_key)
+
+ledger_key = stellar_xdr.LedgerKey(
+    stellar_xdr.LedgerEntryType.CONTRACT_DATA,
+    contract_data=stellar_xdr.LedgerKeyContractData(
+        contract=Address(contract_id).to_xdr_sc_address(),
+        key=stellar_xdr.SCVal(stellar_xdr.SCValType.SCV_LEDGER_KEY_CONTRACT_INSTANCE),
+        durability=stellar_xdr.ContractDataDurability.PERSISTENT,
+        body_type=stellar_xdr.ContractEntryBodyType.DATA_ENTRY,
+    ),
+)
+soroban_data = SorobanDataBuilder().set_read_only([ledger_key]).build()
+
+tx = (
+    TransactionBuilder(source, network_passphrase, base_fee=50000)
+    .set_timeout(300)
+    .append_bump_footprint_expiration_op(ledgers_to_expire=101)
+    .set_soroban_data(soroban_data)
+    .build()
+)
+print(f"XDR: {tx.to_xdr()}")
+
+try:
+    tx = soroban_server.prepare_transaction(tx)
+except PrepareTransactionException as e:
+    print(f"Got exception: {e.simulate_transaction_response}")
+    raise e
+
+tx.sign(kp)
+print(f"Signed XDR: {tx.to_xdr()}")
+
+send_transaction_data = soroban_server.send_transaction(tx)
+print(f"sent transaction: {send_transaction_data}")
+
+while True:
+    print("waiting for transaction to be confirmed...")
+    get_transaction_data = soroban_server.get_transaction(send_transaction_data.hash)
+    if get_transaction_data.status != GetTransactionStatus.NOT_FOUND:
+        break
+    time.sleep(3)
+
+print(f"transaction: {get_transaction_data}")
+
+if get_transaction_data.status == GetTransactionStatus.SUCCESS:
+    print(f"transaction success")
+else:
+    print(f"Transaction failed: {get_transaction_data.result_xdr}")

examples/soroban_deploy_contract.py

@@ -5,7 +5,7 @@
 from stellar_sdk import Keypair, Network, SorobanServer, StrKey, TransactionBuilder
 from stellar_sdk import xdr as stellar_xdr
 from stellar_sdk.exceptions import PrepareTransactionException
-from stellar_sdk.soroban_rpc import GetTransactionStatus
+from stellar_sdk.soroban_rpc import GetTransactionStatus, SendTransactionStatus
 
 # TODO: You need to replace the following parameters according to the actual situation
 secret = "SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV"
@@ -40,6 +40,8 @@
 tx.sign(kp)
 send_transaction_data = soroban_server.send_transaction(tx)
 print(f"sent transaction: {send_transaction_data}")
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
 
 while True:
     print("waiting for transaction to be confirmed...")
@@ -85,6 +87,8 @@
 tx.sign(kp)
 
 send_transaction_data = soroban_server.send_transaction(tx)
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
 print(f"sent transaction: {send_transaction_data}")
 
 while True:

examples/soroban_deploy_create_wrapped_token_contract.py

@@ -13,7 +13,7 @@
 )
 from stellar_sdk import xdr as stellar_xdr
 from stellar_sdk.exceptions import PrepareTransactionException
-from stellar_sdk.soroban_rpc import GetTransactionStatus
+from stellar_sdk.soroban_rpc import GetTransactionStatus, SendTransactionStatus
 
 # TODO: You need to replace the following parameters according to the actual situation
 secret = "SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV"
@@ -44,6 +44,8 @@
 
 send_transaction_data = soroban_server.send_transaction(tx)
 print(f"sent transaction: {send_transaction_data}")
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
 
 while True:
     print("waiting for transaction to be confirmed...")

examples/soroban_invoke_contract_function.py

@@ -15,7 +15,7 @@
 from stellar_sdk import Keypair, Network, SorobanServer, TransactionBuilder, scval
 from stellar_sdk import xdr as stellar_xdr
 from stellar_sdk.exceptions import PrepareTransactionException
-from stellar_sdk.soroban_rpc import GetTransactionStatus
+from stellar_sdk.soroban_rpc import GetTransactionStatus, SendTransactionStatus
 
 # TODO: You need to replace the following parameters according to the actual situation
 secret = "SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV"
@@ -51,7 +51,8 @@
 
 send_transaction_data = soroban_server.send_transaction(tx)
 print(f"sent transaction: {send_transaction_data}")
-
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
 while True:
     print("waiting for transaction to be confirmed...")
     get_transaction_data = soroban_server.get_transaction(send_transaction_data.hash)

examples/soroban_payment.py

@@ -7,7 +7,7 @@
 from stellar_sdk import Keypair, Network, SorobanServer, TransactionBuilder, scval
 from stellar_sdk import xdr as stellar_xdr
 from stellar_sdk.exceptions import PrepareTransactionException
-from stellar_sdk.soroban_rpc import GetTransactionStatus
+from stellar_sdk.soroban_rpc import GetTransactionStatus, SendTransactionStatus
 
 rpc_server_url = "https://rpc-futurenet.stellar.org:443/"
 soroban_server = SorobanServer(rpc_server_url)
@@ -51,7 +51,8 @@
 
 send_transaction_data = soroban_server.send_transaction(tx)
 print(f"sent transaction: {send_transaction_data}")
-
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
 while True:
     print("waiting for transaction to be confirmed...")
     get_transaction_data = soroban_server.get_transaction(send_transaction_data.hash)

examples/soroban_restore_footprint.py

@@ -0,0 +1,75 @@
+"""This example shows how to restore footprint.
+
+See https://soroban.stellar.org/docs/fundamentals-and-concepts/state-expiration#restorefootprintop
+"""
+import time
+
+from stellar_sdk import (
+    Keypair,
+    Network,
+    SorobanDataBuilder,
+    SorobanServer,
+    TransactionBuilder,
+)
+from stellar_sdk import xdr as stellar_xdr
+from stellar_sdk.address import Address
+from stellar_sdk.exceptions import PrepareTransactionException
+from stellar_sdk.soroban_rpc import GetTransactionStatus, SendTransactionStatus
+
+secret = "SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV"
+rpc_server_url = "https://rpc-futurenet.stellar.org:443/"
+contract_id = "CAEZUQ3JTKBLIYFZEHKSK5X2K3MGU66B4F6MJFEKZKF6ZFRWBERV3BKF"
+network_passphrase = Network.STANDALONE_NETWORK_PASSPHRASE
+
+kp = Keypair.from_secret(secret)
+soroban_server = SorobanServer(rpc_server_url)
+source = soroban_server.load_account(kp.public_key)
+
+ledger_key = stellar_xdr.LedgerKey(
+    stellar_xdr.LedgerEntryType.CONTRACT_DATA,
+    contract_data=stellar_xdr.LedgerKeyContractData(
+        contract=Address(contract_id).to_xdr_sc_address(),
+        key=stellar_xdr.SCVal(stellar_xdr.SCValType.SCV_LEDGER_KEY_CONTRACT_INSTANCE),
+        durability=stellar_xdr.ContractDataDurability.PERSISTENT,
+        body_type=stellar_xdr.ContractEntryBodyType.DATA_ENTRY,
+    ),
+)
+soroban_data = SorobanDataBuilder().set_read_only([ledger_key]).build()
+
+tx = (
+    TransactionBuilder(source, network_passphrase, base_fee=50000)
+    .set_timeout(300)
+    .append_restore_footprint_op()
+    .set_soroban_data(soroban_data)
+    .build()
+)
+print(f"XDR: {tx.to_xdr()}")
+
+try:
+    tx = soroban_server.prepare_transaction(tx)
+except PrepareTransactionException as e:
+    print(f"Got exception: {e.simulate_transaction_response}")
+    raise e
+
+tx.sign(kp)
+print(f"Signed XDR: {tx.to_xdr()}")
+
+send_transaction_data = soroban_server.send_transaction(tx)
+print(f"sent transaction: {send_transaction_data}")
+
+if send_transaction_data.status != SendTransactionStatus.PENDING:
+    raise Exception("send transaction failed")
+
+while True:
+    print("waiting for transaction to be confirmed...")
+    get_transaction_data = soroban_server.get_transaction(send_transaction_data.hash)
+    if get_transaction_data.status != GetTransactionStatus.NOT_FOUND:
+        break
+    time.sleep(3)
+
+print(f"transaction: {get_transaction_data}")
+
+if get_transaction_data.status == GetTransactionStatus.SUCCESS:
+    print(f"transaction success")
+else:
+    print(f"Transaction failed: {get_transaction_data.result_xdr}")