Class MarketExecuteAPI

Hierarchy (view full)

BaseVertexAPI
- MarketExecuteAPI

Index

Constructors

Properties

Methods

mintLp burnLp placeOrder cancelOrders cancelAndPlace cancelProductOrders placeTriggerOrder cancelTriggerOrders cancelTriggerProductOrders

Constructors

constructor

new MarketExecuteAPI(context): MarketExecuteAPI
Parameters
- context: VertexClientContext
Returns MarketExecuteAPI
Inherited from BaseVertexAPI.constructor
- Defined in apis/base.ts:12

Properties

`Readonly`context

context: VertexClientContext

Methods

mintLp

mintLp(params): Promise<EngineServerExecuteSuccessResult<"mint_lp">>
Mint LP tokens through engine
Parameters
- params: MintLpParams
Returns Promise<EngineServerExecuteSuccessResult<"mint_lp">>
- Defined in apis/market/MarketExecuteAPI.ts:20

burnLp

burnLp(params): Promise<EngineServerExecuteSuccessResult<"burn_lp">>
Burn LP tokens through engine
Parameters
- params: BurnLpParams
Returns Promise<EngineServerExecuteSuccessResult<"burn_lp">>
- Defined in apis/market/MarketExecuteAPI.ts:33

placeOrder

placeOrder(params): Promise<EnginePlaceOrderResult>
Places an order through the engine
Parameters
- params: PlaceOrderParams
Returns Promise<EnginePlaceOrderResult>
- Defined in apis/market/MarketExecuteAPI.ts:46

cancelOrders

cancelOrders(params): Promise<EngineServerExecuteSuccessResult<"cancel_orders">>
Cancels orders through the engine
Parameters
- params: CancelOrdersParams
Returns Promise<EngineServerExecuteSuccessResult<"cancel_orders">>
- Defined in apis/market/MarketExecuteAPI.ts:67

cancelAndPlace

cancelAndPlace(params): Promise<EngineServerExecuteSuccessResult<"cancel_and_place">>
Cancels orders through the engine and places a new one
Parameters
- params: CancelAndPlaceOrderParams
Returns Promise<EngineServerExecuteSuccessResult<"cancel_and_place">>
- Defined in apis/market/MarketExecuteAPI.ts:80

cancelProductOrders

cancelProductOrders(params): Promise<EngineServerExecuteSuccessResult<"cancel_product_orders">>
Cancels all orders for provided products through the engine.
Parameters
- params: CancelProductOrdersParams
Returns Promise<EngineServerExecuteSuccessResult<"cancel_product_orders">>
- Defined in apis/market/MarketExecuteAPI.ts:115

placeTriggerOrder

placeTriggerOrder(params): Promise<TriggerServerExecuteSuccessResult<"place_order">>
Places a trigger order through the trigger service
Parameters
- params: PlaceTriggerOrderParams
Returns Promise<TriggerServerExecuteSuccessResult<"place_order">>
- Defined in apis/market/MarketExecuteAPI.ts:128

cancelTriggerOrders

cancelTriggerOrders(params): Promise<TriggerServerExecuteSuccessResult<"cancel_orders">>
Cancels all trigger orders for provided digests through the trigger service.
Parameters
- params: CancelTriggerOrdersParams
Returns Promise<TriggerServerExecuteSuccessResult<"cancel_orders">>
- Defined in apis/market/MarketExecuteAPI.ts:144

cancelTriggerProductOrders

cancelTriggerProductOrders(params): Promise<TriggerServerExecuteSuccessResult<"cancel_product_orders">>
Cancels all trigger orders for provided products through the trigger service.
Parameters
- params: CancelTriggerProductOrdersParams
Returns Promise<TriggerServerExecuteSuccessResult<"cancel_product_orders">>
- Defined in apis/market/MarketExecuteAPI.ts:157