@xgamesfun/solana 0.20.1 → 0.25.0

package/types/economy/model.d.mts

@@ -10,12 +10,13 @@ export declare const FEES: Readonly<{
  * on `open_box` (order.rs), whoever sends `draw_lottery` (lottery.rs, its `payer`), the authority on `roll`
  * (roll.rs). Measured on devnet: 500,000 lamports per open.
  */
-export declare const ORACLE_FEE = 500000n;
+export declare const ORACLE_FEE = 800000n;
 /**
- * Put in the order itself on every purchase, with the player fee on top of it (order.rs: ESCROW_LAMPORTS + fee); what
- * a collectible's rent doesn't use goes back at settle, and a refund returns all of it (constants.rs).
+ * What js/play's throwaway settle key is funded with, in the purchase's own transaction, for each prize its settle may
+ * open or mint (`loot.SETTLE_RENT_UNIT`): whoever settles pays that rent, the order lends nothing. What the settle
+ * doesn't spend goes back to the player when the key empties itself, and all of it when the roll fails.
  */
-export declare const ESCROW_LAMPORTS = 6000000n;
+export declare const SETTLE_RENT_UNIT = 6000000n;
 /** Rent: (bytes + 128) × 5,080 lamports, as `solana rent` reads it on devnet and mainnet-beta. */
 export declare const RENT_PER_BYTE = 5080n;
 export declare const ACCOUNT_OVERHEAD = 128n;
@@ -35,29 +36,36 @@ export declare const COLLECTIBLE_RENT = 3100000n;
 export declare const SIGNATURE_FEE = 5000n;
 export declare const LAMPORTS_PER_SOL = 1000000000n;
 export declare const WSOL = "So11111111111111111111111111111111111111112";
-/** The program's limits. */
+/** The limits a spec meets: the chain's (the oracle's answer carries 21 accounts; a farm names a tier and a recipe a
+ * collectible's place in a byte; Bubblegum keeps a compressed NFT's link in 200 bytes and its name in 32) and the two
+ * caps that keep a farm's numbers from overflowing. Since loot 0.22 the program caps no count or size of its own. */
 export declare const LIMITS: Readonly<{
-    shares: 4;
-    entries: 8;
     callbackAccounts: 21;
-    lines: 8;
-    collectiblesPerCraft: 8;
-    places: 8;
-    tiers: 4;
-    boosts: 4;
-    growths: 4;
-    gates: 4;
-    odds: 4;
+    tiers: 256;
+    collectiblesPerCraft: 255;
     vouchers: 3;
-    deciders: 3;
-    gateWallets: 16;
-    nameBytes: 32;
-    uriBytes: 200;
-    keyBytes: 32;
+    compressedNameBytes: 32;
+    compressedUriBytes: 200;
     maxBoostBps: 1000000;
     maxTierBps: 110000;
+    boxEntries: 128;
+    boxSlots: 32;
+    boxOdds: 32;
+    boxFates: 64;
+    entryPrizes: 14;
+    itemTraits: 64;
+    traitKeyBytes: 64;
+    recipeLines: 48;
+    farmRules: 32;
+    growthSteps: 128;
+    contestSides: 1024;
+    deciders: 32;
+    collections: 32;
+    lotteryRuns: 64;
+    farmEnds: 100000;
 }>;
-/** Attribute names the program writes itself, which a recipe cannot copy and `Set` cannot change (craft.rs, make.rs). */
+/** Attribute names the program writes itself, which a recipe cannot copy and `Set` cannot change (craft.rs, make.rs),
+ * and the two a collectible's life keeps (`lifeLines`: its uses and its next use). */
 export declare const RESERVED_ATTRIBUTES: readonly string[];
 export declare const RARITIES: readonly string[];
 /** A refusal raised while reading a value; the checker turns it into a refusal with a code. */
@@ -79,18 +87,43 @@ export declare function toBps(percent: any): number | null;
 /** "7d" → 604800. A number is seconds already. */
 export declare function toSeconds(duration: any): number;
 /**
- * How long what lands in a farm's rewards pool takes to be released to its seats, in seconds (a farm that shares its
- * pool, `farm.rs` `release_span`): its longest lock tier, and a day at least.
+ * How long what lands in a farm's rewards vault takes to be released to its seats, in seconds (a farm that shares what
+ * lands, `farm.rs` `release_span`): its longest lock tier, and a day at least.
  */
 export declare const releaseSeconds: (f: any) => number;
 /** A farm's release span in words: "a day", "30 days", "36 hours". */
 export declare function releaseWords(f: any): string;
+/**
+ * What a run sent late does, in words (schedule.rs `catches_up`): a sealed schedule's fixed amount pays every run due;
+ * any other run pays once, for the latest run due, and the runs before it lapse.
+ */
+export declare const lateRunWords: (s: any) => "a run missed is missed: one sent late pays once, for the latest run due, and the runs before it lapse" | "a run sent late pays every run due since";
+/**
+ * Whether a farm's boost reads a number its own growth writes (`refresh_seat` writes it): each level counts from when it is
+ * written, so a page or a keeper should refresh seats.
+ */
+export declare const boostReadsGrowth: (f: any) => any;
+/** A box's roll against what is in stock, in words (order.rs): the odds stay as written, whatever is left. */
+export declare const STOCK_WORDS = "The odds stay as written whatever is in stock: a draw that lands on an outcome that can\u2019t be given then (its pool short of the whole amount, its item or stash gone) is not made, no other outcome takes its place, and that draw\u2019s worth of the price goes back at the settle; with no draw made at all, a paid open fails and is refunded, and a free roll goes back to waiting";
+/**
+ * What a box that rolls does once an outcome can't be given (`whenOut`, order.rs `WhenOut`), in words. `sold`: it is
+ * sold (an open checks the stock); a box only other routes roll (a prize, a mission) never stops a sale.
+ */
+export declare function whenOutWords(b: any, { sold }?: {
+    sold?: boolean | undefined;
+}): "The odds stay as written whatever is in stock: a draw that lands on an outcome that can’t be given then (its pool short of the whole amount, its item or stash gone) is not made, no other outcome takes its place, and that draw’s worth of the price goes back at the settle; with no draw made at all, a paid open fails and is refunded, and a free roll goes back to waiting. A free roll (a prize, a recipe’s, a mission’s chest) is on the odds as written too: a draw on an outcome that is out misses and gives nothing back (a pack keeps what its other draws won; a roll that drew nothing waits to be asked again), so emptying a shared source before asking steers nothing. A pack that should draw among what is left needs \"whenOut\": \"drawLeft\"" | "When an outcome runs out (an item sold out, a pool short of its prize, a stash empty), a roll draws among the outcomes still there by their written weights, so the others’ chances rise; with nothing left at all, a free roll waits to be asked again and a paid one is refunded" | "When an outcome runs out (an item sold out, a pool short of its prize, a stash empty), the box keeps selling while its first draw has anything left, and a roll draws among the outcomes still there by their written weights: the others’ chances rise as one runs out, so a player can empty a common outcome to make a rare one likelier (a box selling a rare prize should stop selling instead, the default)" | "When an outcome runs out, the box stops selling: it isn’t sold while anything an outcome takes (an item’s units left, a pool’s tokens, a stash’s NFTs) couldn’t cover, at the most any outcome sharing it takes in one draw, this purchase’s draws and those of purchases still waiting for the oracle, so every roll is on the odds as written and nobody can buy their way to a refund on every miss; it sells again once the project restocks or edits the box (an outcome whose odds shrink with stock needs no cover). An outcome emptied another way all the same (another route sharing its pool, item or stash) makes no draw, no other outcome taking its place, and gives back that draw’s worth of the price at the settle; with no draw made at all, the open is refunded";
 /**
  * What the end of a sharing farm that `runs` means, in words, or null (no end, or a fixed rate): its release keeps its
- * pace, so what it has not let go by the end stays in the pool, the project's, and so does what a seat gives back after
- * the end; a seat that may be dead (a watched NFT sold, an upkeep run out) is refreshed a release span before it.
+ * pace, so what it has not let go by the end stays in its vault, free for the authority to take back, and so does what
+ * a seat forfeits after the end.
  */
 export declare function farmEndWords(f: any): string | null;
+/**
+ * The token a farm's rewards are in (`rewards`, a token key): by default its staked token, or for a farm of
+ * collectibles the project's currency. One that names a pool (as farms did before they had a vault of their own) is
+ * read as that pool's token, and the checker refuses it.
+ */
+export declare function farmRewardsToken(f: any, tokens: any, currencyKey: any, poolCurrency?: Map<any, any>): any;
 /** A raise's or a shift's `by`: a number, or for a time a duration, which may be negative ("-1d"). */
 export declare function toBy(by: any): any;
 /** "publish", "publish+7d" or a date → Unix seconds, counted from `now` (Unix seconds) for the first two. */
@@ -130,8 +163,9 @@ export declare function model(economy: any, { now }?: {
     /** The project's number among its owner's: its address is ["project", owner, number]. */
     projectNumber: any;
     items: any;
-    pools: any[];
+    pools: any;
     stashes: any;
+    tables: any;
     boxes: never[];
     payments: any;
     recipes: any;
@@ -155,12 +189,12 @@ export declare function model(economy: any, { now }?: {
 export declare function stashNfts(s: any): any;
 /**
  * A prize as the spec writes it (`$defs/prize`), read the one way: a line { gives, … } as a recipe's `out` lines are:
- * "item" (`item`), "tokens" (`amount`, `from` "mint" with `currency`, or "pool:<key>"), "share" (`percent` of `pool`),
+ * "item" (`item`), "tokens" (`amount`, `from` "mint" with `currency`, or "pool:<key>"),
  * "nft" (`nft`, an address the stash `stash` lists) or "roll" (a roll of `box`; in a recipe, on the collectible kept
  * at `on`). A grant's older `gives` ({ item }, { pool, amount }, { roll }) reads as its line. Null for none.
  */
 export declare function prizeLine(p: any): any;
-/** The pool a prize line pays from: a share's, or tokens' "pool:<key>". */
+/** The pool a prize line pays from: tokens' "pool:<key>". */
 export declare const prizePool: (p: any) => any;
 /** The token a prize line pays in: its pool's, or the one it mints. */
 export declare const prizeToken: (p: any, m: any) => any;
@@ -203,25 +237,49 @@ export declare function rollsOf(m: any): {
     by: any;
     route: any;
 }[];
-/** A prize line in words: "one Badge", "100 GOLD from “rewards”", "100 GOLD, minted", "10% of “jackpot”", "the NFT ab12…cd34 of “vault”", "a roll of “Chest”". */
+/** A prize line in words: "one Badge", "100 GOLD from “rewards”", "100 GOLD, minted", "the NFT ab12…cd34 of “vault”", "a roll of “Chest”". */
 export declare function prizeWords(p: any, m: any): string;
 /**
- * What one box outcome gives (catalog.rs, at most three prizes an entry), each in the box's own words: "item",
- * "pay" (a fixed amount from a pool), "share" (a percent of a pool), "stash" (an NFT of a stash at random), "mint"
+ * What one box outcome gives (catalog.rs), each in the box's own words: "item", "pay" (a fixed amount from a pool),
+ * "stash" (an NFT of a stash at random), "mint"
  * (tokens minted), "nft" (one NFT a stash lists) or "roll" (a roll of another box). A bundle gives its `prizes`; "burn"
  * and "nothing" give none.
  */
 export declare function outcomeParts(o: any): any;
-/** Whether an outcome burns the payment in place of the box's split: "burn", or a bundle that says `burns`. */
-export declare const outcomeBurns: (o: any) => boolean;
 /** Whether a box leaves its outcome to the oracle (catalog.rs `rolls`): more than one outcome, or an NFT at random. */
-export declare const boxRolls: (b: any) => any;
-/** Whether a box sells with `buy`, in one transaction (buy.rs): it doesn't roll, and rolls on no NFT. */
-export declare const boxBuys: (b: any) => boolean;
-/** A lottery's place as { percent, prize }: a number is a share of the pot and no prize. */
+/** How many draws one open of a box makes: its slots' counts, or one. */
+export declare const drawsOf: (b: any) => any;
+/** Whether a box's prize costs its settle a collectible's rent: an item minted as a Core NFT, or a fresh compressed one
+ * (its traits' Sheet). A plain compressed NFT costs no rent. */
+export declare const holdsRent: (p: any, m: any) => boolean;
+/**
+ * The units of `SETTLE_RENT_UNIT` a settle of box `b`'s order may spend (`loot.settleRent`), which js/play funds its
+ * throwaway settle key with and gets back unspent: for each draw, each part of the richest outcome that opens an
+ * account (a collectible, a fresh compressed NFT's Sheet, a stash's NFT); once an order, each source of tokens it may
+ * pay, and the fate of the NFT it rolls on.
+ */
+export declare function settleUnits(b: any, m: any): number;
+export declare const boxRolls: (b: any, m: any) => any;
+/** Whether a box sells with `buy`, in one transaction (buy.rs): it doesn't roll and rolls on no NFT, any number of draws
+ * a sale (a fixed pack: its prizes given once for each draw). */
+export declare const boxBuys: (b: any, m: any) => boolean;
+/**
+ * What a recipe's lines owe the life of each collectible they take (an item's `life`), as the program's needs and
+ * raises (craft.rs `Need`, `Raise`), at each collectible's place in the recipe (each burned unit, then each kept one, in
+ * line order; a pay line takes none): ready after `readyAfter` (`made` older than it), for `lasts` (`made` within it),
+ * on every line that takes it; `uses` times (`used` raised by 1 up to it) and a `cooldown` (`next_use` passed, then
+ * raised to that far from now) on a line that uses it or takes it staked; a renew line counts its uses from 0 again.
+ * { needs, raises }, in the program's shapes.
+ */
+export declare function lifeLines(r: any, m: any): {
+    needs: any[];
+    raises: any[];
+};
+/** A lottery's place as { percent, prize }: a number is a percent of what the round pays from, and no prize. */
 export declare const placeOf: (p: any) => {
     percent: any;
     prize: any;
+    times: any;
 };
 /** "pool:house" → { kind: 'pool', key: 'house' }; "burn" → { kind: 'burn' }. */
 export declare function destination(to: any): {
@@ -237,7 +295,8 @@ export declare const sharesOf: (split: any) => any;
  * The program's `To` for a destination, with pool indexes resolved (the IDL's own shape). A wallet ("wallet:<address>")
  * is paid at its own token account of the part's currency (the program opens it when it is not there); "treasury" is the game's treasury wallet's; "chosen"
  * (or "chosen:<item>") is the one the buyer names when they buy; "lottery:<key>" is that lottery's pot
- * ("@pot:<id>", which the plan resolves once the game is known).
+ * ("@pot:<lottery id>:<pot id>") and "farm:<key>" that farm's rewards vault ("@rewards:<id>"), which the plan resolves once the game is
+ * known.
  */
 export declare function toEnum(to: any, m: any): "Burn" | "Treasury" | {
     Pool: any[];
@@ -342,6 +401,51 @@ export declare const windowOf: (part: any, now: any) => {
     opens_at: bigint;
     closes_at: bigint;
 };
+/** Whether lottery `l` pays its places from a pot it keeps (`"pot"`, `PaysFrom::Pot`); false when each round pays from
+ * its own ticket money and sends what its places leave to `"rest"` (`PaysFrom::Round`). */
+export declare const keepsPot: (l: any) => boolean;
+/** The program's `PaysFrom` for a lottery: `{ Pot: [id] }` or `{ Round: { rest } }` (its `rest` as `toEnum` gives it). */
+export declare const paysFromOf: (l: any, m: any) => {
+    Pot: any[];
+    Round?: undefined;
+} | {
+    Pot?: undefined;
+    Round: {
+        rest: string | {
+            Pool: any[];
+            Account?: undefined;
+            Wallet?: undefined;
+            Chosen?: undefined;
+            Holder?: undefined;
+        } | {
+            Pool?: undefined;
+            Account: (string | undefined)[];
+            Wallet?: undefined;
+            Chosen?: undefined;
+            Holder?: undefined;
+        } | {
+            Pool?: undefined;
+            Account?: undefined;
+            Wallet: (string | undefined)[];
+            Chosen?: undefined;
+            Holder?: undefined;
+        } | {
+            Pool?: undefined;
+            Account?: undefined;
+            Wallet?: undefined;
+            Chosen: {
+                item: any;
+            };
+            Holder?: undefined;
+        } | {
+            Pool?: undefined;
+            Account?: undefined;
+            Wallet?: undefined;
+            Chosen?: undefined;
+            Holder: (string | undefined)[];
+        };
+    };
+};
 /** A lottery's split of ticket money: its own, and "cutPercent" as a share to the treasury. */
 export declare const lotterySplit: (l: any) => any[];
 /** The program's `Effect` for a spec effect: a flat share, or a share per point of the attribute. */
@@ -361,3 +465,12 @@ export declare function weights(box: any): any;
 export declare function poolTakers(m: any): any[];
 /** Every place the spec sends money into a pool. */
 export declare function poolFillers(m: any): any[];
+/**
+ * Every place the spec sends money into a farm's rewards vault ("farm:<key>"): a split's share, a schedule that pays it,
+ * a craft that pays it, the owner's seed, an early exit's fee into its own vault. [{ farm, by, how }]
+ */
+export declare function farmFillers(m: any): {
+    farm: any;
+    by: string;
+    how: string;
+}[];