common

package
v1.2.2 Latest Latest
Warning

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

Go to latest
Published: Feb 27, 2024 License: GPL-3.0 Imports: 25 Imported by: 0

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source
const (
	STATIC_VALIDATOR_MODE = "static"
	INNER_VALIDATOR_MODE  = "inner"
	DPOS_VALIDATOR_MODE   = "dpos"
)
View Source
const (
	// HashLength is the expected length of the hash
	HashLength        = 32
	VersionSignLength = 65
	// AddressLength is the expected length of the address
	AddressLength          = 20
	BlockConfirmSignLength = 65
	ExtraSeal              = 65
)

Lengths of hashes and addresses 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)
	Big100 = big.NewInt(100)
	Big256 = big.NewInt(256)
	Big257 = big.NewInt(257)
)

Common big integers often used

View Source
var (
	OkCode           = uint32(0)
	NoErr            = &BizError{Code: OkCode, Msg: "ok"}
	InternalError    = &BizError{Code: 1, Msg: "System error"}
	NotFound         = &BizError{Code: 2, Msg: "Object not found"}
	InvalidParameter = &BizError{Code: 3, Msg: "Invalid parameter"}
)
View Source
var (
	//  the meter for the protocol of eth
	StatusEgressTrafficMeter          = metrics.NewRegisteredMeter("p2p/flow/eth/status/OutboundTraffic", nil)
	NewBlockHashesEgressTrafficMeter  = metrics.NewRegisteredMeter("p2p/flow/eth/newBlockHashes/OutboundTraffic", nil)
	TxTrafficMeter                    = metrics.NewRegisteredMeter("p2p/flow/eth/tx/OutboundTraffic", nil)
	GetBlockHeadersEgressTrafficMeter = metrics.NewRegisteredMeter("p2p/flow/eth/getBlockHeaders/OutboundTraffic", nil)
	BlockHeadersEgressTrafficMeter    = metrics.NewRegisteredMeter("p2p/flow/eth/blockHeaders/OutboundTraffic", nil)
	GetBlockBodiesEgressTrafficMeter  = metrics.NewRegisteredMeter("p2p/flow/eth/getBlockBodies/OutboundTraffic", nil)
	BlockBodiesEgressTrafficMeter     = metrics.NewRegisteredMeter("p2p/flow/eth/blockBodies/OutboundTraffic", nil)
	NewBlockEgressTrafficMeter        = metrics.NewRegisteredMeter("p2p/flow/eth/newBlock/OutboundTraffic", nil)
	PrepareBlockEgressTrafficMeter    = metrics.NewRegisteredMeter("p2p/flow/eth/prepareBlock/OutboundTraffic", nil)
	BlockSignatureEgressTrafficMeter  = metrics.NewRegisteredMeter("p2p/flow/eth/blockSignature/OutboundTraffic", nil)
	PongEgressTrafficMeter            = metrics.NewRegisteredMeter("p2p/flow/eth/pong/OutboundTraffic", nil)
	GetNodeDataEgressTrafficMeter     = metrics.NewRegisteredMeter("p2p/flow/eth/getNodeData/OutboundTraffic", nil)
	NodeDataEgressTrafficMeter        = metrics.NewRegisteredMeter("p2p/flow/eth/nodeData/OutboundTraffic", nil)
	GetReceiptsEgressTrafficMeter     = metrics.NewRegisteredMeter("p2p/flow/eth/getReceipts/OutboundTraffic", nil)
	ReceiptsTrafficMeter              = metrics.NewRegisteredMeter("p2p/flow/eth/receipts/OutboundTraffic", nil)

	// the meter for the protocol of pbft
	PrepareBlockPBFTEgressTrafficMeter   = metrics.NewRegisteredMeter("p2p/flow/pbft/PrepareBlock/OutboundTraffic", nil)
	PrepareVoteEgressTrafficMeter        = metrics.NewRegisteredMeter("p2p/flow/pbft/PrepareVote/OutboundTraffic", nil)
	ViewChangeEgressTrafficMeter         = metrics.NewRegisteredMeter("p2p/flow/pbft/ViewChange/OutboundTraffic", nil)
	GetPrepareBlockEgressTrafficMeter    = metrics.NewRegisteredMeter("p2p/flow/pbft/GetPrepareBlock/OutboundTraffic", nil)
	PrepareBlockHashEgressTrafficMeter   = metrics.NewRegisteredMeter("p2p/flow/pbft/PrepareBlockHash/OutboundTraffic", nil)
	GetPrepareVoteEgressTrafficMeter     = metrics.NewRegisteredMeter("p2p/flow/pbft/GetPrepareVote/OutboundTraffic", nil)
	PrepareVotesEgressTrafficMeter       = metrics.NewRegisteredMeter("p2p/flow/pbft/PrepareVotes/OutboundTraffic", nil)
	GetBlockQuorumCertEgressTrafficMeter = metrics.NewRegisteredMeter("p2p/flow/pbft/GetBlockQuorumCert/OutboundTraffic", nil)
	BlockQuorumCertEgressTrafficMeter    = metrics.NewRegisteredMeter("p2p/flow/pbft/BlockQuorumCert/OutboundTraffic", nil)
	PBFTStatusEgressTrafficMeter         = metrics.NewRegisteredMeter("p2p/flow/pbft/PBFTStatus/OutboundTraffic", nil)
	GetQCBlockListEgressTrafficMeter     = metrics.NewRegisteredMeter("p2p/flow/pbft/GetQCBlockList/OutboundTraffic", nil)
	QCBlockListEgressTrafficMeter        = metrics.NewRegisteredMeter("p2p/flow/pbft/QCBlockList/OutboundTraffic", nil)
)
View Source
var (
	ZeroHash     = HexToHash(Hash{}.String())
	ZeroAddr     = Address{}
	ZeroNodeAddr = NodeAddress{}
)

Functions

func AbsolutePath

func AbsolutePath(datadir string, filename string) string

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

func AnyContains

func AnyContains(array []string, vals []string) bool

func Beautiful

func Beautiful(t time.Time) string

func Bytes2Hex

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func BytesToFloat32

func BytesToFloat32(bytes []byte) float32

func BytesToFloat64

func BytesToFloat64(bytes []byte) float64

func BytesToInt32

func BytesToInt32(b []byte) int32

func BytesToInt64

func BytesToInt64(b []byte) int64

func BytesToUint32

func BytesToUint32(b []byte) uint32

func BytesToUint64

func BytesToUint64(b []byte) uint64

func CopyBytes

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

CopyBytes returns an exact copy of the provided bytes.

func DecodeError

func DecodeError(err error) (uint32, string)

func FileExist

func FileExist(filePath string) bool

FileExist checks if a file exists at filePath.

func Float32ToBytes

func Float32ToBytes(float float32) []byte

func Float64ToBytes

func Float64ToBytes(float float64) []byte

func FromHex

func FromHex(s string) []byte

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

func Hex2Bytes

func Hex2Bytes(str string) []byte

Hex2Bytes returns the bytes represented by the hexadecimal string str.

func Int32ToBytes

func Int32ToBytes(n int32) []byte

func Int64ToBytes

func Int64ToBytes(n int64) []byte

func IsHexAddress

func IsHexAddress(s string) bool

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

func LeftPadBytes

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

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

func LoadJSON

func LoadJSON(file string, val interface{}) error

LoadJSON reads the given file and unmarshals its content.

func LocalIPv4s

func LocalIPv4s() []string

func Millis

func Millis(t time.Time) int64

func MillisToString

func MillisToString(t int64) string

func MillisToTime

func MillisToTime(millis int64) time.Time

func MustRlpEncode

func MustRlpEncode(val interface{}) []byte

func PrintDepricationWarning

func PrintDepricationWarning(str string)

PrintDepricationWarning prinst the given string in a box using fmt.Println.

func Report

func Report(extra ...interface{})

Report gives off a warning requesting the user to submit an issue to the github tracker.

func RightPadBytes

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

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

func StringsContains

func StringsContains(array []string, val string) (index int)

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 Uint16ToBytes

func Uint16ToBytes(val uint16) []byte

func Uint32ToBytes

func Uint32ToBytes(val uint32) []byte

func Uint64ToBytes

func Uint64ToBytes(val uint64) []byte

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 MustStringToAddress

func MustStringToAddress(s string) Address

func StringToAddress

func StringToAddress(s string) (Address, error)

func StringToAddressWithoutCheck

func StringToAddressWithoutCheck(s string) Address

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.it's use for node address

func (Address) HexWithNoPrefix

func (a Address) HexWithNoPrefix() string

func (Address) MarshalText

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

MarshalText returns the hex representation of a.

func (Address) MarshalText2

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

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) 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.

func (Address) Value

func (a Address) Value() (driver.Value, error)

Value implements valuer for database/sql.

type AtomicBool

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

AtomicBool is a wrapper around uint32 for usage as a boolean value with atomic access.

func (*AtomicBool) IsSet

func (ab *AtomicBool) IsSet() bool

IsSet returns wether the current boolean value is true.

func (*AtomicBool) Set

func (ab *AtomicBool) Set(value bool)

Set sets the value of the bool regardless of the previous value.

func (*AtomicBool) TrySet

func (ab *AtomicBool) TrySet(value bool) bool

TrySet sets the value of the bool and returns wether the value changed.

type BizError

type BizError struct {
	Code uint32 `json:"code"`
	Msg  string `json:"message"`
}

business error, Gas will not be returned back to caller

func NewBizError

func NewBizError(code uint32, text string) *BizError

func (*BizError) AppendMsg

func (be *BizError) AppendMsg(msg string)

func (*BizError) Error

func (e *BizError) Error() string

func (*BizError) ErrorCode

func (e *BizError) ErrorCode() int

ErrorCode returns the JSON error code for a revertal.

func (*BizError) ErrorData

func (e *BizError) ErrorData() interface{}

func (*BizError) Wrap

func (be *BizError) Wrap(text string) *BizError

func (*BizError) Wrapf

func (be *BizError) Wrapf(format string, a ...interface{}) *BizError

type BlockConfirmSign

type BlockConfirmSign [BlockConfirmSignLength]byte

func NewBlockConfirmSign

func NewBlockConfirmSign(signSlice []byte) *BlockConfirmSign

func (*BlockConfirmSign) Bytes

func (sig *BlockConfirmSign) Bytes() []byte

func (BlockConfirmSign) MarshalText

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

MarshalText returns the hex representation of a.

func (*BlockConfirmSign) SetBytes

func (sig *BlockConfirmSign) SetBytes(signSlice []byte)

func (*BlockConfirmSign) String

func (sig *BlockConfirmSign) String() string

func (*BlockConfirmSign) UnmarshalJSON

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

UnmarshalJSON parses a hash in hex syntax.

func (*BlockConfirmSign) UnmarshalText

func (a *BlockConfirmSign) 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.

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 GenerateKVHash

func GenerateKVHash(k, v []byte, oldHash Hash) Hash

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 RlpHash

func RlpHash(x interface{}) (h 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(rand *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) HexWithNoPrefix

func (h Hash) HexWithNoPrefix() string

Hex converts a hash to a hex string with no prefix of 0x.

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) 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.

func (Hash) Value

func (h Hash) Value() (driver.Value, error)

Value implements valuer for database/sql.

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 NodeAddress

type NodeAddress Address

func BytesToNodeAddress

func BytesToNodeAddress(b []byte) NodeAddress

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

func HexToNodeAddress

func HexToNodeAddress(s string) NodeAddress

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

func (NodeAddress) Bytes

func (a NodeAddress) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (NodeAddress) Format

func (a NodeAddress) 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 (NodeAddress) Hash

func (a NodeAddress) Hash() Hash

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

func (NodeAddress) Hex

func (a NodeAddress) Hex() string

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

func (NodeAddress) HexWithNoPrefix

func (a NodeAddress) HexWithNoPrefix() string

func (NodeAddress) MarshalText

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

MarshalText returns the hex representation of a.

func (*NodeAddress) Scan

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

Scan implements Scanner for database/sql.

func (*NodeAddress) SetBytes

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

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

func (NodeAddress) String

func (a NodeAddress) String() string

String implements fmt.Stringer.

func (*NodeAddress) UnmarshalJSON

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

UnmarshalJSON parses a hash in hex syntax.

func (*NodeAddress) UnmarshalText

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

UnmarshalText parses a hash in hex syntax.

func (NodeAddress) Value

func (a NodeAddress) Value() (driver.Value, error)

Value implements valuer for database/sql.

type PrettyAge

type PrettyAge time.Time

PrettyAge is a pretty printed version of a time.Duration value that rounds the values up to a single most significant unit, days/weeks/years included.

func (PrettyAge) String

func (t PrettyAge) String() string

String implements the Stringer interface, allowing pretty printing of duration values rounded to the most significant time unit.

type PrettyDuration

type PrettyDuration time.Duration

PrettyDuration is a pretty printed version of a time.Duration value that cuts the unnecessary precision off from the formatted textual representation.

func (PrettyDuration) String

func (d PrettyDuration) String() string

String implements the Stringer interface, allowing pretty printing of duration values rounded to three decimals.

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 Timer

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

func NewTimer

func NewTimer() *Timer

func (*Timer) Begin

func (t *Timer) Begin()

func (*Timer) End

func (t *Timer) End() float64

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.

type VersionSign

type VersionSign [VersionSignLength]byte

func BytesToVersionSign

func BytesToVersionSign(b []byte) VersionSign

func HexSign

func HexSign(in string) (VersionSign, error)

HexID converts a hex string to a NodeID. The string may be prefixed with 0x.

func (VersionSign) Bytes

func (s VersionSign) Bytes() []byte

func (VersionSign) Format

func (s VersionSign) Format(st fmt.State, c rune)

func (VersionSign) Hex

func (s VersionSign) Hex() string

func (VersionSign) HexWithNoPrefix

func (s VersionSign) HexWithNoPrefix() string

func (VersionSign) MarshalText

func (s VersionSign) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*VersionSign) SetBytes

func (s *VersionSign) SetBytes(b []byte)

func (VersionSign) String

func (s VersionSign) String() string

func (VersionSign) TerminalString

func (s VersionSign) TerminalString() string

func (*VersionSign) UnmarshalText

func (s *VersionSign) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

Directories

Path Synopsis
Package bitutil implements fast bitwise operations.
Package bitutil implements fast bitwise operations.
Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
Package hexutil implements hex encoding with 0x prefix.
Package hexutil implements hex encoding with 0x prefix.
Package json implements encoding and decoding of JSON as defined in RFC 7159.
Package json implements encoding and decoding of JSON as defined in RFC 7159.
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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL