-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathvote_escrow.py
3014 lines (2544 loc) · 106 KB
/
vote_escrow.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
Errors = sp.io.import_script_from_url("file:utils/errors.py")
FA12 = sp.io.import_script_from_url("file:ply_fa12.py").FA12
TokenUtils = sp.io.import_script_from_url("file:utils/token.py")
Constants = sp.io.import_script_from_url("file:utils/constants.py")
Addresses = sp.io.import_script_from_url("file:helpers/addresses.py")
Voter = sp.io.import_script_from_url("file:helpers/dummy/voter.py").Voter
Utils = sp.io.import_script_from_url("file:utils/misc.py")
SVG = sp.io.import_script_from_url("file:utils/svg.py")
############
# Constants
############
DAY = Constants.DAY
WEEK = Constants.WEEK
YEAR = Constants.YEAR
MAX_TIME = Constants.MAX_TIME
DECIMALS = Constants.DECIMALS
SLOPE_MULTIPLIER = Constants.SLOPE_MULTIPLIER
########
# Types
########
class Types:
LOCK = sp.TRecord(
base_value=sp.TNat,
end=sp.TNat,
).layout(("base_value", "end"))
POINT = sp.TRecord(
slope=sp.TNat,
bias=sp.TNat,
ts=sp.TNat,
).layout(("slope", ("bias", "ts")))
TRANSFER_PARAMS = sp.TList(
sp.TRecord(
from_=sp.TAddress,
txs=sp.TList(
sp.TRecord(to_=sp.TAddress, token_id=sp.TNat, amount=sp.TNat,).layout(
("to_", ("token_id", "amount")),
),
),
).layout(("from_", "txs"))
)
OPERATOR_PARAMS = sp.TRecord(
owner=sp.TAddress,
operator=sp.TAddress,
token_id=sp.TNat,
).layout(("owner", ("operator", "token_id")))
BALANCE_OF_PARAMS = sp.TRecord(
requests=sp.TList(sp.TRecord(owner=sp.TAddress, token_id=sp.TNat).layout(("owner", "token_id"))),
callback=sp.TContract(
sp.TList(
sp.TRecord(
request=sp.TRecord(owner=sp.TAddress, token_id=sp.TNat).layout(("owner", "token_id")),
balance=sp.TNat,
).layout(("request", "balance"))
)
),
).layout(("requests", "callback"))
CREATE_LOCK_PARAMS = sp.TRecord(
user_address=sp.TAddress,
base_value=sp.TNat,
end=sp.TNat,
).layout(("user_address", ("base_value", "end")))
CLAIM_LEDGER_KEY = sp.TRecord(
token_id=sp.TNat,
epoch=sp.TNat,
).layout(("token_id", "epoch"))
# Enumeration for voting power readers
CURRENT = sp.nat(0)
WHOLE_WEEK = sp.nat(1)
# TZIP-12 specified errors for FA2 standard
class FA2_Errors:
FA2_TOKEN_UNDEFINED = "FA2_TOKEN_UNDEFINED"
FA2_NOT_OPERATOR = "FA2_NOT_OPERATOR"
FA2_INSUFFICIENT_BALANCE = "FA2_INSUFFICIENT_BALANCE"
FA2_NOT_OWNER = "FA2_NOT_OWNER"
FA2_INVALID_AMOUNT = "FA2_INVALID_AMOUNT"
###########
# Contract
###########
class VoteEscrow(sp.Contract):
def __init__(
self,
# FA2 standard storage items
ledger=sp.big_map(
l={},
tkey=sp.TPair(sp.TAddress, sp.TNat),
tvalue=sp.TNat,
),
operators=sp.big_map(
l={},
tkey=sp.TRecord(
token_id=sp.TNat,
owner=sp.TAddress,
operator=sp.TAddress,
),
tvalue=sp.TUnit,
),
# Vote-escrow storage items
locks=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=Types.LOCK,
),
attached=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=sp.TAddress,
),
token_checkpoints=sp.big_map(
l={},
tkey=sp.TPair(sp.TNat, sp.TNat),
tvalue=Types.POINT,
),
num_token_checkpoints=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=sp.TNat,
),
gc_index=sp.nat(0),
global_checkpoints=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=Types.POINT,
),
slope_changes=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=sp.TNat,
),
epoch_inflation=sp.big_map(
l={},
tkey=sp.TNat,
tvalue=sp.TNat,
),
claim_ledger=sp.big_map(
l={},
tkey=Types.CLAIM_LEDGER_KEY,
tvalue=sp.TUnit,
),
voter=Addresses.CONTRACT,
base_token=Addresses.TOKEN,
locked_supply=sp.nat(0),
):
METADATA = {
"name": "PLY Vote Escrow",
"version": "1.0.0",
"description": "This contract allows locking up PLY as a veNFT",
"interfaces": ["TZIP-012", "TZIP-016", "TZIP-021"],
"views": [self.token_metadata],
}
# Smartpy's helper to create the metadata json
self.init_metadata("metadata", METADATA)
self.init(
ledger=ledger,
operators=operators,
metadata=sp.utils.metadata_of_url("ipfs://QmXnSs9njQtEEauevAyhw5vKqEinFmieqXBwHxPKvXMKDA"),
locks=locks,
attached=attached,
uid=sp.nat(0),
token_checkpoints=token_checkpoints,
num_token_checkpoints=num_token_checkpoints,
gc_index=gc_index,
global_checkpoints=global_checkpoints,
slope_changes=slope_changes,
epoch_inflation=epoch_inflation,
claim_ledger=claim_ledger,
voter=voter,
base_token=base_token,
locked_supply=locked_supply,
)
self.init_type(
sp.TRecord(
# FA2 specific
ledger=sp.TBigMap(sp.TPair(sp.TAddress, sp.TNat), sp.TNat),
operators=sp.TBigMap(
sp.TRecord(
token_id=sp.TNat,
owner=sp.TAddress,
operator=sp.TAddress,
),
sp.TUnit,
),
metadata=sp.TBigMap(sp.TString, sp.TBytes),
# VE specific
locks=sp.TBigMap(sp.TNat, Types.LOCK),
attached=sp.TBigMap(sp.TNat, sp.TAddress),
uid=sp.TNat,
token_checkpoints=sp.TBigMap(sp.TPair(sp.TNat, sp.TNat), Types.POINT),
num_token_checkpoints=sp.TBigMap(sp.TNat, sp.TNat),
gc_index=sp.TNat,
global_checkpoints=sp.TBigMap(sp.TNat, Types.POINT),
slope_changes=sp.TBigMap(sp.TNat, sp.TNat),
epoch_inflation=sp.TBigMap(sp.TNat, sp.TNat),
claim_ledger=sp.TBigMap(Types.CLAIM_LEDGER_KEY, sp.TUnit),
voter=sp.TAddress,
base_token=sp.TAddress,
locked_supply=sp.TNat,
)
)
# Default tzip-12 specified transfer for NFTs
@sp.entry_point
def transfer(self, params):
sp.set_type(params, Types.TRANSFER_PARAMS)
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
with sp.for_("transfer", params) as transfer:
current_from = transfer.from_
with sp.for_("tx", transfer.txs) as tx:
# Verify sender
sp.verify(
(sp.sender == current_from)
| self.data.operators.contains(
sp.record(owner=current_from, operator=sp.sender, token_id=tx.token_id)
),
FA2_Errors.FA2_NOT_OPERATOR,
)
# Verify that lock is not attached
sp.verify(~self.data.attached.contains(tx.token_id), Errors.LOCK_IS_ATTACHED)
# Verify that the token id belongs to a lock
sp.verify(self.data.locks.contains(tx.token_id), FA2_Errors.FA2_TOKEN_UNDEFINED)
# Each token is unique, so transfer amount would always be 1
with sp.if_(tx.amount >= 1):
# Verify that the address has sufficient balance for transfer
sp.verify(
self.data.ledger[(current_from, tx.token_id)] >= tx.amount,
FA2_Errors.FA2_INSUFFICIENT_BALANCE,
)
# Make transfer
self.data.ledger[(current_from, tx.token_id)] = sp.as_nat(
self.data.ledger[(current_from, tx.token_id)] - tx.amount
)
balance = self.data.ledger.get((tx.to_, tx.token_id), 0)
self.data.ledger[(tx.to_, tx.token_id)] = balance + tx.amount
with sp.else_():
pass
# Default tzip-12 specified balance_of
@sp.entry_point
def balance_of(self, params):
sp.set_type(params, Types.BALANCE_OF_PARAMS)
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
# Response object
response = sp.local("response", [])
with sp.for_("request", params.requests) as request:
sp.verify(self.data.locks.contains(request.token_id), FA2_Errors.FA2_TOKEN_UNDEFINED)
balance = self.data.ledger.get((request.owner, request.token_id), 0)
response.value.push(sp.record(request=request, balance=balance))
sp.transfer(response.value, sp.tez(0), params.callback)
# Default FA2 specified update_operators
@sp.entry_point
def update_operators(self, params):
sp.set_type(
params,
sp.TList(
sp.TVariant(
add_operator=Types.OPERATOR_PARAMS,
remove_operator=Types.OPERATOR_PARAMS,
)
),
)
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
with sp.for_("update", params) as update:
with update.match_cases() as arg:
with arg.match("add_operator") as upd:
sp.verify(
upd.owner == sp.sender,
FA2_Errors.FA2_NOT_OWNER,
)
self.data.operators[upd] = sp.unit
with arg.match("remove_operator") as upd:
sp.verify(
upd.owner == sp.sender,
FA2_Errors.FA2_NOT_OWNER,
)
del self.data.operators[upd]
@sp.entry_point
def update_attachments(self, params):
sp.set_type(
params,
sp.TRecord(
attachments=sp.TList(
sp.TVariant(
add_attachment=sp.TNat,
remove_attachment=sp.TNat,
)
),
owner=sp.TAddress,
),
)
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
with sp.for_("attachment", params.attachments) as attachment:
with attachment.match_cases() as arg:
with arg.match("add_attachment") as token_id:
# Sanity checks
sp.verify(~self.data.attached.contains(token_id), Errors.LOCK_IS_ATTACHED)
sp.verify(self.data.ledger.get((params.owner, token_id), 0) == 1, Errors.NOT_AUTHORISED)
sp.verify(
(sp.sender == params.owner)
| self.data.operators.contains(
sp.record(owner=params.owner, operator=sp.sender, token_id=token_id)
),
Errors.NOT_AUTHORISED,
)
# Attach token/lock
self.data.attached[token_id] = sp.sender
with arg.match("remove_attachment") as token_id:
# Sanity checks
sp.verify(self.data.ledger.get((params.owner, token_id), 0) == 1, Errors.NOT_AUTHORISED)
sp.verify(sp.sender == self.data.attached[token_id], Errors.NOT_AUTHORISED)
sp.verify(
(sp.sender == params.owner)
| self.data.operators.contains(
sp.record(owner=params.owner, operator=sp.sender, token_id=token_id)
),
Errors.NOT_AUTHORISED,
)
with sp.if_(self.data.attached.contains(token_id)):
# Detach token/lock
del self.data.attached[token_id]
@sp.private_lambda(with_storage="read-write", wrap_call=True)
def record_global_checkpoint(self, params):
sp.set_type(
params,
sp.TRecord(old_cp=Types.POINT, new_cp=Types.POINT, prev_end=sp.TNat, new_end=sp.TNat),
)
# nat version of block timestamp
now_ = sp.compute(sp.as_nat(sp.now - sp.timestamp(0)))
with sp.if_(self.data.gc_index == 0):
# First entry check
self.data.slope_changes[params.new_end] = params.new_cp.slope
self.data.global_checkpoints[self.data.gc_index + 1] = sp.record(
bias=params.new_cp.bias,
slope=params.new_cp.slope,
ts=now_,
)
self.data.gc_index += 1
with sp.else_():
global_checkpoint = sp.compute(self.data.global_checkpoints[self.data.gc_index])
# Calculate current global bias and slope
c_bias = sp.local("c_bias", global_checkpoint.bias)
c_slope = sp.local("c_slope", global_checkpoint.slope)
n_ts = sp.local("n_ts", ((global_checkpoint.ts + WEEK) // WEEK) * WEEK)
c_ts = sp.local("c_ts", global_checkpoint.ts)
with sp.if_(n_ts.value < now_):
with sp.while_((n_ts.value < now_) & (c_bias.value != 0)):
d_ts = sp.as_nat(n_ts.value - c_ts.value)
c_bias.value = sp.as_nat(c_bias.value - (d_ts * c_slope.value) // SLOPE_MULTIPLIER)
# Update slope
c_slope.value = sp.as_nat(c_slope.value - self.data.slope_changes.get(n_ts.value, 0))
# Update n_ts
c_ts.value = n_ts.value
n_ts.value = n_ts.value + WEEK
with sp.if_(c_bias.value != 0):
d_ts = sp.as_nat(now_ - c_ts.value)
c_bias.value = sp.as_nat(c_bias.value - (d_ts * c_slope.value) // SLOPE_MULTIPLIER)
# Adjust out old checkpoint off the global bias/slope & slope_changes
with sp.if_(params.old_cp.slope != 0):
bias_ = sp.as_nat(
params.old_cp.bias - (params.old_cp.slope * sp.as_nat(now_ - params.old_cp.ts)) // SLOPE_MULTIPLIER
)
c_bias.value = sp.as_nat(c_bias.value - bias_)
c_slope.value = sp.as_nat(c_slope.value - params.old_cp.slope)
with sp.if_(params.prev_end != 0):
self.data.slope_changes[params.prev_end] = sp.as_nat(
self.data.slope_changes[params.prev_end] - params.old_cp.slope
)
# Add new checkpoint to global bias/slope & slope_changes
c_bias.value += params.new_cp.bias
c_slope.value += params.new_cp.slope
change = self.data.slope_changes.get(params.new_end, 0)
self.data.slope_changes[params.new_end] = change + params.new_cp.slope
# Insert new global checkpoint
self.data.global_checkpoints[self.data.gc_index + 1] = sp.record(
bias=c_bias.value,
slope=c_slope.value,
ts=now_,
)
self.data.gc_index += 1
@sp.entry_point
def create_lock(self, params):
sp.set_type(params, Types.CREATE_LOCK_PARAMS)
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
# nat version of block timestamp
now_ = sp.compute(sp.as_nat(sp.now - sp.timestamp(0)))
# Find a timestamp rounded off to nearest week
ts = sp.compute((params.end // WEEK) * WEEK)
# Lock period in seconds
d_ts = sp.compute(sp.as_nat(ts - now_, Errors.INVALID_LOCK_TIME))
# Verify that calculated timestamp falls in the correct range
sp.verify((d_ts >= WEEK) & (d_ts <= MAX_TIME), Errors.INVALID_LOCK_TIME)
# Calculate slope & bias for linearly decreasing voting power
bias = sp.compute((params.base_value * d_ts) // MAX_TIME)
slope = (bias * SLOPE_MULTIPLIER) // d_ts
# Update uid and mint associated NFT for params.user_address
self.data.uid += 1
# Store as local variable to keep on stack
uid = sp.compute(self.data.uid)
# Update balance in the FA2 ledger
self.data.ledger[(params.user_address, uid)] = sp.nat(1)
# Register a lock
self.data.locks[uid] = sp.record(
base_value=params.base_value,
end=ts,
)
# Record token checkpoint
self.data.num_token_checkpoints[uid] = 1
self.data.token_checkpoints[(uid, 1)] = sp.record(
slope=slope,
bias=bias,
ts=now_,
)
# Record global checkpoint for lock creation
old_cp = sp.record(bias=0, slope=0, ts=0)
new_cp = self.data.token_checkpoints[(uid, 1)]
self.record_global_checkpoint(
sp.record(
old_cp=old_cp,
new_cp=new_cp,
prev_end=0,
new_end=self.data.locks[uid].end,
)
)
# Retrieve base token to self address
TokenUtils.transfer_FA12(
sp.record(
from_=sp.sender,
to_=sp.self_address,
value=params.base_value,
token_address=self.data.base_token,
)
)
# Increase locked supply
self.data.locked_supply += params.base_value
@sp.entry_point
def withdraw(self, token_id):
sp.set_type(token_id, sp.TNat)
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
# nat version of block timestamp
now_ = sp.as_nat(sp.now - sp.timestamp(0))
# Verify that the lock with supplied token-id exists
sp.verify(self.data.locks.contains(token_id), Errors.LOCK_DOES_NOT_EXIST)
# Store as local variable to keep on stack
lock = sp.compute(self.data.locks[token_id])
# Sanity checks
sp.verify(self.data.ledger.get((sp.sender, token_id), 0) == 1, Errors.NOT_AUTHORISED)
sp.verify(now_ > lock.end, Errors.LOCK_YET_TO_EXPIRE)
sp.verify(~self.data.attached.contains(token_id), Errors.LOCK_IS_ATTACHED)
# Transfer underlying PLY
TokenUtils.transfer_FA12(
sp.record(
from_=sp.self_address,
to_=sp.sender,
value=lock.base_value,
token_address=self.data.base_token,
)
)
# Decrease locked supply
self.data.locked_supply = sp.as_nat(self.data.locked_supply - lock.base_value)
# Remove associated token
self.data.ledger[(sp.sender, token_id)] = 0
# Delete the lock
del self.data.locks[token_id]
@sp.entry_point
def increase_lock_value(self, params):
sp.set_type(params, sp.TRecord(token_id=sp.TNat, value=sp.TNat).layout(("token_id", "value")))
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
# nat version of block timestamp
now_ = sp.compute(sp.as_nat(sp.now - sp.timestamp(0)))
# Verify that lock with token-id exists
sp.verify(self.data.locks.contains(params.token_id), Errors.LOCK_DOES_NOT_EXIST)
# Store as local variable to keep on stack
lock = sp.compute(self.data.locks[params.token_id])
# Sanity checks
sp.verify(
(sp.sender == sp.self_address) | (self.data.ledger.get((sp.sender, params.token_id), 0) == 1),
Errors.NOT_AUTHORISED,
)
sp.verify((sp.sender == sp.self_address) | (lock.end > now_), Errors.LOCK_HAS_EXPIRED)
sp.verify(params.value > 0, Errors.INVALID_INCREASE_VALUE)
# Modify base value of the lock
self.data.locks[params.token_id].base_value += params.value
# Only add a checkpoint if the lock has not already expired
with sp.if_(lock.end > now_):
# Fetch current updated bias
index_ = sp.compute(self.data.num_token_checkpoints[params.token_id])
last_tc = sp.compute(self.data.token_checkpoints[(params.token_id, index_)])
bias_ = sp.as_nat(last_tc.bias - (last_tc.slope * sp.as_nat(now_ - last_tc.ts)) // SLOPE_MULTIPLIER)
# Time left in lock
d_ts = sp.compute(sp.as_nat(lock.end - now_))
# Increase in bias
i_bias = (params.value * d_ts) // MAX_TIME
# New bias & slope
n_bias = sp.compute(bias_ + i_bias)
n_slope = (n_bias * SLOPE_MULTIPLIER) // d_ts
# Record new token checkpoint
self.data.token_checkpoints[(params.token_id, index_ + 1)] = sp.record(
slope=n_slope,
bias=n_bias,
ts=now_,
)
# Updated later to prevent access error
self.data.num_token_checkpoints[params.token_id] += 1
# Store as local variable to keep on stack
index__ = sp.compute(self.data.num_token_checkpoints[params.token_id])
# Record global checkpoint
old_cp = self.data.token_checkpoints[(params.token_id, sp.as_nat(index__ - 1))]
new_cp = self.data.token_checkpoints[(params.token_id, index__)]
self.record_global_checkpoint(
sp.record(
old_cp=old_cp,
new_cp=new_cp,
prev_end=lock.end,
new_end=lock.end,
)
)
with sp.if_(sp.sender != sp.self_address):
# Retrieve the increased value in base token
TokenUtils.transfer_FA12(
sp.record(
from_=sp.sender,
to_=sp.self_address,
value=params.value,
token_address=self.data.base_token,
)
)
# Increase locked supply
self.data.locked_supply += params.value
@sp.entry_point
def increase_lock_end(self, params):
sp.set_type(params, sp.TRecord(token_id=sp.TNat, end=sp.TNat).layout(("token_id", "end")))
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
# nat version of block timestamp
now_ = sp.compute(sp.as_nat(sp.now - sp.timestamp(0)))
# Find a timestamp rounded off to nearest week
ts = sp.compute((params.end // WEEK) * WEEK)
# Lock period in seconds
d_ts = sp.compute(sp.as_nat(ts - now_, Errors.INVALID_LOCK_TIME))
# Verify that lock with token-id exists
sp.verify(self.data.locks.contains(params.token_id), Errors.LOCK_DOES_NOT_EXIST)
# Store as local variable to keep on stack
lock = sp.compute(self.data.locks[params.token_id])
# Sanity checks
sp.verify(self.data.ledger[(sp.sender, params.token_id)] == 1, Errors.NOT_AUTHORISED)
sp.verify(lock.end > now_, Errors.LOCK_HAS_EXPIRED)
sp.verify((ts > lock.end) & (d_ts <= MAX_TIME), Errors.INVALID_INCREASE_END_TIMESTAMP)
# Calculate new bias and slope
bias = sp.compute((lock.base_value * d_ts) // MAX_TIME)
slope = (bias * SLOPE_MULTIPLIER) // d_ts
# Update lock end
self.data.locks[params.token_id].end = ts
# Update checkpoint index
self.data.num_token_checkpoints[params.token_id] += 1
# Store as local variable to keep on stack
index_ = sp.compute(self.data.num_token_checkpoints[params.token_id])
# Add new checkpoint for token
self.data.token_checkpoints[(params.token_id, index_)] = sp.record(
slope=slope,
bias=bias,
ts=now_,
)
# Record global checkpoint
old_cp = self.data.token_checkpoints[(params.token_id, sp.as_nat(index_ - 1))]
new_cp = self.data.token_checkpoints[(params.token_id, index_)]
self.record_global_checkpoint(
sp.record(
old_cp=old_cp,
new_cp=new_cp,
prev_end=lock.end,
new_end=ts,
)
)
# NOTE: called once during origination sequence
@sp.entry_point
def set_voter(self, address):
sp.set_type(address, sp.TAddress)
with sp.if_(self.data.voter == Addresses.CONTRACT):
self.data.voter = address
@sp.entry_point
def add_inflation(self, params):
sp.set_type(params, sp.TRecord(epoch=sp.TNat, value=sp.TNat).layout(("epoch", "value")))
# Verify that the sender is the Voter contract
sp.verify(sp.sender == self.data.voter, Errors.NOT_AUTHORISED)
# Update inflation value for the epoch
self.data.epoch_inflation[params.epoch] = params.value
# Increase locked supply
self.data.locked_supply += params.value
@sp.entry_point
def claim_inflation(self, params):
sp.set_type(params, sp.TRecord(token_id=sp.TNat, epochs=sp.TList(sp.TNat)).layout(("token_id", "epochs")))
# Reject tez
sp.verify(sp.amount == sp.tez(0), Errors.ENTRYPOINT_DOES_NOT_ACCEPT_TEZ)
# Sanity checks
sp.verify(self.data.ledger.get((sp.sender, params.token_id), 0) == 1, Errors.NOT_AUTHORISED)
# Local variable to store through the inflation share
inflation_share = sp.local("inflation_share", sp.nat(0))
# Iterate through requested epochs
with sp.for_("epochs", params.epochs) as epoch:
sp.verify(
~self.data.claim_ledger.contains(sp.record(token_id=params.token_id, epoch=epoch)),
Errors.ALREADY_CLAIMED_INFLATION,
)
sp.verify(self.data.epoch_inflation.contains(epoch), Errors.INFLATION_NOT_ADDED)
# Get epoch ending from Voter
epoch_end = sp.view("get_epoch_end", self.data.voter, epoch, sp.TNat).open_some(Errors.INVALID_VIEW)
ts_ = sp.compute(sp.as_nat(epoch_end - WEEK))
# Get token voting power at the beginning of epoch
token_vp = sp.view(
"get_token_voting_power",
sp.self_address,
sp.record(token_id=params.token_id, ts=ts_, time=Types.WHOLE_WEEK),
sp.TNat,
).open_some(Errors.INVALID_VIEW)
# Get total voting power at the beginning of epoch
total_vp = sp.view(
"get_total_voting_power",
sp.self_address,
sp.record(ts=ts_, time=Types.WHOLE_WEEK),
sp.TNat,
).open_some(Errors.INVALID_VIEW)
# Calculate inflation share for the token/lock
inflation_share.value += (token_vp * self.data.epoch_inflation[epoch]) // total_vp
# Mark as claimed
self.data.claim_ledger[sp.record(token_id=params.token_id, epoch=epoch)] = sp.unit
# Increase lock value using the inflation share
c = sp.self_entry_point("increase_lock_value")
sp.transfer(sp.record(token_id=params.token_id, value=inflation_share.value), sp.tez(0), c)
@sp.onchain_view()
def get_token_voting_power(self, params):
sp.set_type(
params,
sp.TRecord(
token_id=sp.TNat,
ts=sp.TNat,
time=sp.TNat,
),
)
# Find a operating timestamp based on user supplied time type in parameters
factor = sp.local("factor", WEEK)
with sp.if_(params.time == Types.CURRENT):
factor.value = 1
ts = sp.compute((params.ts // factor.value) * factor.value)
# Sanity checks
sp.verify((params.time == Types.CURRENT) | (params.time == Types.WHOLE_WEEK), Errors.INVALID_TIME)
sp.verify(self.data.locks.contains(params.token_id), Errors.LOCK_DOES_NOT_EXIST)
sp.verify(ts >= self.data.token_checkpoints[(params.token_id, 1)].ts, Errors.TOO_EARLY_TIMESTAMP)
# Store as local variables to keep on stack
index_ = sp.compute(self.data.num_token_checkpoints[params.token_id])
last_checkpoint = sp.compute(self.data.token_checkpoints[(params.token_id, index_)])
with sp.if_(ts >= last_checkpoint.ts):
i_bias = last_checkpoint.bias
slope = last_checkpoint.slope
f_bias = sp.compute(i_bias - (sp.as_nat(ts - last_checkpoint.ts) * slope) // SLOPE_MULTIPLIER)
with sp.if_(f_bias < 0):
sp.result(sp.nat(0))
with sp.else_():
sp.result(sp.as_nat(f_bias))
with sp.else_():
high = sp.local("high", sp.as_nat(index_ - 2))
low = sp.local("low", sp.nat(0))
mid = sp.local("mid", sp.nat(0))
with sp.while_(
(low.value < high.value) & (self.data.token_checkpoints[(params.token_id, mid.value + 1)].ts != ts)
):
mid.value = (low.value + high.value + 1) // 2
with sp.if_(self.data.token_checkpoints[(params.token_id, mid.value + 1)].ts < ts):
low.value = mid.value
with sp.else_():
high.value = sp.as_nat(mid.value - 1)
with sp.if_(self.data.token_checkpoints[(params.token_id, mid.value + 1)].ts == ts):
sp.result(self.data.token_checkpoints[(params.token_id, mid.value + 1)].bias)
with sp.else_():
checkpoint = sp.compute(self.data.token_checkpoints[(params.token_id, low.value + 1)])
bias = checkpoint.bias
slope = checkpoint.slope
d_ts = ts - checkpoint.ts
sp.result(sp.as_nat(bias - (sp.as_nat(d_ts) * slope) // SLOPE_MULTIPLIER))
@sp.onchain_view()
def get_total_voting_power(self, params):
sp.set_type(
params,
sp.TRecord(
ts=sp.TNat,
time=sp.TNat,
),
)
# Find a operating timestamp based on user supplied time type in parameters
factor = sp.local("factor", WEEK)
with sp.if_(params.time == Types.CURRENT):
factor.value = 1
ts = sp.compute((params.ts // factor.value) * factor.value)
# Sanity check
sp.verify((params.time == Types.CURRENT) | (params.time == Types.WHOLE_WEEK), Errors.INVALID_TIME)
sp.verify(ts >= self.data.global_checkpoints[1].ts, Errors.TOO_EARLY_TIMESTAMP)
# Checkpoint closest to requested ts
c_cp = sp.local("c_cp", self.data.global_checkpoints[self.data.gc_index])
# Find the closest checkpoint using binary search
with sp.if_(ts < c_cp.value.ts):
high = sp.local("high", sp.as_nat(self.data.gc_index - 2))
low = sp.local("low", sp.nat(0))
mid = sp.local("mid", sp.nat(0))
with sp.while_((low.value < high.value) & (self.data.global_checkpoints[mid.value + 1].ts != ts)):
mid.value = (low.value + high.value + 1) // 2
with sp.if_(self.data.global_checkpoints[mid.value + 1].ts < ts):
low.value = mid.value
with sp.else_():
high.value = sp.as_nat(mid.value - 1)
with sp.if_(self.data.global_checkpoints[mid.value + 1].ts == ts):
c_cp.value = self.data.global_checkpoints[mid.value + 1]
with sp.else_():
c_cp.value = self.data.global_checkpoints[low.value + 1]
# Calculate the linear drop across remaining seconds
c_bias = sp.local("c_bias", c_cp.value.bias)
c_slope = sp.local("c_slope", c_cp.value.slope)
n_ts = sp.local("n_ts", ((c_cp.value.ts + WEEK) // WEEK) * WEEK)
c_ts = sp.local("c_ts", c_cp.value.ts)
with sp.if_(n_ts.value < ts):
# Can go upto ts here, since ts is a whole WEEK
with sp.while_((n_ts.value < ts) & (c_bias.value != 0)):
d_ts = sp.as_nat(n_ts.value - c_ts.value)
c_bias.value = sp.as_nat(c_bias.value - (d_ts * c_slope.value) // SLOPE_MULTIPLIER)
# Update slope
c_slope.value = sp.as_nat(c_slope.value - self.data.slope_changes.get(n_ts.value, 0))
# Update n_ts
c_ts.value = n_ts.value
n_ts.value = n_ts.value + WEEK
with sp.if_(c_bias.value != 0):
d_ts = sp.as_nat(ts - c_ts.value)
c_bias.value = sp.as_nat(c_bias.value - (d_ts * c_slope.value) // SLOPE_MULTIPLIER)
sp.result(c_bias.value)
@sp.onchain_view()
def is_owner(self, params):
sp.set_type(params, sp.TRecord(address=sp.TAddress, token_id=sp.TNat))
balance = self.data.ledger.get((params.address, params.token_id), 0)
with sp.if_(balance != 1):
sp.result(sp.bool(False))
with sp.else_():
sp.result(sp.bool(True))
@sp.onchain_view()
def get_locked_supply(self):
sp.result(self.data.locked_supply)
@sp.offchain_view(pure=False)
def token_metadata(self, token_id):
sp.set_type(token_id, sp.TNat)
# Verify that the lock with supplied token-id exists
sp.verify(self.data.locks.contains(token_id), Errors.LOCK_DOES_NOT_EXIST)
# Current timestamp as nat
ts = sp.compute(sp.as_nat(sp.now - sp.timestamp(0)))
lock = sp.compute(self.data.locks[token_id])
bytes_of_nat = sp.compute(Utils.bytes_of_nat)
voting_power = sp.local("voting_power", 0)
expiry = sp.local("expiry", 0)
with sp.if_(lock.end > ts):
# Number of days left to expire
expiry.value = sp.as_nat(lock.end - ts) // 86400
index_ = self.data.num_token_checkpoints[token_id]
last_checkpoint = sp.compute(self.data.token_checkpoints[(token_id, index_)])
# Find the current voting power. `ts` is bound to be >= the timestamp of last checkpoint.
i_bias = last_checkpoint.bias
slope = last_checkpoint.slope
f_bias = sp.compute(i_bias - (sp.as_nat(ts - last_checkpoint.ts) * slope) // SLOPE_MULTIPLIER)
with sp.if_(f_bias < 0):
voting_power.value = 0
with sp.else_():
voting_power.value = sp.as_nat(f_bias)
# Segments of the SVG data URI
segments = sp.local("segments", SVG.DATA_SEGMENTS.GOLD)
# Select the correct set of segments based on days to expire to generate the SVG
# >= 3 years = gold
# >= 2 years = violet
# >= 6 months = red
# < 6 months = green
# expired = grey
with sp.if_((expiry.value >= 728) & (expiry.value < 1092)):
segments.value = SVG.DATA_SEGMENTS.VIOLET
with sp.else_():
with sp.if_((expiry.value >= 180) & (expiry.value < 728)):
segments.value = SVG.DATA_SEGMENTS.RED
with sp.else_():
with sp.if_(expiry.value < 180):
segments.value = SVG.DATA_SEGMENTS.GREEN
with sp.if_(lock.end < ts):
segments.value = SVG.DATA_SEGMENTS.GREY
get_floating_point = sp.compute(Utils.get_floating_point)
f_locked_ply = get_floating_point(lock.base_value)
f_voting_power = get_floating_point(voting_power.value)
b_locked_ply = sp.local("b_locked_ply", bytes_of_nat(sp.fst(f_locked_ply)))
b_voting_power = sp.local("b_voting_power", bytes_of_nat(sp.fst(f_voting_power)))
with sp.if_(sp.snd(f_locked_ply) > 0):
b_locked_ply.value += sp.utils.bytes_of_string(".") + bytes_of_nat(sp.snd(f_locked_ply))
with sp.if_(sp.snd(f_voting_power) > 0):
b_voting_power.value += sp.utils.bytes_of_string(".") + bytes_of_nat(sp.snd(f_voting_power))
# Build the SVG data URI
image_uri = sp.compute(
SVG.build_svg(
sp.record(
segments=segments.value,
token_id=bytes_of_nat(token_id),
locked_ply=b_locked_ply.value,
voting_power=b_voting_power.value,
expiry=bytes_of_nat(expiry.value),
)
)
)
# Create a TZIP-21 compliant token-info
metadata_tzip_21 = {
"name": sp.utils.bytes_of_string("Plenty veNFT"),
"symbol": sp.utils.bytes_of_string("veNFT"),
"decimals": sp.utils.bytes_of_string("0"),
"thumbnailUri": image_uri,
"artifactUri": image_uri,
"displayUri": image_uri,
"ttl": bytes_of_nat(sp.nat(900)),
}
# Return the TZIP-16 compliant metadata
sp.result(
sp.record(
token_id=token_id,
token_info=metadata_tzip_21,
)
)