Struct BtcSignOutputRequest

pub struct BtcSignOutputRequest {
    pub ours: bool,
    pub type: i32,
    pub value: u64,
    pub payload: Vec<u8>,
    pub keypath: Vec<u32>,
    pub script_config_index: u32,
    pub payment_request_index: Option<u32>,
    pub silent_payment: Option<SilentPayment>,
    pub output_script_config_index: Option<u32>,
}

Fields

ours: bool

type: i32

if ours is false

value: u64

20 bytes for p2pkh, p2sh, pw2wpkh. 32 bytes for p2wsh.

payload: Vec<u8>

if ours is false. Renamed from hash.

keypath: Vec<u32>

if ours is true

script_config_index: u32

If ours is true and output_script_config_index is absent. References a script config from BTCSignInitRequest. This allows change output identification and allows us to identify non-change outputs to the same account, so we can display this info to the user.

payment_request_index: Option<u32>

silent_payment: Option<SilentPayment>

If provided, type and payload is ignored. The generated output pkScript is returned in BTCSignNextResponse. contains_silent_payment_outputs in the init request must be true.

output_script_config_index: Option<u32>

If ours is true. If set, script_config_index is ignored. References an output script config from BTCSignInitRequest. This enables verification that an output belongs to the same keystore, even if it is from a different account than we spend from, allowing us to display this info to the user.

Implementations

impl BtcSignOutputRequest

pub fn type(&self) -> BtcOutputType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: BtcOutputType)

Sets type to the provided enum value.

pub fn payment_request_index(&self) -> u32

Returns the value of payment_request_index, or the default value if payment_request_index is unset.

pub fn output_script_config_index(&self) -> u32

Returns the value of output_script_config_index, or the default value if output_script_config_index is unset.

Trait Implementations

impl Clone for BtcSignOutputRequest

fn clone(&self) -> BtcSignOutputRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BtcSignOutputRequest

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

Formats the value using the given formatter.

impl Default for BtcSignOutputRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for BtcSignOutputRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BtcSignOutputRequest

fn eq(&self, other: &BtcSignOutputRequest) -> 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 StructuralPartialEq for BtcSignOutputRequest