common

package
v0.0.0-...-a173fca Latest Latest
Warning

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

 Go to latest Published: Mar 1, 2021 License: LGPL-3.0 Imports: 29 Imported by: 0

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const (
	PendingBlockNumber  = BlockNumber(-2)
	LatestBlockNumber   = BlockNumber(-1)
	EarliestBlockNumber = BlockNumber(0)
)
View Source 
const (
	MaxInt8   = 1<<7 - 1
	MinInt8   = -1 << 7
	MaxInt16  = 1<<15 - 1
	MinInt16  = -1 << 15
	MaxInt32  = 1<<31 - 1
	MinInt32  = -1 << 31
	MaxInt64  = 1<<63 - 1
	MinInt64  = -1 << 63
	MaxUint8  = 1<<8 - 1
	MaxUint16 = 1<<16 - 1
	MaxUint32 = 1<<32 - 1
	MaxUint64 = 1<<64 - 1
)

Integer limit values.

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)
)
View Source 
var (
	ErrEmptyString   = &decError{"empty hex string"}
	ErrSyntax        = &decError{"invalid hex string"}
	ErrMissingPrefix = &decError{"hex string without 0x prefix"}
	ErrOddLength     = &decError{"hex string of odd length"}
	ErrEmptyNumber   = &decError{"hex string \"0x\""}
	ErrLeadingZero   = &decError{"hex number with leading zero digits"}
	ErrUint64Range   = &decError{"hex number > 64 bits"}
	ErrUintRange     = &decError{fmt.Sprintf("hex number > %d bits", uintBits)}
	ErrBig256Range   = &decError{"hex number > 256 bits"}
)

Errors

View Source 
var Version int32 = 1

Functions

func AllZero 

func AllZero(b []byte) bool

func AppDataDir 

func AppDataDir(appName string, roaming bool) string

AppDataDir returns an operating system specific directory to be used for storing application data for an application.

The appName parameter is the name of the application the data directory is being requested for. This function will prepend a period to the appName for POSIX style operating systems since that is standard practice. An empty appName or one with a single dot is treated as requesting the current directory so only "." will be returned. Further, the first character of appName will be made lowercase for POSIX style operating systems and uppercase for Mac and Windows since that is standard practice.

The roaming parameter only applies to Windows where it specifies the roaming application data profile (%APPDATA%) should be used instead of the local one (%LOCALAPPDATA%) that is used by default.

Example results: 

dir := AppDataDir("myapp", false)
 POSIX (Linux/BSD): ~/.myapp
 Mac OS: $HOME/Library/Application Support/Myapp
 Windows: %LOCALAPPDATA%\Myapp
 Plan 9: $home/myapp

func BigIntMustFromString 

func BigIntMustFromString(number string) *big.Int

func Bytes2Hex 

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func CalcMemSize 

func CalcMemSize(off, l *big.Int) *big.Int

func CopyBytes 

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

CopyBytes returns an exact copy of the provided bytes.

func Decode 

func Decode(input string) ([]byte, error)

Decode decodes a hex string with 0x prefix.

func DecodeBig 

func DecodeBig(input string) (*big.Int, error)

DecodeBig decodes a hex string with 0x prefix as a quantity. Numbers larger than 256 bits are not accepted.

func DecodeUint64 

func DecodeUint64(input string) (uint64, error)

DecodeUint64 decodes a hex string with 0x prefix as a quantity.

func Encode 

func Encode(b []byte) string

Encode encodes b as a hex string with 0x prefix.

func EncodeBig 

func EncodeBig(bigint *big.Int) string

EncodeBig encodes bigint as a hex string with 0x prefix. The sign of the integer is ignored.

func EncodeUint64 

func EncodeUint64(i uint64) string

EncodeUint64 encodes i as a hex string with 0x prefix.

func ExpandPath 

func ExpandPath(p string) string

