Skip to main content

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

NameTypeDescription
_0bytes32undefined

allowance(address,address)

Solidity

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

See {IERC20-allowance}.

Parameters

NameTypeDescription
owneraddressundefined
spenderaddressundefined

Returns

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
spenderaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

balanceOf(address)

Solidity

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

See {IERC20-balanceOf}.

Parameters

NameTypeDescription
accountaddressundefined

Returns

NameTypeDescription
_0uint256undefined

burn(uint256)

Solidity

function burn(uint256 amount) external nonpayable
Details

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

Parameters

NameTypeDescription
amountuint256undefined

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

NameTypeDescription
accountaddressundefined
amountuint256undefined

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

NameTypeDescription
accountaddressundefined
posuint32undefined

Returns

NameTypeDescription
_0ERC20VotesUpgradeable.Checkpointundefined

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

NameTypeDescription
_0uint8undefined

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

NameTypeDescription
spenderaddressundefined
subtractedValueuint256undefined

Returns

NameTypeDescription
_0boolundefined

delegate(address)

Solidity

function delegate(address delegatee) external nonpayable
Details

Delegate votes from the sender to delegatee.

Parameters

NameTypeDescription
delegateeaddressundefined

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

NameTypeDescription
delegateeaddressundefined
nonceuint256undefined
expiryuint256undefined
vuint8undefined
rbytes32undefined
sbytes32undefined

delegates(address)

Solidity

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

Get the address account is currently delegating to.

Parameters

NameTypeDescription
accountaddressundefined

Returns

NameTypeDescription
_0addressundefined

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

NameTypeDescription
blockNumberuint256undefined

Returns

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
accountaddressundefined
blockNumberuint256undefined

Returns

NameTypeDescription
_0uint256undefined

getVotes(address)

Solidity

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

Gets the current votes balance for account

Parameters

NameTypeDescription
accountaddressundefined

Returns

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
spenderaddressundefined
addedValueuint256undefined

Returns

NameTypeDescription
_0boolundefined

initialize(uint256)

Solidity

function initialize(uint256 initialSupply) external nonpayable

Parameters

NameTypeDescription
initialSupplyuint256undefined

mint(address,uint256)

Solidity

function mint(address _to, uint256 _amount) external nonpayable
Details

Mints tokens to a given address

Parameters

NameTypeDescription
_toaddressThe address to transfer to
_amountuint256The amount to transfer

name()

Solidity

function name() external view returns (string)
Details

Returns the name of the token.

Returns

NameTypeDescription
_0stringundefined

nonces(address)

Solidity

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

See {IERC20Permit-nonces}.

Parameters

NameTypeDescription
owneraddressundefined

Returns

NameTypeDescription
_0uint256undefined

numCheckpoints(address)

Solidity

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

Get number of checkpoints for account.

Parameters

NameTypeDescription
accountaddressundefined

Returns

NameTypeDescription
_0uint32undefined

owner()

Solidity

function owner() external view returns (address)
Details

Returns the address of the current owner.

Returns

NameTypeDescription
_0addressundefined

pause()

Solidity

function pause() external nonpayable
Details

Pause token transfers in the event of emergencyThis 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

NameTypeDescription
_0boolundefined

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

NameTypeDescription
owneraddressundefined
spenderaddressundefined
valueuint256undefined
deadlineuint256undefined
vuint8undefined
rbytes32undefined
sbytes32undefined

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

NameTypeDescription
_0stringundefined

totalSupply()

Solidity

function totalSupply() external view returns (uint256)
Details

See {IERC20-totalSupply}.

Returns

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
recipientaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

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

NameTypeDescription
senderaddressundefined
recipientaddressundefined
amountuint256undefined

Returns

NameTypeDescription
_0boolundefined

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

NameTypeDescription
newOwneraddressundefined

unpause()

Solidity

function unpause() external nonpayable
Details

Unpause token transfers in the event of emergencyThis will restore token transfers after an 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

NameTypeDescription
newImplementationaddressundefined

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

NameTypeDescription
newImplementationaddressundefined
databytesundefined

Events

AdminChanged

Solidity

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

NameTypeDescription
previousAdminaddressundefined
newAdminaddressundefined

Approval

Solidity

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

Parameters

NameTypeDescription
owner indexedaddressundefined
spender indexedaddressundefined
valueuint256undefined

BeaconUpgraded

Solidity

event BeaconUpgraded(address indexed beacon)

Parameters

NameTypeDescription
beacon indexedaddressundefined

DelegateChanged

Solidity

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

Parameters

NameTypeDescription
delegator indexedaddressundefined
fromDelegate indexedaddressundefined
toDelegate indexedaddressundefined

DelegateVotesChanged

Solidity

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

Parameters

NameTypeDescription
delegate indexedaddressundefined
previousBalanceuint256undefined
newBalanceuint256undefined

OwnershipTransferred

Solidity

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

NameTypeDescription
previousOwner indexedaddressundefined
newOwner indexedaddressundefined

Paused

Solidity

event Paused(address account)

Parameters

NameTypeDescription
accountaddressundefined

Transfer

Solidity

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

Parameters

NameTypeDescription
from indexedaddressundefined
to indexedaddressundefined
valueuint256undefined

Unpaused

Solidity

event Unpaused(address account)

Parameters

NameTypeDescription
accountaddressundefined

Upgraded

Solidity

event Upgraded(address indexed implementation)

Parameters

NameTypeDescription
implementation indexedaddressundefined