Show / Hide Table of Contents

Class SponsorshipSet

The SponsorshipSet transaction creates or updates a Sponsorship relationship, allowing the sponsor to pay transaction fees and/or reserves on behalf of the sponsee.

Inheritance
object
TransactionRequest
SponsorshipSet
Implements
ITransactionRequest
ISponsorshipSet
ITransactionCommon
Inherited Members
TransactionRequest.NetworkID
TransactionRequest.Account
TransactionRequest.AccountTxnID
TransactionRequest.Fee
TransactionRequest.LastLedgerSequence
TransactionRequest.Memos
TransactionRequest.Sequence
TransactionRequest.SigningPublicKey
TransactionRequest.Signers
TransactionRequest.TransactionType
TransactionRequest.TransactionSignature
TransactionRequest.ToJson()
TransactionRequest.ToDictionary()
TransactionRequest.SourceTag
TransactionRequest.TicketSequence
TransactionRequest.Sponsor
TransactionRequest.SponsorFlags
TransactionRequest.Delegate
TransactionRequest.OperationLimit
Namespace: Xrpl.Models.Transactions
Assembly: Xrpl.dll
Syntax
public class SponsorshipSet : TransactionRequest, ITransactionRequest, ISponsorshipSet, ITransactionCommon
Remarks

Requires the Sponsor amendment (XLS-68). This feature is in draft and subject to change.

Constructors

| Edit this page View Source

SponsorshipSet()

Declaration
public SponsorshipSet()

Properties

| Edit this page View Source

CounterpartySponsor

The sponsoring account. Present when the sponsee submits the transaction (the sponsor then co-signs via SponsorSignature).

Declaration
[JsonPropertyName("CounterpartySponsor")]
public string CounterpartySponsor { get; set; }
Property Value
Type Description
string
| Edit this page View Source

FeeAmountDelta

Signed change applied to the FeeAmount held by the Sponsorship object — XRP the sponsor adds to (positive) or reclaims from (negative) the fee budget. Must be a non-zero XRP amount, and positive when the object is being created.

Declaration
[JsonPropertyName("FeeAmountDelta")]
[JsonConverter(typeof(CurrencyConverter))]
public Currency FeeAmountDelta { get; set; }
Property Value
Type Description
Currency
| Edit this page View Source

Flags

Typed view over the base Flags value (see SponsorshipSetFlags).

Declaration
[JsonPropertyName("Flags")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public SponsorshipSetFlags? Flags { get; set; }
Property Value
Type Description
SponsorshipSetFlags?
| Edit this page View Source

MaxFee

The maximum fee per transaction the sponsor is willing to cover.

Declaration
[JsonPropertyName("MaxFee")]
[JsonConverter(typeof(CurrencyConverter))]
public Currency MaxFee { get; set; }
Property Value
Type Description
Currency
| Edit this page View Source

RemainingOwnerCountDelta

Signed change applied to the RemainingOwnerCount held by the Sponsorship object — owner-reserve slots the sponsor adds (positive) or withdraws (negative). Must be non-zero, and positive when the object is being created.

Declaration
[JsonPropertyName("RemainingOwnerCountDelta")]
public int? RemainingOwnerCountDelta { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Sponsee

The account being sponsored. Present when the sponsor submits the transaction.

Declaration
[JsonPropertyName("Sponsee")]
public string Sponsee { get; set; }
Property Value
Type Description
string

Implements

ITransactionRequest
ISponsorshipSet
ITransactionCommon

Extension Methods

BatchUtils.ToBatchTx(ITransactionRequest)
Utilities.Encode(TransactionRequest)
Utilities.EncodeForMultiSigning(TransactionRequest, string)
Utilities.EncodeForSigning(TransactionRequest)
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX