@pickhooks/sdk 0.0.0-stage → 0.4.0

package/dist/sticky-sim.d.ts

@@ -0,0 +1,125 @@
+/**
+ * sticky rules in the browser: the coin's rule engine (src/sticky/StickyToken.sol) line for line, on bigints, and a test
+ * run of random trades on top. The engine is checked against the contract trade by trade (test/sticky/StickyTrace.t.sol
+ * writes a run, scripts/dev/sticky-sim-diff.mjs replays it here), so what the launcher shows is what the coin would do.
+ * The chain stays the truth: this only shows a creator what a table does before the launch.
+ */
+import { type Row } from "./sticky-rules.js";
+export declare const SUPPLY: bigint;
+/** The addresses the coin does not keep lots for. */
+export declare const POOL = "pool";
+export declare const POT = "pot";
+export declare const DEAD = "dead";
+export type Lot = {
+    amount: bigint;
+    lk: bigint;
+    since: number;
+    flags: number;
+};
+export type Stats = {
+    holders: number;
+    buys: number;
+    sells: number;
+    highAt: number;
+    lastBuy: number;
+    volume: bigint;
+    net: bigint;
+    peak: bigint;
+    high: bigint;
+};
+export type Now = {
+    t: number;
+    b: number;
+};
+export type CoinState = {
+    rows: Row[];
+    release: number;
+    off: number;
+    creator: string;
+    start: number;
+    startBlock: number;
+    curveSupply: bigint;
+    stats: Stats;
+    bal: Map<string, bigint>;
+    lots: Map<string, Lot[]>;
+};
+export type Result = {
+    ok: true;
+    burn: bigint;
+    toPot: bigint;
+    drop: bigint;
+} | {
+    ok: false;
+    why: number | "nope";
+};
+export declare function newCoin(rows: (bigint | Row)[], release: number, creator: string, curveSupply: bigint, start?: number, startBlock?: number): CoinState;
+/** A transfer as the coin runs it: out of POOL is a buy, into POOL a sell, anything else a send. */
+export declare function transfer(s: CoinState, from: string, to: string, amount: bigint, now: Now): Result;
+/** What `a` could sell right now (size rows left out, like the coin's view). */
+export declare function sellable(s: CoinState, a: string, now: Now): bigint;
+export declare function balanceOf(s: CoinState, a: string): bigint;
+export declare function lots(s: CoinState, a: string): Lot[];
+/** The curve as the coin prices it: x * y = k from the start price, so price / start = (supply / coins left)². */
+export declare const CURVE: {
+    supply: bigint;
+    startFdvBnb: number;
+};
+export type SimReport = {
+    trades: number;
+    hours: number;
+    buys: {
+        ok: number;
+        refused: number;
+    };
+    sells: {
+        ok: number;
+        refused: number;
+    };
+    sends: {
+        ok: number;
+        refused: number;
+    };
+    /** refusals by row (0 based) and LOCKED (254) */
+    refusals: {
+        row: number;
+        count: number;
+    }[];
+    /** longest a wallet that wanted to sell had to wait until a sell went through (seconds) */
+    longestWait: number;
+    /** wallets still unable to sell when the run ended */
+    stillWaiting: number;
+    /** after the run: seconds until every wallet can sell everything (null: longer than 31 days) */
+    allFreeAfter: number | null;
+    burnedPct: number;
+    pot: {
+        inPct: number;
+        drops: number;
+        paidPct: number;
+        biggestX: number;
+        leftPct: number;
+    };
+    snipers: {
+        count: number;
+        firstSellAfter: number | null;
+    };
+    splits: {
+        count: number;
+        refusedAfter: number;
+    };
+    /** a scanner's test: a tiny buy and an instant sell an hour after launch */
+    scanner: {
+        buy: number | null;
+        sell: number | null;
+    };
+};
+/**
+ * Random trades on a fresh coin with this table: the creator's first buy, three snipers in the first blocks, wallets
+ * that come, buy, hold for a while and sell (and try again when refused), some bags split to fresh wallets that then
+ * try to sell. The same seed gives the same run.
+ */
+export declare function simulate(rows: bigint[], release: number, opts?: {
+    seed?: number;
+    trades?: number;
+    devBuyBnb?: number;
+    start?: number;
+}): SimReport;