documents new vaultClawback functionaliy #422
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 tasks
ximinez
requested changes
Dec 16, 2025
|
|
||
| - If `Vault.Asset` is an `IOU` and: | ||
| - The `Issuer` account is not the submitter of the transaction. | ||
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `IOU`: |
Collaborator
There was a problem hiding this comment.
Suggested change
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `IOU`: | |
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `IOU` and: |
Otherwise there might be confusion about whether to fail if the submitter is issuer and asset is an IOU, and nothing else.
|
|
||
| - If `Vault.Asset` is an `MPT` and: | ||
| - `MPTokenIssuance.Issuer` is not the submitter of the transaction. | ||
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `MPT`: |
Collaborator
There was a problem hiding this comment.
Suggested change
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `MPT`: | |
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `MPT` and: |
| - `MPTokenIssuance.Issuer` is not the submitter of the transaction. | ||
| - If the submitter is the **Asset Issuer** and `Vault.Asset` is an `MPT`: | ||
| - `MPTokenIssuance.lsfMPTCanClawback` flag is not set (the asset does not support clawback). | ||
| - If the `MPTokenIssuance.lsfMPTCanLock` flag is NOT set (the asset cannot be locked). |
Collaborator
There was a problem hiding this comment.
I think we've established that lsfMPTCanLock is not required for MPT clawbacks.
gregtatcam
reviewed
Jan 5, 2026
| ##### 3.3.1.1 Failure conditions | ||
| - **Asset Issuer**: The `Amount` must be specified as the Vault's asset type (IOU or MPT). The transaction will clawback up to `Amount` of assets from the `Holder`'s shares, sending the funds to the Issuer's account. | ||
|
|
||
| - **Vault Owner**: The `Amount` must be specified as the Vault's share type (MPT), where `mpt_issuance_id` matches `Vault.MPTokenIssuanceID`. Since the Vault Owner can only submit this transaction when `Vault.AssetsTotal` and `Vault.AssetsAvailable` are both zero, no assets are transferred—only shares are destroyed. Partial burns are not permitted, the Vault Owner must burn all shares held by the `Holder`. The `Amount` can be specified as either: |
Collaborator
There was a problem hiding this comment.
Why not make it simpler by just making amount absent in this case? This would imply burning all shares assuming all other conditions are met.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extends the VaultClawback transaction to allow the Vault Owner to force burn depositor shares when the vault has no assets remaining.
Problem
A vault can become permanently stuck when Vault.AssetsTotal and Vault.AssetsAvailable are both zero, but shares still exist. This situation may arise when a loan issued for the total of the vault's assets defaults. In this state:
Deposits cannot settle the balance
The Vault object becomes non-deletable
Solution
The VaultClawback transaction can now be submitted by:
Asset Issuer (existing functionality): Clawback funds from the vault, specifying Amount as the vault's asset (IOU or MPT).
Vault Owner (new functionality): Force burn worthless shares when both Vault.AssetsTotal and Vault.AssetsAvailable are zero. The Amount must be specified as the vault's share (MPT), and partial burns are not permitted—the Vault Owner must burn all shares held by the Holder.
Changes
Updated VaultClawback transaction description to document both use cases
Added Amount field documentation clarifying the expected asset type per submitter
Updated failure conditions to authorize Vault Owner and enforce the zero-asset requirement