zec
/
zips
mirror of https://github.com/zcash/zips.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

All fields that allow multiple instances are denoted by a * in the table 

With cleanups for field descriptions 

Co-authored-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Deirdre Connolly 2020-08-12 12:58:30 -04:00 committed by GitHub
parent 566711de46
commit 3c031e0c8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
zip-0400.rst
View File

@ -43,46 +43,46 @@ Here ``zkey`` is the property name located at the first position of the database
Schema Schema
------ ------
According to Zcash v3.0.0-rc1 the following key-values can be found: the property names in **bold** mean only one instance of this type can exist in the entire database, while the others can have multiple instances. Keys and Values columns of the table contain the types that the stored data is representing. Included also there are the variable names hoping it will add some clarity to what the stored data is representing. According to Zcash v3.0.0-rc1 the following key-values can be found: the property names in **bold** mean only one instance of this type can exist in the entire database, while the others, suffixed by '\*' can have multiple instances. Keys and Values columns of the table contain the types that the stored data is representing. Included also there are the variable names hoping it will add some clarity to what the stored data is representing.
.. csv-table:: .. csv-table::
:header: "Name", "Description", "Keys", "Values" :header: "Name", "Description", "Keys", "Values"
"acc", "Account data", "1. ``string strAccount``", "1. ``CAccount account``" "acc*", "Account data", "1. ``string strAccount``", "1. ``CAccount account``"
"acentry", "Track internal tranfers between accounts in the same wallet", "1. ``string strAccount`` "acentry*", "Track internal transfers between accounts in the same wallet", "1. ``string strAccount``
2. ``uint64_t nNumber``", "1. ``CAccountingEntry acentry``" 2. ``uint64_t nNumber``", "1. ``CAccountingEntry acentry``"
"**bestblock**", "The current best block of the blockchain.", "", "1. ``CBlockLocator locator``" "**bestblock**", "The current best block of the blockchain.", "", "1. ``CBlockLocator locator``"
"**chdseed**", "Encrypted HD seed", "1. ``uint256 seedFp``", "1. ``vector<unsigned char> vchCryptedSecret``" "**chdseed**", "Encrypted HD seed", "1. ``uint256 seedFp``", "1. ``vector<unsigned char> vchCryptedSecret``"
"ckey", "Encrypted transparent pubkey and private key.", "1. ``vector<unsigned char> vchPubKey``", "1. ``vector<unsigned char> vchPrivKey``" "ckey*", "Encrypted transparent pubkey and private key.", "1. ``vector<unsigned char> vchPubKey``", "1. ``vector<unsigned char> vchPrivKey``"
"csapzkey", "Encrypted sapling pubkey and private key.", "1. ``libzcash::SaplingIncomingViewingKey ivk``", "1. ``libzcash::SaplingExtendedFullViewingKey extfvk`` "csapzkey*", "Encrypted Sapling pubkey and private key.", "1. ``libzcash::SaplingIncomingViewingKey ivk``", "1. ``libzcash::SaplingExtendedFullViewingKey extfvk``
2. ``vector<unsigned char> vchCryptedSecret``" 2. ``vector<unsigned char> vchCryptedSecret``"
"**cscript**", "Serialized script, used inside transaction inputs and outputs", "1. ``uint160 hash``", "1. ``CScript script``" "**cscript**", "Serialized script, used inside transaction inputs and outputs", "1. ``uint160 hash``", "1. ``CScript script``"
"czkey", "Encrypted sprout pubkey and private key.", "1. ``libzcash::SproutPaymentAddress addr``", "1. ``uint256 rkValue`` "czkey*", "Encrypted Sprout pubkey and private key.", "1. ``libzcash::SproutPaymentAddress addr``", "1. ``uint256 rkValue``
2. ``vector<unsigned char> vchCryptedSecret``" 2. ``vector<unsigned char> vchCryptedSecret``"
"**defaultkey**", "Default Transparent key.", "", "1. ``CPubKey CWallet::vchDefaultKey``" "**defaultkey**", "Default Transparent key.", "", "1. ``CPubKey CWallet::vchDefaultKey``"
"destdata", "Adds a destination data tuple to the store.", "1. ``std::string strAddress`` "destdata*", "Adds a destination data tuple to the store.", "1. ``std::string strAddress``
2. ``std::string strKey``", "1. ``std::string strValue``" 2. ``std::string strKey``", "1. ``std::string strValue``"
"**hdchain**", "Hierarchical Deterministic chain code, derived from seed.", "", "1. ``CHDChain chain``" "**hdchain**", "Hierarchical Deterministic chain code, derived from seed.", "", "1. ``CHDChain chain``"
"hdseed", "Hierarchical Deterministic seed.", "1. ``uint256 seedFp``", "1. ``RawHDSeed rawSeed``" "hdseed*", "Hierarchical Deterministic seed. [#zip-0032]_", "1. ``uint256 seedFp``", "1. ``RawHDSeed rawSeed``"
"key", "Transparent pubkey and privkey.", "1. ``CPubKey vchPubKey``", "1. ``CPrivKey pkey``" "key*", "Transparent pubkey and privkey.", "1. ``CPubKey vchPubKey``", "1. ``CPrivKey pkey``"
"keymeta", "Transparent key metadata.", "1. ``CPubKey vchPubKey``", "1. ``CKeyMetadata keyMeta``" "keymeta*", "Transparent key metadata.", "1. ``CPubKey vchPubKey``", "1. ``CKeyMetadata keyMeta``"
"**minversion**", "Wallet required minimal version.", "", "" "**minversion**", "Wallet required minimal version.", "", ""
"**mkey**", "Master key, used to encrypt public and private keys of the database.", "1. ``unsigned int nID``", "1. ``CMasterKey kMasterKey``" "**mkey**", "Master key, used to encrypt public and private keys of the database.", "1. ``unsigned int nID``", "1. ``CMasterKey kMasterKey``"
"name", "Name of an address to insert in the address book.", "1. ``string strAddress``", "1. ``string strAddress``" "name*", "Name of an address to insert in the address book.", "1. ``string strAddress``", "1. ``string strAddress``"
"**orderposnext**", "Index of next tx.", "", "1. ``int64_t nOrderPosNext``" "**orderposnext**", "Index of next tx.", "", "1. ``int64_t nOrderPosNext``"
"pool", "", "1. ``int64_t nIndex``", "1. ``CKeyPool keypool``" "pool*", "", "1. ``int64_t nIndex``", "1. ``CKeyPool keypool``"
"purpose", "Short description or identifier of an address.", "1. ``string strAddress``", "1. ``string strPurpose``" "purpose*", "Short description or identifier of an address.", "1. ``string strAddress``", "1. ``string strPurpose``"
"sapzaddr", "Sapling zaddr viewing key and address.", "1. ``libzcash::SaplingPaymentAddress addr``", "1. ``libzcash::SaplingIncomingViewingKey ivk``" "sapzaddr", "Sapling zaddr viewing key and address.", "1. ``libzcash::SaplingPaymentAddress addr``", "1. ``libzcash::SaplingIncomingViewingKey ivk``"
"sapextfvk", "", "", "" "sapextfvk*", "Sapling Extended Full Viewing Key", "", ""
"sapzkey", "Sapling pubkey and privkey", "1. ``libzcash::SaplingIncomingViewingKey ivk``", "1. ``libzcash::SaplingExtendedSpendingKey key``" "sapzkey*", "Sapling Incoming Viewing Key and Extended Spending Key", "1. ``libzcash::SaplingIncomingViewingKey ivk``", "1. ``libzcash::SaplingExtendedSpendingKey key``"
"tx", "Store all transactions that are related to wallet.", "1. ``uint256 hash``", "1. ``CWalletTx wtx``" "tx*", "Store all transactions that are related to wallet.", "1. ``uint256 hash``", "1. ``CWalletTx wtx``"
"**version**", "The ``CLIENT_VERSION`` from ``clientversion.h``.", "", "1. ``int nFileVersion``" "**version**", "The ``CLIENT_VERSION`` from ``clientversion.h``.", "", "1. ``int nFileVersion``"
"vkey", "Sprout viewing keys.", "1. ``libzcash::SproutViewingKey vk``", "1. ``char fYes``" "vkey*", "Sprout Viewing Keys.", "1. ``libzcash::SproutViewingKey vk``", "1. ``char fYes``"
"watchs", "Watch only addresses.", "1. ``CScript script``", "1. ``char fYes``" "watchs*", "Watch-only t-addresses.", "1. ``CScript script``", "1. ``char fYes``"
"**witnesscachesize**", "Shielded Note Witness cache size.", "", "1. ``int64_t nWitnessCacheSize``" "**witnesscachesize**", "Shielded Note Witness cache size.", "", "1. ``int64_t nWitnessCacheSize``"
"wkey", "Wallet key.", "", "" "wkey*", "Wallet key.", "", ""
"zkey", "Sprout pubkey and privkey.", "1. ``libzcash::SproutPaymentAddress addr``", "1. ``libzcash::SproutSpendingKey key``" "zkey*", "Sprout Payment Address and Spending Key.", "1. ``libzcash::SproutPaymentAddress addr``", "1. ``libzcash::SproutSpendingKey key``"
"zkeymeta", "Sprout key meta data.", "1. ``libzcash::SproutPaymentAddress addr``", "1. ``CKeyMetadata keyMeta``" "zkeymeta*", "Sprout Payment Address and key metadata.", "1. ``libzcash::SproutPaymentAddress addr``", "1. ``CKeyMetadata keyMeta``"
Functionality Functionality
@ -152,4 +152,5 @@ References
.. [#RFC2119] `Key words for use in RFCs to Indicate Requirement Levels <https://www.rfc-editor.org/rfc/rfc2119.html>`_ .. [#RFC2119] `Key words for use in RFCs to Indicate Requirement Levels <https://www.rfc-editor.org/rfc/rfc2119.html>`_
.. [#BDB] `Oracle Berkeley Database <https://www.oracle.com/database/berkeley-db/db.html>`_ .. [#BDB] `Oracle Berkeley Database <https://www.oracle.com/database/berkeley-db/db.html>`_
.. [#ZIP400Issue] `ZIP 400 issue <https://github.com/zcash/zips/issues/350>`_ .. [#ZIP400Issue] `ZIP 400 issue <https://github.com/zcash/zips/issues/350>`_
.. [#zip-0032] `ZIP 32: Shielded Hierarchical Deterministic Wallets <zip-0032.rst>`_
.. [#CrypterCode] `Database key encryption implementation <https://github.com/zcash/zcash/blob/master/src/wallet/crypter.h>`_ .. [#CrypterCode] `Database key encryption implementation <https://github.com/zcash/zcash/blob/master/src/wallet/crypter.h>`_