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 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
// 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 super::{
error::{Error, Result},
Client, ClientEvent, ClientEventsBroadcaster, ClientEventsReceiver, ClientRegister,
WalletClient,
};
use bls::{PublicKey, SecretKey, Signature};
use libp2p::{
identity::Keypair,
kad::{Quorum, Record},
Multiaddr, PeerId,
};
#[cfg(feature = "open-metrics")]
use prometheus_client::registry::Registry;
use rand::{thread_rng, Rng};
use sn_networking::{
get_signed_spend_from_record, multiaddr_is_global,
target_arch::{interval, spawn, timeout, Instant},
GetRecordCfg, GetRecordError, NetworkBuilder, NetworkError, NetworkEvent, PutRecordCfg,
VerificationKind, CLOSE_GROUP_SIZE,
};
use sn_protocol::{
error::Error as ProtocolError,
messages::ChunkProof,
storage::{
try_deserialize_record, try_serialize_record, Chunk, ChunkAddress, RecordHeader,
RecordKind, RegisterAddress, RetryStrategy, SpendAddress,
},
NetworkAddress, PrettyPrintRecordKey,
};
use sn_registers::{Permissions, SignedRegister};
use sn_transfers::{
CashNote, CashNoteRedemption, MainPubkey, NanoTokens, Payment, SignedSpend, TransferError,
};
#[cfg(target_arch = "wasm32")]
use std::path::PathBuf;
use std::{
collections::{HashMap, HashSet},
num::NonZeroUsize,
sync::Arc,
};
use tokio::time::Duration;
use tracing::trace;
use xor_name::XorName;
/// The maximum duration the client will wait for a connection to the network before timing out.
const CONNECTION_TIMEOUT: Duration = Duration::from_secs(30);
/// The timeout duration for the client to receive any response from the network.
const INACTIVITY_TIMEOUT: Duration = Duration::from_secs(30);
impl Client {
/// A quick client with a random secret key and some peers.
pub async fn quick_start(peers: Option<Vec<Multiaddr>>) -> Result<Self> {
Self::new(SecretKey::random(), peers, None, None).await
}
/// Instantiate a new client.
///
/// Optionally specify the duration for the connection timeout.
///
/// Defaults to 180 seconds.
///
/// # Arguments
/// * 'signer' - [SecretKey]
/// * 'peers' - [Option]<[Vec]<[Multiaddr]>>
/// * 'connection_timeout' - [Option]<[Duration]> : Specification for client connection timeout set via Optional
/// * 'client_event_broadcaster' - [Option]<[ClientEventsBroadcaster]>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// # Ok(())
/// # }
/// ```
pub async fn new(
signer: SecretKey,
peers: Option<Vec<Multiaddr>>,
connection_timeout: Option<Duration>,
client_event_broadcaster: Option<ClientEventsBroadcaster>,
) -> Result<Self> {
// If any of our contact peers has a global address, we'll assume we're in a global network.
let local = match peers {
Some(ref peers) => !peers.iter().any(multiaddr_is_global),
None => true,
};
info!("Startup a client with peers {peers:?} and local {local:?} flag");
info!("Starting Kad swarm in client mode...");
#[cfg(target_arch = "wasm32")]
let root_dir = PathBuf::from("dummy path, wasm32/browser environments will not use this");
#[cfg(not(target_arch = "wasm32"))]
let root_dir = std::env::temp_dir();
trace!("Starting Kad swarm in client mode..{root_dir:?}.");
#[cfg(not(feature = "open-metrics"))]
let network_builder = NetworkBuilder::new(Keypair::generate_ed25519(), local, root_dir);
#[cfg(feature = "open-metrics")]
let mut network_builder = NetworkBuilder::new(Keypair::generate_ed25519(), local, root_dir);
#[cfg(feature = "open-metrics")]
network_builder.metrics_registry(Registry::default());
let (network, mut network_event_receiver, swarm_driver) = network_builder.build_client()?;
info!("Client constructed network and swarm_driver");
// If the events broadcaster is not provided by the caller, then we create a new one.
// This is not optional as we wait on certain events to connect to the network and return from this function.
let events_broadcaster = client_event_broadcaster.unwrap_or_default();
let client = Self {
network: network.clone(),
events_broadcaster,
signer: Arc::new(signer),
};
// subscribe to our events channel first, so we don't have intermittent
// errors if it does not exist and we cannot send to it.
// (eg, if PeerAdded happens faster than our events channel is created)
let mut client_events_rx = client.events_channel();
let _swarm_driver = spawn({
trace!("Starting up client swarm_driver");
swarm_driver.run()
});
// spawn task to dial to the given peers
let network_clone = network.clone();
let _handle = spawn(async move {
if let Some(peers) = peers {
for addr in peers {
trace!(%addr, "dialing initial peer");
if let Err(err) = network_clone.dial(addr.clone()).await {
tracing::error!(%addr, "Failed to dial: {err:?}");
};
}
}
});
// spawn task to wait for NetworkEvent and check for inactivity
let mut client_clone = client.clone();
let _event_handler = spawn(async move {
let mut peers_added: usize = 0;
loop {
match timeout(INACTIVITY_TIMEOUT, network_event_receiver.recv()).await {
Ok(event) => {
let the_event = match event {
Some(the_event) => the_event,
None => {
error!("The `NetworkEvent` channel has been closed");
continue;
}
};
let start = Instant::now();
let event_string = format!("{the_event:?}");
if let Err(err) =
client_clone.handle_network_event(the_event, &mut peers_added)
{
warn!("Error handling network event: {err}");
}
trace!(
"Handled network event in {:?}: {:?}",
start.elapsed(),
event_string
);
}
Err(_elapse_err) => {
debug!("Client inactivity... waiting for a network event");
client_clone
.events_broadcaster
.broadcast(ClientEvent::InactiveClient(INACTIVITY_TIMEOUT));
}
}
}
});
// loop to connect to the network
let mut is_connected = false;
let connection_timeout = connection_timeout.unwrap_or(CONNECTION_TIMEOUT);
let mut connection_timeout_interval = interval(connection_timeout);
// first tick completes immediately
connection_timeout_interval.tick().await;
loop {
tokio::select! {
_ = connection_timeout_interval.tick() => {
if !is_connected {
error!("Timeout: Client failed to connect to the network within {connection_timeout:?}");
return Err(Error::ConnectionTimeout(connection_timeout));
}
}
event = client_events_rx.recv() => {
match event {
Ok(ClientEvent::ConnectedToNetwork) => {
is_connected = true;
info!("Client connected to the Network {is_connected:?}.");
break;
}
Ok(ClientEvent::InactiveClient(timeout)) => {
if is_connected {
info!("The client was inactive for {timeout:?}.");
} else {
info!("The client still does not know enough network nodes.");
}
}
Err(err) => {
error!("Unexpected error during client startup {err:?}");
println!("Unexpected error during client startup {err:?}");
return Err(err.into());
}
_ => {}
}
}}
}
Ok(client)
}
fn handle_network_event(&mut self, event: NetworkEvent, peers_added: &mut usize) -> Result<()> {
match event {
NetworkEvent::PeerAdded(peer_id, _connected_peer) => {
debug!("PeerAdded: {peer_id}");
*peers_added += 1;
// notify the listeners that we are waiting on CLOSE_GROUP_SIZE peers before emitting ConnectedToNetwork
self.events_broadcaster.broadcast(ClientEvent::PeerAdded {
max_peers_to_connect: CLOSE_GROUP_SIZE,
});
// In case client running in non-local-discovery mode,
// it may take some time to fill up the RT.
// To avoid such delay may fail the query with RecordNotFound,
// wait till certain amount of peers populated into RT
if *peers_added >= CLOSE_GROUP_SIZE {
self.events_broadcaster
.broadcast(ClientEvent::ConnectedToNetwork);
} else {
debug!("{peers_added}/{CLOSE_GROUP_SIZE} initial peers found.",);
}
}
_other => {}
}
Ok(())
}
/// Get the client events channel.
///
/// Return Type:
///
/// [ClientEventsReceiver]
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error, ClientEvent};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Using client.events_channel() to publish messages
/// let mut events_channel = client.events_channel();
/// while let Ok(event) = events_channel.recv().await {
/// // Handle the event
/// }
///
/// # Ok(())
/// # }
/// ```
pub fn events_channel(&self) -> ClientEventsReceiver {
self.events_broadcaster.subscribe()
}
/// Sign the given data.
///
/// # Arguments
/// * 'data' - bytes; i.e bytes of an sn_registers::Register instance
///
/// Return Type:
///
/// [Signature]
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
///
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// use tracing::callsite::register;
/// use xor_name::XorName;
/// use sn_registers::Register;
/// use sn_protocol::messages::RegisterCmd;
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
///
/// // Set up register prerequisites
/// let mut rng = rand::thread_rng();
/// let xorname = XorName::random(&mut rng);
/// let owner_sk = SecretKey::random();
/// let owner_pk = owner_sk.public_key();
///
/// // set up register
/// let mut register = Register::new(owner_pk, xorname, Default::default());
/// let mut register_clone = register.clone();
///
/// // Use of client.sign() with register through RegisterCmd::Create
/// let cmd = RegisterCmd::Create {
/// register,
/// signature: client.sign(register_clone.bytes()?),
/// };
/// # Ok(())
/// # }
/// ```
pub fn sign<T: AsRef<[u8]>>(&self, data: T) -> Signature {
self.signer.sign(data)
}
/// Return a reference to the signer secret key.
///
/// Return Type:
///
/// [SecretKey]
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let secret_key_reference = client.signer();
/// # Ok(())
/// # }
/// ```
pub fn signer(&self) -> &SecretKey {
&self.signer
}
/// Return the public key of the data signing key.
///
/// Return Type:
///
/// [PublicKey]
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let public_key_reference = client.signer_pk();
/// # Ok(())
/// # }
/// ```
pub fn signer_pk(&self) -> PublicKey {
self.signer.public_key()
}
/// Set the signing key for this client.
///
/// # Arguments
/// * 'sk' - [SecretKey]
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// let mut client = Client::new(SecretKey::random(), None, None, None).await?;
/// client.set_signer_key(SecretKey::random());
/// # Ok(())
/// # }
/// ```
pub fn set_signer_key(&mut self, sk: SecretKey) {
self.signer = Arc::new(sk);
}
/// Get a register from network
///
/// # Arguments
/// * 'address' - [RegisterAddress]
/// * 'is_verifying' - Boolean: If true, we fetch at-least 2 copies from the network with more retry attempts.
///
/// Return Type:
///
/// Result<[SignedRegister]>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// use xor_name::XorName;
/// use sn_registers::RegisterAddress;
/// // Set up a client
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Set up an address
/// let mut rng = rand::thread_rng();
/// let owner = SecretKey::random().public_key();
/// let xorname = XorName::random(&mut rng);
/// let address = RegisterAddress::new(xorname, owner);
/// // Get a signed register
/// let signed_register = client.get_signed_register_from_network(address,true);
/// # Ok(())
/// # }
/// ```
pub async fn get_signed_register_from_network(
&self,
address: RegisterAddress,
is_verifying: bool,
) -> Result<SignedRegister> {
let key = NetworkAddress::from_register_address(address).to_record_key();
let get_quorum = if is_verifying {
Quorum::N(NonZeroUsize::new(2).ok_or(Error::NonZeroUsizeWasInitialisedAsZero)?)
} else {
Quorum::One
};
let retry_strategy = if is_verifying {
Some(RetryStrategy::Balanced)
} else {
Some(RetryStrategy::Quick)
};
let get_cfg = GetRecordCfg {
get_quorum,
retry_strategy,
target_record: None,
expected_holders: Default::default(),
};
let maybe_record = self.network.get_record_from_network(key, &get_cfg).await;
let record = match &maybe_record {
Ok(r) => r,
Err(NetworkError::GetRecordError(GetRecordError::SplitRecord { result_map })) => {
return merge_split_register_records(address, result_map)
}
Err(e) => {
warn!("Failed to get record at {address:?} from the network: {e:?}");
return Err(ProtocolError::RegisterNotFound(Box::new(address)).into());
}
};
debug!(
"Got record from the network, {:?}",
PrettyPrintRecordKey::from(&record.key)
);
let register = get_register_from_record(record)
.map_err(|_| ProtocolError::RegisterNotFound(Box::new(address)))?;
Ok(register)
}
/// Retrieve a Register from the network.
///
/// # Arguments
/// * 'address' - [RegisterAddress]
///
/// Return Type:
///
/// Result<[ClientRegister]>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// use xor_name::XorName;
/// use sn_registers::RegisterAddress;
/// // Set up a client
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Set up an address
/// let mut rng = rand::thread_rng();
/// let owner = SecretKey::random().public_key();
/// let xorname = XorName::random(&mut rng);
/// let address = RegisterAddress::new(xorname, owner);
/// // Get the register
/// let retrieved_register = client.get_register(address);
/// # Ok(())
/// # }
/// ```
pub async fn get_register(&self, address: RegisterAddress) -> Result<ClientRegister> {
info!("Retrieving a Register replica at {address}");
ClientRegister::retrieve(self.clone(), address).await
}
/// Create a new Register on the Network.
/// Tops up payments and retries if necessary and verification failed
///
/// # Arguments
/// * 'address' - [XorName]
/// * 'wallet_client' - [WalletClient]
/// * 'verify_store' - Boolean
/// * 'perms' - [Permissions]
///
/// Return Type:
///
/// Result<([ClientRegister], [NanoTokens], [NanoTokens])>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, WalletClient, Error};
/// use tempfile::TempDir;
/// use bls::SecretKey;
/// use sn_transfers::{MainSecretKey};
/// use xor_name::XorName;
/// use sn_registers::RegisterAddress;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// // Set up Client, Wallet, etc
/// use sn_registers::Permissions;
/// use sn_transfers::HotWallet;
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// let tmp_path = TempDir::new()?.path().to_owned();
/// let mut wallet = HotWallet::load_from_path(&tmp_path,Some(MainSecretKey::new(SecretKey::random())))?;
/// let mut wallet_client = WalletClient::new(client.clone(), wallet);
/// // Set up an address
/// let mut rng = rand::thread_rng();
/// let owner = SecretKey::random().public_key();
/// let xorname = XorName::random(&mut rng);
/// let address = RegisterAddress::new(xorname, owner);
/// // Example:
/// let (mut client_register, _storage_cost, _royalties_fees) = client
/// .create_and_pay_for_register(
/// xorname,
/// &mut wallet_client,
/// true,
/// Permissions::default(),
/// )
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_and_pay_for_register(
&self,
address: XorName,
wallet_client: &mut WalletClient,
verify_store: bool,
perms: Permissions,
) -> Result<(ClientRegister, NanoTokens, NanoTokens)> {
info!("Instantiating a new Register replica with address {address:?}");
let (reg, mut total_cost, mut total_royalties) = ClientRegister::create_online(
self.clone(),
address,
wallet_client,
false,
perms.clone(),
)
.await?;
debug!("{address:?} Created in theory");
let reg_address = reg.address();
if verify_store {
debug!("We should verify stored at {address:?}");
let mut stored = self.verify_register_stored(*reg_address).await.is_ok();
while !stored {
info!("Register not completely stored on the network yet. Retrying...");
// this verify store call here ensures we get the record from Quorum::all
let (reg, top_up_cost, royalties_top_up) = ClientRegister::create_online(
self.clone(),
address,
wallet_client,
true,
perms.clone(),
)
.await?;
let reg_address = reg.address();
total_cost = total_cost
.checked_add(top_up_cost)
.ok_or(Error::TotalPriceTooHigh)?;
total_royalties = total_cost
.checked_add(royalties_top_up)
.ok_or(Error::Wallet(sn_transfers::WalletError::from(
sn_transfers::TransferError::ExcessiveNanoValue,
)))?;
stored = self.verify_register_stored(*reg_address).await.is_ok();
}
}
Ok((reg, total_cost, total_royalties))
}
/// Store `Chunk` as a record. Protected method.
///
/// # Arguments
/// * 'chunk' - [Chunk]
/// * 'payee' - [PeerId]
/// * 'payment' - [Payment]
/// * 'verify_store' - Boolean
/// * 'retry_strategy' - [Option]<[RetryStrategy]> : Uses Balanced by default
///
pub(super) async fn store_chunk(
&self,
chunk: Chunk,
payee: PeerId,
payment: Payment,
verify_store: bool,
retry_strategy: Option<RetryStrategy>,
) -> Result<()> {
info!("Store chunk: {:?}", chunk.address());
let key = chunk.network_address().to_record_key();
let retry_strategy = Some(retry_strategy.unwrap_or(RetryStrategy::Balanced));
let record_kind = RecordKind::ChunkWithPayment;
let record = Record {
key: key.clone(),
value: try_serialize_record(&(payment, chunk.clone()), record_kind)?.to_vec(),
publisher: None,
expires: None,
};
let verification = if verify_store {
let verification_cfg = GetRecordCfg {
get_quorum: Quorum::N(
NonZeroUsize::new(2).ok_or(Error::NonZeroUsizeWasInitialisedAsZero)?,
),
retry_strategy,
target_record: None, // Not used since we use ChunkProof
expected_holders: Default::default(),
};
// The `ChunkWithPayment` is only used to send out via PutRecord.
// The holders shall only hold the `Chunk` copies.
// Hence the fetched copies shall only be a `Chunk`
let stored_on_node = try_serialize_record(&chunk, RecordKind::Chunk)?.to_vec();
let random_nonce = thread_rng().gen::<u64>();
let expected_proof = ChunkProof::new(&stored_on_node, random_nonce);
Some((
VerificationKind::ChunkProof {
expected_proof,
nonce: random_nonce,
},
verification_cfg,
))
} else {
None
};
let put_cfg = PutRecordCfg {
put_quorum: Quorum::One,
retry_strategy,
use_put_record_to: Some(vec![payee]),
verification,
};
Ok(self.network.put_record(record, &put_cfg).await?)
}
/// Get chunk from chunk address.
///
/// # Arguments
/// * 'address' - [ChunkAddress]
/// * 'show_holders' - Boolean
/// * 'retry_strategy' - [Option]<[RetryStrategy]> : Uses Quick by default
///
/// Return Type:
///
/// Result<[Chunk]>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// use xor_name::XorName;
/// use sn_protocol::storage::ChunkAddress;
/// // client
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // chunk address
/// let mut rng = rand::thread_rng();
/// let xorname = XorName::random(&mut rng);
/// let chunk_address = ChunkAddress::new(xorname);
/// // get chunk
/// let chunk = client.get_chunk(chunk_address,true, None).await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_chunk(
&self,
address: ChunkAddress,
show_holders: bool,
retry_strategy: Option<RetryStrategy>,
) -> Result<Chunk> {
info!("Getting chunk: {address:?}");
let key = NetworkAddress::from_chunk_address(address).to_record_key();
let expected_holders = if show_holders {
let result: HashSet<_> = self
.network
.get_closest_peers(&NetworkAddress::from_chunk_address(address), true)
.await?
.iter()
.cloned()
.collect();
result
} else {
Default::default()
};
let get_cfg = GetRecordCfg {
get_quorum: Quorum::One,
retry_strategy: Some(retry_strategy.unwrap_or(RetryStrategy::Quick)),
target_record: None,
expected_holders,
};
let record = self.network.get_record_from_network(key, &get_cfg).await?;
let header = RecordHeader::from_record(&record)?;
if let RecordKind::Chunk = header.kind {
let chunk: Chunk = try_deserialize_record(&record)?;
Ok(chunk)
} else {
Err(NetworkError::RecordKindMismatch(RecordKind::Chunk).into())
}
}
/// Verify if a `Chunk` is stored by expected nodes on the network.
/// Single local use. Marked Private.
pub async fn verify_chunk_stored(&self, chunk: &Chunk) -> Result<()> {
let address = chunk.network_address();
info!("Verifying chunk: {address:?}");
let random_nonce = thread_rng().gen::<u64>();
let record_value = try_serialize_record(&chunk, RecordKind::Chunk)?;
let expected_proof = ChunkProof::new(record_value.as_ref(), random_nonce);
if let Err(err) = self
.network
.verify_chunk_existence(
address.clone(),
random_nonce,
expected_proof,
Quorum::N(NonZeroUsize::new(2).ok_or(Error::NonZeroUsizeWasInitialisedAsZero)?),
None,
)
.await
{
error!("Failed to verify the existence of chunk {address:?} with err {err:?}");
return Err(err.into());
}
Ok(())
}
/// Verify if a `Register` is stored by expected nodes on the network.
///
/// # Arguments
/// * 'address' - [RegisterAddress]
///
/// Return Type:
///
/// Result<[SignedRegister]>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// use xor_name::XorName;
/// use sn_registers::RegisterAddress;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// // Set up Client
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Set up an address
/// let mut rng = rand::thread_rng();
/// let owner = SecretKey::random().public_key();
/// let xorname = XorName::random(&mut rng);
/// let address = RegisterAddress::new(xorname, owner);
/// // Verify address is stored
/// let is_stored = client.verify_register_stored(address).await.is_ok();
/// # Ok(())
/// # }
/// ```
pub async fn verify_register_stored(&self, address: RegisterAddress) -> Result<SignedRegister> {
info!("Verifying register: {address:?}");
self.get_signed_register_from_network(address, true).await
}
/// Send a `SpendCashNote` request to the network. Protected method.
///
/// # Arguments
/// * 'spend' - [SignedSpend]
/// * 'verify_store' - Boolean
///
pub(crate) async fn network_store_spend(
&self,
spend: SignedSpend,
verify_store: bool,
) -> Result<()> {
let unique_pubkey = *spend.unique_pubkey();
let cash_note_addr = SpendAddress::from_unique_pubkey(&unique_pubkey);
let network_address = NetworkAddress::from_spend_address(cash_note_addr);
trace!("Sending spend {unique_pubkey:?} to the network via put_record, with addr of {cash_note_addr:?}");
let key = network_address.to_record_key();
let record_kind = RecordKind::Spend;
let record = Record {
key,
value: try_serialize_record(&[spend], record_kind)?.to_vec(),
publisher: None,
expires: None,
};
let (record_to_verify, expected_holders) = if verify_store {
let expected_holders: HashSet<_> = self
.network
.get_closest_peers(&network_address, true)
.await?
.iter()
.cloned()
.collect();
(Some(record.clone()), expected_holders)
} else {
(None, Default::default())
};
let verification_cfg = GetRecordCfg {
get_quorum: Quorum::Majority,
retry_strategy: Some(RetryStrategy::Balanced),
target_record: record_to_verify,
expected_holders,
};
let put_cfg = PutRecordCfg {
put_quorum: Quorum::All,
retry_strategy: Some(RetryStrategy::Persistent),
use_put_record_to: None,
verification: Some((VerificationKind::Network, verification_cfg)),
};
Ok(self.network.put_record(record, &put_cfg).await?)
}
/// Get a spend from network.
///
/// # Arguments
/// * 'address' - [SpendAddress]
///
/// Return Type:
///
/// Result<[SignedSpend]>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// use xor_name::XorName;
/// use sn_transfers::SpendAddress;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Create a SpendAddress
/// let mut rng = rand::thread_rng();
/// let xorname = XorName::random(&mut rng);
/// let spend_address = SpendAddress::new(xorname);
/// // Here we get the spend address
/// let spend = client.get_spend_from_network(spend_address).await?;
/// // Example: We can use the spend to get its unique public key:
/// let unique_pubkey = spend.unique_pubkey();
/// # Ok(())
/// # }
/// ```
pub async fn get_spend_from_network(&self, address: SpendAddress) -> Result<SignedSpend> {
let key = NetworkAddress::from_spend_address(address).to_record_key();
info!(
"Getting spend at {address:?} with record_key {:?}",
PrettyPrintRecordKey::from(&key)
);
let get_cfg = GetRecordCfg {
get_quorum: Quorum::Majority,
retry_strategy: Some(RetryStrategy::Balanced),
target_record: None,
expected_holders: Default::default(),
};
let record = self
.network
.get_record_from_network(key.clone(), &get_cfg)
.await?;
info!(
"For spend at {address:?} got record from the network, {:?}",
PrettyPrintRecordKey::from(&record.key)
);
let signed_spend = get_signed_spend_from_record(&address, &record)?;
// check addr
let spend_addr = SpendAddress::from_unique_pubkey(signed_spend.unique_pubkey());
if address != spend_addr {
let s = format!("Spend got from the Network at {address:?} contains different spend address: {spend_addr:?}");
warn!("{s}");
return Err(Error::Transfer(TransferError::InvalidSpendValue(
*signed_spend.unique_pubkey(),
)));
}
// check spend
match signed_spend.verify(signed_spend.spent_tx_hash()) {
Ok(()) => {
trace!("Verified signed spend got from network for {address:?}");
Ok(signed_spend.clone())
}
Err(err) => {
warn!("Invalid signed spend got from network for {address:?}: {err:?}.");
Err(Error::CouldNotVerifyTransfer(format!(
"Verification failed for spent at {address:?} with error {err:?}"
)))
}
}
}
/// This function is used to receive a Vector of CashNoteRedemptions and turn them back into spendable CashNotes.
/// For this we need a network connection.
/// Verify CashNoteRedemptions and rebuild spendable currency from them.
/// Returns an `Error::InvalidTransfer` if any CashNoteRedemption is not valid
/// Else returns a list of CashNotes that can be spent by the owner.
///
/// # Arguments
/// * 'main_pubkey' - [MainPubkey]
/// * 'cashnote_redemptions' - [CashNoteRedemption]
///
/// Return Type:
///
/// Result<[Vec]<[CashNote]>>
///
/// # Example
/// ```no_run
/// use sn_client::{Client, Error};
/// use bls::SecretKey;
/// # #[tokio::main]
/// # async fn main() -> Result<(),Error>{
/// use sn_transfers::{CashNote, CashNoteRedemption, MainPubkey};
/// let client = Client::new(SecretKey::random(), None, None, None).await?;
/// // Create a main public key
/// let pk = SecretKey::random().public_key();
/// let main_pub_key = MainPubkey::new(pk);
/// // Create a Cash Note Redemption Vector
/// let cash_note = CashNote::from_hex("&hex").unwrap();
/// let cashNoteRedemption = CashNoteRedemption::from_cash_note(&cash_note).unwrap();
/// let vector = vec![cashNoteRedemption.clone(), cashNoteRedemption.clone()];
/// // Verify the cash note redemptions
/// let cash_notes = client.verify_cash_notes_redemptions(main_pub_key,&vector);
/// # Ok(())
/// # }
/// ```
pub async fn verify_cash_notes_redemptions(
&self,
main_pubkey: MainPubkey,
cashnote_redemptions: &[CashNoteRedemption],
) -> Result<Vec<CashNote>> {
let cash_notes = self
.network
.verify_cash_notes_redemptions(main_pubkey, cashnote_redemptions)
.await?;
Ok(cash_notes)
}
}
fn get_register_from_record(record: &Record) -> Result<SignedRegister> {
let header = RecordHeader::from_record(record)?;
if let RecordKind::Register = header.kind {
let register = try_deserialize_record::<SignedRegister>(record)?;
Ok(register)
} else {
error!("RecordKind mismatch while trying to retrieve a signed register");
Err(NetworkError::RecordKindMismatch(RecordKind::Register).into())
}
}
/// if multiple register records where found for a given key, merge them into a single register
fn merge_split_register_records(
address: RegisterAddress,
map: &HashMap<XorName, (Record, HashSet<PeerId>)>,
) -> Result<SignedRegister> {
let key = NetworkAddress::from_register_address(address).to_record_key();
let pretty_key = PrettyPrintRecordKey::from(&key);
debug!("Got multiple records from the network for key: {pretty_key:?}");
let mut all_registers = vec![];
for (record, peers) in map.values() {
match get_register_from_record(record) {
Ok(r) => all_registers.push(r),
Err(e) => {
warn!("Ignoring invalid register record found for {pretty_key:?} received from {peers:?}: {:?}", e);
continue;
}
}
}
// get the first valid register
let one_valid_reg = if let Some(r) = all_registers.clone().iter().find(|r| r.verify().is_ok()) {
r.clone()
} else {
error!("No valid register records found for {key:?}");
return Err(Error::Protocol(ProtocolError::RegisterNotFound(Box::new(
address,
))));
};
// merge it with the others if they are valid
let register: SignedRegister = all_registers.into_iter().fold(one_valid_reg, |mut acc, r| {
if acc.verified_merge(&r).is_err() {
warn!("Skipping register that failed to merge. Entry found for {key:?}");
}
acc
});
Ok(register)
}
#[cfg(test)]
mod tests {
use std::collections::BTreeSet;
use sn_registers::Register;
use super::*;
#[test]
fn test_merge_split_register_records() -> eyre::Result<()> {
let mut rng = rand::thread_rng();
let meta = XorName::random(&mut rng);
let owner_sk = SecretKey::random();
let owner_pk = owner_sk.public_key();
let address = RegisterAddress::new(meta, owner_pk);
let peers1 = HashSet::from_iter(vec![PeerId::random(), PeerId::random()]);
let peers2 = HashSet::from_iter(vec![PeerId::random(), PeerId::random()]);
// prepare registers
let mut register_root = Register::new(owner_pk, meta, Default::default());
let (root_hash, _) =
register_root.write(b"root_entry".to_vec(), &BTreeSet::default(), &owner_sk)?;
let root = BTreeSet::from_iter(vec![root_hash]);
let signed_root = register_root.clone().into_signed(&owner_sk)?;
let mut register1 = register_root.clone();
let (_hash, op1) = register1.write(b"entry1".to_vec(), &root, &owner_sk)?;
let mut signed_register1 = signed_root.clone();
signed_register1.add_op(op1)?;
let mut register2 = register_root.clone();
let (_hash, op2) = register2.write(b"entry2".to_vec(), &root, &owner_sk)?;
let mut signed_register2 = signed_root;
signed_register2.add_op(op2)?;
let mut register_bad = Register::new(owner_pk, meta, Default::default());
let (_hash, _op_bad) =
register_bad.write(b"bad_root".to_vec(), &BTreeSet::default(), &owner_sk)?;
let invalid_sig = register2.sign(&owner_sk)?; // steal sig from something else
let signed_register_bad = SignedRegister::new(register_bad, invalid_sig);
// prepare records
let record1 = Record {
key: NetworkAddress::from_register_address(address).to_record_key(),
value: try_serialize_record(&signed_register1, RecordKind::Register)?.to_vec(),
publisher: None,
expires: None,
};
let xorname1 = XorName::from_content(&record1.value);
let record2 = Record {
key: NetworkAddress::from_register_address(address).to_record_key(),
value: try_serialize_record(&signed_register2, RecordKind::Register)?.to_vec(),
publisher: None,
expires: None,
};
let xorname2 = XorName::from_content(&record2.value);
let record_bad = Record {
key: NetworkAddress::from_register_address(address).to_record_key(),
value: try_serialize_record(&signed_register_bad, RecordKind::Register)?.to_vec(),
publisher: None,
expires: None,
};
let xorname_bad = XorName::from_content(&record_bad.value);
// test with 2 valid records: should return the two merged
let mut expected_merge = signed_register1.clone();
expected_merge.merge(&signed_register2)?;
let map = HashMap::from_iter(vec![
(xorname1, (record1.clone(), peers1.clone())),
(xorname2, (record2, peers2.clone())),
]);
let reg = merge_split_register_records(address, &map)?; // Ok
assert_eq!(reg, expected_merge);
// test with 1 valid record and 1 invalid record: should return the valid one
let map = HashMap::from_iter(vec![
(xorname1, (record1, peers1.clone())),
(xorname2, (record_bad.clone(), peers2.clone())),
]);
let reg = merge_split_register_records(address, &map)?; // Ok
assert_eq!(reg, signed_register1);
// test with 2 invalid records: should error out
let map = HashMap::from_iter(vec![
(xorname_bad, (record_bad.clone(), peers1)),
(xorname_bad, (record_bad, peers2)),
]);
let res = merge_split_register_records(address, &map); // Err
assert!(res.is_err());
Ok(())
}
}