Expands a file path 1. replace tilde with users home dir 2. expands embedded environment variables 3. cleans the path, e.g. /a/b/../c -> /a/c Note, it has limitations, e.g. ~someuser/tmp will not be expanded

func FileExist 

func FileExist(filePath string) bool

FileExist checks if a file exists at filePath.

func FromHex 

func FromHex(s string) []byte

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

func GenUnique 

func GenUnique() ([]byte, error)

func GetData 

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

func GetDataBig 

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

func GlobalBig 

func GlobalBig(ctx *cli.Context, name string) *big.Int

GlobalBig returns the value of a BigFlag from the global flag set.

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 HmAC 

func HmAC(message, key []byte) []byte

func HomeDir 

func HomeDir() string

func IsHex 

func IsHex(str string) bool

isHex validates whether each byte is valid hexadecimal string.

func IsHexCharacter 

func IsHexCharacter(c byte) bool

isHexCharacter returns bool of c being a valid hexadecimal.

func LeftPadBytes 

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

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

func MustDecode 

func MustDecode(input string) []byte

MustDecode decodes a hex string with 0x prefix. It panics for invalid input.

func MustDecodeBig 

func MustDecodeBig(input string) *big.Int

MustDecodeBig decodes a hex string with 0x prefix as a quantity. It panics for invalid input.

func MustDecodeUint64 

func MustDecodeUint64(input string) uint64

MustDecodeUint64 decodes a hex string with 0x prefix as a quantity. It panics for invalid input.

func MustParseUint64 

func MustParseUint64(s string) uint64

MustParseUint64 parses s as an integer and panics if the string is invalid.

func ParseUint64 

func ParseUint64(s string) (uint64, bool)

ParseUint64 parses s as an integer in decimal or hexadecimal syntax. Leading zeros are accepted. The empty string parses as zero.

func RightPadBytes 

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

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

func SafeAdd 

func SafeAdd(x, y uint64) (uint64, bool)

SafeAdd returns the result and whether overflow occurred.

func SafeMul 

func SafeMul(x, y uint64) (uint64, bool)

SafeMul returns multiplication result and whether overflow occurred.

func SafeSub 

func SafeSub(x, y uint64) (uint64, bool)

SafeSub returns subtraction result and whether overflow occurred.

func SliceEqual 

func SliceEqual(a []interface{}, b []interface{}, cp func(interface{}, interface{}) bool) bool

func ToHex deprecated 

func ToHex(b []byte) string

ToHex returns the hex representation of b, prefixed with '0x'. For empty slices, the return value is "0x0".

Deprecated: use hexutil.Encode instead.

func ToHexArray 

func ToHexArray(b [][]byte) []string

ToHexArray creates a array of hex-string based on []byte

func ToWordSize 

func ToWordSize(size uint64) uint64

func UnmarshalFixedJSON 

func UnmarshalFixedJSON(typ reflect.Type, input, out []byte) error

UnmarshalFixedJSON decodes the input as a string with 0x prefix. The length of out determines the required input length. This function is commonly used to implement the UnmarshalJSON method for fixed-size types.

func UnmarshalFixedText 

func UnmarshalFixedText(typname string, input, out []byte) error

UnmarshalFixedText decodes the input as a string with 0x prefix. The length of out determines the required input length. This function is commonly used to implement the UnmarshalText method for fixed-size types.

func UnmarshalFixedUnprefixedText 

func UnmarshalFixedUnprefixedText(typname string, input, out []byte) error

UnmarshalFixedUnprefixedText decodes the input as a string with optional 0x prefix. The length of out determines the required input length. This function is commonly used to implement the UnmarshalText method for fixed-size types.

Types

type Big 

type Big mathBig.Int

Big marshals/unmarshals as a JSON string with 0x prefix. The zero value marshals as "0x0".

Negative integers are not supported at this time. Attempting to marshal them will return an error. Values larger than 256bits are rejected by Unmarshal but will be marshaled without error.

func (Big) MarshalBSONValue 

