common

package
v3.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 8, 2023 License: GPL-3.0 Imports: 19 Imported by: 0

Documentation

Overview

Package common contains various helper functions.

Package common - common tools nolint

Index

Constants

View Source 
const (
	// AddressLength is the expected length of the address
	AddressLength = 20
)

Lengths of addresses in bytes.

View Source 
const (
	// HashLength is the expected length of the hash
	HashLength = 32
)

Lengths of hashes in bytes.

Variables

View Source 
var (
	Big1   = big.NewInt(1)
	Big2   = big.NewInt(2)
	Big3   = big.NewInt(3)
	Big0   = big.NewInt(0)
	Big32  = big.NewInt(32)
	Big256 = big.NewInt(256)
	Big257 = big.NewInt(257)

	BigMaxUint64 = new(big.Int).SetUint64(math.MaxUint64)
)

Common big integers often used

Functions

func AbsolutePath 

func AbsolutePath(datadir, filename string) string

AbsolutePath returns datadir + filename, or filename if it is absolute.

func BigFromUint64 

func BigFromUint64(value uint64) *big.Int

BigFromUint64 new big int from uint64 value.

func BigUint64 

func BigUint64(v *big.Int) (uint64, bool)

BigUint64 big to uint64 and an overflow flag.

func Bytes2Hex 

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func CopyBytes 

func CopyBytes(b []byte) (copiedBytes []byte)

CopyBytes returns an exact copy of the provided bytes.

func CurrentDir added in v3.4.0 

func CurrentDir() (string, error)

CurrentDir current directory

func ExecuteDir 

func ExecuteDir() (string, error)

ExecuteDir returns the execute directory

func FileExist 

func FileExist(filePath string) bool

FileExist checks if a file exists at filePath.

func FirstN added in v3.6.1 

func FirstN(s string, n int) string

FirstN first n chars of string

func FromHex 

func FromHex(s string) []byte

FromHex returns the bytes represented by the hexadecimal string s. s may be prefixed with "0x".

func GetBigInt 

func GetBigInt(data []byte, start, size uint64) *big.Int

GetBigInt get big int from data[start:start+size]

func GetBigIntFromStr 

func GetBigIntFromStr(str string) (*big.Int, error)

GetBigIntFromStr new big int from string.

func GetData 

func GetData(data []byte, start, size uint64) []byte

