librustzcash.h File Reference

#include <stdint.h>

Include dependency graph for librustzcash.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef uint8_t	codeunit

Functions
void	librustzcash_to_scalar (const unsigned char *input, unsigned char *result)
void	librustzcash_ask_to_ak (const unsigned char *ask, unsigned char *result)
void	librustzcash_nsk_to_nk (const unsigned char *nsk, unsigned char *result)
void	librustzcash_crh_ivk (const unsigned char *ak, const unsigned char *nk, unsigned char *result)
bool	librustzcash_check_diversifier (const unsigned char *diversifier)
bool	librustzcash_ivk_to_pkd (const unsigned char *ivk, const unsigned char *diversifier, unsigned char *result)
void	librustzcash_init_zksnark_params (const codeunit *spend_path, size_t spend_path_len, const char *spend_hash, const codeunit *output_path, size_t output_path_len, const char *output_hash, const codeunit *sprout_path, size_t sprout_path_len, const char *sprout_hash)
	Loads the zk-SNARK parameters into memory and saves paths as necessary. More...
bool	librustzcash_eh_isvalid (uint32_t n, uint32_t k, const unsigned char *input, size_t input_len, const unsigned char *nonce, size_t nonce_len, const unsigned char *soln, size_t soln_len)
	Validates the provided Equihash solution against the given parameters, input and nonce. More...
void	librustzcash_tree_uncommitted (unsigned char *result)
	Writes the "uncommitted" note value for empty leaves of the merkle tree. More...
void	librustzcash_merkle_hash (size_t depth, const unsigned char *a, const unsigned char *b, unsigned char *result)
	Computes a merkle tree hash for a given depth. More...
bool	librustzcash_sapling_spend_sig (const unsigned char *ask, const unsigned char *ar, const unsigned char *sighash, unsigned char *result)
	Computes the signature for each Spend description, given the key ask, the re-randomization ar, the 32-byte sighash sighash, and an output result buffer of 64-bytes for the signature. More...
void *	librustzcash_sapling_proving_ctx_init ()
	Creates a Sapling proving context. Please free this when you're done. More...
bool	librustzcash_sapling_spend_proof (void *ctx, const unsigned char *ak, const unsigned char *nsk, const unsigned char *diversifier, const unsigned char *rcm, const unsigned char *ar, const uint64_t value, const unsigned char *anchor, const unsigned char *witness, unsigned char *cv, unsigned char *rk, unsigned char *zkproof)
	This function (using the proving context) constructs a Spend proof given the necessary witness information. More...
bool	librustzcash_sapling_output_proof (void *ctx, const unsigned char *esk, const unsigned char *payment_address, const unsigned char *rcm, const uint64_t value, unsigned char *cv, unsigned char *zkproof)
	This function (using the proving context) constructs an Output proof given the necessary witness information. More...
bool	librustzcash_sapling_binding_sig (const void *ctx, int64_t valueBalance, const unsigned char *sighash, unsigned char *result)
	This function (using the proving context) constructs a binding signature. More...
void	librustzcash_sapling_proving_ctx_free (void *)
	Frees a Sapling proving context returned from librustzcash_sapling_proving_ctx_init. More...
void *	librustzcash_sapling_verification_ctx_init ()
	Creates a Sapling verification context. More...
bool	librustzcash_sapling_check_spend (void *ctx, const unsigned char *cv, const unsigned char *anchor, const unsigned char *nullifier, const unsigned char *rk, const unsigned char *zkproof, const unsigned char *spendAuthSig, const unsigned char *sighashValue)
	Check the validity of a Sapling Spend description, accumulating the value commitment into the context. More...
bool	librustzcash_sapling_check_output (void *ctx, const unsigned char *cv, const unsigned char *cm, const unsigned char *ephemeralKey, const unsigned char *zkproof)
	Check the validity of a Sapling Output description, accumulating the value commitment into the context. More...
bool	librustzcash_sapling_final_check (void *ctx, int64_t valueBalance, const unsigned char *bindingSig, const unsigned char *sighashValue)
	Finally checks the validity of the entire Sapling transaction given valueBalance and the binding signature. More...
void	librustzcash_sapling_verification_ctx_free (void *)
	Frees a Sapling verification context returned from librustzcash_sapling_verification_ctx_init. More...
bool	librustzcash_sapling_compute_nf (const unsigned char *diversifier, const unsigned char *pk_d, const uint64_t value, const unsigned char *r, const unsigned char *ak, const unsigned char *nk, const uint64_t position, unsigned char *result)
	Compute a Sapling nullifier. More...
