Merge branch 'master' into iterator-go-fix-doublecheck-todo

Author: DeVikingMark

.gitignore

@@ -1,4 +1,6 @@
+# binary built during testing
 cmd/legacydump/legacydump
+
 vendor
 .glide
 *.swp

Makefile

@@ -24,10 +24,10 @@ test-short:
 	@go test ./... $(LDFLAGS) -v --race --short
 .PHONY: test-short
 
-cmd/legacydump/legacydump: 
+legacydump:
 	cd cmd/legacydump && go build -o legacydump main.go
 
-test: cmd/legacydump/legacydump
+test: legacydump
 	@echo "--> Running go test"
 	@go test ./... $(LDFLAGS) 
 .PHONY: test

PERFORMANCE.md

@@ -23,7 +23,7 @@ The rest of this document is the planned or completed actions for the above-list
 ## Cleanup
 
 Done in branch `cleanup_deps`:
-  * Fixed up dependeny management (tmlibs/db etc in glide/vendor)
+  * Fixed up dependency management (tmlibs/db etc in glide/vendor)
   * Updated Makefile (test, bench, get_deps)
   * Fixed broken code - `looper.go` and one benchmark didn't run
 

go.mod

@@ -10,7 +10,7 @@ require (
 	github.com/google/btree v1.1.3
 	github.com/stretchr/testify v1.10.0
 	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7
-	go.uber.org/mock v0.5.1
+	go.uber.org/mock v0.5.2
 )
 
 require (

go.sum

@@ -64,8 +64,8 @@ github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 h1:epCh84lMvA70
 github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7/go.mod h1:q4W45IWZaF22tdD+VEXcAWRA037jwmWEB5VWYORlTpc=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
-go.uber.org/mock v0.5.1 h1:ASgazW/qBmR+A32MYFDB6E2POoTgOwT509VP0CT/fjs=
-go.uber.org/mock v0.5.1/go.mod h1:ge71pBPLYDk7QIi1LupWxdAykm7KIEFchiOqd6z7qMM=
+go.uber.org/mock v0.5.2 h1:LbtPTcP8A5k9WPXj54PPPbjcI4Y6lhyOZXn+VS7wNko=
+go.uber.org/mock v0.5.2/go.mod h1:wLlUxC2vVTPTaE3UD51E0BGOAElKrILxhVSDYQLld5o=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=

immutable_tree.go

@@ -52,7 +52,7 @@ func (t *ImmutableTree) String() string {
 	return "Tree{" + strings.Join(leaves, ", ") + "}"
 }
 
-// RenderShape provides a nested tree shape, ident is prepended in each level
+// RenderShape provides a nested tree shape, indent is prepended in each level
 // Returns an array of strings, one per line, to join with "\n" or display otherwise
 func (t *ImmutableTree) RenderShape(indent string, encoder NodeEncoder) ([]string, error) {
 	if encoder == nil {
@@ -63,7 +63,7 @@ func (t *ImmutableTree) RenderShape(indent string, encoder NodeEncoder) ([]strin
 
 // NodeEncoder will take an id (hash, or key for leaf nodes), the depth of the node,
 // and whether or not this is a leaf node.
-// It returns the string we wish to print, for iaviwer
+// It returns the string we wish to print, for iavlviewer
 type NodeEncoder func(id []byte, depth int, isLeaf bool) string
 
 // defaultNodeEncoder can encode any node unless the client overrides it
@@ -209,7 +209,7 @@ func (t *ImmutableTree) Get(key []byte) ([]byte, error) {
 
 	// otherwise skipFastStorageUpgrade is true or
 	// the cached node was updated later than the current tree. In this case,
-	// we need to use the regular stategy for reading from the current tree to avoid staleness.
+	// we need to use the regular strategy for reading from the current tree to avoid staleness.
 	_, result, err := t.root.get(t, key)
 	return result, err
 }
@@ -326,7 +326,7 @@ func (t *ImmutableTree) nodeSize() int {
 	return int(t.root.size*2 - 1)
 }
 
-// TraverseStateChanges iterate the range of versions, compare each version to it's predecessor to extract the state changes of it.
+// TraverseStateChanges iterate the range of versions, compare each version to its predecessor to extract the state changes of it.
 // endVersion is exclusive.
 func (t *ImmutableTree) TraverseStateChanges(startVersion, endVersion int64, fn func(version int64, changeSet *ChangeSet) error) error {
 	return t.ndb.traverseStateChanges(startVersion, endVersion, fn)

iterator.go

@@ -68,12 +68,12 @@ func (nodes *delayedNodes) length() int {
 // next traversal to proceed, or simply discard the `traversal` struct to stop iteration.
 //
 // At the each step of `next`, the `delayedNodes` can have one of the three states:
-// 1. It has length of 0, meaning that their is no more traversable nodes.
+// 1. It has length of 0, meaning that there is no more traversable nodes.
 // 2. It has length of 1, meaning that the traverse is being started from the initial node.
 // 3. It has length of 2>=, meaning that there are delayed nodes to be traversed.
 //
 // When the `delayedNodes` are not empty, `next` retrieves the first `delayedNode` and initially check:
-// 1. If it is not an delayed node (node.delayed == false) it immediately returns it.
+// 1. If it is not a delayed node (node.delayed == false) it immediately returns it.
 //
 // A. If the `node` is a branch node:
 //  1. If the traversal is postorder, then append the current node to the t.delayedNodes,
@@ -164,7 +164,7 @@ func (t *traversal) next() (*Node, error) {
 		return node, nil
 	}
 
-	// Keep traversing and expanding the remaning delayed nodes. A-4.
+	// Keep traversing and expanding the remaining delayed nodes. A-4.
 	return t.next()
 }
 
@@ -258,7 +258,7 @@ func (iter *Iterator) Error() error {
 	return iter.err
 }
 
-// IsFast returnts true if iterator uses fast strategy
+// IsFast returns true if iterator uses fast strategy
 func (iter *Iterator) IsFast() bool {
 	return false
 }

testutils_test.go

@@ -283,7 +283,7 @@ func setupMirrorForIterator(t *testing.T, config *iteratorTestConfig, tree *Muta
 	return mirror
 }
 
-// assertIterator confirms that the iterator returns the expected values desribed by mirror in the same order.
+// assertIterator confirms that the iterator returns the expected values described by mirror in the same order.
 // mirror is a slice containing slices of the form [key, value]. In other words, key at index 0 and value at index 1.
 func assertIterator(t *testing.T, itr corestore.Iterator, mirror [][]string, ascending bool) {
 	startIdx, endIdx := 0, len(mirror)-1