GetData get data[start:start+size] (won't out of index range), and right padding the bytes to size long

func GetIntFromStr 

func GetIntFromStr(str string) (int, error)

GetIntFromStr get int from string.

func GetUint32FromStr added in v3.6.0 

func GetUint32FromStr(str string) (uint32, error)

GetUint32FromStr get uint64 from string.

func GetUint64 

func GetUint64(data []byte, start, size uint64) (uint64, bool)

GetUint64 get uint64 from data[start:start+size]

func GetUint64FromStr 

func GetUint64FromStr(str string) (uint64, error)

GetUint64FromStr get uint64 from string.

func GetUnprefixedHex 

func GetUnprefixedHex(str string) (unprefixedHex string, ok, hasUpperChar bool)

GetUnprefixedHex returns (unprefixed hex, is hex string flag, if has uppercase hexadecimal)

func HasHexPrefix 

func HasHexPrefix(str string) bool

HasHexPrefix validates str begins with '0x' or '0X'.

func Hex2Bytes 

func Hex2Bytes(str string) []byte

Hex2Bytes returns the bytes represented by the hexadecimal string str.

func Hex2BytesFixed 

func Hex2BytesFixed(str string, flen int) []byte

Hex2BytesFixed returns bytes of a specified fixed length flen.

func IsEqualIgnoreCase 

func IsEqualIgnoreCase(s1, s2 string) bool

IsEqualIgnoreCase returns if s1 and s2 are equal ignore case.

func IsHex 

func IsHex(str string) bool

IsHex validates whether each byte is valid hexadecimal string.

func IsHexAddress 

func IsHexAddress(s string) bool

IsHexAddress verifies whether a string can represent a valid hex-encoded Ethereum address or not.

func IsHexCharacter 

func IsHexCharacter(c byte) bool

IsHexCharacter returns bool of c being a valid hexadecimal.

func IsHexHash 

func IsHexHash(s string) bool

IsHexHash is hex hash

func IsUpperHexCharacter 

func IsUpperHexCharacter(c byte) bool

IsUpperHexCharacter returns bool of c being a valid uppercase hexadecimal.

func LeftPadBytes 

func LeftPadBytes(slice []byte, l int) []byte

LeftPadBytes zero-pads slice to the left up to length l.

func MakeName 

func MakeName(name, version string) string

MakeName creates a node name that follows the ethereum convention for such names. It adds the operation system name and Go runtime version the name.

func MarshalBigInt added in v3.2.1 

func MarshalBigInt(i *big.Int) (string, error)

MarshalBigInt marshalls big int into text string for consistent encoding

func MaxUint64 

func MaxUint64(x, y uint64) uint64

MaxUint64 get maximum calue of x and y.

func MinUint64 

func MinUint64(x, y uint64) uint64

MinUint64 get minimum value of x and y

func MustMarshalBigInt added in v3.2.1 

func MustMarshalBigInt(i *big.Int) string

MustMarshalBigInt marshalls big int into text string for consistent encoding. It panics if an error is encountered.

func MustRunBashCommand added in v3.6.1 

func MustRunBashCommand(cwd, cmdStr string) []string

MustRunBashCommand for tool usage

func MustUnmarshalBigInt added in v3.2.1 

func MustUnmarshalBigInt(s string) *big.Int

MustUnmarshalBigInt unmarshalls string from *big.Int. It panics if an error is encountered.

func Now 

func Now() int64

Now returns timestamp of the point of calling.

func NowMilli 

func NowMilli() int64

NowMilli returns now timestamp in miliseconds

func NowMilliStr 

func NowMilliStr() string

NowMilliStr returns now timestamp in miliseconds of string format.

func NowStr 

func NowStr() string

NowStr returns now timestamp of string format.

func RightPadBytes 

func RightPadBytes(slice []byte, l int) []byte

RightPadBytes zero-pads slice to the right up to length l.

func ToHex 

func ToHex(b []byte) string

ToHex returns the hex representation of b, prefixed with '0x'.

func ToJSONString 

func ToJSONString(content interface{}, pretty bool) string

ToJSONString to json string

func UnmarshalBigInt added in v3.2.1 

func UnmarshalBigInt(s string) (*big.Int, error)

UnmarshalBigInt unmarshalls string from *big.Int

Types

type Address 

type Address [AddressLength]byte

Address represents the 20 byte address of an Ethereum account.

func BigToAddress 

func BigToAddress(b *big.Int) Address

BigToAddress returns Address with byte values of b. If b is larger than len(h), b will be cropped from the left.

func BytesToAddress 

func BytesToAddress(b []byte) Address

BytesToAddress returns Address with value b. If b is larger than len(h), b will be cropped from the left.

func HexToAddress 

func HexToAddress(s string) Address

HexToAddress returns Address with byte values of s. If s is larger than len(h), s will be cropped from the left.

func (Address) Bytes 

func (a Address) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (Address) Format 

func (a Address) Format(s fmt.State, c rune)

Format implements fmt.Formatter, forcing the byte slice to be formatted as is, without going through the stringer interface used for logging.

func (Address) Hash 

func (a Address) Hash() Hash

Hash converts an address to a hash by left-padding it with zeros.

func (Address) Hex 

func (a Address) Hex() string

Hex returns an EIP55-compliant hex string representation of the address.

func (Address) ImplementsGraphQLType 

func (a Address) ImplementsGraphQLType(name string) bool

ImplementsGraphQLType returns true if Hash implements the specified GraphQL type.

func (Address) LowerHex 

func (a Address) LowerHex() string

LowerHex hex encoding address bytes with '0x' prefix and lower case letters

func (Address) MarshalText 

func (a Address) MarshalText() ([]byte, error)

MarshalText returns the hex representation of a.

func (*Address) Scan 

func (a *Address) Scan(src interface{}) error

Scan implements Scanner for database/sql.

func (*Address) SetBytes 

func (a *Address) SetBytes(b []byte)

SetBytes sets the address to the value of b. If b is larger than len(a) it will panic.

func (Address) String 

func (a Address) String() string

String implements fmt.Stringer.

func (*Address) UnmarshalGraphQL 

func (a *Address) UnmarshalGraphQL(input interface{}) error

UnmarshalGraphQL unmarshals the provided GraphQL query data.

func (*Address) UnmarshalJSON 

func (a *Address) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a hash in hex syntax.

func (*Address) UnmarshalText 

func (a *Address) UnmarshalText(input []byte) error

UnmarshalText parses a hash in hex syntax.

type Hash 

type Hash [HashLength]byte

Hash represents the 32 byte Keccak256 hash of arbitrary data. 

var (

	// EmptyHash empty hash
	EmptyHash Hash
)

func BigToHash 

func BigToHash(b *big.Int) Hash

BigToHash sets byte representation of b to hash. If b is larger than len(h), b will be cropped from the left.

func BytesToHash 

func BytesToHash(b []byte) Hash

BytesToHash sets b to hash. If b is larger than len(h), b will be cropped from the left.

func HexToHash 

func HexToHash(s string) Hash

HexToHash sets byte representation of s to hash. If b is larger than len(h), b will be cropped from the left.

func Keccak256Hash 

func Keccak256Hash(data ...[]byte) (h Hash)

Keccak256Hash calc keccak hash.

func (Hash) Big 

func (h Hash) Big() *big.Int

Big converts a hash to a big integer.

func (Hash) Bytes 

func (h Hash) Bytes() []byte

Bytes gets the byte representation of the underlying hash.

func (Hash) Format 

func (h Hash) Format(s fmt.State, c rune)

Format implements fmt.Formatter, forcing the byte slice to be formatted as is, without going through the stringer interface used for logging.

func (Hash) Generate 

func (h Hash) Generate(rander *rand.Rand, size int) reflect.Value

Generate implements testing/quick.Generator.

func (Hash) Hex 

func (h Hash) Hex() string

Hex converts a hash to a hex string.

func (Hash) ImplementsGraphQLType 

func (Hash) ImplementsGraphQLType(name string) bool

ImplementsGraphQLType returns true if Hash implements the specified GraphQL type.

func (Hash) MarshalText 

func (h Hash) MarshalText() ([]byte, error)

MarshalText returns the hex representation of h.

func (*Hash) Scan 

func (h *Hash) Scan(src interface{}) error

Scan implements Scanner for database/sql.

func (*Hash) SetBytes 

func (h *Hash) SetBytes(b []byte)

SetBytes sets the hash to the value of b. If b is larger than len(h), b will be cropped from the left.

func (Hash) String 

func (h Hash) String() string

String implements the stringer interface and is used also by the logger when doing full logging into a file.

func (Hash) TerminalString 

func (h Hash) TerminalString() string

TerminalString implements log.TerminalStringer, formatting a string for console output during logging.

func (*Hash) UnmarshalGraphQL 

func (h *Hash) UnmarshalGraphQL(input interface{}) error

UnmarshalGraphQL unmarshals the provided GraphQL query data.

func (*Hash) UnmarshalJSON 

func (h *Hash) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a hash in hex syntax.

func (*Hash) UnmarshalText 

func (h *Hash) UnmarshalText(input []byte) error

UnmarshalText parses a hash in hex syntax.

type MixedcaseAddress 

type MixedcaseAddress struct {
	// contains filtered or unexported fields
}

MixedcaseAddress retains the original string, which may or may not be correctly checksummed

func NewMixedcaseAddress 

func NewMixedcaseAddress(addr Address) MixedcaseAddress

NewMixedcaseAddress constructor (mainly for testing)

func NewMixedcaseAddressFromString 

func NewMixedcaseAddressFromString(hexaddr string) (*MixedcaseAddress, error)

NewMixedcaseAddressFromString is mainly meant for unit-testing

func (*MixedcaseAddress) Address 

func (ma *MixedcaseAddress) Address() Address

Address returns the address

func (*MixedcaseAddress) MarshalJSON 

func (ma *MixedcaseAddress) MarshalJSON() ([]byte, error)

MarshalJSON marshals the original value

func (*MixedcaseAddress) Original 

func (ma *MixedcaseAddress) Original() string

Original returns the mixed-case input string

func (*MixedcaseAddress) String 

func (ma *MixedcaseAddress) String() string

String implements fmt.Stringer

func (*MixedcaseAddress) UnmarshalJSON 

func (ma *MixedcaseAddress) UnmarshalJSON(input []byte) error

UnmarshalJSON parses MixedcaseAddress

func (*MixedcaseAddress) ValidChecksum 

func (ma *MixedcaseAddress) ValidChecksum() bool

ValidChecksum returns true if the address has valid checksum

type StorageSize added in v3.4.0 

type StorageSize float64

StorageSize is a wrapper around a float value that supports user friendly formatting.

func (StorageSize) String added in v3.4.0 

func (s StorageSize) String() string

String implements the stringer interface.

func (StorageSize) TerminalString added in v3.4.0 

func (s StorageSize) TerminalString() string

TerminalString implements log.TerminalStringer, formatting a string for console output during logging.

type UnprefixedAddress 

type UnprefixedAddress Address

UnprefixedAddress allows marshaling an Address without 0x prefix.

func (UnprefixedAddress) MarshalText 

func (a UnprefixedAddress) MarshalText() ([]byte, error)

MarshalText encodes the address as hex.

func (*UnprefixedAddress) UnmarshalText 

func (a *UnprefixedAddress) UnmarshalText(input []byte) error

UnmarshalText decodes the address from hex. The 0x prefix is optional.

type UnprefixedHash 

type UnprefixedHash Hash

UnprefixedHash allows marshaling a Hash without 0x prefix.

func (UnprefixedHash) MarshalText 

func (h UnprefixedHash) MarshalText() ([]byte, error)

MarshalText encodes the hash as hex.

func (*UnprefixedHash) UnmarshalText 

func (h *UnprefixedHash) UnmarshalText(input []byte) error

UnmarshalText decodes the hash from hex. The 0x prefix is optional.

Source Files

View all Source files

Directories

Path Synopsis
Package hexutil implements hex encoding with 0x prefix.
 Package hexutil implements hex encoding with 0x prefix.
Package math provides integer math utilities.
 Package math provides integer math utilities.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.