Merge pull request #1748 from rikublock/riku/b0079-ms2

[Bounty 0079] Python code samples for require destination tags

content/_code-samples/get-started/py/base-async.py

@@ -0,0 +1,16 @@
+import asyncio
+from xrpl.asyncio.clients import AsyncWebsocketClient
+
+
+async def main():
+    # Define the network client
+    async with AsyncWebsocketClient("wss://s.altnet.rippletest.net:51233") as client:
+        # inside the context the client is open
+
+        # ... custom code goes here
+
+    # after exiting the context, the client is closed
+
+
+asyncio.run(main())
+

content/_code-samples/require-destination-tags/py/require-destination-tags.py

@@ -1,48 +1,60 @@
-from xrpl.clients import JsonRpcClient
+import asyncio
-from xrpl.models.transactions import AccountSet, AccountSetFlag
+
-from xrpl.transaction import safe_sign_and_autofill_transaction, submit_transaction
+from xrpl.asyncio.clients import AsyncWebsocketClient
-from xrpl.wallet import generate_faucet_wallet
+from xrpl.asyncio.transaction import (
+    safe_sign_and_autofill_transaction,
+    send_reliable_submission,
+)
+from xrpl.asyncio.wallet import generate_faucet_wallet
 from xrpl.models.requests import AccountInfo
