common

Documentation

Index

• Constants
• Variables
• func Base64ToBytes(str string) ([]byte, error)
• func Bytes2Hex(d []byte) string
• func BytesToBase64(bytes []byte) string
• func BytesToUint32(i []byte) uint32
• func BytesToUint64(i []byte) uint64
• func CopyBytes(b []byte) (copiedBytes []byte)
• func FromHex(s string) []byte
• func Hex2Bytes(str string) []byte
• func LeftPadBytes(slice []byte, l int) []byte
• func Min(a, b int) int
• func Min32(a, b uint32) uint32
• func Min64(a, b uint64) uint64
• func RightPadBytes(slice []byte, l int) []byte
• func Uint32ToBytes(i uint32) []byte
• func Uint64ToBytes(i uint64) []byte
• type Hash
  • func BigToHash(b *big.Int) Hash
  • func BytesToHash(b []byte) Hash
  • func HexToHash(s string) Hash
  • func (h Hash) Big() *big.Int
  • func (h Hash) Bytes() []byte
  • func (h Hash) Format(s fmt.State, c rune)
  • func (h Hash) Generate(rand *rand.Rand, size int) reflect.Value
  • func (h Hash) Hex() string
  • func (h Hash) MarshalText() ([]byte, error)
  • func (h *Hash) Scan(src interface{}) error
  • func (h *Hash) SetBytes(b []byte)
  • func (h Hash) ShortString() string
  • func (h Hash) String() string
  • func (h Hash) TerminalString() string
  • func (h *Hash) UnmarshalJSON(input []byte) error
  • func (h *Hash) UnmarshalText(input []byte) error
• type StorageSize
  • func (s StorageSize) String() string
  • func (s StorageSize) TerminalString() string

Constants

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

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 Base64ToBytes

func Base64ToBytes(str string) ([]byte, error)

Decode base64 string into a byte array

func Bytes2Hex

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func BytesToBase64

func BytesToBase64(bytes []byte) string

Encode byte array into base64 string

func BytesToUint32

func BytesToUint32(i []byte) uint32

func BytesToUint64

func BytesToUint64(i []byte) uint64

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 Hex2Bytes

func Hex2Bytes(str string) []byte

Hex2Bytes returns the bytes represented by the hexadecimal string str.

func LeftPadBytes

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

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

func Min

func Min(a, b int) int

func Min32

func Min32(a, b uint32) uint32

func Min64

func Min64(a, b uint64) uint64

func RightPadBytes

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

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

func Uint32ToBytes

func Uint32ToBytes(i uint32) []byte

func Uint64ToBytes

func Uint64ToBytes(i uint64) []byte

Types

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

func (h Hash) ShortString() string

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