rollkit-types 0.0.1

Protocol buffer generated types for Rollkit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# rollkit-types

Proto-generated types for Rollkit.

## Features

- `grpc` (enabled by default) - Includes gRPC client and server code
- `transport` - Enables tonic transport features

## Usage

### Default usage (with gRPC)

```toml
[dependencies]
rollkit-types = "0.1"
```

### Types only (without gRPC)

If you only need the message types without gRPC client/server code:

```toml
[dependencies]
rollkit-types = { version = "0.1", default-features = false }
```

This is useful when:

- You only need to serialize/deserialize Rollkit messages
- You're using a different RPC framework
- You want to minimize dependencies
- You're building for environments where gRPC is not needed

## How It Works

This crate generates two versions of the protobuf code:

1. **`rollkit.v1.messages.rs`** - Contains only the message types (structs/enums) with no gRPC dependencies
2. **`rollkit.v1.services.rs`** - Contains everything including gRPC client/server code

Both files are pre-generated and checked into the repository, so users don't need `protoc` installed or need to regenerate based on their feature selection.

## Building

The proto files are automatically generated during the build process:

```bash
cargo build
```

## Proto Generation

The generated code is committed to the repository. If you modify the proto files, you need to regenerate:

```bash
# From the repository root
make rust-proto-gen

# Or directly
cd client/crates/rollkit-types
cargo build
```

**Important**: The build process generates both `rollkit.v1.messages.rs` and `rollkit.v1.services.rs`. Both files should be committed to ensure users can use the crate without needing to regenerate based on their feature selection.

## Version Consistency

**Important**: The CI uses protoc version 25.1. If your local protoc version differs, you may see formatting differences in the generated files.

To check your protoc version:

```bash
protoc --version
```

To ensure consistency with CI:

1. Install protoc version 25.1
2. Use the provided script: `./client/scripts/generate-protos.sh`
3. Or use the Makefile: `make rust-proto-gen`

### Common Issues

If you see differences in generated files between local and CI:

- It's usually due to protoc version differences
- Different versions may format the generated code slightly differently
- The functionality remains the same, only formatting changes

To avoid this:

- Use the same protoc version as CI (25.1)
- Or accept the formatting from your version and update CI if needed

## Dependencies

This crate requires:

- `protoc` (Protocol Buffers compiler)
- `tonic-build` for code generation
- `prost` for runtime support

The build dependencies are specified in `Cargo.toml` and use workspace versions for consistency.