AToken

Methods

alien

function alien() external view returns (address)

The Alien contract address

Returns

Name	Type	Description
_0	address	undefined

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

asset

function asset() external view returns (address)

Return the underlying market.

Returns

Name	Type	Description
_0	address	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(address account, uint256 amount) external nonpayable

Burn AToken.

This function will only emit a Transfer event.

Parameters

Name	Type	Description
account	address	The address to burn AToken from
amount	uint256	The amount of AToken to burn

decimals

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 this function is overridden; 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

Name	Type	Description
_0	uint8	undefined

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

initialize

function initialize(string name_, string symbol_, address admin_, address alien_, address market_) external nonpayable

Initialize the contract

Parameters

Name	Type	Description
name_	string	undefined
symbol_	string	undefined
admin_	address	undefined
alien_	address	undefined
market_	address	undefined

market

function market() external view returns (address)

The underlying token address

Returns

Name	Type	Description
_0	address	undefined

mint

function mint(address account, uint256 amount) external nonpayable

Mint AToken.

This function will only emit a Transfer event.

Parameters

Name	Type	Description
account	address	The address to receive AToken
amount	uint256	The amount of AToken to mint

name

function name() external view returns (string)

Returns the name of the token.

Returns

Name	Type	Description
_0	string	undefined

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

proxiableUUID

function proxiableUUID() external view returns (bytes32)

Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the implementation. It is used to validate the implementation's compatibility when performing an upgrade. IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this function revert if invoked through a proxy. This is guaranteed by the notDelegated modifier.

Returns

Name	Type	Description
_0	bytes32	undefined

renounceOwnership

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.

seize

function seize(address from, address to, uint256 amount) external nonpayable

Seize AToken.

This function will only be called when a liquidation occurs.

Parameters

Name	Type	Description
from	address	The address to seize AToken from
to	address	The address to receive AToken
amount	uint256	The amount of AToken to seize

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)

Transfer AToken to another address.

Parameters

Name	Type	Description
to	address	The address to receive AToken
amount	uint256	The amount of AToken to transfer

Returns

Name	Type	Description
_0	bool	undefined

transferFrom

function transferFrom(address from, address to, uint256 amount) external nonpayable returns (bool)

Transfer AToken from one address to another.

Parameters

Name	Type	Description
from	address	The address to send AToken from
to	address	The address to receive AToken
amount	uint256	The amount of AToken to transfer

Returns

Name	Type	Description
_0	bool	undefined

transferOwnership

function transferOwnership(address newOwner) external nonpayable

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

Name	Type	Description
newOwner	address	undefined

upgradeTo

function upgradeTo(address newImplementation) external nonpayable

Upgrade the implementation of the proxy to newImplementation. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined

upgradeToAndCall

function upgradeToAndCall(address newImplementation, bytes data) external payable

Upgrade the implementation of the proxy to newImplementation, and subsequently execute the function call encoded in data. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined
data	bytes	undefined

Events

AdminChanged

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

Name	Type	Description
previousAdmin	address	undefined
newAdmin	address	undefined

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

BeaconUpgraded

event BeaconUpgraded(address indexed beacon)

Parameters

Name	Type	Description
beacon indexed	address	undefined

Initialized

event Initialized(uint8 version)

Parameters

Name	Type	Description
version	uint8	undefined

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	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

Upgraded

event Upgraded(address indexed implementation)

Parameters

Name	Type	Description
implementation indexed	address	undefined