hood-alerts 0.1.0

package/dist/schema-DuDMPqpq.d.ts

@@ -0,0 +1,183 @@
+import { z } from 'zod';
+import { e as Launchpad, b as AlertEventKind } from './types-DFPpTMWo.js';
+
+/** An EVM address, stored lowercase so comparisons never depend on checksum casing. */
+declare const addressSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/** The four alert kinds. */
+declare const eventKindSchema: z.ZodEnum<{
+    launch: "launch";
+    curve_trade: "curve_trade";
+    graduation: "graduation";
+    whale_trade: "whale_trade";
+}>;
+/** The two launchpads. */
+declare const launchpadSchema: z.ZodEnum<{
+    noxa: "noxa";
+    odyssey: "odyssey";
+}>;
+/** Trade direction filter. `any` disables the filter. */
+declare const sideSchema: z.ZodEnum<{
+    buy: "buy";
+    sell: "sell";
+    any: "any";
+}>;
+/**
+ * Deployer reputation filters, all derived from on-chain history (see
+ * `hood-alerts/rules` `createRpcReputationProvider`). Every bound is inclusive.
+ */
+declare const reputationFilterSchema: z.ZodObject<{
+    minPriorLaunches: z.ZodOptional<z.ZodNumber>;
+    maxPriorLaunches: z.ZodOptional<z.ZodNumber>;
+    maxRuggedLaunches: z.ZodOptional<z.ZodNumber>;
+    requireLpLocked: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/** Per-rule delivery rate limits. */
+declare const rateLimitSchema: z.ZodObject<{
+    maxPerHour: z.ZodOptional<z.ZodNumber>;
+    minIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/** A single alert rule. */
+declare const ruleSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    kinds: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        launch: "launch";
+        curve_trade: "curve_trade";
+        graduation: "graduation";
+        whale_trade: "whale_trade";
+    }>>>;
+    launchpads: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        noxa: "noxa";
+        odyssey: "odyssey";
+    }>>>;
+    minUsd: z.ZodOptional<z.ZodNumber>;
+    maxUsd: z.ZodOptional<z.ZodNumber>;
+    minLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+    maxLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+    tokens: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    deployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    excludeDeployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    side: z.ZodDefault<z.ZodEnum<{
+        buy: "buy";
+        sell: "sell";
+        any: "any";
+    }>>;
+    reputation: z.ZodOptional<z.ZodObject<{
+        minPriorLaunches: z.ZodOptional<z.ZodNumber>;
+        maxPriorLaunches: z.ZodOptional<z.ZodNumber>;
+        maxRuggedLaunches: z.ZodOptional<z.ZodNumber>;
+        requireLpLocked: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    rateLimit: z.ZodOptional<z.ZodObject<{
+        maxPerHour: z.ZodOptional<z.ZodNumber>;
+        minIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** A validated rule. */
+type Rule = z.output<typeof ruleSchema>;
+/** A rule as accepted on input, before defaults are applied. */
+type RuleInput = z.input<typeof ruleSchema>;
+/** Validated reputation filter. */
+type ReputationFilter = z.output<typeof reputationFilterSchema>;
+/** Validated rate limit block. */
+type RateLimitConfig = z.output<typeof rateLimitSchema>;
+/** Delivery platforms a subscription can target. */
+declare const platformSchema: z.ZodEnum<{
+    telegram: "telegram";
+    discord: "discord";
+}>;
+/** A delivery platform. */
+type Platform = z.output<typeof platformSchema>;
+/** A subscription: one delivery target plus the rules that feed it. */
+declare const subscriptionSchema: z.ZodObject<{
+    id: z.ZodString;
+    subscriberId: z.ZodString;
+    platform: z.ZodEnum<{
+        telegram: "telegram";
+        discord: "discord";
+    }>;
+    target: z.ZodString;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    rules: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        kinds: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            launch: "launch";
+            curve_trade: "curve_trade";
+            graduation: "graduation";
+            whale_trade: "whale_trade";
+        }>>>;
+        launchpads: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            noxa: "noxa";
+            odyssey: "odyssey";
+        }>>>;
+        minUsd: z.ZodOptional<z.ZodNumber>;
+        maxUsd: z.ZodOptional<z.ZodNumber>;
+        minLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+        maxLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+        tokens: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        deployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        excludeDeployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        side: z.ZodDefault<z.ZodEnum<{
+            buy: "buy";
+            sell: "sell";
+            any: "any";
+        }>>;
+        reputation: z.ZodOptional<z.ZodObject<{
+            minPriorLaunches: z.ZodOptional<z.ZodNumber>;
+            maxPriorLaunches: z.ZodOptional<z.ZodNumber>;
+            maxRuggedLaunches: z.ZodOptional<z.ZodNumber>;
+            requireLpLocked: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        rateLimit: z.ZodOptional<z.ZodObject<{
+            maxPerHour: z.ZodOptional<z.ZodNumber>;
+            minIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>>;
+    createdAtMs: z.ZodNumber;
+}, z.core.$strict>;
+/** A validated subscription. */
+type Subscription = z.output<typeof subscriptionSchema>;
+/** A subscription as accepted on input. */
+type SubscriptionInput = z.input<typeof subscriptionSchema>;
+/** Can a launchpad emit this event kind at all? */
+declare function canEmit(launchpad: Launchpad, kind: AlertEventKind): boolean;
+/**
+ * How many filters a rule actually uses. The tier policy caps this so free
+ * subscribers get real filtering without turning the service into an unpaid
+ * on-chain query engine.
+ */
+declare function ruleComplexity(rule: Rule): number;
+/** Filters that cost an extra on-chain read per candidate event. */
+declare function usesOnChainLookups(rule: Rule): boolean;
+/**
+ * Parse and validate a rule, applying defaults.
+ *
+ * @throws {@link z.ZodError} with a field-level message the bot renders back
+ * to the user verbatim.
+ *
+ * @example
+ * ```ts
+ * const rule = parseRule({ id: 'whales', kinds: ['whale_trade'], minUsd: 5000 })
+ * console.log(rule.launchpads) // ['noxa', 'odyssey'] (defaulted)
+ * ```
+ */
+declare function parseRule(input: unknown): Rule;
+/** Non-throwing {@link parseRule}. */
+declare function safeParseRule(input: unknown): z.ZodSafeParseResult<Rule>;
+/** Parse and validate a subscription. */
+declare function parseSubscription(input: unknown): Subscription;
+/** Non-throwing {@link parseSubscription}. */
+declare function safeParseSubscription(input: unknown): z.ZodSafeParseResult<Subscription>;
+/**
+ * Render a Zod error as one line of human-readable text, for bot replies.
+ * A user who typed `/threshold abc` gets "minUsd: expected number", not a
+ * stack trace and not a silent failure.
+ */
+declare function formatValidationError(error: z.ZodError): string;
+/** A ready-to-use starter rule set, used by `/subscribe` before any editing. */
+declare function defaultRules(): Rule[];
+
+export { type Platform as P, type RateLimitConfig as R, type Subscription as S, type ReputationFilter as a, type Rule as b, type RuleInput as c, type SubscriptionInput as d, addressSchema as e, canEmit as f, defaultRules as g, eventKindSchema as h, formatValidationError as i, parseSubscription as j, platformSchema as k, launchpadSchema as l, reputationFilterSchema as m, ruleComplexity as n, ruleSchema as o, parseRule as p, safeParseSubscription as q, rateLimitSchema as r, safeParseRule as s, sideSchema as t, subscriptionSchema as u, usesOnChainLookups as v };

package/dist/schema-NnIdKFl2.d.cts

@@ -0,0 +1,183 @@
+import { z } from 'zod';
+import { e as Launchpad, b as AlertEventKind } from './types-DFPpTMWo.cjs';
+
+/** An EVM address, stored lowercase so comparisons never depend on checksum casing. */
+declare const addressSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/** The four alert kinds. */
+declare const eventKindSchema: z.ZodEnum<{
+    launch: "launch";
+    curve_trade: "curve_trade";
+    graduation: "graduation";
+    whale_trade: "whale_trade";
+}>;
+/** The two launchpads. */
+declare const launchpadSchema: z.ZodEnum<{
+    noxa: "noxa";
+    odyssey: "odyssey";
+}>;
+/** Trade direction filter. `any` disables the filter. */
+declare const sideSchema: z.ZodEnum<{
+    buy: "buy";
+    sell: "sell";
+    any: "any";
+}>;
+/**
+ * Deployer reputation filters, all derived from on-chain history (see
+ * `hood-alerts/rules` `createRpcReputationProvider`). Every bound is inclusive.
+ */
+declare const reputationFilterSchema: z.ZodObject<{
+    minPriorLaunches: z.ZodOptional<z.ZodNumber>;
+    maxPriorLaunches: z.ZodOptional<z.ZodNumber>;
+    maxRuggedLaunches: z.ZodOptional<z.ZodNumber>;
+    requireLpLocked: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/** Per-rule delivery rate limits. */
+declare const rateLimitSchema: z.ZodObject<{
+    maxPerHour: z.ZodOptional<z.ZodNumber>;
+    minIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/** A single alert rule. */
+declare const ruleSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    kinds: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        launch: "launch";
+        curve_trade: "curve_trade";
+        graduation: "graduation";
+        whale_trade: "whale_trade";
+    }>>>;
+    launchpads: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        noxa: "noxa";
+        odyssey: "odyssey";
+    }>>>;
+    minUsd: z.ZodOptional<z.ZodNumber>;
+    maxUsd: z.ZodOptional<z.ZodNumber>;
+    minLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+    maxLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+    tokens: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    deployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    excludeDeployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    side: z.ZodDefault<z.ZodEnum<{
+        buy: "buy";
+        sell: "sell";
+        any: "any";
+    }>>;
+    reputation: z.ZodOptional<z.ZodObject<{
+        minPriorLaunches: z.ZodOptional<z.ZodNumber>;
+        maxPriorLaunches: z.ZodOptional<z.ZodNumber>;
+        maxRuggedLaunches: z.ZodOptional<z.ZodNumber>;
+        requireLpLocked: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    rateLimit: z.ZodOptional<z.ZodObject<{
+        maxPerHour: z.ZodOptional<z.ZodNumber>;
+        minIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** A validated rule. */
+type Rule = z.output<typeof ruleSchema>;
+/** A rule as accepted on input, before defaults are applied. */
+type RuleInput = z.input<typeof ruleSchema>;
+/** Validated reputation filter. */
+type ReputationFilter = z.output<typeof reputationFilterSchema>;
+/** Validated rate limit block. */
+type RateLimitConfig = z.output<typeof rateLimitSchema>;
+/** Delivery platforms a subscription can target. */
+declare const platformSchema: z.ZodEnum<{
+    telegram: "telegram";
+    discord: "discord";
+}>;
+/** A delivery platform. */
+type Platform = z.output<typeof platformSchema>;
+/** A subscription: one delivery target plus the rules that feed it. */
+declare const subscriptionSchema: z.ZodObject<{
+    id: z.ZodString;
+    subscriberId: z.ZodString;
+    platform: z.ZodEnum<{
+        telegram: "telegram";
+        discord: "discord";
+    }>;
+    target: z.ZodString;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    rules: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        kinds: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            launch: "launch";
+            curve_trade: "curve_trade";
+            graduation: "graduation";
+            whale_trade: "whale_trade";
+        }>>>;
+        launchpads: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            noxa: "noxa";
+            odyssey: "odyssey";
+        }>>>;
+        minUsd: z.ZodOptional<z.ZodNumber>;
+        maxUsd: z.ZodOptional<z.ZodNumber>;
+        minLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+        maxLiquidityUsd: z.ZodOptional<z.ZodNumber>;
+        tokens: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        deployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        excludeDeployers: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        side: z.ZodDefault<z.ZodEnum<{
+            buy: "buy";
+            sell: "sell";
+            any: "any";
+        }>>;
+        reputation: z.ZodOptional<z.ZodObject<{
+            minPriorLaunches: z.ZodOptional<z.ZodNumber>;
+            maxPriorLaunches: z.ZodOptional<z.ZodNumber>;
+            maxRuggedLaunches: z.ZodOptional<z.ZodNumber>;
+            requireLpLocked: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+        rateLimit: z.ZodOptional<z.ZodObject<{
+            maxPerHour: z.ZodOptional<z.ZodNumber>;
+            minIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>>;
+    createdAtMs: z.ZodNumber;
+}, z.core.$strict>;
+/** A validated subscription. */
+type Subscription = z.output<typeof subscriptionSchema>;
+/** A subscription as accepted on input. */
+type SubscriptionInput = z.input<typeof subscriptionSchema>;
+/** Can a launchpad emit this event kind at all? */
+declare function canEmit(launchpad: Launchpad, kind: AlertEventKind): boolean;
+/**
+ * How many filters a rule actually uses. The tier policy caps this so free
+ * subscribers get real filtering without turning the service into an unpaid
+ * on-chain query engine.
+ */
+declare function ruleComplexity(rule: Rule): number;
+/** Filters that cost an extra on-chain read per candidate event. */
+declare function usesOnChainLookups(rule: Rule): boolean;
+/**
+ * Parse and validate a rule, applying defaults.
+ *
+ * @throws {@link z.ZodError} with a field-level message the bot renders back
+ * to the user verbatim.
+ *
+ * @example
+ * ```ts
+ * const rule = parseRule({ id: 'whales', kinds: ['whale_trade'], minUsd: 5000 })
+ * console.log(rule.launchpads) // ['noxa', 'odyssey'] (defaulted)
+ * ```
+ */
+declare function parseRule(input: unknown): Rule;
+/** Non-throwing {@link parseRule}. */
+declare function safeParseRule(input: unknown): z.ZodSafeParseResult<Rule>;
+/** Parse and validate a subscription. */
+declare function parseSubscription(input: unknown): Subscription;
+/** Non-throwing {@link parseSubscription}. */
+declare function safeParseSubscription(input: unknown): z.ZodSafeParseResult<Subscription>;
+/**
+ * Render a Zod error as one line of human-readable text, for bot replies.
+ * A user who typed `/threshold abc` gets "minUsd: expected number", not a
+ * stack trace and not a silent failure.
+ */
+declare function formatValidationError(error: z.ZodError): string;
+/** A ready-to-use starter rule set, used by `/subscribe` before any editing. */
+declare function defaultRules(): Rule[];
+
+export { type Platform as P, type RateLimitConfig as R, type Subscription as S, type ReputationFilter as a, type Rule as b, type RuleInput as c, type SubscriptionInput as d, addressSchema as e, canEmit as f, defaultRules as g, eventKindSchema as h, formatValidationError as i, parseSubscription as j, platformSchema as k, launchpadSchema as l, reputationFilterSchema as m, ruleComplexity as n, ruleSchema as o, parseRule as p, safeParseSubscription as q, rateLimitSchema as r, safeParseRule as s, sideSchema as t, subscriptionSchema as u, usesOnChainLookups as v };