types

package
v1.2.1 Latest Latest
Warning

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

 Go to latest Published: Dec 22, 2020 License: MIT Imports: 13 Imported by: 39

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const (
	HashLength              = 32
	AddressLength           = 20
	PubKeyLength            = 32
	CoinSymbolLength        = 10
	TendermintAddressLength = 20
)

Types lengths

View Source 
const (
	// BasecoinID is an ID of a base coin
	BasecoinID = 0
)

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(0xff)
	Big257 = big.NewInt(257)
)

Common big integers often used

View Source 
var CurrentChainID = ChainMainnet

CurrentChainID is current ChainID of the network

Functions

func Bytes2Hex 

func Bytes2Hex(d []byte) string

func CopyBytes 

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

Copy bytes

Returns an exact copy of the provided bytes

func EmptyHash 

func EmptyHash(h Hash) bool

EmptyHash checks if given Hash is empty

func FromHex 

func FromHex(s string, prefix string) []byte

func Hex2Bytes 

func Hex2Bytes(str string) []byte

func Hex2BytesFixed 

func Hex2BytesFixed(str string, flen int) []byte

func IsHexAddress 

func IsHexAddress(s string) bool

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

func LeftPadBytes 

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

func RightPadBytes 

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

func ToHex 

func ToHex(b []byte, prefix string) string

Types

type Account added in v0.15.0 

type Account struct {
	Address      Address   `json:"address"`
	Balance      []Balance `json:"balance"`
	Nonce        uint64    `json:"nonce"`
	MultisigData *Multisig `json:"multisig_data,omitempty"`
}

type Address 

type Address [AddressLength]byte

Address represents 20-byte address in Minter Blockchain

func BigToAddress 

func BigToAddress(b *big.Int) Address

BigToAddress converts given big.Int to Address

func BytesToAddress 

func BytesToAddress(b []byte) Address

BytesToAddress converts given byte slice to Address

func HexToAddress 

func HexToAddress(s string) Address

HexToAddress converts given hex string to Address

func StringToAddress 

func StringToAddress(s string) Address

StringToAddress converts given string to Address

func (Address) Big 

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

Big returns the big.Int representation of the underlying address

func (Address) Bytes 

func (a Address) Bytes() []byte

Bytes returns the byte representation of the underlying address

func (*Address) Compare 

func (a *Address) Compare(a2 Address) int

Compare compares addresses. The result will be 0 if a==b, -1 if a < b, and +1 if a > b.

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 returns the Hash representation of the underlying address

func (Address) Hex 

func (a Address) Hex() string

Hex returns the hex-string representation of the underlying address

func (Address) MarshalJSON added in v0.8.0 

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

MarshalJSON marshals given address to json format.

func (Address) MarshalText 

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

MarshalText returns the hex representation of a.

func (*Address) Set 

func (a *Address) Set(other Address)

Set Sets a to other

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

func (a *Address) SetString(s string)

SetString set string `s` to a. If s is larger than len(a) it will panic

func (Address) Str 

func (a Address) Str() string

Str returns the string representation of the underlying address

func (Address) String 

func (a Address) String() string

String implements the stringer interface and is used also by the logger.

func (*Address) Unmarshal added in v0.8.0 

func (a *Address) Unmarshal(input []byte) error

Unmarshal parses a hash from byte slice.

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 AppState added in v0.15.0 

type AppState struct {
	Note                string       `json:"note"`
	StartHeight         uint64       `json:"start_height"`
	Validators          []Validator  `json:"validators,omitempty"`
	Candidates          []Candidate  `json:"candidates,omitempty"`
	BlockListCandidates []Pubkey     `json:"block_list_candidates,omitempty"`
	Waitlist            []Waitlist   `json:"waitlist,omitempty"`
	Accounts            []Account    `json:"accounts,omitempty"`
	Coins               []Coin       `json:"coins,omitempty"`
	FrozenFunds         []FrozenFund `json:"frozen_funds,omitempty"`
	HaltBlocks          []HaltBlock  `json:"halt_blocks,omitempty"`
	UsedChecks          []UsedCheck  `json:"used_checks,omitempty"`
	MaxGas              uint64       `json:"max_gas"`
	TotalSlashed        string       `json:"total_slashed"`
}

func (*AppState) Verify added in v1.1.0 

func (s *AppState) Verify() error

type Balance added in v0.15.0 

type Balance struct {
	Coin  uint64 `json:"coin"`
	Value string `json:"value"`
}

type BitArray added in v0.15.0 

type BitArray struct {
	Bits  uint     `json:"bits"`  // NOTE: persisted via reflect, must be exported
	Elems []uint64 `json:"elems"` // NOTE: persisted via reflect, must be exported
	// contains filtered or unexported fields
}

BitArray is a thread-safe implementation of a bit array.

func NewBitArray added in v0.15.0 

func NewBitArray(bits int) *BitArray

NewBitArray returns a new bit array. It returns nil if the number of bits is zero.

