roi.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. from __future__ import annotations
  2. import dataclasses
  3. import json
  4. import typing
  5. import cache
  6. def main() -> None:
  7. recipes: list[Recipe] = cache.get('https://api.prunplanner.org/data/recipes/')
  8. buildings: dict[str, Building] = {m['building_ticker']: m for m in cache.get('https://api.prunplanner.org/data/buildings/')}
  9. materials: dict[str, Material] = {m['ticker']: m for m in cache.get('https://api.prunplanner.org/data/materials/')}
  10. raw_prices: list[RawPrice] = cache.get('https://refined-prun.github.io/refined-prices/all.json')
  11. hq_levels_raw = cache.get('https://raw.githubusercontent.com/PRUNplanner/frontend/ec2ab897624121186f7de8e6c2e28ebf292f4432/src/features/hq_upgrade_calculator/hq_levels.json')
  12. for cx in ['AI1', 'CI1', 'IC1', 'NC1']:
  13. profits = calc_for_cx(cx, recipes, buildings, materials, raw_prices, hq_levels_raw)
  14. with open(f'www/roi_{cx.lower()}.json', 'w') as f:
  15. json.dump([dataclasses.asdict(p) for p in profits], f, indent='\t')
  16. def calc_for_cx(cx: str, recipes: typing.Collection[Recipe], buildings: typing.Mapping[str, Building],
  17. materials: typing.Mapping[str, Material], raw_prices: typing.Collection[RawPrice],
  18. hq_levels_raw: dict) -> typing.Sequence[Profit]:
  19. prices: dict[str, Price] = {
  20. p['MaterialTicker']: Price(p['VWAP7D'], p['AverageTraded7D'], p['VWAP30D'], p['Bid'], p['Ask']) for p in raw_prices # pyright: ignore[reportArgumentType]
  21. if p['ExchangeCode'] == cx
  22. }
  23. hq_costs: dict[str, dict[str, float]] = {}
  24. for level_str, mats in hq_levels_raw.items():
  25. cost = {'vwap': 0.0, 'bid': 0.0, 'ask': 0.0}
  26. for mat in mats:
  27. if mat['ticker'] in prices:
  28. m_metrics = get_metrics(mat['amount'], prices[mat['ticker']])
  29. for k in cost: cost[k] += m_metrics[k]
  30. hq_costs[level_str] = cost
  31. habitation: typing.Mapping[Worker, str] = {
  32. 'pioneers': 'HB1',
  33. 'settlers': 'HB2',
  34. 'technicians': 'HB3',
  35. 'engineers': 'HB4',
  36. 'scientists': 'HB5',
  37. }
  38. hab_area_cost: dict[Worker, float] = {}
  39. hab_capex: dict[Worker, dict[str, float]] = {}
  40. for worker, hab in habitation.items():
  41. hab_area_cost[worker] = buildings[hab]['area_cost'] / 100
  42. base_capex = building_construction_cost(buildings[hab], prices)
  43. hab_capex[worker] = {k: v / 100 for k, v in base_capex.items()}
  44. profits: list[Profit] = []
  45. for recipe in recipes:
  46. if profit := calc_profit(recipe, buildings, hab_area_cost, hab_capex, materials, prices, hq_costs):
  47. profits.append(profit)
  48. profits.sort()
  49. return profits
  50. def get_metrics(amount: float, price: Price) -> dict[str, float]:
  51. v = price.vwap_7d or price.vwap_30d or 0.0
  52. b = price.bid if price.bid is not None else v
  53. a = price.ask if price.ask is not None else v
  54. return {'vwap': amount * v, 'bid': amount * b, 'ask': amount * a}
  55. def calc_profit(recipe: Recipe, buildings: typing.Mapping[str, Building], hab_area_cost: typing.Mapping[Worker, float],
  56. hab_capex: typing.Mapping[Worker, dict[str, float]], materials: typing.Mapping[str, Material],
  57. prices: typing.Mapping[str, Price], hq_costs: dict[str, dict[str, float]]) -> Profit | None:
  58. if len(recipe['outputs']) == 0:
  59. return
  60. building = buildings[recipe['building_ticker']]
  61. area = building['area_cost'] + sum(hab_area_cost[worker] * building[worker] for worker in hab_area_cost)
  62. runs_per_day = 24 * 60 * 60 * 1000 / recipe['time_ms'] * 1.25 # assume CoGC
  63. if building['building_ticker'] in ('FRM', 'ORC'):
  64. runs_per_day *= 1.1212 # promitor's fertility
  65. outputs: list[MatPrice] = []
  66. revenue = {'vwap': 0.0, 'bid': 0.0, 'ask': 0.0}
  67. output_prices: dict[str, PriceNonNull] = {}
  68. for output in recipe['outputs']:
  69. price = prices[output['material_ticker']]
  70. if price.vwap_7d is None or price.average_traded_7d is None:
  71. return # skip recipes with thinly traded outputs
  72. output_prices[output['material_ticker']] = typing.cast(PriceNonNull, price)
  73. m = get_metrics(output['material_amount'] * runs_per_day, price)
  74. for k in revenue: revenue[k] += m[k]
  75. outputs.append(MatPrice(output['material_ticker'], output['material_amount'], price.vwap_7d, price.bid, price.ask))
  76. input_costs: list[MatPrice] = []
  77. opex = {'vwap': 0.0, 'bid': 0.0, 'ask': 0.0}
  78. for input in recipe['inputs']:
  79. price = prices[input['material_ticker']]
  80. if price.vwap_7d is None:
  81. return # skip recipes with thinly traded inputs
  82. m = get_metrics(input['material_amount'] * runs_per_day, price)
  83. for k in opex: opex[k] += m[k]
  84. input_costs.append(MatPrice(input['material_ticker'], input['material_amount'], price.vwap_7d, price.bid, price.ask))
  85. worker_consumable = building_daily_cost(building, prices)
  86. for k in opex: opex[k] += worker_consumable[k]
  87. capex = building_construction_cost(building, prices)
  88. for worker, hab_cost in hab_capex.items():
  89. workers = building[worker]
  90. if workers > 0:
  91. for k in capex: capex[k] += hab_cost[k] * workers
  92. lowest_liquidity = min(recipe['outputs'],
  93. key=lambda output: output['material_amount'] / output_prices[output['material_ticker']].average_traded_7d)
  94. output_per_day = lowest_liquidity['material_amount'] * runs_per_day
  95. average_traded_7d = output_prices[lowest_liquidity['material_ticker']].average_traded_7d
  96. output_per_base = output_per_day / (area / 500)
  97. market_capacity_base = average_traded_7d / output_per_base
  98. in_w = sum(materials[input['material_ticker']]['weight'] * input['material_amount'] for input in recipe['inputs'])
  99. in_v = sum(materials[input['material_ticker']]['volume'] * input['material_amount'] for input in recipe['inputs'])
  100. out_w = sum(materials[output['material_ticker']]['weight'] * output['material_amount'] for output in recipe['outputs'])
  101. out_v = sum(materials[output['material_ticker']]['volume'] * output['material_amount'] for output in recipe['outputs'])
  102. runs_per_base = runs_per_day / (area / 500)
  103. # EXTREME DETAIL: We extract the normalized fraction of a ship required.
  104. # We pass this to the frontend as `normalized_logistics_per_base` so TS can use it
  105. # to accurately sort and calculate percentiles, regardless of unit type (t vs m³).
  106. normalized_logistics_per_base = max(in_w / 3000, in_v / 1000, out_w / 3000, out_v / 1000) * runs_per_base
  107. ship_capex_per_base = normalized_logistics_per_base * 800_000
  108. bottlenecks = [
  109. (in_w, 't (I)'),
  110. (in_v, 'm³ (I)'),
  111. (out_w, 't (O)'),
  112. (out_v, 'm³ (O)')
  113. ]
  114. max_logistics, logistics_bottleneck = max(bottlenecks, key=lambda x: x[0])
  115. logistics_per_base = max_logistics * runs_per_base
  116. return Profit(outputs, recipe['recipe_name'],
  117. expertise=building['expertise'],
  118. building=building['building_ticker'],
  119. area=area,
  120. capex=capex,
  121. opex=opex,
  122. revenue=revenue,
  123. input_costs=input_costs,
  124. runs_per_day=runs_per_day,
  125. logistics_per_base=logistics_per_base,
  126. normalized_logistics_per_base=normalized_logistics_per_base,
  127. logistics_bottleneck=logistics_bottleneck,
  128. output_per_day=output_per_day,
  129. average_traded_7d=average_traded_7d,
  130. market_capacity_base=market_capacity_base,
  131. ship_capex_per_base=ship_capex_per_base,
  132. hq_costs=hq_costs)
  133. def building_construction_cost(building: Building, prices: typing.Mapping[str, Price]) -> dict[str, float]:
  134. cost = {'vwap': 0.0, 'bid': 0.0, 'ask': 0.0}
  135. for bc in building['costs']:
  136. m = get_metrics(bc['material_amount'], prices[bc['material_ticker']])
  137. for k in cost: cost[k] += m[k]
  138. # https://handbook.apex.prosperousuniverse.com/wiki/building-costs/#rocky-planets
  139. mcg = get_metrics(building['area_cost'] * 4, prices['MCG'])
  140. for k in cost: cost[k] += mcg[k]
  141. return cost
  142. def building_daily_cost(building: Building, prices: typing.Mapping[str, Price]) -> dict[str, float]:
  143. consumption = {
  144. 'pioneers': [('COF', 0.5), ('DW', 4), ('RAT', 4), ('OVE', 0.5), ('PWO', 0.2)],
  145. 'settlers': [('DW', 5), ('RAT', 6), ('KOM', 1), ('EXO', 0.5), ('REP', 0.2), ('PT', 0.5)],
  146. 'technicians': [('DW', 7.5), ('RAT', 7), ('ALE', 1), ('MED', 0.5), ('SC', 0.1), ('HMS', 0.5), ('SCN', 0.1)],
  147. 'engineers': [('DW', 10), ('MED', 0.5), ('GIN', 1), ('FIM', 7), ('VG', 0.2), ('HSS', 0.2), ('PDA', 0.1)],
  148. 'scientists': [('DW', 10), ('MED', 0.5), ('WIN', 1), ('MEA', 7), ('NST', 0.1), ('LC', 0.2), ('WS', 0.05)],
  149. }
  150. cost = {'vwap': 0.0, 'bid': 0.0, 'ask': 0.0}
  151. for worker, mats in consumption.items():
  152. workers = building[worker]
  153. for mat, per_100 in mats:
  154. m = get_metrics(workers * per_100 / 100, prices[mat])
  155. for k in cost: cost[k] += m[k]
  156. return cost
  157. Worker = typing.Literal['pioneers', 'settlers', 'technicians', 'engineers', 'scientists']
  158. class Recipe(typing.TypedDict):
  159. recipe_name: str
  160. building_ticker: str
  161. inputs: list[RecipeMat]
  162. outputs: list[RecipeMat]
  163. time_ms: int
  164. class RecipeMat(typing.TypedDict):
  165. material_ticker: str
  166. material_amount: int
  167. class Building(typing.TypedDict):
  168. building_ticker: str
  169. expertise: str
  170. area_cost: int
  171. costs: list[BuildingMat]
  172. pioneers: int
  173. settlers: int
  174. technicians: int
  175. engineers: int
  176. scientists: int
  177. class BuildingMat(typing.TypedDict):
  178. material_ticker: str
  179. material_amount: int
  180. class Material(typing.TypedDict):
  181. ticker: str
  182. weight: float
  183. volume: float
  184. class RawPrice(typing.TypedDict):
  185. MaterialTicker: str
  186. ExchangeCode: str
  187. VWAP7D: float | None
  188. AverageTraded7D: float | None
  189. VWAP30D: float | None
  190. Bid: float | None
  191. Ask: float | None
  192. @dataclasses.dataclass(eq=False, frozen=True, slots=True)
  193. class Price:
  194. vwap_7d: float | None
  195. average_traded_7d: float | None
  196. vwap_30d: float | None
  197. bid: float | None
  198. ask: float | None
  199. @dataclasses.dataclass(eq=False, frozen=True, slots=True)
  200. class PriceNonNull:
  201. vwap_7d: float
  202. average_traded_7d: float
  203. @dataclasses.dataclass(eq=False, frozen=True, slots=True)
  204. class Profit:
  205. outputs: typing.Collection[MatPrice]
  206. recipe: str
  207. expertise: str
  208. building: str
  209. area: float
  210. capex: dict[str, float]
  211. opex: dict[str, float]
  212. revenue: dict[str, float]
  213. input_costs: typing.Collection[MatPrice]
  214. runs_per_day: float
  215. logistics_per_base: float
  216. normalized_logistics_per_base: float # Explicitly exported for TS mapping
  217. logistics_bottleneck: str
  218. output_per_day: float
  219. average_traded_7d: float
  220. market_capacity_base: float
  221. ship_capex_per_base: float
  222. hq_costs: dict[str, dict[str, float]]
  223. def __lt__(self, other: Profit) -> bool:
  224. bases_a = self.area / 500
  225. p_a = (self.revenue['vwap'] - self.opex['vwap']) / bases_a
  226. c_a = self.capex['vwap'] / bases_a
  227. o_a = self.opex['vwap'] / bases_a
  228. be_a = (c_a + 3 * o_a) / p_a if p_a > 0 else 10000 - p_a
  229. bases_b = other.area / 500
  230. p_b = (other.revenue['vwap'] - other.opex['vwap']) / bases_b
  231. c_b = other.capex['vwap'] / bases_b
  232. o_b = other.opex['vwap'] / bases_b
  233. be_b = (c_b + 3 * o_b) / p_b if p_b > 0 else 10000 - p_b
  234. return be_a < be_b
  235. @dataclasses.dataclass(eq=False, frozen=True, slots=True)
  236. class MatPrice:
  237. ticker: str
  238. amount: int
  239. vwap_7d: float
  240. bid: float | None
  241. ask: float | None
  242. if __name__ == '__main__':
  243. main()