Struct zcash_hsmbuilder::txbuilder::Builder

pub struct Builder<P: Parameters, R: RngCore + CryptoRng> {
    pub sighash: [u8; 32],
    /* private fields */
}

Generates a Transaction from its inputs and outputs.

This is a rather low level builder, and is a HSM-compatible version of zcash_primitives::transaction::builder::Builder.

Fields

sighash: [u8; 32]

Implementations

impl<P: Parameters> Builder<P, OsRng>

pub fn new(params: P, height: u32) -> Self

Creates a new Builder targeted for inclusion in the block with the given height, using default values for general transaction fields and the default OS random.

Default values

The expiry height will be set to the given height plus the default transaction expiry delta (20 blocks).

The fee will be set to the default fee (0.0001 ZEC).

pub fn new_with_fee(params: P, height: u32, fee: u64) -> Self

impl<P: Parameters, R: RngCore + CryptoRng> Builder<P, R>

pub fn new_with_rng(params: P, height: u32, rng: R) -> Self

Creates a new Builder targeted for inclusion in the block with the given height and randomness source, using default values for general transaction fields.

Default values

The expiry height will be set to the given height plus the default transaction expiry delta (20 blocks).

The fee will be set to the default fee (0.0001 ZEC).

pub fn new_with_fee_rng(params: P, height: u32, rng: R, fee: u64) -> Self

pub fn add_sapling_spend(
    &mut self,
    diversifier: Diversifier,
    note: Note,
    merkle_path: MerklePath<Node>,
    alpha: Fr,
    proofkey: ProofGenerationKey,
    rcv: Fr
) -> Result<(), Error>

Adds a Sapling note to be spent in this transaction.

Returns an error if the given Merkle path does not have the same anchor as the paths for previous Sapling notes.

pub fn add_sapling_output(
    &mut self,
    ovk: Option<OutgoingViewingKey>,
    to: PaymentAddress,
    value: Amount,
    memo: Option<Memo>,
    rcv: Fr,
    rseed: Rseed,
    hash_seed: Option<HashSeed>
) -> Result<(), Error>

Adds a Sapling address to send funds to.

pub fn add_transparent_input(
    &mut self,
    pubkey: PublicKey,
    utxo: OutPoint,
    coin: TxOut
) -> Result<(), Error>

Adds a transparent coin to be spent in this transaction.

pub fn add_transparent_output(
    &mut self,
    to: Script,
    value: Amount
) -> Result<(), Error>

Adds a transparent address to send funds to.

pub fn build(
    &mut self,
    consensus_branch_id: BranchId,
    prover: &impl HsmTxProver
) -> Result<HsmTxData, Error>

Prepares a transaction to be transmitted to the HSM from the configured spends and outputs.

Upon success, returns the structure that can be serialized in in the format understood by the HSM and subsequently transmitted via the appropriate method.

After having retrieved the signatures from the HSM and having applied them with the appropriate methods of the builder, it’s possible to retrieve the final signature using Builder::finalize

consensus_branch_id must be valid for the block height that this transaction is targeting. An invalid consensus_branch_id will not result in an error from this function, and instead will generate a transaction that will be rejected by the network.

pub fn add_signatures_transparant(
    &mut self,
    signatures: Vec<Signature>,
    consensus_branch_id: BranchId
) -> Result<(), Error>

Attempt to apply the signatures for the transparent components of the transaction

pub fn add_signatures_spend(
    &mut self,
    sign: Vec<Signature>
) -> Result<(), Error>

Attempt to apply the signatures for the shielded components of the transaction

pub fn finalize(self) -> Result<(Transaction, TransactionMetadata), Error>

Finalize the transaction, after having obtained all the signatures from the the HSM.

Upon success, returns a tuple containing the final transaction, and the TransactionMetadata generated during the build process.

pub fn finalize_js(&mut self) -> Result<Vec<u8>, Error>

Same as finalize, except serialized to the format understood by the JavaScript users