-
Notifications
You must be signed in to change notification settings - Fork 4
/
lib.rs
1617 lines (1491 loc) · 60.9 KB
/
lib.rs
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
// Copyright 2020-2021 OxyDev.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#![cfg_attr(not(feature = "std"), no_std)]
#[ink_lang::contract]
pub mod subscrypt {
use core::convert::TryInto;
use ink_env::hash::{HashOutput, Sha2x256};
use ink_env::Error;
use ink_prelude::string::String;
use ink_prelude::vec;
use ink_prelude::vec::Vec;
use ink_storage::collections::HashMap;
use ink_storage::traits::{PackedLayout, SpreadLayout};
/// This struct represents a subscription record
/// # fields:
/// * provider
/// * plan
/// * plan_index
/// * subscription_time : this stores start time of each subscription (used in linkedList)
/// * characteristics_values_encrypted : this is the features that user has chosen for her subscription
/// * refunded
#[derive(scale::Encode, scale::Decode, SpreadLayout, PackedLayout, Debug)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct SubscriptionRecord {
pub provider: AccountId,
pub plan: PlanConsts,
pub plan_index: u128,
subscription_time: u64,
characteristics_values_encrypted: Vec<String>,
//encrypted Data with public key of provider
pub refunded: bool,
}
/// This struct stores user plan records
/// # fields:
/// * subscription_records
/// * pass_hash : hash of (token + pass_phrase) for authenticating user without wallet
#[derive(scale::Encode, scale::Decode, SpreadLayout, PackedLayout, Debug)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct PlanRecord {
pub subscription_records: Vec<SubscriptionRecord>,
pass_hash: [u8; 32],
}
/// This struct stores configs of plan which is set by provider
/// # Note
/// `max_refund_permille_policy` is out of 1000
#[derive(scale::Encode, scale::Decode, PackedLayout, SpreadLayout, Debug, Clone, Copy)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo, std::cmp::PartialEq))]
pub struct PlanConsts {
pub duration: u64,
pub(crate) price: u128,
pub(crate) max_refund_permille_policy: u128,
pub disabled: bool,
}
/// This struct represents a provider
/// # fields:
/// * plans
/// * money_address : provider earned money will be sent to this address
/// * payment_manager : struct for handling refund requests
/// * subscrypt_pass_hash : password of provider to login into SubsCrypt Dashboard
/// * plans_characteristics : array of key arrays of features of that plan
#[derive(scale::Encode, scale::Decode, PackedLayout, SpreadLayout, Debug)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct Provider {
pub plans: Vec<PlanConsts>,
pub(crate) plans_characteristics: Vec<Vec<String>>,
pub(crate) money_address: AccountId,
payment_manager: LinkedList,
pub subscrypt_pass_hash: [u8; 32],
}
/// This struct represents a user
/// # fields:
/// * list_of_providers : list of providers that the user subscribed to
/// * subscrypt_pass_hash : pass hash for retrieve data in subscrypt user dashboard
#[derive(scale::Encode, scale::Decode, SpreadLayout, PackedLayout, Debug)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct User {
pub list_of_providers: Vec<AccountId>,
pub subscrypt_pass_hash: [u8; 32],
}
/// Struct for handling payments of refund
/// # Description
///
/// This LinkedList is used for keeping tracking of each subscription that will end in some
/// specific date in future. We order these subscriptions by their date of expiration, so we
/// will be able to easily calculate and handle refund - withdraw methods with a minimum
/// transaction fee. Each entity of the linked-list is `PaymentAdmission` struct.
#[derive(scale::Encode, scale::Decode, PackedLayout, SpreadLayout, Debug)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct LinkedList {
pub head: u64,
pub back: u64,
pub length: u128,
}
/// Struct that represents amount of money that can be withdraw after its due date passed.
#[derive(scale::Encode, scale::Decode, PackedLayout, SpreadLayout, Debug)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
struct DailyLockedAmount {
amount: u128,
next_day: u64,
}
pub struct ProcessReturningData {
withdrawing_amount: u128,
current_linked_list_head: u64,
reduced_length: u128,
}
/// Main struct of contract
/// # fields:
/// * `start_time` : start time of the contract which is used in `LinkedList`
/// * `provider_register_fee`
/// * `providers` : the hashmap that stores providers data
/// * `users` : the hashmap that stores users data
/// * `daily_locked_amounts` : the hashmap that stores `DailyLockedAmount` data of each day in order
/// * `records` : the hashmap that stores user's subscription records data
/// * `plan_index_to_record_index` : the hashmap that stores user's last `SubscriptionRecord` index
/// * `PlanRecord.subscription_records` for each (user, provider, plan_index)
/// * `username_to_address` mapping of Usernames to Addresses
/// * `address_to_username` mapping of Addresses to Usernames
#[ink(storage)]
pub struct Subscrypt {
start_time: u64,
pub provider_register_fee: u128,
// (provider AccountId) -> provider data
pub providers: HashMap<AccountId, Provider>,
// (user AccountId) -> user data
pub users: HashMap<AccountId, User>,
// (provider AccountId , day_id) -> payment admission
daily_locked_amounts: HashMap<(AccountId, u64), DailyLockedAmount>,
// (user AccountId, provider AccountId) -> PlanRecord struct
pub records: HashMap<(AccountId, AccountId), PlanRecord>,
// (user AccountId, provider AccountId, plan_index) -> index
plan_index_to_record_index: HashMap<(AccountId, AccountId, u128), u128>,
// username -> user AccountId
username_to_address: HashMap<String, AccountId>,
// user AccountId -> username
address_to_username: HashMap<AccountId, String>,
}
impl Default for Subscrypt {
fn default() -> Self {
Self::new()
}
}
#[ink(event)]
pub struct ProviderRegisterEvent {
#[ink(topic)]
address: AccountId,
}
#[ink(event)]
pub struct AddPlanEvent {
#[ink(topic)]
provider: AccountId,
duration: u64,
price: u128,
index: u128,
}
#[ink(event)]
pub struct SubscribeEvent {
#[ink(topic)]
provider: AccountId,
#[ink(topic)]
plan_index: u128,
user_address: AccountId,
subscription_time: u64,
duration: u64,
price: u128,
characteristics: Vec<String>,
}
impl Subscrypt {
#[ink(constructor)]
pub fn new() -> Self {
Subscrypt::default()
}
#[ink(constructor)]
pub fn default() -> Self {
Self {
start_time: Self::env().block_timestamp(),
provider_register_fee: 100,
providers: HashMap::new(),
users: ink_storage::collections::HashMap::new(),
daily_locked_amounts: ink_storage::collections::HashMap::new(),
records: ink_storage::collections::HashMap::new(),
plan_index_to_record_index: ink_storage::collections::HashMap::new(),
username_to_address: ink_storage::collections::HashMap::new(),
address_to_username: ink_storage::collections::HashMap::new(),
}
}
/// Registering a new `Provider` by paying the required fee amount (`provider_register_fee`)
///
/// # Panics
/// if length of plan inputs are not the same
/// If paid amount is less than `provider_register_fee`
/// if same `AccountId` registered as provider previously.
/// if username is already been taken by someone else
///
/// # Emits
/// ProviderRegisterEvent
/// AddPlanEvent
///
/// # Examples
/// Examples of different situations in `tests/test.rs`
#[ink(message, payable)]
pub fn provider_register(
&mut self,
durations: Vec<u64>,
prices: Vec<u128>,
max_refund_permille_policies: Vec<u128>,
address: AccountId,
username: String,
subscrypt_pass_hash: [u8; 32],
plans_characteristics: Vec<Vec<String>>,
) {
assert_eq!(prices.len(), durations.len(), "Wrong Number of Args");
assert_eq!(
max_refund_permille_policies.len(),
durations.len(),
"Wrong Number of Args"
);
assert_eq!(
durations.len(),
plans_characteristics.len(),
"Wrong Number of Args"
);
let caller = self.env().caller();
let mut address_has_not_username: bool = true;
match self.address_to_username.get(&caller) {
Some(_) => {
address_has_not_username = false;
}
None => {
if let Some(address) = self.username_to_address.get(&username) {
assert_eq!(*address, caller, "this username is invalid!")
}
}
}
assert!(
self.env().transferred_balance() >= self.provider_register_fee,
"You have to pay a minimum amount to register in the contract!"
);
assert!(
!self.providers.contains_key(&caller),
"You can not register again in the contract!"
);
if address_has_not_username {
self.address_to_username.insert(caller, username.clone());
self.username_to_address.insert(username, caller);
}
let provider = Provider {
plans: Vec::new(),
plans_characteristics: Vec::new(),
money_address: address,
payment_manager: LinkedList::new(),
subscrypt_pass_hash,
};
self.providers.insert(caller, provider);
self.add_plan(
durations,
prices,
max_refund_permille_policies,
plans_characteristics,
);
self.env().emit_event(ProviderRegisterEvent { address });
}
/// Add plans to `provider` storage
///
/// # Panics
///
/// If the size of vectors passed to the method are different
/// If the caller is not a valid provider.
///
/// # Emits
/// AddPlanEvent
///
/// # Examples
/// Examples in `add_plan_works` , `add_plan_fails_wrong_arguments`
#[ink(message)]
pub fn add_plan(
&mut self,
durations: Vec<u64>,
prices: Vec<u128>,
max_refund_permille_policies: Vec<u128>,
plan_characteristics: Vec<Vec<String>>,
) {
assert_eq!(prices.len(), durations.len(), "Wrong Number of Args");
assert_eq!(
max_refund_permille_policies.len(),
durations.len(),
"Wrong Number of Args"
);
assert_eq!(
durations.len(),
plan_characteristics.len(),
"Wrong Number of Args"
);
let caller = self.env().caller();
let provider = match self.providers.get_mut(&caller) {
Some(x) => x,
None => panic!("You should first register in the contract!"),
};
let mut index: u128 = provider.plans.len().try_into().unwrap();
for i in 0..durations.len() {
provider.plans.push(PlanConsts {
duration: durations[i],
price: prices[i],
max_refund_permille_policy: max_refund_permille_policies[i],
disabled: false,
});
provider
.plans_characteristics
.push(plan_characteristics[i].clone());
}
for i in 0..durations.len() {
self.env().emit_event(AddPlanEvent {
provider: caller,
duration: durations[i],
price: prices[i],
index
});
index += 1;
}
}
/// Editing previously created plans of the `caller`
///
/// # Note
///
/// This will not effect the users that subscribed prior to the edition of plan
///
/// # Panics
///
/// If `plan_index` is bigger than the length of `plans` of `provider`
///
/// # Examples
/// Examples of different situations in `edit_plan_works` and `edit_plan_works2` in `tests/test.rs`
#[ink(message)]
pub fn edit_plan(
&mut self,
plan_index: u128,
duration: u64,
price: u128,
max_refund_permille_policies: u128,
disabled: bool,
) {
let number: usize = plan_index.try_into().unwrap();
let caller = self.env().caller();
let provider = match self.providers.get_mut(&caller) {
Some(x) => x,
None => panic!("You should first register in the contract!"),
};
let mut plan: &mut PlanConsts = match provider.plans.get_mut(number) {
Some(x) => x,
None => panic!("please select a valid plan"),
};
plan.duration = duration;
plan.price = price;
plan.max_refund_permille_policy = max_refund_permille_policies;
plan.disabled = disabled;
}
/// Adding new characteristics to existing plans
///
/// # Note
///
/// This will not effect the users that subscribed prior to the edition of plan
///
/// # Panics
/// If caller is not `provider`
/// If `plan_index` is bigger than the length of `plans` of `provider`
///
/// # Examples
/// Examples of different situations in `add_characteristic_for_plan_works`
#[ink(message)]
pub fn add_characteristic_for_plan(
&mut self,
plan_index: u128,
characteristics: Vec<String>,
) {
let number: usize = plan_index.try_into().unwrap();
let caller = self.env().caller();
let provider = match self.providers.get_mut(&caller) {
Some(x) => x,
None => panic!("You should first register in the contract!"),
};
let plan: &mut Vec<String> = match provider.plans_characteristics.get_mut(number) {
Some(x) => x,
None => panic!("please select a valid plan"),
};
for i in 0..characteristics.len() {
plan.push(characteristics[i].clone());
}
}
/// Disabling previously created plans of the `caller`
///
/// # Note
///
/// This will not effect the users that subscribed prior to the edition of plan
///
/// # Panics
///
/// If `plan_index` is bigger than the length of `plans` of `provider`
///
/// # Examples
/// Examples in `change_disable_works` in `tests/test.rs`
#[ink(message)]
pub fn change_disable(&mut self, plan_index: u128) {
let caller = self.env().caller();
let number: usize = plan_index.try_into().unwrap();
match self.providers.get_mut(&caller) {
Some(provider) => {
assert!(
provider.plans.len() > plan_index.try_into().unwrap(),
"please select a valid plan"
);
provider.plans[number].disabled = !provider.plans[number].disabled
}
None => panic!("You should first register in the contract!"),
}
}
/// Subscribing to `plan_index` of the `provider_address` with `Sha2x256` hashed `pass` and array of characteristics_values_encrypted
///
/// In this function, we will lock (`plan.max_refund_permille_policy` * `transferred_balance`) / 1000
/// in the `Linked List` of the contract and will transfer the rest of paid money directly to provider
///
/// # Note
///
/// The `subscrypt_pass_hash` will only be set if it's the first subscription of the `caller` to the `SubsCrypt` platform
/// `caller` can not subscribe to same `plan_index` of the same `provider_address` but
/// it can subscribe to different `plan_index` of same `provider_address` .
/// This line of code checks that if you previously subscribed to `provider_address` and if it's the first time
/// then `list_of_providers` will be updated.
/// `if !self.records.contains_key(&(caller, provider_address)) `
///
///
/// # Panics
/// If paid amount is not equal to `price` of the plan
/// If plan is `disabled`
/// If `caller` is already subscribed to plan
/// If `provider` does not exist
/// If `plan_index` is bigger than the length of `plans` of `provider_address`
/// If 'username' has already been taken
///
/// # Emits
/// SubscribeEvent
///
/// # Examples
/// Examples in `subscribe_works` and `subscribe_fails_insufficient_paying` in `tests/test.rs`
#[ink(message, payable)]
pub fn subscribe(
&mut self,
provider_address: AccountId,
plan_index: u128,
pass: [u8; 32],
username: String,
characteristics_values_encrypted: Vec<String>,
) {
let caller: AccountId = self.env().caller();
let time: u64 = self.env().block_timestamp();
assert!(
!self.check_subscription(caller, provider_address, plan_index),
"You are already subscribed to this plan!"
);
let provider = match self.providers.get(&provider_address) {
Some(provider) => provider,
None => panic!("Provider not existed in the contract!"),
};
let index: usize = plan_index.try_into().unwrap();
assert!(
provider.plans.len() > plan_index.try_into().unwrap(),
"Wrong plan index!"
);
let consts: PlanConsts = provider.plans[index];
let plan_characteristics: Vec<String> = provider.plans_characteristics[index].clone();
assert_eq!(
characteristics_values_encrypted.len(),
plan_characteristics.len(),
"invalid characteristic values!"
);
assert_eq!(
consts.price,
self.env().transferred_balance(),
"You have to pay exact plan price"
);
assert!(!consts.disabled, "Plan is currently disabled by provider");
let plan_characteristics: Vec<String> = provider.plans_characteristics[index].clone();
assert_eq!(
characteristics_values_encrypted.len(),
plan_characteristics.len(),
"invalid characteristic values!"
);
let mut address_has_not_username: bool = true;
if self.address_to_username.contains_key(&caller) {
address_has_not_username = false;
} else {
match self.username_to_address.get(&username) {
Some(_) => panic!("username is invalid!"),
None => {}
}
}
let addr: &AccountId = &provider.money_address;
// send money to money_address (1000 - plan.max_refund_permille_policy) / 1000;
assert_eq!(
self.transfer(
*addr,
consts.price * (1000 - consts.max_refund_permille_policy) / 1000
),
Ok(())
);
if address_has_not_username {
self.address_to_username.insert(caller, username.clone());
self.username_to_address.insert(username, caller);
}
if !self.users.contains_key(&caller) {
self.users.insert(
caller,
User {
list_of_providers: Vec::new(),
subscrypt_pass_hash: pass,
},
);
}
let characteristics_values: Vec<String> = characteristics_values_encrypted.clone();
let subscription_record = SubscriptionRecord {
provider: provider_address,
plan: consts,
plan_index,
subscription_time: time,
characteristics_values_encrypted,
refunded: false,
};
if let Some(plan_record) = self.records.get_mut(&(caller, provider_address)) {
self.plan_index_to_record_index.insert(
(caller, provider_address, plan_index),
plan_record.subscription_records.len().try_into().unwrap(),
);
plan_record.subscription_records.push(subscription_record);
} else {
self.users
.get_mut(&caller)
.unwrap()
.list_of_providers
.push(provider_address);
let plan_record: PlanRecord = PlanRecord {
subscription_records: vec![subscription_record],
pass_hash: pass,
};
self.records.insert((caller, provider_address), plan_record);
self.plan_index_to_record_index
.insert((caller, provider_address, plan_index), 0);
}
self.add_entry(
provider_address,
(time + consts.duration - self.start_time) / 86400,
(self.env().transferred_balance() * consts.max_refund_permille_policy) / 1000,
);
self.env().emit_event(SubscribeEvent {
provider: provider_address,
plan_index,
user_address: caller,
subscription_time: time,
duration: consts.duration,
price: consts.price,
characteristics: characteristics_values
});
}
/// Renewing subscription of `plan_index` of the `provider_address` array of characteristics_values_encrypted
///
/// In this function, we will first unlock (`plan.max_refund_permille_policy` * `transferred_balance`) / 1000
/// in the `Linked List` of the contract and will also send that alongside the ((1000 - `plan.max_refund_permille_policy`) * `transferred_balance`) / 1000
/// of new recieved money and send that to provider. And (`plan.max_refund_permille_policy` * `transferred_balance`) / 1000 will be locked in the `Linked List`
///
/// # Note
///
/// The start of that renewed subscription will be at the end of current subscription.
/// The current subscription can not be refunded.
///
///
/// # Panics
/// If paid amount is not equal to `price` of the plan
/// If plan is `disabled`
/// If `caller` is not already subscribed to plan
/// If `provider` does not exist
/// If `plan_index` is bigger than the length of `plans` of `provider_address`
///
/// # Emits
/// SubscribeEvent
///
/// # Examples
/// Examples in `renew_works` in `tests/test.rs`
#[ink(message, payable)]
pub fn renew(
&mut self,
provider_address: AccountId,
plan_index: u128,
new_characteristics_values: Vec<String>,
) {
let caller: AccountId = self.env().caller();
if !self.plan_index_to_record_index.contains_key(&(
caller,
provider_address,
plan_index,
)) {
panic!("You should have been subscribed to this plan for renew!");
}
let last_index: u128 =
match self
.plan_index_to_record_index
.get(&(caller, provider_address, plan_index))
{
Some(index) => *index,
None => panic!("index is not valid!"),
};
let number: usize = last_index.try_into().unwrap();
let record = &self
.records
.get(&(caller, provider_address))
.unwrap()
.subscription_records[number];
if record.plan_index != plan_index
|| record.refunded
|| record.plan.duration + record.subscription_time < self.env().block_timestamp()
{
panic!("You should have been subscribed to this plan for renew!");
}
let provider = match self.providers.get(&provider_address) {
Some(provider) => provider,
None => panic!("Provider not existed in the contract!"),
};
let start_time: u64 = record.plan.duration + record.subscription_time;
let index: usize = plan_index.try_into().unwrap();
let consts: PlanConsts = provider.plans[index];
assert_eq!(
consts.price,
self.env().transferred_balance(),
"You have to pay exact plan price"
);
assert!(!consts.disabled, "Plan is currently disabled by provider");
let plan_characteristics: Vec<String> = provider.plans_characteristics[index].clone();
assert_eq!(
new_characteristics_values.len(),
plan_characteristics.len(),
"invalid characteristic values!"
);
let addr: &AccountId = &provider.money_address;
// send money to money_address (1000 - plan.max_refund_permille_policy) / 1000;
assert_eq!(
self.transfer(
*addr,
consts.price * (1000 - consts.max_refund_permille_policy) / 1000
),
Ok(())
);
let promised_amount = record.plan.price * record.plan.max_refund_permille_policy / 1000;
assert_eq!(
self.transfer(provider.money_address, promised_amount),
Ok(())
);
let passed_time = record.plan.duration + record.subscription_time - self.start_time;
let subscription_record = SubscriptionRecord {
provider: provider_address,
plan: consts,
plan_index,
subscription_time: start_time,
characteristics_values_encrypted: new_characteristics_values.clone(),
refunded: false,
};
self.remove_entry(
provider_address,
passed_time / 86400,
promised_amount / 1000,
);
let plan_record = self.records.get_mut(&(caller, provider_address)).unwrap();
self.plan_index_to_record_index.insert(
(caller, provider_address, plan_index),
plan_record.subscription_records.len().try_into().unwrap(),
);
plan_record.subscription_records.push(subscription_record);
self.add_entry(
provider_address,
(start_time + consts.duration - self.start_time) / 86400,
(self.env().transferred_balance() * consts.max_refund_permille_policy) / 1000,
);
self.env().emit_event(SubscribeEvent {
provider: provider_address,
plan_index,
user_address: caller,
subscription_time: start_time,
duration: consts.duration,
price: consts.price,
characteristics: new_characteristics_values.clone(),
});
}
/// Setting the `subscrypt_pass_hash` of caller to `pass`
///
/// # Note
///
/// The `subscrypt_pass_hash` will also be set in `subscribe` function in first subscription
///
///
/// # Panics
/// If `caller` does not exist in `users`
#[ink(message)]
pub fn set_user_subscrypt_pass(&mut self, pass: [u8; 32]) {
match self.users.get_mut(&self.env().caller()) {
Some(x) => x.subscrypt_pass_hash = pass,
None => panic!("User doesn't exist!"),
};
}
/// Setting the `pass_hash` of caller in specific provider to `pass`
///
/// # Panics
/// If `caller` does not exist in `users`
#[ink(message)]
pub fn subs_crypt_pass_hash_for_each_provider(
&mut self,
provider_address: AccountId,
pass: [u8; 32],
) {
match self
.records
.get_mut(&(self.env().caller(), provider_address))
{
Some(x) => x.pass_hash = pass,
None => panic!("User doesn't exist!"),
};
}
/// Setting the `subscrypt_pass_hash` of caller to `pass`
///
/// # Note
///
/// The `subscrypt_pass_hash` will also be set in `provider_register` function in first subscription
///
///
/// # Panics
/// If `caller` does not exist in `providers`
#[ink(message)]
pub fn set_provider_subscrypt_pass(&mut self, pass: [u8; 32]) {
match self.providers.get_mut(&self.env().caller()) {
Some(x) => x.subscrypt_pass_hash = pass,
None => panic!("User doesn't exist!"),
};
}
/// This function is used when providers want to collect the locked money for refund policy
///
/// In this function, we will unlock that money which was locked in `subscribe` function via the
/// LinkedList mechanism, so providers can `withdraw` them when the due date passed.
///
/// # Returns
/// `paid` amount is returned
///
/// # Panics
/// If `provider` does not exist
///
/// # Examples
/// Examples in `withdraw_works` and `withdraw_works2` in `tests/test.rs`
#[ink(message)]
pub fn withdraw(&mut self) -> u128 {
assert!(
self.providers.contains_key(&self.env().caller()),
"You are not a registered provider"
);
let caller: AccountId = self.env().caller();
let t = self.process(caller, self.env().block_timestamp() / 86400);
if t.withdrawing_amount > 0 {
assert_eq!(self.transfer(caller, t.withdrawing_amount), Ok(()));
}
let linked_list: &mut LinkedList =
&mut self.providers.get_mut(&caller).unwrap().payment_manager;
linked_list.length -= t.reduced_length;
linked_list.head = t.current_linked_list_head;
return t.withdrawing_amount;
}
/// `users` can use this function to easily refund their subscription as the policy of that
/// specific plan was set. The `users` will be paid back at most
/// (`plan.max_refund_permille_policy` * `transferred_balance`) / 1000 and it will be linearly
/// decreased as time passed and will get to 0. The `provider` will get 0 at least and will linearly
/// get more if `user` refund later.
///
/// # Returns
/// `paid` amount is returned
///
/// # Panics
/// If `provider` does not exist
///
/// # Examples
/// Assume that `plan.max_refund_permille_policy` = 500 and `plan.price` = 100 the duration
/// of the plan is a month(30 days month). if `user` refund in first half of the month, then the user will
/// be paid 50. if `user` refund in day 20th of month then `user` will be paid 33.33 and `provider`
/// will be paid 16.66.
/// Other Examples in `refund_works` and `refund_works2` in `tests/test.rs`
#[ink(message)]
pub fn refund(&mut self, provider_address: AccountId, plan_index: u128) -> u128 {
let caller: AccountId = self.env().caller();
let time: u64 = self.env().block_timestamp();
assert!(
self.check_subscription(caller, provider_address, plan_index),
"You are not in this plan or already refunded"
);
let last_index =
match self
.plan_index_to_record_index
.get(&(caller, provider_address, plan_index))
{
Some(index) => index,
None => panic!("index is not valid!"),
};
let number: usize = (*last_index).try_into().unwrap();
let record: &SubscriptionRecord = self
.records
.get(&(caller, provider_address))
.unwrap()
.subscription_records
.get(number)
.unwrap();
assert!(time - record.subscription_time < record.plan.duration);
let promised_amount = record.plan.price * record.plan.max_refund_permille_policy;
let price: u64 = (record.plan.price * 1000).try_into().unwrap();
let used: u64 = price * (time - record.subscription_time) / record.plan.duration;
let mut customer_portion_locked_money: u128 = (price - used).try_into().unwrap();
if customer_portion_locked_money > promised_amount {
// in this case the customer wants to refund very early so he want to get
// more than the amount of refund policy, so we can only give back just
// max_refund_permille_policy of his/her subscription. Whole locked money will go directly to
// account of the customer
customer_portion_locked_money = promised_amount;
} else {
// in this case the customer wants to refund, but he/she used most of his subscription time
// and now he/she will get portion of locked money, and the provider will get the rest of money
let provider_portion_locked_money =
(promised_amount - customer_portion_locked_money) / 1000;
assert_eq!(
self.transfer(
self.providers.get(&provider_address).unwrap().money_address,
provider_portion_locked_money
),
Ok(())
);
}
assert_eq!(
self.transfer(caller, customer_portion_locked_money / 1000),
Ok(())
);
let passed_time = record.plan.duration + record.subscription_time - self.start_time;
self.remove_entry(
provider_address,
passed_time / 86400,
promised_amount / 1000,
);
self.records
.get_mut(&(caller, provider_address))
.unwrap()
.subscription_records
.get_mut(number)
.unwrap()
.refunded = true;
customer_portion_locked_money
}
/// This function returns the withdrawable amount
///
/// # Returns
/// `paid` amount is returned
///
/// # Panics
/// If `provider` does not exist
///
/// # Examples
/// Examples in `withdraw_works` and `withdraw_works2` in `tests/test.rs`
#[ink(message)]
pub fn get_withdrawable_amount(&self) -> u128 {
assert!(
self.providers.contains_key(&self.env().caller()),
"You are not a registered provider"
);
let caller: AccountId = self.env().caller();
let t = self.process(caller, self.env().block_timestamp() / 86400);
t.withdrawing_amount
}
/// This function indicate if `user` can authenticate with given `pass_phrase`
/// # Note
/// `user` are encouraged to have different `pass_phrase` for each provider
///
/// # Returns
/// `bool` is returned which shows the correctness of auth
///
/// # Example
/// Examples in `check_auth_works` in `tests/test.rs`
#[ink(message)]
pub fn check_auth(
&self,
user: AccountId,
provider: AccountId,
pass_phrase: String,
) -> bool {
return match self.records.get(&(user, provider)) {
Some(record) => {
let encoded = self.env().hash_encoded::<Sha2x256, _>(&pass_phrase);
return encoded == record.pass_hash;
}
None => false,
};
}