token

Documentation

Index

• type BaseToken
  • func NewBaseToken(name, symbol string, decimals chainid.Uint8Map, addresses chainid.AddressMap, ...) BaseToken
  • func (t BaseToken) Address(chainID chainid.ChainID) (addr common.Address, ok bool)
  • func (t BaseToken) Addresses() chainid.AddressMap
  • func (t BaseToken) CanSwap(other Token) bool
  • func (t BaseToken) Decimals(chainID chainid.ChainID) (decimals uint8, ok bool)
  • func (t BaseToken) Equal(other Token) bool
  • func (t BaseToken) Hash() string
  • func (t BaseToken) IsOnChain(chainID chainid.ChainID) bool
  • func (t BaseToken) IsWrappedToken() bool
  • func (t BaseToken) MarshalJSON() ([]byte, error)
  • func (t BaseToken) Name() string
  • func (t BaseToken) SerializeJSON() []byte
  • func (t BaseToken) SwapType() swaptype.SwapType
  • func (t BaseToken) Symbol() string
  • func (t BaseToken) UnderlyingToken() Token
  • func (t *BaseToken) UnmarshalJSON(data []byte) (unmarshalErr error)
• type Token
• type WrappedToken
  • func NewWrappedToken(name, symbol string, decimals chainid.Uint8Map, addresses chainid.AddressMap, ...) WrappedToken
  • func (t WrappedToken) IsWrappedToken() bool
  • func (t WrappedToken) UnderlyingToken() Token

Types

type BaseToken

type BaseToken struct {
	// contains filtered or unexported fields
}

func NewBaseToken

func NewBaseToken(
	name, symbol string,
	decimals chainid.Uint8Map,
	addresses chainid.AddressMap,
	swapType swaptype.SwapType,
) BaseToken

func (BaseToken) Address

func (t BaseToken) Address(chainID chainid.ChainID) (addr common.Address, ok bool)

func (BaseToken) Addresses

func (t BaseToken) Addresses() chainid.AddressMap

func (BaseToken) CanSwap

func (t BaseToken) CanSwap(other Token) bool

func (BaseToken) Decimals

func (t BaseToken) Decimals(chainID chainid.ChainID) (decimals uint8, ok bool)

func (BaseToken) Equal

func (t BaseToken) Equal(other Token) bool

func (BaseToken) Hash

func (t BaseToken) Hash() string

func (BaseToken) IsOnChain

func (t BaseToken) IsOnChain(chainID chainid.ChainID) bool

func (BaseToken) IsWrappedToken

func (t BaseToken) IsWrappedToken() bool

func (BaseToken) MarshalJSON

func (t BaseToken) MarshalJSON() ([]byte, error)

func (BaseToken) Name

func (t BaseToken) Name() string

func (BaseToken) SerializeJSON

func (t BaseToken) SerializeJSON() []byte

func (BaseToken) SwapType

func (t BaseToken) SwapType() swaptype.SwapType

SwapType returns the Token's swaptype.SwapType

func (BaseToken) Symbol

func (t BaseToken) Symbol() string

func (BaseToken) UnderlyingToken

func (t BaseToken) UnderlyingToken() Token

func (*BaseToken) UnmarshalJSON

func (t *BaseToken) UnmarshalJSON(data []byte) (unmarshalErr error)

type Token

type Token interface {
	Name() string
	Symbol() string
	Hash() string
	SwapType() swaptype.SwapType
	Equal(Token) bool
	CanSwap(Token) bool
	Address(chainid.ChainID) (common.Address, bool)
	Addresses() chainid.AddressMap
	Decimals(chainid.ChainID) (uint8, bool)
	IsOnChain(chainid.ChainID) bool
	IsWrappedToken() bool
	UnderlyingToken() Token
	SerializeJSON() []byte
}

type WrappedToken

type WrappedToken struct {
	BaseToken
	// contains filtered or unexported fields
}

func NewWrappedToken

func NewWrappedToken(
	name, symbol string,
	decimals chainid.Uint8Map,
	addresses chainid.AddressMap,
	swapType swaptype.SwapType,
	underlyingToken BaseToken,
) WrappedToken

func (WrappedToken) IsWrappedToken

func (t WrappedToken) IsWrappedToken() bool

func (WrappedToken) UnderlyingToken

func (t WrappedToken) UnderlyingToken() Token