Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface FractionalFeeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
FractionalFee, FractionalFee.Builder
@Generated public interface FractionalFeeOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Fraction
    getFractionalAmount()
    * A Fraction of the transferred tokens to assess as a fee.<br/> This value MUST be less than or equal to one.<br/> This value MUST be greater than zero.
    long
    getMaximumAmount()
    * A maximum fee to charge, in units of 10<sup>-decimals</sup> tokens.
    long
    getMinimumAmount()
    * A minimum fee to charge, in units of 10<sup>-decimals</sup> tokens.
    boolean
    getNetOfTransfers()
    * Flag requesting to assess the calculated fee against the sender, without reducing the amount transferred.<br/> #### Effects of this flag <ol> <li>If this value is true <ul> <li>The receiver of a transfer SHALL receive the entire amount sent.</li> <li>The fee SHALL be charged to the sender as an additional amount, increasing the token transfer debit.</li> </ul> </li> <li>If this value is false <ul> <li>The receiver of a transfer SHALL receive the amount sent _after_ deduction of the calculated fee.</li> </ul> </li> </ol>
    boolean
    hasFractionalAmount()
    * A Fraction of the transferred tokens to assess as a fee.<br/> This value MUST be less than or equal to one.<br/> This value MUST be greater than zero.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasFractionalAmount

      boolean hasFractionalAmount()
       *
 A Fraction of the transferred tokens to assess as a fee.<br/>
 This value MUST be less than or equal to one.<br/>
 This value MUST be greater than zero.
      .proto.Fraction fractional_amount = 1;
      Returns:
      Whether the fractionalAmount field is set.

    • getFractionalAmount

      Fraction getFractionalAmount()
       *
 A Fraction of the transferred tokens to assess as a fee.<br/>
 This value MUST be less than or equal to one.<br/>
 This value MUST be greater than zero.
      .proto.Fraction fractional_amount = 1;
      Returns:
      The fractionalAmount.

    • getMinimumAmount

      long getMinimumAmount()
       *
 A minimum fee to charge, in units of 10<sup>-decimals</sup> tokens.
 <p>
 This value is OPTIONAL, with a default of `0` indicating no minimum.<br/>
 If set, this value MUST be greater than zero.<br/>
 If set, all transfers SHALL pay at least this amount.
      int64 minimum_amount = 2;
      Returns:
      The minimumAmount.

    • getMaximumAmount

      long getMaximumAmount()
       *
 A maximum fee to charge, in units of 10<sup>-decimals</sup> tokens.
 <p>
 This value is OPTIONAL, with a default of `0` indicating no maximum.<br/>
 If set, this value MUST be greater than zero.<br/>
 If set, any fee charged SHALL NOT exceed this value.<br/>
 This value SHOULD be strictly greater than `minimum_amount`.
 If this amount is less than or equal to `minimum_amount`, then
 the fee charged SHALL always be equal to this value and
 `fractional_amount` SHALL NOT have any effect.
      int64 maximum_amount = 3;
      Returns:
      The maximumAmount.

    • getNetOfTransfers

      boolean getNetOfTransfers()
       *
 Flag requesting to assess the calculated fee against the sender,
 without reducing the amount transferred.<br/>
 #### Effects of this flag
 <ol>
 <li>If this value is true
 <ul>
 <li>The receiver of a transfer SHALL receive the entire
 amount sent.</li>
 <li>The fee SHALL be charged to the sender as an additional
 amount, increasing the token transfer debit.</li>
 </ul>
 </li>
 <li>If this value is false
 <ul>
 <li>The receiver of a transfer SHALL receive the amount sent
 _after_ deduction of the calculated fee.</li>
 </ul>
 </li>
 </ol>
      bool net_of_transfers = 4;
      Returns:
      The netOfTransfers.