SteerToken.sol

Details

This token is used within the governance contracts

Methods

DOMAIN_SEPARATOR()

Solidity

function DOMAIN_SEPARATOR() external view returns (bytes32)

Details

See {IERC20Permit-DOMAIN_SEPARATOR}.

Returns

Name	Type	Description
_0	bytes32	undefined

allowance(address,address)

Solidity

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

Details

See {IERC20-allowance}.

Parameters

Name	Type	Description
owner	address	undefined
spender	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

approve(address,uint256)

Solidity

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

Details

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

Parameters

Name	Type	Description
spender	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

balanceOf(address)

Solidity

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

Details

See {IERC20-balanceOf}.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

burn(uint256)

Solidity

function burn(uint256 amount) external nonpayable

Details

Destroys amount tokens from the caller. See {ERC20-_burn}.

Parameters

Name	Type	Description
amount	uint256	undefined

burnFrom(address,uint256)

Solidity

function burnFrom(address account, uint256 amount) external nonpayable

Details

Destroys amount tokens from account, deducting from the caller's allowance. See {ERC20-_burn} and {ERC20-allowance}. Requirements: - the caller must have allowance for accounts's tokens of at least amount.

Parameters

Name	Type	Description
account	address	undefined
amount	uint256	undefined

checkpoints(address,uint32)

Solidity

function checkpoints(address account, uint32 pos) external view returns (struct ERC20VotesUpgradeable.Checkpoint)

Details

Get the pos-th checkpoint for account.

Parameters

Name	Type	Description
account	address	undefined
pos	uint32	undefined

Returns

Name	Type	Description
_0	ERC20VotesUpgradeable.Checkpoint	undefined

decimals()

Solidity

function decimals() external view returns (uint8)

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

Returns

Name	Type	Description
_0	uint8	undefined

decreaseAllowance(address,uint256)

Solidity

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

Details

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

Name	Type	Description
spender	address	undefined
subtractedValue	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

delegate(address)

Solidity

function delegate(address delegatee) external nonpayable

Details

Delegate votes from the sender to delegatee.

Parameters

Name	Type	Description
delegatee	address	undefined

delegateBySig(address,uint256,uint256,uint8,bytes32,bytes32)

Solidity

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

Details

Delegates votes from signer to delegatee

Parameters

Name	Type	Description
delegatee	address	undefined
nonce	uint256	undefined
expiry	uint256	undefined
v	uint8	undefined
r	bytes32	undefined
s	bytes32	undefined

delegates(address)

Solidity

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

Details

Get the address account is currently delegating to.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	address	undefined

flashFee(address,uint256)

Solidity

function flashFee(address token, uint256 amount) external view returns (uint256)

Details

Returns the fee applied when doing flash loans. By default this implementation has 0 fees. This function can be overloaded to make the flash loan mechanism deflationary.

Parameters

Name	Type	Description
token	address	The token to be flash loaned.
amount	uint256	The amount of tokens to be loaned.

Returns

Name	Type	Description
_0	uint256	The fees applied to the corresponding flash loan.

flashLoan(address,address,uint256,bytes)

Solidity

function flashLoan(contract IERC3156FlashBorrowerUpgradeable receiver, address token, uint256 amount, bytes data) external nonpayable returns (bool)

Details

Performs a flash loan. New tokens are minted and sent to the receiver, who is required to implement the {IERC3156FlashBorrower} interface. By the end of the flash loan, the receiver is expected to own amount + fee tokens and have them approved back to the token contract itself so they can be burned.

Parameters

Name	Type	Description
receiver	contract IERC3156FlashBorrowerUpgradeable	The receiver of the flash loan. Should implement the {IERC3156FlashBorrower.onFlashLoan} interface.
token	address	The token to be flash loaned. Only address(this) is supported.
amount	uint256	The amount of tokens to be loaned.
data	bytes	An arbitrary datafield that is passed to the receiver.

Returns

Name	Type	Description
_0	bool	true is the flash loan was successful.

getPastTotalSupply(uint256)

Solidity

function getPastTotalSupply(uint256 blockNumber) external view returns (uint256)

Details

Retrieve the totalSupply at the end of blockNumber. Note, this value is the sum of all balances. It is but NOT the sum of all the delegated votes! Requirements: - blockNumber must have been already mined

Parameters

Name	Type	Description
blockNumber	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

getPastVotes(address,uint256)

Solidity

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

Details

Retrieve the number of votes for account at the end of blockNumber. Requirements: - blockNumber must have been already mined

Parameters

Name	Type	Description
account	address	undefined
blockNumber	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

getVotes(address)

Solidity

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

Details

Gets the current votes balance for account

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

increaseAllowance(address,uint256)

