Documentation ¶
Overview ¶
Package common contains various helper functions.
Index ¶
- Constants
- Variables
- func AbsolutePath(datadir string, filename string) string
- func Bytes2Hex(d []byte) string
- func BytesToInt(b []byte) int
- func CopyBytes(b []byte) (copiedBytes []byte)
- func FileExist(filePath string) bool
- func FromHex(s string) []byte
- func GetForkEnabledHeight(forkNumber int) uint64
- func Hex2Bytes(str string) []byte
- func Hex2BytesFixed(str string, flen int) []byte
- func IntToBytes(n int) []byte
- func IsHexAddress(s string) bool
- func LeftPadBytes(slice []byte, l int) []byte
- func LoadJSON(file string, val interface{}) error
- func MakeName(name, version string) string
- func MaxUint64(x, y uint64) uint64
- func MinUint64(x, y uint64) uint64
- func ParseBig256(s string) (*big.Int, bool)
- func PrintDepricationWarning(str string)
- func Report(extra ...interface{})
- func RightPadBytes(slice []byte, l int) []byte
- func TicketPrice(blocknumber *big.Int) *big.Int
- func ToHex(b []byte) stringdeprecated
- type 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) MarshalText() ([]byte, error)
- func (a *Address) Scan(src interface{}) error
- func (a *Address) SetBytes(b []byte)
- func (a Address) String() string
- func (a *Address) UnmarshalJSON(input []byte) error
- func (a *Address) UnmarshalText(input []byte) error
- func (a Address) Value() (driver.Value, error)
- type Asset
- type AssetValueChangeExParam
- type AssetValueChangeParam
- type BuyTicketParam
- type FSNCallFunc
- type FSNCallParam
- type GenAssetParam
- type Hash
- func (h Hash) Big() *big.Int
- func (h Hash) Bytes() []byte
- 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 (h Hash) MarshalText() ([]byte, error)
- func (h *Hash) Scan(src interface{}) error
- func (h *Hash) SetBytes(b []byte)
- func (h Hash) String() string
- func (h Hash) TerminalString() string
- func (h *Hash) UnmarshalJSON(input []byte) error
- func (h *Hash) UnmarshalText(input []byte) error
- func (h Hash) Value() (driver.Value, error)
- type KeyValue
- type MakeSwapParam
- type MixedcaseAddress
- func (ma *MixedcaseAddress) Address() Address
- func (ma *MixedcaseAddress) MarshalJSON() ([]byte, error)
- func (ma *MixedcaseAddress) Original() string
- func (ma *MixedcaseAddress) String() string
- func (ma *MixedcaseAddress) UnmarshalJSON(input []byte) error
- func (ma *MixedcaseAddress) ValidChecksum() bool
- type PrettyAge
- type PrettyDuration
- type RecallSwapParam
- type SendAssetParam
- type StorageSize
- type Swap
- type TailFlag
- type TakeSwapParam
- type Ticket
- type TicketSlice
- func (s TicketSlice) Add(ticket *Ticket) TicketSlice
- func (s TicketSlice) DeepCopy() TicketSlice
- func (s TicketSlice) Delete(tid Hash) TicketSlice
- func (s TicketSlice) Get(tid Hash) (*Ticket, bool)
- func (s TicketSlice) Len() int
- func (s TicketSlice) Less(i, j int) bool
- func (s TicketSlice) Swap(i, j int)
- func (s TicketSlice) ToMap() map[Hash]Ticket
- func (s TicketSlice) ToTicketStructSlice() TicketStructSlice
- type TicketStruct
- type TicketStructSlice
- type TimeLock
- func (z *TimeLock) Add(x, y *TimeLock) *TimeLock
- func (z *TimeLock) Add2(x, y *TimeLock) *TimeLock
- func (z *TimeLock) CheckValid()
- func (z *TimeLock) ClearExpired(timestamp uint64) *TimeLock
- func (z *TimeLock) Clone() *TimeLock
- func (z *TimeLock) Cmp(x *TimeLock, blockNumber *big.Int) int
- func (z *TimeLock) Cmp2(x *TimeLock) int
- func (z *TimeLock) HasOnlyOneItem() bool
- func (z *TimeLock) IsEmpty() bool
- func (z *TimeLock) IsNormalized() bool
- func (z *TimeLock) IsValid() error
- func (z *TimeLock) Len() int
- func (z *TimeLock) Less(i, j int) bool
- func (z *TimeLock) Normalize() *TimeLock
- func (z *TimeLock) Set(x *TimeLock) *TimeLock
- func (z *TimeLock) SetItems(items []*TimeLockItem)
- func (z *TimeLock) String() string
- func (z *TimeLock) Sub(x, y *TimeLock) *TimeLock
- func (z *TimeLock) Sub2(x, y *TimeLock) *TimeLock
- func (z *TimeLock) Swap(i, j int)
- func (z *TimeLock) ToDisplay() *TimeLock
- type TimeLockItem
- func (z *TimeLockItem) Add(x *TimeLockItem) ([]*TimeLockItem, TailFlag)
- func (z *TimeLockItem) AdjustEnd(endTime uint64) *TimeLockItem
- func (z *TimeLockItem) AdjustStart(startTime uint64) *TimeLockItem
- func (z *TimeLockItem) AdjustStartEnd(startTime uint64, endTime uint64) *TimeLockItem
- func (z *TimeLockItem) CanMerge(x *TimeLockItem) bool
- func (z *TimeLockItem) Clone() *TimeLockItem
- func (z *TimeLockItem) EqualRange(x *TimeLockItem) bool
- func (z *TimeLockItem) IsFlagTimeLockItem() bool
- func (z *TimeLockItem) IsValid() error
- func (u *TimeLockItem) MarshalJSON() ([]byte, error)
- func (z *TimeLockItem) Merge(x *TimeLockItem) *TimeLockItem
- func (z *TimeLockItem) String() string
- func (z *TimeLockItem) Sub(x *TimeLockItem) ([]*TimeLockItem, *TimeLockItem)
- func (z *TimeLockItem) SubWithMissingValue(x *TimeLockItem) (*big.Int, []*TimeLockItem)
- type TimeLockParam
- type TimeLockType
- type UnprefixedAddress
- type UnprefixedHash
Constants ¶
const ( // TimeLockNow wacom TimeLockNow uint64 = 0 // TimeLockForever wacom TimeLockForever uint64 = 0xffffffffffffffff )
const ( // HashLength is the expected length of the hash HashLength = 32 // AddressLength is the expected length of the adddress AddressLength = 20 )
Lengths of hashes and addresses in bytes.
const ( // GenNotationFunc wacom GenNotationFunc = iota // GenAssetFunc wacom GenAssetFunc // SendAssetFunc wacom SendAssetFunc // TimeLockFunc wacom TimeLockFunc // BuyTicketFunc wacom BuyTicketFunc // OldAssetValueChangeFunc wacom OldAssetValueChangeFunc // MakeSwapFunc wacom MakeSwapFunc // RecallSwapFunc wacom RecallSwapFunc // TakeSwapFunc wacom TakeSwapFunc // EmptyFunc wacom EmptyFunc // MakeSwapFuncExt wacom MakeSwapFuncExt // TakeSwapFuncExt wacom TakeSwapFuncExt // AssetValueChangeFunc wacom AssetValueChangeFunc )
const (
DebugMode = true
)
Variables ¶
var ( Big0 = big.NewInt(0) Big1 = big.NewInt(1) Big2 = big.NewInt(2) Big3 = big.NewInt(3) Big32 = big.NewInt(32) Big100 = big.NewInt(100) Big256 = big.NewInt(256) Big257 = big.NewInt(257) BigMaxUint64 = new(big.Int).SetUint64(math.MaxUint64) )
Common big integers often used
var ( // NotationKey wacom NotationKey = []byte{0x01} // AssetKey wacom AssetKey = []byte{0x02} // TicketKey wacom TicketKey = []byte{0x03} // SwapKey wacom SwapKey = []byte{0x06} // 4 was the old // Auto buy tickets AutoBuyTicket = false AutoBuyTicketChan = make(chan int, 10) )
var AssetKeyAddress = HexToAddress("0xfffffffffffffffffffffffffffffffffffffffc")
var FSNCallAddress = HexToAddress("0xffffffffffffffffffffffffffffffffffffffff")
FSNCallAddress wacom
var FlagTimeLockItem = TimeLockItem{0, 0, Big0}
added after hard fork 5 to indentify different storage
var NotationKeyAddress = HexToAddress("0xfffffffffffffffffffffffffffffffffffffffd")
var SwapKeyAddress = HexToAddress("0xfffffffffffffffffffffffffffffffffffffffa")
var SystemAsset = Asset{ Name: "Fusion", Symbol: "FSN", Decimals: 18, Total: new(big.Int).Mul(big.NewInt(81920000), big.NewInt(1000000000000000000)), ID: SystemAssetID, Description: "https://fusion.org", }
SystemAsset wacom
var SystemAssetID = HexToHash("0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff")
SystemAssetID wacom
var TicketKeyAddress = HexToAddress("0xfffffffffffffffffffffffffffffffffffffffb")
var TicketLogAddress = HexToAddress("0xfffffffffffffffffffffffffffffffffffffffe")
TicketLogAddress wacom
Functions ¶
func AbsolutePath ¶
AbsolutePath returns datadir + filename, or filename if it is absolute.
func FromHex ¶
FromHex returns the bytes represented by the hexadecimal string s. s may be prefixed with "0x".
func GetForkEnabledHeight ¶
func Hex2BytesFixed ¶
Hex2BytesFixed returns bytes of a specified fixed length flen.
func IsHexAddress ¶
IsHexAddress verifies whether a string can represent a valid hex-encoded Ethereum address or not.
func LeftPadBytes ¶
LeftPadBytes zero-pads slice to the left up to length l.
func MakeName ¶
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 ParseBig256 ¶
ParseBig256 parses s as a 256 bit integer in decimal or hexadecimal syntax. Leading zeros are accepted. The empty string parses as zero.
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 RightPadBytes ¶
RightPadBytes zero-pads slice to the right up to length l.
func TicketPrice ¶
TicketPrice place holder for ticket price
Types ¶
type Address ¶
type Address [AddressLength]byte
Address represents the 20 byte address of an Ethereum account.
func BigToAddress ¶
BigToAddress returns Address with byte values of b. If b is larger than len(h), b will be cropped from the left.
func BytesToAddress ¶
BytesToAddress returns Address with value b. If b is larger than len(h), b will be cropped from the left.
func HexToAddress ¶
HexToAddress returns Address with byte values of s. If s is larger than len(h), s will be cropped from the left.
func (Address) Format ¶
Format implements fmt.Formatter, forcing the byte slice to be formatted as is, without going through the stringer interface used for logging.
func (Address) MarshalText ¶
MarshalText returns the hex representation of a.
func (*Address) SetBytes ¶
SetBytes sets the address to the value of b. If b is larger than len(a) it will panic.
func (*Address) UnmarshalJSON ¶
UnmarshalJSON parses a hash in hex syntax.
func (*Address) UnmarshalText ¶
UnmarshalText parses a hash in hex syntax.
type Asset ¶
type Asset struct { ID Hash Owner Address Name string Symbol string Decimals uint8 Total *big.Int `json:",string"` CanChange bool Description string }
Asset wacom
func (*Asset) MarshalJSON ¶
type AssetValueChangeExParam ¶
type AssetValueChangeExParam struct { AssetID Hash To Address Value *big.Int `json:",string"` IsInc bool TransacData string }
AssetValueChangeExParam wacom
func (*AssetValueChangeExParam) Check ¶
func (p *AssetValueChangeExParam) Check(blockNumber *big.Int) error
func (*AssetValueChangeExParam) ToBytes ¶
func (p *AssetValueChangeExParam) ToBytes() ([]byte, error)
ToBytes wacom
type AssetValueChangeParam ¶
type AssetValueChangeParam struct { AssetID Hash To Address Value *big.Int `json:",string"` IsInc bool }
AssetValueChangeParam wacom
func (*AssetValueChangeParam) Check ¶
func (p *AssetValueChangeParam) Check(blockNumber *big.Int) error
func (*AssetValueChangeParam) ToBytes ¶
func (p *AssetValueChangeParam) ToBytes() ([]byte, error)
ToBytes wacom
type GenAssetParam ¶
type GenAssetParam struct { Name string Symbol string Decimals uint8 Total *big.Int `json:",string"` CanChange bool Description string }
GenAssetParam wacom
type Hash ¶
type Hash [HashLength]byte
Hash represents the 32 byte Keccak256 hash of arbitrary data.
func BigToHash ¶
BigToHash sets byte representation of b to hash. If b is larger than len(h), b will be cropped from the left.
func BytesToHash ¶
BytesToHash sets b to hash. If b is larger than len(h), b will be cropped from the left.
func HexToHash ¶
HexToHash sets byte representation of s to hash. If b is larger than len(h), b will be cropped from the left.
func (Hash) Format ¶
Format implements fmt.Formatter, forcing the byte slice to be formatted as is, without going through the stringer interface used for logging.
func (Hash) MarshalText ¶
MarshalText returns the hex representation of h.
func (*Hash) SetBytes ¶
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 ¶
String implements the stringer interface and is used also by the logger when doing full logging into a file.
func (Hash) TerminalString ¶
TerminalString implements log.TerminalStringer, formatting a string for console output during logging.
func (*Hash) UnmarshalJSON ¶
UnmarshalJSON parses a hash in hex syntax.
func (*Hash) UnmarshalText ¶
UnmarshalText parses a hash in hex syntax.
type MakeSwapParam ¶
type MakeSwapParam struct { FromAssetID Hash FromStartTime uint64 FromEndTime uint64 MinFromAmount *big.Int `json:",string"` ToAssetID Hash ToStartTime uint64 ToEndTime uint64 MinToAmount *big.Int `json:",string"` SwapSize *big.Int `json:",string"` Targes []Address Time *big.Int Description string }
MakeSwapParam wacom
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 PrettyAge ¶
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.
type PrettyDuration ¶
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 RecallSwapParam ¶
type RecallSwapParam struct {
SwapID Hash
}
RecallSwapParam wacom
type SendAssetParam ¶
SendAssetParam wacom
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 Swap ¶
type Swap struct { ID Hash Owner Address FromAssetID Hash FromStartTime uint64 FromEndTime uint64 MinFromAmount *big.Int `json:",string"` ToAssetID Hash ToStartTime uint64 ToEndTime uint64 MinToAmount *big.Int `json:",string"` SwapSize *big.Int `json:",string"` Targes []Address Time *big.Int // Provides information for TIME Description string }
Swap wacom
type Ticket ¶
type Ticket struct { ID Hash Owner Address Height *big.Int `json:",string"` StartTime uint64 ExpireTime uint64 Value *big.Int `json:",string"` // contains filtered or unexported fields }
Ticket wacom
type TicketSlice ¶
type TicketSlice []Ticket
func (TicketSlice) Add ¶
func (s TicketSlice) Add(ticket *Ticket) TicketSlice
func (TicketSlice) DeepCopy ¶
func (s TicketSlice) DeepCopy() TicketSlice
func (TicketSlice) Delete ¶
func (s TicketSlice) Delete(tid Hash) TicketSlice
func (TicketSlice) Len ¶
func (s TicketSlice) Len() int
func (TicketSlice) Less ¶
func (s TicketSlice) Less(i, j int) bool
func (TicketSlice) Swap ¶
func (s TicketSlice) Swap(i, j int)
func (TicketSlice) ToMap ¶
func (s TicketSlice) ToMap() map[Hash]Ticket
func (TicketSlice) ToTicketStructSlice ¶
func (s TicketSlice) ToTicketStructSlice() TicketStructSlice
type TicketStruct ¶
type TicketStructSlice ¶
type TicketStructSlice []TicketStruct
func (TicketStructSlice) ToTicketSlice ¶
func (s TicketStructSlice) ToTicketSlice() TicketSlice
type TimeLock ¶
type TimeLock struct { Items []*TimeLockItem // contains filtered or unexported fields }
///////////////////////////// TimeLock /////////////////////////// TimeLock wacom
func (*TimeLock) CheckValid ¶
func (z *TimeLock) CheckValid()
func (*TimeLock) ClearExpired ¶
func (*TimeLock) HasOnlyOneItem ¶
func (*TimeLock) IsNormalized ¶
use this special way to identify different TimeLock storage method after hard fork 4
type TimeLockItem ¶
TimeLockItem wacom
func (*TimeLockItem) Add ¶
func (z *TimeLockItem) Add(x *TimeLockItem) ([]*TimeLockItem, TailFlag)
func (*TimeLockItem) AdjustEnd ¶
func (z *TimeLockItem) AdjustEnd(endTime uint64) *TimeLockItem
func (*TimeLockItem) AdjustStart ¶
func (z *TimeLockItem) AdjustStart(startTime uint64) *TimeLockItem
func (*TimeLockItem) AdjustStartEnd ¶
func (z *TimeLockItem) AdjustStartEnd(startTime uint64, endTime uint64) *TimeLockItem
func (*TimeLockItem) CanMerge ¶
func (z *TimeLockItem) CanMerge(x *TimeLockItem) bool
func (*TimeLockItem) Clone ¶
func (z *TimeLockItem) Clone() *TimeLockItem
func (*TimeLockItem) EqualRange ¶
func (z *TimeLockItem) EqualRange(x *TimeLockItem) bool
func (*TimeLockItem) IsFlagTimeLockItem ¶
func (z *TimeLockItem) IsFlagTimeLockItem() bool
func (*TimeLockItem) IsValid ¶
func (z *TimeLockItem) IsValid() error
func (*TimeLockItem) MarshalJSON ¶
func (u *TimeLockItem) MarshalJSON() ([]byte, error)
func (*TimeLockItem) Merge ¶
func (z *TimeLockItem) Merge(x *TimeLockItem) *TimeLockItem
please ensure CanMerge condition is satisfied
func (*TimeLockItem) String ¶
func (z *TimeLockItem) String() string
func (*TimeLockItem) Sub ¶
func (z *TimeLockItem) Sub(x *TimeLockItem) ([]*TimeLockItem, *TimeLockItem)
func (*TimeLockItem) SubWithMissingValue ¶
func (z *TimeLockItem) SubWithMissingValue(x *TimeLockItem) (*big.Int, []*TimeLockItem)
type TimeLockParam ¶
type TimeLockParam struct { Type TimeLockType AssetID Hash To Address StartTime uint64 EndTime uint64 Value *big.Int `json:",string"` }
TimeLockParam wacom
type TimeLockType ¶
type TimeLockType uint
TimeLockType wacom
const ( AssetToTimeLock TimeLockType = iota TimeLockToTimeLock TimeLockToAsset )
TimeLockTypes wacom
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.
Source Files ¶
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 |
Package overflow offers overflow-checked integer arithmetic operations for int, int32, and int64.
|
Package overflow offers overflow-checked integer arithmetic operations for int, int32, and int64. |