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
use sn_data_types::{Money, PublicKey, SignedTransfer, TransferAgreementProof};
use sn_messaging::{Cmd, Event, Query, QueryResponse, TransferCmd, TransferQuery};
use sn_transfers::{ActorEvent, TransferInitiated};

use crate::client::Client;
use crate::errors::Error;

use log::{debug, info, trace};

/// Handle all Money transfers and Write API requests for a given ClientId.
impl Client {
    /// Get the current known account balance from the local actor. (ie. Without querying the network)
    ///
    /// # Examples
    ///
    /// Create a random client
    /// ```no_run
    /// # extern crate tokio;use sn_client::Error;
    /// use sn_client::Client;
    /// use std::str::FromStr;
    /// use sn_data_types::Money;
    /// # #[tokio::main]async fn main() {let _: Result<(), Error> = futures::executor::block_on( async {
    /// let client = Client::new(None, None).await?;
    /// // now we check the local balance
    /// let some_balance = client.get_local_balance().await;
    /// assert_eq!(some_balance, Money::from_str("0")?);
    /// # Ok(())} );}
    /// ```
    pub async fn get_local_balance(&self) -> Money {
        info!("Retrieving actor's local balance.");
        self.transfer_actor.lock().await.balance()
    }

    /// Handle a validation event.
    #[allow(dead_code)]
    pub(crate) async fn handle_validation_event(
        &self,
        event: Event,
    ) -> Result<Option<TransferAgreementProof>, Error> {
        debug!("Handling validation event: {:?}", event);
        let validation = match event {
            Event::TransferValidated { event, .. } => event,
            _ => return Err(Error::UnexpectedTransferEvent(event)),
        };
        let mut actor = self.transfer_actor.lock().await;
        let transfer_validation = match actor.receive(validation) {
            Ok(Some(validation)) => validation,
            Ok(None) => return Ok(None),
            Err(error) => {
                if !error.to_string().contains("Already received validation") {
                    return Err(Error::from(error));
                }

                return Ok(None);
            }
        };

        actor.apply(ActorEvent::TransferValidationReceived(
            transfer_validation.clone(),
        ))?;

        Ok(transfer_validation.proof)
    }

    /// Get the current balance for this TransferActor PK (by default) or any other...
    pub(crate) async fn get_balance_from_network(
        &self,
        pk: Option<PublicKey>,
    ) -> Result<Money, Error> {
        info!("Getting balance for {:?} or self", pk);
        let public_key = pk.unwrap_or(self.public_key().await);

        let msg_contents = Query::Transfer(TransferQuery::GetBalance(public_key));

        let message = Self::create_query_message(msg_contents);

        match self
            .connection_manager
            .lock()
            .await
            .send_query(&message)
            .await?
        {
            QueryResponse::GetBalance(balance) => balance.map_err(Error::from),
            another_response => Err(Error::UnexpectedQueryResponse(another_response)),
        }
    }

    /// Send money to another PublicKey.
    ///
    /// If the PublicKey does not exist as a balance on the network it will be created with the send amount.
    ///
    /// # Examples
    ///
    /// Send money to a PublickKey.
    /// (This test uses "simulated payouts" to generate test money. This of course would not be avaiable on a live network.)
    /// ```no_run
    /// # extern crate tokio;use sn_client::Error;
    /// use sn_client::Client;
    /// use sn_data_types::{PublicKey, Money};
    /// use std::str::FromStr;
    /// # #[tokio::main] async fn main() { let _: Result<(), Error> = futures::executor::block_on( async {
    /// // A random sk, to send money to
    /// let sk = threshold_crypto::SecretKey::random();
    /// let pk = PublicKey::from(sk.public_key());
    /// // Next we create a random client.
    /// let mut client = Client::new(None, None).await?;
    /// let target_balance = Money::from_str("100")?;
    /// // And trigger a simulated payout to our client's PublicKey, so we have money to send.
    /// let _ = client.trigger_simulated_farming_payout(target_balance).await?;
    ///
    /// // Now we have 100 money at our balance, we can send it elsewhere:
    /// let (count, sending_pk) = client.send_money( pk, target_balance ).await?;
    ///
    /// // Finally, we can see that the money has arrived:
    /// let received_balance = client.get_balance_for(pk).await?;
    ///
    /// assert_eq!(1, count);
    /// assert_ne!(pk, sending_pk);
    /// assert_eq!(received_balance, target_balance);
    /// # Ok(())} ); }
    /// ```
    pub async fn send_money(
        &self,
        to: PublicKey,
        amount: Money,
    ) -> Result<(u64, PublicKey), Error> {
        info!("Sending money");

        // first make sure our balance  history is up to date
        self.get_history().await?;

        info!(
            "Our actor balance at send: {:?}",
            self.transfer_actor.lock().await.balance()
        );

        let initiated = self
            .transfer_actor
            .lock()
            .await
            .transfer(amount, to, "asdf".to_string())?
            .ok_or(Error::NoTransferGenerated)?;

        let signed_transfer = SignedTransfer {
            debit: initiated.signed_debit,
            credit: initiated.signed_credit,
        };
        let dot = signed_transfer.id();
        let msg_contents = Cmd::Transfer(TransferCmd::ValidateTransfer(signed_transfer.clone()));

        let message = Self::create_cmd_message(msg_contents);

        self.transfer_actor
            .lock()
            .await
            .apply(ActorEvent::TransferInitiated(TransferInitiated {
                signed_debit: signed_transfer.debit.clone(),
                signed_credit: signed_transfer.credit.clone(),
            }))?;

        let transfer_proof: TransferAgreementProof = self
            .await_validation(&message, signed_transfer.id())
            .await?;

        // Register the transfer on the network.
        let msg_contents = Cmd::Transfer(TransferCmd::RegisterTransfer(transfer_proof.clone()));

        let message = Self::create_cmd_message(msg_contents);
        trace!(
            "Transfer proof received and to be sent in RegisterTransfer req: {:?}",
            transfer_proof
        );

        let _ = self
            .connection_manager
            .lock()
            .await
            .send_cmd(&message)
            .await?;

        let mut actor = self.transfer_actor.lock().await;
        // First register with local actor, then reply.
        let register_event = actor
            .register(transfer_proof)?
            .ok_or(Error::NoTransferEventsForLocalActor)?;

        actor.apply(ActorEvent::TransferRegistrationSent(register_event))?;

        Ok((dot.counter, dot.actor))
    }
}

// --------------------------------
// Tests
// ---------------------------------

#[allow(missing_docs)]
#[cfg(feature = "simulated-payouts")]
pub mod exported_tests {
    use super::*;
    use crate::errors::TransfersError;
    use crate::utils::{generate_random_vector, test_utils::calculate_new_balance};
    use anyhow::{anyhow, bail, Result};
    use rand::rngs::OsRng;
    use sn_data_types::{Keypair, Money};
    use std::str::FromStr;

    pub async fn transfer_actor_can_send_money_and_thats_reflected_locally() -> Result<()> {
        let keypair = Keypair::new_ed25519(&mut OsRng);

        let client = Client::new(None, None).await?;

        let _ = client
            .send_money(keypair.public_key(), Money::from_str("1")?)
            .await?;

        // initial 10 on creation from farming simulation minus 1
        assert_eq!(client.get_local_balance().await, Money::from_str("9")?);

        assert_eq!(client.get_balance().await?, Money::from_str("9")?);

        Ok(())
    }

    pub async fn transfer_actor_can_send_several_transfers_and_thats_reflected_locally(
    ) -> Result<()> {
        let keypair2 = Keypair::new_ed25519(&mut OsRng);

        let client = Client::new(None, None).await?;

        let _ = client
            .send_money(keypair2.public_key(), Money::from_str("1")?)
            .await?;

        // Initial 10 Money on creation from farming simulation minus 1
        // Assert locally
        assert_eq!(client.get_local_balance().await, Money::from_str("9")?);

        // Fetch balance from network and assert the same.
        assert_eq!(
            client.get_balance_from_network(None).await?,
            Money::from_str("9")?
        );

        let _ = client
            .send_money(keypair2.public_key(), Money::from_str("2")?)
            .await?;

        // Initial 10 on creation from farming simulation minus 3
        assert_eq!(client.get_local_balance().await, Money::from_str("7")?);

        // Fetch balance from network and assert the same.
        assert_eq!(
            client.get_balance_from_network(None).await?,
            Money::from_str("7")?
        );

        Ok(())
    }

