Interface BatchSigner

All Known Implementing Classes:
ImmutableBatchSigner

@Immutable @Beta public interface BatchSigner
Represents a signer in the BatchSigners array of a Batch transaction. A BatchSigner can either sign directly with a public key and signature or use multi-signing with a nested Signers array.

This class will be marked Beta until the featureBatch amendment is enabled on mainnet. Its API is subject to change.

See Also:
  • "https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0056-batch"
  • Method Details

    • builder

      static ImmutableBatchSigner.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableBatchSigner.Builder.
    • account

      Address account()
      The account address of the signer. This must match either the outer transaction's Account or one of the inner transaction accounts.
      Returns:
      An Address.
    • transactionSignature

      Optional<Signature> transactionSignature()
      The signature for the transaction. Present for direct signing.
      Returns:
      An optionally-present Signature.
    • signingPublicKey

      Optional<PublicKey> signingPublicKey()
      The public key used to create the signature. Present for direct signing.
      Returns:
      An optionally-present PublicKey.
    • sortedSigners

      @Default default boolean sortedSigners()
    • signers

      @Default default List<SignerWrapper> signers()
      The array of signers for multi-signing (sorted). Present when using multi-sig instead of direct signing.

      Note: When building a BatchSigner, you can provide signers in any order, and they will be automatically sorted by account address for serialization and signing via the checkAndNormalize() function.

      Returns:
      A List of SignerWrappers in the order they were added.
    • checkAndNormalize

      @Check default BatchSigner checkAndNormalize()
      Validates that the BatchSigner has either direct signing fields or multi-sig signers, but not both.