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.
Inherited Members
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 SourceSponsorshipSet()
Declaration
public SponsorshipSet()
Properties
| Edit this page View SourceCounterpartySponsor
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 |
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 |
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? |
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 |
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? |
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 |