func (m Big) MarshalBSONValue() (bsontype.Type, []byte, error)

func (Big) MarshalText 

func (b Big) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler

func (*Big) SetMathBig 

func (m *Big) SetMathBig(v mathBig.Int)

func (*Big) String 

func (b *Big) String() string

String returns the hex encoding of b.

func (*Big) ToInt 

func (b *Big) ToInt() *mathBig.Int

ToInt converts b to a big.Int.

func (*Big) UnmarshalBSON 

func (b *Big) UnmarshalBSON(data []byte) error

func (*Big) UnmarshalJSON 

func (b *Big) UnmarshalJSON(input []byte) error
func (b Big)MarshalJSON()([]byte,error){
	buf, err:= b.MarshalText()
	//bigJson := `"` + string(buf) + `"`
	return []byte(buf), err
}

UnmarshalJSON implements json.Unmarshaler.

func (*Big) UnmarshalText 

func (b *Big) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler

type BigFlag 

type BigFlag struct {
	Name  string
	Value *big.Int
	Usage string
}

BigFlag is a command line flag that accepts 256 bit big integers in decimal or hexadecimal syntax.

func (BigFlag) Apply 

func (f BigFlag) Apply(set *flag.FlagSet)

func (BigFlag) GetName 

func (f BigFlag) GetName() string

func (BigFlag) String 

func (f BigFlag) String() string

type BlockNumber 

type BlockNumber int64

func (BlockNumber) Int64 

func (bn BlockNumber) Int64() int64

func (*BlockNumber) UnmarshalJSON 

func (bn *BlockNumber) UnmarshalJSON(data []byte) error

UnmarshalJSON parses the given JSON fragment into a BlockNumber. It supports: - "latest", "earliest" or "pending" as string arguments - the block number Returned errors: - an invalid block number error when the given argument isn't a known strings - an out of range error when the given block number is either too little or too large

type Bytes 

type Bytes []byte

Bytes marshals/unmarshals as a JSON string with 0x prefix. The empty slice marshals as "0x".

func (Bytes) MarshalText 

func (b Bytes) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler

func (Bytes) String 

func (b Bytes) String() string

String returns the hex encoding of b.

func (*Bytes) UnmarshalJSON 

func (b *Bytes) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*Bytes) UnmarshalText 

func (b *Bytes) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type ConnectionError 

type ConnectionError struct {
	MyError
}

type ConsensusError 

type ConsensusError struct {
	MyError
}

type DataError 

type DataError struct {
	MyError
}

type DefaultError 

type DefaultError struct {
	MyError
}

type DirectoryFlag 

type DirectoryFlag struct {
	Name  string
	Value DirectoryString
	Usage string
}

Custom cli.Flag type which expand the received string to an absolute path. e.g. ~/.ethereum -> /home/username/.ethereum

func (DirectoryFlag) Apply 

func (self DirectoryFlag) Apply(set *flag.FlagSet)

called by cli library, grabs variable from environment (if in env) and adds variable to flag set for parsing.

func (DirectoryFlag) GetName 

func (self DirectoryFlag) GetName() string

func (*DirectoryFlag) Set 

func (self *DirectoryFlag) Set(value string)

func (DirectoryFlag) String 

func (self DirectoryFlag) String() string

type DirectoryString 

type DirectoryString struct {
	Value string
}

Custom type which is registered in the flags library which cli uses for argument parsing. This allows us to expand Value to an absolute path when the argument is parsed

func (*DirectoryString) Set 

func (self *DirectoryString) Set(value string) error

func (*DirectoryString) String 

func (self *DirectoryString) String() string

type DupOpError 

type DupOpError struct {
	MyError
}

type HexOrDecimal64 

type HexOrDecimal64 uint64

HexOrDecimal64 marshals uint64 as hex or decimal.

func (HexOrDecimal64) MarshalText 

func (i HexOrDecimal64) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*HexOrDecimal64) UnmarshalText 

