xrpl

xrpl

Each rule under rules/ is self-contained: an incorrect example, a correct example, and links to upstream xrpl.js source, xrpl.org docs, and (where available) an XRPL Developer Portal code sample. Use the index below to jump to the rule that fits the task.

This skill is not an API reference. For exhaustive type signatures, see js.xrpl.org. For XLS protocol specs, use the companion `xrpl-standards` skill — when work touches AMM, MPT, NFToken, Credentials, Batch, etc., load both skills.

Read first: Security

These four rules are non-negotiable. Funds have been lost over every one of them.

• `security-partial-payment` — always credit `delivered_amount`, never `Amount` on incoming payments. Partial-payment inflation is the canonical XRPL exchange exploit.
• `security-validate-meta` — a preliminary tesSUCCESS does not mean the tx was applied. Only validated-ledger meta is authoritative.
• `security-lastledgersequence` — never submit without LastLedgerSequence. Without it a transaction can replay weeks later.
• `security-validate-destination-tag` — honor requireDestTag; a missing tag on a custodial destination loses funds.

What to read when

Map the user's task to the rules to consult before writing code.

Full rule index

Impact tags below match each rule file's frontmatter (CRITICAL, HIGH, MEDIUM).

Security

• `security-partial-payment` — CRITICAL — Read delivered_amount, not Amount
• `security-validate-meta` — CRITICAL — Wait for validated: true before crediting
• `security-lastledgersequence` — CRITICAL — Always set LastLedgerSequence
• `security-validate-destination-tag` — CRITICAL — Honor requireDestTag on destination

Amounts & numbers

• `amounts` — CRITICAL — Drops + BigInt for XRP, bignumber.js for IOUs, never JS number; respect the 15-digit IOU mantissa

Client & connection

• `client` — HIGH — One shared Client per app, wss:// over https://, trust the built-in reconnect, always disconnect on shutdown

Wallet & signing

• `wallet-secure-entropy` — CRITICAL — Wallet.generate() only; never hand-rolled entropy
• `wallet-prefer-ed25519` — MEDIUM — Default to ed25519
• `wallet-regular-key-for-hot-wallets` — HIGH — Use SetRegularKey so the master key can be disabled

Transactions & submission

• `tx-autofill-before-sign` — HIGH — client.autofill(tx) before signing
• `tx-submitandwait` — HIGH — Prefer submitAndWait over submit
• `tx-handle-tec-codes` — HIGH — Distinguish tec* (applied, failed) from tem* / tef* / ter* (not applied)
• `tx-idempotent-retry` — HIGH — Reuse Sequence or Ticket on retry
• `read-pagination-marker` — MEDIUM — Loop on marker for paginated requests

Code samples

The rules in this skill explain what to do and why. When you need a runnable, end-to-end example — how to actually construct, sign, and submit a transaction — go to the XRPL Developer Portal code samples. They are maintained by XRPLF and stay current with xrpl.js. Prefer them over inventing example code.

When the user asks "how do I send a payment / mint an NFT / set up an escrow" and the answer requires runnable code, fetch the matching sample and adapt it — do not paraphrase the structure from memory.

How to Use

Once you have picked a rule from the table above, read its file:

Read <skill-dir>/rules/<rule-name>.md

<skill-dir> resolves to wherever the skill is installed — ~/.claude/skills/xrpl/ for a user-level Claude Code install, .claude/skills/xrpl/ for a project-level install, /mnt/skills/user/xrpl/ on claude.ai, or a plugin-managed path. Don't hard-code the directory; rely on the path the host resolves.

Each rule file contains:

• Frontmatter — title, impact (CRITICAL / HIGH / MEDIUM), tags, and where applicable xrpl_js_source, upstream_docs, code_sample. Fields with no good link are omitted; treat any of these as optional metadata.
• Why it matters — one or two sentences explaining the failure mode.
• Incorrect example — what the broken code typically looks like.
• Correct example — the idiomatic fix.
• Notes — edge cases, related amendments, version caveats.
• See also — explicit links back to upstream xrpl.js source files, xrpl.org protocol docs, and (where it exists) a dev-portal code sample.

Companion skill: xrpl-standards

If the task touches a specific XLS amendment (AMM, MPT, NFToken, Credentials, Batch, DID, Clawback, Permissioned DEX, etc.), load the `xrpl-standards` skill alongside this one. That skill holds the raw spec text — field definitions, transaction formats, ledger objects, failure conditions — that this skill deliberately does not duplicate.

Authoritative external resources

• xrpl.js API reference: https://js.xrpl.org
• xrpl.js source: https://github.com/XRPLF/xrpl.js
• Protocol docs: https://xrpl.org/docs
• Code samples: https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples
• Standards (XLS): load the `xrpl-standards` skill