Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/api-md/classes/CustodyApiError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: CustodyApiError

Defined in: [errors.ts:116](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L116)
Defined in: [errors.ts:154](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L154)

A Ripple Custody API call returned an error. The diagnostic `hint` and full
response body are preserved for the caller to surface.
Expand All @@ -15,7 +15,7 @@ response body are preserved for the caller to surface.

> **new CustodyApiError**(`status`, `raw`, `hint`?): [`CustodyApiError`](CustodyApiError.md)

Defined in: [errors.ts:128](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L128)
Defined in: [errors.ts:166](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L166)

Construct a CustodyApiError.

Expand All @@ -41,7 +41,7 @@ Construct a CustodyApiError.

> `readonly` `optional` **hint**: `string`

Defined in: [errors.ts:118](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L118)
Defined in: [errors.ts:156](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L156)

***

Expand All @@ -61,12 +61,12 @@ Defined in: [errors.ts:9](https://github.com/ripple/simpleXRPL/blob/main/src/err

> `readonly` **raw**: `unknown`

Defined in: [errors.ts:119](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L119)
Defined in: [errors.ts:157](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L157)

***

### status

> `readonly` **status**: `number`

Defined in: [errors.ts:117](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L117)
Defined in: [errors.ts:155](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L155)
2 changes: 1 addition & 1 deletion docs/api-md/classes/CustodyAuthError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: CustodyAuthError

Defined in: [errors.ts:110](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L110)
Defined in: [errors.ts:148](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L148)

Authenticating with Ripple Custody failed (challenge/JWT exchange or refresh).

Expand Down
8 changes: 4 additions & 4 deletions docs/api-md/classes/DuplicateSignerError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: DuplicateSignerError

Defined in: [errors.ts:88](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L88)
Defined in: [errors.ts:126](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L126)

Two configured signers point at the same backend tenant — the same
`kind` and the same `tenantId` (§3.1). The client rejects this at init so
Expand All @@ -16,7 +16,7 @@ one backend is never registered twice; drop the duplicate signer.

> **new DuplicateSignerError**(`kind`, `tenantId`): [`DuplicateSignerError`](DuplicateSignerError.md)

Defined in: [errors.ts:98](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L98)
Defined in: [errors.ts:136](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L136)

Construct a DuplicateSignerError.

Expand All @@ -41,7 +41,7 @@ Construct a DuplicateSignerError.

> `readonly` **kind**: [`CustodianKind`](../type-aliases/CustodianKind.md)

Defined in: [errors.ts:89](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L89)
Defined in: [errors.ts:127](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L127)

***

Expand All @@ -61,4 +61,4 @@ Defined in: [errors.ts:9](https://github.com/ripple/simpleXRPL/blob/main/src/err

> `readonly` **tenantId**: `string`

Defined in: [errors.ts:90](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L90)
Defined in: [errors.ts:128](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L128)
10 changes: 5 additions & 5 deletions docs/api-md/classes/IntentPendingError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: IntentPendingError

Defined in: [errors.ts:171](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L171)
Defined in: [errors.ts:209](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L209)

Not a failure — a "still waiting" signal raised when a custodian intent has
not reached a terminal state before the SDK's timeout. Resume later with the
Expand All @@ -16,7 +16,7 @@ carried `intentId`.

> **new IntentPendingError**(`intentId`, `custodian`, `lastState`): [`IntentPendingError`](IntentPendingError.md)

Defined in: [errors.ts:183](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L183)
Defined in: [errors.ts:221](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L221)

Construct an IntentPendingError.

Expand All @@ -42,23 +42,23 @@ Construct an IntentPendingError.

> `readonly` **custodian**: `"ripple-custody"` \| `"palisade-custody"`

Defined in: [errors.ts:173](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L173)
Defined in: [errors.ts:211](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L211)

***

### intentId

> `readonly` **intentId**: `string`

Defined in: [errors.ts:172](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L172)
Defined in: [errors.ts:210](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L210)

***

### lastState

> `readonly` **lastState**: `string`

Defined in: [errors.ts:174](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L174)
Defined in: [errors.ts:212](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L212)

***

Expand Down
8 changes: 4 additions & 4 deletions docs/api-md/classes/MultiStepFailureError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: MultiStepFailureError

Defined in: [errors.ts:220](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L220)
Defined in: [errors.ts:258](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L258)

A multi-step operation failed partway through. simpleXRPL does not roll back; the
already-committed steps are carried so the caller can reconcile manually.
Expand All @@ -15,7 +15,7 @@ already-committed steps are carried so the caller can reconcile manually.

> **new MultiStepFailureError**(`committed`, `failed`): [`MultiStepFailureError`](MultiStepFailureError.md)

Defined in: [errors.ts:235](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L235)
Defined in: [errors.ts:273](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L273)

Construct a MultiStepFailureError.

Expand All @@ -42,15 +42,15 @@ Construct a MultiStepFailureError.

> `readonly` **committed**: readonly [`SubmissionResult`](../type-aliases/SubmissionResult.md)[]

Defined in: [errors.ts:221](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L221)
Defined in: [errors.ts:259](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L259)

***

### failed

> `readonly` **failed**: \{ `error`: [`SimpleXRPLError`](SimpleXRPLError.md); `step`: `number`; \}

Defined in: [errors.ts:222](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L222)
Defined in: [errors.ts:260](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L260)

#### error

Expand Down
75 changes: 75 additions & 0 deletions docs/api-md/classes/NetworkMismatchError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Class: NetworkMismatchError

Defined in: [errors.ts:90](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L90)

An account exists at a custodian, but only on XRPL network(s) other than the
one the client is connected to. The SDK refuses to route a transaction to the
wrong network (which would silently strand it), so point the client's
`xrpldUrl` at a node on a matching network, or register the address on this
network at the custodian.

## Extends

- [`SimpleXRPLError`](SimpleXRPLError.md)

## Constructors

### new NetworkMismatchError()

> **new NetworkMismatchError**(`account`, `clientNetworkId`, `availableNetworkIds`): [`NetworkMismatchError`](NetworkMismatchError.md)

Defined in: [errors.ts:103](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L103)

Construct a NetworkMismatchError.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `account` | `string` | The r-address that has no record on the client's network. |
| `clientNetworkId` | `undefined` \| `number` | The network id the client is connected to, or `undefined` when it could not be determined. |
| `availableNetworkIds` | readonly `number`[] | The network ids the account does exist on. |

#### Returns

[`NetworkMismatchError`](NetworkMismatchError.md)

#### Overrides

[`SimpleXRPLError`](SimpleXRPLError.md).[`constructor`](SimpleXRPLError.md#constructors)

## Properties

### account

> `readonly` **account**: `string`

Defined in: [errors.ts:91](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L91)

***

### availableNetworkIds

> `readonly` **availableNetworkIds**: readonly `number`[]

Defined in: [errors.ts:93](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L93)

***

### clientNetworkId

> `readonly` **clientNetworkId**: `undefined` \| `number`

Defined in: [errors.ts:92](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L92)

***

### name

> `readonly` **name**: `string`

Defined in: [errors.ts:9](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L9)

#### Inherited from

[`SimpleXRPLError`](SimpleXRPLError.md).[`name`](SimpleXRPLError.md#name)
10 changes: 5 additions & 5 deletions docs/api-md/classes/PalisadeApiError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: PalisadeApiError

Defined in: [errors.ts:146](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L146)
Defined in: [errors.ts:184](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L184)

A Palisade API call returned an error. The diagnostic `hint` (the
`rpcStatus.message` Palisade's equivalent of Custody's `processing.hint`)
Expand All @@ -16,7 +16,7 @@ and full response body are preserved for the caller to surface.

> **new PalisadeApiError**(`status`, `raw`, `hint`?): [`PalisadeApiError`](PalisadeApiError.md)

Defined in: [errors.ts:158](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L158)
Defined in: [errors.ts:196](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L196)

Construct a PalisadeApiError.

Expand All @@ -42,7 +42,7 @@ Construct a PalisadeApiError.

> `readonly` `optional` **hint**: `string`

Defined in: [errors.ts:148](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L148)
Defined in: [errors.ts:186](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L186)

***

Expand All @@ -62,12 +62,12 @@ Defined in: [errors.ts:9](https://github.com/ripple/simpleXRPL/blob/main/src/err

> `readonly` **raw**: `unknown`

Defined in: [errors.ts:149](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L149)
Defined in: [errors.ts:187](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L187)

***

### status

> `readonly` **status**: `number`

Defined in: [errors.ts:147](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L147)
Defined in: [errors.ts:185](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L185)
2 changes: 1 addition & 1 deletion docs/api-md/classes/PalisadeAuthError.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: PalisadeAuthError

Defined in: [errors.ts:139](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L139)
Defined in: [errors.ts:177](https://github.com/ripple/simpleXRPL/blob/main/src/errors.ts#L177)

Authenticating with Palisade failed (API key).

Expand Down
Loading
Loading