zeth.core.wallet.ZethNoteDescription Class Reference

Public Member Functions
def	__init__ (self, ZethNote note, int address, bytes commitment)
Tuple[int, ZethNote]	as_input (self)
str	to_json (self)

Static Public Member Functions
ZethNoteDescription	from_json (str json_str)

Public Attributes
	note
	address
	commitment

Detailed Description

All secret data about a single ZethNote, including address in the merkle
tree and the commit value.

Definition at line 35 of file wallet.py.

Constructor & Destructor Documentation

__init__()

def zeth.core.wallet.ZethNoteDescription.__init__	(		self,
		ZethNote	note,
		int	address,
		bytes	commitment
	)

Definition at line 40 of file wallet.py.

    def __init__(self, note: ZethNote, address: int, commitment: bytes):
        self.note = note
        self.address = address
        self.commitment = commitment
 

Member Function Documentation

as_input()

Tuple[int, ZethNote] zeth.core.wallet.ZethNoteDescription.as_input

(

self

)

Returns the description in a form suitable for joinsplit.

Definition at line 45 of file wallet.py.

    def as_input(self) -> Tuple[int, ZethNote]:
        """
        Returns the description in a form suitable for joinsplit.
        """
        return (self.address, self.note)
 

from_json()

ZethNoteDescription zeth.core.wallet.ZethNoteDescription.from_json ( str  json_str )

static

Definition at line 60 of file wallet.py.

    def from_json(json_str: str) -> ZethNoteDescription:
        json_dict = json.loads(json_str)
        return ZethNoteDescription(
            note=zeth_note_from_json_dict(json_dict["note"]),
            address=int(json_dict["address"]),
            commitment=bytes.fromhex(json_dict["commitment"]))
 
 

Here is the call graph for this function:

to_json()

str zeth.core.wallet.ZethNoteDescription.to_json

(

self

)

Definition at line 51 of file wallet.py.

    def to_json(self) -> str:
        json_dict = {
            "note": zeth_note_to_json_dict(self.note),
            "address": str(self.address),
            "commitment": self.commitment.hex(),
        }
        return json.dumps(json_dict, indent=4)
 

Here is the call graph for this function:

Member Data Documentation

address

zeth.core.wallet.ZethNoteDescription.address

Definition at line 42 of file wallet.py.

commitment

zeth.core.wallet.ZethNoteDescription.commitment

Definition at line 43 of file wallet.py.

note

zeth.core.wallet.ZethNoteDescription.note

Definition at line 41 of file wallet.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zeth/zeth/client/zeth/core/wallet.py