Skip to content

LoanBrokerCoverClawback

[Source]

Attention

Lending Protocol and Single Asset Vaults are disabled on Devnet. You have two options for testing these features:

  1. Run rippled in stand-alone mode and enable LendingProtocol and SingleAssetVault in the rippled.cfg file.
  2. Connect to the Lending Protocol-specific Devnet at https://lend.devnet.rippletest.net:51234/.

The LoanBrokerCoverClawback transaction claws back first-loss capital from a LoanBroker ledger entry. The transaction can only be submitted by the issuer of the asset used in the lending protocol, and can't clawback an amount that would cause the available first-loss capital to drop below the minimum amount defined by the LoanBroker.CoverRateMinimum value.

(Requires the Lending Protocol amendment )

Example LoanBrokerCoverClawback JSON

{
  "TransactionType": "LoanBrokerCoverClawback",
  "Account": "rEXAMPLE9AbCdEfGhIjKlMnOpQrStUvWxYz",
  "Fee": "12",
  "Flags": 0,
  "LastLedgerSequence": 7108682,
  "Sequence": 8,
  "LoanBrokerID": "E123F4567890ABCDE123F4567890ABCDEF1234567890ABCDEF1234567890ABCD",
  "Amount": {
    "currency": "USD",
    "issuer": "rIssuer1234567890abcdef1234567890abcdef",
    "value": "1000"
  }
}

LoanBrokerCoverClawback Fields

In addition to the common fields, LoanBrokerCoverClawback transactions use the following fields:

Field NameJSON TypeInternal TypeRequired?Description
LoanBrokerIDStringHash256NoThe ID of the LoanBroker ledger entry to clawback first-loss capital. Must be provided if Amount is an MPT, or Amount is an IOU and the specified issuer matches the Account submitting the transaction.
AmountObjectAmountNoThe amount of first-loss capital to claw back. If the value is 0 or empty, claw back all assets down to the minimum cover (DebtTotal * CoverRateMinimum).

Error Cases

Besides errors that can occur for all transactions, LoanBrokerCoverClawback transactions can result in the following transaction result codes:

Error CodeDescription
temINVALID- The transaction is missing the LoanBrokerID and Amount fields.
- LoanBrokerID is invalid.
- Amount is an MPT and LoanBrokerID is missing.
- Amount is an IOU and its issuer matches Account.
temBAD_AMOUNT- Amount is less than or equal to zero.
- Amount specifies the native XRP.
tecNO_ENTRY- The LoanBroker ledger entry doesn't exist, or the asset issuer doesn't exist.
tecNO_PERMISSION- The asset doesn't support clawback, or the asset can't be frozen.
- The transaction is attempting to clawback native XRP.
- The Account isn't the asset issuer.
tecWRONG_ASSETThe specified asset to clawback doesn't match the asset in the lending protocol vault.
tecINTERNALThe balance of the trust line doesn't match the CoverAvailable field.
tecINSUFFICIENT_FUNDSClawing back the specified Amount puts the available cover below the minimum required. You can also receive this error if the issuer of the asset has frozen the account or placed a global freeze.