# @integraledger/lcp/xrpl

> The exports of @integraledger/lcp/xrpl.

Source: https://lcp.integraledger.com/reference/api/xrpl

## Interfaces

### XrplLanded

#### Properties

| Property            | Type                 | Description                                                  |
| ------------------- | -------------------- | ------------------------------------------------------------ |
|  `deletedChannels?` | readonly `string`\[] | The `PayChannel` `DeletedNode`s of the transaction's `meta`. |
|  `invoiceId?`       | `string`             | -                                                            |
|  `ledgerIndex?`     | `number`             | -                                                            |
|  `result`           | `string`             | `meta.TransactionResult`.                                    |
|  `transactionType`  | `string`             | -                                                            |
|  `validated`        | `boolean`            | -                                                            |

***

### XrplReader

Bounded, read-only calls against one network's endpoint. Every failure rejects with `ReaderError`.

#### Properties

| Property   | Modifier   | Type                   |
| ---------- | ---------- | ---------------------- |
|  `network` | `readonly` | `` `xrpl:${number}` `` |

#### Methods

##### tx()

> **tx**(`hash`, `range`): `Promise`\<[`XrplLanded`](#xrpllanded) | \{ `notFound`: `true`; `searchedAll`: `boolean`; }>

`tx` by hash, with `min_ledger` and `max_ledger` when a range is given.

###### Parameters

| Parameter | Type                                             |
| --------- | ------------------------------------------------ |
| `hash`    | `string`                                         |
| `range`   | \{ `max`: `number`; `min`: `number`; } \| `null` |

###### Returns

`Promise`\<[`XrplLanded`](#xrpllanded) | \{ `notFound`: `true`; `searchedAll`: `boolean`; }>

##### txBlob()

> **txBlob**(`hash`): `Promise`\<`string` | `null`>

`tx` with `binary: true`: the signed blob, for credentials that name only a hash.

###### Parameters

| Parameter | Type     |
| --------- | -------- |
| `hash`    | `string` |

###### Returns

`Promise`\<`string` | `null`>

##### validatedLedger()

> **validatedLedger**(): `Promise`\<`number`>

`ledger` `validated` → `ledger_index`.

###### Returns

`Promise`\<`number`>

***

### XrplRef

The read keys recorded at claim.

#### Properties

| Property              | Type                   |
| --------------------- | ---------------------- |
|  `expect`             | `string`               |
|  `fromLedger`         | `number`               |
|  `lastLedgerSequence` | `number` \| `null`     |
|  `network`            | `` `xrpl:${number}` `` |
|  `transaction`        | `string`               |

***

### XrplTxJson

#### Indexable

> \[`field`: `string`]: `unknown`

#### Properties

| Property               | Type      |
| ---------------------- | --------- |
|  `Account`             | `string`  |
|  `InvoiceID?`          | `string`  |
|  `LastLedgerSequence?` | `number`  |
|  `Memos?`              | `unknown` |
|  `TransactionType`     | `string`  |

***

### XrplUnsigned

What the wallet signs, and how its signed blob completes the payment.

#### Type Parameters

| Type Parameter |
| -------------- |
| `P`            |

#### Properties

| Property         | Type                        |
| ---------------- | --------------------------- |
|  `request`       | `object`                    |
| `request.kind`   | `"xrpl-tx"`                 |
| `request.txJson` | [`XrplTxJson`](#xrpltxjson) |

#### Methods

##### complete()

> **complete**(`signedBlob`): [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | `P`

###### Parameters

| Parameter    | Type     |
| ------------ | -------- |
| `signedBlob` | `string` |

###### Returns

[`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | `P`

## Type Aliases

### XrplCloseRef

> **XrplCloseRef** = `object`

#### Properties

| Property       | Type                          |
| -------------- | ----------------------------- |
|  `channel`     | `string`                      |
|  `network`     | [`XrplNetwork`](#xrplnetwork) |
|  `phase`       | `"close"`                     |
|  `transaction` | `string`                      |

***

### XrplCloseStatus

> **XrplCloseStatus** = \{ `ledgerIndex`: `number`; `state`: `"settled"`; } | \{ `state`: `"pending"`; `why`: `"not-found"` | `"not-validated"` | `"unreadable"`; } | \{ `state`: `"failed"`; `why`: `"not-a-close"`; }

***

### XrplNetwork

> **XrplNetwork** = `` `xrpl:${number}` ``

CAIP-2: `xrpl:` and the chain's NetworkID, 0 to 4294967295.

***

### XrplStatus

> **XrplStatus** = \{ `ledgerIndex`: `number`; `state`: `"settled"`; } | \{ `state`: `"pending"`; `why`: `"not-found"` | `"not-validated"` | `"unreadable"`; } | \{ `state`: `"failed"`; `why`: `"expired"` | `"claimed-fee"` | `"not-this-instrument"`; }

## Variables

### XRPL\_MAX\_DEPTH

> `const` **XRPL\_MAX\_DEPTH**: `64` = `64`

The deepest nesting of STObject and STArray fields inside a transaction: an object or array field one level below
its container, and an array's member object one level below the array.

***

### XRPL\_MAX\_FIELDS

> `const` **XRPL\_MAX\_FIELDS**: `number`

The most fields, counting array members, that one blob may hold. Every field takes at least its one-byte header, so
no blob within `MAX_BLOB_HEX` holds more.

## Functions

### cancelAfterOf()

> **cancelAfterOf**(`blobHex`): `number` | `undefined`

The `CancelAfter` (field 36 of type UInt32) of a signed blob, read from the canonical field order: every UInt16
field, then every UInt32 field in field-code order, precede all others. Undefined when the blob has none.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `blobHex` | `string` |

#### Returns

`number` | `undefined`

***

### decodeBlob()

> **decodeBlob**(`hex`): `Promise`\<[`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | \{ `hash`: `string`; `tx`: [`XrplTxJson`](#xrpltxjson); }>

Decodes a signed blob of at most 4 KiB of hex, and computes its transaction hash as the ledger does: SHA-512Half
over `54584E00` and the blob, in upper case. The blob must be the canonical serialization of what it decodes to: the
codec's encoding of the decoded fields gives back the same bytes, so nothing follows a top-level end marker and
every array member is an object.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `hex`     | `string` |

#### Returns

`Promise`\<[`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | \{ `hash`: `string`; `tx`: [`XrplTxJson`](#xrpltxjson); }>

***

### mppInvoiceId()

> **mppInvoiceId**(`h`): `string`

The hash's 64 hex digits in upper case, without `0x`: MPP's `methodDetails.invoiceId`.

#### Parameters

| Parameter | Type                |
| --------- | ------------------- |
| `h`       | `` `0x${string}` `` |

#### Returns

`string`

***

### x402InvoiceId()

> **x402InvoiceId**(`h`): `Promise`\<`string`>

Uppercase hex of SHA-256 over the UTF-8 bytes of the hash's LCP string: x402's `InvoiceID` for `extra.invoiceId`.

#### Parameters

| Parameter | Type                |
| --------- | ------------------- |
| `h`       | `` `0x${string}` `` |

#### Returns

`Promise`\<`string`>

***

### xrplChannelId()

> **xrplChannelId**(`account`, `destination`, `sequence`): `string` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)

The PayChannel id: SHA-512Half of `0x0078` ‖ the source's AccountID ‖ the destination's AccountID ‖ the creating
transaction's sequence (or ticket sequence), big-endian; upper-case hex. A malformed address or sequence is
`xrpl/not-channel-create`.

#### Parameters

| Parameter     | Type     |
| ------------- | -------- |
| `account`     | `string` |
| `destination` | `string` |
| `sequence`    | `number` |

#### Returns

`string` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)

***

### xrplClaim()

> **xrplClaim**(`channelId`, `drops`): `Uint8Array`\<`ArrayBufferLike`> | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)

The bytes a channel claim signs: `CLM\0` ‖ channel id (32 bytes) ‖ drops as u64 big-endian.

#### Parameters

| Parameter   | Type     |
| ----------- | -------- |
| `channelId` | `string` |
| `drops`     | `bigint` |

#### Returns

`Uint8Array`\<`ArrayBufferLike`> | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)

***

### xrplCloseStatus()

> **xrplCloseStatus**(`ref`, `reader`): `Promise`\<[`XrplCloseStatus`](#xrplclosestatus)>

Reads a reported close: validated with the channel among the transaction's deleted `PayChannel` entries is settled;
validated without it is failed `not-a-close`; otherwise pending. One call.

#### Parameters

| Parameter | Type                            |
| --------- | ------------------------------- |
| `ref`     | [`XrplCloseRef`](#xrplcloseref) |
| `reader`  | [`XrplReader`](#xrplreader)     |

#### Returns

`Promise`\<[`XrplCloseStatus`](#xrplclosestatus)>

***

### xrplOpenStatus()

> **xrplOpenStatus**(`ref`, `reader`): `Promise`\<[`XrplStatus`](#xrplstatus)>

Reads an opening by the hash computed from its signed blob: settled only when a validated ledger holds it with
`tesSUCCESS` as a `PaymentChannelCreate`; `tec` codes are final failures that claimed the fee; past
`LastLedgerSequence` with the whole range searched it expired. A failed read is pending. At most two calls.

#### Parameters

| Parameter | Type                                       |
| --------- | ------------------------------------------ |
| `ref`     | `Omit`\<[`XrplRef`](#xrplref), `"expect"`> |
| `reader`  | [`XrplReader`](#xrplreader)                |

#### Returns

`Promise`\<[`XrplStatus`](#xrplstatus)>

***

### xrplStatus()

> **xrplStatus**(`ref`, `reader`): `Promise`\<[`XrplStatus`](#xrplstatus)>

Reads a transaction by the hash computed from its signed blob. Settled only when a validated ledger holds it with
`tesSUCCESS` as a Payment whose `InvoiceID` is the one expected; `tec` codes are final failures that claimed the fee;
past `LastLedgerSequence` with the whole range searched it expired. A failed read is pending. At most two calls.

#### Parameters

| Parameter | Type                        |
| --------- | --------------------------- |
| `ref`     | [`XrplRef`](#xrplref)       |
| `reader`  | [`XrplReader`](#xrplreader) |

#### Returns

`Promise`\<[`XrplStatus`](#xrplstatus)>