OfferTypeβ
enum OfferType {
Bid,
Ask
}
IHasOfferListOfOfferTypeβ
offerListOfOfferTypeβ
function offerListOfOfferType(enum OfferType ba) internal view virtual returns (struct OLKey olKey)
turns an offer type into an (outbound_tkn, inbound_tkn, tickSpacing) pair identifying an offer list.
Parametersβ
Name | Type | Description |
---|
ba | enum OfferType | whether one wishes to access the offer lists where asks or bids are posted. |
Return Valuesβ
Name | Type | Description |
---|
olKey | struct OLKey | the olKey defining the token pair |
offerTypeOfOutboundβ
function offerTypeOfOutbound(contract IERC20 outbound_tkn) internal view virtual returns (enum OfferType ba)
returns the offer type of the offer list whose outbound token is given in the argument.
Parametersβ
Name | Type | Description |
---|
outbound_tkn | contract IERC20 | the outbound token |
Return Valuesβ
Name | Type | Description |
---|
ba | enum OfferType | the offer type |
outboundOfOfferTypeβ
function outboundOfOfferType(enum OfferType ba) internal view virtual returns (contract IERC20 token)
returns the outbound token for the offer type
Parametersβ
Name | Type | Description |
---|
ba | enum OfferType | the offer type |
Return Valuesβ
Name | Type | Description |
---|
token | contract IERC20 | the outbound token |
TradesBaseQuotePairβ
Implements the IHasOfferListOfOfferType interface contract.
base of the market Kandel is making
quote of the market Kandel is making
TICK_SPACINGβ
tickSpacing of the market Kandel is making
OfferListKeyβ
event OfferListKey(bytes32 olKeyHash)
The traded offer list
we only emit this, so that the events for a Kandel is self contained. If one uses the KandelSeeder to deploy, then this information is already available from NewKandel or NewAaveKandel events.
Parametersβ
Name | Type | Description |
---|
olKeyHash | bytes32 | of the market Kandel is making |
constructorβ
constructor(struct OLKey olKeyBaseQuote) internal
Constructor
Parametersβ
Name | Type | Description |
---|
olKeyBaseQuote | struct OLKey | The OLKey for the outbound_tkn base and inbound_tkn quote offer list Kandel will act on, the flipped OLKey is used for the opposite offer list. |
offerListOfOfferTypeβ
function offerListOfOfferType(enum OfferType ba) internal view returns (struct OLKey olKey)
turns an offer type into an (outbound_tkn, inbound_tkn, tickSpacing) pair identifying an offer list.
Parametersβ
Name | Type | Description |
---|
ba | enum OfferType | whether one wishes to access the offer lists where asks or bids are posted. |
Return Valuesβ
Name | Type | Description |
---|
olKey | struct OLKey | the olKey defining the token pair |
offerTypeOfOutboundβ
function offerTypeOfOutbound(contract IERC20 outbound_tkn) internal view returns (enum OfferType)
returns the offer type of the offer list whose outbound token is given in the argument.
Parametersβ
Name | Type | Description |
---|
outbound_tkn | contract IERC20 | the outbound token |
Return Valuesβ
Name | Type | Description |
---|
[0] | enum OfferType | |
outboundOfOfferTypeβ
function outboundOfOfferType(enum OfferType ba) internal view returns (contract IERC20 token)
returns the outbound token for the offer type
Parametersβ
Name | Type | Description |
---|
ba | enum OfferType | the offer type |
Return Valuesβ
Name | Type | Description |
---|
token | contract IERC20 | the outbound token |
function dual(enum OfferType ba) internal pure returns (enum OfferType baDual)
returns the dual offer type
Parametersβ
Name | Type | Description |
---|
ba | enum OfferType | whether the offer is an ask or a bid |
Return Valuesβ
Name | Type | Description |
---|
baDual | enum OfferType | is the dual offer type (ask for bid and conversely) |