From af38849b85d133dd3e21f63461b2405b9c1345a9 Mon Sep 17 00:00:00 2001 From: Svyatoslav Nikolsky Date: Tue, 23 Apr 2024 11:08:44 +0300 Subject: [PATCH] updated RelayerVersion documentation to support multiple running relayer versions (see https://github.com/paritytech/parity-bridges-common/issues/2891 for request) --- bridges/primitives/runtime/src/lib.rs | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/bridges/primitives/runtime/src/lib.rs b/bridges/primitives/runtime/src/lib.rs index 7fb5092ae992..35190ebd1fce 100644 --- a/bridges/primitives/runtime/src/lib.rs +++ b/bridges/primitives/runtime/src/lib.rs @@ -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. @@ -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,