xrpl
    Preparing search index...

    Interface SponsorshipTransfer

    A SponsorshipTransfer transaction transfers ownership of a ledger object's reserve sponsorship from one sponsor to another, creates a new sponsorship, or removes sponsorship entirely.

    This transaction allows changing which account is paying the reserve for a specific ledger object (such as a trust line, offer, escrow, etc.) or for account-level sponsorship.

    interface SponsorshipTransfer {
        Account: string;
        AccountTxnID?: string;
        Delegate?: string;
        Fee?: string;
        Flags?: number | SponsorshipTransferFlagsInterface;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        NetworkID?: number;
        ObjectID?: string;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        Sponsee?: string;
        Sponsor?: string;
        SponsorFlags?: number;
        SponsorSignature?: SponsorSignature;
        TicketSequence?: number;
        TransactionType: "SponsorshipTransfer";
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    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.

    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.

    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.

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    ObjectID?: string

    (Optional) The ledger object ID of the object whose sponsorship is being transferred. This identifies the specific ledger entry whose reserve sponsorship will be changed. When omitted, this transaction refers to account-level sponsorship.

    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

    (Optional) The account whose object/account-level sponsorship is being ended. Only valid for the tfSponsorshipEnd scenario; must not be present for tfSponsorshipCreate or tfSponsorshipReassign. Defaults to Account when omitted.

    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: "SponsorshipTransfer"

    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.