func (*BitArray) Bytes added in v0.15.0 

func (bA *BitArray) Bytes() []byte

Bytes returns the byte representation of the bits within the bitarray.

func (*BitArray) GetIndex added in v0.15.0 

func (bA *BitArray) GetIndex(i int) bool

GetIndex returns the bit at index i within the bit array. The behavior is undefined if i >= bA.Bits

func (*BitArray) MarshalJSON added in v0.15.0 

func (bA *BitArray) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface by marshaling bit array using a custom format: a string of '-' or 'x' where 'x' denotes the 1 bit.

func (*BitArray) SetIndex added in v0.15.0 

func (bA *BitArray) SetIndex(i int, v bool) bool

SetIndex sets the bit at index i within the bit array. The behavior is undefined if i >= bA.Bits

func (*BitArray) Size added in v0.15.0 

func (bA *BitArray) Size() uint

Size returns the number of bits in the bitarray

func (*BitArray) String added in v0.15.0 

func (bA *BitArray) String() string

String returns a string representation of BitArray: BA{<bit-string>}, where <bit-string> is a sequence of 'x' (1) and '_' (0). The <bit-string> includes spaces and newlines to help people. For a simple sequence of 'x' and '_' characters with no spaces or newlines, see the MarshalJSON() method. Example: "BA{_x_}" or "nil-BitArray" for nil.

func (*BitArray) StringIndented added in v0.15.0 

func (bA *BitArray) StringIndented(indent string) string

StringIndented returns the same thing as String(), but applies the indent at every 10th bit, and twice at every 50th bit.

func (*BitArray) UnmarshalJSON added in v0.15.0 

func (bA *BitArray) UnmarshalJSON(bz []byte) error

UnmarshalJSON implements json.Unmarshaler interface by unmarshaling a custom JSON description.

type Candidate added in v0.15.0 

type Candidate struct {
	ID             uint64  `json:"id"`
	RewardAddress  Address `json:"reward_address"`
	OwnerAddress   Address `json:"owner_address"`
	ControlAddress Address `json:"control_address"`
	TotalBipStake  string  `json:"total_bip_stake"`
	PubKey         Pubkey  `json:"public_key"`
	Commission     uint64  `json:"commission"`
	Stakes         []Stake `json:"stakes"`
	Updates        []Stake `json:"updates"`
	Status         uint64  `json:"status"`
}

type ChainID added in v0.19.0 

type ChainID byte

ChainID is ID of the network (1 - mainnet, 2 - testnet) 

const (
	// ChainMainnet is mainnet chain ID of the network
	ChainMainnet ChainID = 0x01
	// ChainTestnet is mainnet chain ID of the network
	ChainTestnet ChainID = 0x02
)

type Coin added in v0.15.0 

type Coin struct {
	ID           uint64     `json:"id"`
	Name         string     `json:"name"`
	Symbol       CoinSymbol `json:"symbol"`
	Volume       string     `json:"volume"`
	Crr          uint64     `json:"crr"`
	Reserve      string     `json:"reserve"`
	MaxSupply    string     `json:"max_supply"`
	Version      uint64     `json:"version"`
	OwnerAddress *Address   `json:"owner_address"`
}

type CoinID added in v1.2.0 

type CoinID uint32

CoinID represents coin id

func BytesToCoinID added in v1.2.0 

func BytesToCoinID(bytes []byte) CoinID

BytesToCoinID converts bytes to coin id. Expects LittleEndian encoding.

func GetBaseCoinID added in v1.2.0 

func GetBaseCoinID() CoinID

GetBaseCoinID returns ID of base coin

func (CoinID) Bytes added in v1.2.0 

func (c CoinID) Bytes() []byte

Bytes returns LittleEndian encoded bytes of coin id

func (CoinID) IsBaseCoin added in v1.2.0 

func (c CoinID) IsBaseCoin() bool

IsBaseCoin checks if

func (CoinID) String added in v1.2.0 

func (c CoinID) String() string

func (CoinID) Uint32 added in v1.2.0 

func (c CoinID) Uint32() uint32

Uint32 returns coin id as uint32

type CoinSymbol 

type CoinSymbol [CoinSymbolLength]byte

CoinSymbol represents the 10 byte coin symbol.

func GetBaseCoin 

func GetBaseCoin() CoinSymbol

GetBaseCoin returns the coin symbol of the current ChainID

func StrToCoinBaseSymbol added in v1.2.0 

func StrToCoinBaseSymbol(s string) CoinSymbol

StrToCoinBaseSymbol converts give string to a coin base symbol

func StrToCoinSymbol added in v0.8.0 

func StrToCoinSymbol(s string) CoinSymbol

StrToCoinSymbol converts given string to a coin symbol

func (CoinSymbol) Bytes 

func (c CoinSymbol) Bytes() []byte

Bytes returns the bytes representation of the underlying CoinSymbol

func (CoinSymbol) Compare 

func (c CoinSymbol) Compare(c2 CoinSymbol) int

