common

package
v2.2.14+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 17, 2018 License: GPL-3.0 Imports: 18 Imported by: 472

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const (
	HashLength    = 32
	AddressLength = 20
)

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(0xff)
	Big257 = big.NewInt(257)
)

Common big integers often used

View Source 
var ErrNotFound = errors.New("not found")

Functions

func AbsolutePath 

func AbsolutePath(Datadir string, filename string) string

func Bytes2Hex 

func Bytes2Hex(d []byte) string

func CopyBytes 

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

Copy bytes

Returns an exact copy of the provided bytes

func EmptyHash added in v0.9.32 

func EmptyHash(h Hash) bool

func FileExist 

func FileExist(filePath string) bool

func FromHex 

func FromHex(s string) []byte

func Hex2Bytes 

func Hex2Bytes(str string) []byte

func Hex2BytesFixed 

func Hex2BytesFixed(str string, flen int) []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

func LoadJSON added in v0.9.34 

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

func ToHex 

func ToHex(b []byte) string

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

func BytesToAddress 

func BytesToAddress(b []byte) Address

func HexToAddress 

func HexToAddress(s string) Address

func StringToAddress 

func StringToAddress(s string) Address

func (Address) Big 

func (a Address) Big() *big.Int

func (Address) Bytes 

func (a Address) Bytes() []byte

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

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

func (a *Address) Set(other Address)

Sets a to other

func (*Address) SetBytes 

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

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

func (*Address) SetString 

func (a *Address) SetString(s string)

Set string `s` to a. If s is larger than len(a) it will panic

func (Address) Str 

func (a Address) Str() string

Get the string representation of the underlying address

func (Address) String 

func (a Address) String() string

String implements the stringer interface and is used also by the logger.

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 Batch 

type Batch interface {
	Putter
	Deleter
	ValueSize() int // amount of data in the batch
	Write() error
	// Reset resets the batch for reuse
	Reset()
}

Batch is a write-only database that commits changes to its host database when Write is called. Batch cannot be used concurrently.

type Database 

type Database interface {
	io.Closer
	GlobalTable() Table
	BodyTable() Table
	HeaderTable() Table
	ReceiptTable() Table
}

Database wraps all database operations. All methods are safe for concurrent use.

type Deleter 

type Deleter interface {
	Delete(key []byte) error
}

Deleter wraps the database delete operation supported by both batches and regular databases.

type Hash 

type Hash [HashLength]byte

Hash represents the 32 byte Keccak256 hash of arbitrary data.

func BigToHash 

func BigToHash(b *big.Int) Hash

func BytesToHash 

func BytesToHash(b []byte) Hash

func HexToHash 

func HexToHash(s string) Hash

func StringToHash 

func StringToHash(s string) Hash

func (Hash) Big 

func (h Hash) Big() *big.Int

func (Hash) Bytes 

func (h Hash) Bytes() []byte

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

func (Hash) MarshalText 

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

MarshalText returns the hex representation of h.

func (*Hash) Set 

func (h *Hash) Set(other Hash)

Sets h to other

func (*Hash) SetBytes 

func (h *Hash) SetBytes(b []byte)

Sets the hash to the value of b. If b is larger than len(h), 'b' will be cropped (from the left).

func (*Hash) SetString 

func (h *Hash) SetString(s string)

Set string `s` to h. If s is larger than len(h) s will be cropped (from left) to fit.

func (Hash) Str 

func (h Hash) Str() string

Get the string representation of the underlying hash

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

type Putter interface {
	Put(key []byte, value []byte) error
}

Putter wraps the write operation supported by both batches and regular tables.

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 Table 

type Table interface {
	Putter
	Get(key []byte) ([]byte, error)
	Has(key []byte) (bool, error)
	Delete(key []byte) error
	NewBatch() Batch
}

Table wraps all mutation & accessor operations. All methods are safe for concurrent use.

type TablePrefixer 

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

TablePrefixer represents an wrapper for Database that prefixes all operations with a key prefix.

func NewTablePrefixer 

func NewTablePrefixer(t Table, prefix string) *TablePrefixer

NewTablePrefixer returns a new instance of TablePrefixer.

func (*TablePrefixer) Close 

func (p *TablePrefixer) Close() error

func (*TablePrefixer) Delete 

func (p *TablePrefixer) Delete(key []byte) error

func (*TablePrefixer) Get 

func (p *TablePrefixer) Get(key []byte) ([]byte, error)

func (*TablePrefixer) Has 

func (p *TablePrefixer) Has(key []byte) (bool, error)

func (*TablePrefixer) NewBatch 

func (p *TablePrefixer) NewBatch() Batch

func (*TablePrefixer) Put 

func (p *TablePrefixer) Put(key []byte, value []byte) error

type TablePrefixerBatch 

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

func (*TablePrefixerBatch) Delete 

func (b *TablePrefixerBatch) Delete(key []byte) error

func (*TablePrefixerBatch) Put 

func (b *TablePrefixerBatch) Put(key, value []byte) error

func (*TablePrefixerBatch) Reset 

func (b *TablePrefixerBatch) Reset()

func (*TablePrefixerBatch) ValueSize 

func (b *TablePrefixerBatch) ValueSize() int

func (*TablePrefixerBatch) Write 

func (b *TablePrefixerBatch) Write() error

type UnprefixedAddress 

type UnprefixedAddress Address

UnprefixedHash 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 compiler wraps the Solidity compiler executable (solc).
 Package compiler wraps the Solidity compiler executable (solc).
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

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.