deprecate messages

Author: curiecrypt

mithril-stm/src/aggregate_signature/aggregate_key.rs

@@ -21,7 +21,10 @@ impl<D: Digest + Clone + FixedOutput> AggregateVerificationKey<D> {
         self.mt_commitment.clone()
     }
 
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `get_merkle_tree_batch_commitment` instead"
+    )]
     pub fn get_mt_commitment(&self) -> MerkleTreeBatchCommitment<D> {
         Self::get_merkle_tree_batch_commitment(self)
     }

mithril-stm/src/aggregate_signature/basic_verifier.rs

@@ -45,7 +45,7 @@ impl BasicVerifier {
     ///     * Collect the unique signers in a hash set,
     ///     * Calculate the total stake of the eligible signers,
     ///     * Sort the eligible signers.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `new` instead")]
     pub fn setup(public_signers: &[(BlsVerificationKey, Stake)]) -> Self {
         Self::new(public_signers)
     }
@@ -88,7 +88,7 @@ impl BasicVerifier {
     /// If there is no sufficient signatures, then the function fails.
     // todo: We need to agree on a criteria to dedup (by default we use a BTreeMap that guarantees keys order)
     // todo: not good, because it only removes index if there is a conflict (see benches)
-    pub(crate) fn select_valid_signatures_for_k_indices(
+    pub fn select_valid_signatures_for_k_indices(
         total_stake: &Stake,
         params: &Parameters,
         msg: &[u8],
@@ -180,7 +180,10 @@ impl BasicVerifier {
     /// If there is no sufficient signatures, then the function fails.
     // todo: We need to agree on a criteria to dedup (by default we use a BTreeMap that guarantees keys order)
     // todo: not good, because it only removes index if there is a conflict (see benches)
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `select_valid_signatures_for_k_indices` instead"
+    )]
     pub fn dedup_sigs_for_indices(
         total_stake: &Stake,
         params: &Parameters,

mithril-stm/src/aggregate_signature/clerk.rs

@@ -28,7 +28,10 @@ impl<D: Digest + Clone + FixedOutput> Clerk<D> {
     }
 
     /// Create a new `Clerk` from a closed registration instance.
-    #[deprecated(since = "0.4.9", note = "Use `new_clerk_from_closed_key_registration` instead")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `new_clerk_from_closed_key_registration` instead"
+    )]
     pub fn from_registration(params: &Parameters, closed_reg: &ClosedKeyRegistration<D>) -> Self {
         Self::new_clerk_from_closed_key_registration(params, closed_reg)
     }
@@ -120,9 +123,12 @@ impl<D: Digest + Clone + FixedOutput> Clerk<D> {
     }
 
     /// Compute the `AggregateVerificationKey` related to the used registration.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `compute_aggregate_verification_key` instead"
+    )]
     pub fn compute_avk(&self) -> AggregateVerificationKey<D> {
-        Clerk::compute_aggregate_verification_key(self)
+        Self::compute_aggregate_verification_key(self)
     }
 
     /// Get the (VK, stake) of a party given its index.
@@ -137,8 +143,8 @@ impl<D: Digest + Clone + FixedOutput> Clerk<D> {
     }
 
     /// Get the (VK, stake) of a party given its index.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `get_registered_party_for_index` instead")]
     pub fn get_reg_party(&self, party_index: &Index) -> Option<(VerificationKey, Stake)> {
-        Clerk::get_registered_party_for_index(self, party_index)
+        Self::get_registered_party_for_index(self, party_index)
     }
 }

mithril-stm/src/bls_multi_signature/verification_key.rs