Solidity

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

Details

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

Name	Type	Description
spender	address	undefined
addedValue	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

initialize(uint256)

Solidity

function initialize(uint256 initialSupply) external nonpayable

Parameters

Name	Type	Description
initialSupply	uint256	undefined

maxFlashLoan(address)

Solidity

function maxFlashLoan(address token) external view returns (uint256)

Details

Returns the maximum amount of tokens available for loan.

Parameters

Name	Type	Description
token	address	The address of the token that is requested.

Returns

Name	Type	Description
_0	uint256	The amont of token that can be loaned.

mint(address,uint256)

Mints tokens to a given address

Solidity

function mint(address _to, uint256 _amount) external nonpayable

Parameters

Name	Type	Description
_to	address	The address to transfer to
_amount	uint256	The amount to transfer

name()

Solidity

function name() external view returns (string)

Details

Returns the name of the token.

Returns

Name	Type	Description
_0	string	undefined

nonces(address)

Solidity

function nonces(address owner) external view returns (uint256)

Details

See {IERC20Permit-nonces}.

Parameters

Name	Type	Description
owner	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

numCheckpoints(address)

Solidity

function numCheckpoints(address account) external view returns (uint32)

Details

Get number of checkpoints for account.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint32	undefined

owner()

Solidity

function owner() external view returns (address)

Details

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

pause()

Pause token transfers in the event of emergency

Solidity

function pause() external nonpayable

Details

This will only be used for emergency situations and should not be used for any other reason

paused()

Solidity

function paused() external view returns (bool)

Details

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

Returns

Name	Type	Description
_0	bool	undefined

permit(address,address,uint256,uint256,uint8,bytes32,bytes32)

Solidity

function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayable

Details

See {IERC20Permit-permit}.

Parameters

Name	Type	Description
owner	address	undefined
spender	address	undefined
value	uint256	undefined
deadline	uint256	undefined
v	uint8	undefined
r	bytes32	undefined
s	bytes32	undefined

renounceOwnership()

Solidity

function renounceOwnership() external nonpayable

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.

symbol()

Solidity

function symbol() external view returns (string)

Details

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

Returns

Name	Type	Description
_0	string	undefined

totalSupply()

Solidity

function totalSupply() external view returns (uint256)

Details

See {IERC20-totalSupply}.

Returns

Name	Type	Description
_0	uint256	undefined

transfer(address,uint256)

Solidity

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

Details

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

Parameters

Name	Type	Description
recipient	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

transferFrom(address,address,uint256)

Solidity

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

Details

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

Name	Type	Description
sender	address	undefined
recipient	address	undefined
amount	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

transferOwnership(address)

Solidity

function transferOwnership(address newOwner) external nonpayable

Details

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

Parameters

Name	Type	Description
newOwner	address	undefined

unpause()

Unpause token transfers in the event of emergency

Solidity

function unpause() external nonpayable

Details

This will restore token transfers after a emergency event

upgradeTo(address)

Solidity

function upgradeTo(address newImplementation) external nonpayable

Details

Upgrade the implementation of the proxy to newImplementation. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined

upgradeToAndCall(address,bytes)

Solidity

function upgradeToAndCall(address newImplementation, bytes data) external payable

Details

Upgrade the implementation of the proxy to newImplementation, and subsequently execute the function call encoded in data. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined
data	bytes	undefined

Events

AdminChanged

Solidity

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

Name	Type	Description
previousAdmin	address	undefined
newAdmin	address	undefined

Approval

Solidity

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

Parameters

Name	Type	Description
owner indexed	address	undefined
spender indexed	address	undefined
value	uint256	undefined

BeaconUpgraded

Solidity

event BeaconUpgraded(address indexed beacon)

Parameters

Name	Type	Description
beacon indexed	address	undefined

DelegateChanged

Solidity

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

Parameters

Name	Type	Description
delegator indexed	address	undefined
fromDelegate indexed	address	undefined
toDelegate indexed	address	undefined

DelegateVotesChanged

Solidity

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

Parameters

Name	Type	Description
delegate indexed	address	undefined
previousBalance	uint256	undefined
newBalance	uint256	undefined

OwnershipTransferred

Solidity

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	undefined

Paused

Solidity

event Paused(address account)

Parameters

Name	Type	Description
account	address	undefined

Transfer

Solidity

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

Parameters

Name	Type	Description
from indexed	address	undefined
to indexed	address	undefined
value	uint256	undefined

Unpaused

Solidity

event Unpaused(address account)

Parameters

Name	Type	Description
account	address	undefined

Upgraded

Solidity

event Upgraded(address indexed implementation)

Parameters

Name	Type	Description
implementation indexed	address	undefined