Struct TxCircuit

pub struct TxCircuit<const H: usize, const I: usize> {
    pub input_notes_info: [InputNoteInfo<H>; I],
    pub output_notes_info: [OutputNoteInfo; 2],
    pub payload_hash: BlsScalar,
    pub root: BlsScalar,
    pub deposit: u64,
    pub max_fee: u64,
    pub sender_pk: PublicKey,
    pub signatures: (Signature, Signature),
}

Declaration of the transaction circuit calling the [gadget].

Fields

input_notes_info: [InputNoteInfo<H>; I]

All information needed in relation to the transaction input-notes

output_notes_info: [OutputNoteInfo; 2]

All information needed in relation to the transaction output-notes

payload_hash: BlsScalar

The hash of the transaction-payload

root: BlsScalar

The root of the tree of notes corresponding to the input-note openings

deposit: u64

The deposit of the transaction, is zero if there is no deposit

max_fee: u64

The maximum fee that the transaction may spend

sender_pk: PublicKey

The public key of the sender used for the sender-encryption

signatures: (Signature, Signature)

The signature of the payload-hash signed with sk.a and sk.b

Implementations

impl<const H: usize, const I: usize> TxCircuit<H, I>

pub const SIZE: usize

The size of a TxCircuit.

pub fn to_var_bytes(&self) -> Vec<u8>

Serialize a TxCircuit to a vector of bytes.

pub fn from_slice(bytes: &[u8]) -> Result<Self, BytesError>

Deserialize a TxCircuit from a slice of bytes.

Errors

Will return dusk_bytes::Error in case of a deserialization error.

Trait Implementations

impl<const H: usize, const I: usize> Circuit for TxCircuit<H, I>

fn circuit(&self, composer: &mut Composer) -> Result<(), PlonkError>

Transaction gadget proving the following properties in ZK for a generic I input-notes and [OUTPUT_NOTES] output-notes:

1. Membership: every input-note is included in the Merkle tree of notes.
2. Ownership: the sender holds the note secret key for every input-note.
3. Nullification: the nullifier is calculated correctly.
4. Minting: the value commitment for every input-note is computed correctly.
5. Balance integrity: the sum of the values of all input-notes is equal to the sum of the values of all output-notes + the gas fee
   • a deposit, where a deposit refers to funds being transferred to a contract.
6. Sender-data: Verify that the sender was encrypted correctly for each output-note.

The circuit has the following public inputs:

• payload_hash
• root
• [nullifier; I]
• [output_value_commitment; 2]
• max_fee
• deposit
• (npk_out_0, npk_out_1)
• (enc_A_npk_out_0, enc_B_npk_out_0)
• (enc_A_npk_out_1, enc_B_npk_out_1)

fn size(&self) -> usize

Returns the size of the circuit.

fn compress() -> Result<Vec<u8>, Error>

Return a bytes representation of a compressed circuit, capable of being compiled into its prover and verifier instances with Compiler::compile_with_compressed.

impl<const H: usize, const I: usize> Clone for TxCircuit<H, I>

fn clone(&self) -> TxCircuit<H, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const H: usize, const I: usize> Debug for TxCircuit<H, I>

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

Formats the value using the given formatter.

impl<const H: usize, const I: usize> Default for TxCircuit<H, I>

fn default() -> Self

Returns the “default value” for a type.

impl<const H: usize, const I: usize> PartialEq for TxCircuit<H, I>

fn eq(&self, other: &TxCircuit<H, I>) -> 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<const H: usize, const I: usize> StructuralPartialEq for TxCircuit<H, I>