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.

Sign up for GitHub

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

Problem: non-stable Gravity Bridge module related functionality #168

Merged
merged 2 commits into from
Oct 13, 2021
Merged

Problem: non-stable Gravity Bridge module related functionality #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa0a8a9
Problem: non-stable Gravity Bridge module related functionality
tomtau Oct 12, 2021
390a4ff
deletion instead of conditional compilation
tomtau Oct 13, 2021
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
3 changes: 2 additions & 1 deletion docs/architecture/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ To suggest an ADR, please make use of the [ADR template](./adr-template.md) prov
## Table of Contents

| ADR \# | Description | Status |
| ------ | ----------- | ------ |
| ------ | ----------- | ------ |
| [001](./adr-001.md) | Disable Gravity Bridge at Genesis | Proposed |
51 changes: 51 additions & 0 deletions docs/architecture/adr-001.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# ADR 001: Disable Gravity Bridge at Genesis

## Changelog
* 12-10-2021: Initial Draft
* 13-10-2021: Code deletion instead of conditional compilation

## Context

The Gravity Bridge module was added for fungible asset transfers from and to the Ethereum network.
Additionally, custom code was added for directly mapping the native tokens from Gravity Bridge
to the Ethermint module. At the time of writing, Gravity Bridge does not have a stable release
and the codebase contains several known issues.

## Decision

The Gravity Bridge module will be removed from:
1. "app/app.go" which contains the module initialization boilerplate
2. "cmd/cronosd/cmd/root.go" which adds Gravity Bridge-related commands.

In addition to that, the "x/cronos" module contains Gravity Bridge-related code in its types and keeper. This following code will be removed:
1. the whole x/cronos/keeper/gravity_hooks.go module
2. the gravityKeeper field in CronosKeeper

Existing integration tests related to Gravity Bridge can be temporarily disabled and later enabled when Gravity Bridge is added back.

Once the Gravity Bridge code is added back, the x/cronos module `ConsensusVersion` should be increased and the corresponding upgrade handler should be added.

## Status

Accepted

## Consequences

### Positive
* Reduced complexity in the initial Cronos state
* Reduced complexity in the initial infrastructure deployment
* Possible to add the Gravity Bridge module in a coordinated upgrade when the module gets a stable release

### Negative
* Not testing Gravity Bridge temporarily

### Neutral
* A need for a breaking change upgrade

## References

* https://github.com/althea-net/cosmos-gravity-bridge/issues/348
* https://github.com/althea-net/cosmos-gravity-bridge/issues/347
* https://github.com/althea-net/cosmos-gravity-bridge/issues/346
* https://github.com/althea-net/cosmos-gravity-bridge/issues/344
* in-place store migrations: https://github.com/cosmos/cosmos-sdk/blob/a47bd592e951d34ebbffca03f85ca98d65b61be8/docs/architecture/adr-041-in-place-store-migrations.md