Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

entities

package

Go to main page

Versions in this module

v0

v0.2.9

Nov 15, 2021

v0.2.8

Aug 24, 2021

v0.2.7

Aug 21, 2021

v0.2.6

Jul 13, 2021

v0.2.5

Jun 26, 2021

v0.2.4

Jun 12, 2021

v0.2.3

Jun 3, 2021

Changes in this version

type Trade

+ ExecutionPrice *Price

+ NextMidPrice *Price

+ PriceImpact *Percent

+ Route *Route

+ TradeType constants.TradeType

v0.2.2

Jun 2, 2021

v0.2.1

Jun 2, 2021

v0.2.0

Mar 29, 2021

v0.1.0

Mar 28, 2021

Changes in this version

+ var ETHER = newCurrency(constants.Decimals18, "ETH", "Ether")

+ var ErrDiffChainID = fmt.Errorf("diff chain id")

+ var ErrDiffToken = fmt.Errorf("diff token")

+ var ErrInsufficientInputAmount = errors.New("the input amount insufficient reserves")

+ var ErrInsufficientReserves = errors.New("doesn't have insufficient reserves")

+ var ErrInvalidCurrency = fmt.Errorf("diff currency")

+ var ErrInvalidInput = fmt.Errorf("invalid token input")

+ var ErrInvalidKLast = fmt.Errorf("invalid kLast")

+ var ErrInvalidLiquidity = fmt.Errorf("invalid liquidity")

+ var ErrInvalidOption = fmt.Errorf("invalid maxHops")

+ var ErrInvalidOutput = fmt.Errorf("invalid token output")

+ var ErrInvalidPairs = fmt.Errorf("invalid pairs")

+ var ErrInvalidPairsChainIDs = fmt.Errorf("invalid pairs chainIDs")

+ var ErrInvalidPath = fmt.Errorf("invalid pairs for path")

+ var ErrInvalidRecursion = fmt.Errorf("invalid recursion")

+ var ErrInvalidSlippageTolerance = fmt.Errorf("invalid slippage tolerance")

+ var ErrSameAddrss = fmt.Errorf("same address")

+ var Percent100 = NewFraction(constants.B100, constants.One)

+ var WETH = map[constants.ChainID]*Token

+ var ZeroFraction = NewFraction(constants.Zero, nil)

+ func InputOutputComparator(a, b InputOutput) int

+ func SortedInsert(items []*Trade, add *Trade, maxSize int, comparator func(a, b *Trade) int) (sortedItems []*Trade, pop *Trade, err error)

+ func TradeComparator(a, b *Trade) int

+ type BestTradeOptions struct

+ MaxHops int

+ MaxNumResults int

+ func NewDefaultBestTradeOptions() *BestTradeOptions

+ func (o *BestTradeOptions) ReduceHops() *BestTradeOptions

+ type Currency struct

+ Decimals int

+ Name string

+ Symbol string

+ func (c *Currency) Equals(other *Currency) bool

+ type CurrencyAmount struct

+ func NewCurrencyAmount(currency *Currency, amount *big.Int) (*CurrencyAmount, error)

+ func NewEther(amount *big.Int) (*CurrencyAmount, error)

+ func (c *CurrencyAmount) Raw() *big.Int

+ type Fraction struct

+ Denominator *big.Int

+ Numerator *big.Int

+ func NewFraction(num, deno *big.Int) *Fraction

+ func (f *Fraction) Add(other *Fraction) *Fraction

+ func (f *Fraction) Divide(other *Fraction) *Fraction

+ func (f *Fraction) EqualTo(other *Fraction) bool

+ func (f *Fraction) GreaterThan(other *Fraction) bool

+ func (f *Fraction) Invert() *Fraction

+ func (f *Fraction) LessThan(other *Fraction) bool

+ func (f *Fraction) Multiply(other *Fraction) *Fraction

+ func (f *Fraction) Quotient() *big.Int

+ func (f *Fraction) Remainder() *Fraction

+ func (f *Fraction) Subtract(other *Fraction) *Fraction

+ func (f *Fraction) ToFixed(decimalPlaces uint) string

+ func (f *Fraction) ToSignificant(significantDigits uint) string

+ type InputOutput interface

+ InputAmount func() *TokenAmount

+ OutputAmount func() *TokenAmount

+ type Pair struct

+ LiquidityToken *Token

+ func NewPair(tokenAmountA, tokenAmountB *TokenAmount) (*Pair, error)

+ func (p *Pair) ChainID() constants.ChainID

