Add smart money event calendar enrichment
This commit is contained in:
parent
6108aea166
commit
6b794ec7ac
11 changed files with 270 additions and 8 deletions
|
|
@ -9,6 +9,7 @@
|
|||
"@islandflow/bus": "workspace:*",
|
||||
"@islandflow/config": "workspace:*",
|
||||
"@islandflow/observability": "workspace:*",
|
||||
"@islandflow/refdata": "workspace:*",
|
||||
"@islandflow/storage": "workspace:*",
|
||||
"@islandflow/types": "workspace:*",
|
||||
"redis": "^5.10.0",
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
import { readEnv } from "@islandflow/config";
|
||||
import { createLogger } from "@islandflow/observability";
|
||||
import {
|
||||
createEmptyEventCalendarProvider,
|
||||
loadEventCalendarProviderFromFile,
|
||||
type EventCalendarProvider
|
||||
} from "@islandflow/refdata/event-calendar";
|
||||
import {
|
||||
SUBJECT_ALERTS,
|
||||
SUBJECT_CLASSIFIER_HITS,
|
||||
|
|
@ -135,10 +140,12 @@ const envSchema = z.object({
|
|||
CLASSIFIER_MIN_AGGRESSOR_RATIO: z.coerce.number().min(0).max(1).default(0.55),
|
||||
CLASSIFIER_0DTE_MAX_ATM_PCT: z.coerce.number().min(0).max(1).default(0.01),
|
||||
CLASSIFIER_0DTE_MIN_PREMIUM: z.coerce.number().positive().default(20_000),
|
||||
CLASSIFIER_0DTE_MIN_SIZE: z.coerce.number().int().positive().default(400)
|
||||
CLASSIFIER_0DTE_MIN_SIZE: z.coerce.number().int().positive().default(400),
|
||||
SMART_MONEY_EVENT_CALENDAR_PATH: z.string().optional()
|
||||
});
|
||||
|
||||
const env = readEnv(envSchema);
|
||||
let eventCalendarProvider: EventCalendarProvider = createEmptyEventCalendarProvider();
|
||||
|
||||
const classifierConfig: ClassifierConfig = {
|
||||
sweepMinPremium: env.CLASSIFIER_SWEEP_MIN_PREMIUM,
|
||||
|
|
@ -898,7 +905,16 @@ const emitClassifiers = async (
|
|||
): Promise<void> => {
|
||||
let smartMoneyEvent: SmartMoneyEvent;
|
||||
try {
|
||||
smartMoneyEvent = SmartMoneyEventSchema.parse(buildSmartMoneyEventFromPacket(packet));
|
||||
const underlyingId =
|
||||
typeof packet.features.underlying_id === "string"
|
||||
? packet.features.underlying_id
|
||||
: parseContractId(typeof packet.features.option_contract_id === "string" ? packet.features.option_contract_id : "")?.root;
|
||||
const referenceTs =
|
||||
typeof packet.features.end_ts === "number" && Number.isFinite(packet.features.end_ts)
|
||||
? packet.features.end_ts
|
||||
: packet.source_ts;
|
||||
const eventCalendarMatch = underlyingId ? eventCalendarProvider.findNextEvent(underlyingId, referenceTs) : null;
|
||||
smartMoneyEvent = SmartMoneyEventSchema.parse(buildSmartMoneyEventFromPacket(packet, { eventCalendarMatch }));
|
||||
await insertSmartMoneyEvent(clickhouse, smartMoneyEvent);
|
||||
await publishJson(js, SUBJECT_SMART_MONEY_EVENTS, smartMoneyEvent);
|
||||
} catch (error) {
|
||||
|
|
@ -1200,6 +1216,19 @@ const run = async () => {
|
|||
database: env.CLICKHOUSE_DATABASE
|
||||
});
|
||||
|
||||
if (env.SMART_MONEY_EVENT_CALENDAR_PATH) {
|
||||
try {
|
||||
eventCalendarProvider = await loadEventCalendarProviderFromFile(env.SMART_MONEY_EVENT_CALENDAR_PATH);
|
||||
logger.info("smart money event calendar loaded", { path: env.SMART_MONEY_EVENT_CALENDAR_PATH });
|
||||
} catch (error) {
|
||||
eventCalendarProvider = createEmptyEventCalendarProvider();
|
||||
logger.warn("smart money event calendar unavailable; scoring will use neutral event features", {
|
||||
path: env.SMART_MONEY_EVENT_CALENDAR_PATH,
|
||||
error: error instanceof Error ? error.message : String(error)
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const redis = createRedisClient(env.REDIS_URL);
|
||||
redis.on("error", (error) => {
|
||||
logger.warn("redis client error", { error: error instanceof Error ? error.message : String(error) });
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import {
|
|||
type SmartMoneyProfileId,
|
||||
type SmartMoneyProfileScore
|
||||
} from "@islandflow/types";
|
||||
import type { EventCalendarMatch } from "@islandflow/refdata/event-calendar";
|
||||
import { parseContractId } from "./contracts";
|
||||
|
||||
const MS_PER_DAY = 86_400_000;
|
||||
|
|
@ -97,7 +98,11 @@ const inferDirection = (packet: FlowPacket): SmartMoneyDirection => {
|
|||
return "neutral";
|
||||
};
|
||||
|
||||
const buildFeatures = (packet: FlowPacket): SmartMoneyFeatures => {
|
||||
export type SmartMoneyParentEventOptions = {
|
||||
eventCalendarMatch?: EventCalendarMatch | null;
|
||||
};
|
||||
|
||||
const buildFeatures = (packet: FlowPacket, options: SmartMoneyParentEventOptions = {}): SmartMoneyFeatures => {
|
||||
const contractId = stringFeature(packet, "option_contract_id");
|
||||
const contract = parseContractId(contractId);
|
||||
const underlyingMid = numberFeature(packet, "underlying_mid");
|
||||
|
|
@ -108,7 +113,8 @@ const buildFeatures = (packet: FlowPacket): SmartMoneyFeatures => {
|
|||
const structureLegs = Math.max(0, Math.round(numberFeature(packet, "structure_legs")));
|
||||
const strikeCount = Math.max(1, Math.round(numberFeature(packet, "structure_strikes") || (contract ? 1 : 0)));
|
||||
const specialCount = numberFeature(packet, "special_print_count");
|
||||
const eventTs = numberFeature(packet, "corporate_event_ts");
|
||||
const calendarEventTs = options.eventCalendarMatch?.event_ts ?? null;
|
||||
const eventTs = calendarEventTs ?? numberFeature(packet, "corporate_event_ts");
|
||||
const referenceTs = getReferenceTs(packet);
|
||||
const expiryTs = contract ? Date.parse(`${contract.expiry}T00:00:00Z`) : Number.NaN;
|
||||
|
||||
|
|
@ -259,8 +265,11 @@ const evaluateProfiles = (
|
|||
return scores.sort((a, b) => b.probability - a.probability);
|
||||
};
|
||||
|
||||
export const buildSmartMoneyEventFromPacket = (packet: FlowPacket): SmartMoneyEvent => {
|
||||
const features = buildFeatures(packet);
|
||||
export const buildSmartMoneyEventFromPacket = (
|
||||
packet: FlowPacket,
|
||||
options: SmartMoneyParentEventOptions = {}
|
||||
): SmartMoneyEvent => {
|
||||
const features = buildFeatures(packet, options);
|
||||
const suppressed = detectSuppression(packet, features);
|
||||
const profileScores = evaluateProfiles(packet, features, suppressed);
|
||||
const primary = profileScores[0] ?? null;
|
||||
|
|
|
|||
|
|
@ -55,4 +55,58 @@ describe("smart money parent events", () => {
|
|||
expect(event.primary_profile_id).toBeNull();
|
||||
expect(event.suppressed_reasons).toContain("stale_or_missing_quote_context");
|
||||
});
|
||||
|
||||
it("uses timestamp-available event calendar matches for event-driven scoring", () => {
|
||||
const packet = buildFlowPacket({
|
||||
id: "flowpacket:event-driven",
|
||||
source_ts: Date.parse("2025-01-15T15:00:00Z"),
|
||||
features: {
|
||||
option_contract_id: "AAPL-2025-02-07-225-C",
|
||||
underlying_id: "AAPL",
|
||||
count: 1,
|
||||
window_ms: 450,
|
||||
total_size: 1800,
|
||||
total_premium: 160_000,
|
||||
total_notional: 16_000_000,
|
||||
nbbo_coverage_ratio: 0.5,
|
||||
nbbo_aggressive_ratio: 0.4,
|
||||
nbbo_aggressive_buy_ratio: 0.4,
|
||||
nbbo_aggressive_sell_ratio: 0.1,
|
||||
nbbo_inside_ratio: 0.08,
|
||||
underlying_mid: 224
|
||||
}
|
||||
});
|
||||
|
||||
const event = buildSmartMoneyEventFromPacket(packet, {
|
||||
eventCalendarMatch: {
|
||||
underlying_id: "AAPL",
|
||||
event_ts: Date.parse("2025-01-31T21:00:00Z"),
|
||||
event_kind: "earnings",
|
||||
announced_ts: Date.parse("2024-12-20T21:00:00Z"),
|
||||
days_to_event: 16.25
|
||||
}
|
||||
});
|
||||
|
||||
expect(event.features.days_to_event).toBeCloseTo(16.25);
|
||||
expect(event.features.expiry_after_event).toBe(true);
|
||||
expect(event.primary_profile_id).toBe("event_driven");
|
||||
});
|
||||
|
||||
it("keeps event-calendar features neutral when no match is available", () => {
|
||||
const packet = buildFlowPacket({
|
||||
id: "flowpacket:no-calendar",
|
||||
source_ts: Date.parse("2025-01-15T15:00:00Z"),
|
||||
features: {
|
||||
option_contract_id: "AAPL-2025-02-07-225-C",
|
||||
underlying_id: "AAPL",
|
||||
total_premium: 160_000,
|
||||
nbbo_coverage_ratio: 0.92
|
||||
}
|
||||
});
|
||||
|
||||
const event = buildSmartMoneyEventFromPacket(packet);
|
||||
expect(event.features.days_to_event).toBeNull();
|
||||
expect(event.features.expiry_after_event).toBeNull();
|
||||
expect(event.features.pre_event_concentration).toBeNull();
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -2,6 +2,9 @@
|
|||
"name": "@islandflow/refdata",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"exports": {
|
||||
"./event-calendar": "./src/event-calendar.ts"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "bun run src/index.ts"
|
||||
},
|
||||
|
|
|
|||
116
services/refdata/src/event-calendar.ts
Normal file
116
services/refdata/src/event-calendar.ts
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
export type EventCalendarKind = "earnings" | "dividend" | "corporate_action" | "m_and_a" | "news" | "other";
|
||||
|
||||
export type EventCalendarEntry = {
|
||||
underlying_id: string;
|
||||
event_ts: number;
|
||||
event_kind: EventCalendarKind;
|
||||
announced_ts: number;
|
||||
source?: string;
|
||||
source_event_id?: string;
|
||||
};
|
||||
|
||||
export type EventCalendarMatch = EventCalendarEntry & {
|
||||
days_to_event: number;
|
||||
};
|
||||
|
||||
export type EventCalendarProvider = {
|
||||
findNextEvent(underlyingId: string, asOfTs: number): EventCalendarMatch | null;
|
||||
};
|
||||
|
||||
const MS_PER_DAY = 86_400_000;
|
||||
|
||||
const EVENT_KINDS = new Set<EventCalendarKind>([
|
||||
"earnings",
|
||||
"dividend",
|
||||
"corporate_action",
|
||||
"m_and_a",
|
||||
"news",
|
||||
"other"
|
||||
]);
|
||||
|
||||
const normalizeUnderlying = (underlyingId: string): string => underlyingId.trim().toUpperCase();
|
||||
|
||||
const asNumber = (value: unknown): number | null => {
|
||||
if (typeof value === "number" && Number.isFinite(value)) {
|
||||
return value;
|
||||
}
|
||||
if (typeof value === "string" && value.trim()) {
|
||||
const parsed = Number(value);
|
||||
if (Number.isFinite(parsed)) {
|
||||
return parsed;
|
||||
}
|
||||
const ts = Date.parse(value);
|
||||
return Number.isFinite(ts) ? ts : null;
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
const asString = (value: unknown): string | null => (typeof value === "string" && value.trim() ? value.trim() : null);
|
||||
|
||||
export const parseEventCalendarEntries = (value: unknown): EventCalendarEntry[] => {
|
||||
const rows = Array.isArray(value) ? value : [];
|
||||
return rows.flatMap((row): EventCalendarEntry[] => {
|
||||
if (!row || typeof row !== "object") {
|
||||
return [];
|
||||
}
|
||||
|
||||
const record = row as Record<string, unknown>;
|
||||
const underlying = asString(record.underlying_id ?? record.underlying ?? record.symbol);
|
||||
const eventTs = asNumber(record.event_ts ?? record.event_time ?? record.event_date);
|
||||
const announcedTs = asNumber(record.announced_ts ?? record.available_ts ?? record.as_of_ts ?? record.created_ts) ?? 0;
|
||||
const rawKind = asString(record.event_kind ?? record.kind ?? record.type) ?? "other";
|
||||
const eventKind = EVENT_KINDS.has(rawKind as EventCalendarKind) ? (rawKind as EventCalendarKind) : "other";
|
||||
|
||||
if (!underlying || eventTs === null || eventTs < 0 || announcedTs < 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
return [
|
||||
{
|
||||
underlying_id: normalizeUnderlying(underlying),
|
||||
event_ts: Math.trunc(eventTs),
|
||||
event_kind: eventKind,
|
||||
announced_ts: Math.trunc(announcedTs),
|
||||
...(asString(record.source) ? { source: asString(record.source) ?? undefined } : {}),
|
||||
...(asString(record.source_event_id ?? record.id)
|
||||
? { source_event_id: asString(record.source_event_id ?? record.id) ?? undefined }
|
||||
: {})
|
||||
}
|
||||
];
|
||||
});
|
||||
};
|
||||
|
||||
export const createStaticEventCalendarProvider = (entries: EventCalendarEntry[]): EventCalendarProvider => {
|
||||
const byUnderlying = new Map<string, EventCalendarEntry[]>();
|
||||
for (const entry of entries) {
|
||||
const key = normalizeUnderlying(entry.underlying_id);
|
||||
const normalized = { ...entry, underlying_id: key };
|
||||
const bucket = byUnderlying.get(key) ?? [];
|
||||
bucket.push(normalized);
|
||||
byUnderlying.set(key, bucket);
|
||||
}
|
||||
|
||||
for (const bucket of byUnderlying.values()) {
|
||||
bucket.sort((a, b) => a.event_ts - b.event_ts || a.announced_ts - b.announced_ts);
|
||||
}
|
||||
|
||||
return {
|
||||
findNextEvent(underlyingId, asOfTs) {
|
||||
const key = normalizeUnderlying(underlyingId);
|
||||
if (!key || !Number.isFinite(asOfTs)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const bucket = byUnderlying.get(key) ?? [];
|
||||
const entry = bucket.find((candidate) => candidate.announced_ts <= asOfTs && candidate.event_ts >= asOfTs);
|
||||
return entry ? { ...entry, days_to_event: (entry.event_ts - asOfTs) / MS_PER_DAY } : null;
|
||||
}
|
||||
};
|
||||
};
|
||||
|
||||
export const createEmptyEventCalendarProvider = (): EventCalendarProvider => createStaticEventCalendarProvider([]);
|
||||
|
||||
export const loadEventCalendarProviderFromFile = async (path: string): Promise<EventCalendarProvider> => {
|
||||
const text = await Bun.file(path).text();
|
||||
return createStaticEventCalendarProvider(parseEventCalendarEntries(JSON.parse(text)));
|
||||
};
|
||||
|
|
@ -1,10 +1,28 @@
|
|||
import { createLogger } from "@islandflow/observability";
|
||||
import { createEmptyEventCalendarProvider, loadEventCalendarProviderFromFile } from "./event-calendar";
|
||||
|
||||
const service = "refdata";
|
||||
const logger = createLogger({ service });
|
||||
|
||||
logger.info("service starting");
|
||||
|
||||
const eventCalendarPath = process.env.REFDATA_EVENT_CALENDAR_PATH ?? process.env.SMART_MONEY_EVENT_CALENDAR_PATH;
|
||||
|
||||
if (eventCalendarPath) {
|
||||
try {
|
||||
await loadEventCalendarProviderFromFile(eventCalendarPath);
|
||||
logger.info("event calendar loaded", { path: eventCalendarPath });
|
||||
} catch (error) {
|
||||
logger.warn("event calendar unavailable", {
|
||||
path: eventCalendarPath,
|
||||
error: error instanceof Error ? error.message : String(error)
|
||||
});
|
||||
}
|
||||
} else {
|
||||
createEmptyEventCalendarProvider();
|
||||
logger.info("event calendar disabled");
|
||||
}
|
||||
|
||||
const shutdown = (signal: string) => {
|
||||
logger.info("service stopping", { signal });
|
||||
process.exit(0);
|
||||
|
|
|
|||
31
services/refdata/tests/event-calendar.test.ts
Normal file
31
services/refdata/tests/event-calendar.test.ts
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
import { describe, expect, it } from "bun:test";
|
||||
import { createStaticEventCalendarProvider, parseEventCalendarEntries } from "../src/event-calendar";
|
||||
|
||||
describe("event calendar refdata", () => {
|
||||
it("parses provider rows and filters by timestamp availability", () => {
|
||||
const entries = parseEventCalendarEntries([
|
||||
{
|
||||
symbol: "aapl",
|
||||
event_date: "2025-01-31T21:00:00Z",
|
||||
event_kind: "earnings",
|
||||
announced_ts: "2025-01-20T21:00:00Z",
|
||||
source: "fixture"
|
||||
},
|
||||
{
|
||||
symbol: "AAPL",
|
||||
event_date: "2025-02-28T21:00:00Z",
|
||||
type: "mystery",
|
||||
announced_ts: "2025-02-01T21:00:00Z"
|
||||
}
|
||||
]);
|
||||
|
||||
const provider = createStaticEventCalendarProvider(entries);
|
||||
const beforeAnnouncement = provider.findNextEvent("AAPL", Date.parse("2025-01-15T15:00:00Z"));
|
||||
const afterAnnouncement = provider.findNextEvent("aapl", Date.parse("2025-01-21T15:00:00Z"));
|
||||
|
||||
expect(beforeAnnouncement).toBeNull();
|
||||
expect(afterAnnouncement?.event_kind).toBe("earnings");
|
||||
expect(afterAnnouncement?.underlying_id).toBe("AAPL");
|
||||
expect(afterAnnouncement?.days_to_event).toBeGreaterThan(0);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue