zcash-block
Advanced tools
A collection of JavaScript classes representing the data contained within Zcash blocks along with a decoder for the binary Zcash block representation.
ZcashBlock is the primary export for this package, it can be used to construct an in-memory representation of a Zcash block along with the child classes (below), or use the ZcashBlock.decode() method to decode from block's raw bytes.
Raw block data, hex encoded, can be obtained via an online API (e.g. https://zcashnetwork.info/api/rawblock/00000001b69a0aedf2e35e4fd072f435835ec48d3acd95ec6a0bcc1cfa12135c) or via the CLI (e.g. zcash-cli getblock 00000001b69a0aedf2e35e4fd072f435835ec48d3acd95ec6a0bcc1cfa12135c 0).
Running JSON.stringify() on a decoded ZcashBlock instance should result in the same data provided by the Zcash CLI, (e.g. zcash-cli getblock 00000001b69a0aedf2e35e4fd072f435835ec48d3acd95ec6a0bcc1cfa12135c) minus some additional properties that are only available when the block is attached to the full blockchain (anchor, height, chainwork, confirmations, valuePools, nextblockhash).
ZcashBlock.decode()ZcashBlock.decodeBlockHeaderOnly()class ZcashBlock
ZcashBlock#toSerializable()class ZcashCompressedG1
class ZcashCompressedG2
class ZcashFq
class ZcashFq2
class ZcashJoinSplitDescription
ZcashJoinSplitDescription#toJSON()class ZcashOutPoint
ZcashOutPoint#toJSON()class ZcashOutputDescription
ZcashOutputDescription#toJSON()class ZcashPHGRProof
class ZcashSpendDescription
ZcashSpendDescription#toJSON()class ZcashTransaction
ZcashTransaction#toJSON()ZcashTransaction#toSerializable()class ZcashTransactionIn
ZcashTransactionIn#toJSON()class ZcashTransactionOut
ZcashTransactionOut#toJSON()ZcashBlock.decode()Decode a ZcashBlock from the raw bytes of the block.
Can be used directly as require('zcash-block').decode().
Parameters:
buffer (Uint8Array|Buffer): the raw bytes of the block to be decoded.ZcashBlock.decodeBlockHeaderOnly()Decode only the header section of a ZcashBlock from the raw bytes of the block. This method will exclude the transactions.
Can be used directly as require('zcash-block').decodeBlockHeaderOnly().
Parameters:
buffer (Uint8Array|Buffer): the raw bytes of the block to be decoded.class ZcashBlockA class representation of a Zcash Block, parent for all of the data included in the raw block data in addition to some information that can be calculated based on that data. Properties are intended to match the names that are provided by the Zcash API (hence the casing and some strange names).
Exported as the main object, available as require('zcash-block').
Properties:
version (number): positive integerpreviousblockhash (Uint8Array|Buffer): 256-bit hashmerkleroot (Uint8Array|Buffer): 256-bit hashfinalsaplingroot (Uint8Array|Buffer): 256-bit hashtime (number): seconds since epochbits (number)nonce (Uint8Array|Buffer): 256-bit hashsolution (Uint8Array|Buffer)hash (Uint8Array|Buffer): 256-bit hash, a double SHA2-256 hash of all bytes making up this block (calculated)transactions (Array.<ZcashTransaction>)difficulty (number): the difficulty for this block (calculated)ZcashBlock(version, previousblockhash, merkleroot, finalsaplingroot, time, bits, nonce, solution, hash, transactions)Instantiate a new ZcashBlock.
See the class properties for expanded information on these parameters.
ZcashBlock#toSerializable()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
class ZcashCompressedG1A class representation of a property of a Zcash transaction joinsplit proof.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/CompressedG1').
Properties:
yLsb (boolean)x (Fq)ZcashCompressedG1(yLsb, x)Instantiate a new ZcashCompressedG1.
See the class properties for expanded information on these parameters.
class ZcashCompressedG2A class representation of a property of a Zcash transaction joinsplit proof.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/CompressedG2').
Properties:
yLsb (boolean)x (Fq2)ZcashCompressedG2(yLsb, x)Instantiate a new ZcashCompressedG2.
See the class properties for expanded information on these parameters.
class ZcashFqA class representation of a property of a Zcash transaction joinsplit proof. Used by ZcashCompressedG1.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/Fq').
Properties:
data (Uint8Array|Buffer): a 256-bit block of dataZcashFq(data)Instantiate a new ZcashFq.
See the class properties for expanded information on these parameters.
class ZcashFq2A class representation of a property of a Zcash transaction joinsplit proof. Used by ZcashCompressedG2.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/Fq2').
Properties:
data (Uint8Array|Buffer): a 512-bit block of dataZcashFq2(data)Instantiate a new ZcashFq2.
See the class properties for expanded information on these parameters.
class ZcashJoinSplitDescriptionA class representation of a Zcash Transaction's joinsplit, which may or may not be present for a given transaction.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/JoinSplitDescription').
Properties:
vpubOld (BigInt): a representation of an amount / valuevpubNew (BigInt): a representation of an amount / valueanchor (Uint8Array|Buffer): a 256-bit hash anchoring the joinsplit's position in the commitment treenullifiers (Array.<Uint8Array>|Array.<Buffer>): two 256-bit blocks derived from secrets in the notecommitments (Array.<Uint8Array>|Array.<Buffer>): two 256-bit blocks representing the spend commitmentsephemeralKey (Uint8Array|Buffer): a 256-bit hashrandomSeed (Uint8Array|Buffer): - a 256-bit blockmacs (Array.<Uint8Array>|Array.<Buffer>): two 256-bit hashes required to verify this joinsplitsproutProof (Uint8Array|Buffer|PHGRProof): either a GrothProof encoded directly as 192 bytes of binary data or a decoded PHGRProof, depending on the block version.ciphertexts (Uint8Array|Buffer): two ciphertexts of 601 bytes each which encode trapdoors, values and other information that the recipient needs, including a memo field.ZcashJoinSplitDescription(vpubOld, vpubNew, anchor, nullifiers, commitments, ephemeralKey, randomSeed, macs, sproutProof, ciphertexts)Instantiate a new ZcashJoinSplitDescription.
See the class properties for expanded information on these parameters.
ZcashJoinSplitDescription#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
class ZcashOutPointA class representation of a Zcash OutPoint for a ZcashTransactionIn.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/OutPoint').
Properties:
hash (Uint8Array|Buffer)n (number)ZcashOutPoint()Instantiate a new ZcashOutPoint.
See the class properties for expanded information on these parameters.
ZcashOutPoint#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
class ZcashOutputDescriptionA class representation of a Zcash output description.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/OutputDescription').
Properties:
cv (Uint8Array|Buffer): a 256-bit block representing the value commitmentcm (Uint8Array|Buffer): a 256-bit block representing the note commitment for the output noteephemeralKey (Uint8Array|Buffer): a 256-bit Jubjub public keyencCiphertext (Uint8Array|Buffer): a 580 byte ciphertext component for the encrypted output noteoutCiphertext (Uint8Array|Buffer): a 80 byte ciphertext component for the encrypted output notezkproof (Uint8Array|Buffer): a GrothProof encoded directly as 192 bytes of binary dataZcashOutputDescription(cv, cm, ephemeralKey, encCiphertext, outCiphertext, zkproof)Instantiate a new ZcashOutputDescription.
See the class properties for expanded information on these parameters.
ZcashOutputDescription#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
class ZcashPHGRProofA class representation of a Zcash transaction joinsplit proof.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/PHGRProof').
Properties:
gA (CompressedG1)gAprime (CompressedG1)gB (CompressedG2)gBprime (CompressedG1)gC (CompressedG1)gCprime (CompressedG1)gK (CompressedG1)gH (CompressedG1)yLsb (boolean)ZcashPHGRProof(gA, gAprime, gB, gBprime, gC, gCprime, gK, gH, yLsb)Instantiate a new ZcashPHGRProof.
class ZcashSpendDescriptionA class representation of a Zcash spend description.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/SpendDescription').
Properties:
cv (Uint8Array|Buffer): a 256-bit value commitment to the value of the input noteanchor (Uint8Array|Buffer): a 256-bit Merkle root of the Sapling note commitment tree at some block height in the pastnullifier (Uint8Array|Buffer): a 256-bit nullifier of the input noterk (Uint8Array|Buffer): a 256-bit randomized public key for spendAuthSigzkproof (Uint8Array|Buffer): a GrothProof encoded directly as 192 bytes of binary dataspendAuthSig (Uint8Array|Buffer): a 512-bit signature authorizing this spendZcashSpendDescription(cv, anchor, nullifier, rk, zkproof, spendAuthSig)Instantiate a new ZcashSpendDescription.
See the class properties for expanded information on these parameters.
ZcashSpendDescription#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
class ZcashTransactionA class representation of a Zcash Transaction, multiple of which are contained within each ZcashBlock.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/Transaction').
Properties:
overwintered (boolean)version (number)versionGroupId (number)vin (Array.<ZcashTransactionIn>)vout (Array.<ZcashTransactionIn>)lockTime (number)expiryHeight (number|null)valueBalance (BigInt|null)shieldedSpend (Array.<ZcashSpendDescription>|null)shieldedOutput (Array.<ZcashOutputDescription>|null)joinSplitPubKey (Uint8Array|Buffer|null)joinSplits (Array.<ZcashJoinSplitDescription>|null)joinSplitSig (Uint8Array|Buffer|null)bindingSig (Uint8Array|Buffer|null)hash (Uint8Array|Buffer)ZcashTransaction()Instantiate a new ZcashTransaction.
See the class properties for expanded information on these parameters.
ZcashTransaction#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
ZcashTransaction#toSerializable()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
class ZcashTransactionInA class representation of a Zcash TransactionIn, multiple of which are contained within each ZcashTransaction.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/TransactionIn').
Properties:
prevout (ZcashOutPoint)scriptSig (Uint8Array|Buffer): an arbitrary length byte arraysequence (number)ZcashTransactionIn(prevout, scriptSig, sequence)Instantiate a new ZcashTransactionIn.
See the class properties for expanded information on these parameters.
ZcashTransactionIn#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
The serailizable form converts this object to { coinbase: scriptSig, sequence: sequence } to match the Zcash API output.
class ZcashTransactionOutA class representation of a Zcash TransactionOut, multiple of which are contained within each ZcashTransaction.
This class isn't explicitly exported, access it for direct use with require('zcash-block/classes/TransactionOut').
Properties:
value (BigInt): an amount / value for this TransactionOutscriptPubKey (Uint8Array|Buffer): an arbitrary length byte arrayZcashTransactionOut(value, scriptPubKey)Instantiate a new ZcashTransactionOut.
See the class properties for expanded information on these parameters.
ZcashTransactionOut#toJSON()Convert to a serializable form that has nice stringified hashes and other simplified forms. May be useful for simplified inspection.
The serialized version includes the raw value as valueZat while value is a proper Zcash coin value.
Copyright 2019 Rod Vagg
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
FAQs
A Zcash block interface and decoder for JavaScript
The npm package zcash-block receives a total of 433 weekly downloads. As such, zcash-block popularity was classified as not popular.
We found that zcash-block demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.