Compare compares coin symbols. The result will be 0 if a==b, -1 if a < b, and +1 if a > b.

func (CoinSymbol) IsBaseCoin 

func (c CoinSymbol) IsBaseCoin() bool

IsBaseCoin checks if coin is a base coin

func (CoinSymbol) MarshalJSON 

func (c CoinSymbol) MarshalJSON() ([]byte, error)

MarshalJSON encodes coin to json

func (CoinSymbol) String 

func (c CoinSymbol) String() string

func (*CoinSymbol) UnmarshalJSON added in v0.15.0 

func (c *CoinSymbol) UnmarshalJSON(input []byte) error

UnmarshalJSON parses a coinSymbol from json

type CoinVersion added in v1.2.0 

type CoinVersion = uint16

CoinVersion represents coin version info

func GetVersionFromSymbol added in v1.2.0 

func GetVersionFromSymbol(s string) CoinVersion

GetVersionFromSymbol returns coin version extracted from symbol

type FrozenFund added in v0.15.0 

type FrozenFund struct {
	Height       uint64  `json:"height"`
	Address      Address `json:"address"`
	CandidateKey *Pubkey `json:"candidate_key,omitempty"`
	CandidateID  uint64  `json:"candidate_id"`
	Coin         uint64  `json:"coin"`
	Value        string  `json:"value"`
}

type HaltBlock added in v1.2.0 

type HaltBlock struct {
	Height       uint64 `json:"height"`
	CandidateKey Pubkey `json:"candidate_key"`
}

type Hash 

type Hash [HashLength]byte

Hash represents the 32 byte Keccak256 hash of arbitrary data.

func BytesToHash 

func BytesToHash(b []byte) Hash

BytesToHash converts given byte slice to Hash

func (Hash) Big 

func (h Hash) Big() *big.Int

Big returns the big.Int representation of the underlying hash

func (Hash) Bytes 

func (h Hash) Bytes() []byte

Bytes returns the bytes 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 returns the hex-string representation of the underlying hash

func (Hash) MarshalText 

func (h Hash) MarshalText() ([]byte, error)

MarshalText returns the hex representation of h.

func (*Hash) Set 

func (h *Hash) Set(other Hash)

Set h to other

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

func (h *Hash) SetString(s string)

SetString sets string `s` to h. If s is larger than len(h) s will be cropped (from left) to fit.

func (Hash) Str 

func (h Hash) Str() string

Str returns the string representation of the underlying hash

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 Multisig added in v0.15.0 

type Multisig struct {
	Weights   []uint64  `json:"weights"`
	Threshold uint64    `json:"threshold"`
	Addresses []Address `json:"addresses"`
}

type Pubkey 

type Pubkey [PubKeyLength]byte

Pubkey represents 32 byte public key of a validator

func BytesToPubkey added in v1.1.0 

func BytesToPubkey(b []byte) Pubkey

BytesToPubkey decodes given bytes into Pubkey

func HexToPubkey added in v1.1.3 

func HexToPubkey(s string) Pubkey

HexToPubkey decodes given string into Pubkey

func (Pubkey) Bytes added in v1.1.0 

func (p Pubkey) Bytes() []byte

Bytes returns underlying bytes

func (Pubkey) Equals added in v1.1.0 

func (p Pubkey) Equals(p2 Pubkey) bool

Equals checks if public keys are equal

func (Pubkey) MarshalJSON added in v0.8.0 

func (p Pubkey) MarshalJSON() ([]byte, error)

MarshalJSON encodes Pubkey from to json format.

func (Pubkey) MarshalText added in v0.8.0 

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

MarshalText encodes Pubkey from to text.

func (*Pubkey) SetBytes added in v1.1.0 

func (p *Pubkey) SetBytes(b []byte)

SetBytes sets given bytes as public key

func (Pubkey) String 

func (p Pubkey) String() string

func (*Pubkey) UnmarshalJSON added in v0.15.0 

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

UnmarshalJSON decodes Pubkey from json format.

type Stake added in v0.15.0 

type Stake struct {
	Owner    Address `json:"owner"`
	Coin     uint64  `json:"coin"`
	Value    string  `json:"value"`
	BipValue string  `json:"bip_value"`
}

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 TmAddress added in v1.1.0 

type TmAddress [TendermintAddressLength]byte

TmAddress represents Tendermint address

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.

type UsedCheck added in v0.15.0 

type UsedCheck string

type Validator added in v0.15.0 

type Validator struct {
	TotalBipStake string    `json:"total_bip_stake"`
	PubKey        Pubkey    `json:"public_key"`
	AccumReward   string    `json:"accum_reward"`
	AbsentTimes   *BitArray `json:"absent_times"`
}

type Waitlist added in v1.2.0 

type Waitlist struct {
	CandidateID uint64  `json:"candidate_id"`
	Owner       Address `json:"owner"`
	Coin        uint64  `json:"coin"`
	Value       string  `json:"value"`
}

Source Files

View all Source files

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.