Skip to main content
Version: mainnet (v0.71)

LiquidityProvisionUpdate

The command to be sent to the chain for a liquidity provision submission

type LiquidityProvisionUpdate {
id: ID
partyID: ID!
createdAt: Timestamp!
updatedAt: Timestamp
marketID: ID!
commitmentAmount: String!
fee: String!
sells: [LiquidityOrderReference!]!
buys: [LiquidityOrderReference!]!
version: String!
status: LiquidityProvisionStatus!
reference: String
}

Fields

LiquidityProvisionUpdate.id ● ID scalar

Unique identifier for the order (set by the system after consensus)

LiquidityProvisionUpdate.partyID ● ID! non-null scalar

The party making this commitment

LiquidityProvisionUpdate.createdAt ● Timestamp! non-null scalar

When the liquidity provision was initially created (formatted RFC3339)

LiquidityProvisionUpdate.updatedAt ● Timestamp scalar

RFC3339Nano time of when the liquidity provision was updated

LiquidityProvisionUpdate.marketID ● ID! non-null scalar

Market for the order

LiquidityProvisionUpdate.commitmentAmount ● String! non-null scalar

Specified as a unit-less number that represents the amount of settlement asset of the market.

LiquidityProvisionUpdate.fee ● String! non-null scalar

Nominated liquidity fee factor, which is an input to the calculation of liquidity fees on the market, as per setting fees and rewarding liquidity providers.

LiquidityProvisionUpdate.sells ● [LiquidityOrderReference!]! non-null object

A set of liquidity sell orders to meet the liquidity provision obligation.

LiquidityProvisionUpdate.buys ● [LiquidityOrderReference!]! non-null object

A set of liquidity buy orders to meet the liquidity provision obligation.

LiquidityProvisionUpdate.version ● String! non-null scalar

The version of this liquidity provision

LiquidityProvisionUpdate.status ● LiquidityProvisionStatus! non-null enum

The current status of this liquidity provision

LiquidityProvisionUpdate.reference ● String scalar

A reference for the orders created out of this liquidity provision

Returned by

liquidityProvisions subscription