veWOM

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.

event Burn

***VeWom.Burn(account, value) ***

Arguments

event Enter

***VeWom.Enter(addr, unlockTime, womAmount, veWomAmount) ***

Arguments

event Exit

***VeWom.Exit(addr, unlockTime, womAmount, veWomAmount) ***

Arguments

event Mint

***VeWom.Mint(beneficiary, value) ***

Arguments

event OwnershipTransferred

***VeWom.OwnershipTransferred(previousOwner, newOwner) ***

Arguments

event Paused

***VeWom.Paused(account) ***

Arguments

event SetMasterWombat

***VeWom.SetMasterWombat(addr) ***

Arguments

event SetMaxBreedingLength

***VeWom.SetMaxBreedingLength(len) ***

Arguments

event SetWhiteList

***VeWom.SetWhiteList(addr) ***

Arguments

event Unpaused

***VeWom.Unpaused(account) ***

Arguments

stateVariable whitelist

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

function balanceOf

VeWom.balanceOf(account) view

Details: explicity override multiple inheritance

Arguments

Outputs

function burn

***VeWom.burn(slot) ***

Arguments

function decimals

VeWom.decimals() view

Details: Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.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

function getUserInfo

VeWom.getUserInfo(addr) view

Arguments

Outputs

function initialize

***VeWom.initialize(_wom, _masterWombat) ***

Arguments

function isUser

VeWom.isUser(_addr) view

Notice: checks wether user _addr has wom staked

Arguments

Outputs

function masterWombat

VeWom.masterWombat() view

Notice: the masterWombat contract

Outputs

function mint

***VeWom.mint(amount, lockDays) ***

Notice: lock WOM into contract and mint veWOM

Arguments

Outputs

function name

VeWom.name() view

Details: Returns the name of the token.

Outputs

function owner

VeWom.owner() view

Details: Returns the address of the current owner.

Outputs

function pause

***VeWom.pause() ***

Details: pause pool, restricting certain operations

function paused

VeWom.paused() view

Details: Returns true if the contract is paused, and false otherwise.

Outputs

function renounceOwnership

***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.

function setMasterWombat

***VeWom.setMasterWombat(_masterWombat) ***

Notice: sets masterWombat address

Arguments

function setMaxBreedingLength

***VeWom.setMaxBreedingLength(_maxBreedingLength) ***

Arguments

function setWhitelist

***VeWom.setWhitelist(_whitelist) ***

Notice: sets whitelist address

Arguments

function symbol

VeWom.symbol() view

Details: Returns the symbol of the token, usually a shorter version of the name.

Outputs

function totalSupply

VeWom.totalSupply() view

Details: explicity override multiple inheritance

Outputs

function transferOwnership

***VeWom.transferOwnership(newOwner) ***

Details: Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Arguments

function unpause

***VeWom.unpause() ***

Details: unpause pool, enabling certain operations

function wom

VeWom.wom() view

Notice: the wom token

Outputs

Last updated