Merge pull request #2543 from b-zee/refactor-deprecate-registers

refactor(autonomi): deprecate registers
maidsafe · Dec 16, 2024 · 851a469 · 851a469
2 parents 7309291 + d77e31c
commit 851a469
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 0 deletions.
diff --git a/ant-cli/src/commands/register.rs b/ant-cli/src/commands/register.rs
@@ -6,6 +6,8 @@
 // KIND, either express or implied. Please review the Licences for the specific language governing
 // permissions and limitations relating to use of the SAFE Network Software.
 
+#![allow(deprecated)]
+
 use crate::utils::collect_upload_summary;
 use crate::wallet::load_wallet;
 use autonomi::client::registers::RegisterAddress;

diff --git a/ant-node/tests/data_with_churn.rs b/ant-node/tests/data_with_churn.rs
@@ -6,6 +6,9 @@
 // KIND, either express or implied. Please review the Licences for the specific language governing
 // permissions and limitations relating to use of the SAFE Network Software.
 
+// TODO: Remove this once the registers are removed
+#![expect(deprecated)]
+
 mod common;
 
 use crate::common::{

diff --git a/ant-node/tests/verify_data_location.rs b/ant-node/tests/verify_data_location.rs
@@ -6,7 +6,10 @@
 // KIND, either express or implied. Please review the Licences for the specific language governing
 // permissions and limitations relating to use of the SAFE Network Software.
 
+// TODO: Remove this once the registers are removed
+#![expect(deprecated)]
 #![allow(clippy::mutable_key_type)]
+
 mod common;
 
 use ant_logging::LogBuilder;

diff --git a/autonomi/README.md b/autonomi/README.md
@@ -51,6 +51,10 @@ let wallet = Wallet::new_from_private_key(EvmNetwork::ArbitrumSepolia, key)?;
 let wallet = Wallet::new_from_private_key(EvmNetwork::new_custom("<rpc URL>", "<payment token address>", "<data payment address>"), key)?;
 ```
 
+# Registers
+
+Registers are deprecated and planned to be replaced by transactions and pointers. Currently, transactions can already be used. For example usage, see [the transaction test](tests/transaction.rs). Pointers are not yet implemented, but will follow soon.
+
 ## Running tests
 
 To run the tests, we can run a local network:

diff --git a/autonomi/src/client/registers.rs b/autonomi/src/client/registers.rs
@@ -6,6 +6,8 @@
 // KIND, either express or implied. Please review the Licences for the specific language governing
 // permissions and limitations relating to use of the SAFE Network Software.
 
+#![allow(deprecated)]
+
 use crate::client::data::PayError;
 use crate::client::Client;
 use crate::client::ClientEvent;
@@ -53,6 +55,10 @@ pub enum RegisterError {
     PayeesMissing,
 }
 
+#[deprecated(
+    since = "0.2.4",
+    note = "Use transactions instead (see Client::transaction_put)"
+)]
 #[derive(Clone, Debug)]
 pub struct Register {
     signed_reg: SignedRegister,
@@ -122,6 +128,10 @@ impl Register {
     }
 }
 
+#[deprecated(
+    since = "0.2.4",
+    note = "Use transactions instead (see Client::transaction_put)"
+)]
 impl Client {
     /// Generate a new register key
     pub fn register_generate_key() -> RegisterSecretKey {

diff --git a/autonomi/tests/register.rs b/autonomi/tests/register.rs
@@ -7,6 +7,7 @@
 // permissions and limitations relating to use of the SAFE Network Software.
 
 #![cfg(feature = "registers")]
+#![allow(deprecated)]
 
 use ant_logging::LogBuilder;
 use autonomi::Client;