common

package
Version: v1.8.4 Latest Latest
Warning

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

Go to latest
Published: May 20, 2022 License: GPL-3.0 Imports: 23 Imported by: 275

Documentation

Overview

Package common contains various helper functions, commonly used data types and constants.

Source Files

Each source file provides functions and types as listed below

  • big.go : Defines common big integers often used such as Big1
  • bytes.go : Provides conversion functions between a byte slice and other types such as string in Hex format and int
  • cache.go : Defines Cache interface and constants such as CacheType
  • debug.go : Provides a function to let an user know where to report a bug. It is being used by datasync/downloader
  • format.go : Provides a function to print a time.Duration in more readable format
  • path.go : Provides functions to check a file's existence and to get an absolute path
  • size.go : Provides StorageSize type and its stringer functions
  • types.go : Provides commonly used Hash and Address types and its methods
  • utils.go : Provides LoadJSON function to read a JSON file
  • variables.go : Provides configuration values

Index

Constants

View Source
const (
	HashLength      = 32
	AddressLength   = 20
	SignatureLength = 65
)

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 CacheScale int = 100 // Cache size = preset size * CacheScale / 100. Only used when IsScaled == true
View Source
var MaxRequestContentLength = 1024 * 512
View Source
var ScaleByCacheUsageLevel int = 100 // Scale according to cache usage level (%). Only used when IsScaled == true
View Source
var TotalPhysicalMemGB int = getPhysicalMemorySize() // Convert Byte to GByte

Functions

func AbsolutePath

func AbsolutePath(datadir string, filename string) string

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

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 EmptyAddress added in v1.6.0

func EmptyAddress(a Address) bool

func EmptyHash

func EmptyHash(h Hash) bool

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 GetScaleByCacheUsageLevel

func GetScaleByCacheUsageLevel(cacheUsageLevelFlag string) (int, error)

GetScaleByCacheUsageLevel returns the scale according to cacheUsageLevel

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 Int64ToByteBigEndian added in v1.5.0

func Int64ToByteBigEndian(number uint64) []byte

Int64ToByteBigEndian encodes a number as big endian uint64

func Int64ToByteLittleEndian added in v1.5.0

func Int64ToByteLittleEndian(num uint64) []byte

IntToByteLittleEndian encodes a number as little endian uint64

func IsHexAddress

func IsHexAddress(s string) bool

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

func IsPrecompiledContractAddress

func IsPrecompiledContractAddress(addr Address) bool

IsPrecompiledContractAddress returns true if the input address is in the range of precompiled contract addresses.

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 Klaytn convention for such names. It adds the operation system name and Go runtime version the name.

func MakeRandomBytes added in v1.5.0

func MakeRandomBytes(n int) []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 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 TrimLeftZeroes added in v1.8.0

func TrimLeftZeroes(s []byte) []byte

TrimLeftZeroes returns a subslice of s without leading zeroes

func TrimRightZeroes added in v1.8.0

func TrimRightZeroes(s []byte) []byte

TrimRightZeroes returns a subslice of s without trailing zeroes

Types

type ARCConfig

type ARCConfig struct {
	CacheSize int
	IsScaled  bool
}

type Address

type Address [AddressLength]byte

Address represents the 20 byte address of a Klaytn 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 StringToAddress

func StringToAddress(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.

func (Address) MarshalText

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

MarshalText returns the hex representation of a.

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

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

SetBytesFromFront sets the address to the value of b. If len(b) is larger, take AddressLength bytes from front.

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.

type Cache

type Cache interface {
	Add(key CacheKey, value interface{}) (evicted bool)
	Get(key CacheKey) (value interface{}, ok bool)
	Contains(key CacheKey) bool
	Purge()
}

func NewCache

func NewCache(config CacheConfiger) Cache

type CacheConfiger

type CacheConfiger interface {
	// contains filtered or unexported methods
}

type CacheKey

type CacheKey interface {
	// contains filtered or unexported methods
}

type CacheKeyUint64

type CacheKeyUint64 uint64

type CacheType

type CacheType int
const (
	LRUCacheType CacheType = iota
	LRUShardCacheType
	FIFOCacheType
	ARCChacheType
)
var DefaultCacheType CacheType = FIFOCacheType

it's set by flag.

type ConnType added in v1.3.0

type ConnType int
const (
	CONSENSUSNODE ConnType = iota
	ENDPOINTNODE
	PROXYNODE
	BOOTNODE
	UNKNOWNNODE // For error case
)
const ConnTypeUndefined ConnType = -1

func (ConnType) String added in v1.3.0

func (ct ConnType) String() string

func (ConnType) Valid added in v1.3.0

func (ct ConnType) Valid() bool

type Entry added in v1.7.0

type Entry struct {
	Key, Val []byte
}

func CreateEntries added in v1.7.0

func CreateEntries(entryNum int) []Entry

CreateEntries creates random key/value pairs.

type FIFOCacheConfig

type FIFOCacheConfig struct {
	CacheSize int
	IsScaled  bool
}

FIFOCacheConfig is a implementation of CacheConfiger interface for fifoCache.

type GovernanceCacheKey

type GovernanceCacheKey string

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 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 (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) MarshalText

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

MarshalText returns the hex representation of h.

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.

type LRUConfig

type LRUConfig struct {
	CacheSize int
	IsScaled  bool
}

type LRUShardConfig

type LRUShardConfig struct {
	CacheSize int
	// Hash, and Address type can not generate as many shard indexes as the maximum (2 ^ 16 = 65536),
	// so it is meaningless to set the NumShards larger than this.
	NumShards int
	IsScaled  bool
}

type PrettyAge added in v1.6.0

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 added in v1.6.0

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

Directories

Path Synopsis
Package bitutil implements fast bitwise operations and compression/decompressions.
Package bitutil implements fast bitwise operations and compression/decompressions.
Package compiler wraps the Solidity compiler executable (solc).
Package compiler wraps the Solidity compiler executable (solc).
Package fdlimit handles file descriptors based on the operating system.
Package fdlimit handles file descriptors based on the operating system.
Package hexutil implements hex encoding with 0x prefix.
Package hexutil implements hex encoding with 0x prefix.
Package math provides convenience functions to use big.Int and to parse a string into an integer.
Package math provides convenience functions to use big.Int and to parse a string into an integer.
Package mclock is a wrapper for a monotonic clock source.
Package mclock is a wrapper for a monotonic clock source.
Package profile provides a profiler which can store a key and related TimeRecord.
Package profile provides a profiler which can store a key and related TimeRecord.

Jump to

Keyboard shortcuts

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