Package 

Class Proposal


  • 
    public final class Proposal
    
                        

    A transaction proposal created by the Rust backend in response to a Kotlin request.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Proposal.Companion
    • Constructor Summary

      Constructors 
      Constructor Description
      Proposal(ProposalUnsafe inner)
    • Method Summary

      Modifier and Type Method Description
      final ProposalUnsafe toUnsafe() Exposes the type-unsafe proposal variant for passing across the FFI.
      final ByteArray toByteArray() Serializes this proposal type-safe data to ByteArray for storing purposes.
      final Integer transactionCount() Returns the number of transactions that this proposal will create.
      final Zatoshi totalFeeRequired() Returns the total fee required by this proposal for its transactions.
      final String toPrettyString()
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Proposal

        Proposal(ProposalUnsafe inner)
        Parameters:
        inner - the type-unsafe Proposal protobuf received across the FFI.
    • Method Detail

      • toUnsafe

         final ProposalUnsafe toUnsafe()

        Exposes the type-unsafe proposal variant for passing across the FFI.

      • transactionCount

         final Integer transactionCount()

        Returns the number of transactions that this proposal will create.

        This is equal to the number of TransactionSubmitResults that will be returned from Synchronizer.createProposedTransactions.

        Proposals always create at least one transaction.

      • totalFeeRequired

         final Zatoshi totalFeeRequired()

        Returns the total fee required by this proposal for its transactions.