Skip to content

feat(cbor): encoding preservation with Redeemers union redesign #191

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

Merged
solidsnakedev merged 10 commits into from
Mar 8, 2026
Merged

feat(cbor): encoding preservation with Redeemers union redesign #191

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
86b00ba
docs: CBOR encoding preservation spec
solidsnakedev Mar 6, 2026
daf1b8e
feat(cbor): encoding preservation with Redeemers union redesign
solidsnakedev Mar 6, 2026
2a0c360
release(evolution): CBOR encoding preservation and Redeemers union
solidsnakedev Mar 6, 2026
c5bba98
fix(cbor): address PR review — key-order guards, map encode fallback,…
solidsnakedev Mar 6, 2026
a519fa5
fix(redeemers): use MapFromSelf for CBOR map encoding parity
solidsnakedev Mar 6, 2026
4733fe6
test(redeemers): update assertions for Redeemers union API
solidsnakedev Mar 6, 2026
7de2879
refactor(cbor): remove preserve mode, add WithFormat APIs
solidsnakedev Mar 8, 2026
1a47e30
test(cbor): refactor preservation tests by concern, absorb CML baselines
solidsnakedev Mar 8, 2026
d07f3a9
docs(cbor): write CBOR guide with WithFormat, CBORFormat, and CodecOp…
solidsnakedev Mar 8, 2026
a3a3657
chore(ci): strip @mentions from generated release tweets
solidsnakedev Mar 8, 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
5 changes: 5 additions & 0 deletions .changeset/cbor-encoding-preservation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@evolution-sdk/evolution": patch
---

