common

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2023 License: GPL-3.0 Imports: 24 Imported by: 20

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const (
	// HashLength is the expected length of the hash
	HashLength = 32
	// AddressLength is the expected length of the address
	AddressLength = 20

	// Constants to mnemonically index into context arrays
	PRIME_CTX  = 0
	REGION_CTX = 1
	ZONE_CTX   = 2

	// Depth of the hierarchy of chains
	NumRegionsInPrime = 3
	NumZonesInRegion  = 3
	HierarchyDepth    = 3
	NumChains         = 1 + NumRegionsInPrime*(1+NumZonesInRegion) // Prime + R regions + RxZ zones
)

Lengths of hashes and addresses in bytes.

Variables

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

Common big integers often used

View Source 
var (

	// The zero address (0x0)
	ZeroInternal    = InternalAddress{}
	ZeroAddr        = Address{&ZeroInternal}
	ErrInvalidScope = errors.New("address is not in scope")
)
View Source 
var (
	// Default to prime node, but changed at startup by config.
	NodeLocation = Location{}
)

Functions

func AbsolutePath 

func AbsolutePath(datadir string, filename string) string

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

func BigBitsArrayToBitsArray 

func BigBitsArrayToBitsArray(original []*big.Int) []*big.Int

func BigBitsToBits 

func BigBitsToBits(original *big.Int) *big.Int

func BitsToBigBits 

func BitsToBigBits(original *big.Int) *big.Int

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

func IsHexAddress(s string) bool

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

func IsInChainScope 

func IsInChainScope(b []byte) 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 quai convention for such names. It adds the operation system name and Go runtime version the name.

func NewRange 

func NewRange(l, h uint8) addrPrefixRange

func OrderToString 

func OrderToString(order int) string

func PrintDeprecationWarning 

func PrintDeprecationWarning(str string)

PrintDeprecationWarning prints 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 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 Address 

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

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 Bytes20ToAddress 

func Bytes20ToAddress(b [20]byte) Address

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 NewAddressFromData 

func NewAddressFromData(inner AddressData) Address

func (Address) Bytes 

func (a Address) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (Address) Bytes20 

func (a Address) Bytes20() (addr AddressBytes)

Bytes20 gets the bytes20 representation of the underlying address.

func (*Address) DecodeRLP 

func (a *Address) DecodeRLP(s *rlp.Stream) error

DecodeRLP decodes the Quai

func (Address) EncodeRLP 

func (a Address) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Quai RLP block format.

func (Address) Equal 

func (a Address) Equal(b Address) bool

func (Address) Format 

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

Format implements fmt.Formatter. Address supports the %v, %s, %v, %x, %X and %d format verbs.

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 a hex string representation of the address.

func (Address) InternalAddress 

func (a Address) InternalAddress() (InternalAddress, error)

func (Address) Location 

func (a Address) Location() *Location

Location looks up the chain location which contains this address

func (*Address) MarshalJSON 

func (a *Address) MarshalJSON() ([]byte, error)

MarshalJSON marshals a subscription as its ID.

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

type AddressBytes [20]byte

func (AddressBytes) Hex 

func (a AddressBytes) Hex() string

Hex returns a hex string representation of the address.

func (AddressBytes) String 

func (a AddressBytes) String() string

String implements fmt.Stringer.

type AddressData 

type AddressData interface {
	Bytes() []byte
	Hash() Hash
	Hex() string
	String() string

	Format(s fmt.State, c rune)
	MarshalText() ([]byte, error)
	UnmarshalText(input []byte) error
	UnmarshalJSON(input []byte) error
	Scan(src interface{}) error
	Value() (driver.Value, error)
	Location() *Location
	// contains filtered or unexported methods
}

type ExternalAddress 

type ExternalAddress [AddressLength]byte

func (ExternalAddress) Bytes 

func (a ExternalAddress) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (ExternalAddress) Format 

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

Format implements fmt.Formatter. Address supports the %v, %s, %v, %x, %X and %d format verbs.

func (ExternalAddress) Hash 

func (a ExternalAddress) Hash() Hash

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

func (ExternalAddress) Hex 

func (a ExternalAddress) Hex() string

Hex returns a hex string representation of the address.

func (ExternalAddress) Location 

