-
Notifications
You must be signed in to change notification settings - Fork 323
/
upgrade_chain.rs
196 lines (167 loc) · 6 KB
/
upgrade_chain.rs
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
//! Chain upgrade plans for triggering IBC-breaking upgrades.
#![allow(deprecated)] // TODO(hu55a1n1): remove this when we don't need legacy upgrade support
use core::time::Duration;
use bytes::BufMut;
use flex_error::define_error;
use prost_types::Any;
use ibc::core::ics02_client::client_state::AnyClientState;
use ibc::core::ics02_client::height::Height;
use ibc::core::ics24_host::identifier::{ChainId, ClientId};
use ibc::{clients::ics07_tendermint::client_state::ClientState, events::IbcEvent};
use ibc_proto::cosmos::gov::v1beta1::MsgSubmitProposal;
use ibc_proto::cosmos::upgrade::v1beta1::{Plan, SoftwareUpgradeProposal};
use ibc_proto::ibc::core::client::v1::UpgradeProposal;
use crate::chain::{ChainEndpoint, CosmosSdkChain};
use crate::config::ChainConfig;
use crate::error::Error;
define_error! {
UpgradeChainError {
Query
[ Error ]
|_| { "error during a query" },
Key
[ Error ]
|_| { "key error" },
Submit
{ chain_id: ChainId }
[ Error ]
|e| {
format!("failed while submitting the Transfer message to chain {0}",
e.chain_id)
},
TxResponse
{ event: String }
|e| {
format!("tx response event consists of an error: {}",
e.event)
},
}
}
#[derive(Clone, Debug)]
pub struct UpgradePlanOptions {
pub src_chain_config: ChainConfig,
pub dst_chain_config: ChainConfig,
pub src_client_id: ClientId,
pub amount: u64,
pub height_offset: u64,
pub upgraded_chain_id: ChainId,
pub upgraded_unbonding_period: Option<Duration>,
pub upgrade_plan_name: String,
pub legacy: bool,
}
pub fn build_and_send_ibc_upgrade_proposal(
mut dst_chain: CosmosSdkChain, // the chain which will undergo an upgrade
src_chain: CosmosSdkChain, // the source chain; supplies a client state for building the upgrade plan
opts: &UpgradePlanOptions,
) -> Result<Vec<IbcEvent>, UpgradeChainError> {
let upgrade_height = dst_chain
.query_latest_height()
.map_err(UpgradeChainError::query)?
.add(opts.height_offset);
let client_state = src_chain
.query_client_state(&opts.src_client_id, Height::zero())
.map_err(UpgradeChainError::query)?;
// Retain the old unbonding period in case the user did not specify a new one
let upgraded_unbonding_period = opts
.upgraded_unbonding_period
.unwrap_or(client_state.unbonding_period);
let mut upgraded_client_state = ClientState::zero_custom_fields(client_state);
upgraded_client_state.latest_height = upgrade_height.increment();
upgraded_client_state.unbonding_period = upgraded_unbonding_period;
upgraded_client_state.chain_id = opts.upgraded_chain_id.clone();
let raw_client_state = AnyClientState::Tendermint(upgraded_client_state);
let proposal = UpgradeProposal {
title: "proposal 0".to_string(),
description: "upgrade the chain software and unbonding period".to_string(),
upgraded_client_state: Some(Any::from(raw_client_state)),
plan: Some(Plan {
name: opts.upgrade_plan_name.clone(),
height: upgrade_height.revision_height as i64,
info: "".to_string(),
..Default::default() // deprecated fields - time & upgraded_client_state
}),
};
let proposal = if opts.legacy {
Proposal::Legacy(proposal.into())
} else {
Proposal::Default(proposal)
};
let mut buf_proposal = Vec::new();
proposal.encode(&mut buf_proposal);
let any_proposal = Any {
type_url: proposal.type_url(),
value: buf_proposal,
};
// build the msg submit proposal
let proposer = dst_chain.get_signer().map_err(UpgradeChainError::key)?;
let coins = ibc_proto::cosmos::base::v1beta1::Coin {
denom: "stake".to_string(),
amount: opts.amount.to_string(),
};
let msg = MsgSubmitProposal {
content: Some(any_proposal),
initial_deposit: vec![coins],
proposer: proposer.to_string(),
};
let mut buf_msg = Vec::new();
prost::Message::encode(&msg, &mut buf_msg).unwrap();
let any_msg = Any {
type_url: "/cosmos.gov.v1beta1.MsgSubmitProposal".to_string(),
value: buf_msg,
};
let events = dst_chain
.send_messages_and_wait_commit(vec![any_msg])
.map_err(|e| UpgradeChainError::submit(dst_chain.id().clone(), e))?;
// Check if the chain rejected the transaction
let result = events.iter().find_map(|event| match event {
IbcEvent::ChainError(reason) => Some(reason.clone()),
_ => None,
});
match result {
None => Ok(events),
Some(reason) => Err(UpgradeChainError::tx_response(reason)),
}
}
enum Proposal {
Default(UpgradeProposal),
Legacy(LegacyProposal),
}
impl Proposal {
fn encode(&self, buf: &mut impl BufMut) {
match self {
Proposal::Default(p) => prost::Message::encode(p, buf),
Proposal::Legacy(p) => prost::Message::encode(&p.0, buf),
}
.unwrap()
}
fn type_url(&self) -> String {
match self {
Proposal::Default(_) => "/ibc.core.client.v1.UpgradeProposal",
Proposal::Legacy(_) => "/cosmos.upgrade.v1beta1.SoftwareUpgradeProposal",
}
.to_owned()
}
}
struct LegacyProposal(SoftwareUpgradeProposal);
impl From<UpgradeProposal> for LegacyProposal {
fn from(v: UpgradeProposal) -> Self {
let plan = {
if let Some(plan) = v.plan {
Some(Plan {
name: plan.name,
height: plan.height,
info: plan.info,
time: None,
upgraded_client_state: v.upgraded_client_state,
})
} else {
None
}
};
Self(SoftwareUpgradeProposal {
title: v.title,
description: v.description,
plan,
})
}
}