xrpl
    Preparing search index...

    Interface LoanBroker

    The LoanBroker object captures attributes of the Lending Protocol.

    interface LoanBroker {
        Account: string;
        CoverAvailable?: string;
        CoverRateLiquidation?: number;
        CoverRateMinimum?: number;
        DebtMaximum: string;
        DebtTotal?: string;
        Flags: number;
        index: string;
        LedgerEntryType: "LoanBroker";
        LoanSequence: number;
        Owner: string;
        OwnerCount?: number;
        OwnerNode: string;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        Sequence: number;
        VaultID: string;
        VaultNode: string;
    }

    Hierarchy

    • BaseLedgerEntry
    • HasPreviousTxnID
      • LoanBroker
    Index

    Properties

    Account CoverAvailable? CoverRateLiquidation? CoverRateMinimum? DebtMaximum DebtTotal? Flags index LedgerEntryType LoanSequence Owner OwnerCount? OwnerNode PreviousTxnID PreviousTxnLgrSeq Sequence VaultID VaultNode

    Properties

    Account: string

    The address of the LoanBroker pseudo-account.

    CoverAvailable?: string

    The total amount of first-loss capital deposited into the Lending Protocol.

    CoverRateLiquidation?: number

    The 1/10th basis point of minimum required first loss capital that is liquidated to cover a Loan default. Valid values are between 0 and 100000 inclusive. A value of 1 is equivalent to 1/10 bps or 0.001%.

    CoverRateMinimum?: number

    The 1/10th basis point of the DebtTotal that the first loss capital must cover. Valid values are between 0 and 100000 inclusive. A value of 1 is equivalent to 1/10 bps or 0.001%.

    DebtMaximum: string

    The maximum amount the protocol can owe the Vault. The default value of 0 means there is no limit to the debt.

    DebtTotal?: string

    The total asset amount the protocol owes the Vault, including interest.

    Flags: number

    Ledger object flags.

    index: string
    LedgerEntryType: "LoanBroker"
    LoanSequence: number

    A sequential identifier for Loan objects, incremented each time a new Loan is created by this LoanBroker instance.

    Owner: string

    The address of the Loan Broker account.

    OwnerCount?: number

    The number of active Loans issued by the LoanBroker.

    OwnerNode: string

    Identifies the page where this item is referenced in the owner's directory.

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    Sequence: number

    The transaction sequence number of LoanBrokerSet transaction that created this LoanBroker object.

    VaultID: string

    The ID of the Vault object associated with this Lending Protocol Instance.

    VaultNode: string

    Identifies the page where this item is referenced in the Vault's pseudo-account owner's directory.

    Settings

    Member Visibility

    On This Page

    Properties