common

package
v0.0.0-...-92d349b Latest Latest
Warning

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

 Go to latest Published: Dec 15, 2023 License: GPL-3.0 Imports: 23 Imported by: 0

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const (
	// BlockNumberLength length of uint64 big endian
	BlockNumberLength = 8
	// IncarnationLength length of uint64 for contract incarnations
	IncarnationLength = 8
)

Lengths of hashes and addresses in bytes.

View Source 
const StorageKeyLen = 2*length.Hash + IncarnationLength

Variables

This section is empty.

Functions

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 FromHex 

func FromHex(s string) []byte

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

func HashData 

func HashData(data []byte) (libcommon.Hash, error)

func Hex2Bytes 

func Hex2Bytes(str string) []byte

Hex2Bytes returns the bytes represented by the hexadecimal string str.

func KeyCmp 

func KeyCmp(key1, key2 []byte) (int, bool)

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 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 PrintDepricationWarning 

func PrintDepricationWarning(str string)

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

func RandomizeDuration 

func RandomizeDuration(in time.Duration) time.Duration

RandomizeDuration - periodic parallel actions may interfere and resonance. Use this func to add small randomness to period

func RemoveDuplicatesFromSorted 

func RemoveDuplicatesFromSorted[T constraints.Ordered](slice []T) []T

func Report 

func Report(extra ...interface{})

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

func ReturnHasherToPool 

func ReturnHasherToPool(h *Hasher)

func RightPadBytes 

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

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

func SortedKeys 

func SortedKeys[K constraints.Ordered, V any](m map[K]V) []K

func TrimLeftZeroes 

func TrimLeftZeroes(s []byte) []byte

TrimLeftZeroes returns a subslice of s without leading zeroes

func TrimRightZeroes 

func TrimRightZeroes(s []byte) []byte

TrimRightZeroes returns a subslice of s without trailing zeroes

Types

type Addresses 

type Addresses []libcommon.Address

Addresses is a slice of libcommon.Address, implementing sort.Interface

func (Addresses) Len 

func (addrs Addresses) Len() int

func (Addresses) Less 

func (addrs Addresses) Less(i, j int) bool

func (Addresses) Swap 

func (addrs Addresses) Swap(i, j int)

type Hasher 

type Hasher struct {
	Sha keccakState
}

func NewHasher 

func NewHasher() *Hasher

type Hashes 

type Hashes []libcommon.Hash

Hashes is a slice of libcommon.Hash, implementing sort.Interface

func (Hashes) Len 

func (hashes Hashes) Len() int

func (Hashes) Less 

func (hashes Hashes) Less(i, j int) bool

func (Hashes) Swap 

func (hashes Hashes) Swap(i, j int)

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 libcommon.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() libcommon.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 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 StorageBucketWriteStats 

type StorageBucketWriteStats struct {
	KeyN             StorageCounter // total number of keys
	KeyBytesN        StorageSize    // total number of bytes owned by keys
	ValueBytesN      StorageSize    // total number of bytes owned by values
	TotalPut         StorageCounter
	TotalDelete      StorageCounter
	TotalBytesPut    StorageSize
	TotalBytesDelete StorageSize
}

type StorageCounter 

type StorageCounter float64

Counter

func (StorageCounter) MarshalJSON 

func (s StorageCounter) MarshalJSON() ([]byte, error)

func (StorageCounter) String 

func (s StorageCounter) String() string

String implements the stringer interface.

type StorageKey 

type StorageKey [StorageKeyLen]byte

StorageKey is representation of address of a contract storage item It consists of two parts, each of which are 32-byte hashes: 1. Hash of the contract's address 2. Hash of the item's key

type StorageKeys 

type StorageKeys []StorageKey

StorageKeys is a slice of StorageKey, implementing sort.Interface

func (StorageKeys) Len 

func (keys StorageKeys) Len() int

func (StorageKeys) Less 

func (keys StorageKeys) Less(i, j int) bool

func (StorageKeys) Swap 

func (keys StorageKeys) Swap(i, j int)

type StorageSize 

type StorageSize float64

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

func (StorageSize) MarshalJSON 

func (s StorageSize) MarshalJSON() ([]byte, error)

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 Tuples 

type Tuples struct {
	Values [][]byte
	SortBy int
	Length int
	// contains filtered or unexported fields
}

Tuples, eg [(index, bucket, key, value)]

func NewTuples 

func NewTuples(size, arity, sortBy int) *Tuples

func (*Tuples) Append 

func (t *Tuples) Append(values ...[]byte) error

func (Tuples) Len 

func (t Tuples) Len() int

func (Tuples) Less 

func (t Tuples) Less(i, j int) bool

func (Tuples) Swap 

func (t Tuples) Swap(i, j int)

type UnprefixedAddress 

type UnprefixedAddress libcommon.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 libcommon.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 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 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 prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.
 Package prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.

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.