bool	librustzcash_sapling_compute_cm (const unsigned char *diversifier, const unsigned char *pk_d, const uint64_t value, const unsigned char *r, unsigned char *result)
	Compute a Sapling commitment. More...
bool	librustzcash_sapling_ka_agree (const unsigned char *p, const unsigned char *sk, unsigned char *result)
	Compute [sk] [8] P for some 32-byte point P, and 32-byte Fs. More...
bool	librustzcash_sapling_ka_derivepublic (const unsigned char *diversifier, const unsigned char *esk, unsigned char *result)
	Compute g_d = GH(diversifier) and returns false if the diversifier is invalid. More...
void	librustzcash_sapling_generate_r (unsigned char *result)
	Generate uniformly random scalar in Jubjub. More...
void	librustzcash_sprout_prove (unsigned char *proof_out, const unsigned char *phi, const unsigned char *rt, const unsigned char *h_sig, const unsigned char *in_sk1, uint64_t in_value1, const unsigned char *in_rho1, const unsigned char *in_r1, const unsigned char *in_auth1, const unsigned char *in_sk2, uint64_t in_value2, const unsigned char *in_rho2, const unsigned char *in_r2, const unsigned char *in_auth2, const unsigned char *out_pk1, uint64_t out_value1, const unsigned char *out_r1, const unsigned char *out_pk2, uint64_t out_value2, const unsigned char *out_r2, uint64_t vpub_old, uint64_t vpub_new)
	Sprout JoinSplit proof generation. More...
bool	librustzcash_sprout_verify (const unsigned char *proof, const unsigned char *rt, const unsigned char *h_sig, const unsigned char *mac1, const unsigned char *mac2, const unsigned char *nf1, const unsigned char *nf2, const unsigned char *cm1, const unsigned char *cm2, uint64_t vpub_old, uint64_t vpub_new)
	Sprout JoinSplit proof verification. More...
void	librustzcash_zip32_xsk_master (const unsigned char *seed, size_t seedlen, unsigned char *xsk_master)
	Derive the master ExtendedSpendingKey from a seed. More...
void	librustzcash_zip32_xsk_derive (const unsigned char *xsk_parent, uint32_t i, unsigned char *xsk_i)
	Derive a child ExtendedSpendingKey from a parent. More...
bool	librustzcash_zip32_xfvk_derive (const unsigned char *xfvk_parent, uint32_t i, unsigned char *xfvk_i)
	Derive a child ExtendedFullViewingKey from a parent. More...
bool	librustzcash_zip32_xfvk_address (const unsigned char *xfvk, const unsigned char *j, unsigned char *j_ret, unsigned char *addr_ret)
	Derive a PaymentAddress from an ExtendedFullViewingKey. More...

Typedef Documentation

codeunit

typedef uint8_t codeunit

Definition at line 10 of file librustzcash.h.

Function Documentation

librustzcash_ask_to_ak()

void librustzcash_ask_to_ak	(	const unsigned char *	ask,
		unsigned char *	result
	)

Here is the caller graph for this function:

librustzcash_check_diversifier()

bool librustzcash_check_diversifier

(

const unsigned char *

diversifier

)

Here is the caller graph for this function:

librustzcash_crh_ivk()

void librustzcash_crh_ivk	(	const unsigned char *	ak,
		const unsigned char *	nk,
		unsigned char *	result
	)

Here is the caller graph for this function:

librustzcash_eh_isvalid()

bool librustzcash_eh_isvalid	(	uint32_t	n,
		uint32_t	k,
		const unsigned char *	input,
		size_t	input_len,
		const unsigned char *	nonce,
		size_t	nonce_len,
		const unsigned char *	soln,
		size_t	soln_len
	)

Validates the provided Equihash solution against the given parameters, input and nonce.

librustzcash_init_zksnark_params()

void librustzcash_init_zksnark_params	(	const codeunit *	spend_path,
		size_t	spend_path_len,
		const char *	spend_hash,
		const codeunit *	output_path,
		size_t	output_path_len,
		const char *	output_hash,
		const codeunit *	sprout_path,
		size_t	sprout_path_len,
		const char *	sprout_hash
	)

Loads the zk-SNARK parameters into memory and saves paths as necessary.

Only called once.

librustzcash_ivk_to_pkd()

bool librustzcash_ivk_to_pkd	(	const unsigned char *	ivk,
		const unsigned char *	diversifier,
		unsigned char *	result
	)

Here is the caller graph for this function:

librustzcash_merkle_hash()

void librustzcash_merkle_hash	(	size_t	depth,
		const unsigned char *	a,
		const unsigned char *	b,
		unsigned char *	result
	)

