LUSD Stablecoin

0x5f98805a4e8be255a32880fdec7f6728c6568ba0 Copy

ERC20

This contract is an ERC20 token.

Name LUSD Stablecoin

Symbol LUSD

Decimals 18

Total Supply 478,480,041 LUSD

About

Liquity USD (LUSD) is a cryptocurrency and operates on the Ethereum platform. Liquity USD has a current supply of 719,446,094.8060437. The last known price of Liquity USD is 1.00689868 USD and is up 0.30 over the last 24 hours. It is currently trading on 10 active market(s) with $866,803.88 traded over the last 24 hours. More information can be found at https://www.liquity.org/.

Stats

Public Functions 20

Event Types 6

Code Size 100,869 bytes

Library Use

Uses SafeMath for uint256.

Events (6)

Approval Event

Parameters

owner	address
spender	address
value	uint256

BorrowerOperationsAddressChanged Event

Parameters

_newBorrowerOperationsAddress

address

LUSDTokenBalanceUpdated Event

Parameters

_user	address
_amount	uint

StabilityPoolAddressChanged Event

Parameters

_newStabilityPoolAddress

address

Transfer Event

Parameters

from	address
to	address
value	uint256

TroveManagerAddressChanged Event

Parameters

_troveManagerAddress

address

Constants (6)

_NAME Constant

string

LUSD Stablecoin

_SYMBOL Constant

string

LUSD

_VERSION Constant

string

_DECIMALS Constant

uint8

_PERMIT_TYPEHASH Constant

bytes32

0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9

_TYPE_HASH Constant

bytes32

0x8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f

State Variables (11)

troveManagerAddress Variable

address

stabilityPoolAddress Variable

address

borrowerOperationsAddress Variable

address

_totalSupply Variable

uint256

Internal Variable

_CACHED_DOMAIN_SEPARATOR Variable

bytes32

Internal Variable

_CACHED_CHAIN_ID Variable

uint256

Internal Variable

_HASHED_NAME Variable

bytes32

Internal Variable

_HASHED_VERSION Variable

bytes32

Internal Variable

_nonces Variable

mapping(address => uint256)

Internal Variable

_balances Variable

mapping(address => uint256)

Internal Variable

_allowances Variable

mapping(address => mapping(address => uint256))

Internal Variable

Functions Expand All Collapse All

mint

Parameters

Name	Type
_account	address
_amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

borrowerOperationsAddress must be equal to the sender's address

_account must not be equal to UNKNOWN VALUE

Source Code

function mint(address _account, uint256 _amount) external override {
  _requireCallerIsBorrowerOperations();
  _mint(_account, _amount);
}

burn

Parameters

Name	Type
_account	address
_amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

One or more of the following: - stabilityPoolAddress must be equal to the sender's address - OR troveManagerAddress must be equal to the sender's address - OR borrowerOperationsAddress must be equal to the sender's address

_account must not be equal to UNKNOWN VALUE

Source Code

function burn(address _account, uint256 _amount) external override {
  _requireCallerIsBOorTroveMorSP();
  _burn(_account, _amount);
}

sendToPool

Parameters

Name	Type
_sender	address
_poolAddress	address
_amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

stabilityPoolAddress must be equal to the sender's address

_sender must not be equal to UNKNOWN VALUE

_poolAddress must not be equal to UNKNOWN VALUE

Source Code

function sendToPool(
  address _sender,
  address _poolAddress,
  uint256 _amount
) external override {
  _requireCallerIsStabilityPool();
  _transfer(_sender, _poolAddress, _amount);
}

returnFromPool

Parameters

Name	Type
_poolAddress	address
_receiver	address
_amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

One or more of the following: - stabilityPoolAddress must be equal to the sender's address - OR troveManagerAddress must be equal to the sender's address

_sender must not be equal to UNKNOWN VALUE

_poolAddress must not be equal to UNKNOWN VALUE

Source Code

function returnFromPool(
  address _poolAddress,
  address _receiver,
  uint256 _amount
) external override {
  _requireCallerIsTroveMorSP();
  _transfer(_poolAddress, _receiver, _amount);
}

totalSupply

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function totalSupply() external view override returns (uint256) {
  return _totalSupply;
}

balanceOf

Parameters

Name	Type
account	address

Properties

Visibility public

Mutability view

Source Code

