common

package
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Mar 7, 2025 License: GPL-3.0 Imports: 29 Imported by: 0

Documentation

Overview

Package common contains various helper functions.

Index

Constants

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

	// Constants to mnemonically index into context arrays
	PRIME_CTX  = 0
	REGION_CTX = 1
	ZONE_CTX   = 2

	//  Depth  of the tree, i.e. prime, region, zone
	HierarchyDepth     = 3
	MaxRegions         = 16
	MaxZones           = 16
	MaxWidth           = 16
	MaxExpansionNumber = 32
	InterlinkDepth     = 4
)

Lengths of hashes and addresses in bytes.

View Source 
const (
	MantBits = 64
)

Variables

View Source 
var (
	ErrNilInner        = errors.New("Address has nil inner")
	ErrExternalAddress = errors.New("Address belongs to other zone")
)
View Source 
var (
	Big0      = big.NewInt(0)
	Big1      = big.NewInt(1)
	Big2      = big.NewInt(2)
	Big3      = big.NewInt(3)
	Big4      = big.NewInt(4)
	Big7      = big.NewInt(7)
	Big8      = big.NewInt(8)
	Big10     = big.NewInt(10)
	Big16     = big.NewInt(16)
	Big32     = big.NewInt(32)
	Big64     = big.NewInt(64)
	Big96     = big.NewInt(96)
	Big99     = big.NewInt(99)
	Big100    = big.NewInt(100)
	Big101    = big.NewInt(101)
	Big256    = big.NewInt(256)
	Big257    = big.NewInt(257)
	Big480    = big.NewInt(480)
	Big1024   = big.NewInt(1024)
	Big3072   = big.NewInt(3072)
	Big199680 = big.NewInt(199680)
	Big2e64   = new(big.Int).Exp(big.NewInt(2), big.NewInt(64), big.NewInt(0))
	Big2e256  = new(big.Int).Exp(big.NewInt(2), big.NewInt(256), big.NewInt(0))
	Big10e18  = new(big.Int).Exp(big.NewInt(10), big.NewInt(18), big.NewInt(0))
)

Common big integers often used

View Source 
var (

	// The zero address (0x0)
	ZeroExternal = ExternalAddress{}
	Zero         = Address{&ZeroExternal} // For utility purposes only. It is out-of-scope for state purposes.
)
View Source 
var (
	BootstrapPeers = map[string][]string{
		"colosseum": {
			"/ip4/35.188.147.227/tcp/4002/p2p/12D3KooWB72Vs7gfLgvJsmR7cex7tG5WY7WDdqJD124Res3byDyk",
			"/ip4/35.192.179.80/tcp/4002/p2p/12D3KooWEtM3ae7ttQuCx9u7fVwk7hLWekYsTjSeBK2kSL1aYmBM",
			"/ip4/35.194.59.149/tcp/4002/p2p/12D3KooWAKQzh3osrPCBFAhqhVTUyDt6YyGrNrqg3QV1YxP5iQfa",
			"/ip4/34.23.115.164/tcp/4002/p2p/12D3KooWPdEr7wZfcWg9d2EoX6cmnyx3GvEnV5pVJvRxMUbkKesB",
			"/ip4/34.127.125.153/tcp/4002/p2p/12D3KooWG2n47V8EFh9MdxPpSmzuAwPS7dDTPEreFYJUR3ucz3sL",
			"/ip4/34.145.104.213/tcp/4002/p2p/12D3KooWMHTexdSq1zQ2Sn4L8zddEa8PWK8TGM56ZHszRuoUPoq1",
		},
		"garden": {
			"/dns4/bootnode.garden0.quai.network/tcp/4002/p2p/12D3KooWRQrLVEeJtfyKoJDYWYjryBKR8qxkDooMMzyf2ZpLaZRR",
			"/dns4/bootnode.garden1.quai.network/tcp/4002/p2p/12D3KooWLzhZXUdqhwbGpezddPkpGtZ6v7obzPkWVkfY1s6ZsX6S",
			"/dns4/bootnode.garden2.quai.network/tcp/4002/p2p/12D3KooWR3xMB6sCpsowQcvtdMKmKbTaiDcDFAXuWABdZVPWaVuo",
			"/dns4/bootnode.garden3.quai.network/tcp/4002/p2p/12D3KooWJnWmBukEbZtGPPJvT1r4tQ97CRSGmnjHewcrjNB8oRxU",
		},
		"orchard": {
			"/ip4/35.196.106.212/tcp/4002/p2p/12D3KooWK755v2ynqqgvrEeTQe38E1i556jDwX9JcduotE1bfvjU",
			"/ip4/34.136.242.207/tcp/4002/p2p/12D3KooWMjRbhyjQ5PCbt6qzMcVJx3n5NRx6uUv43yQP9ec3DV3U",
			"/ip4/35.247.60.58/tcp/4002/p2p/12D3KooWS3GnpJMNqKSSP8eCGYw53xtwdRFVZ5jj1RsCnFX2R1eu",
		},
		"lighthouse": {
			"/dns4/host-go-quai/tcp/4002/p2p/12D3KooWS83uhvCfyNeAV24nEsp3DHrygDD39rZiVy6Gabv6pqxt",
		},
	}
)
View Source 
var (
	ErrInvalidLocation = errors.New("invalid location")
)
View Source 
var File_common_proto_common_proto protoreflect.FileDescriptor
View Source 
var (
	PeerMetrics *prometheus.GaugeVec
)

