Class: KandelSeeder
Seeder for creating Kandel instances on-chain.
Constructors
constructor
• new KandelSeeder(mgv): KandelSeeder
Constructor
Parameters
| Name | Type | Description |
|---|---|---|
mgv | Mangrove | The Mangrove to deploy to. |
Returns
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:37
Properties
mgv
• mgv: Mangrove
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:27
configuration
• configuration: KandelConfiguration
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:28
tradeEventManagement
• tradeEventManagement: TradeEventManagement
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:29
aaveKandelSeeder
• aaveKandelSeeder: AaveKandelSeeder
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:31
kandelSeeder
• kandelSeeder: KandelSeeder
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:32
Methods
sow
▸ sow(seed, overrides?): Promise<Transaction<GeometricKandelInstance>>
Create a new Kandel instance.
Parameters
| Name | Type | Description |
|---|---|---|
seed | KandelSeed | The parameters for sowing the Kandel instance. |
overrides | Overrides | - |
Returns
Promise<Transaction<GeometricKandelInstance>>
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:62
getKandelFromReceipt
▸ getKandelFromReceipt(params): Promise<GeometricKandelInstance>
Gets the Kandel instance created in a transaction via sow.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters. |
params.receipt | ContractReceipt | The receipt of the transaction. |
params.onAave | boolean | Whether the Kandel is an AaveKandel. |
params.market | Market | The market the Kandel is for. |
Returns
Promise<GeometricKandelInstance>
The Kandel instance created in the transaction.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:105
getDefaultGasreq
▸ getDefaultGasreq(onAave): Promise<number>
Retrieves the default gasreq for the Kandel type.
Parameters
| Name | Type | Description |
|---|---|---|
onAave | boolean | Whether to get the gasreq for an AaveKandel or a standard Kandel. |
Returns
Promise<number>
The gasreq for the Kandel type.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:145
getBufferedGasprice
▸ getBufferedGasprice(gaspriceFactor, gasprice?): Promise<number>
Retrieves the gasprice for the Kandel type multiplied by the buffer factor.
Parameters
| Name | Type | Description |
|---|---|---|
gaspriceFactor | number | The factor to multiply the gasprice by. This is used to ensure that the Kandel offers do not fail to be reposted even if Mangrove's gasprice increases up to this. |
gasprice? | number | The gasprice (in Mwei) to use for the Kandel (before multiplying with the factor). If null, then Mangrove's global gasprice will be used. |
Returns
Promise<number>
The gasprice for the Kandel type multiplied by the buffer factor.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:158
getRequiredProvision
▸ getRequiredProvision(seed, distribution, gaspriceFactor?, gasprice?, gasreq?): Promise<Big>
Determines the required provision for the distribution prior to sowing based on the number of price points.
Parameters
| Name | Type | Description |
|---|---|---|
seed | KandelSeed | The parameters for sowing the Kandel instance. |
distribution | KandelDistribution | The distribution to determine the provision for. |
gaspriceFactor? | number | The factor to multiply the gasprice by. This is used to ensure that the Kandel offers do not fail to be reposted even if Mangrove's gasprice increases up to this. If null, then the default gaspriceFactor for the market will be used. |
gasprice? | number | The gasprice (in Mwei) to use for the Kandel (before multiplying with the factor). If null, then Mangrove's global gasprice will be used. |
gasreq? | number | The gasreq to use for the Kandel. If null, then the default gasreq for the Kandel type will be used. |
Returns
Promise<Big>
The provision required for the distribution.
Remarks
This takes into account that each price point can become both an ask and a bid which both require provision.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:171
getMinimumVolume
▸ getMinimumVolume(params): Promise<Big>
Determines the minimum recommended volume for an offer of the given type to avoid density issues.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters. |
params.market | Market | The market the Kandel is deployed to. |
params.offerType | BA | The type of offer. |
params.onAave | boolean | Whether the Kandel is an AaveKandel. |
params.factor? | number | The factor to multiply the minimum volume by. Defaults to minimumBasePerOfferFactory / minimumQuotePerOfferFactor from KandelConfiguration. |
Returns
Promise<Big>
The minimum recommended volume.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:197
getMinimumVolumeForGasreq
▸ getMinimumVolumeForGasreq(params): Big
Determines the minimum recommended volume for an offer of the given type to avoid density issues.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters. |
params.market | Market | The market the Kandel is deployed to. |
params.offerType | BA | The type of offer. |
params.factor? | number | The factor to multiply the minimum volume by. Defaults to minimumBasePerOfferFactory / minimumQuotePerOfferFactor from KandelConfiguration. |
params.gasreq | number | The gasreq to use. |
Returns
Big
The minimum recommended volume.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:215