function balanceOf(address account) external view override returns (uint256) {
  return _balances[account];
}

transfer

Parameters

Name	Type
recipient	address
amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

recipient must not be equal to UNKNOWN VALUE

recipient must not be equal to borrowerOperationsAddress

recipient must not be equal to troveManagerAddress

recipient must not be equal to stabilityPoolAddress

_sender must not be equal to UNKNOWN VALUE

_poolAddress must not be equal to UNKNOWN VALUE

Source Code

function transfer(address recipient, uint256 amount)
  external
  override
  returns (bool)
{
  _requireValidRecipient(recipient);
  _transfer(msg.sender, recipient, amount);
  return true;
}

allowance

Parameters

Name	Type
owner	address
spender	address

Properties

Visibility public

Mutability view

Source Code

function allowance(address owner, address spender)
  external
  view
  override
  returns (uint256)
{
  return _allowances[owner][spender];
}

approve

Parameters

Name	Type
spender	address
amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

spender must not be equal to UNKNOWN VALUE

Source Code

function approve(address spender, uint256 amount)
  external
  override
  returns (bool)
{
  _approve(msg.sender, spender, amount);
  return true;
}

transferFrom

Parameters

Name	Type
sender	address
recipient	address
amount	uint256

Properties

Visibility public

Mutability transaction

Requirements

recipient must not be equal to UNKNOWN VALUE

recipient must not be equal to borrowerOperationsAddress

recipient must not be equal to troveManagerAddress

recipient must not be equal to stabilityPoolAddress

_sender must not be equal to UNKNOWN VALUE

_poolAddress must not be equal to UNKNOWN VALUE

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function transferFrom(
  address sender,
  address recipient,
  uint256 amount
) external override returns (bool) {
  _requireValidRecipient(recipient);
  _transfer(sender, recipient, amount);
  _approve(
    sender,
    msg.sender,
    _allowances[sender][msg.sender].sub(
      amount,
      "ERC20: transfer amount exceeds allowance"
    )
  );
  return true;
}

increaseAllowance

Parameters

Name	Type
spender	address
addedValue	uint256

Properties

Visibility public

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function increaseAllowance(address spender, uint256 addedValue)
  external
  override
  returns (bool)
{
  _approve(
    msg.sender,
    spender,
    _allowances[msg.sender][spender].add(addedValue)
  );
  return true;
}

decreaseAllowance

Parameters

Name	Type
spender	address
subtractedValue	uint256

Properties

Visibility public

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function decreaseAllowance(address spender, uint256 subtractedValue)
  external
  override
  returns (bool)
{
  _approve(
    msg.sender,
    spender,
    _allowances[msg.sender][spender].sub(
      subtractedValue,
      "ERC20: decreased allowance below zero"
    )
  );
  return true;
}

domainSeparator

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function domainSeparator() public view override returns (bytes32) {
  if (_chainID() == _CACHED_CHAIN_ID) {
    return _CACHED_DOMAIN_SEPARATOR;
  } else {
    return _buildDomainSeparator(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION);
  }
}

permit

Parameters

Name	Type
owner	address
spender	address
amount	uint
deadline	uint
v	uint8
r	bytes32
s	bytes32

Properties

Visibility public

Mutability transaction

Requirements

deadline must be greater than or equal to now

recoveredAddress must be equal to owner

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function permit(
  address owner,
  address spender,
  uint256 amount,
  uint256 deadline,
  uint8 v,
  bytes32 r,
  bytes32 s
) external override {
  require(deadline >= now, "LUSD: expired deadline");
  bytes32 digest = keccak256(
    abi.encodePacked(
      "\x19\x01",
      domainSeparator(),
      keccak256(
        abi.encode(
          _PERMIT_TYPEHASH,
          owner,
          spender,
          amount,
          _nonces[owner]++,
          deadline
        )
      )
    )
  );
  address recoveredAddress = ecrecover(digest, v, r, s);
  require(recoveredAddress == owner, "LUSD: invalid signature");
  _approve(owner, spender, amount);
}

nonces

Parameters

Name	Type
owner	address

Properties

Visibility public

Mutability view

Source Code

function nonces(address owner) external view override returns (uint256) {
  // FOR EIP 2612
  return _nonces[owner];
}

name

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function name() external view override returns (string memory) {
  return _NAME;
}

