examples/max_pain.py

@@ -1,239 +0,0 @@
-#!/usr/bin/env python
-from decimal import (
-    Decimal,
-)
-import trio
-import tractor
-from datetime import datetime
-from pprint import pformat
-from piker.brokers.deribit.api import (
-    get_client,
-    maybe_open_oi_feed,
-)
-import sys
-import pyqtgraph as pg
-from PyQt6 import QtCore
-from pyqtgraph import ScatterPlotItem, InfiniteLine
-from PyQt6.QtWidgets import QApplication
-
-def check_if_complete(
-        oi: dict[str, dict[str, Decimal | None]]
-    ) -> bool:
-    return all(
-        oi[strike]['C'] is not None
-        and
-        oi[strike]['P'] is not None for strike in oi
-    )
-
-
-async def max_pain_daemon(
-) -> None:
-    oi_by_strikes: dict[str, dict[str, Decimal | None]]
-    instruments: list[Symbol] = []
-    expiry_dates: list[str]
-    expiry_date: str
-    currency: str = 'btc'
-    kind: str = 'option'
-
-    async with get_client(
-    ) as client:
-        expiry_dates: list[str] = await client.get_expiration_dates(
-            currency=currency,
-            kind=kind
-        )
-
-        print(f'Available expiration dates for {currency}-{kind}:')
-        print(f'{expiry_dates}')
-        expiry_date = input('Please enter a valid expiration date: ').upper()
-        print('Starting little daemon...')
-
-        oi_by_strikes: dict[str, dict[str, Decimal]]
-        instruments = await client.get_instruments(
-            expiry_date=expiry_date,
-        )
-        oi_by_strikes = client.get_strikes_dict(instruments)
-
-
-    def get_total_intrinsic_values(
-        oi_by_strikes: dict[str, dict[str, Decimal]]
-    ) -> dict[str, dict[str, Decimal]]:
-        call_cash: Decimal = Decimal(0)
-        put_cash: Decimal = Decimal(0)
-        intrinsic_values: dict[str, dict[str, Decimal]] = {}
-        closes: list = sorted(Decimal(close) for close in oi_by_strikes)
-
-        for strike, oi in oi_by_strikes.items():
-            s = Decimal(strike)
-            call_cash = sum(max(0, (s - c) * oi_by_strikes[str(c)]['C']) for c in closes)
-            put_cash = sum(max(0, (c - s) * oi_by_strikes[str(c)]['P']) for c in closes)
-
-            intrinsic_values[strike] = {
-                'C': call_cash,
-                'P': put_cash,
-                'total': call_cash + put_cash,
-            }
-
-        return intrinsic_values
-
-    def get_intrinsic_value_and_max_pain(
-        intrinsic_values: dict[str, dict[str, Decimal]]
-        ):
-        # We meed to find the lowest value, so we start at
-        # infinity to ensure that, and the max_pain must be
-        # an amount greater than zero.
-        total_intrinsic_value: Decimal = Decimal('Infinity')
-        max_pain: Decimal = Decimal(0)
-
-        for strike, oi in oi_by_strikes.items():
-            s = Decimal(strike)
-            if intrinsic_values[strike]['total'] < total_intrinsic_value:
-                total_intrinsic_value = intrinsic_values[strike]['total']
-                max_pain = s
-
-        return total_intrinsic_value, max_pain
-
-    def plot_graph(
-        oi_by_strikes: dict[str, dict[str, Decimal]],
-        plot,
-    ):
-        """Update the bar graph with new open interest data."""
-        plot.clear()
-
-        intrinsic_values = get_total_intrinsic_values(oi_by_strikes)
-
-        for strike_str in sorted(oi_by_strikes, key=lambda x: int(x)):
-            strike = int(strike_str)
-            calls_val = float(oi_by_strikes[strike_str]['C'])
-            puts_val  = float(oi_by_strikes[strike_str]['P'])
-
-            bar_c = pg.BarGraphItem(
-                x=[strike - 100],
-                height=[calls_val],
-                width=200,
-                pen='w',
-                brush=(0, 0, 255, 150)
-            )
-            plot.addItem(bar_c)
-
-            bar_p = pg.BarGraphItem(
-                x=[strike + 100],
-                height=[puts_val],
-                width=200,
-                pen='w',
-                brush=(255, 0, 0, 150)
-            )
-            plot.addItem(bar_p)
-
-            total_val = float(intrinsic_values[strike_str]['total']) / 100000
-
-            scatter_iv = ScatterPlotItem(
-                x=[strike],
-                y=[total_val],
-                pen=pg.mkPen(color=(0, 255, 0), width=2),
-                brush=pg.mkBrush(0, 255, 0, 150),
-                size=3,
-                symbol='o'
-            )
-            plot.addItem(scatter_iv)
-
-        _, max_pain = get_intrinsic_value_and_max_pain(intrinsic_values)
-
-        vertical_line = InfiniteLine(
-            pos=max_pain,
-            angle=90,
-            pen=pg.mkPen(color='yellow', width=1, style=QtCore.Qt.PenStyle.DotLine),
-            label=f'Max pain: {max_pain:,.0f}',
-            labelOpts={
-                'position': 0.85,
-                'color': 'yellow',
-                'movable': True
-            }
-        )
-        plot.addItem(vertical_line)
-
-    def update_oi_by_strikes(msg: tuple):
-        nonlocal oi_by_strikes
-        if 'oi' == msg[0]:
-            strike_price = msg[1]['strike_price']
-            option_type = msg[1]['option_type']
-            open_interest = msg[1]['open_interest']
-            oi_by_strikes.setdefault(
-                strike_price, {}
-            ).update(
-                {option_type: open_interest}
-            )
-
-    def get_max_pain(
-        oi_by_strikes: dict[str, dict[str, Decimal]]
-    ) -> dict[str, str | Decimal]:
-        '''
-        This method requires only the strike_prices and oi for call
-        and puts, the closes list are the same as the strike_prices
-        the idea is to sum all the calls and puts cash for each strike
-        and the ITM strikes from that strike, the lowest value is what we
-        are looking for the intrinsic value.
-
-        '''
-
-        nonlocal timestamp
-
-        intrinsic_values = get_total_intrinsic_values(oi_by_strikes)
-
-        total_intrinsic_value, max_pain = get_intrinsic_value_and_max_pain(intrinsic_values)
-
-        return {
-            'timestamp': timestamp,
-            'expiry_date': expiry_date,
-            'total_intrinsic_value': total_intrinsic_value,
-            'max_pain': max_pain,
-        }
-
-    async with maybe_open_oi_feed(
-        instruments,
-    ) as oi_feed:
-        # Initialize QApplication
-        app = QApplication(sys.argv)
-
-        win = pg.GraphicsLayoutWidget(show=True)
-        win.setWindowTitle('Calls (blue) vs Puts (red)')
-
-        plot = win.addPlot(title='OI by Strikes')
-        plot.showGrid(x=True, y=True)
-        print('Plot initialized...')
-
-        async for msg in oi_feed:
-
-            update_oi_by_strikes(msg)
-            if check_if_complete(oi_by_strikes):
-                if 'oi' == msg[0]:
-                    timestamp = msg[1]['timestamp']
-                    max_pain = get_max_pain(oi_by_strikes)
-                    intrinsic_values = get_total_intrinsic_values(oi_by_strikes)
-
-                    # graph here
-                    plot_graph(oi_by_strikes, plot)
-
-                    print('-----------------------------------------------')
-                    print(f'timestamp:             {datetime.fromtimestamp(max_pain['timestamp'])}')
-                    print(f'expiry_date:           {max_pain['expiry_date']}')
-                    print(f'max_pain:              {max_pain['max_pain']:,.0f}')
-                    print(f'total intrinsic value: {max_pain['total_intrinsic_value']:,.0f}')
-                    print('-----------------------------------------------')
-
-            # Process GUI events to keep the window responsive
-            app.processEvents()
-
-
-async def main():
-
-    async with tractor.open_nursery() as n:
-
-        p: tractor.Portal = await n.start_actor(
-            'max_pain_daemon',
-            enable_modules=[__name__],
-            infect_asyncio=True,
-        )
-        await p.run(max_pain_daemon)
-
-if __name__ == '__main__':
-    trio.run(main)

