Sim: Use a CSPRNG (#10806)

mia-pi-git · Zarel · web-flow · commit d3e60b31f784 · 2025-01-11T13:56:34.000-06:00
* Sim: Use a CSPRNG

* Add test

* fix test prng

* move prng test to others

* fix slight hack

* tf?

* Fuck this

* fucking lol

* fix crap

* i'm going to kill someone

* i hate state

* fix test

* Good work genius

* typo

* Fix exportinputlog

* Refactor for inputlog backwards compatibility

This is a pretty major refactor which is mostly unrelated to the
feature, but it does make the code a lot simpler.

* Readability pass

* Readability (again)

* Remove sodium-native dependency

* Refactor to serialize seeds in hex strings

(Also removes the Buffer dependency from PRNG, and slightly improves
comments.)

* Apparently &lt;&lt; is 32-bit signed

* Readability

---------

Co-authored-by: Guangcong Luo &lt;guangcongluo@gmail.com&gt;
diff --git a/data/cg-teams.ts b/data/cg-teams.ts
@@ -1028,7 +1028,7 @@ export default class TeamGenerator {
 
 		const totalWeight = weights.reduce((a, b) => a + b, 0);
 
-		let randomWeight = this.prng.next(0, totalWeight);
+		let randomWeight = this.prng.random(0, totalWeight);
 		for (let i = 0; i < choices.length; i++) {
 			randomWeight -= weights[i];
 			if (randomWeight < 0) {
@@ -1043,6 +1043,6 @@ export default class TeamGenerator {
 	}
 
 	setSeed(seed: PRNGSeed) {
-		this.prng.seed = seed;
+		this.prng.setSeed(seed);
 	}
 }
diff --git a/data/mods/gen2/moves.ts b/data/mods/gen2/moves.ts
@@ -590,7 +590,7 @@ export const Moves: import('../../../sim/dex-moves').ModdedMoveDataTable = {
 				this.debug('Pursuit start');
 				let alreadyAdded = false;
 				for (const source of this.effectState.sources) {
-					if (source.speed < pokemon.speed || (source.speed === pokemon.speed && this.random(2) === 0)) {
+					if (source.speed < pokemon.speed || (source.speed === pokemon.speed && this.randomChance(1, 2))) {
 						// Destiny Bond ends if the switch action "outspeeds" the attacker, regardless of host
 						pokemon.removeVolatile('destinybond');
 					}
diff --git a/data/mods/gen5/conditions.ts b/data/mods/gen5/conditions.ts
@@ -32,8 +32,7 @@ export const Conditions: import('../../../sim/dex-conditions').ModdedConditionDa
 			// However, just in case, use 1 if it is undefined.
 			const counter = this.effectState.counter || 1;
 			if (counter >= 256) {
-				// 2^32 - special-cased because Battle.random(n) can't handle n > 2^16 - 1
-				return (this.random() * 4294967296 < 1);
+				return this.randomChance(1, 2 ** 32);
 			}
 			this.debug("Success chance: " + Math.round(100 / counter) + "%");
 			return this.randomChance(1, counter);
diff --git a/data/mods/gen9ssb/moves.ts b/data/mods/gen9ssb/moves.ts
@@ -1248,7 +1248,7 @@ export const Moves: import('../../../sim/dex-moves').ModdedMoveDataTable = {
 				target.clearBoosts();
 				this.add('-clearboost', target);
 				target.addVolatile('protect');
-				const set = Math.floor(Math.random() * 4);
+				const set = this.random(4);
 				const newMoves = [];
 				let role = '';
 				switch (set) {
@@ -2608,7 +2608,7 @@ export const Moves: import('../../../sim/dex-moves').ModdedMoveDataTable = {
 			const spd = target.getStat('spd', false, true);
 			const physical = Math.floor(Math.floor(Math.floor(Math.floor(2 * pokemon.level / 5 + 2) * 90 * atk) / def) / 50);
 			const special = Math.floor(Math.floor(Math.floor(Math.floor(2 * pokemon.level / 5 + 2) * 90 * spa) / spd) / 50);
-			if (physical > special || (physical === special && this.random(2) === 0)) {
+			if (physical > special || (physical === special && this.randomChance(1, 2))) {
 				move.category = 'Physical';
 				move.flags.contact = 1;
 			}
diff --git a/data/moves.ts b/data/moves.ts
@@ -7352,7 +7352,7 @@ export const Moves: import('../sim/dex-moves').MoveDataTable = {
 		isMax: "Snorlax",
 		self: {
 			onHit(source) {
-				if (this.random(2) === 0) return;
+				if (this.randomChance(1, 2)) return;
 				for (const pokemon of source.alliesAndSelf()) {
 					if (pokemon.item) continue;
 
@@ -7448,12 +7448,12 @@ export const Moves: import('../sim/dex-moves').MoveDataTable = {
 		isMax: "Grimmsnarl",
 		onHit(target) {
 			if (target.status || !target.runStatusImmunity('slp')) return;
-			if (this.random(2) === 0) return;
+			if (this.randomChance(1, 2)) return;
 			target.addVolatile('yawn');
 		},
 		onAfterSubDamage(damage, target) {
 			if (target.status || !target.runStatusImmunity('slp')) return;
-			if (this.random(2) === 0) return;
+			if (this.randomChance(1, 2)) return;
 			target.addVolatile('yawn');
 		},
 		secondary: null,
@@ -16812,7 +16812,7 @@ export const Moves: import('../sim/dex-moves').MoveDataTable = {
 			const spd = target.getStat('spd', false, true);
 			const physical = Math.floor(Math.floor(Math.floor(Math.floor(2 * pokemon.level / 5 + 2) * 90 * atk) / def) / 50);
 			const special = Math.floor(Math.floor(Math.floor(Math.floor(2 * pokemon.level / 5 + 2) * 90 * spa) / spd) / 50);
-			if (physical > special || (physical === special && this.random(2) === 0)) {
+			if (physical > special || (physical === special && this.randomChance(1, 2))) {
 				move.category = 'Physical';
 				move.flags.contact = 1;
 			}
diff --git a/data/random-battles/gen1/teams.ts b/data/random-battles/gen1/teams.ts
@@ -107,7 +107,7 @@ export class RandomGen1Teams extends RandomGen2Teams {
 		this.enforceNoDirectCustomBanlistChanges();
 
 		// Get what we need ready.
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
diff --git a/data/random-battles/gen3/teams.ts b/data/random-battles/gen3/teams.ts
@@ -639,7 +639,7 @@ export class RandomGen3Teams extends RandomGen4Teams {
 	randomTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
diff --git a/data/random-battles/gen5/teams.ts b/data/random-battles/gen5/teams.ts
@@ -846,7 +846,7 @@ export class RandomGen5Teams extends RandomGen6Teams {
 	randomTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
diff --git a/data/random-battles/gen7/teams.ts b/data/random-battles/gen7/teams.ts
@@ -1182,7 +1182,7 @@ export class RandomGen7Teams extends RandomGen8Teams {
 	randomTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
diff --git a/data/random-battles/gen8/teams.ts b/data/random-battles/gen8/teams.ts
@@ -270,7 +270,7 @@ export class RandomGen8Teams {
 	}
 
 	random(m?: number, n?: number) {
-		return this.prng.next(m, n);
+		return this.prng.random(m, n);
 	}
 
 	/**
@@ -2479,7 +2479,7 @@ export class RandomGen8Teams {
 	randomTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
@@ -3112,7 +3112,7 @@ export class RandomGen8Teams {
 		for (const speciesName of pokemonPool) {
 			const sortObject = {
 				speciesName: speciesName,
-				score: Math.pow(this.prng.next(), 1 / this.randomBSSFactorySets[speciesName].usage),
+				score: Math.pow(this.prng.random(), 1 / this.randomBSSFactorySets[speciesName].usage),
 			};
 			shuffledSpecies.push(sortObject);
 		}
diff --git a/data/random-battles/gen9/teams.ts b/data/random-battles/gen9/teams.ts
@@ -279,7 +279,7 @@ export class RandomTeams {
 	}
 
 	random(m?: number, n?: number) {
-		return this.prng.next(m, n);
+		return this.prng.random(m, n);
 	}
 
 	/**
@@ -1632,7 +1632,7 @@ export class RandomTeams {
 	randomTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
@@ -2551,7 +2551,7 @@ export class RandomTeams {
 		for (const speciesName of pokemonPool) {
 			const sortObject = {
 				speciesName,
-				score: Math.pow(this.prng.next(), 1 / this.randomFactorySets[this.factoryTier][speciesName].weight),
+				score: Math.pow(this.prng.random(), 1 / this.randomFactorySets[this.factoryTier][speciesName].weight),
 			};
 			shuffledSpecies.push(sortObject);
 		}
@@ -2847,7 +2847,7 @@ export class RandomTeams {
 		for (const speciesName of pokemonPool) {
 			const sortObject = {
 				speciesName,
-				score: Math.pow(this.prng.next(), 1 / this.randomBSSFactorySets[speciesName].weight),
+				score: Math.pow(this.prng.random(), 1 / this.randomBSSFactorySets[speciesName].weight),
 			};
 			shuffledSpecies.push(sortObject);
 		}
diff --git a/data/random-battles/gen9baby/teams.ts b/data/random-battles/gen9baby/teams.ts
@@ -669,7 +669,7 @@ export class RandomBabyTeams extends RandomTeams {
 	randomBabyTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
diff --git a/data/random-battles/gen9cap/teams.ts b/data/random-battles/gen9cap/teams.ts
@@ -185,7 +185,7 @@ export class RandomCAPTeams extends RandomTeams {
 	randomTeam() {
 		this.enforceNoDirectCustomBanlistChanges();
 
-		const seed = this.prng.seed;
+		const seed = this.prng.getSeed();
 		const ruleTable = this.dex.formats.getRuleTable(this.format);
 		const pokemon: RandomTeamsTypes.RandomSet[] = [];
 
diff --git a/data/rulesets.ts b/data/rulesets.ts
@@ -2543,7 +2543,7 @@ export const Rulesets: import('../sim/dex-formats').FormatDataTable = {
 				const spd = target.getStat('spd', false, true);
 				const physical = Math.floor(Math.floor(Math.floor(Math.floor(2 * pokemon.level / 5 + 2) * 90 * atk) / def) / 50);
 				const special = Math.floor(Math.floor(Math.floor(Math.floor(2 * pokemon.level / 5 + 2) * 90 * spa) / spd) / 50);
-				if (physical > special || (physical === special && this.random(2) === 0)) {
+				if (physical > special || (physical === special && this.randomChance(1, 2))) {
 					move.category = 'Physical';
 					move.flags.contact = 1;
 				}
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -413,6 +413,21 @@ export function formatSQLArray(arr: unknown[], args?: unknown[]) {
 	return [...'?'.repeat(arr.length)].join(', ');
 }
 
+export function bufFromHex(hex: string) {
+	const buf = new Uint8Array(Math.ceil(hex.length / 2));
+	bufWriteHex(buf, hex);
+	return buf;
+}
+export function bufWriteHex(buf: Uint8Array, hex: string, offset = 0) {
+	const size = Math.ceil(hex.length / 2);
+	for (let i = 0; i < size; i++) {
+		buf[offset + i] = parseInt(hex.slice(i * 2, i * 2 + 2).padEnd(2, '0'), 16);
+	}
+}
+export function bufReadHex(buf: Uint8Array, start = 0, end?: number) {
+	return [...buf.slice(start, end)].map(val => val.toString(16).padStart(2, '0')).join('');
+}
+
 export class Multiset<T> extends Map<T, number> {
 	get(key: T) {
 		return super.get(key) ?? 0;
@@ -436,5 +451,7 @@ export const Utils = {
 	shuffle, deepClone, clearRequireCache,
 	randomElement, forceWrap, splitFirst,
 	stripHTML, visualize, getString,
-	escapeRegex, formatSQLArray, Multiset,
+	escapeRegex, formatSQLArray,
+	bufFromHex, bufReadHex, bufWriteHex,
+	Multiset,
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,7 +10,8 @@
     "preact-render-to-string": "^5.1.19",
     "probe-image-size": "^7.2.3",
     "sockjs": "^0.3.21",
-    "source-map-support": "^0.5.21"
+    "source-map-support": "^0.5.21",
+    "ts-chacha20": "^1.2.0"
   },
   "optionalDependencies": {
     "better-sqlite3": "^7.6.2",
@@ -72,6 +73,7 @@
     "@types/nodemailer": "^6.4.4",
     "@types/pg": "^8.6.5",
     "@types/sockjs": "^0.3.33",
+    "@types/sodium-native": "^2.3.9",
     "@typescript-eslint/eslint-plugin": "^5.8.0",
     "@typescript-eslint/parser": "^5.8.0",
     "eslint": "8.5.0",
diff --git a/sim/battle-stream.ts b/sim/battle-stream.ts
@@ -136,10 +136,12 @@ export class BattleStream extends Streams.ObjectReadWriteStream<string> {
 			this.battle!.inputLog.push(`>forcelose ${message}`);
 			break;
 		case 'reseed':
-			const seed = message ? message.split(',').map(Number) as PRNGSeed : null;
+			const seed = message ? message.split(',').map(
+				n => /[0-9]/.test(n.charAt(0)) ? Number(n) : n
+			) as PRNGSeed : null;
 			this.battle!.resetRNG(seed);
 			// could go inside resetRNG, but this makes using it in `eval` slightly less buggy
-			this.battle!.inputLog.push(`>reseed ${this.battle!.prng.seed.join(',')}`);
+			this.battle!.inputLog.push(`>reseed ${this.battle!.prng.getSeed().join(',')}`);
 			break;
 		case 'tiebreak':
 			this.battle!.tiebreak();
diff --git a/sim/battle.ts b/sim/battle.ts
@@ -222,7 +222,7 @@ export class Battle {
 			(format.playerCount > 2 || this.gameType === 'doubles') ? 2 :
 			1;
 		this.prng = options.prng || new PRNG(options.seed || undefined);
-		this.prngSeed = this.prng.startingSeed.slice() as PRNGSeed;
+		this.prngSeed = this.prng.startingSeed;
 		this.rated = options.rated || !!options.rated;
 		this.reportExactHP = !!format.debug;
 		this.reportPercentages = false;
@@ -273,7 +273,7 @@ export class Battle {
 		this.send = options.send || (() => {});
 
 		const inputOptions: {formatid: ID, seed: PRNGSeed, rated?: string | true} = {
-			formatid: options.formatid, seed: this.prng.seed,
+			formatid: options.formatid, seed: this.prngSeed,
 		};
 		if (this.rated) inputOptions.rated = this.rated;
 		if (typeof __version !== 'undefined') {
@@ -340,7 +340,7 @@ export class Battle {
 	}
 
 	random(m?: number, n?: number) {
-		return this.prng.next(m, n);
+		return this.prng.random(m, n);
 	}
 
 	randomChance(numerator: number, denominator: number) {
@@ -353,7 +353,7 @@ export class Battle {
 	}
 
 	/** Note that passing `undefined` resets to the starting seed, but `null` will roll a new seed */
-	resetRNG(seed: PRNGSeed | null = this.prng.startingSeed) {
+	resetRNG(seed: PRNGSeed | null = this.prngSeed) {
 		this.prng = new PRNG(seed);
 		this.add('message', "The battle's RNG was reset.");
 	}
diff --git a/sim/pokemon.ts b/sim/pokemon.ts
@@ -317,7 +317,7 @@ export class Pokemon {
 		set.level = this.battle.clampIntRange(set.adjustLevel || set.level || 100, 1, 9999);
 		this.level = set.level;
 		const genders: {[key: string]: GenderName} = {M: 'M', F: 'F', N: 'N'};
-		this.gender = genders[set.gender] || this.species.gender || (this.battle.random() * 2 < 1 ? 'M' : 'F');
+		this.gender = genders[set.gender] || this.species.gender || (this.battle.random(2) ? 'F' : 'M');
 		if (this.gender === 'N') this.gender = '';
 		this.happiness = typeof set.happiness === 'number' ? this.battle.clampIntRange(set.happiness, 0, 255) : 255;
 		this.pokeball = this.set.pokeball || 'pokeball';
diff --git a/sim/prng.ts b/sim/prng.ts
diff --git a/sim/state.ts b/sim/state.ts
diff --git a/sim/tools/exhaustive-runner.ts b/sim/tools/exhaustive-runner.ts
diff --git a/sim/tools/multi-random-runner.ts b/sim/tools/multi-random-runner.ts
diff --git a/sim/tools/random-player-ai.ts b/sim/tools/random-player-ai.ts
diff --git a/sim/tools/runner.ts b/sim/tools/runner.ts
diff --git a/test/sim/misc/prng.js b/test/sim/misc/prng.js

Original file line number	Diff line number	Diff line change
`@@ -1028,7 +1028,7 @@ export default class TeamGenerator {`
`1028`	`1028`
`1029`	`1029`	`const totalWeight = weights.reduce((a, b) => a + b, 0);`
`1030`	`1030`
`1031`		`- let randomWeight = this.prng.next(0, totalWeight);`
	`1031`	`+ let randomWeight = this.prng.random(0, totalWeight);`
`1032`	`1032`	`for (let i = 0; i < choices.length; i++) {`
`1033`	`1033`	`randomWeight -= weights[i];`
`1034`	`1034`	`if (randomWeight < 0) {`
`@@ -1043,6 +1043,6 @@ export default class TeamGenerator {`
`1043`	`1043`	`}`
`1044`	`1044`
`1045`	`1045`	`setSeed(seed: PRNGSeed) {`
`1046`		`- this.prng.seed = seed;`
	`1046`	`+ this.prng.setSeed(seed);`
`1047`	`1047`	`}`
`1048`	`1048`	`}`
Original file line number	Diff line number	Diff line change
`@@ -590,7 +590,7 @@ export const Moves: import('../../../sim/dex-moves').ModdedMoveDataTable = {`
`590`	`590`	`this.debug('Pursuit start');`
`591`	`591`	`let alreadyAdded = false;`
`592`	`592`	`for (const source of this.effectState.sources) {`
`593`		`- if (source.speed < pokemon.speed \|\| (source.speed === pokemon.speed && this.random(2) === 0)) {`
	`593`	`+ if (source.speed < pokemon.speed \|\| (source.speed === pokemon.speed && this.randomChance(1, 2))) {`
`594`	`594`	`// Destiny Bond ends if the switch action "outspeeds" the attacker, regardless of host`
`595`	`595`	`pokemon.removeVolatile('destinybond');`
`596`	`596`	`}`