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.
Methods
allowance
See {IERC20-allowance}.
Parameters
Returns
approve
See {IERC20-approve}. Requirements: - spender
cannot be the zero address.
Parameters
Returns
balanceOf
See {IERC20-balanceOf}.
Parameters
Returns
burn
Destroys amount
tokens from the caller. See {ERC20-_burn}.
Parameters
burnFrom
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
decimals
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}.
Returns
decreaseAllowance
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
Returns
increaseAllowance
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
Returns
initialize
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.
Parameters
Returns
mint
Mints the given amount of LPToken to the recipient.
only owner can call this mint function
Parameters
name
Returns the name of the token.
Returns
owner
Returns the address of the current owner.
Returns
renounceOwnership
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
Returns the symbol of the token, usually a shorter version of the name.
Returns
totalSupply
See {IERC20-totalSupply}.
Returns
transfer
See {IERC20-transfer}. Requirements: - recipient
cannot be the zero address. - the caller must have a balance of at least amount
.
Parameters
Returns
transferFrom
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
Returns
transferOwnership
Transfers ownership of the contract to a new account (newOwner
). Can only be called by the current owner.
Parameters
Events
Approval
Parameters
OwnershipTransferred
Parameters
Transfer
Parameters
Last updated