MutualCredit
Methods
__MutualCredit_init
function __MutualCredit_init(string name_, string symbol_) external nonpayable
initializes ERC20 with the name and symbol provided.
should be called directly after deployment (see OpenZeppelin upgradeable standards).
Parameters
| Name | Type | Description |
|---|
| name_ | string | name of the credit token. |
| symbol_ | string | symbol of the credit token. |
allowance
function allowance(address owner, address spender) external view returns (uint256)
See {IERC20-allowance}.
Parameters
| Name | Type | Description |
|---|
| owner | address | undefined |
| spender | address | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
approve
function approve(address spender, uint256 amount) external nonpayable returns (bool)
See {IERC20-approve}. NOTE: If amount is the maximum uint256, the allowance is not updated on transferFrom. This is semantically equivalent to an infinite approval. Requirements: - spender cannot be the zero address.
Parameters
| Name | Type | Description |
|---|
| spender | address | undefined |
| amount | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
balanceOf
function balanceOf(address account) external view returns (uint256)
See {IERC20-balanceOf}.
Parameters
| Name | Type | Description |
|---|
| account | address | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
burn
function burn(uint256 amount) external nonpayable
Destroys amount tokens from the caller. See {ERC20-_burn}.
Parameters
| Name | Type | Description |
|---|
| amount | uint256 | undefined |
burnFrom
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.
Parameters
| Name | Type | Description |
|---|
| account | address | undefined |
| amount | uint256 | undefined |
creditBalanceOf
function creditBalanceOf(address member) external view returns (uint256)
returns the credit balance of a given member
Parameters
| Name | Type | Description |
|---|
| member | address | address of member to query |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | credit balance of member |
creditLimitLeftOf
function creditLimitLeftOf(address member) external view returns (uint256)
returns the credit limit left of a given member
Parameters
| Name | Type | Description |
|---|
| member | address | address of member to query |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | credit limit left of member |
creditLimitOf
function creditLimitOf(address member) external view returns (uint256)
returns the credit limit of a given member
Parameters
| Name | Type | Description |
|---|
| member | address | address of member to query |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | credit limit of member |
decimals
function decimals() external view returns (uint8)
returns the number of decimals used by the credit token.
Returns
| Name | Type | Description |
|---|
| _0 | uint8 | number of decimals. |
decreaseAllowance
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.
Parameters
| Name | Type | Description |
|---|
| spender | address | undefined |
| subtractedValue | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
increaseAllowance
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.
Parameters
| Name | Type | Description |
|---|
| spender | address | undefined |
| addedValue | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
name
function name() external view returns (string)
Returns the name of the token.
Returns
| Name | Type | Description |
|---|
| _0 | string | undefined |
symbol
function symbol() external view returns (string)
Returns the symbol of the token, usually a shorter version of the name.
Returns
| Name | Type | Description |
|---|
| _0 | string | undefined |
totalSupply
function totalSupply() external view returns (uint256)
See {IERC20-totalSupply}.
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
transfer
function transfer(address to, uint256 amount) external nonpayable returns (bool)
See {IERC20-transfer}. Requirements: - to cannot be the zero address. - the caller must have a balance of at least amount.
Parameters
| Name | Type | Description |
|---|
| to | address | undefined |
| amount | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
transferFrom
function transferFrom(address from, address to, 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}. NOTE: Does not update the allowance if the current allowance is the maximum uint256. Requirements: - from and to cannot be the zero address. - from must have a balance of at least amount. - the caller must have allowance for from's tokens of at least amount.
Parameters
| Name | Type | Description |
|---|
| from | address | undefined |
| to | address | undefined |
| amount | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
Events
Approval
event Approval(address indexed owner, address indexed spender, uint256 value)
Parameters
| Name | Type | Description |
|---|
owner indexed | address | undefined |
spender indexed | address | undefined |
| value | uint256 | undefined |
CreditLimitUpdate
event CreditLimitUpdate(address member, uint256 limit)
Parameters
| Name | Type | Description |
|---|
| member | address | undefined |
| limit | uint256 | undefined |
Initialized
event Initialized(uint8 version)
Parameters
| Name | Type | Description |
|---|
| version | uint8 | undefined |
Transfer
event Transfer(address indexed from, address indexed to, uint256 value)
Parameters
| Name | Type | Description |
|---|
from indexed | address | undefined |
to indexed | address | undefined |
| value | uint256 | undefined |