feat(tendermint): staking queries by onur-ozkan · Pull Request #2377 · GLEECBTC/komodo-defi-framework

onur-ozkan · 2025-02-27T10:50:13Z

Implements delegations and ongoing_undelegations searching RPCs including rewards and undelegation completion period information for tendermint.

Signed-off-by: onur-ozkan <work@onurozkan.dev>

laruh

I think it's better to follow common recommendations and implement the Display trait instead of a direct ToString implementation.

https://github.com/KomodoPlatform/komodo-defi-framework/blob/7bcf53389024c92b7df9ce77b351fef6751806ec/mm2src/coins/rpc_command/tendermint/staking.rs#L21-L30

impl Display for ValidatorStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let str = match self {
            // An empty string doesn't filter any validators and we get an unfiltered result.
            ValidatorStatus::All => String::default(),
            ValidatorStatus::Bonded => "BOND_STATUS_BONDED".into(),
            ValidatorStatus::Unbonded => "BOND_STATUS_UNBONDED".into(),
        };
        write!(f, "{}", str)
    }
}

onur-ozkan · 2025-03-05T06:45:13Z

Could you elaborate how it's being the common recommendation to prefer Display trait for String castings?

laruh · 2025-03-05T06:55:57Z

Could you elaborate how it's being the common recommendation to prefer Display trait for String castings?

https://doc.rust-lang.org/std/fmt/trait.Display.html

Implementing this trait for a type will automatically implement the ToString trait for the type, allowing the usage of the .to_string() method. Prefer implementing the Display trait for a type, rather than ToString.

As I understand implementing Display makes code easier to maintain and integrates with formatting macros.

onur-ozkan · 2025-03-05T07:01:20Z

We don't need formatting on the type so it's unnecessary. We specifically and explicitly need ToString, anything extra is redundant IMO.

laruh · 2025-03-05T07:11:04Z

mm2src/coins/lp_coins.rs

