farm

Documentation

Index

• type FarmContract
  • func (cont *FarmContract) Add(cc *types.ContractContext, _allocPoint uint32, _want common.Address, ...) error
  • func (cont *FarmContract) Address() common.Address
  • func (cont *FarmContract) Deposit(cc *types.ContractContext, _pid uint64, _wantAmt *amount.Amount) error
  • func (cont *FarmContract) EmergencyWithdraw(cc *types.ContractContext, _pid uint64) error
  • func (cont *FarmContract) FarmToken(cc *types.ContractContext) common.Address
  • func (cont *FarmContract) Front() interface{}
  • func (cont *FarmContract) GetMultiplier(cc *types.ContractContext, _from uint32, _to uint32) (uint32, error)
  • func (cont *FarmContract) InCaseTokensGetStuck(cc *types.ContractContext, _token common.Address, _amount *amount.Amount) error
  • func (cont *FarmContract) Init(addr common.Address, master common.Address)
  • func (cont *FarmContract) MassUpdatePools(cc *types.ContractContext) error
  • func (cont *FarmContract) Master() common.Address
  • func (cont *FarmContract) Name() string
  • func (cont *FarmContract) OnCreate(cc *types.ContractContext, Args []byte) error
  • func (cont *FarmContract) OnReward(cc *types.ContractContext, b *types.Block, CountMap map[common.Address]uint32) (map[common.Address]*amount.Amount, error)
  • func (cont *FarmContract) Owner(cc *types.ContractContext) common.Address
  • func (cont *FarmContract) OwnerReward(cc *types.ContractContext) uint16
  • func (cont *FarmContract) PendingReward(cc *types.ContractContext, _pid uint64, _user common.Address) (*amount.Amount, error)
  • func (cont *FarmContract) PoolInfo(cc *types.ContractContext, pid uint64) (common.Address, uint32, uint32, *amount.Amount, common.Address, error)
  • func (cont *FarmContract) PoolLength(cc *types.ContractContext) uint64
  • func (cont *FarmContract) Set(cc *types.ContractContext, _pid uint64, _allocPoint uint32, _withUpdate bool) error
  • func (cont *FarmContract) SetHoldShares(cc *types.ContractContext, height uint32) error
  • func (cont *FarmContract) StakedWantTokens(cc *types.ContractContext, _pid uint64, _user common.Address) (*amount.Amount, error)
  • func (cont *FarmContract) StartBlock(cc *types.ContractContext) uint32
  • func (cont *FarmContract) TokenMaxSupply(cc *types.ContractContext) *amount.Amount
  • func (cont *FarmContract) TokenPerBlock(cc *types.ContractContext) *amount.Amount
  • func (cont *FarmContract) TotalAllocPoint(cc *types.ContractContext) uint32
  • func (cont *FarmContract) UnsetHoldShares(cc *types.ContractContext) error
  • func (cont *FarmContract) UpdatePool(cc *types.ContractContext, _pid uint64) error
  • func (cont *FarmContract) UserInfo(cc *types.ContractContext, pid uint64, user common.Address) (*amount.Amount, *amount.Amount, error)
  • func (cont *FarmContract) Withdraw(cc *types.ContractContext, _pid uint64, _wantAmt *amount.Amount) error
  • func (cont *FarmContract) WithdrawAll(cc *types.ContractContext, _pid uint64) error
• type FarmContractConstruction
  • func (s *FarmContractConstruction) ReadFrom(r io.Reader) (int64, error)
  • func (s *FarmContractConstruction) WriteTo(w io.Writer) (int64, error)
• type PoolInfo
  • func (s *PoolInfo) ReadFrom(r io.Reader) (int64, error)
  • func (s *PoolInfo) WriteTo(w io.Writer) (int64, error)
• type UserInfo
  • func (s *UserInfo) ReadFrom(r io.Reader) (int64, error)
  • func (s *UserInfo) WriteTo(w io.Writer) (int64, error)

Types

type FarmContract

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

func (*FarmContract) Add

func (cont *FarmContract) Add(cc *types.ContractContext, _allocPoint uint32, _want common.Address, _withUpdate bool, _strat common.Address) error

func (*FarmContract) Address

func (cont *FarmContract) Address() common.Address

func (*FarmContract) Deposit

func (cont *FarmContract) Deposit(cc *types.ContractContext, _pid uint64, _wantAmt *amount.Amount) error

Want tokens moved from user -> FletaFinance (Cherry allocation) -> Strat (compounding)

func (*FarmContract) EmergencyWithdraw

func (cont *FarmContract) EmergencyWithdraw(cc *types.ContractContext, _pid uint64) error

Withdraw without caring about rewards. EMERGENCY ONLY.

func (*FarmContract) FarmToken

func (cont *FarmContract) FarmToken(cc *types.ContractContext) common.Address

func (*FarmContract) Front

func (cont *FarmContract) Front() interface{}

func (*FarmContract) GetMultiplier

func (cont *FarmContract) GetMultiplier(cc *types.ContractContext, _from uint32, _to uint32) (uint32, error)

Return reward multiplier over the given _from to _to block.

func (*FarmContract) InCaseTokensGetStuck

