Documentation ¶
Index ¶
- Constants
- Variables
- func BEP2RuneAsset() Asset
- func (pks PubKeySet) Contains(pk PubKey) bool
- func ConvertAndEncode(hrp string, data []byte) (string, error)
- func CosmosPrivateKeyToTMPrivateKey(privateKey cryptotypes.PrivKey) crypto.PrivKey
- func Decrypt(data []byte, passphrase string) ([]byte, error)
- func ERC20RuneAsset() Asset
- func Encrypt(data []byte, passphrase string) ([]byte, error)
- func Entropy(b []byte) float64
- func (c Coin) Equals(cc Coin) bool
- func (tx Tx) EqualsEx(tx2 Tx) bool
- func (pks PubKeySet) GetAddress(chain Chain) (Address, error)
- func (a Asset) GetChain() Chain
- func (a Asset) GetDerivedAsset() Asset
- func (a Asset) GetLayer1Asset() Asset
- func GetMedianUint(vals []cosmos.Uint) cosmos.Uint
- func GetRagnarokTx(chain Chain, fromAddr, toAddr Address) Tx
- func GetSafeShare(part, total, allocation cosmos.Uint) cosmos.Uint
- func (a Asset) GetSyntheticAsset() Asset
- func GetUncappedShare(part, total, allocation cosmos.Uint) (share cosmos.Uint)
- func (tx Tx) Hash() string
- func (a Asset) IsBNB() bool
- func (a Asset) IsDerivedAsset() bool
- func (c Coin) IsEmpty() bool
- func (a Asset) IsGasAsset() bool
- func (c Coin) IsNative() bool
- func (a Asset) IsNativeRune() bool
- func (a Asset) IsRune() bool
- func (a Asset) IsSyntheticAsset() bool
- func (a Asset) IsVaultAsset() bool
- func (a Asset) MarshalJSON() ([]byte, error)
- func (a Asset) MarshalJSONPB(*jsonpb.Marshaler) ([]byte, error)
- func (a Asset) MimirString() string
- func (c Coin) Native() (cosmos.Coin, error)
- func NewAsset(input string) (Asset, error)
- func NewCoin(asset Asset, amount cosmos.Uint) Coin
- func NewFee(coins Coins, poolDeduct cosmos.Uint) Fee
- func NewPubKeySet(secp256k1, ed25519 PubKey) PubKeySet
- func NewTx(txID TxID, from, to Address, coins Coins, gas Gas, memo string) Tx
- func ParseCoin(coinStr string) (Coin, error)
- func RandStringBytesMask(n int) string
- func RuneAsset() Asset
- func SafeSub(input1, input2 cosmos.Uint) cosmos.Uint
- func Sign(buf []byte) ([]byte, []byte, error)
- func SignBase64(buf []byte) (string, string, error)
- func (f Fee) String() string
- func (tx Tx) ToAttributes() []cosmos.Attribute
- func (a *Asset) UnmarshalJSON(data []byte) error
- func (a *Asset) UnmarshalJSONPB(unmarshal *jsonpb.Unmarshaler, content []byte) error
- func (c Coin) Valid() error
- func (c Coin) WithDecimals(decimal int64) Coin
- type Account
- type Address
- func (addr Address) AccAddress() (cosmos.AccAddress, error)
- func (addr Address) Equals(addr2 Address) bool
- func (addr Address) GetChain() Chain
- func (addr Address) GetNetwork(ver semver.Version, chain Chain) ChainNetwork
- func (addr Address) IsChain(chain Chain) bool
- func (addr Address) IsEmpty() bool
- func (addr Address) IsNoop() bool
- func (addr Address) IsValidBCHAddress() bool
- func (addr Address) String() string
- type AddressSuite
- type Chain
- func (c Chain) AddressPrefix(cn ChainNetwork) string
- func (c Chain) ApproximateBlockMilliseconds() int64
- func (c Chain) DefaultCoinbase() float64
- func (c Chain) DustThreshold() cosmos.Uint
- func (c Chain) Equals(c2 Chain) bool
- func (c Chain) GetGasAsset() Asset
- func (c Chain) GetGasAssetDecimal() int64
- func (c Chain) GetGasUnits() string
- func (c Chain) GetSigningAlgo() SigningAlgo
- func (c Chain) InboundNotes() string
- func (c Chain) IsBNB() bool
- func (c Chain) IsEVM() bool
- func (c Chain) IsEmpty() bool
- func (c Chain) IsTHORChain() bool
- func (c Chain) IsUTXO() bool
- func (c Chain) IsValidAddress(addr Address) bool
- func (c Chain) MaxMemoLength() int
- func (c Chain) String() string
- func (c Chain) Validate() error
- type ChainNetwork
- type ChainPoolInfo
- type Chains
- type Coins
- func (cs Coins) Add(coin Coin) Coins
- func (cs Coins) Adds(coins Coins) Coins
- func (cs Coins) Contains(c Coin) bool
- func (cs Coins) Distinct() Coins
- func (cs Coins) Equals(cs2 Coins) bool
- func (cs Coins) EqualsEx(cs2 Coins) bool
- func (cs Coins) GetCoin(asset Asset) Coin
- func (cs Coins) HasNoneNativeRune() bool
- func (cs Coins) HasSynthetic() bool
- func (cs Coins) IsEmpty() bool
- func (cs Coins) Native() (cosmos.Coins, error)
- func (cs Coins) NoneEmpty() Coins
- func (cs Coins) SafeSub(coin Coin) Coins
- func (cs Coins) String() string
- func (cs Coins) Valid() error
- type Duration
- type Gas
- type PubKey
- func (pubKey PubKey) EVMPubkeyToAddress() (Address, error)
- func (pubKey PubKey) Equals(pubKey1 PubKey) bool
- func (pubKey PubKey) GetAddress(chain Chain) (Address, error)
- func (pubKey PubKey) GetThorAddress() (cosmos.AccAddress, error)
- func (pubKey PubKey) IsEmpty() bool
- func (pubKey PubKey) MarshalJSON() ([]byte, error)
- func (pubKey PubKey) String() string
- func (pubKey *PubKey) UnmarshalJSON(data []byte) error
- type PubKeys
- type SigningAlgo
- type Symbol
- type Ticker
- type Tickers
- type TxID
- type TxIDs
- type Txs
Constants ¶
const ( NoAddress = Address("") NoopAddress = Address("noop") )
const ( EmptyChain = Chain("") BNBChain = Chain("BNB") BSCChain = Chain("BSC") 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") )
const ( // BNBSymbol BNB BNBSymbol = Symbol("BNB") // Rune67CSymbol RUNE on binance testnet Rune67CSymbol = Symbol("RUNE-67C") // RuneB1ASymbol RUNE on binance mainnet RuneB1ASymbol = Symbol("RUNE-B1A") )
const ( // BNBTicker BNB BNBTicker = Ticker("BNB") // RuneTicker RUNE RuneTicker = Ticker("RUNE") )
const CurrentChainNetwork = MainNet
const One = 100000000
One is useful type so DDNode doesn't need to manage 8 zeroes all the time
const THORChainDecimals = 8
THORChainDecimals indicate the number of decimal points used in THORChain
Variables ¶
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} // BNBBEP20Asset BNB BNBBEP20Asset = Asset{Chain: BSCChain, 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} TOR = Asset{Chain: THORChain, Symbol: "TOR", Ticker: "TOR", Synth: false} THORBTC = Asset{Chain: THORChain, Symbol: "BTC", Ticker: "BTC", Synth: false} )
var AllChains = [...]Chain{ BNBChain, BSCChain, ETHChain, BTCChain, LTCChain, BCHChain, DOGEChain, THORChain, TERRAChain, GAIAChain, AVAXChain, }
var BNBGasFeeMulti = Gas{ {Asset: BNBAsset, Amount: bnbMultiTxFee}, }
BNBGasFeeMulti gas fee for multi send
var BNBGasFeeSingleton = Gas{ {Asset: BNBAsset, Amount: bnbSingleTxFee}, }
BNBGasFeeSingleton fee charged by Binance for transfer with a single coin
var BlankTxID = TxID("0000000000000000000000000000000000000000000000000000000000000000")
BlankTxID represent blank
var EmptyPubKeySet PubKeySet
var LatestVersion semver.Version = semver.MustParse("999.0.0")
var NoCoin = Coin{ Asset: EmptyAsset, Amount: cosmos.ZeroUint(), }
NoCoin is empty Coin
Functions ¶
func ConvertAndEncode ¶
ConvertAndEncode converts from a base64 encoded byte string to hex or base32 encoded byte string and then to bech32
func CosmosPrivateKeyToTMPrivateKey ¶
func CosmosPrivateKeyToTMPrivateKey(privateKey cryptotypes.PrivKey) crypto.PrivKey
CosmosPrivateKeyToTMPrivateKey convert cosmos implementation of private key to tendermint private key
func (Coin) Equals ¶
func (c Coin) Equals(cc Coin) bool
Equals compare two coins to see whether they represent the same information
func (Tx) EqualsEx ¶
func (tx Tx) EqualsEx(tx2 Tx) bool
EqualsEx compare two Tx to see whether they represent the same Tx This method will not change the original tx & tx2
func (PubKeySet) GetAddress ¶
GetAddress
func GetRagnarokTx ¶
GetRagnarokTx return a tx used for ragnarok
func GetSafeShare ¶
GetSafeShare does the same as GetUncappedShare , but GetSafeShare will guarantee the result will not more than total
func (Asset) GetSyntheticAsset ¶
func (a Asset) GetSyntheticAsset() Asset
Get synthetic asset of asset
func GetUncappedShare ¶
GetUncappedShare this method will panic if any of the input parameter can't be convert to cosmos.Dec which shouldn't happen
func (Tx) Hash ¶
func (tx Tx) Hash() string
Hash calculate a hash based on from address, coins and to address
func (Asset) IsBNB ¶
func (a Asset) IsBNB() bool
IsBNB is a helper function, return true only when the asset represent BNB
func (Asset) IsDerivedAsset ¶
func (a Asset) IsDerivedAsset() bool
Check if asset is a derived asset
func (Coin) IsEmpty ¶
func (c Coin) IsEmpty() bool
IsEmpty check whether asset is empty and also amount is zero
func (Asset) IsGasAsset ¶
func (a Asset) IsGasAsset() bool
IsGasAsset check whether asset is base asset used to pay for gas
func (Coin) IsNative ¶
func (c Coin) IsNative() bool
IsNative check whether the coin is native on THORChain
func (Asset) IsNativeRune ¶
func (a Asset) IsNativeRune() bool
IsNativeRune is a helper function, return true only when the asset represent NATIVE RUNE
func (Asset) IsRune ¶
func (a Asset) IsRune() bool
IsRune is a helper function ,return true only when the asset represent RUNE
func (Asset) IsSyntheticAsset ¶
func (a Asset) IsSyntheticAsset() bool
Check if asset is a pegged asset
func (Asset) IsVaultAsset ¶
func (a Asset) IsVaultAsset() bool
func (Asset) MarshalJSON ¶
MarshalJSON implement Marshaler interface
func (Asset) MarshalJSONPB ¶
MarshalJSONPB implement jsonpb.Marshaler
func (Asset) MimirString ¶
func (a Asset) MimirString() string
Replace pool name "." with a "-" for Mimir key checking.
func NewPubKeySet ¶
func NewPubKeySet(secp256k1, ed25519 PubKey) PubKeySet
NewPubKeySet create a new instance of PubKeySet , which contains two keys
func RandStringBytesMask ¶
RandStringBytesMask generate random string used for test purpose
func RuneAsset ¶
func RuneAsset() Asset
RuneAsset return RUNE Asset depends on different environment
func SafeSub ¶
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 (Tx) ToAttributes ¶
ToAttributes push all the tx fields into a slice of cosmos Attribute(key value pairs)
func (*Asset) UnmarshalJSON ¶
UnmarshalJSON implement Unmarshaler interface
func (*Asset) UnmarshalJSONPB ¶
func (a *Asset) UnmarshalJSONPB(unmarshal *jsonpb.Unmarshaler, content []byte) error
UnmarshalJSONPB implement jsonpb.Unmarshaler
func (Coin) WithDecimals ¶
func (c Coin) WithDecimals(decimal int64) Coin
WithDecimals update coin with a decimal
Types ¶
type Address ¶
type Address string
func ConvertToNewBCHAddressFormat ¶
ConvertToNewBCHAddressFormat convert the given BCH to new address format
func ConvertToNewBCHAddressFormatV83 ¶
ConvertToNewBCHAddressFormatV83 convert the given BCH to new address format
func NewAddress ¶
NewAddress create a new Address. Supports Binance, Bitcoin, and Ethereum
func (Address) AccAddress ¶
func (addr Address) AccAddress() (cosmos.AccAddress, error)
func (Address) GetChain ¶
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 ¶
func (addr Address) GetNetwork(ver semver.Version, chain Chain) ChainNetwork
func (Address) IsChain ¶
Note that this can have false positives, such as being unable to distinguish between ETH and AVAX.
func (Address) IsValidBCHAddress ¶
IsValidBCHAddress determinate whether the address is a valid new BCH address format
type AddressSuite ¶
type AddressSuite struct{}
func (*AddressSuite) TestAddress ¶
func (s *AddressSuite) TestAddress(c *C)
func (*AddressSuite) TestConvertToNewBCHAddressFormat ¶
func (s *AddressSuite) TestConvertToNewBCHAddressFormat(c *C)
type Chain ¶
type Chain string
func GetEVMChains ¶
func GetEVMChains() []Chain
GetEVMChains returns all "EVM" chains connected to THORChain "EVM" is defined, in ddnode's context, as a chain that: - uses 0x as an address prefix - has a "Router" Smart Contract
func GetUTXOChains ¶
func GetUTXOChains() []Chain
GetUTXOChains returns all "UTXO" chains connected to THORChain.
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 ¶
func (Chain) DefaultCoinbase ¶
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 ¶
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) GetGasAssetDecimal ¶
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 ¶
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) InboundNotes ¶
func (Chain) IsEVM ¶
IsEVM returns true if given chain is an EVM chain. See working definition of an "EVM" chain in the `GetEVMChains` function description
func (Chain) IsTHORChain ¶
func (Chain) IsValidAddress ¶
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 ¶
MaxMemoLength returns the max memo length for each chain. Returns 0 if no max is configured.
type ChainNetwork ¶
type ChainNetwork uint8
ChainNetwork is to indicate which chain environment DDNode 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 (ChainNetwork) SoftEquals ¶
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
type Coins ¶
type Coins []Coin
Coins represent a slice of Coin
func (Coins) Adds ¶
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) Equals ¶
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 ¶
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 ¶
HasNoneNativeRune check whether the coins contains NoneNativeRUNE
At the moment, there are BEP2 RUNE, ERC20 RUNE and Native RUNE
func (Coins) HasSynthetic ¶
HasSynthetic check whether the coins contains synth coin
type Duration ¶
Duration embedded time.Duration so DDNode could use string to represent duration in json file for example ,1s ,1h , 5m etc
func (Duration) MarshalJSON ¶
MarshalJSON marshal the duration to json string
func (*Duration) UnmarshalJSON ¶
UnmarshalJSON convert the json value back to time.Duration
type Gas ¶
type Gas Coins
Gas coins
func CalcBinanceGasPrice ¶
CalcBinanceGasPrice calculate gas price for Binance chain
func (Gas) Add ¶
Add combines two gas objects into one, adding amounts where needed or appending new coins.
func (Gas) Equals ¶
Equals Check if two lists of coins are equal to each other. Order does not matter
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 NewPubKeyFromCrypto ¶
NewPubKeyFromCrypto
func (PubKey) EVMPubkeyToAddress ¶
EVMPubkeyToAddress converts a pubkey of an EVM chain to the corresponding address
func (PubKey) GetAddress ¶
GetAddress will return an address for the given chain
func (PubKey) GetThorAddress ¶
func (pubKey PubKey) GetThorAddress() (cosmos.AccAddress, error)
func (PubKey) MarshalJSON ¶
MarshalJSON to Marshals to JSON using Bech32
func (*PubKey) UnmarshalJSON ¶
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
type SigningAlgo ¶
type SigningAlgo string
type Symbol ¶
type Symbol string
Symbol represent an asset
func (Symbol) IsMiniToken ¶
IsMiniToken is to determine whether it is a mini token on binance chain
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 ¶
NewTicker parse the given string as ticker, return error if it is not legitimate ticker