Computes a merkle tree hash for a given depth.

The depth parameter should not be larger than 62.

a and b each must be of length 32, and must each be scalars of BLS12-381.

The result of the merkle tree hash is placed in result, which must also be of length 32.

Here is the caller graph for this function:

librustzcash_nsk_to_nk()

void librustzcash_nsk_to_nk	(	const unsigned char *	nsk,
		unsigned char *	result
	)

Here is the caller graph for this function:

librustzcash_sapling_binding_sig()

bool librustzcash_sapling_binding_sig	(	const void *	ctx,
		int64_t	valueBalance,
		const unsigned char *	sighash,
		unsigned char *	result
	)

This function (using the proving context) constructs a binding signature.

You must provide the intended valueBalance so that we can internally check consistency.

librustzcash_sapling_check_output()

bool librustzcash_sapling_check_output	(	void *	ctx,
		const unsigned char *	cv,
		const unsigned char *	cm,
		const unsigned char *	ephemeralKey,
		const unsigned char *	zkproof
	)

Check the validity of a Sapling Output description, accumulating the value commitment into the context.

librustzcash_sapling_check_spend()

bool librustzcash_sapling_check_spend	(	void *	ctx,
		const unsigned char *	cv,
		const unsigned char *	anchor,
		const unsigned char *	nullifier,
		const unsigned char *	rk,
		const unsigned char *	zkproof,
		const unsigned char *	spendAuthSig,
		const unsigned char *	sighashValue
	)

Check the validity of a Sapling Spend description, accumulating the value commitment into the context.

librustzcash_sapling_compute_cm()

bool librustzcash_sapling_compute_cm	(	const unsigned char *	diversifier,
		const unsigned char *	pk_d,
		const uint64_t	value,
		const unsigned char *	r,
		unsigned char *	result
	)

Compute a Sapling commitment.

The diversifier parameter must be 11 bytes in length. The pk_d and r parameters must be of length 32. The result is also of length 32 and placed in result. Returns false if the diversifier or pk_d is not valid

Here is the caller graph for this function:

librustzcash_sapling_compute_nf()

bool librustzcash_sapling_compute_nf	(	const unsigned char *	diversifier,
		const unsigned char *	pk_d,
		const uint64_t	value,
		const unsigned char *	r,
		const unsigned char *	ak,
		const unsigned char *	nk,
		const uint64_t	position,
		unsigned char *	result
	)

Compute a Sapling nullifier.

The diversifier parameter must be 11 bytes in length. The pk_d, r, ak and nk parameters must be of length 32. The result is also of length 32 and placed in result. Returns false if the diversifier or pk_d is not valid

Here is the caller graph for this function:

librustzcash_sapling_final_check()

bool librustzcash_sapling_final_check	(	void *	ctx,
		int64_t	valueBalance,
		const unsigned char *	bindingSig,
		const unsigned char *	sighashValue
	)

Finally checks the validity of the entire Sapling transaction given valueBalance and the binding signature.

librustzcash_sapling_generate_r()

void librustzcash_sapling_generate_r

(

unsigned char *

result

)

Generate uniformly random scalar in Jubjub.

The result is of length 32.

Here is the caller graph for this function:

librustzcash_sapling_ka_agree()

bool librustzcash_sapling_ka_agree	(	const unsigned char *	p,
		const unsigned char *	sk,
		unsigned char *	result
	)

Compute [sk] [8] P for some 32-byte point P, and 32-byte Fs.

If P or sk are invalid, returns false. Otherwise, the result is written to the 32-byte result buffer.

Here is the caller graph for this function:

librustzcash_sapling_ka_derivepublic()

bool librustzcash_sapling_ka_derivepublic	(	const unsigned char *	diversifier,
		const unsigned char *	esk,
		unsigned char *	result
	)

Compute g_d = GH(diversifier) and returns false if the diversifier is invalid.

Computes [esk] g_d and writes the result to the 32-byte result buffer. Returns false if esk is not a valid scalar.

Here is the caller graph for this function:

librustzcash_sapling_output_proof()

bool librustzcash_sapling_output_proof	(	void *	ctx,
		const unsigned char *	esk,
		const unsigned char *	payment_address,
		const unsigned char *	rcm,
		const uint64_t	value,
		unsigned char *	cv,
		unsigned char *	zkproof
	)

This function (using the proving context) constructs an Output proof given the necessary witness information.

It outputs cv and the zkproof.

librustzcash_sapling_proving_ctx_free()

void librustzcash_sapling_proving_ctx_free

(

void *

)

Frees a Sapling proving context returned from librustzcash_sapling_proving_ctx_init.

