Skip to content

Commit 46a524e

Browse files
mDuo13tequdev
andauthored
Apply suggestions from @tequdev review
Co-authored-by: tequ <git@tequ.dev>
1 parent 52c3ac6 commit 46a524e

File tree

9 files changed

+18
-18
lines changed

9 files changed

+18
-18
lines changed

docs/concepts/decentralized-storage/credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Credentials
22

3-
The Credentials feature is a set of tools for managing authorization and compliance requirements using the XRP Ledger blockchain, while respecting privacy and decentralization. This feature extends and interconnects with other features of the XRP Ledger including [Deposit Authorization](https://xrpl.org/docs/concepts/accounts/depositauth). The goal of this feature is to streamline the process of compliance checks such as [KYC (Know Your Customer)](https://en.wikipedia.org/wiki/Know_your_customer) and to enable further trust-based applications within the XRP Ledger ecosystem.
3+
The Credentials feature is a set of tools for managing authorization and compliance requirements using the XRP Ledger blockchain, while respecting privacy and decentralization. This feature extends and interconnects with other features of the XRP Ledger including [Deposit Authorization](../../concepts/accounts/depositauth.md)). The goal of this feature is to streamline the process of compliance checks such as [KYC (Know Your Customer)](https://en.wikipedia.org/wiki/Know_your_customer) and to enable further trust-based applications within the XRP Ledger ecosystem.
44

55
The design of the Credentials standard draws from the [W3C Verifiable Credentials standard](https://www.w3.org/TR/vc-data-model-2.0/). It is intended to be compatible to an extent that makes sense in the context of the XRP Ledger. There are some differences in data structures and formatting: for example, the subject of a credential is identified by an XRP Ledger address rather than a URL.
66

docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ You can use this type of request to get any singleton ledger entry, if it exists
112112

113113

114114
### Get AccountRoot Entry
115-
<a id="get-accountroot-entry"></a><!-- legacy ID -->
115+
<a id="get-accountroot-object"></a><!-- legacy ID -->
116116

117117
Retrieve an [AccountRoot entry](../../../protocol/ledger-data/ledger-entry-types/accountroot.md) by its address. This is roughly equivalent to the [account_info method][].
118118

@@ -160,7 +160,7 @@ rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
160160

161161

162162
### Get AMM Entry
163-
<a id="get-amm-entry"></a><!-- legacy ID -->
163+
<a id="get-amm-object"></a><!-- legacy ID -->
164164

165165
_(Added by the [AMM amendment][])_
166166

docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/deposit_authorized.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88
# deposit_authorized
99
[[Source]](https://github.com/XRPLF/rippled/blob/817d2339b8632cb2f97d3edd6f7af33aa7631744/src/ripple/rpc/handlers/DepositAuthorized.cpp "Source")
1010

11-
The `deposit_authorized` command indicates whether one account is authorized to send payments directly to another. See [Deposit Authorization](https://xrpl.org/docs/concepts/accounts/depositauth/) for information on how to require authorization to deliver money to your account.
11+
The `deposit_authorized` command indicates whether one account is authorized to send payments directly to another. See [Deposit Authorization](../../../../concepts/accounts/depositauth.md) for information on how to require authorization to deliver money to your account.
1212

1313
## Request Format
1414
An example of the request format:
@@ -65,7 +65,7 @@ The request includes the following parameters:
6565
|:----------------------|:---------------------|:----------|-------------|
6666
| `source_account` | String - [Address][] | Yes | The sender of a possible payment. |
6767
| `destination_account` | String - [Address][] | Yes | The recipient of a possible payment. |
68-
| `ledger_hash` | [Hash][] | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
68+
| `ledger_hash` | [Hash][] | No | A 32-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
6969
| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
7070
| `credentials` | Array | No | A set of credentials to take into account when checking if the sender can send funds to the destination. Each member of the array must be the unique ID of a [Credential entry][] in the ledger. Cannot be an empty array. |
7171

@@ -150,7 +150,7 @@ The response follows the [standard format][], with a successful result containin
150150
| Field | Type | Required? | Description |
151151
|:-----------------------|:--------------------------|:----------|:--------------|
152152
| `credentials` | Array of [Hash][] | No | The credentials specified in the request, if any. |
153-
| `deposit_authorized` | Boolean | Yes | Whether the specified source account is authorized to send payments directly to the destination account. If `true`, either the destination account does not require [deposit authorization](https://xrpl.org/docs/concepts/accounts/depositauth) or the source account is preauthorized. |
153+
| `deposit_authorized` | Boolean | Yes | Whether the specified source account is authorized to send payments directly to the destination account. If `true`, either the destination account does not require [deposit authorization](../../../../concepts/accounts/depositauth.md) or the source account is preauthorized. |
154154
| `destination_account` | String - [Address][] | Yes | The destination account specified in the request. |
155155
| `ledger_hash` | String | No | The identifying hash of the ledger that was used to generate this response. |
156156
| `ledger_index` | Number - [Ledger Index][] | No | The ledger index of the ledger version that was used to generate this response. |
@@ -159,7 +159,7 @@ The response follows the [standard format][], with a successful result containin
159159
| `validated` | Boolean | No | If `true`, the information comes from a validated ledger version. |
160160

161161
{% admonition type="info" name="Note" %}
162-
A `deposit_authorized` status of `true` does not guarantee that a payment can be sent from the specified source to the specified destination. For example, the destination account may not have a [trust line](https://xrpl.org/docs/concepts/tokens/fungible-tokens) for the specified currency, or there may not be enough liquidity to deliver a payment.
162+
A `deposit_authorized` status of `true` does not guarantee that a payment can be sent from the specified source to the specified destination. For example, the destination account may not have a [trust line](../../../../concepts/tokens/fungible-tokens/index.md) for the specified currency, or there may not be enough liquidity to deliver a payment.
163163
{% /admonition %}
164164

165165
## Possible Errors

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ seo:
44
---
55
# Credential
66

7-
A `Credential` entry represents a [credential](../index.md), which contains an attestation about a _subject_ account from a _credential issuer_ account. The meaning of the attestation is defined by the issuer.
7+
A `Credential` entry represents a [credential](../../../../concepts/decentralized-storage/credentials.md), which contains an attestation about a _subject_ account from a _credential issuer_ account. The meaning of the attestation is defined by the issuer.
88

99
## Example Credential JSON
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ labels:
99
# DepositPreauth
1010
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp#L172-L178 "Source")
1111

12-
A `DepositPreauth` entry tracks a preauthorization from one account. You can always create a preauthorization by sending a [DepositPreauth transaction][], but it has no effect unless you are using [Deposit Authorization](https://xrpl.org/docs/concepts/accounts/depositauth).
12+
A `DepositPreauth` entry tracks a preauthorization from one account. You can always create a preauthorization by sending a [DepositPreauth transaction][], but it has no effect unless you are using [Deposit Authorization](../../../../concepts/accounts/depositauth.md).
1313

1414
A preauthorization allows specific others to send money directly to you even if you have Deposit Authorization enabled. Preauthorizations are one-directional, and have no effect on payments going the opposite direction.
1515

docs/references/protocol/transactions/types/credentialaccept.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
seo:
33
description: Accept a credential provisionally issued to your account.
44
---
5-
# CredentialAccept Transaction
5+
# CredentialAccept
66

77
A CredentialAccept transaction accepts a credential, which makes the credential valid. Only the subject of the credential can do this.
88

@@ -42,7 +42,7 @@ The combination of `Account`, `Issuer`, and `CredentialType` must match a `Crede
4242
| `tecEXPIRED` | The specified credential has an expiration time in the past. (In this case, the transaction also deletes the expired credentials from the ledger.) |
4343
| `tecNO_ENTRY` | The credential uniquely identified by the `Account`, `Issuer`, and `CredentialType` fields of the transaction does not exist in the ledger. |
4444
| `temDISABLED` | The related amendment is not enabled. |
45-
| `temINVALID_ACCOUNT_ID` | The provided `Issuer` field is invalid. For example, it contains [ACCOUNT_ZERO][]. |
45+
| `temINVALID_ACCOUNT_ID` | The provided `Issuer` field is invalid. For example, it contains [ACCOUNT_ZERO](../../../../concepts/accounts/addresses.md#special-addresses). |
4646

4747

4848
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/protocol/transactions/types/credentialcreate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ seo:
33
description: Provisionally issue a credential to a subject account.
44
---
55

6-
# CredentialCreate Transaction
6+
# CredentialCreate
77

88
A CredentialCreate transaction creates a credential in the ledger. The issuer of the credential uses this transaction to provisionally issue a credential. The credential is not valid until the subject of the credential accepts it with a [CredentialAccept transaction][].
99

@@ -37,15 +37,15 @@ The `Account` field (the sender) of the transaction is the issuer of the credent
3737

3838
## Error Cases
3939

40-
Besides errors that can occur for all transactions, CredentialCreate transactions can result in the following [transaction result codes][]:
40+
Besides errors that can occur for all transactions, CredentialCreate transactions can result in the following [transaction result codes](../transaction-results/index.md):
4141

4242
| Error Code | Description |
4343
|:-----------|:------------|
4444
| `tecDUPLICATE` | A credential with the same subject, issuer, and credential type already exists in the ledger. |
4545
| `tecEXPIRED` | The credential's expiration time is in the past. |
4646
| `tecNO_TARGET` | The account specified in the `Subject` field is not a funded account in the ledger. |
4747
| `temDISABLED` | The related amendment is not enabled. |
48-
| `temINVALID_ACCOUNT_ID` | The provided `Subject` field is invalid. For example, it contains [ACCOUNT_ZERO][]. |
48+
| `temINVALID_ACCOUNT_ID` | The provided `Subject` field is invalid. For example, it contains [ACCOUNT_ZERO](../../../../concepts/accounts/addresses.md#special-addresses). |
4949

5050

5151
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/protocol/transactions/types/credentialdelete.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
seo:
33
description: Remove a credential from the ledger, effectively revoking it.
44
---
5-
# CredentialDelete Transaction
5+
# CredentialDelete
66

7-
A CredentialDelete transaction removes a credential from the ledger, effectively revoking it. Users may also want to delete an unwanted credential to reduce their [reserve requirement][].
7+
A CredentialDelete transaction removes a credential from the ledger, effectively revoking it. Users may also want to delete an unwanted credential to reduce their [reserve requirement](../../../../concepts/accounts/reserves.md).
88

99
## Example CredentialDelete JSON
1010

@@ -41,7 +41,7 @@ This transaction looks for a [Credential ledger entry](../../ledger-data/ledger-
4141
| Error Code | Description |
4242
|:-----------|:------------|
4343
| `temDISABLED` | The related amendment is not enabled. |
44-
| `temINVALID_ACCOUNT_ID` | A provided `Subject` or `Issuer` field is invalid. For example, it contains [ACCOUNT_ZERO][]. |
44+
| `temINVALID_ACCOUNT_ID` | A provided `Subject` or `Issuer` field is invalid. For example, it contains [ACCOUNT_ZERO](../../../../concepts/accounts/addresses.md#special-addresses). |
4545
| `tecNO_PERMISSION` | The sender is neither the issuer nor subject of the credential, and the credential is not expired. |
4646
| `tecNO_ENTRY` | The specified credential does not exist in the ledger. |
4747

docs/references/protocol/transactions/types/depositpreauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ In addition to error types that can occur for all transactions, DepositPreauth t
8383
| Error Code | Description |
8484
|:--------------------------|:------------|
8585
| `tecDUPLICATE` | The transaction would create a preauthorization that already exists. |
86-
| `tecINSUFFICIENT_RESERVE` | The sender would not meet the [reserve requirement][] after adding another entry to the ledger. (A DepositPreauth entry counts as one item towards the authorizer's owner reserve.) |
86+
| `tecINSUFFICIENT_RESERVE` | The sender would not meet the [reserve requirement](../../../../concepts/accounts/reserves.md) after adding another entry to the ledger. (A DepositPreauth entry counts as one item towards the authorizer's owner reserve.) |
8787
| `tecNO_ENTRY` | The transaction tried to revoke a preauthorization that does not exist in the ledger. |
8888
| `tecNO_ISSUER` | One or more specified credential issuers does not exist in the ledger. |
8989
| `tecNO_TARGET` | The transaction tried to authorize an account that is not a funded account in the ledger. |

0 commit comments

Comments
 (0)