Skip to content

Commit

Permalink
updated RelayerVersion documentation to support multiple running rela…
Browse files Browse the repository at this point in the history
…yer versions (see paritytech/parity-bridges-common#2891 for request)
  • Loading branch information
svyatonik committed Apr 23, 2024
1 parent f973f81 commit af38849
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion bridges/primitives/runtime/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,14 @@ where
)]
pub struct RelayerVersion {
/// Version that is increased manually. Increase it every time when something that
/// breaks the relayer and can't be detected with tests is changed.
/// may break already running relayers is changed. This is an always increasing
/// value and relayers that are using older version will immediately shutdown, while
/// relayers using newer value will keep running until runtime is upgraded to that
/// new version.
///
/// **IMPORTANT**: it must be changed every time [`Self::auto`] value is changed.
/// It also msut be changed if [`Self::auto`] stays the same and there's some breaking
/// change that is not detected by tests.
///
/// Every change to this field shall result in building and deploying a new relayer
/// version.
Expand All @@ -551,6 +558,8 @@ pub struct RelayerVersion {
/// tests righteously fail, meaning that something has been changed in pallet/runtime
/// configuration that breaks the existing relayer.
///
/// **IMPORTANT**: do not
///
/// Every change to this field shall result in building and deploying a new relayer
/// version.
pub auto: H256,
Expand Down

0 comments on commit af38849

Please sign in to comment.