types

package
v0.0.0-...-c04c664 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2020 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

Package common contains various helper functions.

Index

Constants

View Source 
const (
	ChainTestnet = 0x02
	ChainMainnet = 0x01

	CurrentChainID = ChainMainnet

	BtcCheckpointInterval = 120
	MntCheckpointInterval = 2
)
View Source 
const (
	HashLength       = 32
	AddressLength    = 20
	PubKeyLength     = 32
	CoinSymbolLength = 10
	TxidLength       = 32
	UtxoIdLength     = 36
)

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

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

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 

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

type ActiveCheckpoint 

type ActiveCheckpoint struct {
	Btc BtcActiveCheckpoint `json:"btc"`
	Mnt MntActiveCheckpoint `json:"mnt"`
}

type Address 

type Address [AddressLength]byte

func BigToAddress 

func BigToAddress(b *big.Int) Address

func BytesToAddress 

func BytesToAddress(b []byte) Address

func HexToAddress 

func HexToAddress(s string) Address

func StringToAddress 

func StringToAddress(s string) Address

func (Address) Big 

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

func (Address) Bytes 

func (a Address) Bytes() []byte

func (*Address) Compare 

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

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

func (Address) Hex 

func (a Address) Hex() string

func (Address) MarshalJSON 

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

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)

Sets a to other

func (*Address) SetBytes 

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

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)

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

func (Address) Str 

func (a Address) Str() string

Get 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 

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

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 

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

	LastBtcCheckpointHeight uint64
	LastMntCheckpointHeight uint64

	SignatorySet          StateSignatorySet    `json:"signatory_set"`
	PendingBtcWithdrawals []Withdrawal         `json:"pending_btc_withdrawals"`
	PendingMntWithdrawals []Withdrawal         `json:"pending_mnt_withdrawals"`
	Utxos                 []Utxo               `json:"utxos"`
	ProcessedDeposits     []Deposit            `json:"processed_deposits"`
	BtcHeaders            []BtcHeader          `json:"btc_headers"`
	MntHeaders            []MntHeader          `json:"mnt_headers"`
	FinalizedCheckpoints  FinalizedCheckpoints `json:"finalized_checkpoints"`
	ActiveCheckpoint      ActiveCheckpoint     `json:"active_checkpoint"`
}

func (*AppState) Verify 

func (s *AppState) Verify() error

type Balance 

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

type BitArray 

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 

func NewBitArray(bits int) *BitArray

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

func (*BitArray) Bytes 

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

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

func (*BitArray) GetIndex 

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 

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 

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 

func (bA *BitArray) Size() uint

Size returns the number of bits in the bitarray

func (*BitArray) String 

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 

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 

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

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

type BlockId 

type BlockId struct {
	Hash        string        `json:"hash"`
	PartsHeader PartSetHeader `json:"parts_header"`
}

type BtcActiveCheckpoint 

type BtcActiveCheckpoint struct {
	Withdrawals []Withdrawal   `json:"withdrawals"`
	Utxos       []Utxo         `json:"utxos"`
	Signatures  []BtcSignature `json:"signatures"`
	VotingPower uint64         `json:"voting_power"`
}

type BtcHeader 

type BtcHeader struct {
	Version    int32  `json:"version"`
	PrevBlock  string `json:"prev_block"`
	MerkleRoot string `json:"merkle_root"`
	Timestamp  int64  `json:"timestamp"`
	Bits       uint32 `json:"bits"`
	Nonce      uint32 `json:"nonce"`
	Height     uint32 `json:"height"`
}

type BtcSignature 

type BtcSignature struct {
	PubKey SignatoryPubkey `json:"pub_key"`
	Sigs   [][64]byte      `json:"sigs"`
}

type Candidate 

type Candidate struct {
	RewardAddress Address `json:"reward_address"`
	OwnerAddress  Address `json:"owner_address"`
	TotalBipStake string  `json:"total_bip_stake"`
	PubKey        Pubkey  `json:"pub_key"`
	Commission    uint    `json:"commission"`
	Stakes        []Stake `json:"stakes"`
	Status        byte    `json:"status"`
}

type ChainID 

type ChainID byte

type Coin 

type Coin struct {
	Symbol CoinSymbol `json:"symbol"`
	Volume string     `json:"volume"`
}

type CoinSymbol 

type CoinSymbol [CoinSymbolLength]byte

func GetBaseCoin 

func GetBaseCoin() CoinSymbol

func StrToCoinSymbol 

func StrToCoinSymbol(s string) CoinSymbol

func (CoinSymbol) Bytes 

func (c CoinSymbol) Bytes() []byte

func (CoinSymbol) Compare 

func (c CoinSymbol) Compare(c2 CoinSymbol) int

