@yipsec/merked

Version:

a directed acyclic graph using merkle trees

1 lines • 4.51 kB

JSON

{"list":[{"title":"module:merked","link":"<a href=\"module-merked.html\">merked</a>","description":"A Merkle DAG (Directed Acyclic Graph) is a data structure used in decentralized\nsystems, where each node contains a hash of its content and links to its child\nnodes. This structure allows for efficient data verification and deduplication,\nensuring that data remains immutable and securely linked."},{"title":"module:merked.dag","link":"<a href=\"module-merked.html#.dag\">dag</a>","description":"{@link module:merked/dag}"},{"title":"module:merked.tree","link":"<a href=\"module-merked.html#.tree\">tree</a>","description":"{@link module:merked/tree}"},{"title":"module:merked/dag","link":"<a href=\"module-merked_dag.html\">merked/dag</a>","description":"A directed acyclic graph (DAG) is a type of graph that consists of vertices\nconnected by directed edges, where there are no cycles, meaning you cannot\nreturn to the same vertex by following the direction of the edges."},{"title":"module:merked/dag~DAG","link":"<a href=\"module-merked_dag-DAG.html\">DAG</a>","description":"Given a list of uniform buffers, construct a Merkle Tree."},{"title":"module:merked/dag~DAG#toArray","link":"<a href=\"module-merked_dag-DAG.html#toArray\">toArray</a>","description":"Get the underlying shard array."},{"title":"module:merked/dag~DAG#toMetadata","link":"<a href=\"module-merked_dag-DAG.html#toMetadata\">toMetadata</a>","description":"Export a serializable metadata object"},{"title":"module:merked/dag~DAG.DEFAULT_OPTS","link":"<a href=\"module-merked_dag-DAG.html#.DEFAULT_OPTS\">DEFAULT_OPTS</a>","description":"Computes the default options for {@link DAG} instance given a shard array."},{"title":"module:merked/dag~DAG.fromBuffer","link":"<a href=\"module-merked_dag-DAG.html#.fromBuffer\">fromBuffer</a>","description":"Construct a {@link DAG} from a Buffer."},{"title":"module:merked/dag~DAG.randomFill","link":"<a href=\"module-merked_dag-DAG.html#.randomFill\">randomFill</a>","description":"Get a buffer filled with random bytes - used to pad last shard."},{"title":"module:merked/dag~DAG~Metadata","link":"<a href=\"module-merked_dag-DAG.html#~Metadata\">Metadata</a>"},{"title":"module:merked/dag~DAG~Options","link":"<a href=\"module-merked_dag-DAG.html#~Options\">Options</a>"},{"title":"module:merked/split","link":"<a href=\"module-merked_split.html\">merked/split</a>"},{"title":"module:merked/split.split","link":"<a href=\"module-merked_split.html#.split\">split</a>","description":"Split buffer."},{"title":"module:merked/split.splitSync","link":"<a href=\"module-merked_split.html#.splitSync\">splitSync</a>","description":"Split buffer synchronously."},{"title":"module:merked/tree","link":"<a href=\"module-merked_tree.html\">merked/tree</a>","description":"A hash tree or Merkle tree is a tree in which every "leaf" node is labelled\nwith the cryptographic hash of a data block, and every node that is not a\nleaf (called a branch, inner node, or inode) is labelled with the\ncryptographic hash of the labels of its child nodes. A hash tree allows\nefficient and secure verification of the contents of a large data structure.\nA hash tree is a generalization of a hash list and a hash chain."},{"title":"module:merked/tree~MerkleTree","link":"<a href=\"module-merked_tree-MerkleTree.html\">MerkleTree</a>","description":"Implements a merkle hash tree"},{"title":"module:merked/tree~MerkleTree#depth","link":"<a href=\"module-merked_tree-MerkleTree.html#depth\">depth</a>","description":"Computes the tree depth"},{"title":"module:merked/tree~MerkleTree#level","link":"<a href=\"module-merked_tree-MerkleTree.html#level\">level</a>","description":"Returns the leaves at the given level"},{"title":"module:merked/tree~MerkleTree#levels","link":"<a href=\"module-merked_tree-MerkleTree.html#levels\">levels</a>","description":"Returns the number of levels in the tree"},{"title":"module:merked/tree~MerkleTree#nodes","link":"<a href=\"module-merked_tree-MerkleTree.html#nodes\">nodes</a>","description":"Returns the number of nodes in the tree"},{"title":"module:merked/tree~MerkleTree#root","link":"<a href=\"module-merked_tree-MerkleTree.html#root\">root</a>","description":"Returns the merkle root of the tree"},{"title":"{DAG}.DAG.DEFAULT_INPUT_SIZE","link":"<a href=\"%257BDAG%257D.html#.DAG.DEFAULT_INPUT_SIZE\">DAG.DEFAULT_INPUT_SIZE</a>"}]}