Functions

func BigBitsArrayToBitsArray 

func BigBitsArrayToBitsArray(original []*big.Int) []*big.Int

func BigBitsToBits 

func BigBitsToBits(original *big.Int) *big.Int

func BigBitsToBitsFloat 

func BigBitsToBitsFloat(original *big.Int) *big.Float

func BitsToBigBits 

func BitsToBigBits(original *big.Int) *big.Int

func Bytes2Hex 

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func CheckIfBytesAreInternalAndQiAddress 

func CheckIfBytesAreInternalAndQiAddress(b []byte, nodeLocation Location) error

func CopyBytes 

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

CopyBytes returns an exact copy of the provided bytes.

func EntropyBigBitsToDifficultyBits 

func EntropyBigBitsToDifficultyBits(bigBits *big.Int) *big.Int

func FromHex 

func FromHex(s string) []byte

FromHex returns the bytes represented by the hexadecimal string s. s may be prefixed with "0x".

func GetHierarchySizeForExpansionNumber 

func GetHierarchySizeForExpansionNumber(expansion uint8) (uint64, uint64)

GetHierarchySizeForExpansionNumber calculates the number of regions and zones for a given expansion number.

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 IsConversionOutput 

func IsConversionOutput(a []byte, nodeLocation Location) bool

func IsHexAddress 

func IsHexAddress(s string) bool

IsHexAddress verifies whether a string can represent a valid hex-encoded Quai address or not.

func IsInChainScope 

func IsInChainScope(b []byte, nodeLocation Location) bool

func LeftPadBytes 

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

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

func LogBig 

func LogBig(diff *big.Int) *big.Int

IntrinsicLogEntropy returns the logarithm of the intrinsic entropy reduction of a PoW hash

func MakeErrQiAddress 

func MakeErrQiAddress(addr string) error

func MakeErrQuaiAddress 

func MakeErrQuaiAddress(addr string) error

func NewRange 

func NewRange(l, h uint8) addrPrefixRange

func OrderToString 

func OrderToString(order int) string

func ReadMessageFromStream 

func ReadMessageFromStream(stream network.Stream, protoversion protocol.ID, reporter libp2pmetrics.Reporter) ([]byte, error)

Reads the message from the stream and returns a byte of data.

func RightPadBytes 

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

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

func SanityCheck 

func SanityCheck(quitCh chan struct{})

Continously verify that the common values have not been overwritten.

func TrimLeftZeroes 

func TrimLeftZeroes(s []byte) []byte

TrimLeftZeroes returns a subslice of s without leading zeroes

func TrimRightZeroes 

func TrimRightZeroes(s []byte) []byte

TrimRightZeroes returns a subslice of s without trailing zeroes

func WriteMessageToStream 

func WriteMessageToStream(stream network.Stream, msg []byte, protoversion protocol.ID, reporter libp2pmetrics.Reporter) error

Writes the message to the stream.

Types

type Address 

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

func BigToAddress 

func BigToAddress(b *big.Int, nodeLocation Location) Address

BigToAddress returns Address with byte values of b. If b is larger than len(h), b will be cropped from the left.

func Bytes20ToAddress 

func Bytes20ToAddress(b [20]byte, nodeLocation Location) Address

func BytesToAddress 

func BytesToAddress(b []byte, nodeLocation Location) 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, nodeLocation Location) Address

HexToAddress returns Address with byte values of s. If s is larger than len(h), s will be cropped from the left.

func NewAddressFromData 

func NewAddressFromData(inner AddressData) Address

