Address reviews

CHANGELOG.md

@@ -7,6 +7,8 @@ BREAKING CHANGES:
 - Better support for injecting randomness
 - Pass evidence/voteInfo through ABCI
 - Upgrade consensus for more real-time use of evidence
+- func(s *State) LoadABCIResponses() *ABCIResponses now returns nil if now ABCIResponses could be loaded from the database.
+  Previously it would return a pointer to an ABCIResponses object if it didn't find anything in the database.
 
 FEATURES:
 - Peer reputation management

rpc/lib/client/http_client.go

@@ -42,7 +42,8 @@ func makeHTTPDialer(remoteAddr string) (string, func(string, string) (net.Conn,
 		protocol = "tcp"
 	}
 
-	trimmedAddress := strings.Replace(address, "/", ".", -1) // replace / with . for http requests (dummy domain)
+	// replace / with . for http requests (dummy domain)
+	trimmedAddress := strings.Replace(address, "/", ".", -1)
 	return trimmedAddress, func(proto, addr string) (net.Conn, error) {
 		return net.Dial(protocol, address)
 	}
@@ -67,7 +68,7 @@ type JSONRPCClient struct {
 	client  *http.Client
 }
 
-// NewJSONRPCClient takes an address and returns a pointer to an instance of JSONRPCClient
+// NewJSONRPCClient returns a JSONRPCClient pointed at the given address.
 func NewJSONRPCClient(remote string) *JSONRPCClient {
 	address, client := makeHTTPClient(remote)
 	return &JSONRPCClient{

state/state.go

@@ -233,8 +233,8 @@ func (s *State) Bytes() []byte {
 	return wire.BinaryBytes(s)
 }
 
-// SetBlockAndValidators mutates State variables to update block and validators after running
+// SetBlockAndValidators mutates State variables
-// EndBlock.
+// to update block and validators after running EndBlock.
 func (s *State) SetBlockAndValidators(header *types.Header, blockPartsHeader types.PartSetHeader,
 	abciResponses *ABCIResponses) {
 

state/txindex/indexer.go

@@ -24,9 +24,8 @@ type TxIndexer interface {
 //----------------------------------------------------
 // Txs are written as a batch
 
-// Batch groups together multiple Index operations you would like performed
+// Batch groups together multiple Index operations to be performed at the same time.
-// at the same time.
+// NOTE: Batch is NOT thread-safe and must not be modified after starting its execution.
-// NOTE: Bach is NOT thread-safe and should not be modified after starting its execution.
 type Batch struct {
 	Ops []types.TxResult
 }

state/txindex/null/null.go

@@ -10,12 +10,12 @@ import (
 // TxIndex acts as a /dev/null.
 type TxIndex struct{}
 
-// Get with a hash panics.
+// Get on a TxIndex is disabled and panics when invoked.
 func (txi *TxIndex) Get(hash []byte) (*types.TxResult, error) {
 	return nil, errors.New(`Indexing is disabled (set 'tx_index = "kv"' in config)`)
 }
 
-// AddBatch returns nil.
+// AddBatch is a noop and always returns nil.
 func (txi *TxIndex) AddBatch(batch *txindex.Batch) error {
 	return nil
 }

types/block.go

@@ -21,7 +21,7 @@ type Block struct {
 	LastCommit *Commit `json:"last_commit"`
 }
 
-// MakeBlock returns a new block and corresponding part set from the given information.
+// MakeBlock returns a new block and corresponding partset from the given information.
 // TODO: Add version information to the Block struct.
 func MakeBlock(height int, chainID string, txs []Tx, commit *Commit,
 	prevBlockID BlockID, valHash, appHash []byte, partSize int) (*Block, *PartSet) {