@@ -164,9 +164,9 @@ impl BlsVerificationKeyProofOfPossession {
     /// manually.
     // If we are really looking for performance improvements, we can combine the
     // two final exponentiations (for verifying k1 and k2) into a single one.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `verify_proof_of_possesion` instead")]
     pub fn check(&self) -> Result<(), MultiSignatureError> {
-        BlsVerificationKeyProofOfPossession::verify_proof_of_possesion(self)
+        Self::verify_proof_of_possesion(self)
     }
 
     /// Convert to a 144 byte string.

mithril-stm/src/merkle_tree/commitment.rs

@@ -56,7 +56,10 @@ impl<D: Digest + FixedOutput> MerkleTreeCommitment<D> {
     /// Check an inclusion proof that `val` is part of the tree by traveling the whole path until the root.
     /// # Error
     /// If the merkle tree path is invalid, then the function fails.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `verify_leaf_membership_from_path` instead"
+    )]
     pub fn check(
         &self,
         val: &MerkleTreeLeaf,
@@ -65,7 +68,7 @@ impl<D: Digest + FixedOutput> MerkleTreeCommitment<D> {
     where
         D: FixedOutput + Clone,
     {
-        MerkleTreeCommitment::verify_leaf_membership_from_path(self, val, proof)
+        Self::verify_leaf_membership_from_path(self, val, proof)
     }
 
     /// Serializes the Merkle Tree commitment together with a message in a single vector of bytes.
@@ -83,12 +86,12 @@ impl<D: Digest + FixedOutput> MerkleTreeCommitment<D> {
 
     /// Serializes the Merkle Tree commitment together with a message in a single vector of bytes.
     /// Outputs `msg || self` as a vector of bytes.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `concatenate_with_message` instead")]
     pub fn concat_with_msg(&self, msg: &[u8]) -> Vec<u8>
     where
         D: Digest,
     {
-        MerkleTreeCommitment::concatenate_with_message(self, msg)
+        Self::concatenate_with_message(self, msg)
     }
 }
 
@@ -133,9 +136,9 @@ impl<D: Digest> MerkleTreeBatchCommitment<D> {
     /// Serializes the Merkle Tree commitment together with a message in a single vector of bytes.
     /// Outputs `msg || self` as a vector of bytes.
     // todo: Do we need to concat msg to whole commitment (nr_leaves and root) or just the root?
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `concatenate_with_message` instead")]
     pub fn concat_with_msg(&self, msg: &[u8]) -> Vec<u8> {
-        MerkleTreeBatchCommitment::concatenate_with_message(self, msg)
+        Self::concatenate_with_message(self, msg)
     }
 
     /// Check a proof of a batched opening. The indices must be ordered.
@@ -237,7 +240,10 @@ impl<D: Digest> MerkleTreeBatchCommitment<D> {
     // todo: Update doc.
     // todo: Simplify the algorithm.
     // todo: Maybe we want more granular errors, rather than only `BatchPathInvalid`
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `verify_leaves_membership_from_batch_path` instead"
+    )]
     pub fn check(
         &self,
         batch_val: &[MerkleTreeLeaf],
@@ -246,7 +252,7 @@ impl<D: Digest> MerkleTreeBatchCommitment<D> {
     where
         D: FixedOutput + Clone,
     {
-        MerkleTreeBatchCommitment::verify_leaves_membership_from_batch_path(self, batch_val, proof)
+        Self::verify_leaves_membership_from_batch_path(self, batch_val, proof)
     }
 }
 

mithril-stm/src/merkle_tree/tree.rs

@@ -64,9 +64,9 @@ impl<D: Digest + FixedOutput> MerkleTree<D> {
     }
 
     /// Provided a non-empty list of leaves, `create` generates its corresponding `MerkleTree`.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `new` instead")]
     pub fn create(leaves: &[MerkleTreeLeaf]) -> MerkleTree<D> {
-        MerkleTree::new(leaves)
+        Self::new(leaves)
     }
 
     /// Return the index of the leaf.
@@ -82,9 +82,12 @@ impl<D: Digest + FixedOutput> MerkleTree<D> {
 
     /// Convert merkle tree to a batch compatible commitment.
     /// This function simply returns the root and the number of leaves in the tree.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `to_merkle_tree_batch_commitment` instead"
+    )]
     pub fn to_commitment_batch_compat(&self) -> MerkleTreeBatchCommitment<D> {
-        MerkleTree::to_merkle_tree_batch_commitment(self)
+        Self::to_merkle_tree_batch_commitment(self)
     }
 
     /// Get a path for a batch of leaves. The indices must be ordered. We use the Octopus algorithm to
@@ -166,12 +169,12 @@ impl<D: Digest + FixedOutput> MerkleTree<D> {
     /// If the indices provided are out of bounds (higher than the number of elements
     /// committed in the `MerkleTree`) or are not ordered, the function fails.
     // todo: Update doc.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `compute_merkle_tree_batch_path` instead")]
     pub fn get_batched_path(&self, indices: Vec<usize>) -> MerkleBatchPath<D>
     where
         D: FixedOutput,
     {
-        MerkleTree::compute_merkle_tree_batch_path(self, indices)
+        Self::compute_merkle_tree_batch_path(self, indices)
     }
 
     /// Convert a `MerkleTree` into a byte string, containing $4 + n * S$ bytes where $n$ is the
@@ -223,9 +226,9 @@ impl<D: Digest + FixedOutput> MerkleTree<D> {
     }
 
     /// Convert merkle tree to a commitment. This function simply returns the root.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `to_merkle_tree_commitment` instead")]
     pub fn to_commitment(&self) -> MerkleTreeCommitment<D> {
-        MerkleTree::to_merkle_tree_commitment(self)
+        Self::to_merkle_tree_commitment(self)
     }
 
     /// Get a path (hashes of siblings of the path to the root node)
@@ -257,9 +260,9 @@ impl<D: Digest + FixedOutput> MerkleTree<D> {
     /// Get a path (hashes of siblings of the path to the root node)
     /// for the `i`th value stored in the tree.
     /// Requires `i < self.n`
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `compute_merkle_tree_path` instead")]
     pub fn get_path(&self, i: usize) -> MerklePath<D> {
-        MerkleTree::compute_merkle_tree_path(self, i)
+        Self::compute_merkle_tree_path(self, i)
     }
 }
 

mithril-stm/src/participant/initializer.rs

@@ -41,9 +41,9 @@ impl Initializer {
 
     /// Builds an `Initializer` that is ready to register with the key registration service.
     /// This function generates the signing and verification key with a PoP, and initialises the structure.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `new` instead")]
     pub fn setup<R: RngCore + CryptoRng>(params: Parameters, stake: Stake, rng: &mut R) -> Self {
-        Initializer::new(params, stake, rng)
+        Self::new(params, stake, rng)
     }
 
     /// Extract the verification key with proof of possession.
@@ -52,9 +52,12 @@ impl Initializer {
     }
 
     /// Extract the verification key.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(
+        since = "0.4.9",
+        note = "Use `get_verification_key_proof_of_possession` instead"
+    )]
     pub fn verification_key(&self) -> VerificationKeyProofOfPossession {
-        Initializer::get_verification_key_proof_of_possession(self)
+        Self::get_verification_key_proof_of_possession(self)
     }
 
     /// Build the `avk` for the given list of parties.
@@ -106,15 +109,15 @@ impl Initializer {
     /// * the current total stake (according to the registration service)
     /// # Error
     /// This function fails if the initializer is not registered.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `create_signer` instead")]
     pub fn new_signer<D: Digest + Clone + FixedOutput>(
         self,
         closed_reg: ClosedKeyRegistration<D>,
     ) -> Result<Signer<D>, RegisterError> {
-        Initializer::create_signer(self, closed_reg)
+        Self::create_signer(self, closed_reg)
     }
 
-    /// Creates a new core signer that does not include closed registration.
+    /// Creates a new basic signer that does not include closed registration.
     /// Takes `eligible_parties` as a parameter and determines the signer's index in the parties.
     /// `eligible_parties` is verified and trusted which is only run by a full-node
     /// that has already verified the parties.
@@ -144,16 +147,16 @@ impl Initializer {
         }
     }
 
-    /// Creates a new core signer that does not include closed registration.
+    /// Creates a new basic signer that does not include closed registration.
     /// Takes `eligible_parties` as a parameter and determines the signer's index in the parties.
     /// `eligible_parties` is verified and trusted which is only run by a full-node
     /// that has already verified the parties.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `create_basic_signer` instead")]
     pub fn new_core_signer<D: Digest + Clone + FixedOutput>(
         self,
         eligible_parties: &[RegisteredParty],
     ) -> Option<Signer<D>> {
-        Initializer::create_basic_signer(self, eligible_parties)
+        Self::create_basic_signer(self, eligible_parties)
     }
 
     /// Convert to bytes

mithril-stm/src/participant/signer.rs

@@ -46,7 +46,7 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
     }
 
     /// Create a Signer for given input
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `set_signer` instead")]
     pub fn set_stm_signer(
         signer_index: u64,
         stake: Stake,
@@ -55,7 +55,7 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
         vk: VerificationKey,
         closed_reg: ClosedKeyRegistration<D>,
     ) -> Signer<D> {
-        Signer::set_signer(signer_index, stake, params, sk, vk, closed_reg)
+        Self::set_signer(signer_index, stake, params, sk, vk, closed_reg)
     }
 
     /// Create a basic signer (no registration data) for given input
@@ -77,15 +77,15 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
     }
 
     /// Create a core signer (no registration data) for given input
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `set_basic_signer` instead")]
     pub fn set_core_signer(
         signer_index: u64,
         stake: Stake,
         params: Parameters,
         sk: BlsSigningKey,
         vk: VerificationKey,
     ) -> Signer<D> {
-        Signer::set_basic_signer(signer_index, stake, params, sk, vk)
+        Self::set_basic_signer(signer_index, stake, params, sk, vk)
     }
 
     /// This function produces a signature following the description of Section 2.4.
