Comment on page
LPToken
Liquidity Provider Token
This token is an ERC20 detailed token with added capability to be minted by the owner. It is used to represent user's shares when providing liquidity to swap contracts.
Only Swap contracts should initialize and own LPToken contracts.
function allowance(address owner, address spender) external view returns (uint256)
See {IERC20-allowance}.
Name | Type | Description |
|---|---|---|
owner | address | undefined |
spender | address | undefined |
Name | Type | Description |
|---|---|---|
_0 | uint256 | undefined |
function approve(address spender, uint256 amount) external nonpayable returns (bool)
See {IERC20-approve}. Requirements: -
spender cannot be the zero address.Name | Type | Description |
|---|---|---|
spender | address | undefined |
amount | uint256 | undefined |
Name | Type | Description |
|---|---|---|
_0 | bool | undefined |
function balanceOf(address account) external view returns (uint256)
See {IERC20-balanceOf}.
Name | Type | Description |
|---|---|---|
account | address | undefined |
Name | Type | Description |
|---|---|---|
_0 | uint256 | undefined |
function burn(uint256 amount) external nonpayable
Destroys
amount tokens from the caller. See {ERC20-_burn}.Name | Type | Description |
|---|---|---|
amount | uint256 | undefined |
function burnFrom(address account, uint256 amount) external nonpayable
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.Name | Type | Description |
|---|---|---|
account | address | undefined |
amount | uint256 | undefined |
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}.Name | Type | Description |
|---|---|---|
_0 | uint8 | undefined |
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.Name | Type | Description |
|---|---|---|
spender | address | undefined |
subtractedValue | uint256 | undefined |
Name | Type | Description |
|---|---|---|
_0 | bool | undefined |
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.Name | Type | Description |
|---|---|---|
spender | address | undefined |
addedValue | uint256 | undefined |
Name | Type | Description |
|---|---|---|
_0 | bool | undefined |
function initialize(string name, string symbol) external nonpayable returns (bool)
Initializes this LPToken contract with the given name and symbol
The caller of this function will become the owner. A Swap contract should call this in its initializer function.
Name | Type | Description |
|---|---|---|
name | string | name of this token |
symbol | string | symbol of this token |
Name | Type | Description |
|---|---|---|
_0 | bool | undefined |
function mint(address recipient, uint256 amount) external nonpayable
Mints the given amount of LPToken to the recipient.
only owner can call this mint function
Name | Type | Description |
|---|---|---|
recipient | address | address of account to receive the tokens |
amount | uint256 | amount of tokens to mint |
function name() external view returns (string)
Returns the name of the token.
Name | Type | Description |
|---|---|---|
_0 | string | undefined |
function owner() external view returns (address)
Returns the address of the current owner.
Name | Type | Description |
|---|---|---|
_0 | address | undefined |
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.function symbol() external view returns (string)
Returns the symbol of the token, usually a shorter version of the name.
Name | Type | Description |
|---|---|---|
_0 | string | undefined |
function totalSupply() external view returns (uint256)
See {IERC20-totalSupply}.
Name | Type | Description |
|---|---|---|
_0 | uint256 | undefined |
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.Name | Type | Description |
|---|---|---|
recipient | address | undefined |
amount | uint256 | undefined |
Name | Type | Description |
|---|---|---|
_0 | bool | undefined |
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.Name | Type | Description |
|---|---|---|
sender | address | undefined |
recipient | address | undefined |
amount | uint256 | undefined |
Name | Type | Description |
|---|---|---|
_0 | bool | undefined |
function transferOwnership(address newOwner) external nonpayable
Transfers ownership of the contract to a new account (
newOwner). Can only be called by the current owner.Name | Type | Description |
|---|---|---|
newOwner | address | undefined |
event Approval(address indexed owner, address indexed spender, uint256 value)
Name | Type | Description |
|---|---|---|
owner indexed | address | undefined |
spender indexed | address | undefined |
value | uint256 | undefined |
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
Name | Type | Description |
|---|---|---|
previousOwner indexed | address | undefined |
newOwner indexed | address | undefined |
event Transfer(address indexed from, address indexed to, uint256 value)
Name | Type | Description |
|---|---|---|
from indexed | address | undefined |
to indexed | address | undefined |
value | uint256 | undefined |
Last modified 1yr ago