Add CBOR encoding preservation for bit-perfect round-trip fidelity and redesign Redeemers as a discriminated union (RedeemerMap + RedeemerArray)
328 changes: 328 additions & 0 deletions .specs/cbor-encoding-preservation.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions packages/evolution/src/Anchor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export const FromCDDL = Schema.transform(CDDLSchema, Schema.typeSchema(Anchor),
* @since 2.0.0
* @category schemas
*/
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(
CBOR.FromBytes(options), // Uint8Array → CBOR
FromCDDL // CBOR → Anchor
Expand All @@ -90,7 +90,7 @@ export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTI
* @since 2.0.0
* @category schemas
*/
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(
Schema.Uint8ArrayFromHex, // string → Uint8Array
FromCBORBytes(options) // Uint8Array → Anchor
Expand Down
12 changes: 6 additions & 6 deletions packages/evolution/src/Assets/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,7 @@ export const FromCDDL = Schema.transformOrFail(CDDLSchema, Schema.typeSchema(Ass
* @since 2.0.0
* @category schemas
*/
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(
CBOR.FromBytes(options), // Uint8Array → CBOR
FromCDDL // CBOR → Assets
Expand All @@ -729,7 +729,7 @@ export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTI
* @since 2.0.0
* @category schemas
*/
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(
Schema.Uint8ArrayFromHex, // string → Uint8Array
FromCBORBytes(options) // Uint8Array → Assets
Expand All @@ -756,7 +756,7 @@ export const arbitrary: FastCheck.Arbitrary<Assets> = FastCheck.oneof(
* @since 2.0.0
* @category decoding
*/
export const fromCBORBytes = (bytes: Uint8Array, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const fromCBORBytes = (bytes: Uint8Array, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.decodeSync(FromCBORBytes(options))(bytes)

/**
Expand All @@ -765,7 +765,7 @@ export const fromCBORBytes = (bytes: Uint8Array, options: CBOR.CodecOptions = CB
* @since 2.0.0
* @category decoding
*/
export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.decodeSync(FromCBORHex(options))(hex)

/**
Expand All @@ -774,7 +774,7 @@ export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.CML_D
* @since 2.0.0
* @category encoding
*/
export const toCBORBytes = (data: Assets, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const toCBORBytes = (data: Assets, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.encodeSync(FromCBORBytes(options))(data)

/**
Expand All @@ -783,5 +783,5 @@ export const toCBORBytes = (data: Assets, options: CBOR.CodecOptions = CBOR.CML_
* @since 2.0.0
* @category encoding
*/
export const toCBORHex = (data: Assets, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const toCBORHex = (data: Assets, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.encodeSync(FromCBORHex(options))(data)
12 changes: 6 additions & 6 deletions packages/evolution/src/AuxiliaryData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ export const FromCDDL = Schema.transformOrFail(AnyEraCDDL, Schema.typeSchema(Aux
* @since 2.0.0
* @category schemas
*/
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(CBOR.FromBytes(options), FromCDDL).annotations({
identifier: "AuxiliaryData.FromCBORBytes",
title: "AuxiliaryData from CBOR bytes",
Expand All @@ -495,7 +495,7 @@ export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTI
* @since 2.0.0
* @category schemas
*/
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(Schema.Uint8ArrayFromHex, FromCBORBytes(options)).annotations({
identifier: "AuxiliaryData.FromCBORHex",
title: "AuxiliaryData from CBOR hex",
Expand Down Expand Up @@ -609,7 +609,7 @@ export const arbitrary: FastCheck.Arbitrary<AuxiliaryData> = FastCheck.oneof(
* @since 2.0.0
* @category parsing
*/
export const fromCBORBytes = (bytes: Uint8Array, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const fromCBORBytes = (bytes: Uint8Array, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.decodeSync(FromCBORBytes(options))(bytes)

/**
Expand All @@ -618,7 +618,7 @@ export const fromCBORBytes = (bytes: Uint8Array, options: CBOR.CodecOptions = CB
* @since 2.0.0
* @category parsing
*/
export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.decodeSync(FromCBORHex(options))(hex)

/**
Expand All @@ -627,7 +627,7 @@ export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.CML_D
* @since 2.0.0
* @category encoding
*/
export const toCBORBytes = (data: AuxiliaryData, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const toCBORBytes = (data: AuxiliaryData, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.encodeSync(FromCBORBytes(options))(data)

/**
Expand All @@ -636,5 +636,5 @@ export const toCBORBytes = (data: AuxiliaryData, options: CBOR.CodecOptions = CB
* @since 2.0.0
* @category encoding
*/
export const toCBORHex = (data: AuxiliaryData, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const toCBORHex = (data: AuxiliaryData, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.encodeSync(FromCBORHex(options))(data)
16 changes: 8 additions & 8 deletions packages/evolution/src/BootstrapWitness.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ export const FromCDDL = Schema.transformOrFail(CDDLSchema, Schema.typeSchema(Boo
* @since 2.0.0
* @category schemas
*/
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(
CBOR.FromBytes(options), // Uint8Array → CBOR
FromCDDL // CBOR → BootstrapWitness
Expand All @@ -151,7 +151,7 @@ export const FromCBORBytes = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTI
* @since 2.0.0
* @category schemas
*/
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS) =>
export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS) =>
Schema.compose(
Schema.Uint8ArrayFromHex, // string → Uint8Array
FromCBORBytes(options) // Uint8Array → BootstrapWitness
Expand All @@ -169,7 +169,7 @@ export const FromCBORHex = (options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTION
*/
export const fromCBORBytes = (
bytes: Uint8Array,
options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS
options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS
): BootstrapWitness => Schema.decodeSync(FromCBORBytes(options))(bytes)

/**
Expand All @@ -178,7 +178,7 @@ export const fromCBORBytes = (
* @since 2.0.0
* @category parsing
*/
export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS): BootstrapWitness =>
export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS): BootstrapWitness =>
Schema.decodeSync(FromCBORHex(options))(hex)

/**
Expand All @@ -189,7 +189,7 @@ export const fromCBORHex = (hex: string, options: CBOR.CodecOptions = CBOR.CML_D
*/
export const toCBORBytes = (
witness: BootstrapWitness,
options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS
options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS
): Uint8Array => Schema.encodeSync(FromCBORBytes(options))(witness)

/**
Expand All @@ -198,7 +198,7 @@ export const toCBORBytes = (
* @since 2.0.0
* @category encoding
*/
export const toCBORHex = (witness: BootstrapWitness, options: CBOR.CodecOptions = CBOR.CML_DEFAULT_OPTIONS): string =>
export const toCBORHex = (witness: BootstrapWitness, options: CBOR.CodecOptions = CBOR.PRESERVE_OPTIONS): string =>
Schema.encodeSync(FromCBORHex(options))(witness)

/**
Expand All @@ -210,9 +210,9 @@ export const arbitrary: FastCheck.Arbitrary<BootstrapWitness> = FastCheck.record
FastCheck.uint8Array({ minLength: 1, maxLength: 64 }).map((path) => {
const m = new Map<bigint, Uint8Array>()
// Byron AddrAttributes: key 1 holds derivation_path; value is CBOR-encoded bytes
const inner = CBOR.internalEncodeSync(path, CBOR.CML_DEFAULT_OPTIONS)
const inner = CBOR.internalEncodeSync(path, CBOR.PRESERVE_OPTIONS)
m.set(1n, inner)
return CBOR.internalEncodeSync(m, CBOR.CML_DEFAULT_OPTIONS)
return CBOR.internalEncodeSync(m, CBOR.PRESERVE_OPTIONS)
})
),
chainCode: FastCheck.uint8Array({ minLength: 32, maxLength: 32 }),
Expand Down
Loading
Loading