Skip to content

docs: add implementation specs and architecture overview#82

Closed
notJoon wants to merge 27 commits into
mainfrom
docs-update
Closed

docs: add implementation specs and architecture overview#82
notJoon wants to merge 27 commits into
mainfrom
docs-update

Conversation

@notJoon

@notJoon notJoon commented May 27, 2026

Copy link
Copy Markdown
Member

Summary

  • Add implementation specs for IBC v1 core, ZKGM v1, light clients, events, fixtures, and toolchain setup
  • Add an architecture overview covering realm topology, actors, state ownership, authorization boundaries, and packet lifecycle flows
  • Clarify ZKGM module paths, temporary stdlib overlay status, event attributes, and fixture tooling

notJoon added 5 commits May 27, 2026 17:31
… ZKGM

- Added "Implementation Specs" link to the README for easy access to current implementation specifications.
- Created a new README.md file in the specs directory detailing the implementation specifications for IBC, ZKGM, events, fixtures, and the toolchain.
- Introduced detailed architecture documentation for the IBC v1 stack, outlining the system topology, external actors, state ownership, and authorization boundaries.
- Added an Event Catalog to document the emitted events for IBC and ZKGM, including stability levels and attributes.
- Established a Fixtures and Wire Compatibility spec to ensure byte-compatibility with external systems and describe the fixture generation process.
- Documented the IBC v1 core specifications, detailing the core realm's responsibilities, client lifecycle, connection and channel lifecycle, and packet lifecycle.
- Created a Light Clients spec to describe the v1 light-client adapter model and its responsibilities.
- Added a Native Stdlib Overlay and Toolchain spec to outline the toolchain setup and local stdlib overlay used in development.
- Introduced a ZKGM v1 App spec detailing the proxy and implementation realms, responsibilities, and instruction dispatch mechanisms.
- Updated the common SendRaw procedure documentation to remove unnecessary log storage instructions.
@github-actions github-actions Bot added A-doc Documentation: README, specs, godoc A-ibc IBC core, light client, packet/channel/connection labels May 27, 2026
@notJoon notJoon marked this pull request as draft May 27, 2026 10:09
@github-actions github-actions Bot added the A-ci CI/CD workflows: lint, test, coverage pipelines label May 28, 2026
@notJoon notJoon marked this pull request as ready for review May 28, 2026 04:40
@notJoon

notJoon commented Jun 12, 2026

Copy link
Copy Markdown
Member Author

move into wiki page. no need to maintain this

@notJoon notJoon closed this Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-ci CI/CD workflows: lint, test, coverage pipelines A-doc Documentation: README, specs, godoc A-ibc IBC core, light client, packet/channel/connection

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant