common

Documentation

Overview

Package common contains various helper functions.

Index

• Constants
• func Bytes2Hex(d []byte) string
• func CopyBytes(b []byte) (copiedBytes []byte)
• func FromHex(s string) []byte
• func Hex2Bytes(str string) []byte
• func LeftPadBytes(slice []byte, l int) []byte
• func RightPadBytes(slice []byte, l int) []byte
• func ToHex(b []byte) string
• type Address
  • func BytesToAddress(b []byte) (ret Address)
  • func HexToAddress(s string) (ret Address)
  • func (a Address) Big() *big.Int
  • func (a Address) Bytes() []byte
  • func (a Address) Format(s fmt.State, c rune)
  • func (a Address) Hash() Hash
  • func (a Address) Hex() string
  • func (a Address) ImplementsGraphQLType(name string) bool
  • func (a Address) MarshalText() ([]byte, error)
  • func (a *Address) Scan(src interface{}) error
  • func (self *Address) SetBytes(b []byte) *Address
  • func (a Address) String() string
  • func (a *Address) UnmarshalGraphQL(input interface{}) error
  • func (a *Address) UnmarshalJSON(input []byte) error
  • func (a *Address) UnmarshalText(input []byte) error
  • func (a Address) Value() (driver.Value, error)
• type Hash
  • func BytesToHash(b []byte) (ret Hash)
  • func HexToHash(s string) Hash
  • func (h Hash) Big() *big.Int
  • func (h Hash) Bytes() []byte
  • func (h *Hash) DecodeRLP(stream *rlp.Stream) error
  • 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 (_ Hash) ImplementsGraphQLType(name string) bool
  • func (h Hash) MarshalText() ([]byte, error)
  • func (h *Hash) Scan(src interface{}) error
  • func (h *Hash) SetBytes(b []byte) *Hash
  • func (h Hash) String() string
  • func (h Hash) TerminalString() string
  • func (h *Hash) UnmarshalGraphQL(input interface{}) error
  • func (h *Hash) UnmarshalJSON(input []byte) error
  • func (h *Hash) UnmarshalText(input []byte) error
  • func (h Hash) Value() (driver.Value, error)
• type UnprefixedHash
  • func (h UnprefixedHash) MarshalText() ([]byte, error)
  • func (h *UnprefixedHash) UnmarshalText(input []byte) error

Constants

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

Lengths of hashes and addresses in bytes.

Functions

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

Types

type Address

type Address [AddressLength]byte

Address represents the 20 byte address of an Ethereum account.

var ZeroAddress Address

func BytesToAddress

func BytesToAddress(b []byte) (ret 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) (ret 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) 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) ImplementsGraphQLType

func (a Address) ImplementsGraphQLType(name string) bool

ImplementsGraphQLType returns true if Hash implements the specified GraphQL type.

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

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

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

func (a *Address) UnmarshalGraphQL(input interface{}) error

UnmarshalGraphQL unmarshals the provided GraphQL query data.

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 Hash

type Hash [HashLength]byte

Hash represents the 32 byte Keccak256 hash of arbitrary data.

var ZeroHash Hash

func BytesToHash

func BytesToHash(b []byte) (ret 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) DecodeRLP

func (h *Hash) DecodeRLP(stream *rlp.Stream) error

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

func (_ Hash) ImplementsGraphQLType(name string) bool

ImplementsGraphQLType returns true if Hash implements the specified GraphQL type.

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) *Hash

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

func (h *Hash) UnmarshalGraphQL(input interface{}) error

UnmarshalGraphQL unmarshals the provided GraphQL query data.

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