Struct Signer 

pub struct Signer { /* private fields */ }

Available on crate feature signer only.

Implementations

impl Signer

pub fn new(pczt: Pczt) -> Result<Self, Error>

Instantiates the Signer role with the given PCZT.

pub fn with_transparent_sighash_policy( self, sighash_policy: SighashPolicy, ) -> Self

Sets the sighash policy that this Signer applies to transparent inputs.

The default is [SighashPolicy::ALL_ONLY]; see [SighashPolicy] for why the sighash type a counterparty placed in the PCZT is only used if this Signer’s own policy permits it.

pub fn shielded_sighash(&self) -> [u8; 32]

Calculates the signature digest that must be signed to authorize shielded spends.

This can be used to produce a signature externally suitable for passing to e.g. Self::apply_orchard_signature.}

pub fn transparent_sighash(&self, index: usize) -> Result<[u8; 32], Error>

Calculates the signature digest that must be signed to authorize the transparent spend at the given index.

This can be used to produce a signature externally suitable for passing to e.g. Self::append_transparent_signature.}

Whoever signs the returned sighash is authorizing whatever it commits to, so the consistency of the input and the acceptability of its sighash type are checked here, exactly as they are when this Signer produces the signature itself.

Returns an error if index is invalid for this PCZT.

pub fn sign_transparent( &mut self, index: usize, sk: &SecretKey, ) -> Result<(), Error>

Signs the transparent spend at the given index with the given spending key.

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

pub fn append_transparent_signature( &mut self, index: usize, signature: Signature, ) -> Result<(), Error>

Appends the given signature to the transparent spend.

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

pub fn sign_sapling<R: Rng + CryptoRng>( &mut self, rng: R, index: usize, ask: &SpendAuthorizingKey, ) -> Result<(), Error>

Signs the Sapling spend at the given index with the given spend authorizing key.

Requires the spend’s proof_generation_key field to be set (because the API does not take an FVK).

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

rng provides the randomness for the signature.

pub fn apply_sapling_signature( &mut self, index: usize, signature: Signature<SpendAuth>, ) -> Result<(), Error>

Applies the given signature to the Sapling spend.

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

pub fn sign_orchard<R: Rng + CryptoRng>( &mut self, rng: R, index: usize, ask: &SpendAuthorizingKey, ) -> Result<(), Error>

Signs the Orchard spend at the given index with the given spend authorizing key.

Requires the spend’s fvk field to be set (because the API does not take an FVK).

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

rng provides the randomness for the signature.

pub fn apply_orchard_signature( &mut self, index: usize, signature: Signature<SpendAuth>, ) -> Result<(), Error>

Applies the given signature to the Orchard spend.

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

pub fn apply_orchard_spend_auth_signature( &mut self, signature: &SpendAuthSignature, ) -> Result<(), Error>

Applies an externally produced Orchard-protocol spend authorization signature.

The signature’s value pool selects the Orchard or Ironwood bundle, and its action index selects the spend within that bundle. The signature is verified against the action’s randomized verification key before it is stored.

Returns an error if the action index is invalid, the action data is inconsistent, or the signature does not verify.

pub fn sign_ironwood<R: Rng + CryptoRng>( &mut self, rng: R, index: usize, ask: &SpendAuthorizingKey, ) -> Result<(), Error>

Signs the Ironwood spend at the given index with the given spend authorizing key.

Requires the spend’s fvk field to be set (because the API does not take an FVK).

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

rng provides the randomness for the signature.

pub fn apply_ironwood_signature( &mut self, index: usize, signature: Signature<SpendAuth>, ) -> Result<(), Error>

Applies the given signature to the Ironwood spend.

It is the caller’s responsibility to perform any semantic validity checks on the PCZT (for example, comfirming that the change amounts are correct) before calling this method.

pub fn finish(self) -> Pczt

Finishes the Signer role, returning the updated PCZT.