common

package
v0.0.12 Latest Latest
Warning

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

 Go to latest Published: May 13, 2019 License: GPL-3.0 Imports: 21 Imported by: 36

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const AddressLength = 20

AddressLength of addresses in bytes

View Source 
const HashLength = 32

HashLength of hashes in bytes.

View Source 
const PubKeyLength = 65

PubKeyLength of PubKey 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)
	Big256 = big.NewInt(256)
	Big257 = big.NewInt(257)
)

Common big integers often used

View Source 
var ErrGasLimitReached = errors.New("gas limit reached")

ErrGasLimitReached is returned by the gas pool if the amount of gas required by a transaction is higher than what's left in the block.

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 FileExist 

func FileExist(filePath string) bool

FileExist checks if a file exists at filePath.

func FindStringSubmatch added in v0.0.9 

func FindStringSubmatch(reg *regexp.Regexp, name string) (ret []string)

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 

address or not.

func IsHexPubKey 

func IsHexPubKey(s string) bool

IsHexPubKey verifies whether a string can represent a valid hex-encoded 

PubKey or not.

func LeftPadBytes 

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

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

func MakeName 

func MakeName(name, version string) string

MakeName creates a node name that follows the Fractal convention for such names. It adds the operation system name and Go runtime version the name.

func ReadVarInt 

func ReadVarInt(r io.Reader) (uint64, error)

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.

Types

type AbsTime 

type AbsTime time.Duration

AbsTime represents absolute monotonic time.

func Now 

func Now() AbsTime

Now returns the current absolute monotonic time.

type AccountAuthor added in v0.0.7 

type AccountAuthor struct {
	Account Name
}

type Address 

type Address [AddressLength]byte

Address represents the 20 byte address of an 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 (Address) Big 

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

Big converts an address to a big integer.

func (Address) Bytes 

func (a Address) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (Address) Compare added in v0.0.7 

func (a Address) Compare(x Address) int

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) 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 Author added in v0.0.7 

type Author struct {
	Owner  `json:"owner"`
	Weight uint64 `json:"weight"`
}

func NewAuthor added in v0.0.7 

func NewAuthor(owner Owner, weight uint64) *Author

func (*Author) DecodeRLP added in v0.0.7 

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

func (*Author) EncodeRLP added in v0.0.7 

func (a *Author) EncodeRLP(w io.Writer) error

func (*Author) GetWeight added in v0.0.7 

func (a *Author) GetWeight() uint64

func (*Author) MarshalJSON added in v0.0.9 

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

func (*Author) UnmarshalJSON added in v0.0.9 

func (a *Author) UnmarshalJSON(data []byte) error

type AuthorJSON added in v0.0.9 

type AuthorJSON struct {
	OwnerStr string `json:"owner"`
	Weight   uint64 `json:"weight"`
	// contains filtered or unexported fields
}

type AuthorType added in v0.0.7 

type AuthorType uint8
const (
	AccountNameType AuthorType = iota
	PubKeyType
	AddressType
)

type GasPool 

type GasPool uint64

GasPool tracks the amount of gas available during execution of the transactions in a block. The zero value is a pool with zero gas available.

func (*GasPool) AddGas 

func (gp *GasPool) AddGas(amount uint64) *GasPool

AddGas makes gas available for execution.

func (*GasPool) Gas 

func (gp *GasPool) Gas() uint64

Gas returns the amount of gas remaining in the pool.

func (*GasPool) String 

func (gp *GasPool) String() string

func (*GasPool) SubGas 

func (gp *GasPool) SubGas(amount uint64) error

SubGas deducts the given amount from the pool if enough gas is available and returns an error otherwise.

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 MerkleRoot 

func MerkleRoot(nodes []Hash) Hash

MerkleRoot return merkle tree root 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) 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 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 Name 

type Name string

Name represents the account name

func BigToName 

func BigToName(b *big.Int) Name

BigToName returns Name with byte values of b.

func BytesToName 

func BytesToName(b []byte) Name

BytesToName returns Name with value b.

func StrToName 

func StrToName(s string) Name

StrToName returns Name with string of s.

func (Name) Big 

func (n Name) Big() *big.Int

Big converts a name to a big integer.

func (Name) Bytes added in v0.0.9 

func (n Name) Bytes() []byte

Bytes converts a name to bytes.

func (Name) IsChildren added in v0.0.9 

func (n Name) IsChildren(name Name, reg *regexp.Regexp) bool

IsChildren name children

func (Name) IsValid added in v0.0.9 

func (n Name) IsValid(reg *regexp.Regexp) bool

IsValid verifies whether a string can represent a valid name or not.

func (*Name) SetString 

func (n *Name) SetString(s string)

SetString sets the name to the value of b..

func (Name) String 

func (n Name) String() string

String converts a name to string.

func (*Name) UnmarshalJSON 

func (n *Name) UnmarshalJSON(data []byte) error

UnmarshalJSON parses a hash in hex syntax.

func (*Name) UnmarshalText 

func (n *Name) UnmarshalText(input []byte) error

UnmarshalText parses a hash in hex syntax.

type Owner added in v0.0.7 

type Owner interface {
	String() string
}

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 PubKey 

type PubKey [PubKeyLength]byte

PubKey represents the 64 byte public key

func BytesToPubKey 

func BytesToPubKey(b []byte) PubKey

BytesToPubKey returns PubKey with value b.

func HexToPubKey 

func HexToPubKey(s string) PubKey

HexToPubKey returns PubKey with byte values of s.

func (PubKey) Big 

func (p PubKey) Big() *big.Int

Big converts a hash to a big integer.

func (PubKey) Bytes 

func (p PubKey) Bytes() []byte

Bytes return bytes

func (PubKey) Compare 

func (p PubKey) Compare(x PubKey) int

Compare returns an integer comparing two byte slices lexicographically. The result will be 0 if a==b, -1 if a < b, and +1 if a > b. A nil argument is equivalent to an empty slice.

func (PubKey) Hex 

func (p PubKey) Hex() string

Hex converts a hash to a hex string.

func (PubKey) MarshalText 

func (p PubKey) MarshalText() ([]byte, error)

MarshalText returns the hex representation of a.

func (*PubKey) SetBytes 

func (p *PubKey) SetBytes(key []byte)

SetBytes set bytes to pubkey

func (PubKey) String 

func (p PubKey) String() string

String implements fmt.Stringer.

func (*PubKey) UnmarshalJSON 

func (p *PubKey) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a hash in hex syntax.

func (*PubKey) UnmarshalText 

func (p *PubKey) UnmarshalText(input []byte) error

UnmarshalText parses a hash in hex syntax.

type StorageAuthor added in v0.0.7 

type StorageAuthor struct {
	Type    AuthorType
	DataRaw rlp.RawValue
	Weight  uint64
}

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.

Source Files

View all Source files

Directories

Path Synopsis

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.