Skip to content

Commit

Permalink
fix error code description and add did ledger entry type
Browse files Browse the repository at this point in the history
  • Loading branch information
oeggert committed Nov 30, 2023
1 parent 8ab92e2 commit 10d6496
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 14 deletions.
2 changes: 2 additions & 0 deletions content/_snippets/rippled-api-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"AMM",
"Check",
"DepositPreauth",
"DID",
"DirectoryNode",
"Escrow",
"FeeSettings",
Expand Down Expand Up @@ -204,6 +205,7 @@
"DeletableAccounts",
"DepositAuth",
"DepositPreauth",
"DID",
"DisallowIncoming",
"EnforceInvariants",
"Escrow",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,24 @@ The `generator` and `ledger` parameters are deprecated and may be removed withou

In addition to the general fields above, you must specify *exactly 1* of the following fields to indicate what type of entry to retrieve, along with its sub-fields as appropriate. The valid fields are:

- [`index`](#get-ledger-object-by-id)
- [`account_root`](#get-accountroot-object)
- [`amm`](#get-amm-object) :not_enabled:
- [`directory`](#get-directorynode-object)
- [`offer`](#get-offer-object)
- [`ripple_state`](#get-ripplestate-object)
- [`check`](#get-check-object)
- [`escrow`](#get-escrow-object)
- [`payment_channel`](#get-paychannel-object)
- [`deposit_preauth`](#get-depositpreauth-object)
- [`ticket`](#get-ticket-object)
- [`nft_page`](#get-nft-page)
- [ledger\_entry](#ledger_entry)
- [Request Format](#request-format)
- [General Fields](#general-fields)
- [Get Ledger Object by ID](#get-ledger-object-by-id)
- [Get AccountRoot Object](#get-accountroot-object)
- [Get AMM Object](#get-amm-object)
- [Get DID Object](#get-did-object)
- [Get DirectoryNode Object](#get-directorynode-object)
- [Get Offer Object](#get-offer-object)
- [Get RippleState Object](#get-ripplestate-object)
- [Get Check Object](#get-check-object)
- [Get Escrow Object](#get-escrow-object)
- [Get PayChannel Object](#get-paychannel-object)
- [Get DepositPreauth Object](#get-depositpreauth-object)
- [Get Ticket Object](#get-ticket-object)
- [Get NFT Page](#get-nft-page)
- [Response Format](#response-format)
- [Possible Errors](#possible-errors)

**Caution:** If you specify more than 1 of these type-specific fields in a request, the server retrieves results for only 1 of them. It is not defined which one the server chooses, so you should avoid doing this.

Expand Down Expand Up @@ -211,6 +217,45 @@ rippled json ledger_entry '{ "amm": { "asset": { "currency": "XRP" }, "asset2":
[Try it! >](websocket-api-tool.html?server=wss%3A%2F%2Famm.devnet.rippletest.net%3A51233%2F#ledger_entry-amm)


### Get DID Object

_(Requires the [DID amendment][] :not_enabled:)_

Retrieve a Decentralized Identifier (DID) object from the ledger.

| Field | Type | Description |
|:--------|:-------|:----------------------------------------------------------|
| `did` | TBD | TBD |

<!-- MULTICODE_BLOCK_START -->

*WebSocket*

```json
{

}
```

*JSON-RPC*

```json
{

}
```

*Commandline*

```sh

```

<!-- MULTICODE_BLOCK_END -->

[Try it! >](websocket-api-tool.html#ledger_entry-did)



### Get DirectoryNode Object

Expand Down
4 changes: 2 additions & 2 deletions content/references/protocol/transactions/types/didset.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Besides errors that can occur for all transactions, {{currentpage.name}} transac

| Error Code | Description |
|:--------------------|:---------------------------------------------|
| `tecEMPTY_DID` | The DID doesn't have an associated `URI`, `Data`, or `DIDDocument`. Include at least one of these fields. |
| `temEMPTY_DID` | The DID doesn't have an associated `URI`, `Data`, or `DIDDocument`. Include at least one of these fields. |
| `tecEMPTY_DID` | The transaction will create an empty DID ledger entry. Check that your updates don't remove the `URI`, `Data`, and `DIDDocument` fields. |
| `temEMPTY_DID` | The transaction is malformed and missing any DID information. Include either the `URI`, `Data`, or `DIDDocument` fields. |


<!--{# common link defs #}-->
Expand Down
23 changes: 23 additions & 0 deletions content/resources/known-amendments.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The following is a comprehensive list of all known [amendments](amendments.html)

| Name | Introduced | Status |
|:----------------------------------|:-----------|:------------------------------|
| [DID][] | v2.0.0 | [Open for Voting: 2023-12-04](https://xrpl.org/blog/2023/rippled-2.0.0.html "BADGE_80d0e0") |
| [AMM][] | v1.12.0 | [Open for Voting: 2023-09-06](https://xrpl.org/blog/2023/rippled-1.12.0.html "BADGE_80d0e0") |
| [Clawback][] | v1.12.0 | [Open for Voting: 2023-09-06](https://xrpl.org/blog/2023/rippled-1.12.0.html "BADGE_80d0e0") |
| [fixReducedOffersV1][] | v1.12.0 | [Open for Voting: 2023-09-06](https://xrpl.org/blog/2023/rippled-1.12.0.html "BADGE_80d0e0") |
Expand Down Expand Up @@ -105,6 +106,28 @@ The following is a list of known [amendments](amendments.html) that have been re

## Details about Known Amendments

### DID
[DID]: #did

| Amendment | DID |
|:-------------|:----|
| Amendment ID | TBD |
| Status | Open for Voting |
| Default Vote (Latest stable release) | No |
| Pre-amendment functionality retired? | No |

Adds Decentralized Identifier (DID) functionality to the ledger that conforms to the [World Wide Web Consortium](https://www.w3.org/press-releases/2022/did-rec/) standard. DIDs provide a digital identity, not dependent on a centralized authority and controlled by the DID subject.

Adds new transactions:

- DIDDelete - Delete the DID associated with your XRPL account.
- DIDSet - Create a new DID or update an existing one.

Adds a new `DID` ledger entry type.

Adds several new transaction result codes.


### AMM
[AMM]: #amm

Expand Down

0 comments on commit 10d6496

Please sign in to comment.