Skip to main content

SushiToken

Methods

DELEGATION_TYPEHASH

function DELEGATION_TYPEHASH() external view returns (bytes32)

The EIP-712 typehash for the delegation struct used by the contract

Returns

NameTypeDescription
_0bytes32undefined

DOMAIN_TYPEHASH

function DOMAIN_TYPEHASH() external view returns (bytes32)

The EIP-712 typehash for the contract's domain

Returns

NameTypeDescription
_0bytes32undefined

allowance

function allowance(address owner, address spender) external view returns (uint256)

See {IERC20-allowance}.

Parameters

NameTypeDescription
owneraddressundefined
spenderaddressundefined

Returns

NameTypeDescription
_0uint256undefined

approve

function approve(address spender, uint256 amount) external nonpayable returns (bool)

See {IERC20-approve}. Requirements: - spender cannot be the zero address.

Parameters

NameTypeDescription
spenderaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

balanceOf

function balanceOf(address account) external view returns (uint256)

See {IERC20-balanceOf}.

Parameters

NameTypeDescription
accountaddressundefined

Returns

NameTypeDescription
_0uint256undefined

checkpoints

function checkpoints(address, uint32) external view returns (uint32 fromBlock, uint256 votes)

A record of votes checkpoints for each account, by index

Parameters

NameTypeDescription
_0addressundefined
_1uint32undefined

Returns

NameTypeDescription
fromBlockuint32undefined
votesuint256undefined

decimals

function decimals() external view returns (uint8)

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 {setupDecimals} is called. 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}.

Returns

NameTypeDescription
_0uint8undefined

decreaseAllowance

function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool)

Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.

Parameters

NameTypeDescription
spenderaddressundefined
subtractedValueuint256undefined

Returns

NameTypeDescription
_0boolundefined

delegate

function delegate(address delegatee) external nonpayable

Delegate votes from msg.sender to delegatee

Parameters

NameTypeDescription
delegateeaddressThe address to delegate votes to

delegateBySig

function delegateBySig(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s) external nonpayable

Delegates votes from signatory to delegatee

Parameters

NameTypeDescription
delegateeaddressThe address to delegate votes to
nonceuint256The contract state required to match the signature
expiryuint256The time at which to expire the signature
vuint8The recovery byte of the signature
rbytes32Half of the ECDSA signature pair
sbytes32Half of the ECDSA signature pair

delegates

function delegates(address delegator) external view returns (address)

Delegate votes from msg.sender to delegatee

Parameters

NameTypeDescription
delegatoraddressThe address to get delegatee for

Returns

NameTypeDescription
_0addressundefined

getCurrentVotes

function getCurrentVotes(address account) external view returns (uint256)

Gets the current votes balance for account

Parameters

NameTypeDescription
accountaddressThe address to get votes balance

Returns

NameTypeDescription
_0uint256The number of current votes for account

getPriorVotes

function getPriorVotes(address account, uint256 blockNumber) external view returns (uint256)

Determine the prior number of votes for an account as of a block number

Block number must be a finalized block or else this function will revert to prevent misinformation.

Parameters

NameTypeDescription
accountaddressThe address of the account to check
blockNumberuint256The block number to get the vote balance at

Returns

NameTypeDescription
_0uint256The number of votes the account had as of the given block

increaseAllowance

function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool)

Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.

Parameters

NameTypeDescription
spenderaddressundefined
addedValueuint256undefined

Returns

NameTypeDescription
_0boolundefined

mint

function mint(address _to, uint256 _amount) external nonpayable

Creates _amount token to _to. Must only be called by the owner (MasterChef).

Parameters

NameTypeDescription
_toaddressundefined
_amountuint256undefined

name

function name() external view returns (string)

Returns the name of the token.

Returns

NameTypeDescription
_0stringundefined

nonces

function nonces(address) external view returns (uint256)

A record of states for signing / validating signatures

Parameters

NameTypeDescription
_0addressundefined

Returns

NameTypeDescription
_0uint256undefined

numCheckpoints

function numCheckpoints(address) external view returns (uint32)

The number of checkpoints for each account

Parameters

NameTypeDescription
_0addressundefined

Returns

NameTypeDescription
_0uint32undefined

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

NameTypeDescription
_0addressundefined

renounceOwnership

function renounceOwnership() external nonpayable

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.

symbol

function symbol() external view returns (string)

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

Returns

NameTypeDescription
_0stringundefined

totalSupply

function totalSupply() external view returns (uint256)

See {IERC20-totalSupply}.

Returns

NameTypeDescription
_0uint256undefined

transfer

function transfer(address recipient, uint256 amount) external nonpayable returns (bool)

See {IERC20-transfer}. Requirements: - recipient cannot be the zero address. - the caller must have a balance of at least amount.

Parameters

NameTypeDescription
recipientaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

transferFrom

function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)

See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - sender and recipient cannot be the zero address. - sender must have a balance of at least amount. - the caller must have allowance for sender's tokens of at least amount.

Parameters

NameTypeDescription
senderaddressundefined
recipientaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

transferOwnership

function transferOwnership(address newOwner) external nonpayable

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

Parameters

NameTypeDescription
newOwneraddressundefined

Events

Approval

event Approval(address indexed owner, address indexed spender, uint256 value)

Parameters

NameTypeDescription
owner indexedaddressundefined
spender indexedaddressundefined
valueuint256undefined

DelegateChanged

event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate)

An event thats emitted when an account changes its delegate

Parameters

NameTypeDescription
delegator indexedaddressundefined
fromDelegate indexedaddressundefined
toDelegate indexedaddressundefined

DelegateVotesChanged

event DelegateVotesChanged(address indexed delegate, uint256 previousBalance, uint256 newBalance)

An event thats emitted when a delegate account's vote balance changes

Parameters

NameTypeDescription
delegate indexedaddressundefined
previousBalanceuint256undefined
newBalanceuint256undefined

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

NameTypeDescription
previousOwner indexedaddressundefined
newOwner indexedaddressundefined

Transfer

event Transfer(address indexed from, address indexed to, uint256 value)

Parameters

NameTypeDescription
from indexedaddressundefined
to indexedaddressundefined
valueuint256undefined