dydx 0.3.0

dYdX v4 asynchronous client.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use super::*;
use dydx_proto::{
    cosmos_sdk_proto::cosmos::{
        distribution::v1beta1::MsgWithdrawDelegatorReward,
        staking::v1beta1::{MsgDelegate, MsgUndelegate},
    },
    dydxprotocol::affiliates::MsgRegisterAffiliate,
};
use ibc_proto::cosmos::base::query::v1beta1::PageRequest;
use ibc_proto::cosmos::gov::v1::ProposalStatus;
use ibc_proto::cosmos::{
    distribution::v1beta1::{
        QueryDelegationTotalRewardsRequest, QueryDelegationTotalRewardsResponse,
    },
    gov::v1::{Proposal, QueryProposalsRequest},
};

/// [`NodeClient`] Governance requests dispatcher.
pub struct Governance<'a> {
    client: &'a mut NodeClient,
}

impl<'a> Governance<'a> {
    pub(crate) fn new(client: &'a mut NodeClient) -> Self {
        Self { client }
    }

    /// Delegate coins from a delegator to a validator.
    ///
    /// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/governance.rs).
    pub async fn delegate(
        &mut self,
        account: &mut Account,
        delegator: Address,
        validator: Address,
        token: impl Tokenized,
    ) -> Result<TxHash, NodeError> {
        let msg = MsgDelegate {
            delegator_address: delegator.into(),
            validator_address: validator.into(),
            amount: Some(token.coin()?),
        };

        let tx_raw = self.client.create_transaction(account, msg, None).await?;

        self.client.broadcast_transaction(tx_raw).await
    }

    /// Undelegate coins from a delegator to a validator.
    ///
    /// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/governance.rs).
    pub async fn undelegate(
        &mut self,
        account: &mut Account,
        delegator: Address,
        validator: Address,
        token: impl Tokenized,
    ) -> Result<TxHash, NodeError> {
        let msg = MsgUndelegate {
            delegator_address: delegator.into(),
            validator_address: validator.into(),
            amount: Some(token.coin()?),
        };

        let tx_raw = self.client.create_transaction(account, msg, None).await?;

        self.client.broadcast_transaction(tx_raw).await
    }

    /// Delegation withdrawal to a delegator from a validator.
    ///
    /// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/governance.rs).
    pub async fn withdraw_delegator_reward(
        &mut self,
        account: &mut Account,
        delegator: Address,
        validator: Address,
    ) -> Result<TxHash, NodeError> {
        let msg = MsgWithdrawDelegatorReward {
            delegator_address: delegator.into(),
            validator_address: validator.into(),
        };

        let tx_raw = self.client.create_transaction(account, msg, None).await?;

        self.client.broadcast_transaction(tx_raw).await
    }

    /// Register a referee-affiliate relationship.
    ///
    /// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/governance.rs).
    pub async fn register_affiliate(
        &mut self,
        account: &mut Account,
        referee: Address,
        affiliate: Address,
    ) -> Result<TxHash, NodeError> {
        let msg = MsgRegisterAffiliate {
            referee: referee.into(),
            affiliate: affiliate.into(),
        };

        let tx_raw = self.client.create_transaction(account, msg, None).await?;

        self.client.broadcast_transaction(tx_raw).await
    }

    /// Query for the governance proposals.
    ///
    /// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/governance.rs).
    pub async fn get_all_gov_proposals(
        &mut self,
        status: ProposalStatus,
        voter: Address,
        depositor: Address,
        pagination: Option<PageRequest>,
    ) -> Result<Vec<Proposal>, Error> {
        let req = QueryProposalsRequest {
            proposal_status: status.into(),
            voter: voter.into(),
            depositor: depositor.into(),
            pagination,
        };

        let proposals = self
            .client
            .governance
            .proposals(req)
            .await?
            .into_inner()
            .proposals;

        Ok(proposals)
    }

    /// Query the rewards accrued by a delegator.
    ///
    /// Check [the example](https://github.com/dydxprotocol/v4-clients/blob/main/v4-client-rs/client/examples/governance.rs).
    pub async fn get_delegation_total_rewards(
        &mut self,
        delegator_address: Address,
    ) -> Result<QueryDelegationTotalRewardsResponse, Error> {
        let req = QueryDelegationTotalRewardsRequest {
            delegator_address: delegator_address.to_string(),
        };

        let rewards = self
            .client
            .distribution
            .delegation_total_rewards(req)
            .await?
            .into_inner();

        Ok(rewards)
    }
}