symbol

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function symbol() external view override returns (string memory) {
  return _SYMBOL;
}

decimals

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function decimals() external view override returns (uint8) {
  return _DECIMALS;
}

version

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function version() external view override returns (string memory) {
  return _VERSION;
}

permitTypeHash

Parameters

This function has no parameters.

Properties

Visibility public

Mutability view

Source Code

function permitTypeHash() external view override returns (bytes32) {
  return _PERMIT_TYPEHASH;
}

Internal Functions Expand All Collapse All

Internal functions are parts of the contract that can't be used directly, but instead are used by the public functions listed above.

internal LUSDToken._chainID

Parameters

This function has no parameters.

Properties

Visibility private

Mutability pure

Source Code

function _chainID() private pure returns (uint256 chainID) {
  assembly {
    chainID := chainid()
  }
}

internal LUSDToken._buildDomainSeparator

Parameters

Name	Type
typeHash	bytes32
name	bytes32
version	bytes32

Properties

Visibility private

Mutability view

Source Code

function _buildDomainSeparator(
  bytes32 typeHash,
  bytes32 name,
  bytes32 version
) private view returns (bytes32) {
  return
    keccak256(abi.encode(typeHash, name, version, _chainID(), address(this)));
}

internal LUSDToken._transfer

Parameters

Name	Type
sender	address
recipient	address
amount	uint256

Properties

Visibility internal

Mutability transaction

Requirements

_sender must not be equal to UNKNOWN VALUE

_poolAddress must not be equal to UNKNOWN VALUE

Source Code

function _transfer(
  address sender,
  address recipient,
  uint256 amount
) internal {
  assert(sender != address(0));
  assert(recipient != address(0));

  _balances[sender] = _balances[sender].sub(
    amount,
    "ERC20: transfer amount exceeds balance"
  );
  _balances[recipient] = _balances[recipient].add(amount);
  emit Transfer(sender, recipient, amount);
}

internal LUSDToken._mint

Parameters

Name	Type
account	address
amount	uint256

Properties

Visibility internal

Mutability transaction

Requirements

_account must not be equal to UNKNOWN VALUE

Source Code

function _mint(address account, uint256 amount) internal {
  assert(account != address(0));

  _totalSupply = _totalSupply.add(amount);
  _balances[account] = _balances[account].add(amount);
  emit Transfer(address(0), account, amount);
}

internal LUSDToken._burn

Parameters

Name	Type
account	address
amount	uint256

Properties

Visibility internal

Mutability transaction

Requirements

_account must not be equal to UNKNOWN VALUE

Source Code

function _burn(address account, uint256 amount) internal {
  assert(account != address(0));

  _balances[account] = _balances[account].sub(
    amount,
    "ERC20: burn amount exceeds balance"
  );
  _totalSupply = _totalSupply.sub(amount);
  emit Transfer(account, address(0), amount);
}

internal LUSDToken._approve

Parameters

Name	Type
owner	address
spender	address
amount	uint256

Properties

Visibility internal

Mutability transaction

Requirements

the sender's address must not be equal to UNKNOWN VALUE

Source Code

function _approve(
  address owner,
  address spender,
  uint256 amount
) internal {
  assert(owner != address(0));
  assert(spender != address(0));

  _allowances[owner][spender] = amount;
  emit Approval(owner, spender, amount);
}

internal LUSDToken._requireValidRecipient

Parameters

Name	Type
_recipient	address

Properties

Visibility internal

Mutability view

Requirements

recipient must not be equal to UNKNOWN VALUE

recipient must not be equal to borrowerOperationsAddress

recipient must not be equal to troveManagerAddress

recipient must not be equal to stabilityPoolAddress

Source Code

function _requireValidRecipient(address _recipient) internal view {
  require(
    _recipient != address(0) && _recipient != address(this),
    "LUSD: Cannot transfer tokens directly to the LUSD token contract or the zero address"
  );
  require(
    _recipient != stabilityPoolAddress &&
      _recipient != troveManagerAddress &&
      _recipient != borrowerOperationsAddress,
    "LUSD: Cannot transfer tokens directly to the StabilityPool, TroveManager or BorrowerOps"
  );
}

internal LUSDToken._requireCallerIsBorrowerOperations

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability view

Requirements

borrowerOperationsAddress must be equal to the sender's address

Source Code

