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

Interface CustomFeeOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllCollectorsAreExempt()
    * Flag indicating to exempt all custom fee collector accounts for this token type from paying this custom fee when sending tokens.
    CustomFee.FeeCase
    getFeeCase()
     
    AccountID
    getFeeCollectorAccountId()
    * The account to receive the custom fee.
    FixedFee
    getFixedFee()
    * A fixed fee to be charged to the `sender` for every token transfer.
    FractionalFee
    getFractionalFee()
    * A fee defined as a fraction of the tokens transferred.
    RoyaltyFee
    getRoyaltyFee()
    * A fee charged as royalty for any transfer of a non-fungible/unique token.
    boolean
    hasFeeCollectorAccountId()
    * The account to receive the custom fee.
    boolean
    hasFixedFee()
    * A fixed fee to be charged to the `sender` for every token transfer.
    boolean
    hasFractionalFee()
    * A fee defined as a fraction of the tokens transferred.
    boolean
    hasRoyaltyFee()
    * A fee charged as royalty for any transfer of a non-fungible/unique token.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasFixedFee

      boolean hasFixedFee()
       *
 A fixed fee to be charged to the `sender` for every token transfer.
 <p>
 This type of fee MAY be defined for any token type.<br/>
 This type of fee MAY be more consistent and reliable than
 other types.
      .proto.FixedFee fixed_fee = 1;
      Returns:
      Whether the fixedFee field is set.

    • getFixedFee

      FixedFee getFixedFee()
       *
 A fixed fee to be charged to the `sender` for every token transfer.
 <p>
 This type of fee MAY be defined for any token type.<br/>
 This type of fee MAY be more consistent and reliable than
 other types.
      .proto.FixedFee fixed_fee = 1;
      Returns:
      The fixedFee.

    • hasFractionalFee

      boolean hasFractionalFee()
       *
 A fee defined as a fraction of the tokens transferred.
 <p>
 This type of fee MUST NOT be defined for a non-fungible/unique
 token type.<br/>
 This fee MAY be charged to either sender, as an increase to the
 amount sent, or receiver, as a reduction to the amount received.
      .proto.FractionalFee fractional_fee = 2;
      Returns:
      Whether the fractionalFee field is set.

    • getFractionalFee

      FractionalFee getFractionalFee()
       *
 A fee defined as a fraction of the tokens transferred.
 <p>
 This type of fee MUST NOT be defined for a non-fungible/unique
 token type.<br/>
 This fee MAY be charged to either sender, as an increase to the
 amount sent, or receiver, as a reduction to the amount received.
      .proto.FractionalFee fractional_fee = 2;
      Returns:
      The fractionalFee.

    • hasRoyaltyFee

      boolean hasRoyaltyFee()
       *
 A fee charged as royalty for any transfer of a
 non-fungible/unique token.
 <p>
 This type of fee MUST NOT be defined for a
 fungible/common token type.
      .proto.RoyaltyFee royalty_fee = 4;
      Returns:
      Whether the royaltyFee field is set.

    • getRoyaltyFee

      RoyaltyFee getRoyaltyFee()
       *
 A fee charged as royalty for any transfer of a
 non-fungible/unique token.
 <p>
 This type of fee MUST NOT be defined for a
 fungible/common token type.
      .proto.RoyaltyFee royalty_fee = 4;
      Returns:
      The royaltyFee.

    • hasFeeCollectorAccountId

      boolean hasFeeCollectorAccountId()
       *
 The account to receive the custom fee.
      .proto.AccountID fee_collector_account_id = 3;
      Returns:
      Whether the feeCollectorAccountId field is set.

    • getFeeCollectorAccountId

      AccountID getFeeCollectorAccountId()
       *
 The account to receive the custom fee.
      .proto.AccountID fee_collector_account_id = 3;
      Returns:
      The feeCollectorAccountId.

    • getAllCollectorsAreExempt

      boolean getAllCollectorsAreExempt()
       *
 Flag indicating to exempt all custom fee collector accounts for this
 token type from paying this custom fee when sending tokens.
 <p>
 The treasury account for a token, and the account identified by the
 `fee_collector_account_id` field of this `CustomFee` are always exempt
 from this custom fee to avoid redundant and unnecessary transfers.
 If this value is `true` then the account(s) identified in
 `fee_collector_account_id` for _all_ custom fee definitions for this
 token type SHALL also be exempt from this custom fee.
 This behavior is specified in HIP-573.
      bool all_collectors_are_exempt = 5;
      Returns:
      The allCollectorsAreExempt.

    • getFeeCase

      CustomFee.FeeCase getFeeCase()