Serializable messages and generic operations #467

krebernisak · 2025-12-23T10:29:05Z

Add tlbe.Dict[K, V] to replace cell.Dictionary as a JSON/Cell serializable generic (dict) type
Add tlbe.ToCell/LoadFromCell shims to support int/uint primitive types (avoid needing a wrapper type for these)
Mark all _ tlb.Magic struct opcodes with <tlb:...> json:"-" to make those structs pass CLDF's operations.IsSerializable check
Add codec.MessageEnvelope[T] which is a JSON/Cell serializable generic (message wrapper) type
Add tvm.MessageRegistry to map contract types (string) to their corresponding TLBMap (opcode -> msg)
New TON basic CLDF types:
- Add ops.SendMessages[T] operation - standardizes sending any []codec.MessageEnvelope[T] batch (+ metadata) on input
- Add ops.AnySequence sequence - standardizes sequencing of any operation based on input (e.g., ops.SendMessage above)
Add new pkg/ton/codec and restructure/rm the existing pkg/ton/debug package

… fn + types

…leanup keys

… JSON

github-actions · 2025-12-23T10:29:18Z

👋 krebernisak, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

Copilot

Pull request overview

This PR introduces serializable message envelopes and generic operations for TON blockchain interactions, reorganizing the codebase to support better message handling and codec functionality.

Key changes:

Introduced a generic message envelope system with JSON serialization support
Created a custom JSON codec for TL-B message structures
Moved debug-related code from pkg/ton/debug to pkg/ton/codec/debug for better organization
Added operations framework for message planning and execution

Reviewed changes

Copilot reviewed 69 out of 79 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
pkg/ton/tvm/registry.go	Adds TLB map registry for message type lookups
pkg/ton/tvm/magic.go	Implements magic number extraction from TL-B structs
pkg/ton/codec/envelope.go	Introduces generic MessageEnvelope for type-safe message handling
pkg/ton/codec/jsoncodec/codec.go	Implements custom JSON codec for TL-B structures
pkg/ton/codec/decoder.go	Refactors decoder to use new TLB registry types
pkg/ton/tlbe/dictionary.go	Adds generic dictionary wrapper for TL-B dictionaries
pkg/ton/tlbe/biguint.go	Adds BitsLen methods and Cmp for Uint256
pkg/bindings/*.go	Updates all bindings to add `json:"-"` tags to Magic fields and use new registry
deployment/pkg/ops/*.go	Adds operations framework for message planning and execution
deployment/pkg/utils/generator.go	Adds sample data generator for testing

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/ton/tvm/magic.go

pkg/ton/codec/jsoncodec/codec.go

pkg/ton/codec/envelope.go

pkg/ton/tlbe/dictionary.go

Copilot · 2025-12-23T10:31:02Z

pkg/ccip/bindings/router/router.go

-	Amount *big.Int        `tlb:"## 256"`
-	Token  address.Address `tlb:"addr"`
+	Amount *big.Int         `tlb:"## 256"`
+	Token  *address.Address `tlb:"addr"`


Changing Token from address.Address to *address.Address is a breaking change. This makes the field nullable which could impact existing code that assumes this field is always present.

Copilot · 2025-12-23T10:31:02Z

pkg/ccip/bindings/offramp/offramp.go

 // Any2TVMMessage represents a cross-chain message to TON
 type Any2TVMMessage struct {
-	MessageID           [32]byte                     `tlb:"bits 256"`
+	MessageID           []byte                       `tlb:"bits 256"`


Changing MessageID from [32]byte to []byte removes compile-time size guarantees. This is a breaking change that could lead to runtime errors if the slice doesn't have exactly 32 bytes.

Suggested change

MessageID []byte `tlb:"bits 256"`

MessageID [32]byte `tlb:"bits 256"`

Using [32byte fails with panic: reflect.Value.Bytes of unaddressable byte array [recovered, repanicked], works as:

[]byte - current choice

*[32]byte

Maybe we can at least leave a comment clarifying it is 32 bytes? Should we create a wrapper type instead maybe?

pkg/bindings/mcms/mcms/types.go

Copilot · 2025-12-23T10:31:03Z

deployment/pkg/utils/generator.go

+// NewGenerator constructs a Generator with sensible defaults.
+func NewGenerator(opts ...Option) *Generator {
+	g := &Generator{
+		rng:                rand.New(rand.NewSource(42)),


Using a fixed seed (42) for random number generation makes the output predictable. While this may be intentional for testing, consider documenting this behavior and providing an option to use a secure random seed for production use cases.

pkg/ton/codec/envelope.go

Copilot · 2025-12-23T10:31:03Z

pkg/ton/tlbe/dictionary.go

+		if t.Kind() == reflect.Pointer {
+			inst = reflect.New(t.Elem()).Interface().(DictKey)
+		} else {
+			inst = reflect.New(t).Elem().Interface().(DictKey)


Type assertion without checking can panic. Wrap this in a type assertion with the ok pattern to handle cases where the type doesn't implement DictKey.

pkg/ton/tvm/magic.go

krebernisak · 2025-12-23T11:11:23Z

pkg/bindings/index.go

 }
+
+// Sent back to sender after the executor role check is updated.
+type TestMessage struct {


TODO: move to tests

krebernisak · 2025-12-23T11:40:14Z

pkg/ccip/bindings/offramp/offramp.go

 // Any2TVMMessage represents a cross-chain message to TON
 type Any2TVMMessage struct {
-	MessageID           [32]byte                     `tlb:"bits 256"`
+	MessageID           []byte                       `tlb:"bits 256"`


Using [32byte fails with panic: reflect.Value.Bytes of unaddressable byte array [recovered, repanicked], works as:

[]byte - current choice

*[32]byte

patricios-space

This is looking really promising! Left some small comments

patricios-space · 2025-12-24T11:32:58Z

deployment/pkg/utils/generator.go

+		if field != nil {
+			ctx.Tag = parseTLBTag(field.Tag.Get("tlb"))
+		}


Isn't this duplicated above?

patricios-space · 2025-12-24T11:45:17Z

deployment/pkg/utils/generator.go

+
+		size := g.randomCollectionSize()
+		slice := reflect.MakeSlice(t, size, size)
+		for i := 0; i < size; i++ {


Nit:

Suggested change

for i := 0; i < size; i++ {

for i := range size {

patricios-space · 2025-12-24T13:10:40Z

deployment/pkg/ops/ops_test.go

Should we move tests to a different module so we don't ship them in the package?

patricios-space · 2025-12-24T13:15:11Z

pkg/ccip/bindings/offramp/offramp.go

 // Any2TVMMessage represents a cross-chain message to TON
 type Any2TVMMessage struct {
-	MessageID           [32]byte                     `tlb:"bits 256"`
+	MessageID           []byte                       `tlb:"bits 256"`


Maybe we can at least leave a comment clarifying it is 32 bytes? Should we create a wrapper type instead maybe?

krebernisak added 16 commits December 23, 2025 11:15

JSON encoder/decoder (wip)

57786c4

Refactor MessageEnvelope[T], add Dict[K, V], add NewMessageOp builder…

59069b5

… fn + types

Remove cellJSON wrapper

1ba7d4a

Use tble.Dict[K,V], add to generator, add tlbe.ToCell/LoadFromCell, c…

b4c32e2

…leanup keys

Extract makeExecuteOp test helper

c4b8b67

Add lib.MessageRegistry, add MessageEnvelope[T].ToCell/LoadFromCell +…

5da7175

… JSON

Tmp fix circural dep, add Fuzz test

7905f15

Add SendMessageOp and AnySequence

18e1b0c

Test AnySequence with SendMessage op

affd015

Remove jsoncodec experiment

2c31415

Move MessageRegistry to pkg/ton/tvm

519fe92

Revert pkg/ton/debug/lib/lib.go changes

290e6b1

Fix refactor

06a436a

Extract pkg/ton/codec

36457d2

mv pkg/ton/debug pgk/ton/codec/debug

2fb071d

Remove generated files

1a6d96e

krebernisak requested a review from a team as a code owner December 23, 2025 10:29

Copilot AI review requested due to automatic review settings December 23, 2025 10:29

Copilot AI reviewed Dec 23, 2025

View reviewed changes

github-advanced-security bot found potential problems Dec 23, 2025

View reviewed changes

pkg/ton/tvm/magic.go Fixed Show fixed Hide fixed

krebernisak added 4 commits December 23, 2025 12:01

Fix binding and nix build

9467f91

Add checks to ExtractMagic fn

63f87dc

rm pkg/ton/codec/jsoncodec

e21b6db

Simplify Dict[K, V].ToCell

b2dc393

krebernisak commented Dec 23, 2025

View reviewed changes

krebernisak added 2 commits December 23, 2025 12:47

PR review fixes

c92bd3f

Fix lint

cd785cc

krebernisak changed the title ~~Serializable messages and generic ops~~ Serializable messages and generic operations Dec 23, 2025

krebernisak mentioned this pull request Dec 23, 2025

Implement CCIP produce level Deployer interface #453

Open

Support sending batch of messages

4aeac0d

patricios-space reviewed Dec 24, 2025

View reviewed changes

	MessageID []byte `tlb:"bits 256"`
	MessageID [32]byte `tlb:"bits 256"`

Serializable messages and generic operations #467

Are you sure you want to change the base?

Serializable messages and generic operations #467

Uh oh!

Conversation

krebernisak commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

patricios-space left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

krebernisak commented Dec 23, 2025 •

edited

Loading

patricios-space left a comment •

edited

Loading