Show / Hide Table of Contents

Class SignatureObject

Typed model of an inner signature STObject shared by all co-signing surfaces: SponsorSignature (XLS-68), CounterpartySignature (LoanSet) and BatchSigner entries. Two alternative forms exist, mirroring rippled's generic STTx::checkSign(sigObject): single-signature (SigningPubKey + TxnSignature) or multisig (a nested Signers array with an empty SigningPubKey).

Inheritance
object
SignatureObject
Namespace: Xrpl.Models.Transactions
Assembly: Xrpl.dll
Syntax
[JsonConverter(typeof(SignatureObjectConverter))]
public class SignatureObject
Remarks

Serialized through SignatureObjectConverter in the wire shape, with each nested signer wrapped in a Signer object. Reading does not enforce either form, so a Batch inner co-signature marker - an empty object, or one with an empty SigningPubKey - reads and writes back unchanged.

Properties

| Edit this page View Source

Account

Signer account (present on BatchSigner entries; absent on Sponsor/Counterparty).

Declaration
public string? Account { get; set; }
Property Value
Type Description
string
| Edit this page View Source

IsMultisig

True when this object carries the multisig form (empty SigningPubKey per rippled).

Declaration
public bool IsMultisig { get; }
Property Value
Type Description
bool
| Edit this page View Source

Signers

Signer entries for the multisig form.

Declaration
public List<SignatureObject>? Signers { get; set; }
Property Value
Type Description
List<SignatureObject>
| Edit this page View Source

SigningPubKey

Public key for the single-signature form; empty string marks the multisig form.

Declaration
public string? SigningPubKey { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TxnSignature

Signature for the single-signature form.

Declaration
public string? TxnSignature { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

FromJsonObject(JsonObject)

Parses the wire-shape JsonObject produced by ToJsonObject() / the binary codec.

Declaration
public static SignatureObject FromJsonObject(JsonObject json)
Parameters
Type Name Description
JsonObject json
Returns
Type Description
SignatureObject
Exceptions
Type Condition
ValidationException

When the object matches neither protocol shape (see ValidateShape()).

| Edit this page View Source

Single(string, string, string?)

Creates the single-signature form.

Declaration
public static SignatureObject Single(string signingPubKey, string txnSignature, string? account = null)
Parameters
Type Name Description
string signingPubKey
string txnSignature
string account
Returns
Type Description
SignatureObject
| Edit this page View Source

ToJsonObject()

Serializes to the wire-shape JsonObject (field order is irrelevant — the binary codec sorts canonically).

Declaration
public JsonObject ToJsonObject()
Returns
Type Description
JsonObject
| Edit this page View Source

ValidateShape()

Enforces the two protocol shapes: multisig (non-empty Signers, empty SigningPubKey, no TxnSignature) or single-signature (SigningPubKey + TxnSignature, no Signers). Empty and mixed forms are rejected.

Declaration
public void ValidateShape()
Exceptions
Type Condition
ValidationException

When the object matches neither shape.

  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX