Skip to content

fix: readd deserialization-time validation for iota holders #1167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IridescentVoid wants to merge 3 commits into
base: 1.21
Choose a base branch
from
Open

fix: readd deserialization-time validation for iota holders #1167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c659a47
fix: readd deserialization-time validation for iota holders
IridescentVoid Jun 14, 2026
4b1b0c3
feat: validate iotas on stack between each frame
IridescentVoid Jun 15, 2026
d487dc2
fix: building on forge
IridescentVoid Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Common/src/main/java/at/petrak/hexcasting/api/addldata/ADIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
package at.petrak.hexcasting.api.addldata;

import at.petrak.hexcasting.api.casting.iota.Iota;
import net.minecraft.server.level.ServerLevel;
import org.jetbrains.annotations.Nullable;

public interface ADIotaHolder {

@Nullable
Iota readIota();
Iota readIota(ServerLevel world);

@Nullable
default Iota emptyIota() {
Expand Down
5 changes: 3 additions & 2 deletions Common/src/main/java/at/petrak/hexcasting/api/addldata/ItemDelegatingEntityIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import at.petrak.hexcasting.api.casting.iota.Iota;
import at.petrak.hexcasting.common.entities.EntityWallScroll;
import at.petrak.hexcasting.xplat.IXplatAbstractions;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.entity.decoration.ItemFrame;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.item.ItemStack;
Expand Down Expand Up @@ -39,9 +40,9 @@ public boolean writeIota(@Nullable Iota datum, boolean simulate) {
}

@Override
public @Nullable Iota readIota() {
public @Nullable Iota readIota(ServerLevel world) {
var delegate = IXplatAbstractions.INSTANCE.findDataHolder(this.stackSupplier.get());
return delegate == null ? null : delegate.readIota();
return delegate == null ? null : delegate.readIota(world);
}

@Override
Expand Down
6 changes: 5 additions & 1 deletion Common/src/main/java/at/petrak/hexcasting/api/casting/eval/vm/CastingVM.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@ class CastingVM(var image: CastingImage, val env: CastingEnvironment) {
sound = HexEvalSounds.MISHAP,
)
} else {
result
result.copy(
newData = result.newData?.copy(
stack = validateIotaList(result.newData.stack, world)

@IridescentVoid IridescentVoid Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also validate the ravenmind, since that is user-visible. Data internal to frames (such as the foreach accumulator) should be fine to leave as-is as it'd need to surface on the stack at some point for a hex to take advantage of it.

It may also be worth implementing caching for validation (since iotas are immutable) to reduce the performance impact of the eager checking.

@Olfi01 Olfi01 Jul 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you maybe describe a bit more how you imagine the caching? From my understanding an entity could become unavailable at any time (logout, despawn, unload, death), and I don't really see a good way to invalidate a cache when that happens.

@IridescentVoid IridescentVoid Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, 3 am iris wasn't thinking straight. We can't cache things that hold volatile iotas. However, most iota types don't decay and always pass validation, so a list holding a large amount of vectors/numbers could still have validation skipped on subsequent passes which could help with performance still.

If the changes in this PR do not impact performance significantly, I think it would be fine to push caching to a later pull request (especially since this technically adds mutable internal state to Iotas, which I think is safe but would need to verify).

)
)
}
}

Expand Down
4 changes: 4 additions & 0 deletions Common/src/main/java/at/petrak/hexcasting/api/utils/HexUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,10 @@ fun <T : Iota> validateIota(iota: T, serverLevel: ServerLevel): Iota {
}
}

fun <T: Iota> validateIotaNullable(iota: T?, serverLevel: ServerLevel): Iota? {
return iota?.let { validateIota(iota, serverLevel) }
}