+    Cosmos(rpc_command::tendermint::staking::SimpleListQuery),
+}
+
+#[derive(Deserialize)]
+pub struct UndelegationsInfo {
+    pub coin: String,
+    info_details: UndelegationsInfoDetails,
+}
+
+#[derive(Debug, Deserialize)]
+#[serde(tag = "type")]
+pub enum UndelegationsInfoDetails {
+    Cosmos(rpc_command::tendermint::staking::SimpleListQuery),


There is so much code in lp_coins.rs related to staking and delegation.

What about moving it to pub mod staking? The module can be inside the coins workspace.

Yeah... I also hate that, but the thing is even with staking module in coins module it wouldn't be good enough, in fact, I think it will be even bad because it will look like we have duplicated staking modules (one from tendermint and one from coins) and it will look inconsistent with how we handle other RPCs (right now they all included in lp_coins).

I would prefer to re-write this module in general, rather than applying a workaround solution for specific logic.

I think it will be even bad because it will look like we have duplicated staking modules

You can rename staking in tendermint or just add doc comment at the top of file

If I do it in this PR, it will be very hard for others to review this PR (due to moving lots of things around). I will wait for others opinion on this.

I think you can create an issue to move staking code from lp_coins to its own module before adding more staking implementations.

If I do it in this PR, it will be very hard for others to review this PR (due to moving lots of things around). I will wait for others opinion on this.

Agreed, we should never do refactors that involves moving code around in the same PR as new functionalities.

mm2src/coins/tendermint/tendermint_coin.rs

borngraced

well done. I have two minor 2 notes

mm2src/coins/tendermint/tendermint_coin.rs

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan · 2025-03-17T11:46:24Z

Can you please finalize your reviews? @laruh @borngraced

borngraced

Great work!

laruh

LGTM! please dont forget to create an issue #2377 (comment)

shamardy

LGTM! Only one nit.

mm2src/coins/lp_coins.rs

Signed-off-by: onur-ozkan <work@onurozkan.dev>

… into staking-query-rpcs

* dev: feat(tendermint): staking queries (#2377)

* dev: fix(tx-history): fix unhandled IBC and HTLC events (#2385) improvement(dep-stack): replace deprecated `instant` dependency (#2391) feat(tendermint): staking queries (#2377) refactor(eth): use trait addr_to_string method instead of old function (#2348) fix(ci): use correct rustup component syntax in fmt-and-lint job (#2390) refactor(tx-query): use TxSearchRequest for tx queries (#2384) refactor(tpu-v2): allow to skip p2p message with taker payment spend preimage for eth (#2359) feat(rpc): add is_success field to legacy MySwapStatusResponse (#2371) fix(key-derivation): use stored Argon2 parameters instead of default values (#2360) fix(tests): stabilize `tendermint_coin::test_claim_staking_rewards` (#2373) improvement(RPCs): group staking rpcs under a namespace (#2372)

onur-ozkan added status: in progress feature: protocol labels Feb 27, 2025

onur-ozkan self-assigned this Feb 27, 2025

onur-ozkan added 5 commits February 27, 2025 16:11

add delegations query support for Cosmos

3376442

Signed-off-by: onur-ozkan <work@onurozkan.dev>

add coverage for tendermint delegations_list

217179a

Signed-off-by: onur-ozkan <work@onurozkan.dev>

include rewards in delegations and impl undelegations

f3db4c3

Signed-off-by: onur-ozkan <work@onurozkan.dev>

add TODO

404b78b

Signed-off-by: onur-ozkan <work@onurozkan.dev>

nit

45f1a67

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the staking-query-rpcs branch from 269feaf to 45f1a67 Compare February 27, 2025 16:11

onur-ozkan changed the base branch from staking-rpcs to dev February 27, 2025 16:11

extend the coverage on delegations and undelegations

77b8c63

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the staking-query-rpcs branch 4 times, most recently from f729bc0 to 47e4489 Compare March 3, 2025 10:40

handle empty reward case on delegations list

7bcf533

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the staking-query-rpcs branch from 47e4489 to 7bcf533 Compare March 3, 2025 11:07

onur-ozkan added status: pending review and removed status: in progress labels Mar 3, 2025

shamardy requested a review from laruh March 3, 2025 11:58

shamardy added the 2.5.0-beta label Mar 3, 2025

laruh reviewed Mar 5, 2025

View reviewed changes

laruh suggested changes Mar 5, 2025

View reviewed changes

borngraced suggested changes Mar 6, 2025

View reviewed changes

mm2src/coins/tendermint/tendermint_coin.rs Show resolved Hide resolved

mm2src/coins/tendermint/tendermint_coin.rs Outdated Show resolved Hide resolved

keep the error with MmError wrapper

d1115e8

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the staking-query-rpcs branch from 2a32128 to d1115e8 Compare March 10, 2025 07:31

shamardy requested a review from borngraced March 17, 2025 11:21

shamardy requested a review from laruh March 17, 2025 11:21

borngraced previously approved these changes Mar 17, 2025

View reviewed changes

laruh previously approved these changes Mar 17, 2025

View reviewed changes

shamardy previously approved these changes Mar 18, 2025

View reviewed changes

mm2src/coins/lp_coins.rs Outdated Show resolved Hide resolved

mm2src/coins/lp_coins.rs Outdated Show resolved Hide resolved

handle tokens

70b217f

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan dismissed stale reviews from shamardy, laruh, and borngraced via 70b217f March 19, 2025 06:04

Merge branch 'dev' of github.com:KomodoPlatform/komodo-defi-framework…

dff50c3

… into staking-query-rpcs

shamardy approved these changes Mar 19, 2025

View reviewed changes

shamardy merged commit cb89300 into dev Mar 19, 2025
24 checks passed

shamardy deleted the staking-query-rpcs branch March 19, 2025 11:49

dimxy pushed a commit that referenced this pull request Mar 20, 2025

Merge branch 'dev' into burn-dex-fee-for-non-kmd

7ace910

* dev: feat(tendermint): staking queries (#2377)

shamardy mentioned this pull request Apr 16, 2025

chore(release): v2.4.0-beta #2345

Merged

Conversation

onur-ozkan commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

laruh left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

onur-ozkan commented Mar 5, 2025

Uh oh!

laruh commented Mar 5, 2025

Uh oh!

onur-ozkan commented Mar 5, 2025

Uh oh!

laruh Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

onur-ozkan Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

laruh Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

onur-ozkan Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

laruh Mar 6, 2025

Choose a reason for hiding this comment

Uh oh!

shamardy Mar 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

borngraced left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

onur-ozkan commented Mar 17, 2025

Uh oh!

borngraced left a comment

Choose a reason for hiding this comment

Uh oh!

laruh left a comment

Choose a reason for hiding this comment

Uh oh!

shamardy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

onur-ozkan commented Feb 27, 2025 •

edited

Loading

laruh left a comment •

edited

Loading

onur-ozkan Mar 6, 2025 •

edited

Loading