This repository has been archived by the owner on Sep 15, 2021. It is now read-only.
Add interface and correctness reference #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
janos
reviewed
Apr 2, 2020
reference/doc.go
Outdated
| // Copyright 2020 The Swarm Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
| // |
bmt.go
Outdated
| // BMT provides the necessary extension of the hash interface to add the length-prefix of the BMT hash | ||
| // | ||
| // Any implementation should make it possible to generate a BMT hash using the hash.Hash interface only. However, the limitation will be that the Span of the BMT hash always must be limited to the amount of bytes actually written. | ||
| type BMTHash interface { |
There was a problem hiding this comment.
As the package is called bmt, could this type be called just Hash?
bmt.go
Outdated
| "hash" | ||
| ) | ||
|
|
||
| // BMT provides the necessary extension of the hash interface to add the length-prefix of the BMT hash |
nolash
force-pushed
the
lash/interface-and-correctness
branch
from
856dc17
to
14c63aa
Compare
|
Thanks @janos amended |
|
@janos you're right I was a bit quick there. Is this better? |
acud
approved these changes
Apr 6, 2020
bmt.go
Outdated
|
|
||
| // Hash provides the necessary extension of the hash interface to add the length-prefix of the BMT hash. | ||
| // | ||
| // Any implementation should make it possible to generate a BMT hash using the hash.Hash interface only. However, the limitation will be that the Span of the BMT hash always must be limited to the amount of bytes actually written. |
There was a problem hiding this comment.
maybe have this comment split into two lines?
reference/doc.go
Outdated
| // license that can be found in the LICENSE file. | ||
|
|
||
| // Package bmt is a simple nonconcurrent reference implementation for hashsize segment based | ||
| // Binary Merkle tree hash on arbitrary but fixed maximum chunksize |
There was a problem hiding this comment.
somewhat ambivalent.
maybe "on a bounded n number of bytes such that 0 ≤ n ≤ 4096 bytes`?
reference/reference.go
Outdated
| return rh.hash(d, rh.maxDataLength) | ||
| } | ||
|
|
||
| // data has length maxDataLength = segmentSize * 2^k |
reference/reference.go
Outdated
| // section contains two data segments (d) | ||
| section = data | ||
| } else { | ||
| // section contains hashes of left and right BMT subtreea |
acud
approved these changes
Apr 6, 2020
janos
approved these changes
Apr 6, 2020
| } | ||
|
|
||
| // calculates the Keccak256 SHA3 hash of the data | ||
| func sha3hash(t *testing.T, data ...[]byte) []byte { |
There was a problem hiding this comment.
It would be good this function as t.Helper.
There was a problem hiding this comment.
That means just add t.Helper() as first line in the function? @janos
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the initial introduction of the BMT component for use in bee. It contains the interface implementation, along with a reference bmt hash generator largely copied from the
bmtpackage ofswarm. The latter does not implement the BMT interface, it is only intended to generate correct hashes using code that is as easy to understand as possible.Part of ethersphere/bee#39