org.stellar.sdk.xdr

Class SorobanTransactionMetaExtV1

java.lang.Object

org.stellar.sdk.xdr.SorobanTransactionMetaExtV1

All Implemented Interfaces:

XdrElement

public class SorobanTransactionMetaExtV1
extends java.lang.Object
implements XdrElement

SorobanTransactionMetaExtV1's original definition in the XDR file is:

 struct SorobanTransactionMetaExtV1
 {
     ExtensionPoint ext;

     // The following are the components of the overall Soroban resource fee
     // charged for the transaction.
     // The following relation holds:
     // `resourceFeeCharged = totalNonRefundableResourceFeeCharged + totalRefundableResourceFeeCharged`
     // where `resourceFeeCharged` is the overall fee charged for the
     // transaction. Also, `resourceFeeCharged` <= `sorobanData.resourceFee`
     // i.e.we never charge more than the declared resource fee.
     // The inclusion fee for charged the Soroban transaction can be found using
     // the following equation:
     // `result.feeCharged = resourceFeeCharged + inclusionFeeCharged`.

     // Total amount (in stroops) that has been charged for non-refundable
     // Soroban resources.
     // Non-refundable resources are charged based on the usage declared in
     // the transaction envelope (such as `instructions`, `readBytes` etc.) and
     // is charged regardless of the success of the transaction.
     int64 totalNonRefundableResourceFeeCharged;
     // Total amount (in stroops) that has been charged for refundable
     // Soroban resource fees.
     // Currently this comprises the rent fee (`rentFeeCharged`) and the
     // fee for the events and return value.
     // Refundable resources are charged based on the actual resources usage.
     // Since currently refundable resources are only used for the successful
     // transactions, this will be `0` for failed transactions.
     int64 totalRefundableResourceFeeCharged;
     // Amount (in stroops) that has been charged for rent.
     // This is a part of `totalNonRefundableResourceFeeCharged`.
     int64 rentFeeCharged;
 };
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SorobanTransactionMetaExtV1.SorobanTransactionMetaExtV1Builder

Constructor Summary

Constructors

Constructor and Description
SorobanTransactionMetaExtV1()
SorobanTransactionMetaExtV1(ExtensionPoint ext, Int64 totalNonRefundableResourceFeeCharged, Int64 totalRefundableResourceFeeCharged, Int64 rentFeeCharged)

Method Summary

Modifier and Type	Method and Description
static SorobanTransactionMetaExtV1.SorobanTransactionMetaExtV1Builder	builder()
static SorobanTransactionMetaExtV1	decode(XdrDataInputStream stream)
void	encode(XdrDataOutputStream stream)
boolean	equals(java.lang.Object o)
static SorobanTransactionMetaExtV1	fromXdrBase64(java.lang.String xdr)
static SorobanTransactionMetaExtV1	fromXdrByteArray(byte[] xdr)
ExtensionPoint	getExt()
Int64	getRentFeeCharged()
Int64	getTotalNonRefundableResourceFeeCharged()
Int64	getTotalRefundableResourceFeeCharged()
int	hashCode()
void	setExt(ExtensionPoint ext)
void	setRentFeeCharged(Int64 rentFeeCharged)
void	setTotalNonRefundableResourceFeeCharged(Int64 totalNonRefundableResourceFeeCharged)
void	setTotalRefundableResourceFeeCharged(Int64 totalRefundableResourceFeeCharged)
SorobanTransactionMetaExtV1.SorobanTransactionMetaExtV1Builder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.stellar.sdk.xdr.XdrElement

toXdrBase64, toXdrByteArray

Constructor Detail

SorobanTransactionMetaExtV1

public SorobanTransactionMetaExtV1()

SorobanTransactionMetaExtV1

public SorobanTransactionMetaExtV1(ExtensionPoint ext,
                                   Int64 totalNonRefundableResourceFeeCharged,
                                   Int64 totalRefundableResourceFeeCharged,
                                   Int64 rentFeeCharged)

Method Detail

encode

public void encode(XdrDataOutputStream stream)
            throws java.io.IOException

Specified by:

encode in interface XdrElement

Throws:

java.io.IOException

decode

public static SorobanTransactionMetaExtV1 decode(XdrDataInputStream stream)
                                          throws java.io.IOException

Throws:

java.io.IOException

fromXdrBase64

public static SorobanTransactionMetaExtV1 fromXdrBase64(java.lang.String xdr)
                                                 throws java.io.IOException

Throws:

java.io.IOException

fromXdrByteArray

public static SorobanTransactionMetaExtV1 fromXdrByteArray(byte[] xdr)
                                                    throws java.io.IOException

Throws:

java.io.IOException

builder

public static SorobanTransactionMetaExtV1.SorobanTransactionMetaExtV1Builder builder()

toBuilder

public SorobanTransactionMetaExtV1.SorobanTransactionMetaExtV1Builder toBuilder()

getExt

public ExtensionPoint getExt()

getTotalNonRefundableResourceFeeCharged

public Int64 getTotalNonRefundableResourceFeeCharged()

getTotalRefundableResourceFeeCharged

public Int64 getTotalRefundableResourceFeeCharged()

getRentFeeCharged

public Int64 getRentFeeCharged()

setExt

public void setExt(ExtensionPoint ext)

setTotalNonRefundableResourceFeeCharged

public void setTotalNonRefundableResourceFeeCharged(Int64 totalNonRefundableResourceFeeCharged)

setTotalRefundableResourceFeeCharged

public void setTotalRefundableResourceFeeCharged(Int64 totalRefundableResourceFeeCharged)

setRentFeeCharged

public void setRentFeeCharged(Int64 rentFeeCharged)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object