@aephia/atlas-kit 0.6.0-next.3 → 0.6.0-next.30

package/dist/planning/index.js

@@ -159,9 +159,278 @@ function normalizeSemanticFact(value, field) {
     }
     return invalid(`${field}.kind`, semantic.kind, 'one of exclusive, requires, invalidates, or transition');
 }
-function normalizePrecondition(value, field, version = 3) {
+function normalizePrecondition(value, field, version = 12) {
     const precondition = readRecord(value, field);
-    if (precondition.kind === 'token-account-or-absent' && version === 3) {
+    if (version >= 12 &&
+        (precondition.kind === 'faction-treasury-buy' ||
+            precondition.kind === 'faction-treasury-sell' ||
+            precondition.kind === 'faction-epoch-meter')) {
+        const { kind } = precondition;
+        assertKeys(precondition, field, [
+            'kind',
+            'address',
+            'game',
+            'factionId',
+            'describes',
+            ...(kind === 'faction-treasury-buy'
+                ? ['cargoId', 'floorRaw']
+                : kind === 'faction-treasury-sell'
+                    ? ['atlasOutCapPerEpochRaw', 'epochLengthSeconds']
+                    : []),
+        ]);
+        const u16 = (key) => {
+            const n = precondition[key];
+            if (typeof n !== 'number' || !Number.isInteger(n) || n < 0 || n > 65535)
+                invalid(`${field}.${key}`, n, 'an unsigned u16 integer');
+            return n;
+        };
+        const integer = (key, signed = false) => {
+            const n = precondition[key];
+            const min = signed ? -(1n << 63n) : 0n;
+            const max = signed ? (1n << 63n) - 1n : (1n << 64n) - 1n;
+            if (typeof n !== 'bigint' || n < min || n > max)
+                invalid(`${field}.${key}`, n, signed ? 'an i64 bigint' : 'a u64 bigint');
+            return n;
+        };
+        const common = {
+            address: readAddress(precondition.address, `${field}.address`),
+            game: readAddress(precondition.game, `${field}.game`),
+            factionId: u16('factionId'),
+            describes: readString(precondition.describes, `${field}.describes`),
+        };
+        if (kind === 'faction-treasury-buy')
+            return Object.freeze({
+                kind,
+                ...common,
+                cargoId: u16('cargoId'),
+                floorRaw: integer('floorRaw'),
+            });
+        if (kind === 'faction-treasury-sell')
+            return Object.freeze({
+                kind,
+                ...common,
+                atlasOutCapPerEpochRaw: integer('atlasOutCapPerEpochRaw'),
+                epochLengthSeconds: integer('epochLengthSeconds', true),
+            });
+        return Object.freeze({ kind, ...common });
+    }
+    if (version >= 11 && precondition.kind === 'fleet-add-ship') {
+        assertKeys(precondition, field, [
+            'kind',
+            'address',
+            'game',
+            'profile',
+            'authority',
+            'system',
+            'shipId',
+            'amount',
+            'keyIndex',
+            'configHash',
+            'maximumProfileDebit',
+            'describes',
+        ]);
+        const keyIndex = precondition.keyIndex;
+        if (typeof keyIndex !== 'number' ||
+            !Number.isInteger(keyIndex) ||
+            keyIndex < 0 ||
+            keyIndex > 65535)
+            invalid(`${field}.keyIndex`, keyIndex, 'an integer from 0 through 65535');
+        const shipId = precondition.shipId;
+        if (typeof shipId !== 'number' ||
+            !Number.isInteger(shipId) ||
+            shipId < 0 ||
+            shipId > 65535)
+            invalid(`${field}.shipId`, shipId, 'a u16 ship configuration ID');
+        const amount = precondition.amount;
+        if (typeof amount !== 'bigint' || amount < 1n || amount > 255n)
+            invalid(`${field}.amount`, amount, 'a whole ship quantity from 1n through 255n');
+        const maximumProfileDebit = precondition.maximumProfileDebit;
+        if (typeof maximumProfileDebit !== 'bigint' || maximumProfileDebit < 0n)
+            invalid(`${field}.maximumProfileDebit`, maximumProfileDebit, 'a nonnegative bigint');
+        return Object.freeze({
+            kind: 'fleet-add-ship',
+            address: readAddress(precondition.address, `${field}.address`),
+            game: readAddress(precondition.game, `${field}.game`),
+            profile: readAddress(precondition.profile, `${field}.profile`),
+            authority: readAddress(precondition.authority, `${field}.authority`),
+            system: readAddress(precondition.system, `${field}.system`),
+            keyIndex,
+            shipId,
+            amount,
+            maximumProfileDebit,
+            configHash: readDataHash(precondition.configHash, `${field}.configHash`),
+            describes: readString(precondition.describes, `${field}.describes`),
+        });
+    }
+    if (version >= 10 && precondition.kind === 'fleet-create') {
+        assertKeys(precondition, field, [
+            'kind',
+            'address',
+            'game',
+            'profile',
+            'authority',
+            'system',
+            'keyIndex',
+            'label',
+            'maximumProfileDebit',
+            'describes',
+        ]);
+        const keyIndex = precondition.keyIndex;
+        if (typeof keyIndex !== 'number' ||
+            !Number.isSafeInteger(keyIndex) ||
+            keyIndex < 0 ||
+            keyIndex > 65_535)
+            invalid(`${field}.keyIndex`, keyIndex, 'an integer from 0 through 65535');
+        const label = readString(precondition.label, `${field}.label`);
+        const bytes = new TextEncoder().encode(label);
+        if (label.trim().length === 0 ||
+            label.includes('\0') ||
+            bytes.length > 64 ||
+            new TextDecoder('utf-8', { ignoreBOM: true }).decode(bytes) !== label)
+            invalid(`${field}.label`, label, 'a nonblank, NUL-free Unicode label of at most 64 UTF-8 bytes');
+        const maximumProfileDebit = precondition.maximumProfileDebit;
+        if (typeof maximumProfileDebit !== 'bigint' || maximumProfileDebit < 0n)
+            invalid(`${field}.maximumProfileDebit`, maximumProfileDebit, 'a nonnegative bigint');
+        return Object.freeze({
+            kind: 'fleet-create',
+            address: readAddress(precondition.address, `${field}.address`),
+            game: readAddress(precondition.game, `${field}.game`),
+            profile: readAddress(precondition.profile, `${field}.profile`),
+            authority: readAddress(precondition.authority, `${field}.authority`),
+            system: readAddress(precondition.system, `${field}.system`),
+            keyIndex,
+            label,
+            maximumProfileDebit,
+            describes: readString(precondition.describes, `${field}.describes`),
+        });
+    }
+    if (version >= 8 && precondition.kind === 'system-account-or-absent') {
+        assertKeys(precondition, field, ['kind', 'address', 'describes']);
+        return Object.freeze({
+            kind: 'system-account-or-absent',
+            address: readAddress(precondition.address, `${field}.address`),
+            describes: readString(precondition.describes, `${field}.describes`),
+        });
+    }
+    if (version >= 7 && precondition.kind === 'token-mint') {
+        assertKeys(precondition, field, [
+            'kind',
+            'address',
+            'decimals',
+            'describes',
+        ]);
+        const decimals = precondition.decimals;
+        if (typeof decimals !== 'number' ||
+            !Number.isInteger(decimals) ||
+            decimals < 0 ||
+            decimals > 255)
+            invalid(`${field}.decimals`, decimals, 'an unsigned u8 mint decimals value');
+        return Object.freeze({
+            kind: 'token-mint',
+            address: readAddress(precondition.address, `${field}.address`),
+            decimals,
+            describes: readString(precondition.describes, `${field}.describes`),
+        });
+    }
+    if (version >= 6 && precondition.kind === 'game-ship-config') {
+        assertKeys(precondition, field, [
+            'kind',
+            'address',
+            'shipId',
+            'configHash',
+            'describes',
+        ]);
+        const id = precondition.shipId;
+        if (typeof id !== 'number' || !Number.isInteger(id) || id < 0 || id > 65535)
+            invalid(`${field}.shipId`, id, 'a u16 ship configuration ID');
+        return Object.freeze({
+            kind: 'game-ship-config',
+            address: readAddress(precondition.address, `${field}.address`),
+            shipId: id,
+            configHash: readDataHash(precondition.configHash, `${field}.configHash`),
+            describes: readString(precondition.describes, `${field}.describes`),
+        });
+    }
+    if (version >= 5 && precondition.kind === 'game-account') {
+        assertKeys(precondition, field, ['kind', 'address', 'describes']);
+        return Object.freeze({
+            kind: 'game-account',
+            address: readAddress(precondition.address, `${field}.address`),
+            describes: readString(precondition.describes, `${field}.describes`),
+        });
+    }
+    if ((version >= 9 && precondition.kind === 'game-cargo-bytes-config') ||
+        (version >= 4 &&
+            ['token-account', 'game-cargo-config', 'cargo-cache'].includes(String(precondition.kind)))) {
+        const base = {
+            address: readAddress(precondition.address, `${field}.address`),
+            describes: readString(precondition.describes, `${field}.describes`),
+        };
+        if (precondition.kind === 'token-account') {
+            assertKeys(precondition, field, [
+                'kind',
+                'address',
+                'mint',
+                'owner',
+                'minimumBalance',
+                'describes',
+            ]);
+            const amount = precondition.minimumBalance;
+            if (typeof amount !== 'bigint' ||
+                amount < 0n ||
+                amount > (1n << 64n) - 1n)
+                invalid(`${field}.minimumBalance`, amount, 'an unsigned u64 bigint');
+            return Object.freeze({
+                ...base,
+                kind: 'token-account',
+                mint: readAddress(precondition.mint, `${field}.mint`),
+                owner: readAddress(precondition.owner, `${field}.owner`),
+                minimumBalance: amount,
+            });
+        }
+        if (precondition.kind === 'game-cargo-config' ||
+            precondition.kind === 'game-cargo-bytes-config') {
+            assertKeys(precondition, field, [
+                'kind',
+                'address',
+                'cargoId',
+                'configHash',
+                'describes',
+            ]);
+            const id = precondition.cargoId;
+            if (typeof id !== 'number' ||
+                !Number.isInteger(id) ||
+                id < 0 ||
+                id > 65535)
+                invalid(`${field}.cargoId`, id, 'a u16 cargo ID');
+            return Object.freeze({
+                ...base,
+                kind: precondition.kind,
+                cargoId: id,
+                configHash: readDataHash(precondition.configHash, `${field}.configHash`),
+            });
+        }
+        assertKeys(precondition, field, [
+            'kind',
+            'address',
+            'game',
+            'bump',
+            'describes',
+        ]);
+        const bump = precondition.bump;
+        if (typeof bump !== 'number' ||
+            !Number.isInteger(bump) ||
+            bump < 0 ||
+            bump > 255)
+            invalid(`${field}.bump`, bump, 'a u8 PDA bump');
+        return Object.freeze({
+            ...base,
+            kind: 'cargo-cache',
+            game: readAddress(precondition.game, `${field}.game`),
+            bump,
+        });
+    }
+    if (precondition.kind === 'token-account-or-absent' && version >= 3) {
         assertKeys(precondition, field, [
             'kind',
             'address',
@@ -186,11 +455,29 @@ function normalizePrecondition(value, field, version = 3) {
         });
     }
     if (precondition.kind !== 'account-state') {
-        invalid(`${field}.kind`, precondition.kind, version === 3
-            ? 'one of account-state, account-absent, or token-account-or-absent'
-            : version === 2
-                ? 'one of account-state or account-absent'
-                : 'the value account-state');
+        invalid(`${field}.kind`, precondition.kind, version === 12
+            ? 'one of faction-treasury-buy, faction-treasury-sell, faction-epoch-meter, or a supported V1–V11 precondition'
+            : version === 11
+                ? 'one of fleet-add-ship, fleet-create, account-state, account-absent, system-account-or-absent, token-account-or-absent, token-account, token-mint, game-cargo-config, game-cargo-bytes-config, cargo-cache, game-account, or game-ship-config'
+                : version === 10
+                    ? 'one of fleet-create, account-state, account-absent, system-account-or-absent, token-account-or-absent, token-account, token-mint, game-cargo-config, game-cargo-bytes-config, cargo-cache, game-account, or game-ship-config'
+                    : version === 9
+                        ? 'one of account-state, account-absent, system-account-or-absent, token-account-or-absent, token-account, token-mint, game-cargo-config, game-cargo-bytes-config, cargo-cache, game-account, or game-ship-config'
+                        : version === 8
+                            ? 'one of account-state, account-absent, system-account-or-absent, token-account-or-absent, token-account, token-mint, game-cargo-config, cargo-cache, game-account, or game-ship-config'
+                            : version === 7
+                                ? 'one of account-state, account-absent, token-account-or-absent, token-account, token-mint, game-cargo-config, cargo-cache, game-account, or game-ship-config'
+                                : version === 6
+                                    ? 'one of account-state, account-absent, token-account-or-absent, token-account, game-cargo-config, cargo-cache, game-account, or game-ship-config'
+                                    : version === 5
+                                        ? 'one of account-state, account-absent, token-account-or-absent, token-account, game-cargo-config, cargo-cache, or game-account'
+                                        : version === 4
+                                            ? 'one of account-state, account-absent, token-account-or-absent, token-account, game-cargo-config, or cargo-cache'
+                                            : version === 3
+                                                ? 'one of account-state, account-absent, or token-account-or-absent'
+                                                : version === 2
+                                                    ? 'one of account-state or account-absent'
+                                                    : 'the value account-state');
     }
     assertKeys(precondition, field, ['kind', 'address', 'dataHash', 'describes']);
     return Object.freeze({
@@ -242,12 +529,142 @@ function planToJSON(plan) {
             : {}),
         signers: [...step.signers],
     }));
+    if (plan.preconditions.some(({ kind }) => kind === 'faction-treasury-buy' ||
+        kind === 'faction-treasury-sell' ||
+        kind === 'faction-epoch-meter')) {
+        return deepFreeze({
+            v: 12,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => {
+                if (guard.kind === 'faction-treasury-buy')
+                    return { ...guard, floorRaw: String(guard.floorRaw) };
+                if (guard.kind === 'faction-treasury-sell')
+                    return {
+                        ...guard,
+                        atlasOutCapPerEpochRaw: String(guard.atlasOutCapPerEpochRaw),
+                        epochLengthSeconds: String(guard.epochLengthSeconds),
+                    };
+                if (guard.kind === 'fleet-add-ship')
+                    return {
+                        ...guard,
+                        amount: String(guard.amount),
+                        maximumProfileDebit: String(guard.maximumProfileDebit),
+                    };
+                if (guard.kind === 'fleet-create')
+                    return {
+                        ...guard,
+                        maximumProfileDebit: String(guard.maximumProfileDebit),
+                    };
+                if (guard.kind === 'token-account')
+                    return { ...guard, minimumBalance: String(guard.minimumBalance) };
+                return { ...guard };
+            }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'fleet-add-ship')) {
+        return deepFreeze({
+            v: 11,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'fleet-add-ship'
+                ? {
+                    ...guard,
+                    amount: String(guard.amount),
+                    maximumProfileDebit: String(guard.maximumProfileDebit),
+                }
+                : guard.kind === 'fleet-create'
+                    ? {
+                        ...guard,
+                        maximumProfileDebit: String(guard.maximumProfileDebit),
+                    }
+                    : guard.kind === 'token-account'
+                        ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                        : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'fleet-create')) {
+        return deepFreeze({
+            v: 10,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'fleet-create'
+                ? { ...guard, maximumProfileDebit: String(guard.maximumProfileDebit) }
+                : guard.kind === 'token-account'
+                    ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                    : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'game-cargo-bytes-config')) {
+        return deepFreeze({
+            v: 9,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'token-account'
+                ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'system-account-or-absent')) {
+        return deepFreeze({
+            v: 8,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'token-account'
+                ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'token-mint')) {
+        return deepFreeze({
+            v: 7,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'token-account'
+                ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'game-ship-config')) {
+        return deepFreeze({
+            v: 6,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'token-account'
+                ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'game-account')) {
+        return deepFreeze({
+            v: 5,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'token-account'
+                ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                : { ...guard }),
+        });
+    }
+    if (plan.preconditions.some(({ kind }) => kind === 'token-account' ||
+        kind === 'game-cargo-config' ||
+        kind === 'cargo-cache')) {
+        return deepFreeze({
+            v: 4,
+            ...common,
+            steps,
+            preconditions: plan.preconditions.map((guard) => guard.kind === 'token-account'
+                ? { ...guard, minimumBalance: String(guard.minimumBalance) }
+                : { ...guard }),
+        });
+    }
     if (plan.preconditions.some(({ kind }) => kind === 'token-account-or-absent')) {
         return deepFreeze({
             v: 3,
             ...common,
             steps,
-            preconditions: plan.preconditions.map((guard) => ({ ...guard })),
+            preconditions: plan.preconditions.map((guard) => ({
+                ...guard,
+            })),
         });
     }
     if (hasSemantics || hasAbsentPrecondition) {
@@ -337,13 +754,13 @@ function sameAddresses(actual, encoded) {
  *
  * @example
  * ```ts
- * declare const wire: PlanJsonV1 | PlanJsonV2 | PlanJsonV3;
+ * declare const wire: PlanJsonV1 | PlanJsonV2 | PlanJsonV3 | PlanJsonV4 | PlanJsonV5 | PlanJsonV6 | PlanJsonV7 | PlanJsonV8 | PlanJsonV9 | PlanJsonV10 | PlanJsonV11 | PlanJsonV12;
  * const plan = planFromJSON(wire);
  * console.log(plan.describe());
  * ```
  */
 export function planFromJSON(json) {
-    const value = readRecord(json, 'planJson');
+    const value = { ...readRecord(json, 'planJson') };
     assertKeys(value, 'planJson', [
         'v',
         'kind',
@@ -353,10 +770,70 @@ export function planFromJSON(json) {
         'affected',
         'requiredSigners',
     ]);
-    if (value.v !== 1 && value.v !== 2 && value.v !== 3) {
-        invalid('planJson.v', value.v, 'the Plan wire version 1, 2, or 3');
+    if (value.v !== 1 &&
+        value.v !== 2 &&
+        value.v !== 3 &&
+        value.v !== 4 &&
+        value.v !== 5 &&
+        value.v !== 6 &&
+        value.v !== 7 &&
+        value.v !== 8 &&
+        value.v !== 9 &&
+        value.v !== 10 &&
+        value.v !== 11 &&
+        value.v !== 12) {
+        invalid('planJson.v', value.v, 'the Plan wire version 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, or 12');
     }
     const version = value.v;
+    if (version >= 4 && Array.isArray(value.preconditions)) {
+        value.preconditions = value.preconditions.map((entry) => {
+            const guard = readRecord(entry, 'precondition');
+            if (version >= 12 &&
+                (guard.kind === 'faction-treasury-buy' ||
+                    guard.kind === 'faction-treasury-sell')) {
+                const keys = guard.kind === 'faction-treasury-buy'
+                    ? ['floorRaw']
+                    : ['atlasOutCapPerEpochRaw', 'epochLengthSeconds'];
+                const decoded = { ...guard };
+                for (const key of keys) {
+                    const raw = guard[key];
+                    const pattern = key === 'epochLengthSeconds'
+                        ? /^(0|[1-9][0-9]*|-[1-9][0-9]*)$/
+                        : /^(0|[1-9][0-9]*)$/;
+                    if (typeof raw !== 'string' || !pattern.test(raw))
+                        invalid(key, raw, 'a canonical decimal string');
+                    decoded[key] = BigInt(raw);
+                }
+                return decoded;
+            }
+            if (version >= 11 && guard.kind === 'fleet-add-ship') {
+                for (const field of ['amount', 'maximumProfileDebit'])
+                    if (typeof guard[field] !== 'string' ||
+                        !/^(0|[1-9][0-9]*)$/.test(guard[field]))
+                        invalid(field, guard[field], 'a canonical unsigned decimal string');
+                return {
+                    ...guard,
+                    amount: BigInt(guard.amount),
+                    maximumProfileDebit: BigInt(guard.maximumProfileDebit),
+                };
+            }
+            if (version >= 10 && guard.kind === 'fleet-create') {
+                if (typeof guard.maximumProfileDebit !== 'string' ||
+                    !/^(0|[1-9][0-9]*)$/.test(guard.maximumProfileDebit))
+                    invalid('maximumProfileDebit', guard.maximumProfileDebit, 'a canonical unsigned decimal string');
+                return {
+                    ...guard,
+                    maximumProfileDebit: BigInt(guard.maximumProfileDebit),
+                };
+            }
+            if (guard.kind !== 'token-account')
+                return guard;
+            if (typeof guard.minimumBalance !== 'string' ||
+                !/^(0|[1-9][0-9]*)$/.test(guard.minimumBalance))
+                invalid('minimumBalance', guard.minimumBalance, 'a canonical unsigned decimal string');
+            return { ...guard, minimumBalance: BigInt(guard.minimumBalance) };
+        });
+    }
     const steps = readArray(value.steps, 'planJson.steps').map((candidate, index) => {
         const field = `planJson.steps[${String(index)}]`;
         const step = readRecord(candidate, field);