common

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2022 License: GPL-3.0 Imports: 25 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
	BlockConfirmSignLength = 65
)

Lengths of hashes and addresses in bytes.

View Source
const (
	CallContractFlag             = 9
	TxTypeCallSollCompatibleWasm = 14
)

tx-type

View Source
const JSONRequiredTag = "required"

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

Common big integers often used

View Source
var (
	Sys_pivot_key               = bcwasmutil.SerilizString("sys_pivot_key")
	Sys_old_system_contract_key = bcwasmutil.SerilizString("sys_old_system_contract_key")
	Sys_old_super_admin_key     = bcwasmutil.SerilizString("sys_old_super_admin_key")
)
View Source
var SysCfg = &SystemConfig{
	SystemConfigMu: &sync.RWMutex{},
	Nodes:          make([]NodeInfo, 0),
	nodeMap:        make(map[string]*NodeInfo),
	ConsensusNodes: make([]*NodeInfo, 0),
	DeleteNodes:    make([]*NodeInfo, 0),
	HighsetNumber:  new(big.Int).SetInt64(0),
	SysParam: &SystemParameter{
		BlockGasLimit: 0xffffffffffff,
		TxGasLimit:    100000000000000,
		VRF: VRFParams{
			ElectionEpoch:     0,
			NextElectionBlock: 0,
			ValidatorCount:    0,
		},
		IsBlockUseTrieHash: true,
		IsUseDAG:           false,
	},
	ContractAddress: make(map[string]Address),
	ReplayParam: &ReplayParam{
		Pivot:           0,
		OldSysContracts: make(map[Address]string),
		OldSuperAdmin:   NullAddress,
	},
}

Functions

func AbsolutePath

func AbsolutePath(datadir string, filename string) string

AbsolutePath returns datadir + filename, or filename if it is absolute.

func BigToByte128

func BigToByte128(I *big.Int) ([]byte, bool)

BigToByte128 convert big.Int to 128-bit big endian,assuming it will not overflow

func BoolToBytes

func BoolToBytes(b bool) []byte

func Byte128ToBig

func Byte128ToBig(b []byte, s bool) *big.Int

Byte128ToBig convert byte[] big endian to big.Int, s indecates whether b is signed

func Bytes2Hex

func Bytes2Hex(d []byte) string

Bytes2Hex returns the hexadecimal encoding of d.

func BytesCombine

func BytesCombine(pBytes ...[]byte) []byte

func BytesToFloat32

func BytesToFloat32(bytes []byte) float32

func BytesToFloat64

func BytesToFloat64(bytes []byte) float64

func BytesToInt32

func BytesToInt32(b []byte) int32

func BytesToInt64

func BytesToInt64(b []byte) int64

func CallResAsBool

func CallResAsBool(bts []byte) bool

func CallResAsFloat128

func CallResAsFloat128(bts []byte) *big.Float

func CallResAsFloat32

func CallResAsFloat32(bts []byte) float32

func CallResAsFloat64

func CallResAsFloat64(bts []byte) float64

func CallResAsInt128

func CallResAsInt128(bts []byte) *big.Int

func CallResAsInt32

func CallResAsInt32(bts []byte) int32

func CallResAsInt64

func CallResAsInt64(bts []byte) int64

func CallResAsString

func CallResAsString(bts []byte) string

func CallResAsUint128

func CallResAsUint128(bts []byte) *big.Int

func CallResAsUint32

func CallResAsUint32(bts []byte) uint32

func CallResAsUint64

func CallResAsUint64(bts []byte) uint64

func CheckRequiredFields

func CheckRequiredFields(isEmpty func(reflect.Value) bool, data interface{}) error

func CheckRequiredFieldsIsEmpty

func CheckRequiredFieldsIsEmpty(data interface{}) error

func CopyBytes

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

CopyBytes returns an exact copy of the provided bytes.

func CurrentGoRoutineID

func CurrentGoRoutineID() string

func EmptyHash

func EmptyHash(h Hash) bool

func ErrPrintln

func ErrPrintln(a ...interface{})

func FileExist

func FileExist(filePath string) bool

FileExist checks if a file exists at filePath.

func Float32ToBytes

func Float32ToBytes(float float32) []byte

func Float64ToBytes

func Float64ToBytes(float float64) []byte

func FromHex

func FromHex(s string) []byte

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

