forked from joshstevens19/rentable-protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRentable.sol
1108 lines (964 loc) · 34.4 KB
/
Rentable.sol
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
// SPDX-License-Identifier: MIT
pragma solidity >=0.8.7;
// Inheritance
import {IRentable} from "./interfaces/IRentable.sol";
import {IRentableAdminEvents} from "./interfaces/IRentableAdminEvents.sol";
import {IRentableHooks} from "./interfaces/IRentableHooks.sol";
import {IORentableHooks} from "./interfaces/IORentableHooks.sol";
import {IWRentableHooks} from "./interfaces/IWRentableHooks.sol";
import {BaseSecurityInitializable} from "./security/BaseSecurityInitializable.sol";
import {RentableStorageV1} from "./RentableStorageV1.sol";
import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
// Libraries
import {SafeERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import {Address} from "@openzeppelin/contracts/utils/Address.sol";
// References
import {IERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";
import {IERC20Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import {IERC1155Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC1155/IERC1155Upgradeable.sol";
import {IERC721ReadOnlyProxy} from "./interfaces/IERC721ReadOnlyProxy.sol";
import {IERC721ExistExtension} from "./interfaces/IERC721ExistExtension.sol";
import {ICollectionLibrary} from "./collections/ICollectionLibrary.sol";
import {IWalletFactory} from "./wallet/IWalletFactory.sol";
import {SimpleWallet} from "./wallet/SimpleWallet.sol";
import {RentableTypes} from "./RentableTypes.sol";
/// @title Rentable main contract
/// @author Rentable Team <[email protected]>
/// @custom:security Rentable Security Team <[email protected]>
/// @notice Main entry point to interact with Rentable protocol
contract Rentable is
IRentable,
IRentableAdminEvents,
IORentableHooks,
IWRentableHooks,
BaseSecurityInitializable,
ReentrancyGuardUpgradeable,
RentableStorageV1
{
/* ========== LIBRARIES ========== */
using Address for address;
using SafeERC20Upgradeable for IERC20Upgradeable;
/* ========== MODIFIERS ========== */
/// @dev Prevents calling a function from anyone except the owner
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
modifier onlyOTokenOwner(address tokenAddress, uint256 tokenId) {
_getExistingORentableCheckOwnership(tokenAddress, tokenId, msg.sender);
_;
}
/// @dev Prevents calling a function from anyone except respective OToken
/// @param tokenAddress wrapped token address
modifier onlyOToken(address tokenAddress) {
require(
msg.sender == _orentables[tokenAddress],
"Only proper ORentables allowed"
);
_;
}
/// @dev Prevents calling a function from anyone except respective WToken
/// @param tokenAddress wrapped token address
modifier onlyWToken(address tokenAddress) {
require(
msg.sender == _wrentables[tokenAddress],
"Only proper WRentables allowed"
);
_;
}
/// @dev Prevents calling a function from anyone except respective OToken or WToken
/// @param tokenAddress wrapped token address
modifier onlyOTokenOrWToken(address tokenAddress) {
require(
msg.sender == _orentables[tokenAddress] ||
msg.sender == _wrentables[tokenAddress],
"Only w/o tokens are authorized"
);
_;
}
/// @dev Prevents calling a library when not set for the respective wrapped token
/// @param tokenAddress wrapped token address
// slither-disable-next-line incorrect-modifier
modifier skipIfLibraryNotSet(address tokenAddress) {
if (_libraries[tokenAddress] != address(0)) {
_;
}
}
/* ========== CONSTRUCTOR ========== */
/// @dev Instatiate Rentable
/// @param governance address for governance role
/// @param operator address for operator role
constructor(address governance, address operator) {
_initialize(governance, operator);
}
/* ---------- INITIALIZER ---------- */
/// @dev Initialize Rentable (to be used with proxies)
/// @param governance address for governance role
/// @param operator address for operator role
function initialize(address governance, address operator) external {
_initialize(governance, operator);
}
/// @dev For internal usage in the initializer external method
/// @param governance address for governance role
/// @param operator address for operator role
function _initialize(address governance, address operator)
internal
initializer
{
__BaseSecurityInitializable_init(governance, operator);
__ReentrancyGuard_init();
}
/* ========== SETTERS ========== */
/// @dev Associate the event hooks library to the specific wrapped token
/// @param tokenAddress wrapped token address
/// @param libraryAddress library address
function setLibrary(address tokenAddress, address libraryAddress)
external
onlyGovernance
{
address previousValue = _libraries[tokenAddress];
_libraries[tokenAddress] = libraryAddress;
emit LibraryChanged(tokenAddress, previousValue, libraryAddress);
}
/// @dev Associate the otoken to the specific wrapped token
/// @param tokenAddress wrapped token address
/// @param oRentable otoken address
function setORentable(address tokenAddress, address oRentable)
external
onlyGovernance
{
address previousValue = _orentables[tokenAddress];
_orentables[tokenAddress] = oRentable;
emit ORentableChanged(tokenAddress, previousValue, oRentable);
}
/// @dev Associate the otoken to the specific wrapped token
/// @param tokenAddress wrapped token address
/// @param wRentable otoken address
function setWRentable(address tokenAddress, address wRentable)
external
onlyGovernance
{
address previousValue = _wrentables[tokenAddress];
_wrentables[tokenAddress] = wRentable;
emit WRentableChanged(tokenAddress, previousValue, wRentable);
}
/// @dev Set wallet factory
/// @param walletFactory wallet factory address
function setWalletFactory(address walletFactory) external onlyGovernance {
require(walletFactory != address(0), "Wallet Factory cannot be 0");
address previousWalletFactory = walletFactory;
_walletFactory = walletFactory;
emit WalletFactoryChanged(previousWalletFactory, walletFactory);
}
/// @dev Set fee (percentage)
/// @param newFee fee in 1e4 units (e.g. 100% = 10000)
function setFee(uint16 newFee) external onlyGovernance {
require(newFee <= BASE_FEE, "Fee greater than max value");
uint16 previousFee = _fee;
_fee = newFee;
emit FeeChanged(previousFee, newFee);
}
/// @dev Set fee collector address
/// @param newFeeCollector fee collector address
function setFeeCollector(address payable newFeeCollector)
external
onlyGovernance
{
require(newFeeCollector != address(0), "FeeCollector cannot be null");
address previousFeeCollector = _feeCollector;
_feeCollector = newFeeCollector;
emit FeeCollectorChanged(previousFeeCollector, newFeeCollector);
}
/// @dev Enable payment token (ERC20)
/// @param paymentToken payment token address
function enablePaymentToken(address paymentToken) external onlyGovernance {
uint8 previousStatus = _paymentTokenAllowlist[paymentToken];
_paymentTokenAllowlist[paymentToken] = ERC20_TOKEN;
emit PaymentTokenAllowListChanged(
paymentToken,
previousStatus,
ERC20_TOKEN
);
}
/// @dev Enable payment token (ERC1155)
/// @param paymentToken payment token address
function enable1155PaymentToken(address paymentToken)
external
onlyGovernance
{
uint8 previousStatus = _paymentTokenAllowlist[paymentToken];
_paymentTokenAllowlist[paymentToken] = ERC1155_TOKEN;
emit PaymentTokenAllowListChanged(
paymentToken,
previousStatus,
ERC1155_TOKEN
);
}
/// @dev Disable payment token (ERC1155)
/// @param paymentToken payment token address
function disablePaymentToken(address paymentToken) external onlyGovernance {
uint8 previousStatus = _paymentTokenAllowlist[paymentToken];
_paymentTokenAllowlist[paymentToken] = NOT_ALLOWED_TOKEN;
emit PaymentTokenAllowListChanged(
paymentToken,
previousStatus,
NOT_ALLOWED_TOKEN
);
}
/// @dev Toggle o/w token to call on-behalf a selector on the wrapped token
/// @param caller o/w token address
/// @param selector selector bytes on the target wrapped token
/// @param enabled true to enable, false to disable
function enableProxyCall(
address caller,
bytes4 selector,
bool enabled
) external onlyGovernance {
bool previousStatus = _proxyAllowList[caller][selector];
_proxyAllowList[caller][selector] = enabled;
emit ProxyCallAllowListChanged(
caller,
selector,
previousStatus,
enabled
);
}
/* ========== VIEWS ========== */
/* ---------- Internal ---------- */
/// @dev Get and check (reverting) otoken exist for a specific token
/// @param tokenAddress wrapped token address
/// @return oRentable otoken instance
function _getExistingORentable(address tokenAddress)
internal
view
returns (address oRentable)
{
oRentable = _orentables[tokenAddress];
require(oRentable != address(0), "Token currently not supported");
}
/// @dev Get and check (reverting) otoken user ownership
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param user user to verify ownership
/// @return oRentable otoken instance
function _getExistingORentableCheckOwnership(
address tokenAddress,
uint256 tokenId,
address user
) internal view returns (address oRentable) {
oRentable = _getExistingORentable(tokenAddress);
require(
IERC721Upgradeable(oRentable).ownerOf(tokenId) == user,
"The token must be yours"
);
}
/// @dev Show rental validity
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @return true if is expired, false otw
function _isExpired(address tokenAddress, uint256 tokenId)
internal
view
returns (bool)
{
// slither-disable-next-line timestamp
return block.timestamp >= (_expiresAt[tokenAddress][tokenId]);
}
/* ---------- Public ---------- */
/// @notice Get library address for the specific wrapped token
/// @param tokenAddress wrapped token address
/// @return library address
function getLibrary(address tokenAddress) external view returns (address) {
return _libraries[tokenAddress];
}
/// @notice Get OToken address associated to the specific wrapped token
/// @param tokenAddress wrapped token address
/// @return OToken address
function getORentable(address tokenAddress)
external
view
returns (address)
{
return _orentables[tokenAddress];
}
/// @notice Get WToken address associated to the specific wrapped token
/// @param tokenAddress wrapped token address
/// @return WToken address
function getWRentable(address tokenAddress)
external
view
returns (address)
{
return _wrentables[tokenAddress];
}
/// @notice Get wallet factory address
/// @return wallet factory address
function getWalletFactory() external view returns (address) {
return _walletFactory;
}
/// @notice Show current protocol fee
/// @return protocol fee in 1e4 units, e.g. 100 = 1%
function getFee() external view returns (uint16) {
return _fee;
}
/// @notice Get protocol fee collector
/// @return protocol fee collector address
function getFeeCollector() external view returns (address payable) {
return _feeCollector;
}
/// @notice Show a token is enabled as payment token
/// @param paymentTokenAddress payment token address
/// @return status, see RentableStorageV1 for values
function getPaymentTokenAllowlist(address paymentTokenAddress)
external
view
returns (uint8)
{
return _paymentTokenAllowlist[paymentTokenAddress];
}
/// @notice Show O/W Token can invoke selector on respective wrapped token
/// @param caller O/W Token address
/// @param selector function selector to invoke
/// @return a bool representing enabled or not
function isEnabledProxyCall(address caller, bytes4 selector)
external
view
returns (bool)
{
return _proxyAllowList[caller][selector];
}
/// @inheritdoc IRentable
function userWallet(address user)
external
view
override
returns (address payable)
{
return _wallets[user];
}
/// @inheritdoc IRentable
function rentalConditions(address tokenAddress, uint256 tokenId)
external
view
override
returns (RentableTypes.RentalConditions memory)
{
return _rentalConditions[tokenAddress][tokenId];
}
/// @inheritdoc IRentable
function expiresAt(address tokenAddress, uint256 tokenId)
external
view
override
returns (uint256)
{
return _expiresAt[tokenAddress][tokenId];
}
/// @inheritdoc IRentable
function isExpired(address tokenAddress, uint256 tokenId)
external
view
override
returns (bool)
{
return _isExpired(tokenAddress, tokenId);
}
/* ========== MUTATIVE FUNCTIONS ========== */
/* ---------- Internal ---------- */
/// @dev Create user wallet address
/// @param user user address
/// @return wallet address
function _createWalletForUser(address user)
internal
returns (address payable wallet)
{
// slither-disable-next-line reentrancy-benign
wallet = IWalletFactory(_walletFactory).createWallet(
address(this),
user
);
require(
wallet != address(0),
"Wallet Factory is not returning a valid wallet address"
);
_wallets[user] = wallet;
// slither-disable-next-line reentrancy-events
emit WalletCreated(user, wallet);
return wallet;
}
/// @dev Get user wallet address (create if not exist)
/// @param user user address
/// @return wallet address
function _getOrCreateWalletForUser(address user)
internal
returns (address payable wallet)
{
wallet = _wallets[user];
if (wallet == address(0)) {
wallet = _createWalletForUser(user);
}
return wallet;
}
/// @dev Deposit only a wrapped token and mint respective OToken
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param to user to mint
function _deposit(
address tokenAddress,
uint256 tokenId,
address to
) internal {
address oRentable = _getExistingORentable(tokenAddress);
require(
IERC721Upgradeable(tokenAddress).ownerOf(tokenId) == address(this),
"Token not deposited"
);
IERC721ReadOnlyProxy(oRentable).mint(to, tokenId);
_postDeposit(tokenAddress, tokenId, to);
emit Deposit(to, tokenAddress, tokenId);
}
/// @dev Deposit and list a wrapped token
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param to user to mint
/// @param rc rental conditions see RentableTypes.RentalConditions
function _depositAndList(
address tokenAddress,
uint256 tokenId,
address to,
RentableTypes.RentalConditions memory rc
) internal {
_deposit(tokenAddress, tokenId, to);
_createOrUpdateRentalConditions(to, tokenAddress, tokenId, rc);
}
/// @dev Set rental conditions for a wrapped token
/// @param user who is changing the conditions
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param rc rental conditions see RentableTypes.RentalConditions
function _createOrUpdateRentalConditions(
address user,
address tokenAddress,
uint256 tokenId,
RentableTypes.RentalConditions memory rc
) internal {
require(
_paymentTokenAllowlist[rc.paymentTokenAddress] != NOT_ALLOWED_TOKEN,
"Not supported payment token"
);
require(
rc.minTimeDuration <= rc.maxTimeDuration,
"Minimum duration cannot be greater than maximum"
);
_rentalConditions[tokenAddress][tokenId] = rc;
_postList(
tokenAddress,
tokenId,
user,
rc.minTimeDuration,
rc.maxTimeDuration,
rc.pricePerSecond
);
emit UpdateRentalConditions(
tokenAddress,
tokenId,
rc.paymentTokenAddress,
rc.paymentTokenId,
rc.minTimeDuration,
rc.maxTimeDuration,
rc.pricePerSecond,
rc.privateRenter
);
}
/// @dev Cancel rental conditions for a wrapped token
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
function _deleteRentalConditions(address tokenAddress, uint256 tokenId)
internal
{
// save gas instead of dropping all the structure
(_rentalConditions[tokenAddress][tokenId]).maxTimeDuration = 0;
}
/// @dev Expire explicitely rental and update data structures for a specific wrapped token
/// @param currentUserHolder (optional) current user holder address
/// @param oTokenOwner (optional) otoken owner address
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param skipExistCheck assume or not wtoken id exists (gas optimization)
/// @return currentlyRented true if rental is not expired
// slither-disable-next-line calls-loop
function _expireRental(
address currentUserHolder,
address oTokenOwner,
address tokenAddress,
uint256 tokenId,
bool skipExistCheck
) internal returns (bool currentlyRented) {
if (
skipExistCheck ||
IERC721ExistExtension(_wrentables[tokenAddress]).exists(tokenId)
) {
if (_isExpired(tokenAddress, tokenId)) {
address currentRentee = oTokenOwner == address(0)
? IERC721Upgradeable(_orentables[tokenAddress]).ownerOf(
tokenId
)
: oTokenOwner;
// recover asset from renter smart wallet to rentable contracts
address wRentable = _wrentables[tokenAddress];
// cannot be 0x0 because transferFrom avoid it
address renter = currentUserHolder == address(0)
? IERC721ExistExtension(wRentable).ownerOf(tokenId, true)
: currentUserHolder;
address payable renterWallet = _wallets[renter];
// slither-disable-next-line unused-return
SimpleWallet(renterWallet).execute(
tokenAddress,
0,
abi.encodeWithSelector(
IERC721Upgradeable.transferFrom.selector, // we don't want to trigger onERC721Receiver
renterWallet,
address(this),
tokenId
),
false
);
// burn
IERC721ReadOnlyProxy(_wrentables[tokenAddress]).burn(tokenId);
// post
_postExpireRental(tokenAddress, tokenId, currentRentee);
emit RentEnds(tokenAddress, tokenId);
} else {
currentlyRented = true;
}
}
return currentlyRented;
}
/// @dev Execute custom logic after deposit via wrapped token library
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param user depositor
function _postDeposit(
address tokenAddress,
uint256 tokenId,
address user
) internal skipIfLibraryNotSet(tokenAddress) {
// slither-disable-next-line unused-return
_libraries[tokenAddress].functionDelegateCall(
abi.encodeWithSelector(
ICollectionLibrary.postDeposit.selector,
tokenAddress,
tokenId,
user
),
""
);
}
/// @dev Execute custom logic after listing via wrapped token library
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param user lister
/// @param maxTimeDuration max duration allowed for the rental
/// @param pricePerSecond price per second in payment token units
function _postList(
address tokenAddress,
uint256 tokenId,
address user,
uint256 minTimeDuration,
uint256 maxTimeDuration,
uint256 pricePerSecond
) internal skipIfLibraryNotSet(tokenAddress) {
// slither-disable-next-line unused-return
_libraries[tokenAddress].functionDelegateCall(
abi.encodeWithSelector(
ICollectionLibrary.postList.selector,
tokenAddress,
tokenId,
user,
minTimeDuration,
maxTimeDuration,
pricePerSecond
),
""
);
}
/// @dev Execute custom logic after rent via wrapped token library
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param duration rental duration
/// @param from rentee
/// @param to renter
/// @param toWallet receiver wallet
function _postRent(
address tokenAddress,
uint256 tokenId,
uint256 duration,
address from,
address to,
address toWallet
) internal skipIfLibraryNotSet(tokenAddress) {
// slither-disable-next-line unused-return
_libraries[tokenAddress].functionDelegateCall(
abi.encodeWithSelector(
ICollectionLibrary.postRent.selector,
tokenAddress,
tokenId,
duration,
from,
to,
toWallet
),
""
);
}
/// @dev Execute custom logic after rent expires via wrapped token library
/// @param tokenAddress wrapped token address
/// @param tokenId wrapped token id
/// @param from rentee
// slither-disable-next-line calls-loop
function _postExpireRental(
address tokenAddress,
uint256 tokenId,
address from
) internal skipIfLibraryNotSet(tokenAddress) {
// slither-disable-next-line unused-return
_libraries[tokenAddress].functionDelegateCall(
abi.encodeWithSelector(
ICollectionLibrary.postExpireRental.selector,
tokenAddress,
tokenId,
from
),
""
);
}
/* ---------- Public ---------- */
/// @inheritdoc IRentable
function createWalletForUser(address user)
external
override
returns (address payable wallet)
{
require(
user != address(0),
"Cannot create a smart wallet for the void"
);
require(_wallets[user] == address(0), "Wallet already existing");
return _createWalletForUser(user);
}
/// @inheritdoc IRentable
function onERC721Received(
address,
address from,
uint256 tokenId,
bytes calldata data
) external override whenNotPaused nonReentrant returns (bytes4) {
if (data.length == 0) {
_deposit(msg.sender, tokenId, from);
} else {
_depositAndList(
msg.sender,
tokenId,
from,
abi.decode(data, (RentableTypes.RentalConditions))
);
}
return this.onERC721Received.selector;
}
/// @inheritdoc IRentable
function withdraw(address tokenAddress, uint256 tokenId)
external
override
whenNotPaused
nonReentrant
{
address user = msg.sender;
address oRentable = _getExistingORentableCheckOwnership(
tokenAddress,
tokenId,
user
);
require(
!_expireRental(address(0), user, tokenAddress, tokenId, false),
"Current rent still pending"
);
_deleteRentalConditions(tokenAddress, tokenId);
IERC721ReadOnlyProxy(oRentable).burn(tokenId);
IERC721Upgradeable(tokenAddress).safeTransferFrom(
address(this),
user,
tokenId
);
emit Withdraw(tokenAddress, tokenId);
}
/// @inheritdoc IRentable
function createOrUpdateRentalConditions(
address tokenAddress,
uint256 tokenId,
RentableTypes.RentalConditions calldata rc
) external override whenNotPaused onlyOTokenOwner(tokenAddress, tokenId) {
_createOrUpdateRentalConditions(msg.sender, tokenAddress, tokenId, rc);
}
/// @inheritdoc IRentable
function deleteRentalConditions(address tokenAddress, uint256 tokenId)
external
override
whenNotPaused
onlyOTokenOwner(tokenAddress, tokenId)
{
_deleteRentalConditions(tokenAddress, tokenId);
}
/// @inheritdoc IRentable
function rent(
address tokenAddress,
uint256 tokenId,
uint256 duration
) external payable override whenNotPaused nonReentrant {
// 1. check token is deposited and available for rental
address oRentable = _getExistingORentable(tokenAddress);
address payable rentee = payable(
IERC721Upgradeable(oRentable).ownerOf(tokenId)
);
RentableTypes.RentalConditions memory rcs = _rentalConditions[
tokenAddress
][tokenId];
require(rcs.maxTimeDuration > 0, "Not available");
require(
!_expireRental(address(0), rentee, tokenAddress, tokenId, false),
"Current rent still pending"
);
// 2. validate renter offer with rentee conditions
require(duration > 0, "Duration cannot be zero");
require(
duration >= rcs.minTimeDuration,
"Duration lower than conditions"
);
require(
duration <= rcs.maxTimeDuration,
"Duration greater than conditions"
);
require(
rcs.privateRenter == address(0) || rcs.privateRenter == msg.sender,
"Rental reserved for another user"
);
// 3. mint wtoken
uint256 eta = block.timestamp + duration;
_expiresAt[tokenAddress][tokenId] = eta;
IERC721ReadOnlyProxy(_wrentables[tokenAddress]).mint(
msg.sender,
tokenId
);
// 4. transfer token to the renter smart wallet
address renterWallet = _getOrCreateWalletForUser(msg.sender);
IERC721Upgradeable(tokenAddress).safeTransferFrom(
address(this),
renterWallet,
tokenId,
""
);
// 5. fees distribution
// gross due amount
uint256 paymentQty = rcs.pricePerSecond * duration;
// protocol and rentee fees calc
uint256 feesForFeeCollector = (paymentQty * _fee) / BASE_FEE;
uint256 feesForRentee = paymentQty - feesForFeeCollector;
if (rcs.paymentTokenAddress == address(0)) {
require(msg.value >= paymentQty, "Not enough funds");
if (feesForFeeCollector > 0) {
Address.sendValue(_feeCollector, feesForFeeCollector);
}
Address.sendValue(rentee, feesForRentee);
// refund eventual remaining
if (msg.value > paymentQty) {
Address.sendValue(payable(msg.sender), msg.value - paymentQty);
}
} else if (
_paymentTokenAllowlist[rcs.paymentTokenAddress] == ERC20_TOKEN
) {
if (feesForFeeCollector > 0) {
IERC20Upgradeable(rcs.paymentTokenAddress).safeTransferFrom(
msg.sender,
_feeCollector,
feesForFeeCollector
);
}
IERC20Upgradeable(rcs.paymentTokenAddress).safeTransferFrom(
msg.sender,
rentee,
feesForRentee
);
} else {
if (feesForFeeCollector > 0) {
IERC1155Upgradeable(rcs.paymentTokenAddress).safeTransferFrom(
msg.sender,
_feeCollector,
rcs.paymentTokenId,
feesForFeeCollector,
""
);
}
IERC1155Upgradeable(rcs.paymentTokenAddress).safeTransferFrom(
msg.sender,
rentee,
rcs.paymentTokenId,
feesForRentee,
""
);
}
// 6. after rent custom logic
_postRent(
tokenAddress,
tokenId,
duration,
rentee,
msg.sender,
renterWallet
);
emit Rent(
rentee,
msg.sender,
tokenAddress,
tokenId,
rcs.paymentTokenAddress,
rcs.paymentTokenId,
eta
);
}
/// @inheritdoc IRentable
function expireRental(address tokenAddress, uint256 tokenId)
external
override
whenNotPaused
returns (bool currentlyRented)
{
return
_expireRental(address(0), address(0), tokenAddress, tokenId, false);
}
/// @notice Batch expireRental
/// @param tokenAddresses array of wrapped token addresses
/// @param tokenIds array of wrapped token id
function expireRentals(
address[] calldata tokenAddresses,
uint256[] calldata tokenIds
) external whenNotPaused {
for (uint256 i = 0; i < tokenAddresses.length; i++) {
_expireRental(
address(0),
address(0),
tokenAddresses[i],
tokenIds[i],
false
);
}
}
/* ---------- Public Permissioned ---------- */
/// @inheritdoc IORentableHooks
function afterOTokenTransfer(
address tokenAddress,
address from,
address to,
uint256 tokenId
) external override whenNotPaused onlyOToken(tokenAddress) {
bool rented = _expireRental(
address(0),
from,
tokenAddress,