Merge pull request #3029 from XRPLF/add-permissioneddomain-object

add permissioned domain object

docs/_snippets/common-links.md

@@ -243,6 +243,7 @@
 [PaymentChannelFundトランザクション]: /docs/references/protocol/transactions/types/paymentchannelfund.md
 [Payment]: /docs/references/protocol/transactions/types/payment.md
 [Paymentトランザクション]: /docs/references/protocol/transactions/types/payment.md
+[PermissionedDomainSet transaction]: /docs/references/protocol/transactions/types/permissioneddomainset.md
 [PermissionedDomains amendment]: /resources/known-amendments.md#permissioneddomains
 [permissioned domain]: /docs/concepts/tokens/decentralized-exchange/permissioned-domains.md
 [PriceOracle amendment]: /resources/known-amendments.md#priceoracle

docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md

@@ -0,0 +1,103 @@
+---
+seo:
+    description: A PermissionedDomain ledger entry represents a Permissioned Domain, which is used to limit access to other features.
+labels:
+  - Compliance
+  - Permissioned Domains
+---
+# PermissionedDomain
+[[Source]](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/detail/ledger_entries.macro#L451-L461 "Source")
+
+A `PermissionedDomain` ledger entry describes a single [permissioned domain][] instance. You can create a permissioned domain by sending a [PermissionedDomainSet transaction][].
+
+_(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_
+
+
+## Example {% $frontmatter.seo.title %} JSON
+
+```json
+{
+  "LedgerEntryType": "PermissionedDomain",
+  "Fee": "10",
+  "Flags": 0,
+  "Owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+  "OwnerNode": "0000000000000000",
+  "Sequence": 390,
+  "AcceptedCredentials": [
+    {
+        "Credential": {
+            "Issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
+            "CredentialType": "6D795F63726564656E7469616C"
+        }
+    }
+  ],
+  "PreviousTxnID": "E7E3F2BBAAF48CF893896E48DC4A02BDA0C747B198D5AE18BC3D7567EE64B904",
+  "PreviousTxnLgrSeq": 8734523,
+  "index": "3DFA1DDEA27AF7E466DE395CCB16158E07ECA6BC4EB5580F75EBD39DE833645F"
+}
+```
+
+<!-- TODO: use a real example above -->
+
+## {% $frontmatter.seo.title %} Fields
+
+In addition to the [common fields](../common-fields.md), {% code-page-name /%} entries have the following fields:
+
+| Field                 | JSON Type            | [Internal Type][] | Required? | Description  |
+|:----------------------|:----------|:------------------|:----------|--------------|
+| `AcceptedCredentials` | Array                | Array             | Yes       | A list of 1 to 10 [Credential](#acceptedcredentials-objects) objects that grant access to this domain. The array is stored sorted by issuer. |
+| `Owner`               | String - [Address][] | AccountID         | Yes       | The address of the account that owns this domain. |
+| `OwnerNode`           | String               | UInt64            | Yes       | A hint indicating which page of the owner directory links to this entry, in case the directory consists of multiple pages. |
+| `PreviousTxnID`       | String - [Hash][]    | Hash256           | Yes       | The identifying hash of the transaction that most recently modified this entry. |
+| `PreviousTxnLgrSeq`   | Number               | UInt32            | Yes       | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object. |
+| `Sequence`            | Number               | UInt32            | Yes       | The `Sequence` value of the transaction that created this entry. |
+
+
+### AcceptedCredentials Objects
+
+Each member of the `AcceptedCredentials` array is an inner object named `Credential` with the following nested fields:
+
+| Field            | JSON Type            | [Internal Type][] | Required? | Description  |
+|:-----------------|:---------------------|:------------------|:----------|--------------|
+| `Issuer`         | String - [Address][] | AccountID         | Yes       | The issuer of the credential. |
+| `CredentialType` | String               | Blob              | Yes       | The type of credential, as hexadecimal. This is an arbitrary value from 1 to 64 bytes that the issuer sets when they issue a credential. |
+
+{% admonition type="info" name="Note" %}
+In the usual JSON format, inner objects are wrapped in an object with one field, whose name defines the inner object type. In this case, the wrapping field is named `Credential`. For example:
+
+```json
+"AcceptedCredentials": [
+    {
+        "Credential": {
+            "Issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
+            "CredentialType": "6D795F63726564656E7469616C"
+        }
+    },
+    // ... additional Credential inner objects ...
+]
+```
+{% /admonition %}
+
+
+## {% $frontmatter.seo.title %} Flags
+
+There are no flags defined for {% code-page-name /%} entries.
+
+
+## {% $frontmatter.seo.title %} Reserve
+
+Each {% code-page-name /%} entry counts as 1 item toward its owner's reserve requirement.
+
+A {% code-page-name /%} entry is a deletion blocker, meaning an account cannot be deleted if it owns any {% code-page-name /%} entries.
+
+
+## {% $frontmatter.seo.title %} ID Format
+
+The ID of a {% code-page-name /%} entry is the [SHA-512Half][] of the following values, concatenated in order:
+
+1. The {% code-page-name /%} space key (`0x0082`).
+0. The AccountID of the {% code-page-name /%}'s owner.
+0. The Sequence number of the transaction that created the {% code-page-name /%}.
+
+
+{% raw-partial file="/docs/_snippets/common-links.md" /%}

sidebars.yaml

@@ -345,6 +345,7 @@
                     - page: docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md
                     - page: docs/references/protocol/ledger-data/ledger-entry-types/offer.md
                     - page: docs/references/protocol/ledger-data/ledger-entry-types/oracle.md
+                    - page: docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md
                     - page: docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md
                     - page: docs/references/protocol/ledger-data/ledger-entry-types/ripplestate.md
                     - page: docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md