func GenCallData

func GenCallData(funcName string, params []interface{}) []byte

func GenerateWasmData

func GenerateWasmData(txType int64, funcName string, params []interface{}) ([]byte, error)

func GetCurrentInterpreterType

func GetCurrentInterpreterType() string

func GetParallelPoolSize added in v1.1.0

func GetParallelPoolSize() int

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 Int16ToBytes

func Int16ToBytes(n int16) []byte

func Int32ToBytes

func Int32ToBytes(n int32) []byte

func Int64ToBytes

func Int64ToBytes(n int64) []byte

func Int8ToBytes

func Int8ToBytes(n int8) []byte

func IntToBytes

func IntToBytes(n int) []byte

func IsBytesEmpty

func IsBytesEmpty(input []byte) bool

func IsHexAddress

func IsHexAddress(s string) bool

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

func IsHexZeroAddress

func IsHexZeroAddress(s string) bool

IsZeroAddress compare

func IsSafeNumber

func IsSafeNumber(number string, bit int, isUnsigned bool) (res bool)

func IsWasmContractCode

func IsWasmContractCode(code []byte) (ok bool, tx_type int64, abi, bytecode []byte)

func LeftPadBytes

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

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

func LoadJSON

func LoadJSON(file string, val interface{}) error

LoadJSON reads the given file and unmarshals its content.

func MakeName

func MakeName(name, version string) string

MakeName creates a node name that follows the ethereum convention for such names. It adds the operation system name and Go runtime version the name.

func PaddingLeft

func PaddingLeft(src []byte, bytes int) []byte

func ParseWasmCodeRlpData

func ParseWasmCodeRlpData(rlpData []byte) (int64, []byte, []byte, error)

func PrintDepricationWarning

func PrintDepricationWarning(str string)

PrintDepricationWarning prinst the given string in a box using fmt.Println.

func Report

func Report(extra ...interface{})

Report gives off a warning requesting the user to submit an issue to the github tracker.

func RevertBytes

func RevertBytes(bts []byte)

func RightPadBytes

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

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

func SetCurrentInterpreterType

func SetCurrentInterpreterType(cit string)

func SetParallelPoolSize added in v1.1.0

func SetParallelPoolSize(size int)

func ToBytes

func ToBytes(source interface{}) ([]byte, error)

func ToHex deprecated

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.

func Uint16ToBytes

func Uint16ToBytes(n uint16) []byte

func Uint32ToBytes

func Uint32ToBytes(n uint32) []byte

func Uint64ToBytes

func Uint64ToBytes(n uint64) []byte

func Uint8ToBytes

func Uint8ToBytes(n uint8) []byte

func UintToBytes

func UintToBytes(n uint) []byte

func WasmCallResultCompatibleSolInt64

func WasmCallResultCompatibleSolInt64(res []byte) []byte

func WasmCallResultCompatibleSolString

func WasmCallResultCompatibleSolString(res []byte) []byte

Types

type Address

type Address [AddressLength]byte

Address represents the 20 byte address of an Ethereum account.

var NullAddress Address = Address{}

func BigToAddress

func BigToAddress(b *big.Int) Address

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

func BytesToAddress

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

func (a Address) HexWithNoPrefix() string

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 (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) 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 BlockConfirmSign

type BlockConfirmSign [BlockConfirmSignLength]byte

func NewBlockConfirmSign

func NewBlockConfirmSign(signSlice []byte) *BlockConfirmSign

func (*BlockConfirmSign) String

func (sig *BlockConfirmSign) String() string

type CommonResult

type CommonResult struct {
	RetCode int32      `json:"code"`
	RetMsg  string     `json:"msg"`
	Data    []NodeInfo `json:"data"`
}

type DBItem

type DBItem struct {
	Key   []byte
	Value []byte
}

type DBItems

type DBItems []*DBItem

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 RlpHash

func RlpHash(x interface{}) (h Hash)

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

func (h Hash) HexWithNoPrefix() string

