Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ADR 063: core API ADR + update app wiring ADR #12972

Merged
merged 31 commits into from
Jan 27, 2023
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
19c735e
docs: add core API ADR
aaronc Aug 19, 2022
95e5281
updates
aaronc Aug 19, 2022
77d6ea1
updates
aaronc Aug 19, 2022
b4040de
updates
aaronc Aug 19, 2022
1b2a02a
updates
aaronc Aug 19, 2022
736f50a
updates
aaronc Aug 19, 2022
40f531e
Merge branch 'main' into aaronc/core-api-adr
aaronc Aug 19, 2022
45bcd8d
updates based on reviews
aaronc Aug 25, 2022
30039ff
updates based on reviews
aaronc Aug 25, 2022
d7ce68a
Merge branch 'main' into aaronc/core-api-adr
aaronc Aug 25, 2022
28c8046
updates based on reviews
aaronc Aug 25, 2022
7d1f682
typo
aaronc Aug 25, 2022
c11a992
API simplifications
aaronc Aug 29, 2022
1175337
ADR-033 updates
aaronc Aug 29, 2022
e9b24e0
update events spec
aaronc Aug 29, 2022
8da33ef
update bundle service
aaronc Aug 29, 2022
f8212ca
Update docs/architecture/adr-061-core-module-api.md
aaronc Aug 30, 2022
b13cb98
Update docs/architecture/adr-061-core-module-api.md
aaronc Aug 30, 2022
5812828
fix indentation
aaronc Aug 31, 2022
09fdad9
Merge remote-tracking branch 'origin/aaronc/core-api-adr' into aaronc…
aaronc Aug 31, 2022
64f2d11
Update docs/architecture/adr-061-core-module-api.md
aaronc Aug 31, 2022
1fb3cba
Merge branch 'main' of github.com:cosmos/cosmos-sdk into aaronc/core-…
aaronc Dec 8, 2022
83a9060
revert
aaronc Dec 8, 2022
2cbd793
update to 063
aaronc Dec 8, 2022
aaf397b
updates
aaronc Dec 8, 2022
0e9bbe1
Merge branch 'main' of github.com:cosmos/cosmos-sdk into aaronc/core-…
aaronc Jan 24, 2023
3432806
updates
aaronc Jan 24, 2023
f330fa3
updates
aaronc Jan 24, 2023
e43258d
Merge branch 'main' into aaronc/core-api-adr
aaronc Jan 24, 2023
bbb6ba8
Merge branch 'main' into aaronc/core-api-adr
aaronc Jan 26, 2023
c216753
Merge branch 'main' into aaronc/core-api-adr
tac0turtle Jan 27, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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