Place an order on the DEX to acquire more of this IOU.
iou.buyOffer(
params: IOUOfferParams,
options?: IOUWriteOptions,
): Promise<SubmissionResult<undefined>>| Parameter | Type | Required | Description |
|---|---|---|---|
ticker | string | Yes | The currency code (3-character ISO-4217-style or 40-character hex; other codes are auto-encoded to hex). |
amount | string | Yes | The number of units of this IOU to buy, as a decimal string. Must be non-negative, with at most 15 significant digits. |
orderType | IOUOrderType | Yes | The order type: 'limit', 'market', 'fok', or 'passive'. |
price | IOUOfferPrice | Yes | What's offered in payment — XRP, an MPT, or another IOU (see below). |
domainID | string | No | Restrict the offer to a permissioned domain. Omit for the open DEX. |
hybrid | boolean | No | Whether a domain-scoped offer also works the open DEX. Only meaningful with domainID; defaults to true when domainID is set. |
offerSequence | number | No | A prior offer sequence to replace. |
price (IOUOfferPrice) is one of:
| Shape | Description |
|---|---|
{ currency: 'XRP'; amount: string } | Priced in XRP. Must be non-negative, with at most 6 decimal places (1 drop, XRP's smallest unit). |
{ mptIssuanceId: string; amount: string } | Priced in an MPT. However, the XRPL DEX doesn't support MPTs yet and will always be rejected. |
{ ticker: string; issuer: string; amount: string } | Priced in another IOU. Must be non-negative, with at most 15 significant digits — the XRPL issued-currency limit. |
options is an optional second argument that sets the source account and overrides the fee.
| Option | Type | Required | Description |
|---|---|---|---|
from | AccountSelector | No | The account to act as — an r-address string, or an object { address } or { signer, account? }. Defaults to the primary signer's primary account. (For IOU operations, this is the issuer.) |
fee | FeeIntent | No | Fee override — a priority tier and/or a maxFeeDrops cap. |
idempotencyKey | string | No | A prior submission's idempotencyKey, to retry to the same intent instead of creating a duplicate. Auto-generated when omitted. |
Resolves to a SubmissionResult<undefined>.
Every simpleXRPL write resolves to a SubmissionResult<T> — a union tagged by source, with the backend's raw response preserved verbatim. Its common fields are:
| Field | Type | Description |
|---|---|---|
intent | T | The operation-specific output — see the operation's own return fields. |
source | 'xrpld' | 'custody' | 'palisade' | Which backend produced the result; discriminates response. |
response | TxResponse | custody record | Palisade record | The backend's raw response, preserved verbatim. |
txHash | string (optional) | The XRPL transaction hash, once the transaction is on-ledger. |
intentId | string (optional) | The custodian intent id, when the path produced one. Hold onto this to resume via client.intent. |
idempotencyKey | string (optional) | The UUIDv7 this submission carried. Pass it back as a later call's idempotencyKey to retry to the same intent rather than creating a duplicate. |
IOU.buyOffer attaches no intent output; intent is undefined.
Builds and submits a single OfferCreate transaction. Throws an IntentValidationError if price is MPT-denominated.
await client.iou.buyOffer({
ticker: 'USD',
amount: '100',
orderType: 'limit',
price: { currency: 'XRP', amount: '50' },
})