Hex converts a hash to a hex string with no prefix of 0x.

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) 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 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) (*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 NodeInfo

type NodeInfo struct {
	Name  string `json:"name,omitempty"`
	Owner string `json:"owner,omitempty"`
	Desc  string `json:"desc,omitempty"`
	Types int32  `json:"type,omitempty"`
	// status 1为正常节点, 2为删除节点
	Status     int32  `json:"status,omitempty"`
	ExternalIP string `json:"externalIP,omitempty"`
	InternalIP string `json:"internalIP,omitempty"`
	PublicKey  string `json:"publicKey,omitempty"`
	RpcPort    int32  `json:"rpcPort,omitempty"`
	P2pPort    int32  `json:"p2pPort,omitempty"`
	// delay set validatorSet
	DelayNum uint64 `json:"delayNum,omitempty"`
}

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 ReplayParam

type ReplayParam struct {
	Pivot           uint64             `json:"povit"`
	OldSysContracts map[Address]string `json:"oldSysContracts"`
	OldSuperAdmin   Address            `json:"oldSuperAdmin"`
}

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 SystemConfig

type SystemConfig struct {
	SystemConfigMu *sync.RWMutex
	SysParam       *SystemParameter
	Nodes          []NodeInfo

	ConsensusNodes  []*NodeInfo
	DeleteNodes     []*NodeInfo
	HighsetNumber   *big.Int
	ContractAddress map[string]Address
	ReplayParam     *ReplayParam
	// contains filtered or unexported fields
}

func (*SystemConfig) GenerateNodeData

func (sc *SystemConfig) GenerateNodeData()

func (*SystemConfig) GetBlockGasLimit

func (sc *SystemConfig) GetBlockGasLimit() int64

func (*SystemConfig) GetConsensusNodes

func (sc *SystemConfig) GetConsensusNodes() []*NodeInfo

func (*SystemConfig) GetConsensusNodesFilterDelay

func (sc *SystemConfig) GetConsensusNodesFilterDelay(number uint64, nodes []NodeInfo) []NodeInfo

func (*SystemConfig) GetContractAddress

func (sc *SystemConfig) GetContractAddress(name string) Address

func (*SystemConfig) GetDeletedNodes

func (sc *SystemConfig) GetDeletedNodes() []*NodeInfo

func (*SystemConfig) GetGasContractAddress

func (sc *SystemConfig) GetGasContractAddress() Address

func (*SystemConfig) GetGasContractName

func (sc *SystemConfig) GetGasContractName() string

func (*SystemConfig) GetHighsetNumber

func (sc *SystemConfig) GetHighsetNumber() *big.Int

func (*SystemConfig) GetIsTxUseGas

func (sc *SystemConfig) GetIsTxUseGas() bool

func (*SystemConfig) GetNodeTypes

func (sc *SystemConfig) GetNodeTypes(publicKey string) int32

func (*SystemConfig) GetNormalNodes

func (sc *SystemConfig) GetNormalNodes() []NodeInfo

func (*SystemConfig) GetTxGasLimit

func (sc *SystemConfig) GetTxGasLimit() int64

func (*SystemConfig) IfCheckContractDeployPermission

func (sc *SystemConfig) IfCheckContractDeployPermission() int64

func (*SystemConfig) IsBlockUseTrieHash

func (sc *SystemConfig) IsBlockUseTrieHash() bool

func (*SystemConfig) IsProduceEmptyBlock

func (sc *SystemConfig) IsProduceEmptyBlock() bool

func (*SystemConfig) IsUseDAG added in v1.1.0

func (sc *SystemConfig) IsUseDAG() bool

func (*SystemConfig) IsValidJoinNode

func (sc *SystemConfig) IsValidJoinNode(publicKey string) bool

type SystemParameter

type SystemParameter struct {
	BlockGasLimit                 int64
	TxGasLimit                    int64
	GasContractName               string
	GasContractAddr               Address
	CheckContractDeployPermission int64
	IsTxUseGas                    bool
	IsProduceEmptyBlock           bool
	VRF                           VRFParams
	IsBlockUseTrieHash            bool
	IsUseDAG                      bool
}

type UnprefixedAddress

type UnprefixedAddress Address

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.

type VRFParams

type VRFParams struct {
	ElectionEpoch     uint64 `json:"electionEpoch"`
	NextElectionBlock uint64 `json:"nextElectionBlock"`
	ValidatorCount    uint64 `json:"validatorCount"`
}

Directories

Path Synopsis
Package bitutil implements fast bitwise operations.
Package bitutil implements fast bitwise operations.
Package compiler wraps the Solidity compiler executable (solc).
Package compiler wraps the Solidity compiler executable (solc).
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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL