Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Declarative CBOR schema via annotations (CborId)

オープン
  • 何か問題がありますか？
#190 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript
領域
backend

調査の方向性

CBOR.ts で、提案されている CborId アノテーション型と codec engine の設計を読み始め、次に TransactionBody、TransactionWitnessSet、Transaction の既存の FromCDDL および CDDLSchema 実装を調査します。Tag-258 セット、redeemer の map/array 二重性、ネストされた map、オプションフィールド、エンコーディングの保持を網羅し、後方互換性を維持したまま、該当するすべてのモジュールの変換が完了すれば、完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement exploration

Summary

Replace hand-written FromCDDL transforms with declarative schema annotations that describe CBOR wire format directly on Effect Schema types.

Motivation

Currently each module (TransactionBody, TransactionWitnessSet, Transaction, etc.) has:

  • A CDDLSchema (intermediate CBOR AST type)
  • A FromCDDL transform (hand-written 200-500 line encode/decode)
  • A FromCBORBytes that composes FromBytes with FromCDDL

This creates a two-hop pipeline (Uint8Array → CBOR AST → domain) with a validation boundary that clones objects and strips Symbol metadata (e.g. kEncoding for encoding preservation).

Proposal

A CborId Symbol annotation on Effect Schemas that carries CBOR layout metadata:

const CborId = Symbol.for("evolution/CborId")

const Address = Schema.Uint8ArrayFromSelf.annotations({
  [CborId]: { tag: 259 }
})

const Value = Schema.Struct({
  coin: Schema.BigIntFromSelf,
  multiasset: Schema.optional(MultiAsset),
}).annotations({
  [CborId]: { encoding: "array", fieldOrder: ["coin", "multiasset"] }
})

const TransactionOutput = Schema.Struct({
  address: Address,
  value: Value,
  datum: Schema.optional(Datum),
  scriptRef: Schema.optional(ScriptRef),
}).annotations({
  [CborId]: { encoding: "map", keys: { address: 0n, value: 1n, datum: 2n, scriptRef: 3n } }
})

A generic CBOR codec engine reads [CborId] annotations to:

  • Map struct fields to integer-keyed CBOR map entries or positional array slots
  • Wrap values in CBOR tags (e.g. #6.258 for sets)
  • Handle optional fields (omit from map when undefined)
  • Thread kEncoding preservation metadata automatically

Benefits

  • Eliminates FromCDDL — no hand-written encode/decode per module
  • Eliminates CDDLSchema — domain schema IS the codec schema, no intermediate type
  • Encoding preservation is free — single transform boundary, no clone/Symbol stripping
  • Self-documenting — annotations describe the wire format directly
  • Less code — TransactionBody goes from ~500 lines of transform to ~25 lines of annotated schema

Scope

  • Build CborId annotation types and codec engine in CBOR.ts (~200-400 lines)
  • Convert all modules with FromCDDL transforms to use annotated schemas
  • Handle edge cases: Tag-258 sets, redeemer map/array duality, nested maps, etc.
  • Maintain backward compatibility with existing domain types

Context

Discovered during CBOR encoding preservation work. The immediate fix (replacing MapFromSelf/Tuple CDDLSchemas with non-cloning Schema.declare) unblocks encoding preservation. This issue tracks the larger architectural improvement.

主要言語
TypeScript
スター
22
フォーク
31
平均マージ
3日 4時間
マージ済み PR（30日）
27

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

IntersectMBO/evolution-sdk のほかの issue

IntersectMBO/evolution-sdk の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。