Merge branch 'main' into definitions-generation

mvadari · web-flow · commit 63aface82137 · 2025-02-06T11:50:32.000-08:00
diff --git a/.darglint b/.darglint
diff --git a/.flake8 b/.flake8
@@ -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
diff --git a/.github/workflows/unit_test.yml b/.github/workflows/unit_test.yml
@@ -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: |
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -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
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,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)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.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
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -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}"
diff --git a/tests/unit/models/transactions/test_better_transaction_flags.py b/tests/unit/models/transactions/test_better_transaction_flags.py
@@ -87,6 +87,7 @@ def test_nftoken_mint_flags(self):
                 TF_ONLY_XRP=True,
                 TF_TRANSFERABLE=True,
                 TF_TRUSTLINE=True,
+                TF_MUTABLE=True,
             ),
         )
         self.assertTrue(actual.has_flag(flag=0x00000001))
diff --git a/tests/unit/models/transactions/test_nftoken_modify.py b/tests/unit/models/transactions/test_nftoken_modify.py
@@ -0,0 +1,82 @@
+from unittest import TestCase
+
+from xrpl.models.exceptions import XRPLModelException
+from xrpl.models.transactions.nftoken_modify import NFTokenModify
+
+_ACCOUNT = "r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ"
+_SEQUENCE = 19048
+_FEE = "0.00001"
+_URI = "ABC"
+_NFTOKEN_ID = "00090032B5F762798A53D543A014CAF8B297CFF8F2F937E844B17C9E00000003"
+
+
+class TestNFTokenModify(TestCase):
+    def test_nftoken_miss(self):
+        with self.assertRaises(XRPLModelException) as error:
+            NFTokenModify(
+                account=_ACCOUNT,
+                owner=_ACCOUNT,
+                sequence=_SEQUENCE,
+                fee=_FEE,
+                uri=_URI,
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'nftoken_id': 'nftoken_id is not set'}",
+        )
+
+    def test_uri_empty(self):
+        with self.assertRaises(XRPLModelException) as error:
+            NFTokenModify(
+                account=_ACCOUNT,
+                owner=_ACCOUNT,
+                sequence=_SEQUENCE,
+                fee=_FEE,
+                nftoken_id=_NFTOKEN_ID,
+                uri="",
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'uri': 'URI must not be empty string'}",
+        )
+
+    def test_uri_too_long(self):
+        with self.assertRaises(XRPLModelException) as error:
+            NFTokenModify(
+                account=_ACCOUNT,
+                owner=_ACCOUNT,
+                sequence=_SEQUENCE,
+                fee=_FEE,
+                nftoken_id=_NFTOKEN_ID,
+                uri=_URI * 1000,
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'uri': 'URI must not be longer than 512 characters'}",
+        )
+
+    def test_uri_not_hex(self):
+        with self.assertRaises(XRPLModelException) as error:
+            NFTokenModify(
+                account=_ACCOUNT,
+                owner=_ACCOUNT,
+                sequence=_SEQUENCE,
+                fee=_FEE,
+                nftoken_id=_NFTOKEN_ID,
+                uri="not-hex-encoded",
+            )
+        self.assertEqual(
+            error.exception.args[0],
+            "{'uri': 'URI must be encoded in hex'}",
+        )
+
+    def test_valid(self):
+        obj = NFTokenModify(
+            account=_ACCOUNT,
+            owner=_ACCOUNT,
+            sequence=_SEQUENCE,
+            fee=_FEE,
+            uri=_URI,
+            nftoken_id=_NFTOKEN_ID,
+        )
+        self.assertTrue(obj.is_valid())
diff --git a/xrpl/core/binarycodec/types/serialized_type.py b/xrpl/core/binarycodec/types/serialized_type.py
@@ -16,7 +16,12 @@ class SerializedType(ABC):
     """The base class for all binary codec field types."""
 
     def __init__(self: Self, buffer: bytes = bytes()) -> None:
-        """Construct a new SerializedType."""
+        """
+        Construct a new SerializedType.
+
+        Args:
+            buffer: The buffer containing the data for the SerializedType.
+        """
         self.buffer = buffer
 
     @classmethod
@@ -86,5 +91,10 @@ def to_hex(self: Self) -> str:
         return self.buffer.hex().upper()
 
     def __len__(self: Self) -> int:
-        """Get the length of a SerializedType's bytes."""
+        """
+        Get the length of a SerializedType's bytes.
+
+        Returns:
+            The number of bytes.
+        """
         return len(self.buffer)
diff --git a/xrpl/core/binarycodec/types/st_object.py b/xrpl/core/binarycodec/types/st_object.py
@@ -59,9 +59,9 @@ def _handle_xaddress(field: str, xaddress: str) -> Dict[str, Union[str, int]]:
     return {field: classic_address}
 
 
+# all of these fields have enum values that are used for serialization
+# converts the string name to the corresponding enum code
 def _str_to_enum(field: str, value: str) -> Union[str, int]:
-    # all of these fields have enum values that are used for serialization
-    # converts the string name to the corresponding enum code
     if field == "TransactionType":
         return get_transaction_type_code(value)
     if field == "TransactionResult":
@@ -71,8 +71,8 @@ def _str_to_enum(field: str, value: str) -> Union[str, int]:
     return value
 
 
+# reverse of the above function
 def _enum_to_str(field: str, value: int) -> Union[str, int]:
-    # reverse of the above function
     if field == "TransactionType":
         return get_transaction_type_name(value)
     if field == "TransactionResult":
diff --git a/xrpl/models/transactions/__init__.py b/xrpl/models/transactions/__init__.py
@@ -67,6 +67,7 @@
     NFTokenMintFlag,
     NFTokenMintFlagInterface,
 )
+from xrpl.models.transactions.nftoken_modify import NFTokenModify
 from xrpl.models.transactions.offer_cancel import OfferCancel
 from xrpl.models.transactions.offer_create import (
     OfferCreate,
@@ -161,6 +162,7 @@
     "NFTokenMint",
     "NFTokenMintFlag",
     "NFTokenMintFlagInterface",
+    "NFTokenModify",
     "OfferCancel",
     "OfferCreate",
     "OfferCreateFlag",
diff --git a/xrpl/models/transactions/nftoken_mint.py b/xrpl/models/transactions/nftoken_mint.py
@@ -46,6 +46,11 @@ class NFTokenMintFlag(int, Enum):
     issuer.
     """
 
+    TF_MUTABLE = 0x00000010
+    """
+    If set, indicates that this NFT's URI can be modified.
+    """
+
 
 class NFTokenMintFlagInterface(FlagInterface):
     """Transaction Flags for an NFTokenMint Transaction."""
@@ -54,6 +59,7 @@ class NFTokenMintFlagInterface(FlagInterface):
     TF_ONLY_XRP: bool
     TF_TRUSTLINE: bool
     TF_TRANSFERABLE: bool
+    TF_MUTABLE: bool
 
 
 @require_kwargs_on_init
diff --git a/xrpl/models/transactions/nftoken_modify.py b/xrpl/models/transactions/nftoken_modify.py
diff --git a/xrpl/models/transactions/types/transaction_type.py b/xrpl/models/transactions/types/transaction_type.py

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,7 @@ def test_nftoken_mint_flags(self):`
`87`	`87`	`TF_ONLY_XRP=True,`
`88`	`88`	`TF_TRANSFERABLE=True,`
`89`	`89`	`TF_TRUSTLINE=True,`
	`90`	`+ TF_MUTABLE=True,`
`90`	`91`	`),`
`91`	`92`	`)`
`92`	`93`	`self.assertTrue(actual.has_flag(flag=0x00000001))`