func (CoinSymbol) IsBaseCoin 

func (c CoinSymbol) IsBaseCoin() bool

func (CoinSymbol) MarshalJSON 

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

func (CoinSymbol) String 

func (c CoinSymbol) String() string

func (*CoinSymbol) UnmarshalJSON 

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

type Commit 

type Commit struct {
	Height     int64       `json:"height"`
	Round      int         `json:"round"`
	BlockID    BlockId     `json:"block_id"`
	Signatures []CommitSig `json:"signatures"`
}

type CommitSig 

type CommitSig struct {
	BlockIDFlag      int    `json:"block_id_flag"`
	ValidatorAddress string `json:"validator_address"`
	Timestamp        int64  `json:"timestamp"`
	Signature        string `json:"signature"`
}

type Deposit 

type Deposit struct {
	MainnetTxid Txid       `json:"mainnet_txid"`
	Coin        CoinSymbol `json:"coin"`
	Amount      string     `json:"amount"`
	Owner       Address    `json:"owner"`
}

type FinalizedCheckpoints 

type FinalizedCheckpoints struct {
	Btc                     [][]byte `json:"btc"`
	LastBtcCheckpointHeight uint64   `json:"last_btc_checkpoint_height"`
	Mnt                     [][]byte `json:"mnt"`
	LastMntCheckpointHeight uint64   `json:"last_mnt_checkpoint_height"`
}

type FrozenFund 

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

type Hash 

type Hash [HashLength]byte

Hash represents the 32 byte Keccak256 hash of arbitrary data.

func BigToHash 

func BigToHash(b *big.Int) Hash

func BytesToHash 

func BytesToHash(b []byte) Hash

func HexToHash 

func HexToHash(s string) Hash

func StringToHash 

func StringToHash(s string) Hash

func (Hash) Big 

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

func (Hash) Bytes 

func (h Hash) Bytes() []byte

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

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)

Sets h to other

func (*Hash) SetBytes 

func (h *Hash) SetBytes(b []byte)

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)

Set 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

Get 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 Header struct {
	Version Version `json:"version"`
	ChainID string  `json:"chain_id"`
	Height  int64   `json:"height"`
	Time    int64   `json:"time"`

	LastBlockID BlockId `json:"last_block_id"`

	LastCommitHash string `json:"last_commit_hash"`
	DataHash       string `json:"data_hash"`

	ValidatorsHash     string `json:"validators_hash"`
	NextValidatorsHash string `json:"next_validators_hash"`
	ConsensusHash      string `json:"consensus_hash"`
	AppHash            string `json:"app_hash"`
	LastResultsHash    string `json:"last_results_hash"`

	EvidenceHash    string `json:"evidence_hash"`
	ProposerAddress string `json:"proposer_address"`
}

type MntActiveCheckpoint 

type MntActiveCheckpoint struct {
	Withdrawals []Withdrawal   `json:"withdrawals"`
	Signatures  []MntSignature `json:"signatures"`
	VotingPower uint64         `json:"voting_power"`
}

type MntHeader 

type MntHeader struct {
	Header Header `json:"header"`
	Commit Commit `json:"commit"`
}

type MntSignature 

type MntSignature struct {
	PubKey SignatoryPubkey `json:"pubkey"`
	Sig    []byte          `json:"sig"`
}

type Multisig 

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

type PartSetHeader 

type PartSetHeader struct {
	Total int    `json:"total"`
	Hash  string `json:"hash"`
}

type Pubkey 

type Pubkey [32]byte

func BytesToPubkey 

func BytesToPubkey(b []byte) Pubkey

func HexToPubkey 

func HexToPubkey(s string) Pubkey

func (Pubkey) Bytes 

func (p Pubkey) Bytes() []byte

func (Pubkey) Equals 

func (p Pubkey) Equals(p2 Pubkey) bool

func (Pubkey) MarshalJSON 

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

func (Pubkey) MarshalText 

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

func (*Pubkey) SetBytes 

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

func (Pubkey) String 

func (p Pubkey) String() string

func (*Pubkey) UnmarshalJSON 

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

type RlpBlockID 

type RlpBlockID struct {
	Hash        tmbytes.HexBytes
	PartsHeader RlpPartSetHeader
}

type RlpBtcHeader 

type RlpBtcHeader struct {
	Version    uint32
	PrevBlock  chainhash.Hash
	MerkleRoot chainhash.Hash
	Timestamp  uint64
	Bits       uint32
	Nonce      uint32
}

func WireToRlp 

func WireToRlp(h wire.BlockHeader) RlpBtcHeader

func (RlpBtcHeader) Wire 

func (h RlpBtcHeader) Wire() wire.BlockHeader

type RlpCommit 

