xrpl
    Preparing search index...

    Interface SponsorshipSet

    A SponsorshipSet transaction creates, modifies, or deletes a Sponsorship object that defines a sponsorship relationship between two accounts.

    Only the sponsor can create or modify a Sponsorship object (Account must be the sponsor). CounterpartySponsor may only be used together with tfDeleteObject, allowing the sponsee to delete a Sponsorship it did not create by identifying the sponsor.

    interface SponsorshipSet {
        Account: string;
        AccountTxnID?: string;
        CounterpartySponsor?: string;
        Delegate?: string;
        Fee?: string;
        FeeAmountDelta?: string;
        Flags?: number | SponsorshipSetFlagsInterface;
        LastLedgerSequence?: number;
        MaxFee?: string;
        Memos?: Memo[];
        NetworkID?: number;
        RemainingOwnerCountDelta?: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        Sponsee?: string;
        Sponsor?: string;
        SponsorFlags?: number;
        SponsorSignature?: SponsorSignature;
        TicketSequence?: number;
        TransactionType: "SponsorshipSet";
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? CounterpartySponsor? Delegate? Fee? FeeAmountDelta? Flags? LastLedgerSequence? MaxFee? Memos? NetworkID? RemainingOwnerCountDelta? Sequence? Signers? SigningPubKey? SourceTag? Sponsee? Sponsor? SponsorFlags? SponsorSignature? TicketSequence? TransactionType TxnSignature?

    Properties

    Account: string

    The unique address of the transaction sender.

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    CounterpartySponsor?: string

    (Optional) The sponsor's address. Identifies the sponsor when the sponsee (Account) is submitting the transaction. Only valid together with tfDeleteObject; the sponsee cannot create or modify a Sponsorship, only delete one.

    Delegate?: string

    The delegate account that is sending the transaction.

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    FeeAmountDelta?: string

    (Optional) A signed delta (in drops) to apply to the sponsorship's fee allocation. A positive value tops up the balance the sponsee can draw from to pay transaction fees; a negative value draws it down. The delta is applied to whatever value the Sponsorship ledger entry currently holds, rather than replacing it outright. Must not be zero. Must be non-negative when creating a new Sponsorship (or RemainingOwnerCountDelta must be positive).

    Flags?: number | SponsorshipSetFlagsInterface

    Set of bit-flags for this transaction.

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    MaxFee?: string

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

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    RemainingOwnerCountDelta?: number

    (Optional) The signed delta to apply to the Sponsorship's RemainingOwnerCount (the number of reserve units the sponsor agrees to cover). Must be a non-zero integer when present. Positive to add coverage, negative to reduce it. Must be positive when creating a new Sponsorship (or FeeAmountDelta must be positive).

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    Sponsee?: string

    The account to be sponsored. This is the account that will benefit from the sponsorship (fees and/or reserves paid by the sponsor). Required when Account is the sponsor; omitted when using CounterpartySponsor.

    Sponsor?: string

    The account sponsoring this transaction (paying fees and/or reserves).

    SponsorFlags?: number

    Flags indicating sponsorship type (fee and/or reserve). Must be included if Sponsor field is present.

    SponsorSignature?: SponsorSignature

    Sponsor's signature information. Required for co-signed sponsorship (when no pre-funded Sponsorship object exists).

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    TransactionType: "SponsorshipSet"

    The type of transaction. Valid types include: Payment, OfferCreate, TrustSet, and many others.

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Settings

    Member Visibility

    On This Page

    Properties