1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
// Copyright 2024 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// 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.
use crate::{wallet::StoragePaymentResult, Client, Error, Result, WalletClient};
use bls::PublicKey;
use crdts::merkle_reg::MerkleReg;
use libp2p::{
kad::{Quorum, Record},
PeerId,
};
use sn_networking::{GetRecordCfg, PutRecordCfg, VerificationKind};
use sn_protocol::{
error::Error as ProtocolError,
messages::RegisterCmd,
storage::{try_serialize_record, RecordKind, RetryStrategy},
NetworkAddress,
};
use sn_registers::{Entry, EntryHash, Permissions, Register, RegisterAddress, SignedRegister};
use sn_transfers::{NanoTokens, Payment};
use std::collections::{BTreeSet, HashSet, LinkedList};
use xor_name::XorName;
/// Cached operations made to an offline Register instance are applied locally only,
/// and accumulated until the user explicitly calls 'sync'. The user can
/// switch back to sync with the network for every op by invoking `online` API.
#[derive(Clone, custom_debug::Debug)]
pub struct ClientRegister {
#[debug(skip)]
client: Client,
pub(crate) register: Register,
ops: LinkedList<RegisterCmd>, // Cached operations.
}
impl ClientRegister {
fn create_register(client: Client, meta: XorName, perms: Permissions) -> Self {
let public_key = client.signer_pk();
let register = Register::new(public_key, meta, perms);
Self {
client,
register,
ops: LinkedList::new(),
}
}
/// Create a new Register Locally.
/// # Arguments
/// * 'client' - [Client]
/// * 'meta' - [XorName]
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// // Here we create a ClientRegister
/// let register = ClientRegister::create(client.clone(), address);
/// # Ok(())
/// # }
/// ```
pub fn create(client: Client, meta: XorName) -> Self {
Self::create_register(client, meta, Permissions::default())
}
/// Create a new Register locally with a specific address.
/// # Arguments
/// * 'client' - [Client]
/// * 'addr' - [RegisterAddress]
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use sn_protocol::storage::RegisterAddress;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = RegisterAddress::new(XorName::random(&mut rng), client.signer_pk());
/// // Here we create a ClientRegister
/// let register = ClientRegister::create_with_addr(client.clone(), address);
/// # Ok(())
/// # }
/// ```
pub fn create_with_addr(client: Client, addr: RegisterAddress) -> Self {
let register = Register::new(addr.owner(), addr.meta(), Permissions::default());
Self {
client,
register,
ops: LinkedList::new(),
}
}
/// Create a new Register and send it to the Network.
///
/// # Arguments
/// * 'client' - [Client]
/// * 'meta' - [XorName]
/// * 'wallet_client' - A borrowed mutable [WalletClient]
/// * `verify_store` - A boolean to verify store. Set this to true for mandatory verification.
/// * 'perms' - [Permissions]
///
/// Return type: Result<(Self, [NanoTokens], [NanoTokens])>
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # use tempfile::TempDir;
/// # use sn_client::WalletClient;
/// # use sn_registers::Permissions;
/// # use sn_transfers::{HotWallet, MainSecretKey};
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let temporary_path = TempDir::new()?.path().to_owned();
/// # let main_secret_key = Some(MainSecretKey::new(SecretKey::random()));
/// # let mut wallet = HotWallet::load_from_path(&temporary_path,main_secret_key)?;
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// let permissions = Permissions::default();
/// // Instantiate a new Register replica from a predefined address.
/// // The create_online function runs a [sync](ClientRegister::sync) internally.
/// let (client_register, mut total_cost, mut total_royalties) = ClientRegister::create_online(
/// client,
/// address,
/// &mut wallet_client,
/// false,
/// permissions,
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_online(
client: Client,
meta: XorName,
wallet_client: &mut WalletClient,
verify_store: bool,
perms: Permissions,
) -> Result<(Self, NanoTokens, NanoTokens)> {
let mut reg = Self::create_register(client, meta, perms);
let (storage_cost, royalties_fees) = reg.sync(wallet_client, verify_store, None).await?;
Ok((reg, storage_cost, royalties_fees))
}
/// Retrieve a Register from the network to work on it offline.
pub(super) async fn retrieve(client: Client, address: RegisterAddress) -> Result<Self> {
let register = Self::get_register_from_network(&client, address).await?;
Ok(Self {
client,
register,
ops: LinkedList::new(),
})
}
/// Return type: [RegisterAddress]
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # use tempfile::TempDir;
/// # use sn_client::WalletClient;
/// # use sn_registers::Permissions;
/// # use sn_transfers::{HotWallet, MainSecretKey};
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let temporary_path = TempDir::new()?.path().to_owned();
/// # let main_secret_key = Some(MainSecretKey::new(SecretKey::random()));
/// # let mut wallet = HotWallet::load_from_path(&temporary_path,main_secret_key)?;
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// # let address = XorName::random(&mut rng);
/// # let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// # let permissions = Permissions::default();
/// // Instantiate a ClientRegister (i.e. with create_online)
/// let (client_register, mut cost, mut royalties) = ClientRegister::create_online//(...)
/// # (client,address,&mut wallet_client,false,permissions,).await?;
/// // From there we can use the address. In this example, we print it out:
/// println!("REGISTER_ADDRESS={}", client_register.address().to_hex());
/// # Ok(())
/// # }
/// ```
pub fn address(&self) -> &RegisterAddress {
self.register.address()
}
/// Returns the Owner of the Register.
///
/// Return type: [PublicKey]
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # use tempfile::TempDir;
/// # use sn_client::WalletClient;
/// # use sn_registers::Permissions;
/// # use sn_transfers::{HotWallet, MainSecretKey};
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let temporary_path = TempDir::new()?.path().to_owned();
/// # let main_secret_key = Some(MainSecretKey::new(SecretKey::random()));
/// # let mut wallet = HotWallet::load_from_path(&temporary_path,main_secret_key)?;
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// # let address = XorName::random(&mut rng);
/// # let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// # let permissions = Permissions::default();
/// // Instantiate a ClientRegister (i.e. with create_online)
/// let (client_register, mut cost, mut royalties) = ClientRegister::create_online//(...)
/// # (client,address,&mut wallet_client,false,permissions,).await?;
/// // From there we can use the owner. In this example, we print it out:
/// println!("REGISTER_OWNER={}", client_register.owner().to_hex());
/// # Ok(())
/// # }
/// ```
pub fn owner(&self) -> PublicKey {
self.register.owner()
}
/// Returns the Permissions of the Register.
///
/// Return type: [Permissions]
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # use tempfile::TempDir;
/// # use sn_client::WalletClient;
/// # use sn_registers::Permissions;
/// # use sn_transfers::{HotWallet, MainSecretKey};
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let temporary_path = TempDir::new()?.path().to_owned();
/// # let main_secret_key = Some(MainSecretKey::new(SecretKey::random()));
/// # let mut wallet = HotWallet::load_from_path(&temporary_path,main_secret_key)?;
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// # let address = XorName::random(&mut rng);
/// let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// let permissions = Permissions::default();
/// // Instantiate a ClientRegister (i.e. with create_online)
/// let (client_register, mut cost, mut royalties) = ClientRegister::create_online//(...)
/// # (client,address,&mut wallet_client,false,permissions,).await?;
/// // From there we can use the permissions. In this example, we print it out:
/// let permissions = client_register.permissions();
/// println!("REGISTER_PERMS={:?}",permissions);
/// # Ok(())
/// # }
/// ```
pub fn permissions(&self) -> &Permissions {
self.register.permissions()
}
/// Return the number of items held in the register.
///
/// Return type: u64
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # use tempfile::TempDir;
/// # use sn_client::WalletClient;
/// # use sn_registers::Permissions;
/// # use sn_transfers::{HotWallet, MainSecretKey};
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let temporary_path = TempDir::new()?.path().to_owned();
/// # let main_secret_key = Some(MainSecretKey::new(SecretKey::random()));
/// # let mut wallet = HotWallet::load_from_path(&temporary_path,main_secret_key)?;
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// # let address = XorName::random(&mut rng);
/// # let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// # let permissions = Permissions::default();
/// // Instantiate a ClientRegister (i.e. with create_online)
/// let (client_register, mut cost, mut royalties) = ClientRegister::create_online//(...)
/// # (client,address,&mut wallet_client,false,permissions,).await?;
/// // From there we can see the size. In this example, we print it out:
/// println!("REGISTER_SIZE={}", client_register.size());
/// # Ok(())
/// # }
/// ```
pub fn size(&self) -> u64 {
self.register.size()
}
/// Return a value corresponding to the provided 'hash', if present.
// No usages found in All Places
pub fn get(&self, hash: EntryHash) -> Result<&Entry> {
let entry = self.register.get(hash)?;
Ok(entry)
}
/// Read the last entry, or entries when there are branches, if the register is not empty.
///
/// Return type: [BTreeSet]<([EntryHash], [Entry])>
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// // Read as bytes into the ClientRegister instance
/// let register = ClientRegister::create(client.clone(), address).read();
/// # Ok(())
/// # }
/// ```
pub fn read(&self) -> BTreeSet<(EntryHash, Entry)> {
self.register.read()
}
/// Write a new value onto the Register atop latest value.
/// It returns an error if it finds branches in the content/entries; if it is
/// required to merge/resolve the branches, invoke the `write_merging_branches` API.
///
/// # Arguments
/// * 'entry' - u8 (i.e .as_bytes)
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// let entry = "Register entry";
/// // Write as bytes into the ClientRegister instance
/// let mut register = ClientRegister::create(client.clone(), address).write(entry.as_bytes());
/// # Ok(())
/// # }
/// ```
pub fn write(&mut self, entry: &[u8]) -> Result<EntryHash> {
let children = self.register.read();
if children.len() > 1 {
return Err(Error::ContentBranchDetected(children));
}
self.write_atop(entry, &children.into_iter().map(|(hash, _)| hash).collect())
}
/// Write a new value onto the Register atop of the latest value.
/// If there are any branches of content or entries, it automatically merges them.
/// Leaving the new value as a single latest value on the Register.
/// Note you can use the `write` API if you need to handle
/// content/entries branches in a different way.
///
/// # Arguments
/// * 'entry' - u8 (i.e .as_bytes)
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// let entry = "entry_input_here";
/// let mut mutable_register = ClientRegister::create(client.clone(), address);
/// let message = "Register entry";
/// let register = mutable_register.write_merging_branches(message.as_bytes());
/// # Ok(())
/// # }
/// ```
pub fn write_merging_branches(&mut self, entry: &[u8]) -> Result<EntryHash> {
let children: BTreeSet<EntryHash> = self
.register
.read()
.into_iter()
.map(|(hash, _)| hash)
.collect();
self.write_atop(entry, &children)
}
/// Write a new value onto the Register atop the set of branches/entries
/// referenced by the provided list of their corresponding entry hash.
/// Note you can use `write_merging_branches` API instead if you
/// want to write atop all exiting branches/entries.
///
/// # Arguments
/// * 'entry' - u8 (i.e .as_bytes)
/// * 'children' - [BTreeSet]<[EntryHash]>
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # use std::collections::BTreeSet;
/// let mut rng = rand::thread_rng();
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// let mut mutable_register = ClientRegister::create(client.clone(), address);
/// let meta = "Register entry".as_bytes();
/// let register = mutable_register.write_atop(meta, &BTreeSet::default());
/// # Ok(())
/// # }
/// ```
pub fn write_atop(
&mut self,
entry: &[u8],
children: &BTreeSet<EntryHash>,
) -> Result<EntryHash> {
// check permissions first
let public_key = self.client.signer_pk();
self.register.check_user_permissions(public_key)?;
let (entry_hash, op) = self
.register
.write(entry.into(), children, self.client.signer())?;
let cmd = RegisterCmd::Edit(op);
self.ops.push_front(cmd);
Ok(entry_hash)
}
// ********* Online methods *********
/// Sync this Register with the replicas on the network.
/// This will optionally verify the stored Register on the network is the same as the local one.
/// If payment info is provided it won't try to make the payment.
///
/// # Arguments
/// * 'wallet_client' - WalletClient
/// * 'verify_store' - Boolean
///
/// Return type:
/// Result<([NanoTokens], [NanoTokens])>
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # use std::collections::BTreeSet;
/// # use tempfile::TempDir;
/// # use sn_client::WalletClient;
/// # use sn_transfers::{HotWallet, MainSecretKey};
/// # let mut rng = rand::thread_rng();
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// # let temporary_path = TempDir::new()?.path().to_owned();
/// # let main_secret_key = Some(MainSecretKey::new(SecretKey::random()));
/// # let mut wallet = HotWallet::load_from_path(&temporary_path,main_secret_key)?;
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// // Run sync of a Client Register instance
/// let mut register =
/// ClientRegister::create(client, address).sync(&mut wallet_client, true, None).await?;
/// # Ok(())
/// # }
/// ```
pub async fn sync(
&mut self,
wallet_client: &mut WalletClient,
verify_store: bool,
mut payment_info: Option<(Payment, PeerId)>,
) -> Result<(NanoTokens, NanoTokens)> {
let addr = *self.address();
debug!("Syncing Register at {addr:?}!");
let mut storage_cost = NanoTokens::zero();
let mut royalties_fees = NanoTokens::zero();
let reg_result = if verify_store {
debug!("VERIFYING REGISTER STORED {:?}", self.address());
let res = if payment_info.is_some() {
// we expect this to be a _fresh_ register.
// It still could have been PUT previously, but we'll do a quick verification
// instead of thorough one.
self.client
.quickly_check_if_register_stored(*self.address())
.await
} else {
self.client.verify_register_stored(*self.address()).await
};
// we need to keep the error here if verifying, so we can retry and pay for storage
// once more below
match res {
Ok(r) => Ok(r.register()?),
Err(error) => Err(error),
}
} else {
Self::get_register_from_network(&self.client, addr).await
};
let remote_replica = match reg_result {
Ok(r) => r,
// any error here will result in a repayment of the register
// TODO: be smart about this and only pay for storage if we need to
Err(err) => {
debug!("Failed to fetch register: {err:?}");
debug!("Creating Register as it doesn't exist at {addr:?}!");
let cmd = RegisterCmd::Create {
register: self.register.clone(),
signature: self.client.sign(self.register.bytes()?),
};
// Let's check if the user has already paid for this address first
if payment_info.is_none() {
let net_addr = NetworkAddress::RegisterAddress(addr);
let payment_result = self.make_payment(wallet_client, &net_addr).await?;
storage_cost = payment_result.storage_cost;
royalties_fees = payment_result.royalty_fees;
// Get payment proofs needed to publish the Register
let (payment, payee) = wallet_client.get_recent_payment_for_addr(&net_addr)?;
debug!("payments found: {payment:?}");
payment_info = Some((payment, payee));
}
Self::publish_register(self.client.clone(), cmd, payment_info, verify_store)
.await?;
self.register.clone()
}
};
self.register.merge(&remote_replica)?;
self.push(verify_store).await?;
Ok((storage_cost, royalties_fees))
}
/// Push all operations made locally to the replicas of this Register on the network.
/// This optionally verifies that the stored Register is the same as our local register.
///
/// # Arguments
/// * 'verify_store' - Boolean
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// let address = XorName::random(&mut rng);
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Pass the boolean value to the Client Register instance via .Push()
/// let mut binding = ClientRegister::create(client, address);
/// let register = binding.push(false);
/// # Ok(())
/// # }
/// ```
pub async fn push(&mut self, verify_store: bool) -> Result<()> {
let ops_len = self.ops.len();
if ops_len > 0 {
let address = *self.address();
debug!("Pushing {ops_len} cached Register cmds at {address}!");
// TODO: send them all concurrently
while let Some(cmd) = self.ops.pop_back() {
// We don't need to send the payment proofs here since
// these are all Register mutation cmds which don't require payment.
let result =
Self::publish_register(self.client.clone(), cmd.clone(), None, verify_store)
.await;
if let Err(err) = result {
warn!("Did not push Register cmd on all nodes in the close group!: {err}");
// We keep the cmd for next sync to retry
self.ops.push_back(cmd);
return Err(err);
}
}
debug!("Successfully pushed {ops_len} Register cmds at {address}!");
}
Ok(())
}
/// Write a new value onto the Register atop of the latest value.
/// It returns an error if it finds branches in the content / entries. If so, then it's
/// required to merge or resolve the branches. In that case, invoke the `write_merging_branches` API.
///
/// # Arguments
/// * 'entry' - u8 (i.e .as_bytes)
/// * 'verify_store' - Boolean
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let meta = "Register entry".as_bytes();
/// // Use of the 'write_online' example:
/// let mut binding = ClientRegister::create(client, address);
/// let register = binding.write_online(meta,false);
/// # Ok(())
/// # }
/// ```
pub async fn write_online(&mut self, entry: &[u8], verify_store: bool) -> Result<()> {
self.write(entry)?;
self.push(verify_store).await
}
/// Write a new value onto the Register atop of the latest value.
/// If there are branches of content/entries, it will automatically merge them.
/// This will leave a single new value as the latest entry into the Register.
/// Note that you can use the `write` API if you need to handle content/entries branches in a different way.
///
/// # Arguments
/// * 'entry' - u8 (i.e .as_bytes)
/// * 'verify_store' - Boolean
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # let mut rng = rand::thread_rng();
/// # let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let address = XorName::random(&mut rng);
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let meta = "Entry".as_bytes();
/// // Use of the 'write_merging_branches_online':
/// let mut binding = ClientRegister::create(client, address);
/// let register = binding.write_merging_branches_online(meta,false);
/// # Ok(())
/// # }
/// ```
pub async fn write_merging_branches_online(
&mut self,
entry: &[u8],
verify_store: bool,
) -> Result<()> {
self.write_merging_branches(entry)?;
self.push(verify_store).await
}
/// Write a new value onto the Register atop the set of branches/entries
/// referenced by the provided list to their corresponding entry hash.
/// Note you can use `write_merging_branches` API if you
/// want to write atop of all exiting branches/entries instead.
///
/// # Arguments
/// * 'entry' - u8 (i.e .as_bytes)
/// * 'children' - [BTreeSet]<[EntryHash]>
/// * 'verify_store' - Boolean
///
/// Return type:
///
/// # Example
/// ```no_run
/// # use sn_client::{Client, ClientRegister, Error};
/// # use bls::SecretKey;
/// # use xor_name::XorName;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// # use std::collections::BTreeSet;
/// let mut rng = rand::thread_rng();
/// let address = XorName::random(&mut rng);
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let entry = "Entry".as_bytes();
/// let tree_set = BTreeSet::new();
/// // Use of the 'write_atop_online':
/// let mut binding = ClientRegister::create(client, address);
/// let mut register = binding.write_atop_online(entry,&tree_set,false);
/// # Ok(())
/// # }
/// ```
pub async fn write_atop_online(
&mut self,
entry: &[u8],
children: &BTreeSet<EntryHash>,
verify_store: bool,
) -> Result<()> {
self.write_atop(entry, children)?;
self.push(verify_store).await
}
/// Access the underlying MerkleReg (e.g. for access to history)
/// NOTE: This API is unstable and may be removed in the future
pub fn merkle_reg(&self) -> &MerkleReg<Entry> {
self.register.merkle_reg()
}
// ********* Private helpers *********
// Make a storage payment for the provided network address
async fn make_payment(
&self,
wallet_client: &mut WalletClient,
net_addr: &NetworkAddress,
) -> Result<StoragePaymentResult> {
// Let's make the storage payment
let payment_result = wallet_client
.pay_for_storage(std::iter::once(net_addr.clone()))
.await?;
let cost = payment_result
.storage_cost
.checked_add(payment_result.royalty_fees)
.ok_or(Error::TotalPriceTooHigh)?;
println!("Successfully made payment of {cost} for a Register (At a cost per record of {cost:?}.)");
info!("Successfully made payment of {cost} for a Register (At a cost per record of {cost:?}.)");
if let Err(err) = wallet_client.store_local_wallet() {
warn!("Failed to store wallet with cached payment proofs: {err:?}");
println!("Failed to store wallet with cached payment proofs: {err:?}");
} else {
println!(
"Successfully stored wallet with cached payment proofs, and new balance {}.",
wallet_client.balance()
);
info!(
"Successfully stored wallet with cached payment proofs, and new balance {}.",
wallet_client.balance()
);
}
Ok(payment_result)
}
/// Publish a `Register` command on the network.
/// If `verify_store` is true, it will verify the Register was stored on the network.
/// Optionally contains the Payment and the PeerId that we paid to.
pub(crate) async fn publish_register(
client: Client,
cmd: RegisterCmd,
payment: Option<(Payment, PeerId)>,
verify_store: bool,
) -> Result<()> {
let cmd_dst = cmd.dst();
debug!("Querying existing Register for cmd: {cmd_dst:?}");
let network_reg = client
.get_signed_register_from_network(cmd.dst(), false)
.await;
debug!("Publishing Register cmd: {cmd_dst:?}");
let register = match cmd {
RegisterCmd::Create {
register,
signature,
} => {
if let Ok(existing_reg) = network_reg {
if existing_reg.owner() != register.owner() {
return Err(ProtocolError::RegisterAlreadyClaimed(existing_reg.owner()))?;
}
}
SignedRegister::new(register, signature)
}
RegisterCmd::Edit(op) => {
let mut reg = network_reg?;
reg.add_op(op)?;
reg
}
};
let network_address = NetworkAddress::from_register_address(*register.address());
let key = network_address.to_record_key();
let (record, payee) = match payment {
Some((payment, payee)) => {
let record = Record {
key: key.clone(),
value: try_serialize_record(
&(payment, ®ister),
RecordKind::RegisterWithPayment,
)?
.to_vec(),
publisher: None,
expires: None,
};
(record, Some(vec![payee]))
}
None => {
let record = Record {
key: key.clone(),
value: try_serialize_record(®ister, RecordKind::Register)?.to_vec(),
publisher: None,
expires: None,
};
(record, None)
}
};
let (record_to_verify, expected_holders) = if verify_store {
let expected_holders: HashSet<_> = client
.network
.get_closest_peers(&network_address, true)
.await?
.iter()
.cloned()
.collect();
(
Some(Record {
key,
value: try_serialize_record(®ister, RecordKind::Register)?.to_vec(),
publisher: None,
expires: None,
}),
expected_holders,
)
} else {
(None, Default::default())
};
let verification_cfg = GetRecordCfg {
get_quorum: Quorum::One,
retry_strategy: Some(RetryStrategy::Balanced),
target_record: record_to_verify,
expected_holders,
};
let put_cfg = PutRecordCfg {
put_quorum: Quorum::All,
retry_strategy: Some(RetryStrategy::Balanced),
use_put_record_to: payee,
verification: Some((VerificationKind::Network, verification_cfg)),
};
// Register edits might exist, so we cannot be sure that just because we get a record back that this should fail
Ok(client.network.put_record(record, &put_cfg).await?)
}
/// Retrieve a `Register` from the Network.
async fn get_register_from_network(
client: &Client,
address: RegisterAddress,
) -> Result<Register> {
debug!("Retrieving Register from: {address}");
let reg = client
.get_signed_register_from_network(address, false)
.await?;
reg.verify_with_address(address)?;
Ok(reg.register()?)
}
}