function _requireCallerIsBorrowerOperations() internal view {
  require(
    msg.sender == borrowerOperationsAddress,
    "LUSDToken: Caller is not BorrowerOperations"
  );
}

internal LUSDToken._requireCallerIsBOorTroveMorSP

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability view

Requirements

Source Code

function _requireCallerIsBOorTroveMorSP() internal view {
  require(
    msg.sender == borrowerOperationsAddress ||
      msg.sender == troveManagerAddress ||
      msg.sender == stabilityPoolAddress,
    "LUSD: Caller is neither BorrowerOperations nor TroveManager nor StabilityPool"
  );
}

internal LUSDToken._requireCallerIsStabilityPool

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability view

Requirements

stabilityPoolAddress must be equal to the sender's address

Source Code

function _requireCallerIsStabilityPool() internal view {
  require(
    msg.sender == stabilityPoolAddress,
    "LUSD: Caller is not the StabilityPool"
  );
}

internal LUSDToken._requireCallerIsTroveMorSP

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability view

Requirements

One or more of the following: - stabilityPoolAddress must be equal to the sender's address - OR troveManagerAddress must be equal to the sender's address

Source Code

function _requireCallerIsTroveMorSP() internal view {
  require(
    msg.sender == troveManagerAddress || msg.sender == stabilityPoolAddress,
    "LUSD: Caller is neither TroveManager nor StabilityPool"
  );
}

internal CheckContract.checkContract

Parameters

Name	Type
_account	address

Properties

Visibility internal

Mutability view

Requirements

_account must not be equal to UNKNOWN VALUE

size must be greater than 0

Source Code

function checkContract(address _account) internal view {
  require(_account != address(0), "Account cannot be zero address");

  uint256 size;
  // solhint-disable-next-line no-inline-assembly
  assembly {
    size := extcodesize(_account)
  }
  require(size > 0, "Account code size cannot be zero");
}

LUSD Stablecoin

ERC20

About link description

Stats

Library Use

Events (6) keyboard_arrow_up

Approval Event

Parameters help Event parameters list the data that an event contains.

BorrowerOperationsAddressChanged Event

Parameters help Event parameters list the data that an event contains.

LUSDTokenBalanceUpdated Event

Parameters help Event parameters list the data that an event contains.

StabilityPoolAddressChanged Event

Parameters help Event parameters list the data that an event contains.

Transfer Event

Parameters help Event parameters list the data that an event contains.

TroveManagerAddressChanged Event

Parameters help Event parameters list the data that an event contains.

Constants (6) keyboard_arrow_up

_NAME Constant

_SYMBOL Constant

_VERSION Constant

_DECIMALS Constant

_PERMIT_TYPEHASH Constant

_TYPE_HASH Constant

State Variables (11) keyboard_arrow_up

troveManagerAddress Variable

stabilityPoolAddress Variable

borrowerOperationsAddress Variable

_totalSupply Variable

_CACHED_DOMAIN_SEPARATOR Variable

_CACHED_CHAIN_ID Variable

_HASHED_NAME Variable

_HASHED_VERSION Variable

_nonces Variable

_balances Variable

_allowances Variable

Functions Expand All Collapse All

mint keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

burn keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

sendToPool keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

returnFromPool keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

totalSupply keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Source Code

balanceOf keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Source Code

transfer keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

allowance keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Source Code

approve keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

About

Events (6)

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Constants (6)

State Variables (11)

mint

Parameters

Requirements

burn

Parameters

Requirements

sendToPool

Parameters

Requirements

returnFromPool

Parameters

Requirements

totalSupply

Parameters

balanceOf

Parameters

transfer

Parameters

Requirements

allowance

Parameters

approve

Parameters

Requirements

transferFrom

Parameters

Requirements

increaseAllowance

Parameters

Requirements

decreaseAllowance

Parameters

Requirements

domainSeparator

Parameters

permit

Parameters

Requirements

nonces

Parameters

name

Parameters

symbol

Parameters

decimals

Parameters

version

Parameters

permitTypeHash

Parameters

internal LUSDToken._chainID

Parameters

internal LUSDToken._buildDomainSeparator

Parameters

internal LUSDToken._transfer

Parameters

Requirements

internal LUSDToken._mint

Parameters

Requirements

internal LUSDToken._burn

Parameters