+ func (p *Pair) GetAddress() common.Address

+ func (p *Pair) GetInputAmount(outputAmount *TokenAmount) (*TokenAmount, *Pair, error)

+ func (p *Pair) GetLiquidityMinted(totalSupply, tokenAmountA, tokenAmountB *TokenAmount) (*TokenAmount, error)

+ func (p *Pair) GetLiquidityValue(token *Token, totalSupply, liquidity *TokenAmount, feeOn bool, kLast *big.Int) (*TokenAmount, error)

+ func (p *Pair) GetOutputAmount(inputAmount *TokenAmount) (*TokenAmount, *Pair, error)

+ func (p *Pair) InvolvesToken(token *Token) bool

+ func (p *Pair) PriceOf(token *Token) (*Price, error)

+ func (p *Pair) Reserve0() *TokenAmount

+ func (p *Pair) Reserve1() *TokenAmount

+ func (p *Pair) ReserveOf(token *Token) (*TokenAmount, error)

+ func (p *Pair) Token0() *Token

+ func (p *Pair) Token0Price() *Price

+ func (p *Pair) Token1() *Token

+ func (p *Pair) Token1Price() *Price

+ type PairAddressCache struct

+ func (p *PairAddressCache) GetAddress(addressA, addressB common.Address) common.Address

+ type Percent struct

+ func NewPercent(num, deno *big.Int) *Percent

+ func (p *Percent) ToFixed(decimalPlaces uint) string

+ func (p *Percent) ToSignificant(significantDigits uint) string

+ type Price struct

+ BaseCurrency *Currency

+ QuoteCurrency *Currency

+ Scalar *Fraction

+ func NewPrice(baseCurrency, quoteCurrency *Currency, denominator, numerator *big.Int) *Price

+ func NewPriceFromRoute(route *Route) (*Price, error)

+ func (p *Price) Adjusted() *Fraction

+ func (p *Price) Invert()

+ func (p *Price) Multiply(other *Price) error

+ func (p *Price) Quote(currencyAmount *CurrencyAmount) (*CurrencyAmount, error)

+ func (p *Price) Raw() *Fraction

+ func (p *Price) ToFixed(decimalPlaces uint) string

+ func (p *Price) ToSignificant(significantDigits uint) string

+ type Route struct

+ Input *Token

+ MidPrice *Price

+ Output *Token

+ Pairs []*Pair

+ Path []*Token

+ func NewRoute(pairs []*Pair, input, output *Token) (*Route, error)

+ func (r *Route) ChainID() constants.ChainID

+ type Token struct

+ func NewETHRToken(chainID constants.ChainID, address common.Address) *Token

+ func NewToken(chainID constants.ChainID, address common.Address, decimals int, ...) (*Token, error)

+ func (t *Token) Equals(other *Token) bool

+ func (t *Token) SortsBefore(other *Token) (bool, error)

+ type TokenAmount struct

+ Token *Token

+ func NewTokenAmount(token *Token, amount *big.Int) (*TokenAmount, error)

+ func (t *TokenAmount) Add(other *TokenAmount) (*TokenAmount, error)

+ func (t *TokenAmount) Equals(other *TokenAmount) bool

+ func (t *TokenAmount) Subtract(other *TokenAmount) (*TokenAmount, error)

+ type TokenAmounts [2]*TokenAmount

+ func NewTokenAmounts(tokenAmountA, tokenAmountB *TokenAmount) (TokenAmounts, error)

+ type Tokens [2]*Token

+ type Trade struct

+ func BestTradeExactIn(pairs []*Pair, currencyAmountIn *TokenAmount, currencyOut *Token, ...) (sortedItems []*Trade, err error)

+ func BestTradeExactOut(pairs []*Pair, currencyIn *Token, currencyAmountOut *TokenAmount, ...) (sortedItems []*Trade, err error)

+ func ExactIn(route *Route, amountIn *TokenAmount) (*Trade, error)

+ func ExactOut(route *Route, amountOut *TokenAmount) (*Trade, error)

+ func NewTrade(route *Route, amount *TokenAmount, tradeType constants.TradeType) (*Trade, error)

+ func (t *Trade) InputAmount() *TokenAmount

+ func (t *Trade) MaximumAmountIn(slippageTolerance *Percent) (*TokenAmount, error)

+ func (t *Trade) MinimumAmountOut(slippageTolerance *Percent) (*TokenAmount, error)

+ func (t *Trade) OutputAmount() *TokenAmount