func ZeroAddress 

func ZeroAddress(nodeLocation Location) Address

func (Address) Bytes 

func (a Address) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (Address) Bytes20 

func (a Address) Bytes20() (addr AddressBytes)

Bytes20 gets the bytes20 representation of the underlying address.

func (*Address) DecodeRLP 

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

DecodeRLP decodes the Quai

func (Address) EncodeRLP 

func (a Address) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Quai RLP block format.

func (Address) Equal 

func (a Address) Equal(b Address) bool

func (Address) Format 

func (a Address) Format(s fmt.State, c rune)

Format implements fmt.Formatter. Address supports the %v, %s, %v, %x, %X and %d format verbs.

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 a hex string representation of the address.

func (Address) InternalAddress 

func (a Address) InternalAddress() (InternalAddress, error)

func (Address) InternalAndQiAddress 

func (a Address) InternalAndQiAddress() (InternalAddress, error)

func (Address) InternalAndQuaiAddress 

func (a Address) InternalAndQuaiAddress() (InternalAddress, error)

func (Address) IsInQiLedgerScope 

func (a Address) IsInQiLedgerScope() bool

func (Address) IsInQuaiLedgerScope 

func (a Address) IsInQuaiLedgerScope() bool

func (Address) Location 

func (a Address) Location() *Location

Location looks up the chain location which contains this address

func (*Address) MarshalJSON 

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

MarshalJSON marshals a subscription as its ID.

func (Address) MarshalText 

func (a Address) MarshalText() ([]byte, error)

MarshalText returns the hex representation of a.

func (Address) MixedcaseAddress 

func (a Address) MixedcaseAddress() MixedcaseAddress

func (Address) MixedcaseAddressPtr 

func (a Address) MixedcaseAddressPtr() *MixedcaseAddress

func (*Address) ProtoDecode 

func (a *Address) ProtoDecode(protoAddress *ProtoAddress, location Location) error

ProtoDecode converts the protobuf to an address representation.

func (Address) ProtoEncode 

func (a Address) ProtoEncode() *ProtoAddress

ProtoEncode converts the address to a protobuf representation.

func (*Address) Scan 

func (a *Address) Scan(src interface{}, args ...Location) error

Scan implements Scanner for database/sql.

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.

func (Address) Value 

func (a Address) Value() (driver.Value, error)

Value implements valuer for database/sql.

type AddressBytes 

type AddressBytes [AddressLength]byte

func HexToAddressBytes 

func HexToAddressBytes(s string) AddressBytes

func (AddressBytes) Bytes 

func (a AddressBytes) Bytes() []byte

func (AddressBytes) Hex 

func (a AddressBytes) Hex() string

Hex returns a hex string representation of the address.

func (AddressBytes) IsInQuaiLedgerScope 

func (a AddressBytes) IsInQuaiLedgerScope() bool

func (AddressBytes) Location 

func (a AddressBytes) Location() *Location

func (AddressBytes) MarshalJSON 

func (a AddressBytes) MarshalJSON() ([]byte, error)

func (*AddressBytes) SetBytes 

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

func (AddressBytes) String 

func (a AddressBytes) String() string

String implements fmt.Stringer.

func (*AddressBytes) UnmarshalJSON 

func (a *AddressBytes) UnmarshalJSON(input []byte) error

type AddressData 

type AddressData interface {
	Bytes() []byte
	Hash() Hash
	Hex() string
	String() string

	Format(s fmt.State, c rune)
	MarshalText() ([]byte, error)
	UnmarshalText(input []byte) error
	UnmarshalJSON(input []byte) error
	Scan(src interface{}) error
	Value() (driver.Value, error)
	Location() *Location
	// contains filtered or unexported methods
}

type ExternalAddress 

type ExternalAddress [AddressLength]byte

func (ExternalAddress) Bytes 

func (a ExternalAddress) Bytes() []byte

Bytes gets the string representation of the underlying address.

func (ExternalAddress) Format 

func (a ExternalAddress) Format(s fmt.State, c rune)

Format implements fmt.Formatter. Address supports the %v, %s, %v, %x, %X and %d format verbs.

func (ExternalAddress) Hash 

func (a ExternalAddress) Hash() Hash

Hash converts an address to a hash by left-padding it with zeros.

func (ExternalAddress) Hex 

func (a ExternalAddress) Hex() string

Hex returns a hex string representation of the address.

func (ExternalAddress) Location 

func (a ExternalAddress) Location() *Location

