Marketplace.sol
This document describes the functions, attributes and modifiers in Redeemer.sol
This contract is in charge of managing the avaialable principals for each loan market. In addition, this contract routes swap orders between metaprincipal tokens and their respective underlying to YieldSpace pools.
Note this list contains both internal and external attributes
Var | Type |
|---|---|
markets | mapping(address => mapping(uint256 => address[9])) |
pools | mapping(address => mapping(uint256 => address)) |
admin | address |
redeemer | address |
lender | address |
ensures that only a certain address can call the function
Declaration
modifier authorized(
address a
)
Args:
Arg | Type | Description |
|---|---|---|
a | address | address that msg.sender must be to be authorized |
intializes the MarketPlace contract
Declaration
function constructor(
address r,
address l
) public
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
r | address | address of the deployed redeemer contract |
l | address | address of the deployed lender contract |
creates a new market for the given underlying token and maturity
Declaration
function createMarket(
address u,
uint256 m,
address[8] t,
string n,
string s,
uint8 d
) external authorized returns
(bool)
Modifiers:
Modifier |
|---|
authorized |
Args:
Arg | Type | Description |
|---|---|---|
u | address | address of an underlying asset |
m | uint256 | maturity (timestamp) of the market |
t | address[8] | principal token addresses for this market minus the illuminate principal (which is added here) |
n | string | name for the illuminate token |
s | string | symbol for the illuminate token |
d | uint8 | decimals for the illuminate token |
Returns:
Type | Description |
|---|---|
bool | true if successful |
allows the admin to set an individual market
Declaration
function setPrincipal(
uint8 p,
address u,
uint256 m,
address a
) external authorized returns
(bool)
Modifiers:
Modifier |
|---|
authorized |
Args:
Arg | Type | Description |
|---|---|---|
p | uint8 | enum value of the principal token |
u | address | underlying token address |
m | uint256 | maturity timestamp for the market |
a | address | address of the new market |
Returns:
Type | Description |
|---|---|
bool | true if successful |
sets the admin address
Declaration
function setAdmin(
address a
) external authorized returns
(bool)
Modifiers:
Modifier |
|---|
authorized |
Args:
Arg | Type | Description |
|---|---|---|
a | address | Address of a new admin |
Returns:
Type | Description |
|---|---|
bool | true if successful |
sets the address for a pool
Declaration
function setPool(
address u,
uint256 m,
address a
) external authorized returns
(bool)
Modifiers:
Modifier |
|---|
authorized |
Args:
Arg | Type | Description |
|---|---|---|
u | address | address of the underlying asset |
m | uint256 | maturity (timestamp) of the market |
a | address | address of the pool |
Returns:
Type | Description |
|---|---|
bool | true if successful |
sells the PT for the PT via the pool
Declaration
function sellPrincipalToken(
address u,
uint256 m,
uint128 a
) external returns
(uint128)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | address of the underlying asset |
m | uint256 | maturity (timestamp) of the market |
a | uint128 | amount of PT to swap |
Returns:
Type | Description |
|---|---|
uint128 | amount of PT bought |
buys the underlying for the PT via the pool
Declaration
function buyPrincipalToken(
address u,
uint256 m,
uint128 a
) external returns
(uint128)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | address of the underlying asset |
m | uint256 | maturity (timestamp) of the market |
a | uint128 | amount of underlying tokens to sell |
Returns:
Type | Description |
|---|---|
uint128 | amount of PT received |
sells the underlying for the PT via the pool
Declaration
function sellUnderlying(
address u,
uint256 m,
uint128 a
) external returns
(uint128)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | address of the underlying asset |
m | uint256 | maturity (timestamp) of the market |
a | uint128 | amount of underlying to swap |
Returns:
Type | Description |
|---|---|
uint128 | amount of underlying sold |
buys the underlying for the PT via the pool
Declaration
function buyUnderlying(
address u,
uint256 m,
uint128 a
) external returns
(uint128)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | address of the underlying asset |
m | uint256 | maturity (timestamp) of the market |
a | uint128 | amount of PT to swap |
Returns:
Type | Description |
|---|---|
uint128 | amount of underlying bought |
mint liquidity tokens in exchange for adding underlying and PT
amount of liquidity tokens to mint is calculated from the amount of unaccounted for PT in this contract. A proportional amount of underlying tokens need to be present in this contract, also unaccounted for.
Declaration
function mint(
address u,
uint256 m,
uint256 uA,
uint256 ptA,
uint256 minRatio,
uint256 maxRatio
) external returns
(uint256, uint256, uint256)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | the address of the underlying token |
m | uint256 | the maturity of the principal token |
uA | uint256 | the underlying amount being sent |
ptA | uint256 | the principal token amount being sent |
minRatio | uint256 | minimum ratio of underlying to PT in the pool. |
maxRatio | uint256 | maximum ratio of underlying to PT in the pool. |
Returns:
Type | Description |
|---|---|
uint256 | the amount of liquidity tokens minted. |
Mint liquidity tokens in exchange for adding only underlying
amount of liquidity tokens is calculated from the amount of PT to buy from the pool, plus the amount of unaccounted for PT in this contract.
Declaration
function mintWithUnderlying(
address u,
uint256 m,
uint256 a,
uint256 ptBought,
uint256 minRatio,
uint256 maxRatio
) external returns
(uint256, uint256, uint256)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | the address of the underlying token |
m | uint256 | the maturity of the principal token |
a | uint256 | the underlying amount being sent |
ptBought | uint256 | amount of PT being bought in the Pool, from this we calculate how much underlying it will be taken in. |
minRatio | uint256 | minimum ratio of underlying to PT in the pool. |
maxRatio | uint256 | maximum ratio of underlying to PT in the pool. |
Returns:
Type | Description |
|---|---|
uint256 | the amount of liquidity tokens minted |
burn liquidity tokens in exchange for underlying and PT.
Declaration
function burn(
address u,
uint256 m,
uint256 minRatio,
uint256 maxRatio
) external returns
(uint256, uint256, uint256)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | the address of the underlying token |
m | uint256 | the maturity of the principal token |
minRatio | uint256 | minimum ratio of underlying to PT in the pool. |
maxRatio | uint256 | maximum ratio of underlying to PT in the pool. |
Returns:
Type | Description |
|---|---|
uint256 | amount of tokens burned and returned (tokensBurned, underlyings, PTs). |
burn liquidity tokens in exchange for underlying.
Declaration
function burnForUnderlying(
address u,
uint256 m,
uint256 minRatio,
uint256 maxRatio
) external returns
(uint256, uint256)
Modifiers:
No modifiers
Args:
Arg | Type | Description |
|---|---|---|
u | address | the address of the underlying token |
m | uint256 | the maturity of the principal token |
minRatio | uint256 | minimum ratio of underlying to PT in the pool. |
maxRatio | uint256 | minimum ratio of underlying to PT in the pool. |
Returns:
Type | Description |
|---|---|
uint256 | amount of underlying tokens returned |
uint256 | amount of PT tokens sent to the pool |
emitted upon the creation of a new market
Last modified 5mo ago