Show / Hide Table of Contents

Enum SignatureRole

Which signature of a transaction a key is producing.

Namespace: Xrpl.Wallet
Assembly: Xrpl.dll
Syntax
public enum SignatureRole
Remarks

Before rippled's fixCleanup3_4_0 every signature on a transaction covered the same bytes, so the role was decided when the parts were composed rather than when they were signed, and a signature could be lifted from one role into another. Since the amendment each role signs under its own hash prefix, so a signer has to know its role before signing. Mirrors rippled's SignatureRole in include/xrpl/protocol/Sign.h.

The SDK works the role out on its own wherever the transaction says it: a wallet named as the Sponsor signs as sponsor, a LoanSet Counterparty as counterparty, and a multi-signature entry on a transaction whose main signature is single can only belong to the co-signing side. One shape it cannot read: where the main signature and a co-signature are both multi-signed, an entry is taken as the transaction's own, and a signer on a co-signing account's list states its role here. Choosing wrong is not silent - SignatureComposer verifies each entry against the section it lands in.

Fields

Name Description
Counterparty

The counterparty's signature (XLS-66 LoanSet), in CounterpartySignature.

Sponsor

The sponsor's signature (XLS-68), in SponsorSignature.

Transaction

The transaction's own signature: TxnSignature, or an entry in Signers.

Extension Methods

EmumExtensions.DecodeFlags<SignatureRole>(SignatureRole)
EmumExtensions.FlagsValues<SignatureRole>(SignatureRole)
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX