Last updated
Edit

TrustSet

[Source]

Create or modify a trust line linking two accounts.

Example TrustSet JSON

{
    "TransactionType": "TrustSet",
    "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
    "Fee": "12",
    "Flags": 262144,
    "LastLedgerSequence": 8007750,
    "LimitAmount": {
      "currency": "USD",
      "issuer": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
      "value": "100"
    },
    "Sequence": 12
}

Query example transaction. >

TrustSet Fields

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

FieldJSON TypeInternal TypeDescription
LimitAmountObjectAmountObject defining the trust line to create or modify, in the format of a Currency Amount.
LimitAmount.currencyString(Amount.currency)The currency to this trust line applies to, as a three-letter ISO 4217 Currency Code or a 160-bit hex value according to currency format. "XRP" is invalid.
LimitAmount.valueString(Amount.value)Quoted decimal representation of the limit to set on this trust line.
LimitAmount.issuerString(Amount.issuer)The address of the account to extend trust to.
QualityInNumberUInt32(Optional) Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of 0 is shorthand for treating balances at face value. For example, if you set the value to 10,000,000, 1% of incoming funds remain with the sender. If an account sends 100 currency, the sender retains 1 currency unit and the destination receives 99 units. This option is included for parity: in practice, you are much more likely to set a QualityOut value. Note that this fee is separate and independent from token transfer fees.
QualityOutNumberUInt32(Optional) Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of 0 is shorthand for treating balances at face value. For example, if you set the value to 10,000,000, 1% of outgoing funds would remain with the issuer. If the sender sends 100 currency units, the issuer retains 1 currency unit and the destination receives 99 units. Note that this fee is separate and independent from token transfer fees.

If the account specified in LimitAmount.issuer is blocking incoming trust lines, the transaction fails with the result code tecNO_PERMISSION. (Requires the DisallowIncoming amendment )

TrustSet Flags

Transactions of the TrustSet type support additional values in the Flags field, as follows:

Flag NameHex ValueDecimal ValueDescription
tfSetfAuth0x0001000065536Authorize the other party to hold currency issued by this account. (No effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.
tfSetNoRipple0x00020000131072Enable the No Ripple flag, which blocks rippling between two trust lines of the same currency if this flag is enabled on both.
tfClearNoRipple0x00040000262144Disable the No Ripple flag, allowing rippling on this trust line.
tfSetFreeze0x001000001048576Freeze the trust line.
tfClearFreeze0x002000002097152Unfreeze the trust line.

If a transaction tries to enable No Ripple but cannot, it fails with the result code tecNO_PERMISSION. Before the fix1578 amendment became enabled, such a transaction would result in tesSUCCESS (making any other changes it could) instead.

The Auth flag of a trust line does not determine whether the trust line counts towards its owner's XRP reserve requirement. However, an enabled Auth flag prevents the trust line from being in its default state. An authorized trust line can never be deleted. An issuer can pre-authorize a trust line with the tfSetfAuth flag only, even if the limit and balance of the trust line are 0.