common

package
v1.101.0 Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2022 License: MIT Imports: 45 Imported by: 45

Documentation

Index

Constants

View Source
const (
	NoAddress   = Address("")
	NoopAddress = Address("noop")
)
View Source
const (
	// BNBSymbol BNB
	BNBSymbol = Symbol("BNB")
	// Rune67CSymbol RUNE on binance testnet
	Rune67CSymbol = Symbol("RUNE-67C")
	// RuneB1ASymbol RUNE on binance mainnet
	RuneB1ASymbol = Symbol("RUNE-B1A")
)
View Source
const (
	// BNBTicker BNB
	BNBTicker = Ticker("BNB")
	// RuneTicker RUNE
	RuneTicker = Ticker("RUNE")
)
View Source
const One = 100000000

One is useful type so THORNode doesn't need to manage 8 zeroes all the time

View Source
const THORChainDecimals = 8

THORChainDecimals indicate the number of decimal points used in THORChain

Variables

View Source
var (
	// EmptyAsset empty asset, not valid
	EmptyAsset = Asset{Chain: EmptyChain, Symbol: "", Ticker: "", Synth: false}
	// LUNAAsset LUNA
	LUNAAsset = Asset{Chain: TERRAChain, Symbol: "LUNA", Ticker: "LUNA", Synth: false}
	// ATOMAsset ATOM
	ATOMAsset = Asset{Chain: GAIAChain, Symbol: "ATOM", Ticker: "ATOM", Synth: false}
	// BNBAsset BNB
	BNBAsset = Asset{Chain: BNBChain, Symbol: "BNB", Ticker: "BNB", Synth: false}
	// BTCAsset BTC
	BTCAsset = Asset{Chain: BTCChain, Symbol: "BTC", Ticker: "BTC", Synth: false}
	// LTCAsset BTC
	LTCAsset = Asset{Chain: LTCChain, Symbol: "LTC", Ticker: "LTC", Synth: false}
	// BCHAsset BCH
	BCHAsset = Asset{Chain: BCHChain, Symbol: "BCH", Ticker: "BCH", Synth: false}
	// DOGEAsset DOGE
	DOGEAsset = Asset{Chain: DOGEChain, Symbol: "DOGE", Ticker: "DOGE", Synth: false}
	// ETHAsset ETH
	ETHAsset = Asset{Chain: ETHChain, Symbol: "ETH", Ticker: "ETH", Synth: false}
	// AVAXAsset AVAX
	AVAXAsset = Asset{Chain: AVAXChain, Symbol: "AVAX", Ticker: "AVAX", Synth: false}
	// Rune67CAsset RUNE on Binance test net
	Rune67CAsset = Asset{Chain: BNBChain, Symbol: "RUNE-67C", Ticker: "RUNE", Synth: false} // testnet asset on binance ganges
	// RuneB1AAsset RUNE on Binance main net
	RuneB1AAsset = Asset{Chain: BNBChain, Symbol: "RUNE-B1A", Ticker: "RUNE", Synth: false} // mainnet
	// RuneNative RUNE on thorchain
	RuneNative            = Asset{Chain: THORChain, Symbol: "RUNE", Ticker: "RUNE", Synth: false}
	RuneERC20Asset        = Asset{Chain: ETHChain, Symbol: "RUNE-0x3155ba85d5f96b2d030a4966af206230e46849cb", Ticker: "RUNE", Synth: false}
	RuneERC20TestnetAsset = Asset{Chain: ETHChain, Symbol: "RUNE-0xd601c6A3a36721320573885A8d8420746dA3d7A0", Ticker: "RUNE", Synth: false}
)
View Source
var (
	EmptyChain = Chain("")
	BNBChain   = Chain("BNB")
	ETHChain   = Chain("ETH")
	BTCChain   = Chain("BTC")
	LTCChain   = Chain("LTC")
	BCHChain   = Chain("BCH")
	DOGEChain  = Chain("DOGE")
	THORChain  = Chain("THOR")
	TERRAChain = Chain("TERRA")
	GAIAChain  = Chain("GAIA")
	AVAXChain  = Chain("AVAX")

	SigningAlgoSecp256k1 = SigningAlgo("secp256k1")
	SigningAlgoEd25519   = SigningAlgo("ed25519")
)
View Source
var BNBGasFeeMulti = Gas{
	{Asset: BNBAsset, Amount: bnbMultiTxFee},
}

BNBGasFeeMulti gas fee for multi send

View Source
var BNBGasFeeSingleton = Gas{
	{Asset: BNBAsset, Amount: bnbSingleTxFee},
}

BNBGasFeeSingleton fee charged by Binance for transfer with a single coin

View Source
var BlankTxID = TxID("0000000000000000000000000000000000000000000000000000000000000000")

BlankTxID represent blank

View Source
var ETHGasFeeTransfer = Gas{
	{Asset: ETHAsset, Amount: ethTransferFee},
}

ETHGasFeeTransfer gas fee for ETH

View Source
var LatestVersion semver.Version = semver.MustParse("999.0.0")
View Source
var NoCoin = Coin{
	Asset:  EmptyAsset,
	Amount: cosmos.ZeroUint(),
}

NoCoin is empty Coin

Functions

func ConvertAndEncode

func ConvertAndEncode(hrp string, data []byte) (string, error)

ConvertAndEncode converts from a base64 encoded byte string to hex or base32 encoded byte string and then to bech32

func CosmosPrivateKeyToTMPrivateKey added in v0.41.0

func CosmosPrivateKeyToTMPrivateKey(privateKey cryptotypes.PrivKey) crypto.PrivKey

CosmosPrivateKeyToTMPrivateKey convert cosmos implementation of private key to tendermint private key

func Decrypt

func Decrypt(data []byte, passphrase string) ([]byte, error)

Decrypt the input data with passphrase

func Encrypt

func Encrypt(data []byte, passphrase string) ([]byte, error)

Encrypt the input data with passphrase

func GetSafeShare added in v0.63.0

func GetSafeShare(part, total, allocation cosmos.Uint) cosmos.Uint

GetSafeShare does the same as GetUncappedShare , but GetSafeShare will guarantee the result will not more than total

func GetUncappedShare added in v1.93.0

func GetUncappedShare(part, total, allocation cosmos.Uint) (share cosmos.Uint)

GetUncappedShare this method will panic if any of the input parameter can't be convert to cosmos.Dec which shouldn't happen

func RandStringBytesMask

func RandStringBytesMask(n int) string

RandStringBytesMask generate random string used for test purpose

func SafeSub

func SafeSub(input1, input2 cosmos.Uint) cosmos.Uint

SafeSub subtract input2 from input1, given cosmos.Uint can't be negative , otherwise it will panic thus in this method,when input2 is larger than input 1, it will just return cosmos.ZeroUint

func Sign added in v1.92.0

func Sign(buf []byte) ([]byte, []byte, error)

Sign an array of bytes. Returns (signature, pubkey, error)

func SignBase64 added in v1.92.0

func SignBase64(buf []byte) (string, string, error)

Types

type Account

type Account struct {
	Sequence      int64
	AccountNumber int64
	Coins         Coins
	HasMemoFlag   bool
}

Account define a struct to hold account information across all chain

func NewAccount

func NewAccount(sequence, accountNumber int64, coins Coins, hasMemoFlag bool) Account

NewAccount create a new instance of Account

type Address

type Address string

func ConvertToNewBCHAddressFormat added in v0.54.0

func ConvertToNewBCHAddressFormat(addr Address) (Address, error)

ConvertToNewBCHAddressFormat convert the given BCH to new address format

func ConvertToNewBCHAddressFormatV83 added in v1.83.0

func ConvertToNewBCHAddressFormatV83(addr Address) (Address, error)

ConvertToNewBCHAddressFormatV83 convert the given BCH to new address format

func NewAddress

func NewAddress(address string) (Address, error)

NewAddress create a new Address. Supports Binance, Bitcoin, and Ethereum

func (Address) AccAddress added in v0.41.0

func (addr Address) AccAddress() (cosmos.AccAddress, error)

func (Address) Equals

func (addr Address) Equals(addr2 Address) bool

func (Address) GetChain added in v0.41.0

func (addr Address) GetChain() Chain

