IBondAggregator

Git Source

Functions

registerAuctioneer

Register a auctioneer with the aggregator

Only Guardian

A auctioneer must be registered with an aggregator to create markets

function registerAuctioneer(IBondAuctioneer auctioneer_) external;

Parameters

Name	Type	Description
auctioneer_	IBondAuctioneer	Address of the Auctioneer to register

registerMarket

Register a new market with the aggregator

Only registered depositories

function registerMarket(
        ERC20 payoutToken_,
        ERC20 quoteToken_
    ) external returns (uint256 marketId);

Parameters

Name	Type	Description
payoutToken_	ERC20	Token to be paid out by the market
quoteToken_	ERC20	Token to be accepted by the market

Returns

Name	Type	Description
marketId	uint256

getAuctioneer

Get the auctioneer for the provided market ID

function getAuctioneer(uint256 id_) external view returns (IBondAuctioneer);

Parameters

Name	Type	Description
id_	uint256	ID of Market

Returns

Name	Type	Description
<none>	IBondAuctioneer

marketPrice

Calculate current market price of payout token in quote tokens

Accounts for debt and control variable decay since last deposit (vs _marketPrice())

function marketPrice(uint256 id_) external view returns (uint256);

Parameters

Name	Type	Description
id_	uint256	ID of market

Returns

Name	Type	Description
<none>	uint256	Price for market (see the specific auctioneer for units)

marketScale

Scale value to use when converting between quote token and payout token amounts with marketPrice()

function marketScale(uint256 id_) external view returns (uint256);

Parameters

Name	Type	Description
id_	uint256	ID of market

Returns

Name	Type	Description
<none>	uint256	Scaling factor for market in configured decimals

payoutFor

Payout due for amount of quote tokens

Accounts for debt and control variable decay so it is up to date

function payoutFor(
        uint256 amount_,
        uint256 id_,
        address referrer_
    ) external view returns (uint256);

Parameters

Name	Type	Description
amount_	uint256	Amount of quote tokens to spend
id_	uint256	ID of market
referrer_	address	Address of referrer, used to get fees to calculate accurate payout amount. Inputting the zero address will take into account just the protocol fee.

Returns

Name	Type	Description
<none>	uint256	amount of payout tokens to be paid

maxAmountAccepted

Returns maximum amount of quote token accepted by the market

function maxAmountAccepted(uint256 id_, address referrer_) external view returns (uint256);

Parameters

Name	Type	Description
id_	uint256	ID of market
referrer_	address	Address of referrer, used to get fees to calculate accurate payout amount. Inputting the zero address will take into account just the protocol fee.

Returns

Name	Type	Description
<none>	uint256

isInstantSwap

Does market send payout immediately

function isInstantSwap(uint256 id_) external view returns (bool);

Parameters

Name	Type	Description
id_	uint256	Market ID to search for

Returns

Name	Type	Description
<none>	bool

isLive

Is a given market accepting deposits

function isLive(uint256 id_) external view returns (bool);

Parameters

Name	Type	Description
id_	uint256	ID of market

Returns

Name	Type	Description
<none>	bool

liveMarketsBetween

Returns array of active market IDs within a range

Should be used if length exceeds max to query entire array

function liveMarketsBetween(
        uint256 firstIndex_,
        uint256 lastIndex_
    ) external view returns (uint256[] memory);

Parameters

Name	Type	Description
firstIndex_	uint256
lastIndex_	uint256

Returns

Name	Type	Description
<none>	uint256[]

liveMarketsFor

Returns an array of all active market IDs for a given quote token

function liveMarketsFor(
        address token_,
        bool isPayout_
    ) external view returns (uint256[] memory);

Parameters

Name	Type	Description
token_	address	Address of token to query by
isPayout_	bool	If true, search by payout token, else search for quote token

Returns

Name	Type	Description
<none>	uint256[]

liveMarketsBy

Returns an array of all active market IDs for a given owner

function liveMarketsBy(
        address owner_,
        uint256 firstIndex_,
        uint256 lastIndex_
    ) external view returns (uint256[] memory);

Parameters

Name	Type	Description
owner_	address	Address of owner to query by
firstIndex_	uint256	Market ID to start at
lastIndex_	uint256	Market ID to end at (non-inclusive)

Returns

Name	Type	Description
<none>	uint256[]

marketsFor

Returns an array of all active market IDs for a given payout and quote token

function marketsFor(address payout_, address quote_) external view returns (uint256[] memory);

Parameters

Name	Type	Description
payout_	address	Address of payout token
quote_	address	Address of quote token

Returns

Name	Type	Description
<none>	uint256[]

findMarketFor

Returns the market ID with the highest current payoutToken payout for depositing quoteToken

function findMarketFor(
        address payout_,
        address quote_,
        uint256 amountIn_,
        uint256 minAmountOut_,
        uint256 maxExpiry_
    ) external view returns (uint256 id);

Parameters

Name	Type	Description
payout_	address	Address of payout token
quote_	address	Address of quote token
amountIn_	uint256	Amount of quote tokens to deposit
minAmountOut_	uint256	Minimum amount of payout tokens to receive as payout
maxExpiry_	uint256	Latest acceptable vesting timestamp for bond Inputting the zero address will take into account just the protocol fee.

Returns

Name	Type	Description
id	uint256

getTeller

Returns the Teller that services the market ID

function getTeller(uint256 id_) external view returns (IBondTeller);

Parameters

Name	Type	Description
id_	uint256

Returns

Name	Type	Description
<none>	IBondTeller

currentCapacity

Returns current capacity of a market

function currentCapacity(uint256 id_) external view returns (uint256);

Parameters

Name	Type	Description
id_	uint256

Returns

Name	Type	Description
<none>	uint256