Parsing market position data

[bryantanjw]

Below is an example market position data when running npm run getMarketPosition for the wallet address EyfR2YqE6AvwA7ZjLyXPciimNt1NgHfRRaPxeYRwijCA in the CLI:

"data": {
    "purchaser": "EyfR2YqE6AvwA7ZjLyXPciimNt1NgHfRRaPxeYRwijCA",
    "market": "EwnL2W8zduqnfzuzRgpoQ4syeKv59ewZPNUXquAHgx4n",
    "marketOutcomeSums": [
      "00",
      "00"
    ],
    "outcomeMaxExposure": [
      "022b4470",
      "01cf8fe0"
    ],
    "offset": "01cf8fe0",
    "outcomePositions": {}
  }

I understand that outcomeMaxExposure indicates the potential loss/profit. What do marketOutcomeSums, offset, and outcomePositions mean? Why is the outcomePositions field empty when the wallet contains trades? 🫡

[obi-ewan]

Hey @bryantanjw

outcomeMaxExposure - this is the maximum amount of stake risked by the user for a given market
marketOutcomeSums - user's total market position for each outcome, i.e. how much they will profit or risk if the individual market outcomes are a win or loss
offset - amount which will be deducted from winnings during settlement, or stake refunded during bet cancellation. A non zero offset means you have used your market position to place bets without risking any more stake (this one is a bit confusing and we should have better documentation for)
outcomePositions - this should be a mapping of market outcome title -> market outcome sum, but it doesn't seem to be populating in your case (it is purely a client side mapping, so not on chain)

Example:

User risks $100 backing "OutcomeA" at a price of 2 in a 3 outcome market.

outcomeMaxExposure:  100 // user has risked a maximum of $100
marketOutcomeSums:  [100, -100, -100] // user will win $100 if Outcome A wins, but risks $100 on the other outcomes
offset: 0 // market position hasn't been leveraged to place additional orders
outcomePositions [
        "OutcomeA": 100, 
        "OutcomeB": -100, 
        "OutcomeC": -100
 ]

[bryantanjw]

Thanks for clearing that up! I'm trying to calculate and display a user's PnL for a market. Is there a way to query historical marketOutcomeSums for a market and wallet?

I saw, in the market_position_query.ts file in the latest release candidate ("@monaco-protocol/client": "3.0.0-rc1"), that there's a way to query the above but I couldn't import the MarketPositions class.

const marketPk = new PublicKey('7o1PXyYZtBBDFZf9cEhHopn2C9R4G6GaPwFAxaNWM33D')
const marketPositions = await MarketPositions.marketPositionQuery(program)
      .filterByMarket(marketPk)
      .filterByPaid(false)
      .fetch();

[obi-ewan]

The above code should do exactly that, we have been using this for some internal tests, although I'd recommend not using the .filterByPaid(false) filter as the protocol code hasn't quite been shipped yet:

import { MarketPositions } from "@monaco-protocol/client/src/market_position_query";
...
 const marketPositions = await MarketPositions.marketPositionQuery(program)
   .filterByMarket(marketPk)
   .fetch();

Why could you not import the class?

[bryantanjw]

I'm getting the error '"@monaco-protocol/client"' has no exported member named 'MarketPositions' when importing from the module's root directory but the above import path works. Thanks!

I assume that a new market position account is created every time there's a new trade in the market right?

[obi-ewan]

A new MarketPosition account will be created for a user (purchaser) the first time they place an order in a market