fun <T : Iota> validateIotaList(iotaList: List<T>, serverLevel: ServerLevel): List<Iota> {
return iotaList.map { validateIota(it, serverLevel) }
}
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/at/petrak/hexcasting/common/blocks/circles/impetuses/BlockRedstoneImpetus.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ protected ItemInteractionResult useItemOn(ItemStack stack, BlockState state, Lev
} else {
var datumContainer = IXplatAbstractions.INSTANCE.findDataHolder(usedStack);
if (datumContainer != null) {
var stored = datumContainer.readIota();
var stored = datumContainer.readIota(sLevel);
if (stored instanceof EntityIota eieio) {
var entity = eieio.getEntity(sLevel);
if (entity instanceof Player iotaPlayer) {
Expand Down
4 changes: 2 additions & 2 deletions Common/src/main/java/at/petrak/hexcasting/common/casting/actions/rw/OpRead.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ object OpRead : ConstMediaAction {
override fun execute(args: List<Iota>, env: CastingEnvironment): List<Iota> {
val (handStack) = env.getHeldItemToOperateOn {
val dataHolder = IXplatAbstractions.INSTANCE.findDataHolder(it)
dataHolder != null && (dataHolder.readIota() != null || dataHolder.emptyIota() != null)
dataHolder != null && (dataHolder.readIota(env.world) != null || dataHolder.emptyIota() != null)
}
// If there are no data holders that are readable, find a data holder that isn't readable
// so that the error message is more helpful.
Expand All @@ -24,7 +24,7 @@ object OpRead : ConstMediaAction {
val datumHolder = IXplatAbstractions.INSTANCE.findDataHolder(handStack)
?: throw MishapBadOffhandItem.of(handStack, "iota.read")

val datum = datumHolder.readIota()
val datum = datumHolder.readIota(env.world)
?: datumHolder.emptyIota()
?: throw MishapBadOffhandItem.of(handStack, "iota.read")

Expand Down
2 changes: 1 addition & 1 deletion Common/src/main/java/at/petrak/hexcasting/common/casting/actions/rw/OpReadable.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ object OpReadable : ConstMediaAction {
?: return false.asActionResult

// If the datum contains no iota, return whether it has a default empty iota.
datumHolder.readIota()
datumHolder.readIota(env.world)
?: return (datumHolder.emptyIota() != null).asActionResult

return true.asActionResult
Expand Down
2 changes: 1 addition & 1 deletion Common/src/main/java/at/petrak/hexcasting/common/casting/actions/rw/OpTheCoolerRead.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ object OpTheCoolerRead : ConstMediaAction {
val datumHolder = IXplatAbstractions.INSTANCE.findDataHolder(target)
?: throw MishapBadEntity.of(target, "iota.read")

val datum = datumHolder.readIota()
val datum = datumHolder.readIota(env.world)
?: datumHolder.emptyIota()
?: throw MishapBadEntity.of(target, "iota.read")
return listOf(datum)
Expand Down
2 changes: 1 addition & 1 deletion Common/src/main/java/at/petrak/hexcasting/common/casting/actions/rw/OpTheCoolerReadable.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ object OpTheCoolerReadable : ConstMediaAction {
val datumHolder = IXplatAbstractions.INSTANCE.findDataHolder(target)
?: return false.asActionResult

datumHolder.readIota()
datumHolder.readIota(env.world)
?: datumHolder.emptyIota()
?: return false.asActionResult

Expand Down
5 changes: 3 additions & 2 deletions Fabric/src/main/java/at/petrak/hexcasting/fabric/cc/adimpl/CCEntityIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import at.petrak.hexcasting.api.casting.iota.Iota;
import net.minecraft.core.HolderLookup;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.server.level.ServerLevel;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

Expand All @@ -27,8 +28,8 @@ public Wrapper(ItemDelegatingEntityIotaHolder inner) {


@Override
public @Nullable Iota readIota() {
return inner.readIota();
public @Nullable Iota readIota(ServerLevel world) {
return inner.readIota(world);
}

@Override
Expand Down
9 changes: 6 additions & 3 deletions Fabric/src/main/java/at/petrak/hexcasting/fabric/cc/adimpl/CCItemIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@
import at.petrak.hexcasting.api.item.IotaHolderItem;
import net.minecraft.core.HolderLookup;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.item.ItemStack;
import org.jetbrains.annotations.Nullable;
import org.ladysnake.cca.api.v3.component.Component;

import java.util.function.Function;

import static at.petrak.hexcasting.api.utils.HexUtils.validateIotaNullable;

public abstract class CCItemIotaHolder implements CCIotaHolder, Component {
final ItemStack stack;
public CCItemIotaHolder(ItemStack stack) {
Expand All @@ -28,8 +31,8 @@ public ItemBased(ItemStack stack) {
}

@Override
public @Nullable Iota readIota() {
return this.iotaHolder.readIota(this.stack);
public @Nullable Iota readIota(ServerLevel world) {
return validateIotaNullable(this.iotaHolder.readIota(this.stack), world);
}

@Override
Expand Down Expand Up @@ -69,7 +72,7 @@ public Static(ItemStack stack, Function<ItemStack, Iota> provider) {
}

@Override
public @Nullable Iota readIota() {
public @Nullable Iota readIota(ServerLevel world) {
return this.provider.apply(this.stack);
}

Expand Down
5 changes: 3 additions & 2 deletions Neoforge/src/main/java/at/petrak/hexcasting/forge/cap/adimpl/CapEntityIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import at.petrak.hexcasting.api.addldata.ADIotaHolder;
import at.petrak.hexcasting.api.addldata.ItemDelegatingEntityIotaHolder;
import at.petrak.hexcasting.api.casting.iota.Iota;
import net.minecraft.server.level.ServerLevel;
import org.jetbrains.annotations.Nullable;

public abstract class CapEntityIotaHolder implements ADIotaHolder {
Expand All @@ -24,8 +25,8 @@ public boolean writeIota(@Nullable Iota iota, boolean simulate) {
}

@Override
public @Nullable Iota readIota() {
return inner.readIota();
public @Nullable Iota readIota(ServerLevel world) {
return inner.readIota(world);
}

@Override
Expand Down
7 changes: 5 additions & 2 deletions Neoforge/src/main/java/at/petrak/hexcasting/forge/cap/adimpl/CapItemIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,18 @@
import at.petrak.hexcasting.api.addldata.ADIotaHolder;
import at.petrak.hexcasting.api.casting.iota.Iota;
import at.petrak.hexcasting.api.item.IotaHolderItem;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.item.ItemStack;
import org.jetbrains.annotations.Nullable;

import static at.petrak.hexcasting.api.utils.HexUtils.validateIotaNullable;

public record CapItemIotaHolder(IotaHolderItem holder, ItemStack stack) implements ADIotaHolder {

@Override
public @Nullable
Iota readIota() {
return holder.readIota(stack);
Iota readIota(ServerLevel world) {
return validateIotaNullable(holder.readIota(stack), world);
}

@Override
Expand Down
3 changes: 2 additions & 1 deletion Neoforge/src/main/java/at/petrak/hexcasting/forge/cap/adimpl/CapStaticIotaHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import at.petrak.hexcasting.api.addldata.ADIotaHolder;
import at.petrak.hexcasting.api.casting.iota.Iota;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.item.ItemStack;
import org.jetbrains.annotations.Nullable;

Expand All @@ -12,7 +13,7 @@ public record CapStaticIotaHolder(Function<ItemStack, Iota> provider,

@Override
public @Nullable
Iota readIota() {
Iota readIota(ServerLevel world) {
return provider.apply(stack);
}

Expand Down
5 changes: 3 additions & 2 deletions Neoforge/src/main/java/at/petrak/hexcasting/forge/recipe/ForgeUnsealedIngredient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import at.petrak.hexcasting.api.addldata.ADIotaHolder;
import at.petrak.hexcasting.api.casting.iota.NullIota;
import at.petrak.hexcasting.api.item.IotaHolderItem;
import at.petrak.hexcasting.common.lib.HexDataComponents;
import at.petrak.hexcasting.forge.lib.ForgeHexIngredientTypes;
import at.petrak.hexcasting.xplat.IXplatAbstractions;
Expand Down Expand Up @@ -56,8 +57,8 @@ public boolean test(@Nullable ItemStack input) {
}
if (this.stack.getItem() == input.getItem() && this.stack.getDamageValue() == input.getDamageValue()) {
ADIotaHolder holder = IXplatAbstractions.INSTANCE.findDataHolder(this.stack);
if (holder != null) {
return holder.readIota() != null && holder.writeIota(new NullIota(), true);
if (holder != null && this.stack.getItem() instanceof IotaHolderItem holderItem) {
return holderItem.readIota(this.stack) != null && holder.writeIota(new NullIota(), true);
}
}

Expand Down
Loading