@pickhooks/sdk 0.0.0-stage → 0.4.0

package/dist/coin-rules.d.ts

@@ -0,0 +1,383 @@
+/**
+ * The rule catalog for hooks on BNB: one entry per rule of HooksToken (src/HooksToken.sol).
+ * The launcher builds its form from `fields` and turns the values into the token's `Rules` struct
+ * with `apply`; the coin page explains a live rule with `describe` and `live`.
+ * Every rule says what a scanner (GoPlus, honeypot.is) will make of it: `scanner`.
+ * Shared by client and server.
+ */
+export declare const SUPPLY = 1000000000;
+export declare const MAX_RULES = 8;
+export declare const DAY = 86400;
+/** Binance Account Bound Token: the soulbound token of identity-verified Binance users, one per account, balanceOf is 0 or 1. */
+export declare const BABT: "0x2B09d47D550061f995A3b5C6F0Fd58005215D7c8";
+/** The pickhooks token on BNB Chain (flap, migrated to PancakeSwap). Gate for the set "$hooks holders only". */
+export declare const HOOKS_TOKEN: "0x07bcB8E8226f671300e135b4A61Dc157359b7777";
+export type Group = "hold" | "buy" | "sell" | "time" | "move" | "pay" | "games" | "linked" | "hooks" | "trust";
+export declare const GROUPS: {
+    id: Group;
+    title: string;
+    blurb: string;
+}[];
+/** What scanners will show. green: nothing. yellow: a hint, or a test buy fails at some moments. red: looks like a honeypot. */
+export type Scanner = {
+    level: "green" | "yellow" | "red";
+    note: string;
+};
+export type Field = {
+    id: string;
+    label: string;
+    kind: "pct";
+    min?: number;
+    max?: number;
+    def: number;
+    zeroOk?: boolean;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "dur";
+    max: number;
+    def: number;
+    zeroOk?: boolean;
+    min?: number;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "int";
+    min: number;
+    max: number;
+    def: number;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "bnb";
+    max: number;
+    def: number;
+    zeroOk?: boolean;
+    min?: number;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "gwei";
+    max: number;
+    def: number;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "address";
+    hint?: string;
+    optional?: boolean;
+} | {
+    id: string;
+    label: string;
+    kind: "bool";
+    def: boolean;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "hour";
+    def: number;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "days";
+    def: number;
+    hint?: string;
+} | {
+    id: string;
+    label: string;
+    kind: "usd";
+    min: number;
+    max: number;
+    def: number;
+    hint?: string;
+}
+/** one of a few fixed values */
+ | {
+    id: string;
+    label: string;
+    kind: "choice";
+    options: {
+        value: number;
+        label: string;
+    }[];
+    def: number;
+    hint?: string;
+}
+/** a comma list of rule kinds picked for this launch (buyout, vote) */
+ | {
+    id: string;
+    label: string;
+    kind: "rules";
+    hint?: string;
+};
+export type Values = Record<string, number | boolean | string>;
+/** The token's Rules struct, as viem reads and writes it. */
+export type R = {
+    mask: bigint;
+    maxWalletBps: number;
+    riseStartBps: number;
+    riseStepBps: number;
+    riseSeconds: number;
+    chapterStartBps: number;
+    chapterVolume: bigint;
+    clubMax: number;
+    gateToken: `0x${string}`;
+    gateMin: bigint;
+    maxTradeBps: number;
+    buysPerBlock: number;
+    maxGasPrice: bigint;
+    raiseBps: number;
+    raiseReset: number;
+    minBuy: bigint;
+    slowSeconds: number;
+    buyLimit: number;
+    dumpBuyBps: number;
+    dumpSellBps: number;
+    curveSmallBps: number;
+    curveFloorBps: number;
+    curveBigBagBps: number;
+    taperStartBps: number;
+    taperEndBps: number;
+    taperSoldBps: number;
+    unlockBuys: number;
+    devLockSeconds: number;
+    devCapBps: number;
+    devGapSeconds: number;
+    diamondSeconds: number;
+    cooldownSeconds: number;
+    jailWindow: number;
+    jailSeconds: number;
+    openHour: number;
+    closeHour: number;
+    weekdays: number;
+    sellsOpen: boolean;
+    sellWindow: number;
+    sellPeriod: number;
+    tickSeconds: number;
+    bellSeconds: number;
+    bellSoldBps: number;
+    rewardPerBuy: bigint;
+    rewardMinBuy: bigint;
+    rewardEveryN: number;
+    jackpotSilence: number;
+    jackpotShareBps: number;
+    jackpotMinBuy: bigint;
+    jackpotFeeBps: number;
+    dipBps: number;
+    beacon: `0x${string}`;
+    beaconTargetBps: number;
+    partner: `0x${string}`;
+    reactBaseBps: number;
+    reactSensitivity: number;
+};
+export declare function emptyRules(): R;
+/** The v2 factory's Extras struct: everything the eight v2 rules need beyond `Rules`, as viem reads and writes it. */
+export type X = {
+    buyoutMask: bigint;
+    buyoutPrice: readonly [bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint];
+    votable: bigint;
+    quorumBps: number;
+    voteSeconds: number;
+    duelOpponent: `0x${string}`;
+    duelStake: bigint;
+    feed: `0x${string}`;
+    target: bigint;
+    sellsAtSeconds: number;
+    deadManSeconds: number;
+    floorDeposit: bigint;
+    floorBps: number;
+    shiftSeconds: number;
+    payrollMin: bigint;
+    payrollDeposit: bigint;
+    /** share of the creator's fee part the creator keeps; the rest buys $hooks back and burns it */
+    creatorKeepBps: number;
+};
+export declare function emptyExtras(): X;
+/** Live state the eight v2 rules add, in display units. */
+export type V2Live = {
+    /** rule kinds that were lifted (bought off, voted off, or sells at reached its target) */
+    off: number[];
+    /** $hooks burned at launch */
+    hooksBurned: number;
+    /** dead man: last sign of life of the creator */
+    devAlive: number;
+    /** milestone: share of the creator's peak bag that may leave, in percent, and what left so far */
+    milestonePct: number;
+    devPeakTokens: number;
+    devOutTokens: number;
+    /** bought minus sold through both pools since launch, in tokens */
+    flowTokens: number;
+    /** sells at: the feed's price now, in USD */
+    feedPrice: number | null;
+    duel: {
+        id: number;
+        opponent: string | null;
+        stake: number;
+        openedAt: number;
+        startedAt: number;
+        closed: boolean;
+        settled: boolean;
+        winner: string | null;
+        flowA: number;
+        flowB: number;
+        mine: "a" | "b";
+    } | null;
+    floor: {
+        deposit: number;
+        left: number;
+        peakPct: number | null;
+        lastDefend: number;
+        belowFloor: boolean;
+    } | null;
+    payroll: {
+        pot: number;
+        total: number;
+        lastShift: number;
+        shiftNo: number;
+        shiftSeconds: number;
+        mine: {
+            wages: number;
+            earning: number;
+            waiting: number;
+        } | null;
+    } | null;
+    votes: {
+        kind: number;
+        round: number;
+        end: number;
+        done: boolean;
+        yes: number;
+        no: number;
+        yesVoters: number;
+        quorum: number;
+        retryAt: number;
+        mine: {
+            deposit: number;
+            side: 0 | 1 | 2;
+        } | null;
+    }[];
+    /** the connected wallet's coins in the vote box */
+    inBoxTokens: number;
+};
+/** Live state of a coin, already in display units (tokens, BNB, seconds). */
+export type LiveState = {
+    creator: string;
+    start: number;
+    holders: number;
+    buys: number;
+    sells: number;
+    buysSinceSell: number;
+    lastBuyTime: number;
+    lastBuyer: string | null;
+    lastBuyTokens: number;
+    volumeTokens: number;
+    soldBps: number;
+    peakBps: number;
+    devLastSend: number;
+    qualifyingBuys: number;
+    jackpotPot: number;
+    jackpotLast: string | null;
+    jackpotTime: number;
+    rewardsPot: number;
+    owedTotal: number;
+    entangledOpen: boolean;
+    maxWalletTokens: number | null;
+    /** clean coins: what the creator paid into the rewards pot and may take back */
+    creatorFunded?: number;
+    /** v2 coins only */
+    v2?: V2Live;
+};
+export type RuleDef = {
+    kind: number;
+    id: string;
+    name: string;
+    /** Hooked's name for the same idea, if they have one. */
+    alias?: string;
+    group: Group;
+    line: string;
+    scanner: Scanner;
+    fields: Field[];
+    apply: (v: Values) => Partial<R>;
+    describe: (r: R, x?: X) => string;
+    /** One line about the rule right now, from the live counters. */
+    live?: (r: R, s: LiveState, now: number, x?: X) => string | null;
+    /** v2 rules: the Extras fields this rule fills. `picked` is the whole selection (buyout and vote list other rules). */
+    extras?: (v: Values, picked: Picked[]) => Partial<X>;
+    /** v2 hooks rules: the launch burns $hooks for this rule */
+    burns?: boolean;
+};
+export declare function pct(bps: number): string;
+export declare function dur(s: number): string;
+export declare const bnb: (v: number) => string;
+export declare const short: (a: string | null | undefined) => string;
+export declare const tokens: (t: number) => string;
+export declare const fromRaw: (x: bigint) => number;
+/** rule kinds of the v1 catalog (the v2 factory takes them all as well) */
+export declare const V1_KINDS: readonly number[];
+/** rules that only restrict trading: the only ones a buyout or a vote can lift (never trust rules, games, pots or linked coins) */
+export declare const LIFTABLE: readonly number[];
+/** rules that cannot have an end time on the v2 factory: trust rules, pots, games and the v2 machinery */
+export declare const NO_UNTIL: readonly number[];
+export declare const FEED_NAMES: readonly ["BNB", "BTC", "ETH", "DOGE"];
+export declare const RULES: RuleDef[];
+/** the catalog the site shows: the eight v2 rules only once the v2 factory is set */
+export declare const RULES_SHOWN: readonly RuleDef[];
+export declare const GROUPS_SHOWN: {
+    id: Group;
+    title: string;
+    blurb: string;
+}[];
+export declare const RULE_BY_KIND: Map<number, RuleDef>;
+export declare const RULE_BY_ID: Map<string, RuleDef>;
+export declare function defaults(def: RuleDef): Values;
+/** Checks the values against the same limits the factory enforces. Returns a sentence or null. */
+export declare function fieldProblem(def: RuleDef, v: Values): string | null;
+export type Picked = {
+    id: string;
+    values: Values;
+    endsAfter?: number;
+};
+/** Checks a whole selection the way the factory does. */
+export declare function selectionProblem(picked: Picked[]): string | null;
+/** The launch arguments for the factory: the Rules struct, the end times, and for the v2 factory the Extras. */
+export declare function buildRules(picked: Picked[], nowSec: number, creatorKeepBps?: number): {
+    rules: R;
+    untilIds: number[];
+    untilTimes: number[];
+    extras: X;
+};
+/** v2: how many hooks rules a selection carries (each burns $hooks at launch), and the BNB the launch deposits besides the seed. */
+export declare function v2Costs(picked: Picked[]): {
+    hooksRules: number;
+    stakeBnb: number;
+    floorBnb: number;
+    payrollBnb: number;
+    v2: boolean;
+};
+/** BNB the launcher sends into pots right after the launch. */
+export declare function launchPots(picked: Picked[]): {
+    jackpot: number;
+    rewards: number;
+};
+/** The worst scanner level in a selection. */
+export declare function worstScanner(kinds: number[]): Scanner["level"];
+/** Rule kinds that are on in a mask. */
+export declare const kindsOf: (mask: bigint) => number[];
+/** The rule's current sentence, or that it ended. */
+export declare function ruleNow(kind: number, r: R, s: LiveState, until: number, now: number, x?: X): {
+    name: string;
+    text: string;
+    live: string | null;
+    ended: boolean;
+    lifted: boolean;
+    scanner: Scanner;
+};
+/** Names of the rules a token error refers to, for "rule: max wallet" messages. */
+export declare function refusal(kind: number, r: R | null): string;