func (i *HexOrDecimal64) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Merkle 

type Merkle struct {
	Root   *MerkleNode
	Leaves MerkleLayer
	Height int
}

func NewMerkle 

func NewMerkle(hashes [][]byte) *Merkle

func (*Merkle) IsOnTrie 

func (m *Merkle) IsOnTrie(hash []byte) bool

type MerkleLayer 

type MerkleLayer []*MerkleNode

type MerkleNode 

type MerkleNode struct {
	Parent     *MerkleNode
	LeftChild  *MerkleNode
	RightChild *MerkleNode
	Neighbour  *MerkleNode
	Hash       []byte
	Subscript  int
}

type MyError 

type MyError struct {
	Err error
}

func (*MyError) Error 

func (e *MyError) Error() string

type NoSetValueFlag 

type NoSetValueFlag struct {
	Name  string
	Usage string
	Value string
}

func (NoSetValueFlag) Apply 

func (self NoSetValueFlag) Apply(set *flag.FlagSet)

func (NoSetValueFlag) GetName 

func (self NoSetValueFlag) GetName() string

func (NoSetValueFlag) String 

func (self NoSetValueFlag) String() string

type OfflineError 

type OfflineError struct {
	MyError
}

type PrettyDuration 

type PrettyDuration time.Duration

type StorageSize 

type StorageSize float64

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

func (StorageSize) String 

func (s StorageSize) String() string

String implements the stringer interface.

func (StorageSize) TerminalString 

func (s StorageSize) TerminalString() string

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

type TextMarshaler 

type TextMarshaler interface {
	encoding.TextMarshaler
	encoding.TextUnmarshaler
}

func GlobalTextMarshaler 

func GlobalTextMarshaler(ctx *cli.Context, name string) TextMarshaler

GlobalTextMarshaler returns the value of a TextMarshalerFlag from the global flag set.

type TextMarshalerFlag 

type TextMarshalerFlag struct {
	Name  string
	Value TextMarshaler
	Usage string
}

TextMarshalerFlag wraps a TextMarshaler value.

func (TextMarshalerFlag) Apply 

func (f TextMarshalerFlag) Apply(set *flag.FlagSet)

func (TextMarshalerFlag) GetName 

func (f TextMarshalerFlag) GetName() string

func (TextMarshalerFlag) String 

func (f TextMarshalerFlag) String() string

type TimeoutError 

type TimeoutError struct {
	MyError
}

type TransmissionError 

type TransmissionError struct {
	MyError
}

type Uint 

type Uint uint

Uint marshals/unmarshals as a JSON string with 0x prefix. The zero value marshals as "0x0".

func (Uint) MarshalText 

func (b Uint) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (Uint) String 

func (b Uint) String() string

String returns the hex encoding of b.

func (*Uint) UnmarshalJSON 

func (b *Uint) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*Uint) UnmarshalText 

func (b *Uint) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Uint64 

type Uint64 uint64

Uint64 marshals/unmarshals as a JSON string with 0x prefix. The zero value marshals as "0x0".

func (Uint64) MarshalText 

func (b Uint64) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (Uint64) String 

func (b Uint64) String() string

String returns the hex encoding of b.

func (*Uint64) UnmarshalJSON 

func (b *Uint64) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*Uint64) UnmarshalText 

func (b *Uint64) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler

Source Files

View all Source files

Directories

Path Synopsis
Package bitutil implements fast bitwise operations.
 Package bitutil implements fast bitwise operations.
Package bloombits implements bloom filtering on batches of data.
 Package bloombits implements bloom filtering on batches of data.
Package event deals with subscriptions to real-time events.
 Package event deals with subscriptions to real-time events.
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.
Package mclock is a wrapper for a monotonic clock source
 Package mclock is a wrapper for a monotonic clock source
Package trie implements Merkle Patricia Tries.
 Package trie implements Merkle Patricia Tries.

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.