librustzcash_sapling_proving_ctx_init()

void* librustzcash_sapling_proving_ctx_init

(

)

Creates a Sapling proving context. Please free this when you're done.

librustzcash_sapling_spend_proof()

bool librustzcash_sapling_spend_proof	(	void *	ctx,
		const unsigned char *	ak,
		const unsigned char *	nsk,
		const unsigned char *	diversifier,
		const unsigned char *	rcm,
		const unsigned char *	ar,
		const uint64_t	value,
		const unsigned char *	anchor,
		const unsigned char *	witness,
		unsigned char *	cv,
		unsigned char *	rk,
		unsigned char *	zkproof
	)

This function (using the proving context) constructs a Spend proof given the necessary witness information.

It outputs cv (the value commitment) and rk (so that you don't have to compute it) along with the proof.

librustzcash_sapling_spend_sig()

bool librustzcash_sapling_spend_sig	(	const unsigned char *	ask,
		const unsigned char *	ar,
		const unsigned char *	sighash,
		unsigned char *	result
	)

Computes the signature for each Spend description, given the key ask, the re-randomization ar, the 32-byte sighash sighash, and an output result buffer of 64-bytes for the signature.

This function will fail if the provided ask or ar are invalid.

librustzcash_sapling_verification_ctx_free()

void librustzcash_sapling_verification_ctx_free

(

void *

)

Frees a Sapling verification context returned from librustzcash_sapling_verification_ctx_init.

librustzcash_sapling_verification_ctx_init()

void* librustzcash_sapling_verification_ctx_init

(

)

Creates a Sapling verification context.

Please free this when you're done.

librustzcash_sprout_prove()

void librustzcash_sprout_prove	(	unsigned char *	proof_out,
		const unsigned char *	phi,
		const unsigned char *	rt,
		const unsigned char *	h_sig,
		const unsigned char *	in_sk1,
		uint64_t	in_value1,
		const unsigned char *	in_rho1,
		const unsigned char *	in_r1,
		const unsigned char *	in_auth1,
		const unsigned char *	in_sk2,
		uint64_t	in_value2,
		const unsigned char *	in_rho2,
		const unsigned char *	in_r2,
		const unsigned char *	in_auth2,
		const unsigned char *	out_pk1,
		uint64_t	out_value1,
		const unsigned char *	out_r1,
		const unsigned char *	out_pk2,
		uint64_t	out_value2,
		const unsigned char *	out_r2,
		uint64_t	vpub_old,
		uint64_t	vpub_new
	)

Sprout JoinSplit proof generation.

librustzcash_sprout_verify()

bool librustzcash_sprout_verify	(	const unsigned char *	proof,
		const unsigned char *	rt,
		const unsigned char *	h_sig,
		const unsigned char *	mac1,
		const unsigned char *	mac2,
		const unsigned char *	nf1,
		const unsigned char *	nf2,
		const unsigned char *	cm1,
		const unsigned char *	cm2,
		uint64_t	vpub_old,
		uint64_t	vpub_new
	)

Sprout JoinSplit proof verification.

librustzcash_to_scalar()

void librustzcash_to_scalar	(	const unsigned char *	input,
		unsigned char *	result
	)

Here is the caller graph for this function:

librustzcash_tree_uncommitted()

void librustzcash_tree_uncommitted

(

unsigned char *

result

)

Writes the "uncommitted" note value for empty leaves of the merkle tree.

result must be a valid pointer to 32 bytes which will be written.

Here is the caller graph for this function:

librustzcash_zip32_xfvk_address()

bool librustzcash_zip32_xfvk_address	(	const unsigned char *	xfvk,
		const unsigned char *	j,
		unsigned char *	j_ret,
		unsigned char *	addr_ret
	)

Derive a PaymentAddress from an ExtendedFullViewingKey.

librustzcash_zip32_xfvk_derive()

bool librustzcash_zip32_xfvk_derive	(	const unsigned char *	xfvk_parent,
		uint32_t	i,
		unsigned char *	xfvk_i
	)

Derive a child ExtendedFullViewingKey from a parent.

librustzcash_zip32_xsk_derive()

void librustzcash_zip32_xsk_derive	(	const unsigned char *	xsk_parent,
		uint32_t	i,
		unsigned char *	xsk_i
	)

Derive a child ExtendedSpendingKey from a parent.

librustzcash_zip32_xsk_master()

void librustzcash_zip32_xsk_master	(	const unsigned char *	seed,
		size_t	seedlen,
		unsigned char *	xsk_master
	)

Derive the master ExtendedSpendingKey from a seed.

Here is the caller graph for this function: