case class TransactionSigningRequest(transaction: SignedTransaction, form: Map[String, (String, String)] = Map.empty, callback: Option[HttpUrl] = None, pubkey: Option[PublicKey] = None, message: Option[String] = None, networkPassphrase: Option[String] = None, signature: Option[DomainSignature] = None) extends Product with Serializable

A request to a transaction to be signed.

transaction

The signed transaction to be encoded

form

The additional information required by the user in the form form_label -> (txrep_field, form_hint)

callback

the uri to post the transaction to after signing

pubkey

the public key associated with the signer who should sign

message

an optional message for displaying to the user

networkPassphrase

the passphrase of the target network, if it's not the public/main network

signature

a domain and signature that proves the validity of this signing request

See also

See https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#operation-tx|SEP-0007 for full specification

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransactionSigningRequest
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TransactionSigningRequest(transaction: SignedTransaction, form: Map[String, (String, String)] = Map.empty, callback: Option[HttpUrl] = None, pubkey: Option[PublicKey] = None, message: Option[String] = None, networkPassphrase: Option[String] = None, signature: Option[DomainSignature] = None)

    transaction

    The signed transaction to be encoded

    form

    The additional information required by the user in the form form_label -> (txrep_field, form_hint)

    callback

    the uri to post the transaction to after signing

    pubkey

    the public key associated with the signer who should sign

    message

    an optional message for displaying to the user

    networkPassphrase

    the passphrase of the target network, if it's not the public/main network

    signature

    a domain and signature that proves the validity of this signing request

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val callback: Option[HttpUrl]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val form: Map[String, (String, String)]
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val message: Option[String]
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val networkPassphrase: Option[String]
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val pubkey: Option[PublicKey]
  18. def sign(fqdn: String, key: KeyPair): TransactionSigningRequest

    Sign the signing request with the given key.

    Sign the signing request with the given key.

    fqdn

    The fully-qualified domain name that contains the TOML file specifying the signer's public key.

    key

    The private key associated with the declared public key.

    returns

    this request with a signature populated. No attempt is made to validate that the provided key matches the public key declared in the TOML file of the fqdn under URI_REQUEST_SIGNING_KEY. No structural validation is performed on fqdn String.

    See also

    https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md#request-signing for more info.

  19. val signature: Option[DomainSignature]
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toUrl: String
  22. val transaction: SignedTransaction
  23. def validateSignature(useHttps: Boolean = true, port: Int = 443)(implicit ec: ExecutionContext): Future[SignatureValidation]

    If a signature is present, executes a round-trip to the domain info of the declared domain to fetch the signing public key and checks the signature against that key.

    If a signature is present, executes a round-trip to the domain info of the declared domain to fetch the signing public key and checks the signature against that key.

    returns

    NoSignaturePresent if there is no signature declared InvalidSignature if the domain cannot be reached, has no TOML, does not declare a signing key or the key used does not match the declared key ValidSignature if the signature is valid.

  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped