@xgamesfun/solana 0.20.1 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/README.md +10 -10
  2. package/examples/coin-flip-arena.json +2 -7
  3. package/examples/elements-set.json +2 -9
  4. package/examples/expedition-guild.json +1 -8
  5. package/examples/guild-missions.json +3 -10
  6. package/examples/halving-seasons.json +4 -9
  7. package/examples/hero-trials.json +1 -4
  8. package/examples/merge-2048.json +5 -5
  9. package/examples/paper-hands-farm.json +4 -16
  10. package/examples/partner-vault.json +1 -4
  11. package/examples/stakers-draw.json +1 -8
  12. package/examples/star-fleet.json +1 -8
  13. package/examples/starforce.json +6 -6
  14. package/js/approve/details.mjs +8 -7
  15. package/js/approve/server.mjs +20 -5
  16. package/js/chain/borsh.js +9 -0
  17. package/js/chain/core.js +14 -2
  18. package/js/chain/lookup.js +8 -2
  19. package/js/chain/rpc.js +4 -2
  20. package/js/client/accounts.js +448 -116
  21. package/js/client/grant.js +125 -66
  22. package/js/client/idl/loot.js +1 -1
  23. package/js/client/idl/loot.json +2360 -2218
  24. package/js/client/index.js +1 -0
  25. package/js/client/ix.js +1204 -473
  26. package/js/client/pda.js +20 -16
  27. package/js/client/policy.js +44 -23
  28. package/js/client/random.js +70 -0
  29. package/js/client/sizes.js +255 -12
  30. package/js/economy/check.mjs +455 -210
  31. package/js/economy/cost.mjs +45 -30
  32. package/js/economy/examples.mjs +2 -2
  33. package/js/economy/explain.mjs +24 -20
  34. package/js/economy/guide.mjs +31 -30
  35. package/js/economy/live.mjs +30 -7
  36. package/js/economy/model.mjs +171 -56
  37. package/js/economy/plan.mjs +380 -112
  38. package/js/economy/schema.json +291 -143
  39. package/js/economy/simulate.mjs +154 -87
  40. package/js/mcp/tools.mjs +14 -8
  41. package/js/play/index.js +1121 -375
  42. package/js/play/keys.js +167 -0
  43. package/package.json +1 -1
  44. package/release.json +5 -5
  45. package/skills/xsolana-economy/SKILL.md +15 -11
  46. package/skills/xsolana-economy/references/after-launch.md +37 -27
  47. package/skills/xsolana-economy/references/apps.md +55 -19
  48. package/skills/xsolana-economy/references/sentence-to-spec.md +30 -22
  49. package/skills/xsolana-economy/references/telling-the-person.md +52 -11
  50. package/types/chain/core.d.ts +3 -1
  51. package/types/chain/lookup.d.ts +5 -2
  52. package/types/chain/rpc.d.ts +3 -1
  53. package/types/client/accounts.d.ts +195 -55
  54. package/types/client/grant.d.ts +72 -27
  55. package/types/client/idl/loot.d.ts +590 -559
  56. package/types/client/index.d.ts +1 -0
  57. package/types/client/ix.d.ts +3862 -234
  58. package/types/client/pda.d.ts +19 -15
  59. package/types/client/policy.d.ts +39 -14
  60. package/types/client/random.d.ts +26 -0
  61. package/types/client/sizes.d.ts +93 -5
  62. package/types/economy/check.d.mts +5 -10
  63. package/types/economy/cost.d.mts +2 -1
  64. package/types/economy/live.d.mts +16 -1
  65. package/types/economy/model.d.mts +105 -37
  66. package/types/economy/plan.d.mts +193 -192
  67. package/types/economy/simulate.d.mts +21 -13
  68. package/types/mcp/tools.d.mts +21 -13
  69. package/types/play/index.d.ts +450 -39
  70. package/types/play/keys.d.ts +51 -0
package/js/client/pda.js CHANGED
@@ -27,7 +27,6 @@ const i64 = (n) => intLE(n, 8);
27
27
  /** The PDA of these seeds under the loot program, with its bump. */
28
28
  export const lootAddress = (seeds, program = LOOT_PROGRAM) => findProgramAddress(seeds, program);
29
29
  const at = (...seeds) => lootAddress(seeds)[0];
30
- const keyReceipt = (grant, incarnation, voucherKey) => at(seed('code'), key(grant), u64(incarnation), key(voucherKey));
31
30
 
32
31
  export const pda = {
33
32
  platform: () => at(seed('platform')),
@@ -36,11 +35,15 @@ export const pda = {
36
35
  project: (creator, id = 0) => at(seed('project'), key(creator), u64(id)),
37
36
  /** The project's fee box: where the platform's fees on its transactions wait. */
38
37
  fees: (project) => at(seed('fees'), key(project)),
39
- pool: (project, index) => at(seed('pool'), key(project), u8(index)),
38
+ pool: (project, index) => at(seed('pool'), key(project), u16(index)),
40
39
  item: (project, id) => at(seed('item'), key(project), u32(id)),
41
40
  box: (project, id) => at(seed('box'), key(project), u32(id)),
42
41
  /** NFTs the project holds to give away as prizes: a box entry of a stash gives one of them at random. */
43
42
  stash: (project, id) => at(seed('stash'), key(project), u32(id)),
43
+ /** A table of weighted rows the project writes and seals (a card among thousands, a trait's values), or commits by a Merkle root. */
44
+ table: (project, id) => at(seed('table'), key(project), u32(id)),
45
+ /** What the project keeps about a wallet (its player's profile: XP, level, rank). */
46
+ profile: (project, wallet) => at(seed('profile'), key(project), key(wallet)),
44
47
  schedule: (project, id) => at(seed('schedule'), key(project), u32(id)),
45
48
  lottery: (project, id) => at(seed('lottery'), key(project), u32(id)),
46
49
  recipe: (project, id) => at(seed('recipe'), key(project), u32(id)),
@@ -55,12 +58,12 @@ export const pda = {
55
58
  itemAsset: (item, serial) => at(seed('asset'), key(item), u32(serial)),
56
59
  /** A contest's pot, or a lottery's: `["pot", contest or lottery]`. */
57
60
  pot: (record) => at(seed('pot'), key(record)),
58
- lotteryFunds: (lottery) => at(seed('lottery_funds'), key(lottery)),
59
- lotteryReceipt: (lottery, incarnation, wallet) => at(seed('receipt'), key(lottery), u64(incarnation), key(wallet)),
60
- /** One purchase of a lottery's tickets, at a nonce of its buyer's. */
61
- contribution: (lottery, player, nonce) => at(seed('contribution'), key(lottery), key(player), u64(nonce)),
62
- /** A wallet's entry in a contest: one, on one side (another side is `OtherSide`). */
63
- entry: (contest, player) => at(seed('entry'), key(contest), key(player)),
61
+ /** One round of a lottery: its record, opened by the round's first purchase (`["round", lottery, incarnation, round]`). */
62
+ round: (lottery, incarnation, round) => at(seed('round'), key(lottery), u64(incarnation), u32(round)),
63
+ /** A lottery round's own token account of `mint`, which the round's record owns. */
64
+ roundTokens: (round, mint) => at(seed('round-tokens'), key(round), key(mint)),
65
+ /** A contest's list of entries, one record a player (page 0). */
66
+ entries: (contest, incarnation, page = 0) => at(seed('entries'), key(contest), u64(incarnation), u8(page)),
64
67
  /** A hold names its NFT and its end (Unix seconds): a release sent late never finds a later hold of the NFT. */
65
68
  hold: (asset, freeAt) => at(seed('hold'), key(asset), i64(freeAt)),
66
69
  /** An offer: an id is its maker's own. Its money waits in the project's vault for its mint (`vault`). */
@@ -75,6 +78,8 @@ export const pda = {
75
78
  listing: (project, asset) => at(seed('listing'), key(project), key(asset)),
76
79
  staked: (farm) => at(seed('staked'), key(farm)),
77
80
  rewards: (farm) => at(seed('rewards'), key(farm)),
81
+ /** A farm's record of when its seats stop earning, for a farm that keeps one (`Farm.keeps_ends`). */
82
+ ends: (farm) => at(seed('ends'), key(farm)),
78
83
  /** A seat: a player's in a farm of tokens, a collectible's (its asset) in a farm of collectibles. */
79
84
  seat: (farm, by) => at(seed('seat'), key(farm), key(by)),
80
85
  /** What the project writes about an NFT it has no authority over (its Sheet): `nft` is a Core asset, a Token Metadata mint or a compressed NFT's asset id. */
@@ -87,14 +92,13 @@ export const pda = {
87
92
  treeConfig: (tree) => findProgramAddress([key(tree)], BUBBLEGUM_PROGRAM)[0],
88
93
  /** A compressed NFT's asset id: Bubblegum's `["asset", tree, nonce]`, `nonce` the count minted before it. */
89
94
  compressedAsset: (tree, nonce) => findProgramAddress([seed('asset'), key(tree), u64(nonce)], BUBBLEGUM_PROGRAM)[0],
90
- /** A wallet's counter on a box or recipe. Grants and lotteries also name their incarnation. */
91
- receipt: (record, wallet) => at(seed('receipt'), key(record), key(wallet)),
92
- grantReceipt: (grant, incarnation, wallet) => at(seed('receipt'), key(grant), u64(incarnation), key(wallet)),
93
- person: (grant, incarnation, personHash) => at(seed('person'), key(grant), u64(incarnation), Uint8Array.from(personHash)),
94
- /** How many times an NFT shown claimed an open grant its gate asks for one of: an address of its own, never a person's. */
95
- badge: (grant, incarnation, nft) => at(seed('badge'), key(grant), u64(incarnation), key(nft)),
96
- /** A voucher key's counter on a grant (a promo code's). */
97
- code: keyReceipt,
95
+ /** A wallet's counts in a project: how many times it bought from each box, crafted each recipe or held tickets in
96
+ * a lottery's round that limits it (`decodeCounts`). */
97
+ counts: (project, wallet) => at(seed('counts'), key(project), key(wallet)),
98
+ /** Shard `shard` of a grant's limit records: what each wallet, person, badge and voucher key claimed. */
99
+ claims: (grant, incarnation, shard) => at(seed('claims'), key(grant), u64(incarnation), u8(shard)),
100
+ /** Shard `shard` of the rounds a grant paid. */
101
+ rounds: (grant, incarnation, shard) => at(seed('rounds'), key(grant), u64(incarnation), u8(shard)),
98
102
  /** The program's identity, which signs its requests to the oracle. */
99
103
  identity: () => at(seed('identity')),
100
104
  /** The identity the oracle signs callbacks with: the VRF program's PDA for this program. */
@@ -3,28 +3,44 @@
3
3
  import IDL from './idl/loot.js';
4
4
 
5
5
  const constant = name => BigInt(IDL.constants.find(value => value.name === name).value);
6
- export const STALE_SLOTS = constant('STALE_SLOTS');
7
- export const LOTTERY_TIMEOUT_SLOTS = constant('LOTTERY_TIMEOUT_SLOTS');
8
- const U64_MAX = (1n << 64n) - 1n;
6
+ /** How long the oracle has to answer before a roll or a draw may be asked again, and a pending order refunded (seconds). */
7
+ export const STALE_SECONDS = constant('STALE_SECONDS');
8
+ /** How long after a lottery's first ask the next ask cancels its round, and an asked order holding a payment or an NFT
9
+ * may be refunded (seconds). */
10
+ export const LOTTERY_TIMEOUT_SECONDS = constant('LOTTERY_TIMEOUT_SECONDS');
9
11
 
10
12
  /**
11
- * The earliest slot an order can be refunded in, or null when it never can be: a rolled order has an outcome anyone
12
- * can carry out, and is settled, never refunded; a roll a mission or a recipe made waits for anyone to ask for it
13
- * (`Waiting`), and once asked (`Asked`) is asked again if the oracle never answers (`rollAskable`).
13
+ * The earliest an order can be refunded, as `{ slot, at }` (the program wants a later slot than `slot` and a later
14
+ * second than `at`), or null when it never can be as it stands: a failed order from the next slot; a paid order the
15
+ * oracle never answered 10 minutes after it was asked (`STALE_SECONDS`); an asked roll holding a payment or an NFT 7 days
16
+ * after its first ask. A rolled order has an outcome to carry out, and is settled. A waiting roll, or an asked one holding
17
+ * nothing, is asked (again): `rollAskable`.
14
18
  */
15
- export function orderRefundSlot(order) {
16
- let wait;
17
- if (order.status === 'Failed') wait = 0n;
18
- else if (order.status === 'Pending') wait = STALE_SLOTS;
19
- else if (['Rolled', 'Waiting', 'Asked'].includes(order.status)) return null;
20
- else throw new Error('Unknown order status.');
21
- const deadline = BigInt(order.requested_slot) + wait;
22
- // The program requires strictly greater than the saturating deadline; MAX + 1 is unreachable.
23
- return (deadline > U64_MAX ? U64_MAX : deadline) + 1n;
19
+ export function orderRefundAt(order) {
20
+ const slot = BigInt(order.requested_slot);
21
+ if (order.status === 'Failed') return { slot, at: null };
22
+ if (order.status === 'Pending') return { slot, at: BigInt(order.asked_at) + STALE_SECONDS };
23
+ if (order.status === 'Asked' && (BigInt(order.paid ?? 0) > 0n || order.held)) return { slot: null, at: BigInt(order.first_asked_at) + LOTTERY_TIMEOUT_SECONDS };
24
+ if (['Rolled', 'Waiting', 'Asked'].includes(order.status)) return null;
25
+ throw new Error('Unknown order status.');
24
26
  }
25
27
 
26
- /** Whether anyone may ask the oracle for a mission's or a recipe's roll at `slot`: never asked, or never answered. */
27
- export const rollAskable = (order, slot) => order.status === 'Waiting' || (order.status === 'Asked' && BigInt(slot) > BigInt(order.requested_slot) + STALE_SLOTS);
28
+ /** Whether an order can be refunded at `slot` and `now` (Unix seconds, the chain's clock): `orderRefundAt`. */
29
+ export function orderRefundable(order, slot, now) {
30
+ const due = orderRefundAt(order);
31
+ if (!due) return false;
32
+ return (due.slot === null || BigInt(slot) > due.slot) && (due.at === null || BigInt(now) > due.at);
33
+ }
34
+
35
+ /**
36
+ * Whether its player or the project's keys may ask the oracle for a mission's or a recipe's roll at `slot` and `now`
37
+ * (Unix seconds, the chain's clock): never asked, or never answered within `STALE_SECONDS`. Once asked, a later ask comes
38
+ * in a later slot than the last (`SameSlot`: never the same seed twice), so a roll that found nothing in stock and waits
39
+ * again is asked from the next slot on.
40
+ */
41
+ export const rollAskable = (order, slot, now) =>
42
+ (order.status === 'Waiting' && (BigInt(order.asked_first ?? 0) === 0n || BigInt(slot) > BigInt(order.requested_slot))) ||
43
+ (order.status === 'Asked' && BigInt(now) > BigInt(order.asked_at) + STALE_SECONDS);
28
44
 
29
45
  /**
30
46
  * Whether a contest is off at `now` (Unix seconds), as the program reads its verdict: called off, its result
@@ -37,12 +53,17 @@ export function contestOff(contest, now) {
37
53
  return BigInt(now) > BigInt(contest.result_by) || (BigInt(now) >= BigInt(contest.closes_at) && total < BigInt(contest.min_pot ?? 0));
38
54
  }
39
55
 
40
- /** Whether a lottery's draw was asked for and the oracle has not answered within `STALE_SLOTS`: anyone may ask again. */
41
- export const lotteryDrawStuck = (lottery, slot) => lottery.status === 'Drawing' && BigInt(slot) > BigInt(lottery.asked_slot) + STALE_SLOTS;
56
+ /** Whether a lottery round's draw (`round`: its decoded record) was asked for and the oracle has not answered within
57
+ * `STALE_SECONDS` by `now` (Unix seconds, the chain's clock): anyone may ask again. */
58
+ export const lotteryDrawStuck = (round, now) => round?.status === 'Drawing' && BigInt(now) > BigInt(round.asked_at) + STALE_SECONDS;
42
59
 
43
60
  /**
44
- * Whether a lottery's draw was asked for and the oracle has not answered within `LOTTERY_TIMEOUT_SLOTS` of the first
45
- * ask (asking again doesn't move it): anyone may cancel the round and refund it. A round nobody asked to draw is never
46
- * cancelled.
61
+ * Whether a lottery round's draw (`round`: its decoded record) was asked for and the oracle has not answered within
62
+ * `LOTTERY_TIMEOUT_SECONDS` of the first ask (asking again doesn't move it) by `now` (Unix seconds, the chain's clock):
63
+ * the next ask of that round (`drawLotteryIx` with its address) cancels it, and every entry is refunded. A round nobody
64
+ * asked to draw is never cancelled.
47
65
  */
48
- export const lotteryCancellable = (lottery, slot) => lottery.status === 'Drawing' && BigInt(slot) > BigInt(lottery.asked_first) + LOTTERY_TIMEOUT_SLOTS;
66
+ export const lotteryCancellable = (round, now) => round?.status === 'Drawing' && BigInt(now) > BigInt(round.first_asked_at) + LOTTERY_TIMEOUT_SECONDS;
67
+
68
+ /** A farm seat's `earns_until` when nothing ends its earning (i64::MAX): no tier term and no fuel it reads. */
69
+ export const NO_END = (1n << 63n) - 1n;
@@ -0,0 +1,70 @@
1
+ // The loot program's rolling module (`src/random`), mirrored: every random choice it makes is drawn from a stream of
2
+ // the oracle's answer, by a path that names what is drawn, with one unbiased sampler. A page shows from an order's
3
+ // answer what each draw gave (and a fresh unit's range traits) exactly as the program drew them. Held to the
4
+ // program's own vectors (`js/test/fixtures/roll-vectors.json`, from gamesfun-loot's `tests/fixtures`).
5
+ import { concat, uintLE } from '../chain/bytes.js';
6
+ import { sha256 } from '../chain/sha256.js';
7
+
8
+ /** What a path's first word names (`random::tag`): an entry of a box, a stash's NFT, a lottery's ticket, a fresh trait. */
9
+ export const TAG = Object.freeze({ ENTRY: 1, STASH: 2, LOTTERY: 3, TRAIT: 4 });
10
+ /** The most words a path holds. */
11
+ export const MAX_PATH = 8;
12
+ const U64 = (1n << 64n) - 1n;
13
+ const PREFIX = new TextEncoder().encode('loot-roll-v1');
14
+
15
+ /** A stream of the oracle's 32-byte `answer` at `path` (whole numbers): seed = sha256("loot-roll-v1" | answer | path as
16
+ * u32 little-endian words); its nth number the first 8 bytes, little-endian, of sha256(seed | n as u64 little-endian). */
17
+ export function stream(answer, path = []) {
18
+ const words = path.slice(0, MAX_PATH).map((w) => uintLE(w, 4));
19
+ const seed = sha256(concat(PREFIX, Uint8Array.from(answer), ...words));
20
+ let counter = 0n;
21
+ return {
22
+ next() {
23
+ const block = sha256(concat(seed, uintLE(counter, 8)));
24
+ counter += 1n;
25
+ return block.subarray(0, 8).reduceRight((n, b) => (n << 8n) | BigInt(b), 0n);
26
+ },
27
+ };
28
+ }
29
+
30
+ /** A number from 0 to `n` - 1, every one as likely: a draw past the last whole multiple of `n` is drawn again. null for
31
+ * `n` 0. */
32
+ export function uniform(s, n) {
33
+ n = BigInt(n);
34
+ if (n === 0n) return null;
35
+ const limit = U64 - (((1n << 64n) - n) % n);
36
+ for (;;) {
37
+ const roll = s.next();
38
+ if (roll <= limit) return roll % n;
39
+ }
40
+ }
41
+
42
+ /** The row `at` lands on, the weights walked in order. null past the last. */
43
+ export function walk(weights, at) {
44
+ let left = BigInt(at);
45
+ for (const [i, w] of weights.entries()) {
46
+ if (left < BigInt(w)) return i;
47
+ left -= BigInt(w);
48
+ }
49
+ return null;
50
+ }
51
+
52
+ /** A row by weight (a weight of 0 never drawn); null when none weighs anything, or they sum past 64 bits. */
53
+ export function weighted(s, weights) {
54
+ const total = weights.reduce((n, w) => n + BigInt(w), 0n);
55
+ if (total > U64) return null;
56
+ const at = uniform(s, total);
57
+ return at === null ? null : walk(weights, at);
58
+ }
59
+
60
+ /** A number from `min` to `max`, both included, every one as likely (either order). */
61
+ export function range(s, min, max) {
62
+ let [lo, hi] = [BigInt(min), BigInt(max)];
63
+ if (lo > hi) [lo, hi] = [hi, lo];
64
+ const n = hi - lo + 1n;
65
+ return n > U64 ? s.next() : lo + uniform(s, n);
66
+ }
67
+
68
+ /** A fresh unit's range trait `t` (its place among the item's traits) as the program draws it at the mint: from the
69
+ * order's `answer`, `at` the unit's place in the order's `won`. */
70
+ export const rangeTrait = (answer, at, t, min, max) => range(stream(answer, [TAG.TRAIT, at, t]), min, max);
@@ -1,11 +1,11 @@
1
1
  // Rent sizes from the current IDL. Fixed allocations reserve the largest enum and option forms,
2
2
  // matching Anchor InitSpace. Dynamic records use their actual encoded fields.
3
- import { encodeAccount } from '../chain/borsh.js';
3
+ import { encodeAccount, encodeBorsh } from '../chain/borsh.js';
4
4
  import IDL from './idl/loot.js';
5
5
 
6
6
  const scalar = { bool: 1, u8: 1, u16: 2, u32: 4, i32: 4, u64: 8, i64: 8, u128: 16, pubkey: 32 };
7
- // The most an order holds: its shares, and a roll's fate (`MAX_SHIFTS` numbers, each key at most 32 bytes).
8
- const bounds = { 'Order.shares': 4, 'Order.won': 3, 'Fate.shifts': 2, 'Project.collections': 8 };
7
+ // What a fixed-size account reserves for its lists and strings: a roll's fate (`Fate.shifts`, each key at most 32 bytes).
8
+ const bounds = { 'Fate.shifts': 2 };
9
9
  const strings = { 'Shift.key': 32 };
10
10
  function maximum(type, path) {
11
11
  if (type === 'string') {
@@ -38,17 +38,260 @@ export function allocationBytes(name) {
38
38
 
39
39
  /** The exact bytes of a dynamically allocated account. */
40
40
  export const accountBytes = (name, value) => encodeAccount(IDL, name, value).length;
41
- export const ACCOUNT_BYTES = Object.freeze({ ...Object.fromEntries(['Order', 'Seat', 'Hold', 'Entry', 'LotteryContribution'].map((name) => [name, allocationBytes(name)])) });
41
+ /** A seat; a loan's hold (with room for its debt); a hold a player asks for, made without one (`Hold::PLAIN`). */
42
+ export const ACCOUNT_BYTES = Object.freeze({
43
+ Seat: allocationBytes('Seat'),
44
+ Loan: allocationBytes('Hold'),
45
+ Hold: allocationBytes('Hold') - maximum({ defined: { name: 'Debt' } }, 'Debt'),
46
+ });
42
47
 
43
48
  /** A project's bytes with `collections` collections, as the program sizes the account. */
44
49
  export const projectBytes = (collections = 0) => 153 + 32 * collections;
45
50
 
46
- // A receipt is not in the IDL and is read by hand: a 17-byte head (its tag, counts and how many rounds), then 8 bytes
47
- // for each round it holds (see docs/program.md).
48
- export const MAX_RECEIPT_ROUNDS = Number(IDL.constants.find((entry) => entry.name === 'MAX_RECEIPT_ROUNDS').value);
49
- export const RECEIPT_BASE_BYTES = 17;
50
- export const RECEIPT_ROUND_BYTES = 8;
51
- export function receiptBytes(rounds = 0) {
52
- if (!Number.isInteger(rounds) || rounds < 0 || rounds > MAX_RECEIPT_ROUNDS) throw new RangeError(`A receipt retains at most ${MAX_RECEIPT_ROUNDS} distinct voucher rounds`);
53
- return RECEIPT_BASE_BYTES + RECEIPT_ROUND_BYTES * rounds;
51
+ /** The most accounts the oracle's answer to a roll carries (`MAX_CALLBACK_ACCOUNTS`). */
52
+ export const MAX_CALLBACK_ACCOUNTS = 21;
53
+
54
+ /**
55
+ * The most accounts a roll of `entries` hands the oracle (`catalog::callback_accounts`): the order, the box and the
56
+ * ticket; one for each prize that needs one at the roll (an item, a pool, a stash); and with tokens, the two token
57
+ * programs, the project, and a mint and a vault for each source of tokens.
58
+ */
59
+ export function callbackAccounts(entries) {
60
+ const sources = new Set();
61
+ let named = 0;
62
+ for (const prize of entries.flatMap((e) => e.prizes)) {
63
+ if (prize.Item || prize.Compressed || prize.Nft || prize.Stash) named += 1;
64
+ else if (prize.Tokens) {
65
+ if (prize.Tokens.from.Pool) named += 1;
66
+ sources.add(JSON.stringify(prize.Tokens.from));
67
+ }
68
+ }
69
+ return 3 + named + (sources.size ? 3 + 2 * sources.size : 0);
70
+ }
71
+
72
+ /**
73
+ * How many fresh items' table accounts the oracle's answer to a roll of `entries` can carry (`order::table_budget`):
74
+ * what the box's own accounts leave of `MAX_CALLBACK_ACCOUNTS`. Negative: the box can't be rolled at all.
75
+ */
76
+ export const tableBudget = (entries) => MAX_CALLBACK_ACCOUNTS - callbackAccounts(entries);
77
+
78
+ const draws = (lootBox) => (lootBox.slots?.length ? lootBox.slots.reduce((n, s) => n + Number(s.count), 0) : 1);
79
+ const ZERO = '11111111111111111111111111111111';
80
+
81
+ /** The most an order can be (`MAX_ORDER_BYTES`, not in the IDL): a box whose one open's order would be more is refused
82
+ * at its upsert (`BadEntries`). In practice a pack is bounded first by what one oracle answer draws (`drawsFit`). */
83
+ export const MAX_ORDER_BYTES = 10_240;
84
+
85
+ /** The bytes a draw sets aside for a prize, as the `Won` it becomes (`Order::sized`): an item 14, tokens or an NFT 41,
86
+ * a roll, a held NFT or a raffled place nothing. */
87
+ const wonBytes = (p) => (p.Item || p.Compressed ? 14 : p.Tokens || p.Nft || p.Stash ? 41 : 0);
88
+ const tableCount = (item) => (item?.traits ?? []).filter((t) => t.from?.Table).length;
89
+
90
+ /**
91
+ * The rows of fresh items' tables a draw of each entry writes into its order (`order::rows_of`), walked with the box's
92
+ * table budget as the roll's accounts are (`entryAccounts`: an item whose tables don't fit what is left draws none).
93
+ * `items` maps an item's id to its decoded Item; one left out is taken as not fresh.
94
+ */
95
+ export function entryRows(entries, items = {}) {
96
+ let budget = Math.max(0, tableBudget(entries));
97
+ return entries.map(({ prizes }) => prizes.reduce((n, p) => {
98
+ const id = p.Item?.[0] ?? p.Compressed?.item;
99
+ const t = id === undefined ? 0 : tableCount(items[id]);
100
+ if (t > budget) return n;
101
+ budget -= t;
102
+ return n + t;
103
+ }, 0));
104
+ }
105
+
106
+ /**
107
+ * The bytes of an order of `lootBox` with `shares` shares and `opens` opens. With `items` (an item's id to its decoded
108
+ * Item), as `open_box` sizes it (`Order::sized`): each draw at its dearest entry's prizes as the `Won` they become (an
109
+ * item 14 bytes, tokens or an NFT 41, a roll none) and 4 bytes for each table row its fresh items draw now
110
+ * (`entryRows`); its odds and its largest fate. Without `items`, as a roll made inside another call sizes it (a craft,
111
+ * a grant's claim, a mission, a roll lot: `Order::space_for`): the box's whole table budget a draw for a box that
112
+ * gives items. A pack's order grows with its cards.
113
+ */
114
+ export function orderBytes(lootBox, shares = 0, opens = 1, items) {
115
+ const drawn = draws(lootBox) * Math.max(1, opens);
116
+ const aDraw = Math.max(0, ...lootBox.entries.map((e) => e.prizes.reduce((n, p) => n + wonBytes(p), 0)));
117
+ const gives = lootBox.entries.some((e) => e.prizes.some((p) => p.Item || p.Compressed));
118
+ const rows = items ? Math.max(0, ...entryRows(lootBox.entries, items)) : gives ? Math.max(0, tableBudget(lootBox.entries)) : 0;
119
+ const fates = lootBox.fates ?? [];
120
+ const fate = fates.reduce((a, f) => (a && encodeBorsh(IDL, { defined: { name: 'Fate' } }, a).length >= encodeBorsh(IDL, { defined: { name: 'Fate' } }, f).length ? a : f), null);
121
+ const empty = {
122
+ project: ZERO, player: ZERO, mint: ZERO, loot_box: ZERO, box_version: 0,
123
+ odds_bps: new Array(lootBox.odds?.length ?? 0).fill(0),
124
+ status: 'Waiting',
125
+ won: [],
126
+ paid: 0n, fee: 0n,
127
+ shares: new Array(shares).fill({ to: { Account: [ZERO] }, bps: 0 }),
128
+ opens: 0, settled: 0, undrawn: 0, back: 0n, settler: ZERO, drew: 0, answer: new Uint8Array(32), drawn: [], reserved: 0n,
129
+ requested_slot: 0n, asked_first: 0n, asked_at: 0n, first_asked_at: 0n, counted: 0, subject: lootBox.subject ? ZERO : null, held: false, fate,
130
+ };
131
+ return encodeAccount(IDL, 'Order', empty).length + drawn * (aDraw + rows * 4);
132
+ }
133
+
134
+ // What one oracle answer's roll spends, counted at no less than each part costs (`order.rs`'s `RollCost`, measured by
135
+ // the program's `tests/roll_costs.rs` and `tests/roll_heap.rs`), against the compute and the heap the oracle gives its
136
+ // answer, less a margin.
137
+ const ROLL_BUDGET = 300_000n;
138
+ const ROLL_HEAP = 32n * 1024n - 512n;
139
+ const COST = { fixed: 20_000n, entry: 3_500n, blank: 1_400n, weigh: 1_000n, weighEntry: 40n, pair: 150n, item: 1_500n, tokens: 6_000n, draw: 9_000n, group: 250n, reread: 1_000n, finish: 15_000n, won: 150n, drawn: 50n, odds: 1_000n, share: 1_000n, fate: 1_000n, slot: 500n, slotEntry: 350n, openSlot: 150n };
140
+ const BYTES = { start: 6_000n, prizeRead: 600n, entryRead: 180n, minted: 700n, pooled: 1_000n, prize: 200n, draw: 40n, finish: 2_000n, won: 120n, boxByte: 2n, gateByte: 3n, odds: 100n, fate: 60n, slot: 64n };
141
+
142
+ /** The Borsh length of `value` as IDL type `type`, an address counted as 32 bytes whatever stands in for it (a spec's
143
+ * `@mint:…` before it goes live). */
144
+ function borshLength(type, value) {
145
+ if (typeof type === 'string') return type === 'string' ? 4 + new TextEncoder().encode(String(value)).length : type === 'bytes' ? 4 + value.length : scalar[type];
146
+ if (type.array) return type.array[1] * (type.array[0] === 'u8' ? 1 : borshLength(type.array[0], value?.[0]));
147
+ if (type.vec) return 4 + (value ?? []).reduce((n, v) => n + borshLength(type.vec, v), 0);
148
+ if (type.option) return value == null ? 1 : 1 + borshLength(type.option, value);
149
+ const definition = IDL.types.find((entry) => entry.name === type.defined.name).type;
150
+ if (definition.kind === 'enum') {
151
+ const name = typeof value === 'string' ? value : Object.keys(value)[0];
152
+ const fields = definition.variants.find((v) => v.name === name)?.fields ?? [];
153
+ const payload = typeof value === 'string' ? [] : value[name];
154
+ return 1 + fields.reduce((n, f, i) => n + (typeof f === 'object' && 'name' in f ? borshLength(f.type, payload[f.name]) : borshLength(f, payload[i])), 0);
155
+ }
156
+ return definition.fields.reduce((n, f) => n + borshLength(f.type, value[f.name]), 0);
157
+ }
158
+
159
+ const defined = (name) => ({ defined: { name } });
160
+
161
+ /**
162
+ * The heap reading a box takes beyond its entries (`order::box_bytes`): its odds, gate, shares, subject, slots and
163
+ * fates, read whole with it, by their bytes and their number. `box`: the box's args, as `upsertBoxIx` takes them.
164
+ */
165
+ export function boxBytes({ odds = [], gate = null, shares = [], subject = null, slots = [], fates = [] }) {
166
+ const slotsWritten = slots.map((s) => ({ only: [], distinct: false, share: 0, ...s }));
167
+ const fatesWritten = fates.map((f) => ({ then: null, ...f, shifts: (f.shifts ?? []).map((x) => ({ from_now: false, ...x })) }));
168
+ const bytes = borshLength({ vec: defined('Odds') }, odds) + borshLength({ vec: defined('Share') }, shares) + borshLength({ option: defined('Rule') }, subject)
169
+ + borshLength({ vec: defined('Slot') }, slotsWritten) + borshLength({ vec: defined('Fate') }, fatesWritten);
170
+ return BYTES.boxByte * BigInt(bytes) + BYTES.gateByte * BigInt(borshLength({ option: defined('Gate') }, gate)) + BYTES.odds * BigInt(odds.length) + BYTES.fate * BigInt(fates.length) + BYTES.slot * BigInt(slots.length);
171
+ }
172
+
173
+ /** The account a prize reads, as a string, when it reads one the box can name: entries naming the same share it. */
174
+ const accountOf = (p) => {
175
+ if (p.Item != null) return `item ${p.Item[0] ?? p.Item}`;
176
+ if (p.Compressed) return `item ${p.Compressed.item}`;
177
+ if (p.Tokens?.from?.Pool) return `pool ${p.Tokens.from.Pool[0] ?? p.Tokens.from.Pool}`;
178
+ if (p.Stash != null) return `stash ${p.Stash[0] ?? p.Stash}`;
179
+ if (p.Nft) return `stash ${p.Nft.stash}`;
180
+ return null;
181
+ };
182
+
183
+ /**
184
+ * Whether all of `opens` opens of `entries` by `slots` fit one oracle answer (`order::draws_fit`), each draw at the
185
+ * dearest its slot could make, with what is known from the box alone (no table rows, a stash of one group), its `odds`,
186
+ * `shares` and `fates` counted, and `bytes` (`boxBytes`) of heap reading the box takes beyond its entries. `slots` may
187
+ * be a number: that many draws among every entry. The answer's heap counts for a box that rolls, or one sold through
188
+ * the oracle (`oracle`: a box that doesn't roll but one `buy` can't carry, `buyFits`). The program refuses a box whose
189
+ * one open doesn't fit at its upsert, and a purchase that doesn't at `open_box`, where it also reads what the accounts
190
+ * hold (`PackTooLarge`).
191
+ */
192
+ export function drawsFit(entries, slots, opens = 1, { odds = 0, shares = 0, fates = 0, bytes = 0n, oracle = false } = {}) {
193
+ const list = typeof slots === 'number' || typeof slots === 'bigint' ? [{ count: slots, only: [] }] : (slots ?? []);
194
+ const draws = list.reduce((n, s) => n + BigInt(s.count), 0n) * BigInt(opens);
195
+ if (draws <= 1n) return true;
196
+ const n = BigInt(entries.length);
197
+ const weigh = COST.weigh + COST.weighEntry * n;
198
+ const reads = entries.map((e) => e.prizes.map(accountOf));
199
+ const cost = entries.map((e) => e.prizes.reduce((c, p) => {
200
+ if (p.Item != null || p.Compressed || p.Nft) return { set: c.set + COST.item, again: c.again + COST.reread, bytes: c.bytes + BYTES.prize };
201
+ if (p.Tokens) return { set: c.set + COST.tokens, again: c.again + (p.Tokens.from.Pool ? COST.reread : 0n), bytes: c.bytes + (p.Tokens.from.Pool ? BYTES.pooled : BYTES.minted) };
202
+ if (p.Stash != null) return { set: c.set + COST.draw + COST.group, again: c.again + COST.reread, bytes: c.bytes + BYTES.prize };
203
+ return { set: c.set + COST.item, again: c.again, bytes: c.bytes + BYTES.prize };
204
+ }, { set: 0n, again: 0n, bytes: BYTES.draw }));
205
+ const next = entries.map((_, i) => weigh + cost[i].set + cost.reduce((sum, c, j) => (j === i || reads[i].some((a) => a && reads[j].includes(a)) ? sum + c.again : sum), 0n));
206
+ const most = BigInt(Math.max(1, ...entries.map((e) => e.prizes.length)));
207
+ let spent = COST.fixed + COST.pair * n * n * most * most + entries.reduce((c, e) => c + (e.prizes.length ? COST.entry : COST.blank), 0n);
208
+ let used = BYTES.start + BigInt(bytes) + BYTES.entryRead * n + BYTES.prizeRead * BigInt(entries.reduce((c, e) => c + e.prizes.length, 0));
209
+ let won = 0n;
210
+ spent += (COST.slot + COST.slotEntry * n) * BigInt(Math.max(1, list.length)) + COST.openSlot * BigInt(list.length) * BigInt(opens) + COST.odds * BigInt(odds) + COST.share * BigInt(shares) + COST.fate * BigInt(fates);
211
+ for (const s of list) {
212
+ const count = BigInt(s.count) * BigInt(opens);
213
+ const among = entries.map((_, i) => i).filter((i) => !(s.only ?? []).length || (s.only ?? []).includes(i));
214
+ const dearest = (f) => among.reduce((m, i) => (f(i) > m ? f(i) : m), 0n);
215
+ spent += count * dearest((i) => next[i]);
216
+ used += count * dearest((i) => cost[i].bytes);
217
+ won += count * dearest((i) => BigInt(entries[i].prizes.length));
218
+ }
219
+ const rolls = oracle || entries.length > 1 || entries.some((e) => e.prizes.some((p) => p.Stash != null));
220
+ return spent + COST.finish + COST.won * won + COST.drawn * draws <= ROLL_BUDGET && (!rolls || used + BYTES.finish + BYTES.won * won + draws <= ROLL_HEAP);
54
221
  }
222
+
223
+ // What one `buy` takes, as the program counts it at the box's write (`catalog::buy_fits`): a transaction holds 64
224
+ // accounts, 64 instructions and 1,400,000 compute units.
225
+ const BUY = { accounts: 15, calls: 7, cu: 30_000, most: { accounts: 64, calls: 64, cu: 1_400_000 } };
226
+ const sameJson = (a, b) => JSON.stringify(a, (_, v) => (typeof v === 'bigint' ? String(v) : v)) === JSON.stringify(b, (_, v) => (typeof v === 'bigint' ? String(v) : v));
227
+
228
+ /**
229
+ * Whether one `buy` of a box that doesn't roll (one entry, given `draws` times: its slots' counts) fits one transaction
230
+ * (`catalog::buy_fits`): its accounts, its instructions and its compute, each prize's at the most it takes. A named NFT
231
+ * is given once at most. A box that doesn't fit sells through the oracle (`open_box`), its answer's heap counted
232
+ * (`drawsFit` with `oracle`), and can't give a roll (`PackTooLarge`). `box`: the box's args.
233
+ */
234
+ export function buyFits(box, draws = (box.slots?.length ? box.slots.reduce((n, s) => n + Number(s.count), 0) : 1)) {
235
+ const entry = box.entries?.[0];
236
+ if (!entry) return true;
237
+ let { accounts, calls, cu } = BUY;
238
+ for (const share of box.shares ?? []) {
239
+ const to = typeof share.to === 'string' ? share.to : Object.keys(share.to)[0];
240
+ const [a, c] = to === 'Burn' ? [0, 1] : to === 'Pool' || to === 'Account' ? [1, 1] : to === 'Holder' ? [3, 6] : [2, 6];
241
+ accounts += a;
242
+ calls += c;
243
+ cu += 30_000;
244
+ }
245
+ const gate = box.gate ? Object.keys(box.gate)[0] : null;
246
+ accounts += gate === 'List' ? Number(box.gate.List.depth) : gate === 'Staked' ? 2 : gate === 'Holds' ? 5 : 0;
247
+ const limit = box.per_wallet ?? {};
248
+ if (Number(limit.total ?? 0) > 0 || Number(limit.per_window ?? 0) > 0) calls += 1;
249
+ // A collectible's collection and Metaplex Core, named once for all of them.
250
+ if (entry.prizes.some((p) => p.Item != null)) accounts += 2;
251
+ for (const [i, p] of entry.prizes.entries()) {
252
+ const first = !entry.prizes.slice(0, i).some((q) => (accountOf(q) && accountOf(q) === accountOf(p)) || sameJson(q, p));
253
+ const gives = p.Tokens ? 1 : draws;
254
+ let once = 0, each = 0, c = 0, units = 0;
255
+ if (p.Tokens) [once, c, units] = [p.Tokens.from.Pool ? 3 : 2, 5, 30_000];
256
+ else if (p.Item != null) [once, each, c, units] = [1, 1, 4, 40_000];
257
+ else if (p.Compressed) [once, c, units] = [9, 6, 150_000];
258
+ else if (p.Roll != null) [once, each, c, units] = [1, 1, 1, 20_000];
259
+ else if (p.Nft) {
260
+ if (draws > 1) return false;
261
+ [once, c, units] = [8, 6, 60_000];
262
+ }
263
+ accounts += (first ? once : 0) + each * gives;
264
+ calls += c * gives;
265
+ cu += units * gives;
266
+ }
267
+ return accounts <= BUY.most.accounts && calls <= BUY.most.calls && cu <= BUY.most.cu;
268
+ }
269
+
270
+ /** The most program rent and fee one order takes from its player, in lamports (0.01 SOL): a client cap (`opensAnOrder`). */
271
+ export const ORDER_COST_CAP = 10_000_000n;
272
+ /** Rent a byte, as devnet and mainnet-beta charge it ((bytes + 128) × 5,080 lamports). */
273
+ const RENT_PER_BYTE = 5_080n;
274
+ /** The player's fee for one order (`fee::PLAYER_FEE`, 0.002 SOL). */
275
+ const PLAYER_FEE = 2_000_000n;
276
+
277
+ /**
278
+ * The most opens of `lootBox` a client puts in one order: what one oracle answer draws (`drawsFit`), and what keeps the
279
+ * order's rent and the player's fee within `ORDER_COST_CAP` (`orderBytes` with `items`, so with the box's shares). At
280
+ * least one: a box whose one open is over the cap is still bought one open an order. A purchase of more is several
281
+ * orders, each its own answer.
282
+ */
283
+ export function opensAnOrder(lootBox, { shares = (lootBox.shares ?? []).length, items = {}, rentPerByte = RENT_PER_BYTE } = {}) {
284
+ const fits = (n) => drawsFit(lootBox.entries, lootBox.slots?.length ? lootBox.slots : 1, n, { odds: (lootBox.odds ?? []).length, shares, fates: (lootBox.fates ?? []).length, bytes: boxBytes(lootBox), oracle: true }) && (BigInt(orderBytes(lootBox, shares, n, items)) + 128n) * rentPerByte + PLAYER_FEE <= ORDER_COST_CAP;
285
+ let n = 1;
286
+ while (n < 4096 && fits(n + 1)) n += 1;
287
+ return n;
288
+ }
289
+
290
+ // Lists of records (tag 26, `list.rs`): a tag byte and a 6-byte header, then fixed-width records.
291
+ export const LIST_HEAD_BYTES = 7;
292
+ /** A limit record (a wallet's count of a box, a recipe or a lottery round; a grant's claim count): key, count, window, in it. */
293
+ export const LIMIT_RECORD_BYTES = 28;
294
+ /** A round a grant paid a wallet: its key alone. */
295
+ export const ROUND_RECORD_BYTES = 16;
296
+ /** A contest's entry: of tokens, and of NFTs (the NFT, its place on its side, the picks taken). */
297
+ export const CONTEST_ENTRY_BYTES = Object.freeze({ tokens: 43, nfts: 83 });