Note that this will always return ETHChain for an AVAXChain address, so perhaps only use it when determining a network (e.g. mainnet/testnet).

func (Address) GetNetwork added in v0.54.0

func (addr Address) GetNetwork(ver semver.Version, chain Chain) ChainNetwork

func (Address) IsChain

func (addr Address) IsChain(chain Chain) bool

Note that this can have false positives, such as being unable to distinguish between ETH and AVAX.

func (Address) IsEmpty

func (addr Address) IsEmpty() bool

func (Address) IsNoop added in v1.93.0

func (addr Address) IsNoop() bool

func (Address) IsValidBCHAddress added in v0.54.0

func (addr Address) IsValidBCHAddress() bool

IsValidBCHAddress determinate whether the address is a valid new BCH address format

func (Address) String

func (addr Address) String() string

type Chain

type Chain string

Chain is an alias of string , represent a block chain

func GetEVMChains added in v1.95.0

func GetEVMChains() []Chain

GetEVMChains returns all "EVM" chains connected to THORChain "EVM" is defined, in thornode's context, as a chain that: - uses 0x as an address prefix - has a "Router" Smart Contract

func NewChain

func NewChain(chainID string) (Chain, error)

NewChain create a new Chain and default the siging_algo to Secp256k1

func (Chain) AddressPrefix

func (c Chain) AddressPrefix(cn ChainNetwork) string

AddressPrefix return the address prefix used by the given network (testnet/mainnet)

func (Chain) ApproximateBlockMilliseconds added in v1.99.0

func (c Chain) ApproximateBlockMilliseconds() int64

func (Chain) DefaultCoinbase added in v1.99.0

func (c Chain) DefaultCoinbase() float64

DefaultCoinbase returns the default coinbase address for each chain, returns 0 if no coinbase emission is used. This is used used at the time of writing as a fallback value in Bifrost, and for inbound confirmation count estimates in the quote APIs.

func (Chain) DustThreshold added in v1.99.0

func (c Chain) DustThreshold() cosmos.Uint

DustThreshold returns the min dust threshold for each chain The min dust threshold defines the lower end of the withdraw range of memoless savers txs The native coin value provided in a memoless tx defines a basis points amount of Withdraw or Add to a savers position as follows: Withdraw range: (dust_threshold + 1) -> (dust_threshold + 10_000) Add range: dust_threshold -> Inf NOTE: these should all be in 8 decimal places

func (Chain) Equals

func (c Chain) Equals(c2 Chain) bool

Equals compare two chain to see whether they represent the same chain

func (Chain) GetGasAsset

func (c Chain) GetGasAsset() Asset

GetGasAsset chain's base asset

func (Chain) GetGasAssetDecimal added in v0.80.0

func (c Chain) GetGasAssetDecimal() int64

GetGasAssetDecimal for the gas asset of given chain , what kind of precision it is using TERRA and GAIA are using 1E6, all other gas asset so far using 1E8 THORChain is using 1E8, if an external chain's gas asset is larger than 1E8, just return cosmos.DefaultCoinDecimals

func (Chain) GetGasUnits added in v1.97.0

func (c Chain) GetGasUnits() string

GetGasUnits returns name of the gas unit for each chain

func (Chain) GetSigningAlgo

func (c Chain) GetSigningAlgo() SigningAlgo

GetSigningAlgo get the signing algorithm for the given chain

func (Chain) IsBNB

func (c Chain) IsBNB() bool

IsBNB determinate whether it is BNBChain

func (Chain) IsEVM added in v1.95.0

func (c Chain) IsEVM() bool

IsEVM returns true if given chain is an EVM chain. See working definition of an "EVM" chain in the `GetEVMChains` function description

func (Chain) IsEmpty

func (c Chain) IsEmpty() bool

IsEmpty is to determinate whether the chain is empty

func (Chain) IsTHORChain added in v0.41.0

func (c Chain) IsTHORChain() bool

func (Chain) IsValidAddress added in v0.54.0

func (c Chain) IsValidAddress(addr Address) bool

IsValidAddress make sure the address is correct for the chain And this also make sure testnet doesn't use mainnet address vice versa

func (Chain) MaxMemoLength added in v1.99.0

func (c Chain) MaxMemoLength() int

MaxMemoLength returns the max memo length for each chain. Returns 0 if no max is configured.

func (Chain) String

func (c Chain) String() string

String implement fmt.Stringer

func (Chain) Validate

func (c Chain) Validate() error

Validate validates chain format, should consist only of uppercase letters

type ChainNetwork

type ChainNetwork uint8

ChainNetwork is to indicate which chain environment THORNode are working with

const (
	// TestNet network for test
	TestNet ChainNetwork = iota
	// MainNet network for main net
	MainNet
	// MockNet network for main net
	MockNet
	// Stagenet network for stage net
	StageNet
)

func GetCurrentChainNetwork

func GetCurrentChainNetwork() ChainNetwork

GetCurrentChainNetwork determinate what kind of network currently it is working with

func (ChainNetwork) SoftEquals added in v0.54.0

func (net ChainNetwork) SoftEquals(net2 ChainNetwork) bool

Soft Equals check is mainnet == mainet, or (testnet/mocknet == testnet/mocknet)

type ChainPoolInfo

type ChainPoolInfo struct {
	Chain       Chain   `json:"chain"`
	PubKey      PubKey  `json:"pub_key"`
	PoolAddress Address `json:"pool_address"`
}

ChainPoolInfo represent the pool address specific for a chain

var EmptyChainPoolInfo ChainPoolInfo

EmptyChainPoolInfo everything is empty

func NewChainPoolInfo

func NewChainPoolInfo(chain Chain, pubKey PubKey) (ChainPoolInfo, error)

NewChainPoolInfo create a new instance of ChainPoolInfo

func (ChainPoolInfo) IsEmpty

func (cpi ChainPoolInfo) IsEmpty() bool

IsEmpty whether the struct is empty

type Chains

type Chains []Chain

Chains represent a slice of Chain

func (Chains) Distinct

func (chains Chains) Distinct() Chains

Distinct return a distinct set of chains, no duplicates

func (Chains) Has

func (chains Chains) Has(c Chain) bool

Has check whether chain c is in the list

func (Chains) Strings added in v0.41.0

func (chains Chains) Strings() []string

type Coins

type Coins []Coin

Coins represent a slice of Coin

func GetCoins

func GetCoins(chain Chain, accCoins []types.Coin) (Coins, error)

GetCoins transforms from binance coins

func NewCoins added in v0.41.0

func NewCoins(coins ...Coin) Coins

NewCoins create a new Coins structure

func (Coins) Add added in v0.41.0

func (cs Coins) Add(coin Coin) Coins

func (Coins) Adds added in v0.41.0

func (cs Coins) Adds(coins Coins) Coins

This overwrites cs by changing its slice-referenced values, so it is recommended to use destination := make(Coins, len(source)) and copy(destination, source) first.

func (Coins) Contains

func (cs Coins) Contains(c Coin) bool

Contains check whether the given coin is in the list

func (Coins) Distinct added in v0.41.0

func (cs Coins) Distinct() Coins

Distinct return a new Coins ,which duplicated coins had been removed

func (Coins) Equals

func (cs Coins) Equals(cs2 Coins) bool

Equals Check if two lists of coins are equal to each other. Order does not matter This method has side effect because it uses sort.Slice on the input parameter which will potentially change the order of cs1 & cs2 Note: quite a few places already using this method , which can't be changed, otherwise it will cause consensus failure on CHAOSNET Deprecated

func (Coins) EqualsEx added in v0.65.0

func (cs Coins) EqualsEx(cs2 Coins) bool

EqualsEx Check if two lists of coins are equal to each other. This method will make a copy of cs1 & cs2 , thus the original coins order will not be changed

func (Coins) GetCoin

func (cs Coins) GetCoin(asset Asset) Coin

GetCoin gets a specific coin by asset. Assumes there is only one of this coin in the list.

func (Coins) HasNoneNativeRune added in v0.41.0

func (cs Coins) HasNoneNativeRune() bool

HasNoneNativeRune check whether the coins contains NoneNativeRUNE

At the moment, there are BEP2 RUNE, ERC20 RUNE and Native RUNE

func (Coins) HasSynthetic added in v0.55.0

func (cs Coins) HasSynthetic() bool

