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

add state alias to ripple_state

Browse Source
This commit is contained in:
Oliver Eggert
2025-03-04 13:04:36 -08:00
parent c8826b3205
commit 28bda7c11f
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -528,6 +528,7 @@ Retrieve a [RippleState entry][], which tracks a (non-XRP) currency balance betw
| Field | Type | Description |
|:------------------------|:---------------------------|:----------------------|
| `state` | Object | Alias to `ripple_state`. |
| `ripple_state` | Object | Object specifying the RippleState (trust line) object to retrieve. The `accounts` and `currency` sub-fields are required to uniquely specify the RippleState entry to retrieve. |
| `ripple_state.accounts` | Array | _(Required if `ripple_state` is specified)_ 2-length array of account [Address][]es, defining the two accounts linked by this RippleState entry. |
| `ripple_state.currency` | String | _(Required if `ripple_state` is specified)_ [Currency Code][] of the RippleState entry to retrieve. |