-
+from xrpl.models.transactions import (
-# Stand-alone code sample for the "Require Destination Tags" tutorial:
+    AccountSet,
-# https://xrpl.org/require-destination-tags.html
+    AccountSetFlag,
-
-lsfRequireDestTag = 131072
-
-# Connect to a testnet node
-print("Connecting to Testnet...")
-JSON_RPC_URL = "https://s.altnet.rippletest.net:51234/"
-client = JsonRpcClient(JSON_RPC_URL)
-
-# Get credentials from the Testnet Faucet
-print("Requesting address from the Testnet faucet...")
-test_wallet = generate_faucet_wallet(client=client)
-myAddr = test_wallet.classic_address
-
-# Construct AccountSet transaction
-tx = AccountSet(
-    account=myAddr,
-    set_flag=AccountSetFlag.ASF_REQUIRE_DEST
 )
-print(f"Prepared transaction: {tx}")
 
-# Sign the transaction
-my_tx_payment_signed = safe_sign_and_autofill_transaction(tx, wallet=test_wallet, client=client)
-print(f"Transaction Hash: {my_tx_payment_signed.txn_signature}")
 
-# Send the transaction to the node
+async def main() -> int:
-print(f"Enabling Require Destination Tag flag (asfRequireDest) on {myAddr}")
+    # Define the network client
-submit_tx = submit_transaction(client=client, transaction=my_tx_payment_signed)
+    async with AsyncWebsocketClient("wss://s.altnet.rippletest.net:51233") as client:
-submit_tx = submit_tx.result["engine_result"]
+        # Get credentials from the Testnet Faucet -----------------------------------
-print(f"Submit result: {submit_tx}")
+        print("Requesting addresses from the Testnet faucet...")
+        wallet = await generate_faucet_wallet(client, debug=True)
 
-# Verify Account Settings
+        # Send AccountSet transaction -----------------------------------------------
-get_acc_flag = AccountInfo(
+        tx = AccountSet(
-    account=myAddr
+            account=wallet.classic_address,
-)
+            set_flag=AccountSetFlag.ASF_REQUIRE_DEST,
-response = client.request(get_acc_flag)
+        )
+
+        # Sign and autofill the transaction (ready to submit)
+        signed_tx = await safe_sign_and_autofill_transaction(tx, wallet, client)
+        print("Transaction hash:", signed_tx.get_hash())
+
+        # Submit the transaction and wait for response (validated or rejected)
+        print("Submitting transaction...")
+        submit_result = await send_reliable_submission(signed_tx, client)
+        print("Submit result:", submit_result)
+
+        # Confirm Account Settings --------------------------------------------------
+        print("Requesting account information...")
+        account_info = await client.request(
+            AccountInfo(
+                account=wallet.classic_address,
+                ledger_index="validated",
+            )
+        )
+
+        # Verify that the AccountRoot lsfRequireDestTag flag is set
+        flags = account_info.result["account_data"]["Flags"]
+        if flags & 0x00020000 != 0:
+            print(f"Require Destination Tag for account {wallet.classic_address} is enabled.")
+        else:
+            print(f"Require Destination Tag for account {wallet.classic_address} is DISABLED.")
+
+    # End main()
+    return 0
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
 
-if response.result['account_data']['Flags'] & lsfRequireDestTag:
-    print("Require Destination Tag is ENABLED.")
-else:
-    print("Require Destination Tag is DISABLED.")

content/tutorials/manage-account-settings/require-destination-tags.md

@@ -19,13 +19,20 @@ This tutorial demonstrates how to enable the Require Destination Tag flag on you
 ## Prerequisites
 
 - You need a funded XRP Ledger account, with an address, secret key, and some XRP. For production, you can use the same address and secret consistently. For this tutorial, you can generate new test credentials as needed.
-- You need a connection to the XRP Ledger network.
+- You need a connection to the XRP Ledger network. As shown in this tutorial, you can use public servers for testing.
-
+- You should be familiar with the Getting Started instructions for your preferred client library. This page provides examples for the following:
-This page provides examples that use [xrpl.js](get-started-using-javascript.html) in the web browser, so you can read along and use the interactive steps without any setup.
+    - **JavaScript** with the [xrpl.js library](https://github.com/XRPLF/xrpl.js/). See [Get Started Using JavaScript](get-started-using-javascript.html) for setup steps.
+    - **Python** with the [`xrpl-py` library](https://xrpl-py.readthedocs.io/). See [Get Started using Python](get-started-using-python.html) for setup steps.
+    - You can also read along and use the interactive steps in your browser without any setup.
 
 <!-- Source for this specific tutorial's interactive bits: -->
 <script type="application/javascript" src="assets/js/tutorials/require-destination-tags.js"></script>
 
+## Example Code
+
+Complete sample code for all the steps of these tutorials is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
+
+- See [Code Samples: Require Destination Tags](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/require-destination-tags/) in the source repository for this website.
 
 ## Steps
 {% set n = cycler(* range(1,99)) %}
@@ -42,8 +49,18 @@ When you're [building production-ready software](production-readiness.html), you
 
 You must be connected to the network to submit transactions to it. The following code shows how to connect to a public XRP Ledger Testnet server a supported [client library](client-libraries.html):
 
+<!-- MULTICODE_BLOCK_START -->
+
+_JavaScript_
+
 {{ include_code("_code-samples/get-started/js/base.js", language="js") }}
 
+_Python_
+
+{{ include_code("_code-samples/get-started/py/base-async.py", language="py") }}
+
+<!-- MULTICODE_BLOCK_END -->
+
 For this tutorial, click the following button to connect:
 
 {% include '_snippets/interactive-tutorials/connect-step.md' %}
@@ -60,6 +77,10 @@ _JavaScript_
 
 {{ include_code("_code-samples/require-destination-tags/js/require-destination-tags.js", language="js", start_with="// Send AccountSet", end_before="// Confirm Account") }}
 
+_Python_
+
+{{ include_code("_code-samples/require-destination-tags/py/require-destination-tags.py", language="py", start_with="# Send AccountSet", end_before="# Confirm Account") }}
+
 <!-- MULTICODE_BLOCK_END -->
 
 {{ start_step("Send AccountSet") }}
@@ -89,6 +110,10 @@ _JavaScript_
 
 {{ include_code("_code-samples/require-destination-tags/js/require-destination-tags.js", language="js", start_with="// Confirm Account", end_before="// End main()") }}
 
+_Python_
+
+{{ include_code("_code-samples/require-destination-tags/py/require-destination-tags.py", language="py", start_with="# Confirm Account", end_before="# End main()") }}
+
 <!-- MULTICODE_BLOCK_END -->