HasSynthetic check whether the coins contains synth coin

func (Coins) IsEmpty

func (cs Coins) IsEmpty() bool

func (Coins) Native

func (cs Coins) Native() (cosmos.Coins, error)

func (Coins) NoneEmpty added in v0.54.0

func (cs Coins) NoneEmpty() Coins

NoneEmpty return a new Coins , which ignore the coin that is empty either Coin asset is empty or amount is empty

func (Coins) String

func (cs Coins) String() string

String implement fmt.Stringer

func (Coins) Valid

func (cs Coins) Valid() error

Valid check whether all the coins are valid , if not , then return an error

type Duration

type Duration struct {
	time.Duration
}

Duration embedded time.Duration so THORNode could use string to represent duration in json file for example ,1s ,1h , 5m etc

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

MarshalJSON marshal the duration to json string

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

UnmarshalJSON convert the json value back to time.Duration

type Gas

type Gas Coins

Gas coins

func CalcBinanceGasPrice

func CalcBinanceGasPrice(tx Tx, asset Asset, units []cosmos.Uint) Gas

CalcBinanceGasPrice calculate gas price for Binance chain

func GetAVAXGasFee added in v1.95.0

func GetAVAXGasFee(gasPrice *big.Int, msgLen uint64) Gas

GetAVAXGasFee return the gas for AVAX

func GetETHGasFee

func GetETHGasFee(gasPrice *big.Int, msgLen uint64) Gas

GetETHGasFee return the gas for ETH

func MakeAVAXGas added in v1.95.0

func MakeAVAXGas(gasPrice *big.Int, gas uint64) Gas

MakeAVAXGas return the gas for AVAX

func MakeETHGas

func MakeETHGas(gasPrice *big.Int, gas uint64) Gas

MakeETHGas return the gas for ETH

func (Gas) Add

func (g Gas) Add(g2 Gas) Gas

Add combines two gas objects into one, adding amounts where needed or appending new coins.

func (Gas) Equals

func (g Gas) Equals(gas2 Gas) bool

Equals Check if two lists of coins are equal to each other. Order does not matter

func (Gas) IsEmpty

func (g Gas) IsEmpty() bool

IsEmpty return true as long as there is one coin in it that is not empty

func (Gas) Sub added in v0.41.0

func (g Gas) Sub(g2 Gas) Gas

Sub subtract the given amount gas from existing gas object

func (Gas) ToCoins

func (g Gas) ToCoins() Coins

ToCoins convert the gas to Coins

func (Gas) Valid

func (g Gas) Valid() error

Valid return nil when it is valid, otherwise return an error

type NodeRelay added in v0.65.0

type NodeRelay struct {
	Msg       NodeRelayMsg `json:"msg"`
	Signature string       `json:"signature"`
	PubKey    string       `json:"pubkey"`
}

func NewNodeRelay added in v0.65.0

func NewNodeRelay(channel, text string) *NodeRelay

func (*NodeRelay) Broadcast added in v0.65.0

func (n *NodeRelay) Broadcast() (string, error)

func (*NodeRelay) Prepare added in v0.65.0

func (n *NodeRelay) Prepare() error

type NodeRelayMsg added in v0.65.0

type NodeRelayMsg struct {
	Text    string `json:"text"`
	Channel string `json:"channel"`
	UUID    string `json:"uuid"`
}

type PubKey

type PubKey string

PubKey used in thorchain, it should be bech32 encoded string thus it will be something like tthorpub1addwnpepqt7qug8vk9r3saw8n4r803ydj2g3dqwx0mvq5akhnze86fc536xcycgtrnv tthorpub1addwnpepqdqvd4r84lq9m54m5kk9sf4k6kdgavvch723pcgadulxd6ey9u70k6zq8qe

var EmptyPubKey PubKey

func NewPubKey

func NewPubKey(key string) (PubKey, error)

NewPubKey create a new instance of PubKey key is bech32 encoded string

func NewPubKeyFromCrypto

func NewPubKeyFromCrypto(pk crypto.PubKey) (PubKey, error)

NewPubKeyFromCrypto

func (PubKey) EVMPubkeyToAddress added in v1.95.0

func (pubKey PubKey) EVMPubkeyToAddress() (Address, error)