func (cont *FarmContract) InCaseTokensGetStuck(cc *types.ContractContext, _token common.Address, _amount *amount.Amount) error

func (*FarmContract) Init

func (cont *FarmContract) Init(addr common.Address, master common.Address)

func (*FarmContract) MassUpdatePools

func (cont *FarmContract) MassUpdatePools(cc *types.ContractContext) error

Update reward variables for all pools. Be careful of gas spending!

func (*FarmContract) Master

func (cont *FarmContract) Master() common.Address

func (*FarmContract) Name

func (cont *FarmContract) Name() string

func (*FarmContract) OnCreate

func (cont *FarmContract) OnCreate(cc *types.ContractContext, Args []byte) error

func (*FarmContract) OnReward

func (cont *FarmContract) OnReward(cc *types.ContractContext, b *types.Block, CountMap map[common.Address]uint32) (map[common.Address]*amount.Amount, error)

func (*FarmContract) Owner

func (cont *FarmContract) Owner(cc *types.ContractContext) common.Address

//////////////////////////////////////////////// Public Reader Functions ////////////////////////////////////////////////

func (*FarmContract) OwnerReward

func (cont *FarmContract) OwnerReward(cc *types.ContractContext) uint16

func (*FarmContract) PendingReward

func (cont *FarmContract) PendingReward(cc *types.ContractContext, _pid uint64, _user common.Address) (*amount.Amount, error)

View function to see pending Cherry on frontend.

func (*FarmContract) PoolInfo

func (cont *FarmContract) PoolInfo(cc *types.ContractContext, pid uint64) (common.Address, uint32, uint32, *amount.Amount, common.Address, error)

func (*FarmContract) PoolLength

func (cont *FarmContract) PoolLength(cc *types.ContractContext) uint64

func (*FarmContract) Set

func (cont *FarmContract) Set(cc *types.ContractContext, _pid uint64, _allocPoint uint32, _withUpdate bool) error

Update the given pool's Cherry allocation point. Can only be called by the owner.

func (*FarmContract) SetHoldShares

func (cont *FarmContract) SetHoldShares(cc *types.ContractContext, height uint32) error

func (*FarmContract) StakedWantTokens

func (cont *FarmContract) StakedWantTokens(cc *types.ContractContext, _pid uint64, _user common.Address) (*amount.Amount, error)

View function to see staked Want tokens on frontend.

func (*FarmContract) StartBlock

func (cont *FarmContract) StartBlock(cc *types.ContractContext) uint32

func (*FarmContract) TokenMaxSupply

func (cont *FarmContract) TokenMaxSupply(cc *types.ContractContext) *amount.Amount

func (*FarmContract) TokenPerBlock

func (cont *FarmContract) TokenPerBlock(cc *types.ContractContext) *amount.Amount

func (*FarmContract) TotalAllocPoint

func (cont *FarmContract) TotalAllocPoint(cc *types.ContractContext) uint32

func (*FarmContract) UnsetHoldShares

func (cont *FarmContract) UnsetHoldShares(cc *types.ContractContext) error

func (*FarmContract) UpdatePool

func (cont *FarmContract) UpdatePool(cc *types.ContractContext, _pid uint64) error

Update reward variables of the given pool to be up-to-date.

func (*FarmContract) UserInfo

func (cont *FarmContract) UserInfo(cc *types.ContractContext, pid uint64, user common.Address) (*amount.Amount, *amount.Amount, error)

func (*FarmContract) Withdraw

func (cont *FarmContract) Withdraw(cc *types.ContractContext, _pid uint64, _wantAmt *amount.Amount) error

Withdraw LP tokens from MasterPicker.

func (*FarmContract) WithdrawAll

func (cont *FarmContract) WithdrawAll(cc *types.ContractContext, _pid uint64) error

type FarmContractConstruction

type FarmContractConstruction struct {
	Owner          common.Address
	FarmToken      common.Address
	OwnerReward    uint16
	TokenMaxSupply *amount.Amount
	TokenPerBlock  *amount.Amount
	StartBlock     uint32
}

func (*FarmContractConstruction) ReadFrom

func (s *FarmContractConstruction) ReadFrom(r io.Reader) (int64, error)

func (*FarmContractConstruction) WriteTo

func (s *FarmContractConstruction) WriteTo(w io.Writer) (int64, error)

type PoolInfo

type PoolInfo struct {
	Want             common.Address
	AllocPoint       uint32
	LastRewardBlock  uint32
	AccTokenPerShare *amount.Amount
	Strat            common.Address
}

func (*PoolInfo) ReadFrom

func (s *PoolInfo) ReadFrom(r io.Reader) (int64, error)

func (*PoolInfo) WriteTo

func (s *PoolInfo) WriteTo(w io.Writer) (int64, error)

type UserInfo

type UserInfo struct {
	Shares     *amount.Amount
	RewardDebt *amount.Amount
}

func (*UserInfo) ReadFrom

func (s *UserInfo) ReadFrom(r io.Reader) (int64, error)

func (*UserInfo) WriteTo

func (s *UserInfo) WriteTo(w io.Writer) (int64, error)