libzcash Namespace Reference

Classes
class	InvalidEncoding
class	SaplingPaymentAddress
	Sapling functions. More...
class	SaplingIncomingViewingKey
class	SaplingFullViewingKey
class	SaplingExpandedSpendingKey
class	SaplingSpendingKey
class	PathFiller
class	MerklePath
class	EmptyMerkleRoots
class	IncrementalWitness
class	IncrementalMerkleTree
class	SHA256Compress
class	PedersenHash
class	BaseNote
	Notes are main primitive of Sapling, similar to a a tree of commitments. More...
class	SaplingNote
class	BaseNotePlaintext
class	SaplingNotePlaintext
class	SaplingOutgoingPlaintext
class	SaplingNoteEncryption
	This is not a thread-safe API. More...
struct	SaplingExtendedFullViewingKey
struct	SaplingExtendedSpendingKey

Typedefs
typedef boost::variant< InvalidEncoding, SaplingPaymentAddress >	PaymentAddress
typedef std::pair< SaplingEncCiphertext, SaplingNoteEncryption >	SaplingNotePlaintextEncryptionResult
typedef std::array< unsigned char, ZC_SAPLING_ENCCIPHERTEXT_SIZE >	SaplingEncCiphertext
typedef std::array< unsigned char, ZC_SAPLING_ENCPLAINTEXT_SIZE >	SaplingEncPlaintext
typedef std::array< unsigned char, ZC_SAPLING_OUTCIPHERTEXT_SIZE >	SaplingOutCiphertext
typedef std::array< unsigned char, ZC_SAPLING_OUTPLAINTEXT_SIZE >	SaplingOutPlaintext
typedef std::array< unsigned char, GROTH_PROOF_SIZE >	GrothProof
typedef blob88	diversifier_index_t
typedef boost::variant< InvalidEncoding, SaplingExtendedSpendingKey >	SpendingKey
typedef boost::variant< InvalidEncoding, SaplingExtendedFullViewingKey >	ViewingKey

Functions
template<size_t Depth, typename Hash >
bool	operator== (const EmptyMerkleRoots< Depth, Hash > &a, const EmptyMerkleRoots< Depth, Hash > &b)
template<size_t Depth, typename Hash >
bool	operator== (const IncrementalMerkleTree< Depth, Hash > &a, const IncrementalMerkleTree< Depth, Hash > &b)
template<size_t Depth, typename Hash >
bool	operator== (const IncrementalWitness< Depth, Hash > &a, const IncrementalWitness< Depth, Hash > &b)
Optional< SaplingEncPlaintext >	AttemptSaplingEncDecryption (const SaplingEncCiphertext &ciphertext, const uint256 &ivk, const uint256 &epk)
Optional< SaplingEncPlaintext >	AttemptSaplingEncDecryption (const SaplingEncCiphertext &ciphertext, const uint256 &epk, const uint256 &esk, const uint256 &pk_d)
Optional< SaplingOutPlaintext >	AttemptSaplingOutDecryption (const SaplingOutCiphertext &ciphertext, const uint256 &ovk, const uint256 &cv, const uint256 &cm, const uint256 &epk)

Variables
const size_t	SerializedSaplingPaymentAddressSize = 43
const size_t	SerializedSaplingFullViewingKeySize = 96
const size_t	SerializedSaplingExpandedSpendingKeySize = 96
const size_t	SerializedSaplingSpendingKeySize = 32

Typedef Documentation

diversifier_index_t

typedef blob88 libzcash::diversifier_index_t

Definition at line 49 of file zip32.h.

GrothProof

typedef std::array<unsigned char, GROTH_PROOF_SIZE> libzcash::GrothProof

Definition at line 35 of file sapling_transaction.h.

PaymentAddress

typedef boost::variant<InvalidEncoding, SaplingPaymentAddress> libzcash::PaymentAddress

Definition at line 127 of file address.h.

SaplingEncCiphertext

