From 217f84c78ddaa0ef3c0302ef7a77422b31128f05 Mon Sep 17 00:00:00 2001 From: Cameron Bergoon Date: Mon, 19 Jun 2017 23:40:19 -0400 Subject: [PATCH] Updating comment for linter --- doc.go | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/doc.go b/doc.go index 55a6412..5da0be4 100644 --- a/doc.go +++ b/doc.go @@ -1,31 +1,30 @@ // Copyright 2017 Cameron Bergoon // Licensed under the MIT License, see LICENCE file for details. -/* Package merkletree implements a Merkle Tree capable of storing arbitrary content. +/*Package merkletree implements a Merkle Tree capable of storing arbitrary content. - A Merkle Tree is a hash tree that provides an efficient way to verify the contents - of a set data are present and untampered with. At its core, a Merkle Tree is - a list of items representing the data that should be verified. Each of these items - is inserted into a leaf node and a tree of hashes is constructed bottom up using a - hash of the nodes left and right children's hashes. This means that the root node - will effictively be a hash of all other nodes (hashes) in the tree. This property - allows the tree to be reproduced and thus verified by on the hash of the root node - of the tree. The benefit of the tree structure is verifying any single content - entry in the tree will require only nlog2(n) steps in the worst case. +A Merkle Tree is a hash tree that provides an efficient way to verify the contents +of a set data are present and untampered with. At its core, a Merkle Tree is +a list of items representing the data that should be verified. Each of these items +is inserted into a leaf node and a tree of hashes is constructed bottom up using a +hash of the nodes left and right children's hashes. This means that the root node +will effictively be a hash of all other nodes (hashes) in the tree. This property +allows the tree to be reproduced and thus verified by on the hash of the root node +of the tree. The benefit of the tree structure is verifying any single content +entry in the tree will require only nlog2(n) steps in the worst case. - Creating a new merkletree requires that the type that the tree will be constructed - from implements the Content interface. +Creating a new merkletree requires that the type that the tree will be constructed +from implements the Content interface. - type Content interface { - CalculateHash() []byte - Equals(other Content) bool - } + type Content interface { + CalculateHash() []byte + Equals(other Content) bool + } - A slice of the Content items should be created and then passed to the NewTree method. +A slice of the Content items should be created and then passed to the NewTree method. - t, err := merkle.NewTree(list) + t, err := merkle.NewTree(list) - t represents the Merkle Tree and can be verified and manipulated with the API methods - described below. -*/ +t represents the Merkle Tree and can be verified and manipulated with the API methods +described below.*/ package merkletree