Skip to main content
Version: V3

IERC20Minimal

Contains a subset of the full ERC20 interface that is used in Uniswap V3

Functions

balanceOf

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

Returns the balance of a token

Parameters:

NameTypeDescription
accountaddressThe account for which to look up the number of tokens it has, i.e. its balance

Return Values:

TypeDescription
uint256number of tokens held by the account

transfer

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

Transfers the amount of token from the msg.sender to the recipient

Parameters:

NameTypeDescription
recipientaddressThe account that will receive the amount transferred
amountuint256The number of tokens to send from the sender to the recipient

Return Values:

TypeDescription
booltrue for a successful transfer, false for an unsuccessful transfer

allowance

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

Returns the current allowance given to a spender by an owner

Parameters:

NameTypeDescription
owneraddressThe account of the token owner
spenderaddressThe account of the token spender

Return Values:

TypeDescription
uint256current allowance granted by owner to spender

approve

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

Sets the allowance of a spender from the msg.sender to the value amount

Parameters:

NameTypeDescription
spenderaddressThe account which will be allowed to spend a given amount of the owners tokens
amountuint256The amount of tokens allowed to be used by spender

Return Values:

TypeDescription
booltrue for a successful approval, false for unsuccessful

transferFrom

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

Transfers amount tokens from sender to recipient up to the allowance given to the msg.sender

Parameters:

NameTypeDescription
senderaddressThe account from which the transfer will be initiated
recipientaddressThe recipient of the transfer
amountuint256The amount of the transfer

Return Values:

TypeDescription
booltrue for a successful transfer, false for unsuccessful

Events

Transfer

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

Event emitted when tokens are transferred from one address to another, either via #transfer or #transferFrom.

Parameters:

NameTypeDescription
fromaddressThe account from which the tokens were sent, i.e. the balance decreased
toaddressThe account to which the tokens were sent, i.e. the balance increased
valueuint256The amount of tokens that were transferred

Approval

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

Event emitted when the approval amount for the spender of a given owner's tokens changes.

Parameters:

NameTypeDescription
owneraddressThe account that approved spending of its tokens
spenderaddressThe account for which the spending allowance was modified
valueuint256The new allowance from the owner to the spender