Skip to content
This repository has been archived by the owner on Aug 1, 2024. It is now read-only.
/ cosmos-sdk Public archive
forked from cosmos/cosmos-sdk

Commit

Permalink
docs: add ADR 063: core API ADR + update app wiring ADR (cosmos#12972)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronc authored and tsenart committed Apr 12, 2023
1 parent 960627a commit b74fc0a
Show file tree
Hide file tree
Showing 3 changed files with 437 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ When writing ADRs, follow the same best practices for writing RFCs. When writing
* [ADR 057: App Wiring](./adr-057-app-wiring.md)
* [ADR 059: Test Scopes](./adr-059-test-scopes.md)
* [ADR 062: Collections State Layer](./adr-062-collections-state-layer.md)
* [ADR 063: Core Module API](./adr-063-core-module-api.md)

### Draft

Expand Down
10 changes: 8 additions & 2 deletions docs/architecture/adr-057-app-wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,9 @@ can help us figure out issues with missing dependencies in an app config if the
In cases where required modules are not loaded at runtime, it may be possible to guide users to the correct module if
through a global Cosmos SDK module registry.

The `*appmodule.Handler` type referenced above is a replacement for the legacy `AppModule` framework, and
described in [ADR 061: Core Module API](./adr-061-core-module-api.md).

### New `app.go`

With this setup, `app.go` might now look something like this:
Expand Down Expand Up @@ -242,8 +245,10 @@ func main() {
### Application to existing SDK modules

So far we have described a system which is largely agnostic to the specifics of the SDK such as store keys, `AppModule`,
`BaseApp`, etc. A second app wiring ADR will be created which outlines the details of how this app wiring system will
be applied to the existing SDK in a way that:
`BaseApp`, etc. Improvements to these parts of the framework that integrate with the general app wiring framework
defined here are described in [ADR 061: Core Module API](./adr-061-core-module-api.md).

### Registration of Inter-Module Hooks

### Registration of Inter-Module Hooks

Expand Down Expand Up @@ -333,3 +338,4 @@ light of code generation. It may be better to do this type registration with a D
* https://github.com/google/wire
* https://pkg.go.dev/github.com/cosmos/cosmos-sdk/container
* https://github.com/cosmos/cosmos-sdk/pull/11802
* [ADR 061](./adr-061-core-module-api.md)
Loading

0 comments on commit b74fc0a

Please sign in to comment.