type RlpCommit struct {
	Height     uint64
	Round      uint
	BlockID    RlpBlockID
	Signatures []RlpCommitSig
}

func (RlpCommit) ToTMType 

func (h RlpCommit) ToTMType() *tmtypes.Commit

type RlpCommitSig 

type RlpCommitSig struct {
	BlockIDFlag      tmtypes.BlockIDFlag
	ValidatorAddress crypto.Address
	Timestamp        uint64
	Signature        []byte
}

type RlpMntHeader 

type RlpMntHeader struct {
	Version            version.Consensus
	ChainID            string
	Height             uint64
	Time               uint64
	LastBlockID        RlpBlockID
	LastCommitHash     tmbytes.HexBytes
	DataHash           tmbytes.HexBytes
	ValidatorsHash     tmbytes.HexBytes
	NextValidatorsHash tmbytes.HexBytes
	ConsensusHash      tmbytes.HexBytes
	AppHash            tmbytes.HexBytes
	LastResultsHash    tmbytes.HexBytes
	EvidenceHash       tmbytes.HexBytes
	ProposerAddress    crypto.Address
}

func (RlpMntHeader) ToTMType 

func (h RlpMntHeader) ToTMType() *tmtypes.Header

type RlpMntSignedHeader 

type RlpMntSignedHeader struct {
	Header RlpMntHeader
	Commit RlpCommit
}

func TMSignedHeaderToRlp 

func TMSignedHeaderToRlp(h tmtypes.SignedHeader) RlpMntSignedHeader

func (RlpMntSignedHeader) ToTMType 

func (h RlpMntSignedHeader) ToTMType() tmtypes.SignedHeader

type RlpPartSetHeader 

type RlpPartSetHeader struct {
	Total uint
	Hash  tmbytes.HexBytes
}

type RlpSimpleProof 

type RlpSimpleProof struct {
	Total    uint
	Index    uint
	LeafHash []byte
	Aunts    [][]byte
}

func SimpleProofToRlp 

func SimpleProofToRlp(sp merkle.SimpleProof) RlpSimpleProof

func (RlpSimpleProof) ToTMType 

func (sp RlpSimpleProof) ToTMType() merkle.SimpleProof

type RlpValidator 

type RlpValidator struct {
	Address          crypto.Address
	PubKey           []byte
	VotingPower      string
	ProposerPriority string
}

type RlpValidatorSet 

type RlpValidatorSet struct {
	Validators []RlpValidator
	Proposer   RlpValidator
}

func TMValidatorsSetToRlp 

func TMValidatorsSetToRlp(v tmtypes.ValidatorSet) RlpValidatorSet

func (RlpValidatorSet) ToTMType 

func (v RlpValidatorSet) ToTMType() tmtypes.ValidatorSet

type Signatory 

type Signatory struct {
	VotingPower uint64          `json:"voting_power"`
	PubKey      SignatoryPubkey `json:"pub_key"`
}

type SignatoryPubkey 

type SignatoryPubkey [33]byte

type SignatorySet 

type SignatorySet struct {
	Map              map[SignatoryPubkey]Signatory `json:"map"`
	Set              []Signatory                   `json:"set"`
	TotalVotingPower uint64                        `json:"total_voting_power"`
}

func (SignatorySet) TwoThirdsVotingPower 

func (s SignatorySet) TwoThirdsVotingPower() uint64

type SignatorySetSnapshot 

type SignatorySetSnapshot struct {
	Time        uint64       `json:"time"`
	Signatories SignatorySet `json:"signatories"`
}

type Stake 

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

type StateSignatorySet 

type StateSignatorySet struct {
	Signatories      []Signatory `json:"signatories"`
	TotalVotingPower uint64      `json:"total_voting_power"`
}

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 

type TmAddress [20]byte

type Txid 

type Txid [TxidLength]byte

func (Txid) Bytes 

func (txid Txid) Bytes() []byte

func (Txid) String 

func (txid Txid) String() string

type UnprefixedAddress 

type UnprefixedAddress Address

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

type UsedCheck 

type UsedCheck string

type Utxo 

type Utxo struct {
	Txid   Txid   `json:"txid"`
	Vout   uint32 `json:"vout"`
	Amount int64  `json:"amount"`
	Data   []byte `json:"data"`
}

type UtxoId 

type UtxoId [UtxoIdLength]byte

func (UtxoId) Bytes 

func (u UtxoId) Bytes() []byte

func (UtxoId) String 

func (u UtxoId) String() string

type Validator 

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

type Version 

type Version struct {
	Block uint64 `json:"block"`
	App   uint64 `json:"app"`
}

type Withdrawal 

type Withdrawal struct {
	Value  int64  `json:"value"`
	Script []byte `json:"script"`
}

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.