common

README

Common

Common types of assets for a blockchain.

Testing

make test 
make test-watch

Linting

make lint

Documentation

Index

• Constants
• func AmountToUint(amount Amount) sdk.Uint
• func FloatToUint(input float64) sdk.Uint
• func FloatToUintAndMultipleOne(input float64) sdk.Uint
• func IntToInt64(input sdk.Int) int64
• func IntToUint64(input sdk.Int) uint64
• func IsBNB(ticker Ticker) bool
• func IsBNBChain(c Chain) bool
• func IsRune(ticker Ticker) bool
• func UintToFloat64(input sdk.Uint) float64
• func UintToUint64(input sdk.Uint) uint64
• type Address
  • func NewAddress(address string) (Address, error)
  • func (addr Address) Equals(addr2 Address) bool
  • func (addr Address) IsChain(chain Chain) bool
  • func (addr Address) IsEmpty() bool
  • func (addr Address) String() string
• type Amount
  • func NewAmount(amount string) (Amount, error)
  • func NewAmountFromFloat(f float64) Amount
  • func UintToAmount(input sdk.Uint) Amount
  • func (a Amount) Equals(a2 Amount) bool
  • func (a Amount) Float64() float64
  • func (a Amount) GreaterThen(f float64) bool
  • func (a Amount) IsEmpty() bool
  • func (a Amount) IsNegative() bool
  • func (a Amount) IsZero() bool
  • func (a Amount) LessThen(f float64) bool
  • func (a Amount) Minus(a2 Amount) Amount
  • func (a Amount) Plus(a2 Amount) Amount
  • func (a Amount) String() string
• type Chain
  • func NewChain(chain string) (Chain, error)
  • func (c Chain) Equals(c2 Chain) bool
  • func (c Chain) IsEmpty() bool
  • func (c Chain) String() string
• type Coin
  • func NewCoin(chain Chain, denom Ticker, amount sdk.Uint) Coin
  • func (c Coin) Valid() error
• type Coins
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) UnmarshalJSON(b []byte) error
• type Ticker
  • func NewTicker(ticker string) (Ticker, error)
  • func (t Ticker) Equals(t2 Ticker) bool
  • func (t Ticker) IsEmpty() bool
  • func (t Ticker) String() string
• type Tickers
• type TxID
  • func NewTxID(hash string) (TxID, error)
  • func (tx TxID) Equals(tx2 TxID) bool
  • func (tx TxID) IsEmpty() bool
  • func (tx TxID) String() string
• type TxIDs

Constants

const (
	BNBChain = Chain("BNB")
	ETHChain = Chain("ETH")
	BTCChain = Chain("BTC")
)

const (
	BNBTicker     = Ticker("BNB")
	RuneTicker    = Ticker("RUNE")
	RuneA1FTicker = Ticker("RUNE-A1F")
	RuneB1ATicker = Ticker("RUNE-B1A")
)

const One = 100000000

One is useful type so we don't need to type 8 zero all the time

Functions

func AmountToUint

func AmountToUint(amount Amount) sdk.Uint

func FloatToUint

func FloatToUint(input float64) sdk.Uint

func FloatToUintAndMultipleOne

func FloatToUintAndMultipleOne(input float64) sdk.Uint

func IntToInt64

func IntToInt64(input sdk.Int) int64

func IntToUint64

func IntToUint64(input sdk.Int) uint64

func IsBNB

func IsBNB(ticker Ticker) bool

func IsBNBChain

func IsBNBChain(c Chain) bool

func IsRune

func IsRune(ticker Ticker) bool

func UintToFloat64

func UintToFloat64(input sdk.Uint) float64

UintToFloat64

func UintToUint64

func UintToUint64(input sdk.Uint) uint64

UintToUint64

Types

type Address

type Address string

var NoAddress Address = Address("")

func NewAddress

func NewAddress(address string) (Address, error)

NewAddress create a new Address Sample: bnb1lejrrtta9cgr49fuh7ktu3sddhe0ff7wenlpn6

func (Address) Equals

func (addr Address) Equals(addr2 Address) bool

func (Address) IsChain

func (addr Address) IsChain(chain Chain) bool

func (Address) IsEmpty

func (addr Address) IsEmpty() bool

func (Address) String

func (addr Address) String() string

type Amount

type Amount string

var ZeroAmount Amount = Amount("0")

func NewAmount

func NewAmount(amount string) (Amount, error)

func NewAmountFromFloat

func NewAmountFromFloat(f float64) Amount

func UintToAmount

func UintToAmount(input sdk.Uint) Amount

func (Amount) Equals

func (a Amount) Equals(a2 Amount) bool

func (Amount) Float64

func (a Amount) Float64() float64

func (Amount) GreaterThen

func (a Amount) GreaterThen(f float64) bool

func (Amount) IsEmpty

func (a Amount) IsEmpty() bool

func (Amount) IsNegative

func (a Amount) IsNegative() bool

func (Amount) IsZero

func (a Amount) IsZero() bool

func (Amount) LessThen

func (a Amount) LessThen(f float64) bool

func (Amount) Minus

func (a Amount) Minus(a2 Amount) Amount

func (Amount) Plus

func (a Amount) Plus(a2 Amount) Amount

func (Amount) String

func (a Amount) String() string

type Chain

type Chain string

func NewChain

func NewChain(chain string) (Chain, error)

func (Chain) Equals

func (c Chain) Equals(c2 Chain) bool

func (Chain) IsEmpty

func (c Chain) IsEmpty() bool

func (Chain) String

func (c Chain) String() string

type Coin

type Coin struct {
	Chain  Chain    `json:"chain"`
	Denom  Ticker   `json:"denom"`
	Amount sdk.Uint `json:"amount"`
}

func NewCoin

func NewCoin(chain Chain, denom Ticker, amount sdk.Uint) Coin

NewCoin return a new instance of Coin

func (Coin) Valid

func (c Coin) Valid() error

type Coins

type Coins []Coin

type Duration

type Duration struct {
	time.Duration
}

Duration embedded time.Duration so we 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 Ticker

type Ticker string

func NewTicker

func NewTicker(ticker string) (Ticker, error)

func (Ticker) Equals

func (t Ticker) Equals(t2 Ticker) bool

func (Ticker) IsEmpty

func (t Ticker) IsEmpty() bool

func (Ticker) String

func (t Ticker) String() string

type Tickers

type Tickers []Ticker

type TxID

type TxID string

func NewTxID

func NewTxID(hash string) (TxID, error)

func (TxID) Equals

func (tx TxID) Equals(tx2 TxID) bool

func (TxID) IsEmpty

func (tx TxID) IsEmpty() bool

func (TxID) String

func (tx TxID) String() string

type TxIDs

type TxIDs []TxID