@@ -115,7 +115,7 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
     }
 
     /// Extract the verification key.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `get_verification_key` instead")]
     pub fn verification_key(&self) -> VerificationKey {
         Self::get_verification_key(self)
     }
@@ -125,8 +125,8 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
         self.stake
     }
 
-    /// A core signature generated without closed registration.
-    /// The core signature can be verified by core verifier.
+    /// A basic signature generated without closed key registration.
+    /// The basic signature can be verified by basic verifier.
     /// Once the signature is produced, this function checks whether any index in `[0,..,self.params.m]`
     /// wins the lottery by evaluating the dense mapping.
     /// It records all the winning indexes in `Self.indexes`.
@@ -145,14 +145,14 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
         }
     }
 
-    /// A core signature generated without closed registration.
-    /// The core signature can be verified by core verifier.
+    /// A basic signature generated without closed key registration.
+    /// The basic signature can be verified by basic verifier.
     /// Once the signature is produced, this function checks whether any index in `[0,..,self.params.m]`
     /// wins the lottery by evaluating the dense mapping.
     /// It records all the winning indexes in `Self.indexes`.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `basic_sign` instead")]
     pub fn core_sign(&self, msg: &[u8], total_stake: Stake) -> Option<SingleSignature> {
-        Signer::basic_sign(self, msg, total_stake)
+        Self::basic_sign(self, msg, total_stake)
     }
 
     /// Collects and returns the winning indices.
@@ -177,9 +177,9 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
     }
 
     /// Get Parameters
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `get_parameters` instead")]
     pub fn get_params(&self) -> Parameters {
-        Signer::get_parameters(self)
+        Self::get_parameters(self)
     }
 
     /// Get closed key registration
@@ -188,8 +188,8 @@ impl<D: Clone + Digest + FixedOutput> Signer<D> {
     }
 
     /// Get closed key registration
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `get_closed_key_registration` instead")]
     pub fn get_closed_reg(&self) -> Option<ClosedKeyRegistration<D>> {
-        Signer::get_closed_key_registration(self)
+        Self::get_closed_key_registration(self)
     }
 }

mithril-stm/src/single_signature/signature.rs

@@ -153,7 +153,7 @@ impl SingleSignature {
     }
 
     /// Will be deprecated. Use `basic_verify` instead.
-    #[deprecated(since = "0.4.9", note = "This function will be removed")]
+    #[deprecated(since = "0.4.9", note = "Use `basic_verify` instead")]
     pub fn core_verify(
         &self,
         params: &Parameters,