XLS-80d Permissioned Domains

.ci-config/rippled.cfg

@@ -194,6 +194,7 @@ fixNFTokenPageLinks
 fixInnerObjTemplate2
 fixEnforceNFTokenTrustline
 fixReducedOffersV2
+PermissionedDomains
 
 # This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
 [voting]

.github/workflows/integration_test.yml

@@ -2,7 +2,7 @@ name: Integration test
 
 env:
   POETRY_VERSION: 1.8.3
-  RIPPLED_DOCKER_IMAGE: rippleci/rippled:2.3.0
+  RIPPLED_DOCKER_IMAGE: rippleci/rippled:develop
 
 on:
   push:
@@ -32,7 +32,7 @@ jobs:
 
       - name: Run docker in background
         run: |
-          docker run --detach --rm -p 5005:5005 -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_nfo || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a"
+          docker run --detach --rm -p 5005:5005 -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a"
 
       - name: Install poetry
         if: steps.cache-poetry.outputs.cache-hit != 'true'

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [[Unreleased]]
 
+### Added
+- Add support for the `PermissionedDomains` feature
+
 ## [4.0.0] - 2024-12-23
 
 ### Added
@@ -96,6 +99,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [2.0.0] - 2023-07-05
 ### BREAKING CHANGE
 - The default signing algorithm in the `Wallet` was changed from secp256k1 to ed25519
+
 ### Added:
 - Wallet support for regular key compatibility
 - Added new ways of wallet generation: `from_seed`, `from_secret`, `from_entropy`, `from_secret_numbers`

tests/integration/reusable_values.py

@@ -13,6 +13,8 @@
     XRP,
     AMMDeposit,
     AMMDepositFlag,
+    CredentialAccept,
+    CredentialCreate,
     IssuedCurrencyAmount,
     OfferCreate,
     PaymentChannelCreate,
@@ -21,6 +23,7 @@
     XChainBridge,
     XChainCreateBridge,
 )
+from xrpl.utils import str_to_hex
 from xrpl.wallet import Wallet
 
 
@@ -95,6 +98,26 @@ async def _set_up_reusable_values():
     amm_asset2 = setup_amm_pool_res["asset2"]
     amm_issuer_wallet = setup_amm_pool_res["issuer_wallet"]
 
+    # Create and accept one credential; This is used in the PermissionedDomain tests
+    cred_type: str = str_to_hex("IdentityDocument")
+    await sign_and_reliable_submission_async(
+        CredentialCreate(
+            account=wallet.address,
+            subject=destination.address,
+            credential_type=cred_type,
+        ),
+        wallet,
+    )
+
+    credential_accept_txn_response = await sign_and_reliable_submission_async(
+        CredentialAccept(
+            issuer=wallet.address,
+            credential_type=cred_type,
+            account=destination.address,
+        ),
+        destination,
+    )
+
     return (
         wallet,
         destination,
@@ -106,6 +129,7 @@ async def _set_up_reusable_values():
         amm_asset2,
         amm_issuer_wallet,
         bridge,
+        credential_accept_txn_response,
     )
 
 
@@ -149,4 +173,5 @@ async def setup_amm_pool(
     AMM_ASSET2,
     AMM_ISSUER_WALLET,
     BRIDGE,
+    CREDENTIAL_ACCEPT_RESPONSE,
 ) = asyncio.run(_set_up_reusable_values())

tests/integration/transactions/test_permissioned_domain.py

