From 51e98273d78ebd9c1f2b259c9d67e75780c0192a Mon Sep 17 00:00:00 2001
From: Axay Sagathiya <axaysagathiya@gmail.com>
Date: Thu, 4 Jul 2024 01:07:56 +0530
Subject: [PATCH] rename the candidate backing message from
`GetBackedCandidates` to `GetBackableCandidates` (#4921)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
**Backable Candidate**: If a candidate receives enough supporting
Statements from the Parachain Validators currently assigned, that
candidate is considered backable.
**Backed Candidate**: A Backable Candidate noted in a relay-chain block
---
When the candidate backing subsystem receives the `GetBackedCandidates`
message, it sends back **backable** candidates, not **backed**
candidates. So we should rename this message to `GetBackableCandidates`
Co-authored-by: Bastian Köcher <git@kchr.de>
---
polkadot/node/core/backing/src/lib.rs | 6 +++---
polkadot/node/core/backing/src/tests/mod.rs | 14 +++++++-------
polkadot/node/core/provisioner/src/lib.rs | 2 +-
polkadot/node/core/provisioner/src/tests.rs | 2 +-
polkadot/node/overseer/src/tests.rs | 2 +-
polkadot/node/subsystem-types/src/messages.rs | 2 +-
6 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/polkadot/node/core/backing/src/lib.rs b/polkadot/node/core/backing/src/lib.rs
index 1bda81c5197..5bcd47a2434 100644
--- a/polkadot/node/core/backing/src/lib.rs
+++ b/polkadot/node/core/backing/src/lib.rs
@@ -827,8 +827,8 @@ async fn handle_communication<Context>(
CandidateBackingMessage::Statement(relay_parent, statement) => {
handle_statement_message(ctx, state, relay_parent, statement, metrics).await?;
},
- CandidateBackingMessage::GetBackedCandidates(requested_candidates, tx) =>
- handle_get_backed_candidates_message(state, requested_candidates, tx, metrics)?,
+ CandidateBackingMessage::GetBackableCandidates(requested_candidates, tx) =>
+ handle_get_backable_candidates_message(state, requested_candidates, tx, metrics)?,
CandidateBackingMessage::CanSecond(request, tx) =>
handle_can_second_request(ctx, state, request, tx).await,
}
@@ -2158,7 +2158,7 @@ async fn handle_statement_message<Context>(
}
}
-fn handle_get_backed_candidates_message(
+fn handle_get_backable_candidates_message(
state: &State,
requested_candidates: HashMap<ParaId, Vec<(CandidateHash, Hash)>>,
tx: oneshot::Sender<HashMap<ParaId, Vec<BackedCandidate>>>,
diff --git a/polkadot/node/core/backing/src/tests/mod.rs b/polkadot/node/core/backing/src/tests/mod.rs
index 5f2bc7e1842..10eb45b82d1 100644
--- a/polkadot/node/core/backing/src/tests/mod.rs
+++ b/polkadot/node/core/backing/src/tests/mod.rs
@@ -703,7 +703,7 @@ fn backing_works(#[case] elastic_scaling_mvp: bool) {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
std::iter::once((
test_state.chain_ids[0],
vec![(candidate_a_hash, test_state.relay_parent)],
@@ -895,7 +895,7 @@ fn get_backed_candidate_preserves_order() {
// Happy case, all candidates should be present.
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
[
(
test_state.chain_ids[0],
@@ -946,7 +946,7 @@ fn get_backed_candidate_preserves_order() {
],
] {
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
[
(test_state.chain_ids[0], candidates),
(test_state.chain_ids[1], vec![(candidate_c_hash, test_state.relay_parent)]),
@@ -985,7 +985,7 @@ fn get_backed_candidate_preserves_order() {
],
] {
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
[
(test_state.chain_ids[0], candidates),
(test_state.chain_ids[1], vec![(candidate_c_hash, test_state.relay_parent)]),
@@ -1030,7 +1030,7 @@ fn get_backed_candidate_preserves_order() {
],
] {
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
[
(test_state.chain_ids[0], candidates),
(test_state.chain_ids[1], vec![(candidate_c_hash, test_state.relay_parent)]),
@@ -1321,7 +1321,7 @@ fn backing_works_while_validation_ongoing() {
virtual_overseer.send(FromOrchestra::Communication { msg: statement }).await;
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
std::iter::once((
test_state.chain_ids[0],
vec![(candidate_a.hash(), test_state.relay_parent)],
@@ -1942,7 +1942,7 @@ fn backing_works_after_failed_validation() {
// Try to get a set of backable candidates to trigger _some_ action in the subsystem
// and check that it is still alive.
let (tx, rx) = oneshot::channel();
- let msg = CandidateBackingMessage::GetBackedCandidates(
+ let msg = CandidateBackingMessage::GetBackableCandidates(
std::iter::once((
test_state.chain_ids[0],
vec![(candidate.hash(), test_state.relay_parent)],
diff --git a/polkadot/node/core/provisioner/src/lib.rs b/polkadot/node/core/provisioner/src/lib.rs
index fa16b38d28b..3f622a60a05 100644
--- a/polkadot/node/core/provisioner/src/lib.rs
+++ b/polkadot/node/core/provisioner/src/lib.rs
@@ -822,7 +822,7 @@ async fn select_candidates(
// now get the backed candidates corresponding to these candidate receipts
let (tx, rx) = oneshot::channel();
- sender.send_unbounded_message(CandidateBackingMessage::GetBackedCandidates(
+ sender.send_unbounded_message(CandidateBackingMessage::GetBackableCandidates(
selected_candidates.clone(),
tx,
));
diff --git a/polkadot/node/core/provisioner/src/tests.rs b/polkadot/node/core/provisioner/src/tests.rs
index 0d3675777cb..b38459302c8 100644
--- a/polkadot/node/core/provisioner/src/tests.rs
+++ b/polkadot/node/core/provisioner/src/tests.rs
@@ -578,7 +578,7 @@ mod select_candidates {
)) => tx.send(Ok(Some(Default::default()))).unwrap(),
AllMessages::RuntimeApi(Request(_parent_hash, AvailabilityCores(tx))) =>
tx.send(Ok(mock_availability_cores.clone())).unwrap(),
- AllMessages::CandidateBacking(CandidateBackingMessage::GetBackedCandidates(
+ AllMessages::CandidateBacking(CandidateBackingMessage::GetBackableCandidates(
hashes,
sender,
)) => {
diff --git a/polkadot/node/overseer/src/tests.rs b/polkadot/node/overseer/src/tests.rs
index 177e3addf36..8e78d8fc892 100644
--- a/polkadot/node/overseer/src/tests.rs
+++ b/polkadot/node/overseer/src/tests.rs
@@ -813,7 +813,7 @@ fn test_candidate_validation_msg() -> CandidateValidationMessage {
fn test_candidate_backing_msg() -> CandidateBackingMessage {
let (sender, _) = oneshot::channel();
- CandidateBackingMessage::GetBackedCandidates(Default::default(), sender)
+ CandidateBackingMessage::GetBackableCandidates(Default::default(), sender)
}
fn test_chain_api_msg() -> ChainApiMessage {
diff --git a/polkadot/node/subsystem-types/src/messages.rs b/polkadot/node/subsystem-types/src/messages.rs
index 722a97989bc..ee937bca05b 100644
--- a/polkadot/node/subsystem-types/src/messages.rs
+++ b/polkadot/node/subsystem-types/src/messages.rs
@@ -85,7 +85,7 @@ pub enum CandidateBackingMessage {
/// candidates of the same para that follow it in the input vector. In other words, assuming
/// candidates are supplied in dependency order, we must ensure that this dependency order is
/// preserved.
- GetBackedCandidates(
+ GetBackableCandidates(
HashMap<ParaId, Vec<(CandidateHash, Hash)>>,
oneshot::Sender<HashMap<ParaId, Vec<BackedCandidate>>>,
),
--
GitLab