    pub async fn transfer_actor_can_send_many_many_transfers_and_thats_reflected_locally_and_on_network(
    ) -> Result<()> {
        let keypair2 = Keypair::new_ed25519(&mut OsRng);

        let client = Client::new(None, None).await?;

        let _ = client
            .send_money(keypair2.public_key(), Money::from_str("1")?)
            .await?;

        // Initial 10 Money on creation from farming simulation minus 1
        // Assert locally
        assert_eq!(client.get_local_balance().await, Money::from_str("9")?);

        // Fetch balance from network and assert the same.
        assert_eq!(client.get_balance().await?, Money::from_str("9")?);

        let _ = client
            .send_money(keypair2.public_key(), Money::from_str("1")?)
            .await?;

        // Initial 10 on creation from farming simulation minus 3
        assert_eq!(client.get_local_balance().await, Money::from_str("8")?);

        // Fetch balance from network and assert the same.
        assert_eq!(client.get_balance().await?, Money::from_str("8")?);

        let _ = client
            .send_money(keypair2.public_key(), Money::from_str("1")?)
            .await?;

        // Initial 10 on creation from farming simulation minus 3
        assert_eq!(client.get_local_balance().await, Money::from_str("7")?);

        // Fetch balance from network and assert the same.
        assert_eq!(client.get_balance().await?, Money::from_str("7")?);

        let _ = client
            .send_money(keypair2.public_key(), Money::from_str("1")?)
            .await?;

        // Initial 10 on creation from farming simulation minus 3
        assert_eq!(client.get_local_balance().await, Money::from_str("6")?);

        // Fetch balance from network and assert the same.
        assert_eq!(client.get_balance().await?, Money::from_str("6")?);

        Ok(())
    }

    pub async fn transfer_actor_cannot_send_0_money_req() -> Result<()> {
        let keypair2 = Keypair::new_ed25519(&mut OsRng);

        let client = Client::new(None, None).await?;

        // Send 0 Money to a random PK.
        match client
            .send_money(keypair2.public_key(), Money::from_str("0")?)
            .await
        {
            Err(Error::Transfer(TransfersError::ZeroValueTransfer)) => Ok(()),
            result => Err(anyhow!(
                "Unexpected error. Zero-Value Transfers should not pass. Received: {:?}",
                result
            )),
        }?;

        // Unchanged balances - local and network.
        assert_eq!(client.get_local_balance().await, Money::from_str("10")?);

        assert_eq!(client.get_balance().await?, Money::from_str("10")?);

        Ok(())
    }

    // 1. Create a client A and allocate 100 Money to it. (Clients start with 10 Money by default on simulated-farming)
    // 2. Get the balance and verify it.
    // 3. Create another client B with a wallet holding 10 Money on start.
    // 4. Transfer 11 Money from client A to client B and verify the new balances.
    pub async fn balance_transfers_between_clients() -> Result<()> {
        let mut client = Client::new(None, None).await?;
        let receiving_client = Client::new(None, None).await?;

        let wallet1 = receiving_client.public_key().await;

        client
            .trigger_simulated_farming_payout(Money::from_str("100.0")?)
            .await?;

        let mut balance = client.get_balance().await?;

        while balance != Money::from_str("110")? {
            balance = client.get_balance().await?;
        }
        // 11 here allows us to more easily debug repeat credits due w/ simulated payouts from each elder
        let _ = client.send_money(wallet1, Money::from_str("11.0")?).await?;

        // Assert sender is debited.
        let mut new_balance = client.get_balance().await?;
        let desired_balance = calculate_new_balance(balance, None, Some(Money::from_str("11.0")?));

        // loop until correct
        while new_balance != desired_balance {
            new_balance = client.get_balance().await?;
        }
        // Assert that the receiver has been credited.
        let mut receiving_bal = receiving_client.get_balance().await?;

        let target_money = Money::from_str("21.0")?;

        // loop until correct
        while receiving_bal != target_money {
            let _ = receiving_client.get_history().await?;
            receiving_bal = receiving_client.get_balance().await?;

            if receiving_bal > target_money {
                continue;
            }
        }

        assert_eq!(receiving_bal, target_money);
        Ok(())
    }

