vega
vega copied to clipboard
Enhance liquidity provisions APIs with AMM details
API Overview
We need to show liquidity provision data for AMMs so that we can show that alongside the existing liquidity provisions data in console.
Its not completely clear at this point how much of the liquidity data is valid for a AMM. We already are proviiding details of the shape of AMM on #11023, so the question then is whether it is best to:
- Add the AMMs to the same set of APIs that we already have for regular LPs with any defaults applied where the data is not relevant
- Create a new AMM liquidity provision API which contains only the relevant parts for AMMs
- Append the liquidity provision data to the shape API already defined
Suggest we discuss that and agree a way forward.
Current APIs
liquidity/all-provisions
Provides basic details like commitment, fee, party ID etc for all active and pending commitments
liquidity/providers
Provides all details of the fee share each LP got, ELS, score, etc
liquidity/paidfees
Provides detils of the fees paid to LPs for a given market in a given epoch
Liquidity view in Console
Console joins all of these together to produce the current view of LPs here.
API request details
- [ ] Exact details TBC
Filtering requirements (inputs)
- [ ] Party ID
- [ ] Market ID
Questions
Work out how to actually provide this data, whether as part of existing APIs, or something new.
API test scenarios
Detailed scenarios that can be executed as feature tests to verify that the API has been implemented as expected.
GIVEN (setup/context) WHEN (action) THEN (assertion) For example... See here for more format information and examples.
Additional Details (optional)
Any additional information that provides context or gives information that will help us develop the feature.