clockworklabs / clockworklabs/SpacetimeDB

Modify SpacetimeDB to assert that current module's `__describe_module__` == `__describe_module__` derived from the system tables

Open
#3,231 0 comments 0 reactions 1 assignee View on GitHub

@Shubham8287 is already working on this.

Since Sep 30, 2025.

Dominant language
Rust
Stars
25.2k
Forks
1.1k
Avg merge
2d 7h
Merged PRs (30d)
46

Description

Currently SpacetimeDB only checks:

  • old module's __describe_module__ == new modules __describe_module__

This ticket proposes to modify SpacetimeDB that before a database is considered up and running, we should be asserting that the __describe_module__ matches a hypothetical __describe_module__ derived from the system table

If the ModuleDefs do match, then we start the database.

If the ModuleDefs do NOT match, then we can either panic if we can't upgrade to the new ModuleDef, or we could attempt an upgrade (probably with a warning since we are basically healing something that should never have happened).

We could also just choose to always panic on a mismatch.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.