    // 1. Create a sender client A w/10 Money by default.
    // 2. Create a receiver client B w/10 Money by default.
    // 3. Attempt to send 5000 Money from A to B which should fail with 'InsufficientBalance'.
    // 4. Assert Client A's balance is unchanged.
    // 5. Assert Client B's balance is unchanged.
    pub async fn insufficient_balance_transfers() -> Result<()> {
        let client = Client::new(None, None).await?;
        let receiving_client = Client::new(None, None).await?;

        let wallet1 = receiving_client.public_key().await;

        // Try transferring money exceeding our balance.
        match client.send_money(wallet1, Money::from_str("5000")?).await {
            Err(Error::Transfer(TransfersError::InsufficientBalance)) => (),
            res => bail!("Unexpected result: {:?}", res),
        };

        // Assert if sender's money is unchanged.
        let balance = client.get_balance().await?;
        assert_eq!(balance, Money::from_str("10")?);

        // Assert no money is credited to receiver's bal accidentally by logic error.
        let receiving_bal = receiving_client.get_balance().await?;
        assert_eq!(receiving_bal, Money::from_str("10")?);

        Ok(())
    }

    pub async fn cannot_write_with_insufficient_balance() -> Result<()> {
        let client = Client::new(None, None).await?;
        let receiving_client = Client::new(None, None).await?;

        let wallet1 = receiving_client.public_key().await;

        let _ = client.send_money(wallet1, Money::from_str("10")?).await?;
        // Assert sender is debited.
        let mut new_balance = client.get_balance().await?;
        let desired_balance = Money::from_nano(0);

        // loop until correct
        while new_balance != desired_balance {
            new_balance = client.get_balance().await?;
        }

        let data = generate_random_vector::<u8>(10);
        let res = client.store_public_blob(&data).await;
        match res {
            Err(Error::Transfer(TransfersError::InsufficientBalance)) => (),
            res => bail!(
                "Unexpected result in money transfer test, able to put data without balance: {:?}",
                res
            ),
        };

        Ok(())
    }
}

#[cfg(all(test, feature = "simulated-payouts"))]
mod tests {
    use super::exported_tests;
    use anyhow::Result;

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn transfer_actor_can_send_money_and_thats_reflected_locally() -> Result<()> {
        exported_tests::transfer_actor_can_send_money_and_thats_reflected_locally().await
    }

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn transfer_actor_can_send_several_transfers_and_thats_reflected_locally(
    ) -> Result<()> {
        exported_tests::transfer_actor_can_send_several_transfers_and_thats_reflected_locally()
            .await
    }

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn transfer_actor_can_send_many_many_transfers_and_thats_reflected_locally_and_on_network(
    ) -> Result<()> {
        exported_tests::transfer_actor_can_send_many_many_transfers_and_thats_reflected_locally_and_on_network()
            .await
    }

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn transfer_actor_cannot_send_0_money_req() -> Result<()> {
        exported_tests::transfer_actor_cannot_send_0_money_req().await
    }

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn balance_transfers_between_clients() -> Result<()> {
        exported_tests::balance_transfers_between_clients().await
    }

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn insufficient_balance_transfers() -> Result<()> {
        exported_tests::insufficient_balance_transfers().await
    }

    #[tokio::test]
    #[cfg(feature = "simulated-payouts")]
    pub async fn cannot_write_with_insufficient_balance() -> Result<()> {
        exported_tests::cannot_write_with_insufficient_balance().await
    }
}