Enum AddressWitness 

pub enum AddressWitness {
    P2pkh {
        signature: BinaryData,
    },
    P2sh {
        signatures: Vec<BinaryData>,
        redeem_script: BinaryData,
    },
}

The input witness data required to spend from a PlatformAddress.

This enum captures the different spending patterns for P2PKH and P2SH addresses.

Wire shape (internally tagged on type, camelCase variants/fields): { "$type": "p2pkh", "signature": <BinaryData> } { "$type": "p2sh", "signatures": [<BinaryData>, ...], "redeemScript": <BinaryData> }

Note: MAX_P2SH_SIGNATURES is enforced by the bincode Decode path (the load-bearing wire format). The serde JSON/Value deserialize path does not enforce it; downstream consumers must validate signature counts before re-serializing for storage.

Variants

P2pkh

P2PKH witness: recoverable signature only

Used for spending from a Pay-to-Public-Key-Hash address. The public key is recovered from the signature during verification, saving 33 bytes per witness compared to including the public key.

Fields

signature: BinaryData

The recoverable ECDSA signature (65 bytes with recovery byte prefix)

P2sh

P2SH witness: signatures + redeem script

Used for spending from a Pay-to-Script-Hash address (e.g., multisig). For a 2-of-3 multisig, signatures would be [OP_0, sig1, sig2] and redeem_script would be OP_2 <pub1> <pub2> <pub3> OP_3 OP_CHECKMULTISIG.

Fields

signatures: Vec<BinaryData>

The signatures (may include placeholder bytes like OP_0 for CHECKMULTISIG bug)

redeem_script: BinaryData

The redeem script that hashes to the address

Implementations

impl AddressWitness

pub fn unique_id(&self) -> String

Generates a unique identifier for this witness based on its contents.

This is used for deduplication purposes in unique_identifiers() implementations.

pub fn redeem_script(&self) -> Option<&BinaryData>

Returns the redeem script if this is a P2SH witness

pub fn is_p2pkh(&self) -> bool

Returns true if this is a P2PKH witness

pub fn is_p2sh(&self) -> bool

Returns true if this is a P2SH witness

Trait Implementations

impl<'de, C> BorrowDecode<'de, C> for AddressWitness

fn borrow_decode<D: BorrowDecoder<'de, Context = C>>( decoder: &mut D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for AddressWitness

fn clone(&self) -> AddressWitness

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AddressWitness

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C> Decode<C> for AddressWitness

fn decode<D: Decoder<Context = C>>(decoder: &mut D) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for AddressWitness

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for AddressWitness

fn encode<E: Encoder>(&self, encoder: &mut E) -> Result<(), EncodeError>

Encode a given type.

impl JsonConvertible for AddressWitness

Available on crate features json-conversion and serde-conversion only.

fn to_json(&self) -> Result<JsonValue, ProtocolError>

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

impl Ord for AddressWitness

fn cmp(&self, other: &AddressWitness) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AddressWitness

fn eq(&self, other: &AddressWitness) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AddressWitness

fn partial_cmp(&self, other: &AddressWitness) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AddressWitness

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValueConvertible for AddressWitness

Available on crate features value-conversion and serde-conversion only.

fn to_object(&self) -> Result<Value, ProtocolError>

where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>

where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>

where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>

where Self: Sized,

impl Eq for AddressWitness

impl JsonSafeFields for AddressWitness

impl StructuralPartialEq for AddressWitness