typedef std::array<unsigned char, ZC_SAPLING_ENCCIPHERTEXT_SIZE> libzcash::SaplingEncCiphertext

Definition at line 23 of file noteencryption.h.

SaplingEncPlaintext

typedef std::array<unsigned char, ZC_SAPLING_ENCPLAINTEXT_SIZE> libzcash::SaplingEncPlaintext

Definition at line 24 of file noteencryption.h.

SaplingNotePlaintextEncryptionResult

typedef std::pair<SaplingEncCiphertext, SaplingNoteEncryption> libzcash::SaplingNotePlaintextEncryptionResult

Definition at line 69 of file note.h.

SaplingOutCiphertext

typedef std::array<unsigned char, ZC_SAPLING_OUTCIPHERTEXT_SIZE> libzcash::SaplingOutCiphertext

Definition at line 27 of file noteencryption.h.

SaplingOutPlaintext

typedef std::array<unsigned char, ZC_SAPLING_OUTPLAINTEXT_SIZE> libzcash::SaplingOutPlaintext

Definition at line 28 of file noteencryption.h.

SpendingKey

typedef boost::variant<InvalidEncoding, SaplingExtendedSpendingKey> libzcash::SpendingKey

Definition at line 116 of file zip32.h.

ViewingKey

typedef boost::variant<InvalidEncoding, SaplingExtendedFullViewingKey> libzcash::ViewingKey

Definition at line 117 of file zip32.h.

Function Documentation

AttemptSaplingEncDecryption() [1/2]

Optional< SaplingEncPlaintext > libzcash::AttemptSaplingEncDecryption	(	const SaplingEncCiphertext &	ciphertext,
		const uint256 &	epk,
		const uint256 &	esk,
		const uint256 &	pk_d
	)

Definition at line 198 of file noteencryption.cpp.

Here is the call graph for this function:

AttemptSaplingEncDecryption() [2/2]

Optional< SaplingEncPlaintext > libzcash::AttemptSaplingEncDecryption	(	const SaplingEncCiphertext &	ciphertext,
		const uint256 &	ivk,
		const uint256 &	epk
	)

Definition at line 163 of file noteencryption.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

AttemptSaplingOutDecryption()

Optional< SaplingOutPlaintext > libzcash::AttemptSaplingOutDecryption	(	const SaplingOutCiphertext &	ciphertext,
		const uint256 &	ovk,
		const uint256 &	cv,
		const uint256 &	cm,
		const uint256 &	epk
	)

Definition at line 267 of file noteencryption.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

operator==() [1/3]

template<size_t Depth, typename Hash >

bool libzcash::operator==	(	const EmptyMerkleRoots< Depth, Hash > &	a,
		const EmptyMerkleRoots< Depth, Hash > &	b
	)

Definition at line 79 of file incrementalmerkletree.h.

operator==() [2/3]

template<size_t Depth, typename Hash >

bool libzcash::operator==	(	const IncrementalMerkleTree< Depth, Hash > &	a,
		const IncrementalMerkleTree< Depth, Hash > &	b
	)

Definition at line 144 of file incrementalmerkletree.h.

operator==() [3/3]

template<size_t Depth, typename Hash >

bool libzcash::operator==	(	const IncrementalWitness< Depth, Hash > &	a,
		const IncrementalWitness< Depth, Hash > &	b
	)

Definition at line 200 of file incrementalmerkletree.h.

Variable Documentation

SerializedSaplingExpandedSpendingKeySize

const size_t libzcash::SerializedSaplingExpandedSpendingKeySize = 96

Definition at line 26 of file address.h.

SerializedSaplingFullViewingKeySize

const size_t libzcash::SerializedSaplingFullViewingKeySize = 96

Definition at line 25 of file address.h.

SerializedSaplingPaymentAddressSize

const size_t libzcash::SerializedSaplingPaymentAddressSize = 43

Definition at line 24 of file address.h.

SerializedSaplingSpendingKeySize

const size_t libzcash::SerializedSaplingSpendingKeySize = 32

Definition at line 27 of file address.h.