xrpl
    Preparing search index...

    Interface Sponsorship

    The Sponsorship object type represents a sponsorship relationship between two accounts, where the sponsor (Owner) pays fees and/or reserves on behalf of the sponsee.

    interface Sponsorship {
        FeeAmount?: string;
        Flags: number;
        index: string;
        LedgerEntryType: "Sponsorship";
        MaxFee?: string;
        Owner: string;
        OwnerNode: string;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        RemainingOwnerCount?: number;
        Sponsee: string;
        SponseeNode: string;
    }

    Hierarchy

    • BaseLedgerEntry
    • HasPreviousTxnID
      • Sponsorship
    Index

    Properties

    FeeAmount? Flags index LedgerEntryType MaxFee? Owner OwnerNode PreviousTxnID PreviousTxnLgrSeq RemainingOwnerCount? Sponsee SponseeNode

    Properties

    FeeAmount?: string

    The amount of XRP (in drops) available for paying transaction fees on behalf of the sponsee. This is a pre-funded balance that gets decremented when the sponsor pays fees for the sponsee's transactions.

    Flags: number

    A bit-map of boolean flags. Possible flags include:

    • lsfSponsorshipRequireSignForFee (0x00010000): Requires sponsee signature for fee sponsorship
    • lsfSponsorshipRequireSignForReserve (0x00020000): Requires sponsee signature for reserve sponsorship
    index: string
    LedgerEntryType: "Sponsorship"
    MaxFee?: string

    The maximum fee (in drops) that the sponsor is willing to pay per transaction on behalf of the sponsee. If not specified, there is no per-transaction limit.

    Owner: string

    The account that is sponsoring (paying fees/reserves). This is the owner of the Sponsorship object.

    OwnerNode: string

    A hint indicating which page of the sponsor's owner directory links to this object, in case the directory consists of multiple pages.

    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.

    RemainingOwnerCount?: number

    The number of ledger objects for which the sponsor is paying reserves on behalf of the sponsee. This count is incremented when the sponsor pays for object creation and decremented when sponsored objects are deleted. Default value is 0.

    Sponsee: string

    The account being sponsored (receiving fee/reserve coverage).

    SponseeNode: string

    A hint indicating which page of the sponsee's owner directory links to this object, in case the directory consists of multiple pages.

    Settings

    Member Visibility

    On This Page

    Properties