common

Documentation

Overview

Package common contains various helper functions.

Index

• Variables
• func AllZero(b []byte) bool
• func BigUint64(v *big.Int) (uint64, bool)
• func Bytes2Hex(d []byte) string
• func CalcMemSize(off, l *big.Int) *big.Int
• func CopyBytes(b []byte) (copiedBytes []byte)
• func FromHex(s string) []byte
• func GetData(data []byte, start uint64, size uint64) []byte
• func GetDataBig(data []byte, start *big.Int, size *big.Int) []byte
• func Hex2Bytes(str string) []byte
• func Hex2BytesFixed(str string, flen int) []byte
• func LeftPadBytes(slice []byte, l int) []byte
• func RightPadBytes(slice []byte, l int) []byte
• func ToHex(b []byte) string
• func ToHexArray(b [][]byte) []string
• func ToWordSize(size uint64) uint64
• type StorageSize
  • func (s StorageSize) String() string
  • func (s StorageSize) TerminalString() string

Variables

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

Functions

func AllZero

func AllZero(b []byte) bool

func BigUint64

func BigUint64(v *big.Int) (uint64, bool)

bigUint64 returns the integer casted to a uint64 and returns whether it overflowed in the process.

func Bytes2Hex

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func CalcMemSize

func CalcMemSize(off, l *big.Int) *big.Int

calculates the memory size required for a step

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 GetData

func GetData(data []byte, start uint64, size uint64) []byte

getData returns a slice from the data based on the start and size and pads up to size with zero's. This function is overflow safe.

func GetDataBig

func GetDataBig(data []byte, start *big.Int, size *big.Int) []byte

getDataBig returns a slice from the data based on the start and size and pads up to size with zero's. This function is overflow safe.

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 LeftPadBytes

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

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

func RightPadBytes

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

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

func ToHex

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 ToHexArray

func ToHexArray(b [][]byte) []string

ToHexArray creates a array of hex-string based on []byte

func ToWordSize

func ToWordSize(size uint64) uint64

toWordSize returns the ceiled word size required for memory expansion.

Types

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.