veWOM
Last updated
Last updated
contracts/wombat-governance/VeWom.sol
Title: VeWom
Notice: Wombat Waddle: the staking contract for WOM, as well as the token used for governance. Note Waddling does not seem to slow the Wombat, it only makes it sturdier. Note that it's ownable and the owner wields tremendous power. The ownership will be transferred to a governance smart contract once Wombat is sufficiently distributed and the community can show to govern itself.
***VeWom.Burn(account, value) ***
Arguments
***VeWom.Enter(addr, unlockTime, womAmount, veWomAmount) ***
Arguments
***VeWom.Exit(addr, unlockTime, womAmount, veWomAmount) ***
Arguments
***VeWom.Mint(beneficiary, value) ***
Arguments
***VeWom.OwnershipTransferred(previousOwner, newOwner) ***
Arguments
***VeWom.Paused(account) ***
Arguments
***VeWom.SetMasterWombat(addr) ***
Arguments
***VeWom.SetMaxBreedingLength(len) ***
Arguments
***VeWom.SetWhiteList(addr) ***
Arguments
***VeWom.Unpaused(account) ***
Arguments
VeWom.whitelist() view
Notice: whitelist wallet checker
Details: contract addresses are by default unable to stake wom, they must be previously whitelisted to stake wom
Outputs
VeWom.balanceOf(account) view
Details: explicity override multiple inheritance
Arguments
Outputs
***VeWom.burn(slot) ***
Arguments
VeWom.decimals() view
Details: Returns the number of decimals used to get its user representation. For example, if
decimals
equals2
, a balance of505
tokens should be displayed to a user as5.05
(505 / 10 ** 2
). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
Outputs
VeWom.getUserInfo(addr) view
Arguments
Outputs
***VeWom.initialize(_wom, _masterWombat) ***
Arguments
VeWom.isUser(_addr) view
Notice: checks wether user _addr has wom staked
Arguments
Outputs
VeWom.masterWombat() view
Notice: the masterWombat contract
Outputs
***VeWom.mint(amount, lockDays) ***
Notice: lock WOM into contract and mint veWOM
Arguments
Outputs
VeWom.name() view
Details: Returns the name of the token.
Outputs
VeWom.owner() view
Details: Returns the address of the current owner.
Outputs
***VeWom.pause() ***
Details: pause pool, restricting certain operations
VeWom.paused() view
Details: Returns true if the contract is paused, and false otherwise.
Outputs
***VeWom.renounceOwnership() ***
Details: Leaves the contract without owner. It will not be possible to call
onlyOwner
functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.
***VeWom.setMasterWombat(_masterWombat) ***
Notice: sets masterWombat address
Arguments
***VeWom.setMaxBreedingLength(_maxBreedingLength) ***
Arguments
***VeWom.setWhitelist(_whitelist) ***
Notice: sets whitelist address
Arguments
VeWom.symbol() view
Details: Returns the symbol of the token, usually a shorter version of the name.
Outputs
VeWom.totalSupply() view
Details: explicity override multiple inheritance
Outputs
***VeWom.transferOwnership(newOwner) ***
Details: Transfers ownership of the contract to a new account (
newOwner
). Can only be called by the current owner.
Arguments
***VeWom.unpause() ***
Details: unpause pool, enabling certain operations
VeWom.wom() view
Notice: the wom token
Outputs
name
type
description
account
address
indexed
value
uint256
not indexed
name
type
description
addr
address
not indexed
unlockTime
uint256
not indexed
womAmount
uint256
not indexed
veWomAmount
uint256
not indexed
name
type
description
addr
address
not indexed
unlockTime
uint256
not indexed
womAmount
uint256
not indexed
veWomAmount
uint256
not indexed
name
type
description
beneficiary
address
indexed
value
uint256
not indexed
name
type
description
previousOwner
address
indexed
newOwner
address
indexed
name
type
description
account
address
not indexed
name
type
description
addr
address
not indexed
name
type
description
len
uint256
not indexed
name
type
description
addr
address
not indexed
name
type
description
account
address
not indexed
name
type
description
address
name
type
description
account
address
name
type
description
uint256
name
type
description
slot
uint256
name
type
description
uint8
name
type
description
addr
address
name
type
description
tuple
name
type
description
_wom
address
_masterWombat
address
name
type
description
_addr
address
the user address to check
name
type
description
bool
true if the user has wom in stake, false otherwise
name
type
description
address
name
type
description
amount
uint256
lockDays
uint256
name
type
description
veWomAmount
uint256
name
type
description
string
name
type
description
address
name
type
description
bool
name
type
description
_masterWombat
address
the new masterWombat address
name
type
description
_maxBreedingLength
uint256
name
type
description
_whitelist
address
the new whitelist address
name
type
description
string
name
type
description
uint256
name
type
description
newOwner
address
name
type
description
address