Merge branch 'main' into xls_80d

Author: ckeshava

.darglint

@@ -11,9 +11,14 @@ ignore = D205,D212,D415,E203,W503
 # https://black.readthedocs.io/en/stable/the_black_code_style.html#line-length
 max-line-length = 88
 
+# This is for pydocstyle - to allow docstrings in __init__ functions
+# This rule was used for easier migration from darglint
+# TODO: remove this rule
+allow-init-docstring=True
+
 per-file-ignores =
   # For tests, disable type annotation and docstring linting.
-  tests/*: ANN D DAR
+  tests/*: ANN D DOC
 
 # Select other tools to enable.
 
@@ -25,7 +30,7 @@ per-file-ignores =
 
 # D enables docstrings warnings from pydocstyle.
 
-# DAR enables docstring style linting via darglint.
+# DOC enables docstring style linting via pydoclint.
 
 # F are errors reported by pyflakes, a tool which parses source files
 # and finds invalid Python code.
@@ -35,4 +40,4 @@ per-file-ignores =
 
 # W and E are warnings and errors reported by pycodestyle, which checks
 # your Python code against some of the style conventions in PEP 8.
-select = ABS,ANN,DAR,BLK,D,E,F,I,W
+select = ABS,ANN,DOC,BLK,D,E,F,I,W

.flake8

@@ -49,7 +49,7 @@ jobs:
 
       - name: Lint
         run: |
-          poetry run flake8 xrpl tests snippets --darglint-ignore-regex="^_(.*)"
+          poetry run poe lint
 
       - name: Type-check
         run: |

.github/workflows/unit_test.yml

@@ -21,7 +21,7 @@ repos:
         types: [python]
       - id: flake8
         name: flake8
-        entry: poetry run flake8 --darglint-ignore-regex="^_(.*)"
+        entry: poetry run flake8
         language: system
         types: [python]
       - id: mypy

.pre-commit-config.yaml

@@ -27,5 +27,10 @@
       "source.organizeImports": "always"
     }
   },
-  "isort.args": ["--profile", "black"]
+  "isort.args": [
+    "--profile",
+    "black"
+  ],
+  "python.testing.pytestEnabled": false,
+  "python.testing.unittestEnabled": true
 }

.vscode/settings.json

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Add support for the `PermissionedDomains` feature
+- Support `AMMClawback` amendment (XLS-73d).
+- Support for the `simulate` RPC ([XLS-69](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0069d-simulate))
+
+### Fixed
+- `Sign`, `SignFor`, and `SignAndSubmit` methods now properly handle WebSocket clients
 
 ## [4.0.0] - 2024-12-23
 
@@ -46,6 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `nfts_by_issuer` clio-only API definition
 - Included `ctid` field in the `tx` request.
 - `from_xrpl` method accepts input dictionary keys exclusively in the proper XRPL format.
+- Support for  DynamicNFT amendment (XLS-46)
 
 ### Fixed
 - Added support for `XChainModifyBridge` flag maps (fixing an issue with `NFTokenCreateOffer` flag names)

CHANGELOG.md

@@ -66,7 +66,7 @@ To run linting and other checks, `xrpl-py` uses [`pre-commit`](https://pre-commi
 To run the linter:
 
 ```bash
-poetry run flake8 xrpl tests --darglint-ignore-regex="^_(.*)"
+poetry run poe lint
 ```
 
 ### Running Tests

CONTRIBUTING.md

@@ -28,7 +28,7 @@ base58 = "^2.1.0"
 ECPy = "^1.2.5"
 typing-extensions = "^4.2.0"
 httpx = ">=0.18.1,<0.29.0"
-websockets = ">=11,<14"
+websockets = ">=11"
 Deprecated = "^1.2.13"
 types-Deprecated = "^1.2.9"
 pycryptodome = "^3.16.0"
@@ -43,7 +43,10 @@ isort = "^5.11.5"
 flake8-isort = "^6.0.0"
 flake8-annotations = "^3.1.1"
 flake8-absolute-import = "^1.0"
-darglint = "^1.5.8"
+pydoclint = [
+    { version = "<=0.5.12", python = "<3.9" },
+    { version = "^0.5.13", python = ">=3.9" }
+]
 sphinx-rtd-theme = "^3.0.2"
 aiounittest = "^1.4.0"
 coverage = "^7.2.7"
@@ -74,6 +77,7 @@ precision = 2
 [tool.poe.tasks]
 test_unit = "coverage run -m unittest discover tests/unit"
 test_integration = "coverage run -m unittest discover tests/integration"
+lint = "poetry run flake8 xrpl tests snippets"
 
 [tool.poe.tasks.test]
 cmd = "python3 -m unittest ${FILE_PATHS}"

poetry.lock

@@ -218,6 +218,7 @@ def test_async_and_sync(
     websockets_only=False,
     num_retries=1,
     use_testnet=False,
+    async_only=False,
 ):
     def decorator(test_function):
         lines = _get_non_decorator_code(test_function)
@@ -235,15 +236,18 @@ def decorator(test_function):
         first_line = lines[0]
         sync_code += first_line.replace("    async def ", "").replace(":", "")
 
-        sync_modules_to_import = {}
-        if modules is not None:
-            for module_str in modules:
-                function = module_str.split(".")[-1]
-                location = module_str[: -1 * len(function) - 1]
-                module = getattr(importlib.import_module(location), function)
-                sync_modules_to_import[function] = module
-
-        all_modules = {**original_globals, **globals(), **sync_modules_to_import}
+        if not async_only:
+            sync_modules_to_import = {}
+            if modules is not None:
+                for module_str in modules:
+                    function = module_str.split(".")[-1]
+                    location = module_str[: -1 * len(function) - 1]
+                    module = getattr(importlib.import_module(location), function)
+                    sync_modules_to_import[function] = module
+
+            all_modules = {**original_globals, **globals(), **sync_modules_to_import}
+        else:
+            all_modules = {**original_globals, **globals()}
         # NOTE: passing `globals()` into `exec` is really bad practice and not safe at
         # all, but in this case it's fine because it's only running test code
 
@@ -290,14 +294,16 @@ def modified_test(self):
                     asyncio.run(
                         _run_async_test(self, _get_client(True, True, use_testnet), 1)
                     )
-                with self.subTest(version="sync", client="json"):
-                    _run_sync_test(self, _get_client(False, True, use_testnet), 2)
+                if not async_only:
+                    with self.subTest(version="sync", client="json"):
+                        _run_sync_test(self, _get_client(False, True, use_testnet), 2)
             with self.subTest(version="async", client="websocket"):
                 asyncio.run(
                     _run_async_test(self, _get_client(True, False, use_testnet), 3)
                 )
-            with self.subTest(version="sync", client="websocket"):
-                _run_sync_test(self, _get_client(False, False, use_testnet), 4)
+            if not async_only:
+                with self.subTest(version="sync", client="websocket"):
+                    _run_sync_test(self, _get_client(False, False, use_testnet), 4)
 
         return modified_test
 
@@ -315,6 +321,7 @@ def _get_non_decorator_code(function):
 
 def create_amm_pool(
     client: SyncClient = JSON_RPC_CLIENT,
+    enable_amm_clawback: bool = False,
 ) -> Dict[str, Any]:
     issuer_wallet = Wallet.create()
     fund_wallet(issuer_wallet)
@@ -331,6 +338,16 @@ def create_amm_pool(
         issuer_wallet,
     )
 
+    # The below flag is required for AMMClawback tests
+    if enable_amm_clawback:
+        sign_and_reliable_submission(
+            AccountSet(
+                account=issuer_wallet.classic_address,
+                set_flag=AccountSetAsfFlag.ASF_ALLOW_TRUSTLINE_CLAWBACK,
+            ),
+            issuer_wallet,
+        )
+
     sign_and_reliable_submission(
         TrustSet(
             account=lp_wallet.classic_address,
@@ -382,11 +399,13 @@ def create_amm_pool(
         "asset": asset,
         "asset2": asset2,
         "issuer_wallet": issuer_wallet,
+        "lp_wallet": lp_wallet,
     }
 
 
 async def create_amm_pool_async(
     client: AsyncClient = ASYNC_JSON_RPC_CLIENT,
+    enable_amm_clawback: bool = False,
 ) -> Dict[str, Any]:
     issuer_wallet = Wallet.create()
     await fund_wallet_async(issuer_wallet)
@@ -403,6 +422,16 @@ async def create_amm_pool_async(
         issuer_wallet,
     )
 
+    # The below flag is required for AMMClawback tests
+    if enable_amm_clawback:
+        await sign_and_reliable_submission_async(
+            AccountSet(
+                account=issuer_wallet.classic_address,
+                set_flag=AccountSetAsfFlag.ASF_ALLOW_TRUSTLINE_CLAWBACK,
+            ),
+            issuer_wallet,
+        )
+
     await sign_and_reliable_submission_async(
         TrustSet(
             account=lp_wallet.classic_address,
@@ -454,6 +483,7 @@ async def create_amm_pool_async(
         "asset": asset,
         "asset2": asset2,
         "issuer_wallet": issuer_wallet,
+        "lp_wallet": lp_wallet,
     }