Skip to content

spec(XLS-65): Update VaultDeposit failure conditions and state changes#552

Open
Tapanito wants to merge 34 commits into
masterfrom
tapanito/spec-vault-deposit
Open

spec(XLS-65): Update VaultDeposit failure conditions and state changes#552
Tapanito wants to merge 34 commits into
masterfrom
tapanito/spec-vault-deposit

Conversation

@Tapanito

Copy link
Copy Markdown
Collaborator

Syncs the VaultDeposit spec section with the current implementation in src/libxrpl/tx/transactors/vault/VaultDeposit.cpp.

Data Verification (3.5.2.1) — was _None._, now has two items:

  • VaultID = 0 (temMALFORMED)
  • Amount ≤ 0 (temBAD_AMOUNT)

Protocol-Level Failures (3.5.2.2) — extended from 7 to 13 items:

  • Private vault auth: split into two sub-cases (no domain configured → tecNO_AUTH; not a valid domain member → tecNO_AUTH)
  • Added: vault shares locked for depositor (tecLOCKED)
  • Added: depositor lacks required authorized holding for MPT (tecNO_AUTH)
  • Added: amount rounds to zero at vault scale (tecPRECISION_LOSS)
  • Added: amount rounds to zero at depositor trust line scale / IOU (tecPRECISION_LOSS)
  • Added: computed share amount is zero (tecPRECISION_LOSS)
  • Added: arithmetic overflow in share calculation (tecPATH_DRY)
  • Added error codes to all items

State Changes (3.5.3) — corrected:

  • Use $\Delta_{asset}$ throughout (actual transferred amount may be less than requested Amount due to IOU scale rounding)
  • Note on rounding added

Tapanito and others added 30 commits February 11, 2026 15:15
…tion

- Add Example JSON sections for Vault ledger entry and all transactions
  (VaultCreate, VaultSet, VaultDelete, VaultDeposit, VaultWithdraw,
  VaultClawback, Payment) with real transaction data
- Add invariants for the Vault ledger entry (universal checks) and all
  transaction types derived from the ValidVault invariant checker
- Restructure section 10 from "API" to "RPC: vault_info" matching the
  amendment template format with Request Fields, Response Fields,
  Failure Conditions, Example Request, and Example Response subsections
- Update response fields table with missing fields (Data, Asset.mpt_issuance_id,
  shares.DomainID, shares.MPTokenMetadata) and correct Always Present values
- Update response examples to use proper JSON format with response envelope
- Add section 9.1 Fields for Payment transaction
- Remove Index section and all Return to Index links

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Reorganize top-level sections: Abstract (1), Introduction (2),
  Specification (3), Rationale (4), Security Considerations (5),
  Appendix
- Move all ledger entry, transaction, and RPC sections under
  "3. Specification" as subsections (3.1-3.9)
- Remove "1.1 Overview" heading, merge content into Introduction body
- Renumber Introduction subsections: Terminology (2.1), Actors (2.2),
  Connecting to the Vault (2.3)
- Demote all specification headings by one level with new numbering
- Add Rationale section explaining decoupled vault design
- Rename FAQ section to "Appendix A: FAQ" with A.x numbering
- Fix heading levels for Key Variables and Vault State Update

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove functional additions (invariants, example JSONs, error codes)
added in this branch and retain only structural changes that bring
the spec into conformance with AMENDMENT_TEMPLATE.md and XLS_TEMPLATE.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Convert failure conditions and state changes from numbered lists back
to master's original nested bullet-point format. Keep the Data
Verification / Protocol-Level Failures subsection headers as template
compliance, but use master's original content and structure inside them.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Convert bullet points in Failure Conditions and State Changes sections
to numbered lists with nested sub-numbering, per template requirements.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Mayukha Vadari <mvadari@gmail.com>
Base automatically changed from tapanito/vault-enhanced to master May 28, 2026 15:12
An error occurred while trying to automatically change base from tapanito/vault-enhanced to master May 28, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant