From d9c8cbe51f8e1bc559ac3882b51e0211e7205791 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Tue, 8 May 2018 15:17:03 +0200 Subject: [PATCH 1/4] common: improve comments --- common/bytes.go | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/common/bytes.go b/common/bytes.go index 2892cc035a..bb605d182f 100644 --- a/common/bytes.go +++ b/common/bytes.go @@ -19,17 +19,18 @@ package common import "encoding/hex" -// ToHex returns string representation of b and either prepends '0x' or initializes value of '0'. +// ToHex returns the hex representation of b, prefixed with '0x'. +// For empty slices, the return value is "0x0". func ToHex(b []byte) string { hex := Bytes2Hex(b) - // Prefer output of "0x0" instead of "0x" if len(hex) == 0 { hex = "0" } return "0x" + hex } -//FromHex returns bytes of s after removing prefix, or prepends 0 if s has odd length. +// FromHex returns the bytes represented by the hexadecimal string s. +// s may be prefixed with "0x". func FromHex(s string) []byte { if len(s) > 1 { if s[0:2] == "0x" || s[0:2] == "0X" { @@ -42,7 +43,7 @@ func FromHex(s string) []byte { return Hex2Bytes(s) } -// CopyBytes returns an exact copy of the provided bytes +// CopyBytes returns an exact copy of the provided bytes. func CopyBytes(b []byte) (copiedBytes []byte) { if b == nil { return nil @@ -76,7 +77,7 @@ func isHex(str string) bool { return true } -//Bytes2Hex returns the hexadecimal encoding of d. +// Bytes2Hex returns the hexadecimal encoding of d. func Bytes2Hex(d []byte) string { return hex.EncodeToString(d) } @@ -84,7 +85,6 @@ func Bytes2Hex(d []byte) string { // Hex2Bytes returns the bytes represented by the hexadecimal string str. func Hex2Bytes(str string) []byte { h, _ := hex.DecodeString(str) - return h } @@ -102,7 +102,7 @@ func Hex2BytesFixed(str string, flen int) []byte { return hh } -// RightPadBytes copies slice into a byte slice of length l. +// RightPadBytes zero-pads slice to the right up to length l. func RightPadBytes(slice []byte, l int) []byte { if l <= len(slice) { return slice @@ -114,7 +114,7 @@ func RightPadBytes(slice []byte, l int) []byte { return padded } -// LeftPadBytes copies via inverted index slice into a byte slice of length l. +// LeftPadBytes zero-pads slice to the left up to length l. func LeftPadBytes(slice []byte, l int) []byte { if l <= len(slice) { return slice From 1e61e5dcd348b70737543b08a072e06d5df13ed6 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Tue, 8 May 2018 16:34:03 +0200 Subject: [PATCH 2/4] common: improve more comments Also remove unused methods on Hash and Address. --- common/bytes.go | 2 ++ common/path.go | 2 +- common/types.go | 63 ++++++++++++++------------------------- common/types_template.go | 64 ---------------------------------------- 4 files changed, 25 insertions(+), 106 deletions(-) delete mode 100644 common/types_template.go diff --git a/common/bytes.go b/common/bytes.go index bb605d182f..cbab2c3fa9 100644 --- a/common/bytes.go +++ b/common/bytes.go @@ -21,6 +21,8 @@ import "encoding/hex" // ToHex returns the hex representation of b, prefixed with '0x'. // For empty slices, the return value is "0x0". +// +// Deprecated: use hexutil.Encode instead. func ToHex(b []byte) string { hex := Bytes2Hex(b) if len(hex) == 0 { diff --git a/common/path.go b/common/path.go index f848f47f2d..6d0c92caab 100644 --- a/common/path.go +++ b/common/path.go @@ -30,7 +30,7 @@ func MakeName(name, version string) string { return fmt.Sprintf("%s/v%s/%s/%s", name, version, runtime.GOOS, runtime.Version()) } -// FileExist checks if a file exists at filePath and returns a bool. +// FileExist checks if a file exists at filePath. func FileExist(filePath string) bool { _, err := os.Stat(filePath) if err != nil && os.IsNotExist(err) { diff --git a/common/types.go b/common/types.go index 1cb0ce170c..2d6a5ce48e 100644 --- a/common/types.go +++ b/common/types.go @@ -29,7 +29,6 @@ import ( "github.com/ethereum/go-ethereum/crypto/sha3" ) -// Sets global constants. const ( HashLength = 32 AddressLength = 20 @@ -43,29 +42,29 @@ var ( // Hash represents the 32 byte Keccak256 hash of arbitrary data. type Hash [HashLength]byte -// BytesToHash sets b to hash. If b is larger than len(h), 'b' will be cropped (from the left). +// BytesToHash sets b to hash. +// If b is larger than len(h), b will be cropped from the left. func BytesToHash(b []byte) Hash { var h Hash h.SetBytes(b) return h } -// BigToHash sets byte representation of b to hash. If b is larger than len(h), 'b' will be cropped (from the left). +// BigToHash sets byte representation of b to hash. +// If b is larger than len(h), b will be cropped from the left. func BigToHash(b *big.Int) Hash { return BytesToHash(b.Bytes()) } -// HexToHash sets byte representation of s to hash. If b is larger than len(h), 'b' will be cropped (from the left). +// HexToHash sets byte representation of s to hash. +// If b is larger than len(h), b will be cropped from the left. func HexToHash(s string) Hash { return BytesToHash(FromHex(s)) } -// Str gets the string representation of the underlying hash. -func (h Hash) Str() string { return string(h[:]) } - // Bytes gets the byte representation of the underlying hash. func (h Hash) Bytes() []byte { return h[:] } -// Big gets the big integer representation of the underlying hash. +// Big converts a hash to a big integer. func (h Hash) Big() *big.Int { return new(big.Int).SetBytes(h[:]) } -// Hex gets the hex representation of the underlying hash. +// Hex converts a hash to a hex string. func (h Hash) Hex() string { return hexutil.Encode(h[:]) } // TerminalString implements log.TerminalStringer, formatting a string for console @@ -101,7 +100,8 @@ func (h Hash) MarshalText() ([]byte, error) { return hexutil.Bytes(h[:]).MarshalText() } -// SetBytes sets the hash to the value of b. If b is larger than len(h), 'b' will be cropped (from the left). +// SetBytes sets the hash to the value of b. +// If b is larger than len(h), b will be cropped from the left. func (h *Hash) SetBytes(b []byte) { if len(b) > len(h) { b = b[len(b)-HashLength:] @@ -110,16 +110,6 @@ func (h *Hash) SetBytes(b []byte) { copy(h[HashLength-len(b):], b) } -// SetString sets `s` to h. If s is larger than len(h) s will be cropped (from left) to fit. -func (h *Hash) SetString(s string) { h.SetBytes([]byte(s)) } - -// Set sets h to other -func (h *Hash) Set(other Hash) { - for i, v := range other { - h[i] = v - } -} - // Generate implements testing/quick.Generator. func (h Hash) Generate(rand *rand.Rand, size int) reflect.Value { m := rand.Intn(len(h)) @@ -129,7 +119,7 @@ func (h Hash) Generate(rand *rand.Rand, size int) reflect.Value { return reflect.ValueOf(h) } -// EmptyHash clears h of values. +// EmptyHash checks whether h is the zero hash. func EmptyHash(h Hash) bool { return h == Hash{} } @@ -152,17 +142,20 @@ func (h UnprefixedHash) MarshalText() ([]byte, error) { // Address represents the 20 byte address of an Ethereum account. type Address [AddressLength]byte -// BytesToAddress returns Address with value b. If b is larger than len(h), 'b' will be cropped (from the left). +// BytesToAddress returns Address with value b. +// If b is larger than len(h), b will be cropped from the left. func BytesToAddress(b []byte) Address { var a Address a.SetBytes(b) return a } -//BigToAddress returns Address with byte values of b. If b is larger than len(h), 'b' will be cropped (from the left). +// BigToAddress returns Address with byte values of b. +// If b is larger than len(h), b will be cropped from the left. func BigToAddress(b *big.Int) Address { return BytesToAddress(b.Bytes()) } -//HexToAddress returns Address with byte values of s. If s is larger than len(h), 's' will be cropped (from the left). +// HexToAddress returns Address with byte values of s. +// If s is larger than len(h), s will be cropped from the left. func HexToAddress(s string) Address { return BytesToAddress(FromHex(s)) } // IsHexAddress verifies whether a string can represent a valid hex-encoded @@ -174,16 +167,13 @@ func IsHexAddress(s string) bool { return len(s) == 2*AddressLength && isHex(s) } -// Str gets the string representation of the underlying address. -func (a Address) Str() string { return string(a[:]) } - // Bytes gets the string representation of the underlying address. func (a Address) Bytes() []byte { return a[:] } -// Big gets the string representation of the underlying address. +// Big converts an address to a big integer. func (a Address) Big() *big.Int { return new(big.Int).SetBytes(a[:]) } -// Hash gets the string representation of the underlying address. +// Hash converts an address to a hash by left-padding it with zeros. func (a Address) Hash() Hash { return BytesToHash(a[:]) } // Hex returns an EIP55-compliant hex string representation of the address. @@ -208,7 +198,7 @@ func (a Address) Hex() string { return "0x" + string(result) } -// String implements the stringer interface and is used also by the logger. +// String implements fmt.Stringer. func (a Address) String() string { return a.Hex() } @@ -219,7 +209,8 @@ func (a Address) Format(s fmt.State, c rune) { fmt.Fprintf(s, "%"+string(c), a[:]) } -// SetBytes sets the address to the value of b. If b is larger than len(a) it will panic +// SetBytes sets the address to the value of b. +// If b is larger than len(a) it will panic. func (a *Address) SetBytes(b []byte) { if len(b) > len(a) { b = b[len(b)-AddressLength:] @@ -227,16 +218,6 @@ func (a *Address) SetBytes(b []byte) { copy(a[AddressLength-len(b):], b) } -// SetString sets `s` to a. If s is larger than len(a) it will panic -func (a *Address) SetString(s string) { a.SetBytes([]byte(s)) } - -// Set sets a to other -func (a *Address) Set(other Address) { - for i, v := range other { - a[i] = v - } -} - // MarshalText returns the hex representation of a. func (a Address) MarshalText() ([]byte, error) { return hexutil.Bytes(a[:]).MarshalText() diff --git a/common/types_template.go b/common/types_template.go deleted file mode 100644 index 9a8f29977b..0000000000 --- a/common/types_template.go +++ /dev/null @@ -1,64 +0,0 @@ -// Copyright 2015 The go-ethereum Authors -// This file is part of the go-ethereum library. -// -// The go-ethereum library is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// The go-ethereum library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with the go-ethereum library. If not, see . - -// +build none -//sed -e 's/_N_/Hash/g' -e 's/_S_/32/g' -e '1d' types_template.go | gofmt -w hash.go - -package common - -import "math/big" - -type _N_ [_S_]byte - -func BytesTo_N_(b []byte) _N_ { - var h _N_ - h.SetBytes(b) - return h -} -func StringTo_N_(s string) _N_ { return BytesTo_N_([]byte(s)) } -func BigTo_N_(b *big.Int) _N_ { return BytesTo_N_(b.Bytes()) } -func HexTo_N_(s string) _N_ { return BytesTo_N_(FromHex(s)) } - -// Don't use the default 'String' method in case we want to overwrite - -// Get the string representation of the underlying hash -func (h _N_) Str() string { return string(h[:]) } -func (h _N_) Bytes() []byte { return h[:] } -func (h _N_) Big() *big.Int { return new(big.Int).SetBytes(h[:]) } -func (h _N_) Hex() string { return "0x" + Bytes2Hex(h[:]) } - -// Sets the hash to the value of b. If b is larger than len(h) it will panic -func (h *_N_) SetBytes(b []byte) { - // Use the right most bytes - if len(b) > len(h) { - b = b[len(b)-_S_:] - } - - // Reverse the loop - for i := len(b) - 1; i >= 0; i-- { - h[_S_-len(b)+i] = b[i] - } -} - -// Set string `s` to h. If s is larger than len(h) it will panic -func (h *_N_) SetString(s string) { h.SetBytes([]byte(s)) } - -// Sets h to other -func (h *_N_) Set(other _N_) { - for i, v := range other { - h[i] = v - } -} From 9e384f56588ab35858fc9d598a9c37f2540b6991 Mon Sep 17 00:00:00 2001 From: kiel barry Date: Mon, 14 May 2018 10:18:55 -0700 Subject: [PATCH 3/4] common: pr updates --- common/types.go | 5 ----- 1 file changed, 5 deletions(-) diff --git a/common/types.go b/common/types.go index 2d6a5ce48e..12c26d94bc 100644 --- a/common/types.go +++ b/common/types.go @@ -119,11 +119,6 @@ func (h Hash) Generate(rand *rand.Rand, size int) reflect.Value { return reflect.ValueOf(h) } -// EmptyHash checks whether h is the zero hash. -func EmptyHash(h Hash) bool { - return h == Hash{} -} - // UnprefixedHash allows marshaling a Hash without 0x prefix. type UnprefixedHash Hash From e344ba8653f9cd6d038d755639ba532731f6e734 Mon Sep 17 00:00:00 2001 From: kiel barry Date: Mon, 14 May 2018 10:19:58 -0700 Subject: [PATCH 4/4] common: pr update for datadir --- common/path.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/common/path.go b/common/path.go index 6d0c92caab..69820cfe5d 100644 --- a/common/path.go +++ b/common/path.go @@ -40,10 +40,10 @@ func FileExist(filePath string) bool { return true } -// AbsolutePath returns Datadir + filename, or filename if it is absolute. -func AbsolutePath(Datadir string, filename string) string { +// AbsolutePath returns datadir + filename, or filename if it is absolute. +func AbsolutePath(datadir string, filename string) string { if filepath.IsAbs(filename) { return filename } - return filepath.Join(Datadir, filename) + return filepath.Join(datadir, filename) }