Struct ProvisionalProposal 

pub struct ProvisionalProposal { /* private fields */ }

Available on crate feature v1 only.

Typestate for a checked proposal which had both the outputs and the inputs modified by the receiver. The receiver may sign and finalize the Payjoin proposal which will be sent to the sender for their signature.

Call Self::finalize_proposal to return a finalized PayjoinProposal.

Implementations

impl ProvisionalProposal

pub fn finalize_proposal( self, wallet_process_psbt: impl Fn(&Psbt) -> Result<Psbt, ImplementationError>, ) -> Result<PayjoinProposal, Error>

Finalizes the Payjoin proposal into a PSBT which the sender will find acceptable before they sign the transaction and broadcast it to the network.

Finalization consists of two steps:

1. Remove all sender signatures which were received with the original PSBT as these signatures are now invalid.
2. Sign and finalize the resulting PSBT using the passed wallet_process_psbt signing function.

pub fn psbt_to_sign(&self) -> Psbt

The Payjoin proposal PSBT that the receiver needs to sign

In some applications the entity that progresses the typestate is different from the entity that has access to the private keys, so the PSBT to sign must be accessible to such implementers.

Trait Implementations

impl Clone for ProvisionalProposal

fn clone(&self) -> ProvisionalProposal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProvisionalProposal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProvisionalProposal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProvisionalProposal

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProvisionalProposal

impl StructuralPartialEq for ProvisionalProposal