Skip to content

Commit 5664c49

Browse files
docs: x/liquid docs updates (#3725)
1 parent 51ed2c8 commit 5664c49

File tree

6 files changed

+1463
-8
lines changed

6 files changed

+1463
-8
lines changed

docs/docs/modules/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ links for each one.
3838

3939
## gaia specific modules
4040

41-
- [Metaprotocols](./metaprotocols.md)
42-
- [LSM staking](./lsm-staking.md)
41+
- [x/metaprotocols](./metaprotocols.md)
42+
- [x/liquid](./liquid.md)
43+
- [Cosmos SDK LSM (deprecated)](./lsm-migration.md)
4344

4445
## other modules
4546

docs/docs/modules/lsm-staking.md renamed to docs/docs/modules/liquid.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: LSM Staking
3-
order: 1
2+
title: x/liquid
3+
order: 2
44
---
55

6-
The `x/staking` module used by the Hub includes extensions that enable liquid staking
7-
You can read more about it in our [LSM documentation](https://github.com/cosmos/cosmos-sdk/tree/v0.50.9-lsm/x/staking#totalliquidstakedtokens).
6+
The `x/liquid` module used by the Hub includes types and APIs that enable liquid staking.
7+
You can read more about it in our [module documentation](https://github.com/cosmos/gaia/tree/main/x/liquid/README.md).
88

99
## What are LSM shares
1010

docs/docs/modules/lsm-migration.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Cosmos SDK LSM
3+
order: 3
4+
---
5+
6+
## Deprecation
7+
8+
As of the `v24.x` release of Gaia, the Cosmos SDK based Liquid Staking Module is deprecated. The `v24` release line
9+
will still have all the types from the forked SDK version, but all the API endpoints will be disabled.
10+
11+
## Migration
12+
13+
The following outlines the key differences between the Cosmos SDK LSM and the x/liquid module, including message and
14+
API removals between the two, as well as parameter and limit changes. In general an effort was made to keep as much
15+
as possible the same between the two. Cases where removals were made were largely due to no longer be able to
16+
properly track state from outside the staking module.
17+
18+
The state associated with each account currently on a live network which is using the SDK LSM will be migrated to
19+
use the liquid module. There should be no change to the existing liquid staking denoms, tokenize share records, or
20+
rewards associated with any owner of a tokenize share record.
21+
22+
### Removals
23+
- MsgUnbondValidator
24+
- MsgValidatorBond
25+
26+
Both the message types and the APIs for Validator Bonds have been removed. The `min_self_delegation` field in the
27+
SDK's staking module, which had previously been marked as deprecated, has been restored to its upstream state.
28+
29+
Note that if you created a validator after the field was deprecated, you may end up with `0` self delegation and a
30+
`min_self_delegation` of `1`. This should be minimally invasive and will only affect you if you try to call
31+
`EditValidator` or potentially in an `Unjail` scenario. The resolution for this is to self delegate a minimal amount
32+
of stake.
33+
34+
- Limits changes
35+
36+
The `GlobalLiquidStakingCap` and `ValidatorLiquidStakingCap` are now the only protocol limits and are enforced
37+
solely on tokenized shares through the x/liquid module itself. Previously this tracked delegations via ICA as
38+
counting towards these limits, but the new tallies do not take that into account.
39+
40+
### Migrations
41+
All messages and APIs have been moved.
42+
43+
For protobuf, the types within the distribution and staking modules have all been moved to
44+
```protobuf
45+
gaia.liquid.v1beta1.*
46+
```
47+
48+
For API paths, the module-specific paths have all been moved to
49+
```
50+
/gaia/liquid/v1beta1/
51+
```
52+
53+
CLI interactions with the liquid module should use `gaiad q liquid` or `gaiad tx liquid`, etc.

docs/docs/modules/metaprotocols.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Metaprotocol
3-
order: 2
3+
order: 1
44
---
55

66
The `x/metaprotocol` module adds support for encoding and decoding additional fields attached to transactions.

0 commit comments

Comments
 (0)