@@ -0,0 +1,102 @@
+from tests.integration.integration_test_case import IntegrationTestCase
+from tests.integration.it_utils import (
+    sign_and_reliable_submission_async,
+    test_async_and_sync,
+)
+from tests.integration.reusable_values import CREDENTIAL_ACCEPT_RESPONSE, WALLET
+from xrpl.models.requests.account_objects import AccountObjects, AccountObjectType
+from xrpl.models.requests.ledger_data import LedgerData
+from xrpl.models.requests.ledger_entry import LedgerEntry, PermissionedDomain
+from xrpl.models.response import ResponseStatus
+from xrpl.models.transactions.permissioned_domain_delete import PermissionedDomainDelete
+from xrpl.models.transactions.permissioned_domain_set import (
+    Credential,
+    PermissionedDomainSet,
+)
+
+
+class TestPermissionedDomain(IntegrationTestCase):
+    @test_async_and_sync(globals())
+    async def test_valid_pd_workflow(self, client):
+
+        # Note: In the below test, WALLET is the "Issuer" of the said credential and is
+        # also the "Owner" of the PermissionedDomain, but these roles need not be
+        # fulfilled by the same account
+
+        # Step-1: Create a PermissionedDomain object
+        response = await sign_and_reliable_submission_async(
+            PermissionedDomainSet(
+                account=WALLET.address,
+                accepted_credentials=[
+                    Credential(
+                        credential_type=CREDENTIAL_ACCEPT_RESPONSE.result["tx_json"][
+                            "CredentialType"
+                        ],
+                        issuer=CREDENTIAL_ACCEPT_RESPONSE.result["tx_json"]["Issuer"],
+                    )
+                ],
+            ),
+            WALLET,
+            client,
+        )
+
+        self.assertEqual(response.status, ResponseStatus.SUCCESS)
+        self.assertEqual(response.result["engine_result"], "tesSUCCESS")
+
+        # Step-2: Verify the existence of the above PD ledger object through the RPC
+        # calls -- ledger_entry, ledger_data, account_objects
+
+        # Use the account_objects RPC to verify the creation of the PermissionedDomain
+        # ledger object
+        account_objects_response = await client.request(
+            AccountObjects(
+                account=WALLET.address, type=AccountObjectType.PERMISSIONED_DOMAIN
+            )
+        )
+        self.assertEqual(account_objects_response.status, ResponseStatus.SUCCESS)
+
+        # Use the LedgerEntry RPC to validate the creation of the credential object
+        ledger_entry_response = await client.request(
+            LedgerEntry(
+                # Use the LedgerIndex from the account_objects RPC response
+                permissioned_domain=account_objects_response.result["account_objects"][
+                    0
+                ]["index"]
+            )
+        )
+        self.assertEqual(ledger_entry_response.status, ResponseStatus.SUCCESS)
+
+        # Aliter: Use the account and sequence-number to retrieve a PermissionedDomain
+        ledger_entry_response = await client.request(
+            LedgerEntry(
+                permissioned_domain=PermissionedDomain(
+                    account=WALLET.address,
+                    seq=account_objects_response.result["account_objects"][0][
+                        "Sequence"
+                    ],
+                )
+            )
+        )
+
+        self.assertEqual(ledger_entry_response.status, ResponseStatus.SUCCESS)
+
+        # Use the ledger_data command to validate the creation of PermissionedDomain
+        # object
+        ledger_data_response = await client.request(
+            LedgerData(ledger_index=response.result["validated_ledger_index"])
+        )
+        self.assertEqual(ledger_data_response.status, ResponseStatus.SUCCESS)
+
+        # Step-3: Delete the PD object
+
+        response = await sign_and_reliable_submission_async(
+            PermissionedDomainDelete(
+                account=WALLET.address,
+                domain_id=ledger_entry_response.result["index"],
+            ),
+            WALLET,
+            client,
+        )
+
+        self.assertEqual(response.status, ResponseStatus.SUCCESS)
+        self.assertEqual(response.result["engine_result"], "tesSUCCESS")

tests/unit/models/requests/test_ledger_entry.py

@@ -2,7 +2,13 @@
 
 from xrpl.models import XRP, LedgerEntry, XChainBridge
 from xrpl.models.exceptions import XRPLModelException
-from xrpl.models.requests.ledger_entry import Credential, MPToken, Oracle, RippleState
+from xrpl.models.requests.ledger_entry import (
+    Credential,
+    MPToken,
+    Oracle,
+    PermissionedDomain,
+    RippleState,
+)
 
 
 class TestLedgerEntry(TestCase):
@@ -170,6 +176,16 @@ def test_invalid_price_oracle_object(self):
                 oracle=Oracle(oracle_document_id=1),
             )
 