func (ExternalAddress) MarshalText 

func (a ExternalAddress) MarshalText() ([]byte, error)

MarshalText returns the hex representation of a.

func (*ExternalAddress) Scan 

func (a *ExternalAddress) Scan(src interface{}) error

Scan implements Scanner for database/sql.

func (ExternalAddress) String 

func (a ExternalAddress) String() string

String implements fmt.Stringer.

func (*ExternalAddress) UnmarshalJSON 

func (a *ExternalAddress) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a hash in hex syntax.

func (*ExternalAddress) UnmarshalText 

func (a *ExternalAddress) UnmarshalText(input []byte) error

UnmarshalText parses a hash in hex syntax.

func (ExternalAddress) Value 

func (a ExternalAddress) 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.

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 SetBlockHashForQi 

func SetBlockHashForQi(blockHash Hash, nodeLocation Location) Hash

SetBlockHashForQuai sets the correct first 4 bytes in the block hash for QIP10 and Qi origin

func SetBlockHashForQuai 

func SetBlockHashForQuai(blockHash Hash, nodeLocation Location) Hash

SetBlockHashForQuai sets the correct first 4 bytes in the block hash for QIP10 and Quai origin

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. Hash supports the %v, %s, %v, %x, %X and %d format verbs.

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

func (h *Hash) ProtoDecode(hash *ProtoHash)

ProtoDecode converts the ProtoHash into the Hash type

func (Hash) ProtoEncode 

func (h Hash) ProtoEncode() *ProtoHash

ProtoEncode converts the hash into the ProtoHash type

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

func (Hash) Value 

func (h Hash) Value() (driver.Value, error)

Value implements valuer for database/sql.

type Hashes 

type Hashes []Hash

Hashes is a slice of Hash

func (Hashes) EncodeIndex 

func (h Hashes) EncodeIndex(i int, w *bytes.Buffer)

func (Hashes) Len 

func (h Hashes) Len() int

Len returns the length of h.

func (*Hashes) ProtoDecode 

func (h *Hashes) ProtoDecode(hashes *ProtoHashes)

func (Hashes) ProtoEncode 

func (h Hashes) ProtoEncode() *ProtoHashes

type InternalAddress 

type InternalAddress [AddressLength]byte

func OneInternal 

func OneInternal(nodeLocation Location) InternalAddress

OneInternal returns an address starting with the byte prefix and ending in 1

func ZeroInternal 

func ZeroInternal(nodeLocation Location) InternalAddress

func (InternalAddress) Bytes 

func (a InternalAddress) Bytes() []byte

Bytes gets the bytes representation of the underlying address.

func (InternalAddress) Bytes20 

func (a InternalAddress) Bytes20() (addr AddressBytes)

Bytes20 gets the bytes20 representation of the underlying address.

func (InternalAddress) Format 

func (a InternalAddress) Format(s fmt.State, c rune)

Format implements fmt.Formatter. Address supports the %v, %s, %v, %x, %X and %d format verbs.

func (InternalAddress) Hash 

func (a InternalAddress) Hash() Hash

Hash converts an address to a hash by left-padding it with zeros.

func (InternalAddress) Hex 

func (a InternalAddress) Hex() string

Hex returns a hex string representation of the address.

func (InternalAddress) IsInQiLedgerScope 

func (a InternalAddress) IsInQiLedgerScope() bool

func (InternalAddress) IsInQuaiLedgerScope 

func (a InternalAddress) IsInQuaiLedgerScope() bool

func (InternalAddress) Location 

func (a InternalAddress) Location() *Location

func (InternalAddress) MarshalText 

func (a InternalAddress) MarshalText() ([]byte, error)

MarshalText returns the hex representation of a.

func (*InternalAddress) Scan 

func (a *InternalAddress) Scan(src interface{}) error

Scan implements Scanner for database/sql.

func (InternalAddress) String 

func (a InternalAddress) String() string

String implements fmt.Stringer.

func (*InternalAddress) UnmarshalJSON 

func (a *InternalAddress) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a hash in hex syntax.

func (*InternalAddress) UnmarshalText 

func (a *InternalAddress) UnmarshalText(input []byte) error

UnmarshalText parses a hash in hex syntax.

func (InternalAddress) Value 

func (a InternalAddress) Value() (driver.Value, error)

Value implements valuer for database/sql.

type Location 

type Location []byte

Location of a chain within the Quai hierarchy Location is encoded as a path from the root of the tree to the specified chain. Not all indices need to be populated, e.g: prime = [] region[0] = [0] zone[1,2] = [1, 2]