examples/max_pain_readme.rst

@@ -1,19 +0,0 @@
-## Max Pain Calculation for Deribit Options
-
-This feature, which calculates the max pain point for options traded on the Deribit exchange using cryptofeed library.
-
-- Functions in the api module for fetching options data from Deribit. [commit](https://pikers.dev/pikers/piker/commit/da55856dd2876291f55a06eb0561438a912d8241)
-
-- Compute the max pain point based on open interest data using deribit's api. [commit](https://pikers.dev/pikers/piker/commit/0d9d6e15ba0edeb662ec97f7599dd66af3046b94)
-
-### How to test it?
-
-**Before start:** in order to get this working with `uv`,  you **must** use my `tractor` [fork](https://pikers.dev/ntorres/tractor/src/branch/aio_abandons) and this branch: `aio_abandons`, the reason is that I cherry-pick the `uv_migration` that guille made, for some reason that a didn't dive into, in my system y need tractor using `uv` too. quite hacky I guess.
-
-1. `uv lock`
-
-2. `uv run --no-dev python examples/max_pain.py`
-
-3. A message should be display, enter one of the expiration date available.
-
-4. The script should be up and running.

piker/brokers/deribit/api.py

@@ -379,82 +379,6 @@ class Client:
 
         return flat
 
-    async def get_instruments(
-        self,
-        currency: str = 'btc',
-        kind: str = 'option',
-        expired: bool = False,
-        expiry_date: str = None,
-
-    ) -> list[Symbol]:
-        """
-        Get instruments for cryptoFeed.FeedHandler.
-        """
-        params: dict[str, str] = {
-            'currency': currency.upper(),
-            'kind': kind,
-            'expired': expired,
-        }
-
-        r: JSONRPCResult = await self._json_rpc_auth_wrapper(
-            'public/get_instruments',
-            params,
-        )
-        resp = r.result
-        response_list = []
-
-        for i in range(len(resp)):
-            element = resp[i]
-            name = f'{element["instrument_name"].split("-")[1]}'
-            if not expiry_date or name == expiry_date.upper():
-                response_list.append(piker_sym_to_cb_sym(element['instrument_name']))
-
-        return response_list
-
-    async def get_expiration_dates(
-        self,
-        currency: str = 'btc',
-        kind: str = 'option',
-
-    ) ->  list[str]:
-        """
-        Get a dict with all expiration dates listed as value and currency as key.
-        """
-
-        params: dict[str, str] = {
-            'currency': currency.upper(),
-            'kind': kind,
-        }
-
-        r: JSONRPCResult = await self._json_rpc_auth_wrapper(
-            'public/get_expirations',
-            params,
-        )
-        resp = r.result
-
-        return resp[currency][kind]
-
-    def get_strikes_dict(
-        self,
-        instruments: list[Symbol],
-
-    ) -> dict[str, dict[str, Decimal | None]]:
-        """
-        Get a dict with strike prices as keys.
-        """
-
-        response: dict[str, dict[str, Decimal | None]] = {}
-
-        for i in range(len(instruments)):
-            element = instruments[i]
-            strike = f'{str(element).split('-')[1]}'
-            response[f'{strike}'] = {
-                'C': None,
-                'P': None,
-            }
-
-        return response
-
     async def submit_limit(
         self,
         symbol: str,
@@ -835,117 +759,6 @@ async def maybe_open_price_feed(
 
 
 
-async def aio_open_interest_feed_relay(
-    fh: FeedHandler,
-    instruments: list[Symbol],
-    from_trio: asyncio.Queue,
-    to_trio: trio.abc.SendChannel,
-) -> None:
-    async def _trade(
-        trade: Trade,  # cryptofeed, NOT ours from `.venues`!
-        receipt_timestamp: int,
-    ) -> None:
-        '''
-        Proxy-thru `cryptofeed.FeedHandler` "trades" to `piker`-side.
-
-        '''
-        to_trio.send_nowait(('trade', trade))
-
-	# trade and oi are user defined functions that
-	# will be called when trade and open interest updates are received
-	# data type is not dict, is an object: cryptofeed.types.OpenINterest
-    async def _oi(
-        oi: OpenInterest,
-        receipt_timestamp: int,
-    ) -> None:
-        '''
-        Proxy-thru `cryptofeed.FeedHandler` "oi" to `piker`-side.
-
-        '''
-        symbol: Symbol = str_to_cb_sym(oi.symbol)
-        piker_sym: str = cb_sym_to_deribit_inst(symbol)
-        (
-            base,
-            expiry_date,
-            strike_price,
-            option_type
-        ) = tuple(
-            piker_sym.split('-')
-        )
-        msg = {
-            'timestamp': oi.timestamp,
-            'strike_price': strike_price,
-            'option_type': option_type,
-            'open_interest': Decimal(oi.open_interest),
-        }
-        to_trio.send_nowait(('oi', msg))
-
-
-    channels = [TRADES, OPEN_INTEREST]
-    callbacks={TRADES: _trade, OPEN_INTEREST: _oi}
-
-    fh.add_feed(
-        DERIBIT,
-        channels=channels,
-        symbols=instruments,
-        callbacks=callbacks
-    )
-
-    if not fh.running:
-        fh.run(
-            start_loop=False,
-            install_signal_handlers=False
-        )
-
-    # sync with trio
-    to_trio.send_nowait(None)
-
-    # run until cancelled
-    await asyncio.sleep(float('inf'))
-
-
-@acm
-async def open_oi_feed(
-    instruments: list[Symbol],
-) -> to_asyncio.LinkedTaskChannel:
-
-    fh: FeedHandler
-    first: None
-    chan: to_asyncio.LinkedTaskChannel
-    async with (
-        maybe_open_feed_handler() as fh,
-        to_asyncio.open_channel_from(
-            partial(
-                aio_open_interest_feed_relay,
-                fh,
-                instruments,
-            )
-        ) as (first, chan)
-    ):
-        yield chan
-
-
-@acm
-async def maybe_open_oi_feed(
-    instruments: list[Symbol],
-) -> trio.abc.ReceiveStream:
-
-    # TODO: add a predicate to maybe_open_context
-    feed: to_asyncio.LinkedTaskChannel
-    async with maybe_open_context(
-        acm_func=open_oi_feed,
-        kwargs={
-            'instruments': instruments
-        },
-        key=f'{instruments[0].base}',
-
-    ) as (cache_hit, feed):
-        if cache_hit:
-            yield broadcast_receiver(feed, 10)
-        else:
-            yield feed
-
-
 # TODO, move all to `.broker` submod!
 # async def aio_order_feed_relay(
 #     fh: FeedHandler,