func (a ExternalAddress) Location() *Location

Location looks up the chain location which contains this address

func (ExternalAddress) MarshalText 

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

MarshalText returns the hex representation of a.

func (*ExternalAddress) Scan 

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

Scan implements Scanner for database/sql.

func (ExternalAddress) String 

func (a ExternalAddress) String() string

String implements fmt.Stringer.

func (*ExternalAddress) UnmarshalJSON 

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

UnmarshalJSON parses a hash in hex syntax.

func (*ExternalAddress) UnmarshalText 

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

UnmarshalText parses a hash in hex syntax.

func (ExternalAddress) Value 

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

Value implements valuer for database/sql.

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. Hash supports the %v, %s, %v, %x, %X and %d format verbs.

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

type InternalAddress [AddressLength]byte

func (InternalAddress) Bytes 

func (a InternalAddress) Bytes() []byte

Bytes gets the bytes representation of the underlying address.

func (InternalAddress) Bytes20 

func (a InternalAddress) Bytes20() (addr AddressBytes)

Bytes20 gets the bytes20 representation of the underlying address.

func (InternalAddress) Format 

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

Format implements fmt.Formatter. Address supports the %v, %s, %v, %x, %X and %d format verbs.

func (InternalAddress) Hash 

func (a InternalAddress) Hash() Hash

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

func (InternalAddress) Hex 

func (a InternalAddress) Hex() string

Hex returns a hex string representation of the address.

func (InternalAddress) Location 

func (a InternalAddress) Location() *Location

func (InternalAddress) MarshalText 

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

MarshalText returns the hex representation of a.

func (*InternalAddress) Scan 

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

Scan implements Scanner for database/sql.

func (InternalAddress) String 

func (a InternalAddress) String() string

String implements fmt.Stringer.

func (*InternalAddress) UnmarshalJSON 

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

UnmarshalJSON parses a hash in hex syntax.

func (*InternalAddress) UnmarshalText 

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

UnmarshalText parses a hash in hex syntax.

func (InternalAddress) Value 

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

Value implements valuer for database/sql.

type Location 

type Location []byte

Location of a chain within the Quai hierarchy Location is encoded as a path from the root of the tree to the specified chain. Not all indices need to be populated, e.g: prime = [] region[0] = [0] zone[1,2] = [1, 2]

func (Location) AssertValid 

func (loc Location) AssertValid()

func (Location) CommonDom 

func (loc Location) CommonDom(cmp Location) Location

CommonDom identifies the highest context chain which exists in both locations * zone-0-0 & zone-0-1 would share region-0 as their highest context common dom * zone-0-0 & zone-1-0 would share Prime as their highest context common dom

func (Location) ContainsAddress 

func (l Location) ContainsAddress(a Address) bool

func (Location) Context 

func (loc Location) Context() int

func (Location) DomIndex 

func (loc Location) DomIndex() int

DomLocation returns the location of your dominant chain

func (Location) Equal 

func (loc Location) Equal(cmp Location) bool

func (Location) HasRegion 

func (loc Location) HasRegion() bool

func (Location) HasZone 

func (loc Location) HasZone() bool

func (Location) InSameSliceAs 

func (loc Location) InSameSliceAs(cmp Location) bool

func (Location) Name 

func (loc Location) Name() string

func (Location) RPCMarshal 

func (l Location) RPCMarshal() []hexutil.Uint64

func (Location) Region 

func (loc Location) Region() int

func (Location) SubInSlice 

func (loc Location) SubInSlice(slice Location) Location

SubInSlice returns the location of the subordinate chain within the specified slice. For example:

  • if prime calls SubInSlice(Location{0,0}) the result will be Location{0}, i.e. region-0's location, because Prime's subordinate in that slice is region-0
  • if region-0 calls SubInSlice(Location{0,0}) the result will be Location{0,0}, i.e. zone-0-0's location, because region-0's subordinate in that slice is zone-0-0

func (Location) SubIndex 

func (loc Location) SubIndex() int

SubIndex returns the index of the subordinate chain for a given location

func (Location) Zone 

func (loc Location) Zone() 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 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 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 UnprefixedAddress 

type UnprefixedAddress InternalAddress

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 bitutil implements fast bitwise operations.
 Package bitutil implements fast bitwise operations.
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.