forked from opdev3/opd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcontract.html
1703 lines (1524 loc) · 82.2 KB
/
contract.html
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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>contract API documentation</title>
<meta name="description" content="This project is intended to provide an easy and efficient way to lend and/or borrow tokens and XTZ on Tezos blockchain …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>contract</code></h1>
</header>
<section id="section-intro">
<p>This project is intended to provide an easy and efficient way to lend and/or borrow tokens and XTZ on Tezos blockchain.</p>
<p>This version allows users to use only XTZ as collateral.
The current implementation supports FA1.2.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">"""
This project is intended to provide an easy and efficient way to lend and/or borrow tokens and XTZ on Tezos blockchain.
This version allows users to use only XTZ as collateral.
The current implementation supports FA1.2.
"""
import smartpy as sp
class Error:
"""The enum used for the contract related errors."""
ACCESS_DENIED = "OD_ACCESS_DENIED"
"""The contract function is not accessible for the sender."""
ILLEGAL_ARGUMENT = "OD_ILLEGAL_ARGUMENT"
"""The corresponding argument value is invalid."""
ILLEGAL_TX_AMOUNT = "OD_ILLEGAL_TX_AMOUNT"
"""The corresponding transaction has incorrect tezos amount."""
PAUSED = "OD_PAUSED"
"""The contract is paused."""
class Opus(sp.Contract):
"""The contract is a storage for p2p credit deals and provides service functionality to make such deals."""
def __init__(self, creator):
self.creator = creator
self.init(
# indicates that making of credit deals is disabled
# (if the value is True, creating loan requests and making deals are not possible)
pause = False,
# baker address or None
baker = sp.none,
# list of admin addresses
admins = sp.set([creator]),
# supported tokens (list of pairs: token name and token address)
tokens = sp.big_map(tkey = sp.TString, tvalue = sp.TAddress),
# time bounds for credit deals
time = sp.record(min = sp.nat(7 * 86400), max = sp.nat(180 * 86400)),
# minimum deposit value
min_deposit = sp.tez(1),
# service fee (APY) in basis points
fee = sp.nat(100),
# last loan request ID
nloan = sp.nat(0),
# last credit deal ID
ndeal = sp.nat(0),
# map of loan requests (key is loan request ID)
loans = sp.big_map(),
# map of credit deals (key is credit deal ID)
deals = sp.big_map(),
# amount of blocked collateral
deposits = sp.mutez(0)
)
@sp.entry_point
def default(self):
"""Support tezos transfer to the contract address."""
pass
@sp.entry_point
def withdraw(self, params):
"""(Admins only) Transfer tezos (except blocked collateral) from the contract address.
Args:
address (address): destination address
amount (mutez): tezos amount
Raises:
`OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.address, sp.TAddress)
sp.set_type(params.amount, sp.TMutez)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(params.amount > sp.mutez(0), message = Error.ILLEGAL_ARGUMENT + ":amount")
sp.verify((sp.balance - self.data.deposits) >= params.amount, message = Error.ILLEGAL_ARGUMENT + ":amount")
sp.send(params.address, params.amount)
@sp.entry_point
def add_admin(self, params):
"""(Admins only) Add an admin address to the list of admin addresses.
Args:
address (address): new admin address
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.address, sp.TAddress)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(~self.data.admins.contains(params.address), message = Error.ILLEGAL_ARGUMENT + ":address")
self.data.admins.add(params.address)
@sp.entry_point
def remove_admin(self, params):
"""(Admins only) Remove an admin address from the list of admin addresses.
Args:
address (address): admin address
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.address, sp.TAddress)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.creator != params.address, message = Error.ILLEGAL_ARGUMENT + ":address")
sp.verify(self.data.admins.contains(params.address), message = Error.ILLEGAL_ARGUMENT + ":address")
self.data.admins.remove(params.address)
@sp.entry_point
def pause(self, params):
"""(Admins only) Disable/enable making of new loan requests and new deals.
Args:
pause (bool): _True_ or _False_
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.pause, sp.TBool)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.pause != params.pause, message = Error.ILLEGAL_ARGUMENT + ":pause")
self.data.pause = params.pause
@sp.entry_point
def delegate(self, params):
"""(Admins only) Set a baker for the contract.
Args:
baker (option): baker address or _None_
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.baker, sp.TOption(sp.TKeyHash))
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.baker != params.baker, message = Error.ILLEGAL_ARGUMENT + ":baker")
self.data.baker = params.baker
sp.set_delegate(params.baker)
@sp.entry_point
def add_token(self, params):
"""(Admins only) Add supported token.
Args:
name (string): token name
address (address): token address
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`
"""
sp.set_type(params.name, sp.TString)
sp.set_type(params.address, sp.TAddress)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
self.data.tokens[params.name] = params.address
@sp.entry_point
def remove_token(self, params):
"""(Admins only) Remove supported token.
Args:
name (string): token name
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.name, sp.TString)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.tokens.contains(params.name), message = Error.ILLEGAL_ARGUMENT + ":name")
del self.data.tokens[params.name]
@sp.entry_point
def set_fee(self, params):
"""(Admins only) Set a service fee.
Args:
fee (nat): fee value (APY) in basis points
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.fee, sp.TNat)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.fee != params.fee, message = Error.ILLEGAL_ARGUMENT + ":fee")
sp.verify(params.fee < 10000, message = Error.ILLEGAL_ARGUMENT + ":fee")
self.data.fee = params.fee
@sp.entry_point
def set_min_deposit(self, params):
"""(Admins only) Set minimum deposit value for loan requests.
Args:
min_deposit (mutez): minimum deposit value
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.min_deposit, sp.TMutez)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.min_deposit != params.min_deposit, message = Error.ILLEGAL_ARGUMENT + ":min_deposit")
self.data.min_deposit = params.min_deposit
@sp.entry_point
def set_time(self, params):
"""(Admins only) Set time bounds for credit deals.
Args:
min (nat): minimum deal duration in seconds
max (nat): maximum deal duration in seconds
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params, sp.TRecord(min = sp.TNat, max = sp.TNat))
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.time != params, message = Error.ILLEGAL_ARGUMENT + ":min,max")
sp.verify((params.min > 0) & (params.min <= params.max), message = Error.ILLEGAL_ARGUMENT + ":min")
self.data.time = params
@sp.entry_point
def add_loan(self, params):
"""Create a new loan request.
The corresponding transaction amount has to include deposit and service fee.
Args:
token (string): token name
token_address (address): token address
amount (nat): requested amount of tokens
reward (nat): amount of tokens as creditor's reward
deposit (mutez): deposit amount, the sender has to send the same amount of tezos
time (nat): credit deal duration in seconds
validity (option): loan request expire date or None
Raises:
`OD_PAUSED`, `OD_ILLEGAL_TX_AMOUNT`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.token, sp.TString)
sp.set_type(params.token_address, sp.TAddress)
sp.set_type(params.amount, sp.TNat)
sp.set_type(params.reward, sp.TNat)
sp.set_type(params.deposit, sp.TMutez)
sp.set_type(params.time, sp.TNat)
sp.set_type(params.validity, sp.TOption(sp.TTimestamp))
sp.verify(~self.data.pause, message = Error.PAUSED)
sp.verify(self.data.tokens.contains(params.token), message = Error.ILLEGAL_ARGUMENT + ":token")
sp.verify(self.data.tokens[params.token] == params.token_address, message = Error.ILLEGAL_ARGUMENT + ":token_address")
sp.verify(params.amount > 0, message = Error.ILLEGAL_ARGUMENT + ":amount")
sp.verify(params.deposit >= self.data.min_deposit, message = Error.ILLEGAL_ARGUMENT + ":deposit")
sp.verify((params.time >= self.data.time.min) & (params.time <= self.data.time.max), message = Error.ILLEGAL_ARGUMENT + ":time")
sp.verify((params.validity == sp.none) | (params.validity > sp.some(sp.now)), message = Error.ILLEGAL_ARGUMENT + ":validity")
# Service fee calculation
f = sp.local("f", sp.utils.nat_to_mutez(sp.utils.mutez_to_nat(params.deposit) * params.time * self.data.fee // (3600 * 24 * 365 * 100 * 100)))
sp.verify(sp.amount == (params.deposit + f.value), message = Error.ILLEGAL_TX_AMOUNT)
loan = sp.record(
ts = sp.now,
borrower = sp.sender,
validity = params.validity,
amount = params.amount,
token = params.token,
token_address = self.data.tokens[params.token],
time = params.time,
reward = params.reward,
deposit = params.deposit,
fee = f.value
)
self.data.nloan += 1
self.data.loans[self.data.nloan] = loan
self.data.deposits += sp.amount
@sp.entry_point
def cancel_loan(self, params):
"""Cancel sender's loan request, deposit and fee of the loan are returned to the sender.
Args:
id (nat): loan request ID
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.id, sp.TNat)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.loans.contains(params.id), message = Error.ILLEGAL_ARGUMENT + ":id")
loan = sp.local("loan", self.data.loans[params.id])
sp.verify((sp.sender == loan.value.borrower) | self.data.admins.contains(sp.sender), Error.ACCESS_DENIED)
with sp.if_(loan.value.deposit > sp.mutez(0)):
sp.send(loan.value.borrower, loan.value.deposit + loan.value.fee)
self.data.deposits -= (loan.value.deposit + loan.value.fee)
del self.data.loans[params.id]
@sp.entry_point
def make_deal(self, params):
"""Make a credit deal, the sender has to approve the corresponding token transfer early.
Args:
id (nat): loan request ID
Raises:
`OD_PAUSED`, `OD_ILLEGAL_TX_AMOUNT`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.id, sp.TNat)
sp.verify(~self.data.pause, message = Error.PAUSED)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.loans.contains(params.id), message = Error.ILLEGAL_ARGUMENT + ":id")
loan = sp.local("loan", self.data.loans[params.id])
sp.verify(loan.value.borrower != sp.sender, Error.ILLEGAL_ARGUMENT + ":sender")
sp.verify((loan.value.validity == sp.none) | (loan.value.validity > sp.some(sp.now)), message = Error.ILLEGAL_ARGUMENT + ":now")
deal = sp.record(
ts = sp.now,
borrower = loan.value.borrower,
creditor = sp.sender,
amount = loan.value.amount,
token = loan.value.token,
token_address = loan.value.token_address,
exp = sp.now.add_seconds(sp.to_int(loan.value.time)),
reward = loan.value.reward,
deposit = loan.value.deposit,
)
self.transfer_tokens(f=sp.sender, t=loan.value.borrower, v=loan.value.amount, token_address=loan.value.token_address)
self.data.ndeal += 1
self.data.deals[self.data.ndeal] = deal
self.data.deposits -= loan.value.fee
del self.data.loans[params.id]
@sp.entry_point
def close_deal(self, params):
"""Close a deal by borrower or creditor/admins.
If a deal is closed by borrower, the tokens are sent to the creditor and the borrower gets back the deposit;
if a deal timed out and it's closed by the creditor or admins, the creditor gets the deposit.
Args:
id (nat): credit deal ID
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.id, sp.TNat)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.deals.contains(params.id), message = Error.ILLEGAL_ARGUMENT + ":id")
deal = sp.local("deal", self.data.deals[params.id])
sp.verify((sp.sender == deal.value.borrower) | (sp.sender == deal.value.creditor) | self.data.admins.contains(sp.sender), Error.ACCESS_DENIED)
with sp.if_(sp.sender == deal.value.borrower):
self.transfer_tokens(f=deal.value.borrower, t=deal.value.creditor, v=(deal.value.amount+deal.value.reward), token_address=deal.value.token_address)
with sp.if_(deal.value.deposit > sp.mutez(0)):
sp.send(deal.value.borrower, deal.value.deposit)
self.data.deposits -= deal.value.deposit
with sp.else_():
sp.verify(deal.value.exp < sp.now, message = Error.ACCESS_DENIED)
with sp.if_(deal.value.deposit > sp.mutez(0)):
sp.send(deal.value.creditor, deal.value.deposit)
self.data.deposits -= deal.value.deposit
del self.data.deals[params.id]
def transfer_tokens(self, f, t, v, token_address):
"""Help function to transfer tokens.
Args:
f (address): source address
t (address): destination address
v (nat): amount of tokens
token_address (address): token smart-contract address
"""
param_type = sp.TRecord(from_ = sp.TAddress, to_ = sp.TAddress, value = sp.TNat).layout(("from_ as from", ("to_ as to", "value")))
param_values = sp.record(from_ = f, to_ = t, value = v)
sp.transfer(param_values, sp.mutez(0), sp.contract(param_type, token_address, entry_point="transfer").open_some())
#########################################################################################################
@sp.add_test(name = "Opus")
def test():
"""Tests."""
creator = sp.address("tz1fE6hEiRFa9ZHJeZrccNKsGW7jdxfe9vcv")
DAY = 86400
admin = sp.test_account("Admin")
userA = sp.test_account("UserA")
userB = sp.test_account("UserB")
userC = sp.test_account("UserC")
scenario = sp.test_scenario()
scenario.h1("Opus tests")
c1 = Opus(creator)
INITIAL_BALANCE = sp.tez(1000)
c1.set_initial_balance(INITIAL_BALANCE)
scenario += c1
scenario.h1("Admins")
scenario.h2("add_admin()")
c1.add_admin(address=userA.address).run(sender = creator, amount=sp.mutez(1), valid = False)
c1.add_admin(address=userA.address).run(sender = userA, valid = False)
c1.add_admin(address=admin.address).run(sender = creator)
c1.add_admin(address=admin.address).run(sender = creator, valid = False)
c1.add_admin(address=userA.address).run(sender = admin)
scenario.h2("remove_admin()")
c1.remove_admin(address=userA.address).run(sender = admin, amount=sp.mutez(1), valid = False)
c1.remove_admin(address=admin.address).run(sender = userB, valid = False)
c1.remove_admin(address=creator).run(sender = admin, valid = False)
c1.remove_admin(address=userA.address).run(sender = admin)
c1.remove_admin(address=userA.address).run(sender = admin, valid = False)
scenario.h1("Delegate")
scenario.h2("delegate()")
keyHash = sp.key_hash("tz1fwnfJNgiDACshK9avfRfFbMaXrs3ghoJa")
voting_powers = {keyHash : 0}
c1.delegate(baker=sp.some(keyHash)).run(sender = admin, voting_powers = voting_powers, amount=sp.mutez(1), valid = False)
c1.delegate(baker=sp.some(keyHash)).run(sender = userB, voting_powers = voting_powers, valid = False)
c1.delegate(baker=sp.some(keyHash)).run(sender = admin, voting_powers = voting_powers)
c1.delegate(baker=sp.some(keyHash)).run(sender = admin, voting_powers = voting_powers, valid = False)
scenario.verify_equal(c1.baker, sp.some(keyHash))
c1.delegate(baker=sp.none).run(sender = admin)
scenario.h1("Tokens")
tokenBTC = sp.record(name="sBTC", address=sp.address("tz1oBTCoMEtsXm3QxA7FmMU2Qh7xzsuGXVbc"))
tokenETH = sp.record(name="sETH", address=sp.address("tz1oETHo1otsXm3QxA7FmMU2Qh7xzsuGXVbc"))
tokenXPR = sp.record(name="sXRP", address=sp.address("tz1oXRPoMEtsXm3QxA7FmMU2Qh7xzsuGXVbc"))
scenario.h2("add_token()")
c1.add_token(tokenBTC).run(sender = creator, amount=sp.mutez(1), valid = False)
c1.add_token(tokenBTC).run(sender = creator)
c1.add_token(tokenETH).run(sender = userA, valid = False)
c1.add_token(name=tokenETH.name, address=sp.address("tz1oETHo2otsXm3QxA7FmMU2Qh7xzsuGXVbc")).run(sender = creator)
c1.add_token(tokenETH).run(sender = admin)
c1.add_token(tokenXPR).run(sender = admin)
scenario.h2("remove_token()")
c1.remove_token(name="sBTC").run(sender = creator, amount=sp.mutez(1), valid = False)
c1.remove_token(name="sBTC").run(sender = userA, valid = False)
c1.remove_token(name="yyyy").run(sender = creator, valid = False)
c1.remove_token(name="sXRP").run(sender = creator)
scenario.h1("Fee")
scenario.h2("set_fee()")
c1.set_fee(fee=0).run(sender = creator, amount=sp.mutez(1), valid = False)
c1.set_fee(fee=0).run(sender = userA, valid = False)
c1.set_fee(fee=100).run(sender = creator, valid = False)
c1.set_fee(fee=10000).run(sender = creator, valid = False)
c1.set_fee(fee=0).run(sender = creator)
c1.set_fee(fee=100).run(sender = admin)
scenario.h1("Min Deposit")
scenario.h2("set_min_deposit()")
c1.set_min_deposit(min_deposit=sp.mutez(100)).run(sender = creator, amount=sp.mutez(1), valid = False)
c1.set_min_deposit(min_deposit=sp.mutez(0)).run(sender = userA, valid = False)
c1.set_min_deposit(min_deposit=sp.mutez(1_000_000)).run(sender = creator, valid = False)
c1.set_min_deposit(min_deposit=sp.mutez(0)).run(sender = admin)
c1.set_min_deposit(min_deposit=sp.mutez(1_000_000)).run(sender = creator)
scenario.h1("Time")
scenario.h2("set_time()")
c1.set_time(sp.record(min=1*DAY, max=366*DAY)).run(sender = creator, amount=sp.mutez(1), valid = False)
c1.set_time(sp.record(min=3*DAY, max=60*DAY)).run(sender = userA, valid = False)
c1.set_time(sp.record(min=0*DAY, max=366*DAY)).run(sender = creator, valid = False)
c1.set_time(sp.record(min=180*DAY, max=7*DAY)).run(sender = creator, valid = False)
c1.set_time(sp.record(min=1*DAY, max=366*DAY)).run(sender = admin)
c1.set_time(sp.record(min=1*DAY, max=366*DAY)).run(sender = creator, valid = False)
scenario.h1("Loans")
scenario.h2("add_loan()")
c1.add_loan(amount=10_000, token="abcd", token_address=tokenETH.address, time=7*DAY, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=sp.address("tz1fwnfJNgiDACshK9avfRfFbMaXrs3ghoJa"), time=7*DAY, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=0, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000,
deposit=sp.mutez(1), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=1, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=456*DAY, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000,
deposit=sp.mutez(1_500_000_00), validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000, deposit=sp.mutez(1_500_000_00),
validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0))
c1.add_loan(amount=20_000, token=tokenBTC.name, token_address=tokenBTC.address, time=14*DAY, reward=200, deposit=sp.mutez(200_000_000),
validity=sp.none
).run(sender=userB, amount=sp.mutez(200_000_000 + 76712), now=sp.timestamp_from_utc(2022, 5, 2, 0, 0, 0))
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=100, deposit=sp.mutez(1_000_000),
validity=sp.some(sp.timestamp_from_utc(2022, 5, 3, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_000_000 + 191), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0))
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000, deposit=sp.mutez(1_500_000_00),
validity=sp.some(sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_500_000_00 + 28767), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0))
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=1000, deposit=sp.mutez(1_000_000),
validity=sp.some(sp.timestamp_from_utc(2022, 5, 3, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_000_000 + 191), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0))
c1.add_loan(amount=20_000, token="eth", token_address=tokenETH.address, time=14*DAY, reward=200, deposit=sp.mutez(200_000_000),
validity=sp.none
).run(sender=userB, amount=sp.mutez(200_000_000 + 76712), now=sp.timestamp_from_utc(2022, 5, 2, 0, 0, 0), valid=False)
c1.add_loan(amount=20_000, token=tokenBTC.name, token_address=tokenETH.address, time=14*DAY, reward=200, deposit=sp.mutez(200_000_000),
validity=sp.none
).run(sender=userB, amount=sp.mutez(200_000_000 + 76712), now=sp.timestamp_from_utc(2022, 5, 2, 0, 0, 0), valid=False)
scenario.h2("cancel_loan()")
c1.cancel_loan(id=1).run(sender = userA, amount=sp.mutez(1), valid = False)
c1.cancel_loan(id=123).run(sender = userA, valid = False)
c1.cancel_loan(id=3).run(sender = userB, valid = False)
c1.cancel_loan(id=1).run(sender = userA)
c1.cancel_loan(id=3).run(sender = admin)
scenario.h1("Deals")
scenario.h2("make_deal()")
c1.make_deal(id=1).run(sender=userB, valid = False)
c1.make_deal(id=4).run(sender=userA, valid = False)
c1.make_deal(id=4).run(sender=userB, now=sp.timestamp_from_utc(2022, 5, 15, 0, 0, 0), valid = False)
c1.make_deal(id=4).run(sender=userB, now=sp.timestamp_from_utc(2022, 5, 10, 0, 0, 0), amount=sp.mutez(1), valid = False)
c1.make_deal(id=4).run(sender=userB, now=sp.timestamp_from_utc(2022, 5, 10, 0, 0, 0))
c1.make_deal(id=5).run(sender=userB, now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0))
scenario.h2("close_deal()")
c1.close_deal(id=0).run(sender=userA, now=sp.timestamp_from_utc(2022, 5, 11, 0, 0, 0), valid = False)
c1.close_deal(id=1).run(sender=userC, now=sp.timestamp_from_utc(2022, 5, 11, 0, 0, 0), valid = False)
c1.close_deal(id=1).run(sender=userB, now=sp.timestamp_from_utc(2022, 5, 11, 0, 0, 0), valid = False)
c1.close_deal(id=1).run(sender=admin, now=sp.timestamp_from_utc(2022, 5, 11, 0, 0, 0), valid = False)
c1.close_deal(id=1).run(sender=userA, now=sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0), amount=sp.mutez(1), valid = False)
c1.close_deal(id=1).run(sender=userA, now=sp.timestamp_from_utc(2022, 5, 14, 0, 0, 0))
c1.close_deal(id=2).run(sender=userB, now=sp.timestamp_from_utc(2022, 5, 9, 0, 0, 0))
scenario.h1("Pause")
scenario.h2("pause()")
c1.pause(pause=True).run(sender = admin, amount=sp.mutez(1), valid = False)
c1.pause(pause=False).run(sender = userA, valid = False)
c1.pause(pause=False).run(sender = admin, valid = False)
c1.pause(pause=True).run(sender = admin)
# Creating new loan request is not possible
c1.add_loan(amount=10_000, token=tokenETH.name, token_address=tokenETH.address, time=7*DAY, reward=100, deposit=sp.mutez(1_000_000),
validity=sp.some(sp.timestamp_from_utc(2022, 5, 3, 0, 0, 0))
).run(sender=userA, amount=sp.mutez(1_000_000 + 191), now=sp.timestamp_from_utc(2022, 5, 1, 0, 0, 0), valid = False)
# Making deal is not possible
c1.make_deal(id=2).run(sender=userC, valid = False)
scenario.h1("Withdraw")
scenario.h2("withdraw()")
c1.withdraw(address=admin.address, amount=sp.mutez(1)).run(sender = userA, valid = False)
c1.withdraw(address=admin.address, amount=sp.mutez(0)).run(sender = creator, valid = False)
c1.withdraw(address=admin.address, amount=sp.tez(1000000)).run(sender = admin, valid = False)
c1.withdraw(address=admin.address, amount=INITIAL_BALANCE).run(sender = admin)
scenario.verify(c1.balance >= c1.data.deposits)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="contract.Error"><code class="flex name class">
<span>class <span class="ident">Error</span></span>
</code></dt>
<dd>
<div class="desc"><p>The enum used for the contract related errors.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Error:
"""The enum used for the contract related errors."""
ACCESS_DENIED = "OD_ACCESS_DENIED"
"""The contract function is not accessible for the sender."""
ILLEGAL_ARGUMENT = "OD_ILLEGAL_ARGUMENT"
"""The corresponding argument value is invalid."""
ILLEGAL_TX_AMOUNT = "OD_ILLEGAL_TX_AMOUNT"
"""The corresponding transaction has incorrect tezos amount."""
PAUSED = "OD_PAUSED"
"""The contract is paused."""</code></pre>
</details>
<h3>Class variables</h3>
<dl>
<dt id="contract.Error.ACCESS_DENIED"><code class="name">var <span class="ident">ACCESS_DENIED</span></code></dt>
<dd>
<div class="desc"><p>The contract function is not accessible for the sender.</p></div>
</dd>
<dt id="contract.Error.ILLEGAL_ARGUMENT"><code class="name">var <span class="ident">ILLEGAL_ARGUMENT</span></code></dt>
<dd>
<div class="desc"><p>The corresponding argument value is invalid.</p></div>
</dd>
<dt id="contract.Error.ILLEGAL_TX_AMOUNT"><code class="name">var <span class="ident">ILLEGAL_TX_AMOUNT</span></code></dt>
<dd>
<div class="desc"><p>The corresponding transaction has incorrect tezos amount.</p></div>
</dd>
<dt id="contract.Error.PAUSED"><code class="name">var <span class="ident">PAUSED</span></code></dt>
<dd>
<div class="desc"><p>The contract is paused.</p></div>
</dd>
</dl>
</dd>
<dt id="contract.Opus"><code class="flex name class">
<span>class <span class="ident">Opus</span></span>
<span>(</span><span>creator)</span>
</code></dt>
<dd>
<div class="desc"><p>The contract is a storage for p2p credit deals and provides service functionality to make such deals.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Opus(sp.Contract):
"""The contract is a storage for p2p credit deals and provides service functionality to make such deals."""
def __init__(self, creator):
self.creator = creator
self.init(
# indicates that making of credit deals is disabled
# (if the value is True, creating loan requests and making deals are not possible)
pause = False,
# baker address or None
baker = sp.none,
# list of admin addresses
admins = sp.set([creator]),
# supported tokens (list of pairs: token name and token address)
tokens = sp.big_map(tkey = sp.TString, tvalue = sp.TAddress),
# time bounds for credit deals
time = sp.record(min = sp.nat(7 * 86400), max = sp.nat(180 * 86400)),
# minimum deposit value
min_deposit = sp.tez(1),
# service fee (APY) in basis points
fee = sp.nat(100),
# last loan request ID
nloan = sp.nat(0),
# last credit deal ID
ndeal = sp.nat(0),
# map of loan requests (key is loan request ID)
loans = sp.big_map(),
# map of credit deals (key is credit deal ID)
deals = sp.big_map(),
# amount of blocked collateral
deposits = sp.mutez(0)
)
@sp.entry_point
def default(self):
"""Support tezos transfer to the contract address."""
pass
@sp.entry_point
def withdraw(self, params):
"""(Admins only) Transfer tezos (except blocked collateral) from the contract address.
Args:
address (address): destination address
amount (mutez): tezos amount
Raises:
`OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.address, sp.TAddress)
sp.set_type(params.amount, sp.TMutez)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(params.amount > sp.mutez(0), message = Error.ILLEGAL_ARGUMENT + ":amount")
sp.verify((sp.balance - self.data.deposits) >= params.amount, message = Error.ILLEGAL_ARGUMENT + ":amount")
sp.send(params.address, params.amount)
@sp.entry_point
def add_admin(self, params):
"""(Admins only) Add an admin address to the list of admin addresses.
Args:
address (address): new admin address
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.address, sp.TAddress)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(~self.data.admins.contains(params.address), message = Error.ILLEGAL_ARGUMENT + ":address")
self.data.admins.add(params.address)
@sp.entry_point
def remove_admin(self, params):
"""(Admins only) Remove an admin address from the list of admin addresses.
Args:
address (address): admin address
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.address, sp.TAddress)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.creator != params.address, message = Error.ILLEGAL_ARGUMENT + ":address")
sp.verify(self.data.admins.contains(params.address), message = Error.ILLEGAL_ARGUMENT + ":address")
self.data.admins.remove(params.address)
@sp.entry_point
def pause(self, params):
"""(Admins only) Disable/enable making of new loan requests and new deals.
Args:
pause (bool): _True_ or _False_
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.pause, sp.TBool)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.pause != params.pause, message = Error.ILLEGAL_ARGUMENT + ":pause")
self.data.pause = params.pause
@sp.entry_point
def delegate(self, params):
"""(Admins only) Set a baker for the contract.
Args:
baker (option): baker address or _None_
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.baker, sp.TOption(sp.TKeyHash))
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.baker != params.baker, message = Error.ILLEGAL_ARGUMENT + ":baker")
self.data.baker = params.baker
sp.set_delegate(params.baker)
@sp.entry_point
def add_token(self, params):
"""(Admins only) Add supported token.
Args:
name (string): token name
address (address): token address
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`
"""
sp.set_type(params.name, sp.TString)
sp.set_type(params.address, sp.TAddress)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
self.data.tokens[params.name] = params.address
@sp.entry_point
def remove_token(self, params):
"""(Admins only) Remove supported token.
Args:
name (string): token name
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.name, sp.TString)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.tokens.contains(params.name), message = Error.ILLEGAL_ARGUMENT + ":name")
del self.data.tokens[params.name]
@sp.entry_point
def set_fee(self, params):
"""(Admins only) Set a service fee.
Args:
fee (nat): fee value (APY) in basis points
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.fee, sp.TNat)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.fee != params.fee, message = Error.ILLEGAL_ARGUMENT + ":fee")
sp.verify(params.fee < 10000, message = Error.ILLEGAL_ARGUMENT + ":fee")
self.data.fee = params.fee
@sp.entry_point
def set_min_deposit(self, params):
"""(Admins only) Set minimum deposit value for loan requests.
Args:
min_deposit (mutez): minimum deposit value
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.min_deposit, sp.TMutez)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.min_deposit != params.min_deposit, message = Error.ILLEGAL_ARGUMENT + ":min_deposit")
self.data.min_deposit = params.min_deposit
@sp.entry_point
def set_time(self, params):
"""(Admins only) Set time bounds for credit deals.
Args:
min (nat): minimum deal duration in seconds
max (nat): maximum deal duration in seconds
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params, sp.TRecord(min = sp.TNat, max = sp.TNat))
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.admins.contains(sp.sender), message = Error.ACCESS_DENIED)
sp.verify(self.data.time != params, message = Error.ILLEGAL_ARGUMENT + ":min,max")
sp.verify((params.min > 0) & (params.min <= params.max), message = Error.ILLEGAL_ARGUMENT + ":min")
self.data.time = params
@sp.entry_point
def add_loan(self, params):
"""Create a new loan request.
The corresponding transaction amount has to include deposit and service fee.
Args:
token (string): token name
token_address (address): token address
amount (nat): requested amount of tokens
reward (nat): amount of tokens as creditor's reward
deposit (mutez): deposit amount, the sender has to send the same amount of tezos
time (nat): credit deal duration in seconds
validity (option): loan request expire date or None
Raises:
`OD_PAUSED`, `OD_ILLEGAL_TX_AMOUNT`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.token, sp.TString)
sp.set_type(params.token_address, sp.TAddress)
sp.set_type(params.amount, sp.TNat)
sp.set_type(params.reward, sp.TNat)
sp.set_type(params.deposit, sp.TMutez)
sp.set_type(params.time, sp.TNat)
sp.set_type(params.validity, sp.TOption(sp.TTimestamp))
sp.verify(~self.data.pause, message = Error.PAUSED)
sp.verify(self.data.tokens.contains(params.token), message = Error.ILLEGAL_ARGUMENT + ":token")
sp.verify(self.data.tokens[params.token] == params.token_address, message = Error.ILLEGAL_ARGUMENT + ":token_address")
sp.verify(params.amount > 0, message = Error.ILLEGAL_ARGUMENT + ":amount")
sp.verify(params.deposit >= self.data.min_deposit, message = Error.ILLEGAL_ARGUMENT + ":deposit")
sp.verify((params.time >= self.data.time.min) & (params.time <= self.data.time.max), message = Error.ILLEGAL_ARGUMENT + ":time")
sp.verify((params.validity == sp.none) | (params.validity > sp.some(sp.now)), message = Error.ILLEGAL_ARGUMENT + ":validity")
# Service fee calculation
f = sp.local("f", sp.utils.nat_to_mutez(sp.utils.mutez_to_nat(params.deposit) * params.time * self.data.fee // (3600 * 24 * 365 * 100 * 100)))
sp.verify(sp.amount == (params.deposit + f.value), message = Error.ILLEGAL_TX_AMOUNT)
loan = sp.record(
ts = sp.now,
borrower = sp.sender,
validity = params.validity,
amount = params.amount,
token = params.token,
token_address = self.data.tokens[params.token],
time = params.time,
reward = params.reward,
deposit = params.deposit,
fee = f.value
)
self.data.nloan += 1
self.data.loans[self.data.nloan] = loan
self.data.deposits += sp.amount
@sp.entry_point
def cancel_loan(self, params):
"""Cancel sender's loan request, deposit and fee of the loan are returned to the sender.
Args:
id (nat): loan request ID
Raises:
`OD_ILLEGAL_TX_AMOUNT`, `OD_ACCESS_DENIED`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.id, sp.TNat)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.loans.contains(params.id), message = Error.ILLEGAL_ARGUMENT + ":id")
loan = sp.local("loan", self.data.loans[params.id])
sp.verify((sp.sender == loan.value.borrower) | self.data.admins.contains(sp.sender), Error.ACCESS_DENIED)
with sp.if_(loan.value.deposit > sp.mutez(0)):
sp.send(loan.value.borrower, loan.value.deposit + loan.value.fee)
self.data.deposits -= (loan.value.deposit + loan.value.fee)
del self.data.loans[params.id]
@sp.entry_point
def make_deal(self, params):
"""Make a credit deal, the sender has to approve the corresponding token transfer early.
Args:
id (nat): loan request ID
Raises:
`OD_PAUSED`, `OD_ILLEGAL_TX_AMOUNT`, `OD_ILLEGAL_ARGUMENT`
"""
sp.set_type(params.id, sp.TNat)
sp.verify(~self.data.pause, message = Error.PAUSED)
sp.verify(sp.amount == sp.mutez(0), message = Error.ILLEGAL_TX_AMOUNT)
sp.verify(self.data.loans.contains(params.id), message = Error.ILLEGAL_ARGUMENT + ":id")
loan = sp.local("loan", self.data.loans[params.id])
sp.verify(loan.value.borrower != sp.sender, Error.ILLEGAL_ARGUMENT + ":sender")
sp.verify((loan.value.validity == sp.none) | (loan.value.validity > sp.some(sp.now)), message = Error.ILLEGAL_ARGUMENT + ":now")
deal = sp.record(
ts = sp.now,
borrower = loan.value.borrower,
creditor = sp.sender,
amount = loan.value.amount,
token = loan.value.token,
token_address = loan.value.token_address,
exp = sp.now.add_seconds(sp.to_int(loan.value.time)),
reward = loan.value.reward,
deposit = loan.value.deposit,
)
self.transfer_tokens(f=sp.sender, t=loan.value.borrower, v=loan.value.amount, token_address=loan.value.token_address)
self.data.ndeal += 1
self.data.deals[self.data.ndeal] = deal