func GenerateLocations 

func GenerateLocations(maxRegions, zonesPerRegion int) []Location

GenerateLocations generates a logical sequence of locations

func LocationFromAddressBytes 

func LocationFromAddressBytes(addr []byte) Location

Implements the shard topology defined in QIP2

func LocationFromName 

func LocationFromName(name string) (Location, error)

LocationFromName parses a location name and returns a Location.

func NewChainsAdded 

func NewChainsAdded(expansionNumber uint8) []Location

NewChainsAdded returns the new chains added on the given expansion number

func NewLocation 

func NewLocation(region, zone int) (Location, error)

NewLocation verifies the inputs for region and zone and returns a valid location

func (Location) BytePrefix 

func (loc Location) BytePrefix() byte

Constructs the byte prefix from the location type

func (Location) CommonDom 

func (loc Location) CommonDom(cmp Location) Location

CommonDom identifies the highest context chain which exists in both locations * zone-0-0 & zone-0-1 would share region-0 as their highest context common dom * zone-0-0 & zone-1-0 would share Prime as their highest context common dom

func (Location) ContainsAddress 

func (l Location) ContainsAddress(a Address) bool

Determines if the given address belongs to the location

func (Location) Context 

func (loc Location) Context() int

func (Location) DomIndex 

func (loc Location) DomIndex(nodeLocation Location) int

DomLocation returns the location of your dominant chain

func (Location) Equal 

func (loc Location) Equal(cmp Location) bool

func (Location) GetDoms 

func (loc Location) GetDoms() []Location

GetDoms returns the dom locations that must be running for a given location For example:

  • if a region-0 calls GetDoms() the result will be [prime, region-0]
  • if a zone-0-0 calls GetDoms() the result will be [prime, region-0, zone-0-0]

func (Location) HasRegion 

func (loc Location) HasRegion() bool

func (Location) HasZone 

func (loc Location) HasZone() bool

func (Location) InSameSliceAs 

func (loc Location) InSameSliceAs(cmp Location) bool

func (Location) MarshalJSON 

func (l Location) MarshalJSON() ([]byte, error)

MarshalJSON marshals the location into a JSON array of integers

func (Location) Name 

func (loc Location) Name() string

func (Location) NameAtOrder 

func (loc Location) NameAtOrder(order int) string

func (*Location) ProtoDecode 

func (loc *Location) ProtoDecode(location *ProtoLocation)

ProtoDecode converts the ProtoLocation type back into Location

func (Location) ProtoEncode 

func (loc Location) ProtoEncode() *ProtoLocation

ProtoEncode converts the Location type into ProtoLocation

func (Location) RPCMarshal 

func (l Location) RPCMarshal() []hexutil.Uint64

func (Location) Region 

func (loc Location) Region() int

func (*Location) SetRegion 

func (l *Location) SetRegion(region int) error

func (*Location) SetZone 

func (l *Location) SetZone(zone int) error

func (Location) SubInSlice 

func (loc Location) SubInSlice(slice Location) Location

SubInSlice returns the location of the subordinate chain within the specified slice. For example:

  • if prime calls SubInSlice(Location{0,0}) the result will be Location{0}, i.e. region-0's location, because Prime's subordinate in that slice is region-0
  • if region-0 calls SubInSlice(Location{0,0}) the result will be Location{0,0}, i.e. zone-0-0's location, because region-0's subordinate in that slice is zone-0-0

func (Location) SubIndex 

func (loc Location) SubIndex(nodeCtx int) int

SubIndex returns the index of the subordinate chain for a given location

func (Location) Zone 

