WETH9 v0.2.3 API Reference
WETH9
A contract that implements Wrapped Ether (WETH), allowing users to wrap and unwrap ETH.
Variables
allowance
mapping(address => mapping(address => uint256)) public allowance
balanceOf
mapping(address => uint256) public balanceOf
decimals
uint8 public decimals = 18
name
string public name = "Wrapped Ether"
symbol
string public symbol = "WETH"
Events
Approval
event Approval(address indexed src, address indexed guy, uint256 wad)
Parameters
Parameter | Type | Description |
---|---|---|
src | address | The address giving the approval |
guy | address | The address receiving the approval |
wad | uint256 | The amount of tokens being approved |
Deposit
event Deposit(address indexed dst, uint256 wad)
Parameters
Parameter | Type | Description |
---|---|---|
dst | address | The address receiving the WETH |
wad | uint256 | The amount of ETH being wrapped |
Transfer
event Transfer(address indexed src, address indexed dst, uint256 wad)
Parameters
Parameter | Type | Description |
---|---|---|
src | address | The address sending the tokens |
dst | address | The address receiving the tokens |
wad | uint256 | The amount of tokens being transferred |
Withdrawal
event Withdrawal(address indexed src, uint256 wad)
Parameters
Parameter | Type | Description |
---|---|---|
src | address | The address unwrapping the WETH |
wad | uint256 | The amount of WETH being unwrapped |
Functions
approve
Approves another address to spend tokens.
function approve(address guy, uint256 wad) public returns (bool)
Parameters
Parameter | Type | Description |
---|---|---|
guy | address | The address to approve |
wad | uint256 | The amount of tokens to approve |
Returns
Parameter | Type | Description |
---|---|---|
(unnamed) | bool | Always returns true |
deposit
Deposits ETH to receive WETH.
function deposit() external payable
totalSupply
Gets the total supply of WETH.
function totalSupply() public view returns (uint256)
Returns
Parameter | Type | Description |
---|---|---|
(unnamed) | uint256 | The total supply of WETH |
transfer
Transfers tokens to another address.
function transfer(address dst, uint256 wad) public returns (bool)
Parameters
Parameter | Type | Description |
---|---|---|
dst | address | The recipient address |
wad | uint256 | The amount of tokens to transfer |
Returns
Parameter | Type | Description |
---|---|---|
(unnamed) | bool | Returns true if the transfer succeeds |
transferFrom
Transfers tokens from one address to another.
function transferFrom(address src, address dst, uint256 wad) public returns (bool)
Parameters
Parameter | Type | Description |
---|---|---|
src | address | The source address |
dst | address | The destination address |
wad | uint256 | The amount of tokens to transfer |
Returns
Parameter | Type | Description |
---|---|---|
(unnamed) | bool | Returns true if the transfer succeeds |
Possible Reverts
- Reverts if the source address has insufficient balance
- Reverts if the caller has insufficient allowance (unless caller is source or has maximum allowance)
withdraw
Withdraws ETH by unwrapping WETH.
function withdraw(uint256 wad) external
Parameters
Parameter | Type | Description |
---|---|---|
wad | uint256 | The amount of WETH to unwrap |
Possible Reverts
- Reverts if the caller has insufficient WETH balance