-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmatching_round.py
1665 lines (1377 loc) · 57.3 KB
/
matching_round.py
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
import smartpy as sp
Addresses = sp.io.import_script_from_url("file:helpers/addresses.py")
DummyToken = sp.io.import_script_from_url("file:helpers/dummy_token.py")
DummyCommunityFund = sp.io.import_script_from_url("file:helpers/dummy_community_fund.py")
Errors = sp.io.import_script_from_url("file:types/errors.py")
Round = sp.io.import_script_from_url("file:types/round.py")
Entry = sp.io.import_script_from_url("file:types/entry.py")
############
# Constants
############
# Token identifier for tez contributions
TEZ_IDENTIFIER = sp.pack("TEZ_IDENTIFIER")
# Mandatory security deposit for the entries. Refundable only if the entry is not disqualified.
# Transferred to community fund otherwise.
SECURITY_DEPOSIT_AMOUNT = sp.tez(10)
#################
# Time constants
#################
# Seconds in a day
DAY = 86400
# Timestamp when entries can start accepting contributions
CONTRIBUTION_START = sp.timestamp(5)
# Length of period in which contributions can be accepted by the entries.
CONTRIBUTION_PERIOD = 30 * DAY
# Length of period in which the contributions can be assessed, and dubious entries be disqualfied
COOLDOWN_PERIOD = 7 * DAY
# Length of period in which the set CLR matches can be challenged in the DAO
CHALLENGE_PERIOD = 7 * DAY
#################
# Default values
#################
ROUND_EVENT_TIMESTAMPS = sp.record(
contribution_start=CONTRIBUTION_START,
contribution_end=CONTRIBUTION_START.add_seconds(CONTRIBUTION_PERIOD),
cooldown_period_end=CONTRIBUTION_START.add_seconds(CONTRIBUTION_PERIOD + COOLDOWN_PERIOD),
challenge_period_end=sp.timestamp(0),
)
ROUND_META = sp.record(
token_set=sp.set([TEZ_IDENTIFIER]),
security_deposit_amount=SECURITY_DEPOSIT_AMOUNT,
stablecoin_address=Addresses.STABLECOIN,
donation_handler_address=Addresses.DONATION_HANDLER,
community_fund_address=Addresses.COMMUNITY_FUND,
)
###########
# Contract
###########
class MatchingRound(sp.Contract):
def __init__(
self,
admin=Addresses.DAO,
round_event_timestamps=ROUND_EVENT_TIMESTAMPS,
round_meta=ROUND_META,
entries=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=Entry.ENTRY_TYPE,
),
contributions=sp.big_map(
l={},
tkey=sp.TPair(sp.TAddress, sp.TNat),
tvalue=sp.TRecord(token_identifier=sp.TBytes, value=sp.TNat).layout(
("token_identifier", "value")
),
),
entry_address_to_id=sp.big_map(
l={},
tkey=sp.TAddress,
tvalue=sp.TNat,
),
sponsors=sp.map(
l={},
tkey=sp.TAddress,
tvalue=sp.TNat,
),
total_sponsored_amount=sp.nat(0),
matches_set=sp.bool(False),
):
self.init_type(
sp.TRecord(
admin=sp.TAddress,
round_event_timestamps=Round.ROUND_EVENT_TIMESTAMPS_TYPE,
round_meta=Round.ROUND_META_TYPE,
entries=sp.TBigMap(sp.TNat, Entry.ENTRY_TYPE),
contributions=sp.TBigMap(
sp.TPair(sp.TAddress, sp.TNat),
sp.TRecord(token_identifier=sp.TBytes, value=sp.TNat).layout(
("token_identifier", "value")
),
),
entry_address_to_id=sp.TBigMap(sp.TAddress, sp.TNat),
sponsors=sp.TMap(sp.TAddress, sp.TNat),
total_sponsored_amount=sp.TNat,
uuid=sp.TNat,
matches_set=sp.TBool,
)
)
self.init(
admin=admin,
round_event_timestamps=round_event_timestamps,
round_meta=round_meta,
entries=entries,
contributions=contributions,
entry_address_to_id=entry_address_to_id,
sponsors=sponsors,
total_sponsored_amount=total_sponsored_amount,
uuid=sp.nat(0),
matches_set=matches_set,
)
@sp.entry_point
def sponsor(self, value):
sp.set_type(value, sp.TNat)
# Verify that sender has not sponsored already
sp.verify(~self.data.sponsors.contains(sp.sender), Errors.ALREADY_SPONSORED)
# Verify that sponsored amount is greater than 0
sp.verify(value > 0, Errors.ZERO_VALUE_NOT_ALLOWED)
# Verify that sponsorship period is still active
sp.verify(
sp.now < self.data.round_event_timestamps.contribution_start,
Errors.NOT_ACCEPTING_SPONSORS,
)
# Retrieve sponsored amount from sender's address (in the mentioned stablecoin)
c = sp.contract(
sp.TRecord(from_=sp.TAddress, to_=sp.TAddress, value=sp.TNat).layout(
("from_ as from", ("to_ as to", "value"))
),
self.data.round_meta.stablecoin_address,
"transfer",
).open_some(Errors.INVALID_STABLECOIN)
sp.transfer(sp.record(from_=sp.sender, to_=sp.self_address, value=value), sp.mutez(0), c)
# Required storage updates
self.data.sponsors[sp.sender] = value
self.data.total_sponsored_amount += value
@sp.entry_point
def enter_round(self, address):
sp.set_type(address, sp.TAddress)
# Verify that entry is not already in the round
sp.verify(~self.data.entry_address_to_id.contains(address), Errors.ALREADY_IN_ROUND)
# Verify that timing is correct
sp.verify(
sp.now < self.data.round_event_timestamps.contribution_start, Errors.ENTRY_PERIOD_OVER
)
# Verify that sent amount equals the security deposit
sp.verify(
sp.amount == self.data.round_meta.security_deposit_amount,
Errors.INVALID_SECURITY_DEPOSIT,
)
entry = sp.record(
address=address,
creator=sp.sender,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
)
# Insert entry into storage
self.data.uuid += 1
self.data.entries[self.data.uuid] = entry
self.data.entry_address_to_id[address] = self.data.uuid
@sp.entry_point
def contribute(self, params):
sp.set_type(
params,
sp.TRecord(
from_=sp.TAddress,
entry_address=sp.TAddress,
token_identifier=sp.TBytes,
value=sp.TNat,
).layout(
(
"from_",
(
"entry_address",
("token_identifier", "value"),
),
),
),
)
# Verify that the sender is the donation handler
sp.verify(sp.sender == self.data.round_meta.donation_handler_address, Errors.NOT_ALLOWED)
# Verify that the entry exists
sp.verify(
self.data.entry_address_to_id.contains(params.entry_address),
Errors.INVALID_ENTRY_ADDRESS,
)
timestamps = self.data.round_event_timestamps
# Verify that contribution period is on-going
sp.verify(
(sp.now >= timestamps.contribution_start) & (sp.now < timestamps.contribution_end),
Errors.NOT_ACCEPTING_CONTRIBUTIONS,
)
entry_id = self.data.entry_address_to_id[params.entry_address]
entry = self.data.entries[entry_id]
# Verify that entry is active i.e not disqualified
sp.verify(entry.status == Entry.ENTRY_STATUS_ACTIVE, Errors.ENTRY_NOT_ACTIVE)
# Verify that the contributor has not contributed already
sp.verify(
~self.data.contributions.contains((params.from_, entry_id)), Errors.ALREADY_CONTRIBUTED
)
# Verify that it is not a self contribution
sp.verify(
(params.from_ != entry.address) & (params.from_ != entry.creator),
Errors.SELF_CONTRIBUTION_NOT_ALLOWED,
)
# Verify that the token_identifier is accepted
sp.verify(
self.data.round_meta.token_set.contains(params.token_identifier),
Errors.INVALID_TOKEN_IDENTIFIER,
)
# Insert contribution into the contributions BIGMAP
self.data.contributions[(params.from_, entry_id)] = sp.record(
token_identifier=params.token_identifier, value=params.value
)
@sp.entry_point
def disqualify_entries(self, entry_list):
sp.set_type(entry_list, sp.TList(sp.TNat))
# Verify that the sender is the admin
sp.verify(sp.sender == self.data.admin, Errors.NOT_ALLOWED)
# Verify that the timing is correct
sp.verify(
sp.now < self.data.round_event_timestamps.cooldown_period_end,
Errors.COOLDOWN_PERIOD_OVER,
)
# Loop through the supplied entries and disqualify them
sp.for entry_id in entry_list:
# If entry is already disqualified then revert the operation
sp.if self.data.entries[entry_id].status == Entry.ENTRY_STATUS_DISQUALIFIED:
sp.failwith(Errors.ENTRY_ALREADY_DISQUALIFIED)
self.data.entries[entry_id].status = Entry.ENTRY_STATUS_DISQUALIFIED
# Transfer security deposit of the disqualified entries to the community-fund
security_deposit_nat = sp.utils.mutez_to_nat(self.data.round_meta.security_deposit_amount)
sp.send(
self.data.round_meta.community_fund_address,
sp.utils.nat_to_mutez(security_deposit_nat * sp.len(entry_list)),
)
# Allows admin to set the matches for the entries once the cooldown period is over
@sp.entry_point
def set_clr_matches(self, matches_map):
sp.set_type(matches_map, sp.TMap(sp.TNat, sp.TNat))
# Verify that sender is the admin
sp.verify(sp.sender == self.data.admin, Errors.NOT_ALLOWED)
sp.verify(
sp.now > self.data.round_event_timestamps.cooldown_period_end, Errors.COOLDOWN_NOT_OVER
)
sp.if ~self.data.matches_set:
# Set the challenge period end timestamp
self.data.round_event_timestamps.challenge_period_end = sp.now.add_seconds(
CHALLENGE_PERIOD
)
self.data.matches_set = True
# Verify that the timing is correct
sp.verify(
sp.now < self.data.round_event_timestamps.challenge_period_end,
Errors.CHALLENGE_PERIOD_OVER,
)
# Loop through the matches map and set the clr match
sp.for entry_id in matches_map.keys():
self.data.entries[entry_id].clr_match = matches_map[entry_id]
@sp.entry_point
def withdraw_match(self, address):
sp.set_type(address, sp.TAddress)
# Verify that entry address exists in the round
sp.verify(self.data.entry_address_to_id.contains(address), Errors.INVALID_ENTRY_ADDRESS)
entry_id = self.data.entry_address_to_id[address]
entry = self.data.entries[entry_id]
# Verify that the entry is still active (not disqualified or already retrieved match)
sp.verify(entry.status == Entry.ENTRY_STATUS_ACTIVE, Errors.ENTRY_NOT_ACTIVE)
# Verify that the matches have been set
sp.verify(self.data.matches_set, Errors.MATCHES_NOT_SET)
# Verify that timing is correct
sp.verify(
sp.now > self.data.round_event_timestamps.challenge_period_end,
Errors.CHALLENGE_PERIOD_ONGOING,
)
# Verify that entry has a non-zero match
sp.verify(entry.clr_match != 0, Errors.ZERO_CLR_MATCH)
# Transfer the match to the entry address
c = sp.contract(
sp.TRecord(from_=sp.TAddress, to_=sp.TAddress, value=sp.TNat).layout(
("from_ as from", ("to_ as to", "value"))
),
self.data.round_meta.stablecoin_address,
"transfer",
).open_some(Errors.INVALID_STABLECOIN)
sp.transfer(
sp.record(
from_=sp.self_address,
to_=entry.address,
value=entry.clr_match,
),
sp.tez(0),
c,
)
# Set entry status to closed
entry.status = Entry.ENTRY_STATUS_CLOSED
@sp.entry_point
def withdraw_deposit(self, address):
sp.set_type(address, sp.TAddress)
# Verify that entry address exists in the round
sp.verify(self.data.entry_address_to_id.contains(address), Errors.INVALID_ENTRY_ADDRESS)
entry_id = self.data.entry_address_to_id[address]
entry = self.data.entries[entry_id]
# Verify that the entry has not been disqualified
sp.verify(entry.status != Entry.ENTRY_STATUS_DISQUALIFIED, Errors.ENTRY_DISQUALIFIED)
# Verify that cooldown period is over
sp.verify(
sp.now > self.data.round_event_timestamps.cooldown_period_end, Errors.COOLDOWN_NOT_OVER
)
# Verify that entry has not withdrawn the deposit already
sp.verify(~entry.deposit_withdrawn, Errors.DEPOSIT_ALREADY_WITHDRAWN)
# Send deposit back to entry's creator
sp.send(entry.creator, self.data.round_meta.security_deposit_amount)
entry.deposit_withdrawn = True
##########
# Tests
##########
if __name__ == "__main__":
##########
# sponsor
##########
@sp.add_test(name="sponsor accepts sponsored amount")
def test():
scenario = sp.test_scenario()
stablecoin = DummyToken.FA12(Addresses.ADMIN)
round_meta = sp.record(
token_set=sp.set([TEZ_IDENTIFIER]),
security_deposit_amount=SECURITY_DEPOSIT_AMOUNT,
stablecoin_address=stablecoin.address,
donation_handler_address=Addresses.DONATION_HANDLER,
community_fund_address=Addresses.COMMUNITY_FUND,
)
matching_round = MatchingRound(round_meta=round_meta)
scenario += matching_round
scenario += stablecoin
# Mint the stablecoin for ALICE and BOB
scenario += stablecoin.mint(address=Addresses.ALICE, value=1000).run(sender=Addresses.ADMIN)
scenario += stablecoin.mint(address=Addresses.BOB, value=1000).run(sender=Addresses.ADMIN)
# Approve matching round contract to spend the tokens
scenario += stablecoin.approve(spender=matching_round.address, value=1000).run(
sender=Addresses.ALICE
)
scenario += stablecoin.approve(spender=matching_round.address, value=1000).run(
sender=Addresses.BOB
)
# ALICE calls sponsor entrypoint
scenario += matching_round.sponsor(800).run(sender=Addresses.ALICE, now=sp.timestamp(1))
# BOB calls sponsor entrypoint
scenario += matching_round.sponsor(500).run(sender=Addresses.BOB, now=sp.timestamp(2))
# Sponsorship has been correctly recorded
scenario.verify(sp.len(matching_round.data.sponsors) == 2)
scenario.verify(matching_round.data.sponsors[Addresses.ALICE] == 800)
scenario.verify(matching_round.data.sponsors[Addresses.BOB] == 500)
scenario.verify(matching_round.data.total_sponsored_amount == 1300)
# Token balance check for matching round
scenario.verify(stablecoin.data.balances[matching_round.address].balance == 1300)
@sp.add_test(name="sponsor fails if sender has already sponsored")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(sponsors={Addresses.ALICE: 1000})
scenario += matching_round
# ALICE calls sponsor even though she sponsored before
scenario += matching_round.sponsor(1000).run(
sender=Addresses.ALICE, valid=False, exception=Errors.ALREADY_SPONSORED
)
@sp.add_test(name="sponsor fails if the sponsor period is over")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound()
scenario += matching_round
# ALICE calls sponsor when public contributions have already started
scenario += matching_round.sponsor(1000).run(
sender=Addresses.ALICE,
now=sp.timestamp(6),
valid=False,
exception=Errors.NOT_ACCEPTING_SPONSORS,
)
@sp.add_test(name="sponsor fails if zero value is sponsored")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound()
scenario += matching_round
# ALICE calls sponsor when public contributions have already started
scenario += matching_round.sponsor(0).run(
sender=Addresses.ALICE,
now=sp.timestamp(3),
valid=False,
exception=Errors.ZERO_VALUE_NOT_ALLOWED,
)
##############
# enter_round
##############
@sp.add_test(name="enter_round allows entry to the round")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound()
scenario += matching_round
scenario += matching_round.enter_round(Addresses.ENTRY_1).run(
sender=Addresses.JOHN, now=sp.timestamp(2), amount=SECURITY_DEPOSIT_AMOUNT
)
scenario += matching_round.enter_round(Addresses.ENTRY_2).run(
sender=Addresses.BOB, now=sp.timestamp(2), amount=SECURITY_DEPOSIT_AMOUNT
)
# Sanity checks
scenario.verify(matching_round.data.entry_address_to_id.contains(Addresses.ENTRY_1))
scenario.verify(matching_round.data.entry_address_to_id.contains(Addresses.ENTRY_2))
entry_1 = matching_round.data.entries[
matching_round.data.entry_address_to_id[Addresses.ENTRY_1]
]
entry_2 = matching_round.data.entries[
matching_round.data.entry_address_to_id[Addresses.ENTRY_2]
]
# Verify that ENTRY_1 has the correct fields
scenario.verify(entry_1.address == Addresses.ENTRY_1)
scenario.verify(entry_1.creator == Addresses.JOHN)
scenario.verify(entry_1.status == Entry.ENTRY_STATUS_ACTIVE)
scenario.verify(entry_1.clr_match == 0)
scenario.verify(entry_1.deposit_withdrawn == False)
# Verify that ENTRY_2 has the correct fields
scenario.verify(entry_2.address == Addresses.ENTRY_2)
scenario.verify(entry_2.creator == Addresses.BOB)
scenario.verify(entry_2.status == Entry.ENTRY_STATUS_ACTIVE)
scenario.verify(entry_2.clr_match == 0)
scenario.verify(entry_2.deposit_withdrawn == False)
@sp.add_test(name="enter_round fails if address is already in the round")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}))
scenario += matching_round
# ENTRY_1 is already in the round, but still tries to re-enter
scenario += matching_round.enter_round(Addresses.ENTRY_1).run(
sender=Addresses.JOHN,
now=sp.timestamp(1),
amount=SECURITY_DEPOSIT_AMOUNT,
valid=False,
exception=Errors.ALREADY_IN_ROUND,
)
@sp.add_test(name="enter_round fails if entry period is over")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound()
scenario += matching_round
# Entry requested 1 second after contribution starts (not valid)
scenario += matching_round.enter_round(Addresses.ENTRY_1).run(
sender=Addresses.JOHN,
now=sp.timestamp(6),
amount=SECURITY_DEPOSIT_AMOUNT,
valid=False,
exception=Errors.ENTRY_PERIOD_OVER,
)
@sp.add_test(name="enter_round fails if incorrect security deposit it made")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound()
scenario += matching_round
# Sender has not provided sufficient security deposit
scenario += matching_round.enter_round(Addresses.ENTRY_1).run(
sender=Addresses.JOHN,
now=sp.timestamp(3),
amount=sp.tez(1),
valid=False,
exception=Errors.INVALID_SECURITY_DEPOSIT,
)
#############
# contribute
#############
# Generic entry
ENTRY = sp.record(
address=Addresses.ENTRY_1,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
)
@sp.add_test(name="contribute records the contribution properly")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# Contribution from ALICE to ENTRY_1
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
)
# Contribution from BOB to ENTRY_1
scenario += matching_round.contribute(
from_=Addresses.BOB,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=200,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
)
entry = matching_round.data.entries[1]
# Verify that contributions are recorded and are correct
scenario.verify(matching_round.data.contributions.contains((Addresses.ALICE, 1)))
scenario.verify(matching_round.data.contributions.contains((Addresses.BOB, 1)))
scenario.verify(
matching_round.data.contributions[(Addresses.ALICE, 1)]
== sp.record(token_identifier=TEZ_IDENTIFIER, value=100)
)
scenario.verify(
matching_round.data.contributions[(Addresses.BOB, 1)]
== sp.record(token_identifier=TEZ_IDENTIFIER, value=200)
)
@sp.add_test(name="contribute fails if the sender is not donation_handler")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# Contribution from ALICE to ENTRY_1 not sent through donation handler contracr
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.RANDOM,
now=sp.timestamp(6),
valid=False,
exception=Errors.NOT_ALLOWED,
)
@sp.add_test(name="contribute fails if the entry_address is not in the round")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# Contribution from ALICE to non existing entry address
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.RANDOM,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
valid=False,
exception=Errors.INVALID_ENTRY_ADDRESS,
)
@sp.add_test(name="contribute fails if the contribution is not made in the correct period")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# Contribution from ALICE to ENTRY_1 before contribution starts
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(4),
valid=False,
exception=Errors.NOT_ACCEPTING_CONTRIBUTIONS,
)
# Contribution from ALICE to ENTRY_1 after contribution period ends
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=CONTRIBUTION_START.add_seconds(CONTRIBUTION_PERIOD + 1),
valid=False,
exception=Errors.NOT_ACCEPTING_CONTRIBUTIONS,
)
@sp.add_test(name="contribute fails if the entry is not active")
def test():
scenario = sp.test_scenario()
entry = sp.record(
address=Addresses.ENTRY_1,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_DISQUALIFIED,
clr_match=0,
deposit_withdrawn=False,
)
matching_round = MatchingRound(
entries=sp.big_map(l={1: entry}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# Contribution from ALICE to disqualified ENTRY_1
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
valid=False,
exception=Errors.ENTRY_NOT_ACTIVE,
)
@sp.add_test(name="contribute fails if the contributor has already contributed")
def test():
scenario = sp.test_scenario()
entry = sp.record(
address=Addresses.ENTRY_1,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
)
matching_round = MatchingRound(
entries=sp.big_map(l={1: entry}),
contributions=sp.big_map(
l={(Addresses.ALICE, 1): sp.record(token_identifier=TEZ_IDENTIFIER, value=10)}
),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# ALICE re-contributes to ENTRY_1
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
valid=False,
exception=Errors.ALREADY_CONTRIBUTED,
)
@sp.add_test(name="contribute fails for self-contributions")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# JOHN (creator of ENTRY_1) self contributes
scenario += matching_round.contribute(
from_=Addresses.JOHN,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
valid=False,
exception=Errors.SELF_CONTRIBUTION_NOT_ALLOWED,
)
# ENTRY_1 self contributes to itself
scenario += matching_round.contribute(
from_=Addresses.ENTRY_1,
entry_address=Addresses.ENTRY_1,
token_identifier=TEZ_IDENTIFIER,
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
valid=False,
exception=Errors.SELF_CONTRIBUTION_NOT_ALLOWED,
)
@sp.add_test(name="contribute fails if incorrect token identifier is used")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# ALICE uses an unknown token identifier
scenario += matching_round.contribute(
from_=Addresses.ALICE,
entry_address=Addresses.ENTRY_1,
token_identifier=sp.pack("unknown"),
value=100,
).run(
sender=Addresses.DONATION_HANDLER,
now=sp.timestamp(6),
valid=False,
exception=Errors.INVALID_TOKEN_IDENTIFIER,
)
#####################
# disqualify_entries
#####################
@sp.add_test(name="disqualify_entries can disqualify a single entry")
def test():
scenario = sp.test_scenario()
entries = sp.big_map(
l={
1: sp.record(
address=Addresses.ENTRY_1,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
),
2: sp.record(
address=Addresses.ENTRY_2,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
),
3: sp.record(
address=Addresses.ENTRY_3,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
),
}
)
community_fund = DummyCommunityFund.DummyCommunityFund()
community_fund.set_initial_balance(sp.tez(0))
round_meta = sp.record(
token_set=sp.set([TEZ_IDENTIFIER]),
security_deposit_amount=SECURITY_DEPOSIT_AMOUNT,
stablecoin_address=Addresses.STABLECOIN,
donation_handler_address=Addresses.DONATION_HANDLER,
community_fund_address=community_fund.address,
)
matching_round = MatchingRound(entries=entries, round_meta=round_meta)
security_deposit_nat = sp.utils.mutez_to_nat(SECURITY_DEPOSIT_AMOUNT)
matching_round.set_initial_balance(sp.utils.nat_to_mutez(security_deposit_nat * 3))
scenario += matching_round
scenario += community_fund
# Disqualify entry 1
scenario += matching_round.disqualify_entries(sp.list([1])).run(
sender=Addresses.DAO, now=CONTRIBUTION_START.add_seconds(CONTRIBUTION_PERIOD + 1)
)
# Verify that the entries have correct status after disqualification
scenario.verify(matching_round.data.entries[1].status == Entry.ENTRY_STATUS_DISQUALIFIED)
scenario.verify(matching_round.data.entries[2].status == Entry.ENTRY_STATUS_ACTIVE)
scenario.verify(matching_round.data.entries[3].status == Entry.ENTRY_STATUS_ACTIVE)
# Verify that the final balances of community fund and matching round are correct
scenario.verify(matching_round.balance == sp.utils.nat_to_mutez(security_deposit_nat * 2))
scenario.verify(community_fund.balance == sp.utils.nat_to_mutez(security_deposit_nat * 1))
@sp.add_test(name="disqualify_entries can disqualify multiple entries")
def test():
scenario = sp.test_scenario()
entries = sp.big_map(
l={
1: sp.record(
address=Addresses.ENTRY_1,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
),
2: sp.record(
address=Addresses.ENTRY_2,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
),
3: sp.record(
address=Addresses.ENTRY_3,
creator=Addresses.JOHN,
status=Entry.ENTRY_STATUS_ACTIVE,
clr_match=0,
deposit_withdrawn=False,
),
}
)
community_fund = DummyCommunityFund.DummyCommunityFund()
community_fund.set_initial_balance(sp.tez(0))
round_meta = sp.record(
token_set=sp.set([TEZ_IDENTIFIER]),
security_deposit_amount=SECURITY_DEPOSIT_AMOUNT,
stablecoin_address=Addresses.STABLECOIN,
donation_handler_address=Addresses.DONATION_HANDLER,
community_fund_address=community_fund.address,
)
matching_round = MatchingRound(entries=entries, round_meta=round_meta)
security_deposit_nat = sp.utils.mutez_to_nat(SECURITY_DEPOSIT_AMOUNT)
matching_round.set_initial_balance(sp.utils.nat_to_mutez(security_deposit_nat * 3))
scenario += matching_round
scenario += community_fund
# Disqualify entries 2 and 3
scenario += matching_round.disqualify_entries(sp.list([2, 3])).run(
sender=Addresses.DAO,
now=CONTRIBUTION_START.add_seconds(CONTRIBUTION_PERIOD + 1),
)
# Verify that the entries have correct status after diaqualification
scenario.verify(matching_round.data.entries[1].status == Entry.ENTRY_STATUS_ACTIVE)
scenario.verify(matching_round.data.entries[2].status == Entry.ENTRY_STATUS_DISQUALIFIED)
scenario.verify(matching_round.data.entries[3].status == Entry.ENTRY_STATUS_DISQUALIFIED)
# Verify that the final balances of community fund and matching round are correct
scenario.verify(matching_round.balance == sp.utils.nat_to_mutez(security_deposit_nat * 1))
scenario.verify(community_fund.balance == sp.utils.nat_to_mutez(security_deposit_nat * 2))
@sp.add_test(name="disqualify_entries fails if sender is not the admin")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(
entries=sp.big_map(l={1: ENTRY}),
entry_address_to_id=sp.big_map(l={Addresses.ENTRY_1: 1}),
)
scenario += matching_round
# RANDOM tries to disqualify ENTRY_1
scenario += matching_round.disqualify_entries(sp.list([1])).run(
sender=Addresses.RANDOM,
now=CONTRIBUTION_START.add_seconds(CONTRIBUTION_PERIOD + 1),
valid=False,
exception=Errors.NOT_ALLOWED,
)
@sp.add_test(name="disqualify_entries fails if the timing is not correct")
def test():
scenario = sp.test_scenario()
matching_round = MatchingRound(