ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-04 11:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'XRPLF:master' into master

Browse Source
This commit is contained in:
Ekiserrepé
2024-04-02 21:25:59 +02:00
committed by GitHub
parent c2e90c06f6 4200ea6771
commit 86543c2ace
5 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md
View File

@@ -62,7 +62,7 @@ The request can contain the following parameters:
| `Field` | Type | Required? | Description |
|:---------------|:-----------------|:----------|-------------|
| `ledger_hash` | [Hash][] | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
| `ledger_hash` | [Hash][] | No | A 32-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
| `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][]) |
| `transactions` | Boolean | No | If `true`, return information on transactions in the specified ledger version. The default is `false`. Ignored if you did not specify a ledger version. |
| `expand` | Boolean | No | Provide full JSON-formatted information for transaction/account information instead of only hashes. The default is `false`. Ignored unless you request transactions, accounts, or both. |

16
docs/references/index.md
View File

@@ -26,13 +26,13 @@ Use these libraries to access the XRP Ledger from your programming language of c
{% card-grid %}
{% xrpl-card title="Basic Data Types" body="Format and meaning of fundamental data types." href="/references/protocol/data-types/basic-data-types/" /%}
{% xrpl-card title="Basic Data Types" body="Format and meaning of fundamental data types." href="/docs/references/protocol/data-types/basic-data-types/" /%}
{% xrpl-card title="Ledger Data Formats" body="Learn about individual entries that comprise the XRP Ledger's shared state data." href="/references/protocol/ledger-data/" /%}
{% xrpl-card title="Ledger Data Formats" body="Learn about individual entries that comprise the XRP Ledger's shared state data." href="/docs/references/protocol/ledger-data/" /%}
{% xrpl-card title="Transaction Reference" body="Definitions for all the protocol's transaction types and their results." href="/references/protocol/transactions/" /%}
{% xrpl-card title="Transaction Reference" body="Definitions for all the protocol's transaction types and their results." href="/docs/references/protocol/transactions/" /%}
{% xrpl-card title="Binary Format" body="Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects." href="/references/protocol/binary-format/" /%}
{% xrpl-card title="Binary Format" body="Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects." href="/docs/references/protocol/binary-format/" /%}
{% /card-grid %}
@@ -40,13 +40,13 @@ Use these libraries to access the XRP Ledger from your programming language of c
{% card-grid %}
{% xrpl-card title="API Conventions" body="Describes data types and formats of the HTTP APIs (JSON-RPC and WebSocket) as implemented in the rippled server." href="/references/http-websocket-apis/api-conventions/" /%}
{% xrpl-card title="API Conventions" body="Describes data types and formats of the HTTP APIs (JSON-RPC and WebSocket) as implemented in the rippled server." href="/docs/references/http-websocket-apis/api-conventions/" /%}
{% xrpl-card title="Public API Methods" body="Public API methods for use by any client attached to the server." href="/references/http-websocket-apis/public-api-methods/" /%}
{% xrpl-card title="Public API Methods" body="Public API methods for use by any client attached to the server." href="/docs/references/http-websocket-apis/public-api-methods/" /%}
{% xrpl-card title="Admin API Methods" body="Admin methods for trusted personnel in charge of keeping the rippled server operational." href="/references/http-websocket-apis/admin-api-methods/" /%}
{% xrpl-card title="Admin API Methods" body="Admin methods for trusted personnel in charge of keeping the rippled server operational." href="/docs/references/http-websocket-apis/admin-api-methods/" /%}
{% xrpl-card title="Peer Port Methods" body="Special API methods for sharing network topology and status metrics, served on the XRPL Peer Protocol port." href="/references/http-websocket-apis/peer-port-methods/" /%}
{% xrpl-card title="Peer Port Methods" body="Special API methods for sharing network topology and status metrics, served on the XRPL Peer Protocol port." href="/docs/references/http-websocket-apis/peer-port-methods/" /%}
{% /card-grid %}

4
docs/references/protocol/transactions/types/trustset.md
View File

@@ -41,8 +41,8 @@ Create or modify a [trust line](../../../../concepts/tokens/fungible-tokens/inde
| `LimitAmount`.`currency` | String | (Amount.currency) | The currency to this trust line applies to, as a three-letter [ISO 4217 Currency Code](https://www.xe.com/iso4217.php) or a 160-bit hex value according to [currency format](../../data-types/currency-formats.md). "XRP" is invalid. |
| `LimitAmount`.`value` | String | (Amount.value) | Quoted decimal representation of the limit to set on this trust line. |
| `LimitAmount`.`issuer` | String | (Amount.issuer) | The address of the account to extend trust to. |
| `QualityIn` | Number | UInt32 | _(Optional)_ Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. |
| `QualityOut` | Number | UInt32 | _(Optional)_ Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. |
| `QualityIn` | Number | UInt32 | _(Optional)_ Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. For example, if you set the value to 10,000,000, 1% of incoming funds remain with the sender. If an account sends 100 currency, the sender retains 1 currency unit and the destination receives 99 units. This option is included for parity: in practice, you are much more likely to set a `QualityOut` value. Note that this fee is separate and independent from token transfer fees. |
| `QualityOut` | Number | UInt32 | _(Optional)_ Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of `0` is shorthand for treating balances at face value. For example, if you set the value to 10,000,000, 1% of outgoing funds would remain with the issuer. If the sender sends 100 currency units, the issuer retains 1 currency unit and the destination receives 99 units. Note that this fee is separate and independent from token transfer fees. |
If the account specified in `LimitAmount.issuer` is blocking incoming trust lines, the transaction fails with the result code `tecNO_PERMISSION`. _(Requires the [DisallowIncoming amendment][] )_

2
docs/tutorials/how-tos/use-tokens/trade-in-the-decentralized-exchange.md
View File

@@ -67,7 +67,7 @@ For this tutorial, click the following button to connect:
### 2. Get Credentials
To transact on the XRP Ledger, you need an address, a secret key, and some XRP. For development purposes, you can get these on the [{{use_network}}](../../../concepts/networks-and-servers/parallel-networks.md) using the following interface:
To transact on the XRP Ledger, you need an address, a secret key, and some XRP. For development purposes, you can get these on the [Testnet](../../../concepts/networks-and-servers/parallel-networks.md) using the following interface:
{% partial file="/docs/_snippets/interactive-tutorials/generate-step.md" /%}

1
sidebars.yaml
View File

@@ -301,6 +301,7 @@
expanded: false
items:
- page: docs/references/protocol/ledger-data/ledger-header.md
- page: docs/references/protocol/ledger-data/common-fields.md
- page: docs/references/protocol/ledger-data/ledger-entry-types/index.md
expanded: false
items: