AuctionImmutableArgs
Inherits: Clone
Defines the immutable arguments for a dual auction
using the clones-with-immutable-args library we fetch args from the code section
Functions
bidAsset
The asset being used to make bids
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function bidAsset() public pure returns (ERC20);
Returns
Name | Type | Description |
---|---|---|
<none> | ERC20 | The asset being used to make bids |
askAsset
The asset being used to make asks
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function askAsset() public pure returns (ERC20);
Returns
Name | Type | Description |
---|---|---|
<none> | ERC20 | The asset being used to make asks |
minPrice
The minimum allowed price
prices are denominated as the numerator of the bidAsset/askAsset fraction. priceDenominator is the denominator.
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function minPrice() public pure returns (uint256);
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The minimum allowed price |
maxPrice
The maximum allowed price
prices are denominated as the numerator of the bidAsset/askAsset fraction. priceDenominator is the denominator.
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function maxPrice() public pure returns (uint256);
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The maximum allowed price |
tickWidth
The width of ticks i.e. allowed prices
prices are denominated as the numerator of the bidAsset/askAsset fraction. priceDenominator is the denominator.
Must evenly divide the range between minPrice and maxPrice by NUM_TICKS = 100.
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function tickWidth() public pure returns (uint256);
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The width of ticks |
priceDenominator
The underlying denominator used to calculate all the price fractions
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function priceDenominator() public pure returns (uint256);
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The number of decimals for the bid asset |
endDate
The timestamp at which the auction will end
using ClonesWithImmutableArgs pattern here to save gas
https://github.com/wighawag/clones-with-immutable-args
function endDate() public pure returns (uint256);
Returns
Name | Type | Description |
---|---|---|
<none> | uint256 | The timestamp at which the auction will end |