+    def test_fetch_permissioned_domain_ledger_index(self):
+        self.assertTrue(LedgerEntry(permissioned_domain="LEDGEROBJECTHASH"))
+
+    def test_fetch_permissioned_domain_ledger_object_params(self):
+        self.assertTrue(
+            LedgerEntry(
+                permissioned_domain=PermissionedDomain(account="rAccount", seq=1234)
+            )
+        )
+
     def test_get_mpt_issuance(self):
         req = LedgerEntry(
             mpt_issuance="rB6XJbxKx2oBSK1E3Hvh7KcZTCCBukWyhv",

tests/unit/models/transactions/test_permissioned_domain_set.py

@@ -0,0 +1,56 @@
+from unittest import TestCase
+
+from xrpl.models.exceptions import XRPLModelException
+from xrpl.models.transactions.deposit_preauth import Credential
+from xrpl.models.transactions.permissioned_domain_set import PermissionedDomainSet
+from xrpl.utils import str_to_hex
+
+_ACCOUNT_1 = "r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ"
+_ACCOUNT_SUBJECT = "rNdY9XDnQ4Dr1EgefwU3CBRuAjt3sAutGg"
+_VALID_CREDENTIAL_TYPE = str_to_hex("Passport")
+_VALID_URI = str_to_hex("www.my-id.com/username")
+
+
+class TestPermissionedDomainSet(TestCase):
+    def test_valid(self):
+        tx = PermissionedDomainSet(
+            account=_ACCOUNT_1,
+            accepted_credentials=[
+                Credential(credential_type=str_to_hex("Passport"), issuer=_ACCOUNT_1)
+            ],
+            domain_id="BC59567FA7E4078FFC501C5B6D8E4545244146982443E58177"
+            "BA4DCF1AC99D6C",
+        )
+        self.assertTrue(tx.is_valid())
+
+    # tests pertaining to the length of AcceptedCredentials list
+    def test_accepted_credentials_too_long(self):
+        with self.assertRaises(XRPLModelException) as err:
+            PermissionedDomainSet(
+                account=_ACCOUNT_1,
+                accepted_credentials=[
+                    Credential(
+                        credential_type=str_to_hex("Passport_" + str(i)),
+                        issuer=_ACCOUNT_1,
+                    )
+                    for i in range(11)
+                ],
+            )
+
+        self.assertEqual(
+            err.exception.args[0],
+            "{'PermissionedDomainSet': 'AcceptedCredentials list cannot have more than "
+            + "10 elements.'}",
+        )
+
+    def test_accepted_credentials_empty(self):
+        with self.assertRaises(XRPLModelException) as err:
+            PermissionedDomainSet(
+                account=_ACCOUNT_1,
+                accepted_credentials=[],
+            )
+
+        self.assertEqual(
+            err.exception.args[0],
+            "{'PermissionedDomainSet': 'AcceptedCredentials list cannot be empty.'}",
+        )

xrpl/core/binarycodec/definitions/definitions.json

@@ -1250,6 +1250,16 @@
         "type": "Hash256"
       }
     ],
+    [
+      "DomainID",
+      {
+        "nth": 34,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Hash256"
+      }
+    ],
     [
       "hash",
       {
@@ -2530,6 +2540,15 @@
         "type": "STArray"
       }
     ],
+    [
+      "AcceptedCredentials", {
+        "nth": 28,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "STArray"
+      }
+    ],
     [
       "CloseResolution",
       {
@@ -2863,6 +2882,7 @@
     "Oracle": 128,
     "Credential": 129,
     "PayChannel": 120,
+    "PermissionedDomain": 130,
     "RippleState": 114,
     "SignerList": 83,
     "Ticket": 84,
@@ -3064,8 +3084,8 @@
     "CheckCash": 17,
     "CheckCreate": 16,
     "Clawback": 30,
-    "CredentialAccept": 59,
     "CredentialCreate": 58,
+    "CredentialAccept": 59,
     "CredentialDelete": 60,
     "DIDDelete": 50,
     "DIDSet": 49,
@@ -3085,6 +3105,7 @@
     "NFTokenCancelOffer": 28,
     "NFTokenCreateOffer": 27,
     "NFTokenMint": 25,
+    "NFTokenModify": 61,
     "OfferCancel": 8,
     "OfferCreate": 7,
     "OracleDelete": 52,
@@ -3093,6 +3114,8 @@
     "PaymentChannelClaim": 15,
     "PaymentChannelCreate": 13,
     "PaymentChannelFund": 14,
+    "PermissionedDomainSet": 62,
+    "PermissionedDomainDelete": 63,
     "SetFee": 101,
     "SetRegularKey": 5,
     "SignerListSet": 12,
@@ -3138,4 +3161,4 @@
     "Vector256": 19,
     "XChainBridge": 25
   }
-}
+}

xrpl/models/requests/account_objects.py

@@ -32,6 +32,7 @@ class AccountObjectType(str, Enum):
     OFFER = "offer"
     ORACLE = "oracle"
     PAYMENT_CHANNEL = "payment_channel"
+    PERMISSIONED_DOMAIN = "permissioned_domain"
     SIGNER_LIST = "signer_list"
     STATE = "state"
     TICKET = "ticket"