func (loc Location) Zone() int

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, nodeLocation Location) (*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 PrettyAge 

type PrettyAge time.Time

PrettyAge is a pretty printed version of a time.Duration value that rounds the values up to a single most significant unit, days/weeks/years included.

func (PrettyAge) String 

func (t PrettyAge) String() string

String implements the Stringer interface, allowing pretty printing of duration values rounded to the most significant time unit.

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 ProtoAddress 

type ProtoAddress struct {
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoAddress) Descriptor deprecated 

func (*ProtoAddress) Descriptor() ([]byte, []int)

Deprecated: Use ProtoAddress.ProtoReflect.Descriptor instead.

func (*ProtoAddress) GetValue 

func (x *ProtoAddress) GetValue() []byte

func (*ProtoAddress) ProtoMessage 

func (*ProtoAddress) ProtoMessage()

func (*ProtoAddress) ProtoReflect 

func (x *ProtoAddress) ProtoReflect() protoreflect.Message

func (*ProtoAddress) Reset 

func (x *ProtoAddress) Reset()

func (*ProtoAddress) String 

func (x *ProtoAddress) String() string

type ProtoHash 

type ProtoHash struct {
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoHash) Descriptor deprecated 

func (*ProtoHash) Descriptor() ([]byte, []int)

Deprecated: Use ProtoHash.ProtoReflect.Descriptor instead.

func (*ProtoHash) GetValue 

func (x *ProtoHash) GetValue() []byte

func (*ProtoHash) ProtoMessage 

func (*ProtoHash) ProtoMessage()

func (*ProtoHash) ProtoReflect 

func (x *ProtoHash) ProtoReflect() protoreflect.Message

func (*ProtoHash) Reset 

func (x *ProtoHash) Reset()

func (*ProtoHash) String 

func (x *ProtoHash) String() string

type ProtoHashes 

type ProtoHashes struct {
	Hashes []*ProtoHash `protobuf:"bytes,1,rep,name=hashes,proto3" json:"hashes,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoHashes) Descriptor deprecated 

func (*ProtoHashes) Descriptor() ([]byte, []int)

Deprecated: Use ProtoHashes.ProtoReflect.Descriptor instead.

func (*ProtoHashes) GetHashes 

func (x *ProtoHashes) GetHashes() []*ProtoHash

func (*ProtoHashes) ProtoMessage 

func (*ProtoHashes) ProtoMessage()

func (*ProtoHashes) ProtoReflect 

func (x *ProtoHashes) ProtoReflect() protoreflect.Message

func (*ProtoHashes) Reset 

func (x *ProtoHashes) Reset()

func (*ProtoHashes) String 

func (x *ProtoHashes) String() string

type ProtoLocation 

type ProtoLocation struct {
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoLocation) Descriptor deprecated 

func (*ProtoLocation) Descriptor() ([]byte, []int)

Deprecated: Use ProtoLocation.ProtoReflect.Descriptor instead.

func (*ProtoLocation) GetValue 

func (x *ProtoLocation) GetValue() []byte

func (*ProtoLocation) ProtoMessage 

func (*ProtoLocation) ProtoMessage()

func (*ProtoLocation) ProtoReflect 

func (x *ProtoLocation) ProtoReflect() protoreflect.Message

func (*ProtoLocation) Reset 

func (x *ProtoLocation) Reset()

func (*ProtoLocation) String 

func (x *ProtoLocation) String() string

type ProtoLocations 

type ProtoLocations struct {
	Locations []*ProtoLocation `protobuf:"bytes,1,rep,name=locations,proto3" json:"locations,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoLocations) Descriptor deprecated 

func (*ProtoLocations) Descriptor() ([]byte, []int)

Deprecated: Use ProtoLocations.ProtoReflect.Descriptor instead.

func (*ProtoLocations) GetLocations 

func (x *ProtoLocations) GetLocations() []*ProtoLocation

func (*ProtoLocations) ProtoMessage 

func (*ProtoLocations) ProtoMessage()

func (*ProtoLocations) ProtoReflect 

func (x *ProtoLocations) ProtoReflect() protoreflect.Message

func (*ProtoLocations) Reset 

func (x *ProtoLocations) Reset()

func (*ProtoLocations) String 

func (x *ProtoLocations) String() string

type ProtoNumber 

type ProtoNumber struct {
	Value uint64 `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ProtoNumber) Descriptor deprecated 

func (*ProtoNumber) Descriptor() ([]byte, []int)

Deprecated: Use ProtoNumber.ProtoReflect.Descriptor instead.

func (*ProtoNumber) GetValue 

func (x *ProtoNumber) GetValue() uint64

func (*ProtoNumber) ProtoMessage 

func (*ProtoNumber) ProtoMessage()

func (*ProtoNumber) ProtoReflect 

func (x *ProtoNumber) ProtoReflect() protoreflect.Message

func (*ProtoNumber) Reset 

func (x *ProtoNumber) Reset()

func (*ProtoNumber) String 

func (x *ProtoNumber) String() string

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 Unlock 

type Unlock struct {
	Addr InternalAddress
	Amt  *big.Int
}

type UnprefixedAddress 

type UnprefixedAddress InternalAddress

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
Package bitutil implements fast bitwise operations.
 Package bitutil implements fast bitwise operations.
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
Package prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.
 Package prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.

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.