EVMPubkeyToAddress converts a pubkey of an EVM chain to the corresponding address

func (PubKey) Equals

func (pubKey PubKey) Equals(pubKey1 PubKey) bool

Equals check whether two are the same

func (PubKey) GetAddress

func (pubKey PubKey) GetAddress(chain Chain) (Address, error)

GetAddress will return an address for the given chain

func (PubKey) GetThorAddress

func (pubKey PubKey) GetThorAddress() (cosmos.AccAddress, error)

func (PubKey) IsEmpty

func (pubKey PubKey) IsEmpty() bool

IsEmpty to check whether it is empty

func (PubKey) MarshalJSON

func (pubKey PubKey) MarshalJSON() ([]byte, error)

MarshalJSON to Marshals to JSON using Bech32

func (PubKey) String

func (pubKey PubKey) String() string

String stringer implementation

func (*PubKey) UnmarshalJSON

func (pubKey *PubKey) UnmarshalJSON(data []byte) error

UnmarshalJSON to Unmarshal from JSON assuming Bech32 encoding

type PubKeys

type PubKeys []PubKey

PubKey used in thorchain, it should be bech32 encoded string thus it will be something like tthorpub1addwnpepqt7qug8vk9r3saw8n4r803ydj2g3dqwx0mvq5akhnze86fc536xcycgtrnv tthorpub1addwnpepqdqvd4r84lq9m54m5kk9sf4k6kdgavvch723pcgadulxd6ey9u70k6zq8qe

func (PubKeys) Contains

func (pks PubKeys) Contains(pk PubKey) bool

func (PubKeys) Equals added in v0.68.0

func (pks PubKeys) Equals(newPks PubKeys) bool

Equals check whether two pub keys are identical

func (PubKeys) String

func (pks PubKeys) String() string

String implement stringer interface

func (PubKeys) Strings added in v0.41.0

func (pks PubKeys) Strings() []string

func (PubKeys) Valid

func (pks PubKeys) Valid() error

type SigningAlgo added in v1.83.0

type SigningAlgo string

type Symbol

type Symbol string

Symbol represent an asset

func NewSymbol

func NewSymbol(input string) (Symbol, error)

NewSymbol parse the input as symbol

func (Symbol) Equals

func (s Symbol) Equals(s2 Symbol) bool

Equals check whether two symbol are the same

func (Symbol) IsEmpty

func (s Symbol) IsEmpty() bool

IsEmpty return true when symbol is just empty string

func (Symbol) IsMiniToken

func (s Symbol) IsMiniToken() bool

IsMiniToken is to determine whether it is a mini token on binance chain

func (Symbol) String

func (s Symbol) String() string

String implement fmt.Stringer

func (Symbol) Ticker

func (s Symbol) Ticker() Ticker

Ticker return the ticker part of symbol

type Ticker

type Ticker string

Ticker The trading 'symbol' or shortened name (typically in capital letters) that refer to a coin on a trading platform. For example: BNB

func NewTicker

func NewTicker(ticker string) (Ticker, error)

NewTicker parse the given string as ticker, return error if it is not legitimate ticker

func (Ticker) Equals

func (t Ticker) Equals(t2 Ticker) bool

Equals compare whether two ticker is the same

func (Ticker) IsEmpty

func (t Ticker) IsEmpty() bool

IsEmpty return true when the ticker is an empty string

func (Ticker) String

func (t Ticker) String() string

String implement fmt.Stringer

type Tickers

type Tickers []Ticker

Tickers a list of ticker

type TxID

type TxID string

TxID is a string that can uniquely represent a transaction on different block chain

func NewTxID

func NewTxID(hash string) (TxID, error)

NewTxID parse the input hash as TxID

func (TxID) Equals

func (tx TxID) Equals(tx2 TxID) bool

Equals check whether two TxID are the same

func (TxID) IsEmpty

func (tx TxID) IsEmpty() bool

IsEmpty return true when the tx represent empty string

func (TxID) String

func (tx TxID) String() string

String implement fmt.Stringer

type TxIDs

type TxIDs []TxID

TxIDs is a slice of TxID

type Txs

type Txs []Tx

Txs a list of Tx

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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