-
Notifications
You must be signed in to change notification settings - Fork 6
/
MarketFees.sol
538 lines (488 loc) · 20.3 KB
/
MarketFees.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
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.12;
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "@manifoldxyz/royalty-registry-solidity/contracts/IRoyaltyRegistry.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
import "../../interfaces/IGetFees.sol";
import "../../interfaces/IGetRoyalties.sol";
import "../../interfaces/IOwnable.sol";
import "../../interfaces/IRoyaltyInfo.sol";
import "../../interfaces/ITokenCreator.sol";
import "../../libraries/ArrayLibrary.sol";
import "./Constants.sol";
import "./FoundationTreasuryNode.sol";
import "./OZERC165Checker.sol";
import "./SendValueWithFallbackWithdraw.sol";
import "./MarketSharedCore.sol";
error NFTMarketFees_Address_Does_Not_Support_IRoyaltyRegistry();
/**
* @title A mixin to distribute funds when an NFT is sold.
*/
abstract contract MarketFees is FoundationTreasuryNode, MarketSharedCore, SendValueWithFallbackWithdraw {
using AddressUpgradeable for address;
using ArrayLibrary for address payable[];
using ArrayLibrary for uint256[];
using ERC165Checker for address;
using OZERC165Checker for address;
/**
* @dev Removing old unused variables in an upgrade safe way. Was:
* uint256 private _primaryFoundationFeeBasisPoints;
* uint256 private _secondaryFoundationFeeBasisPoints;
* uint256 private _secondaryCreatorFeeBasisPoints;
* mapping(address => mapping(uint256 => bool)) private _nftContractToTokenIdToFirstSaleCompleted;
*/
uint256[4] private __gap_was_fees;
/// @notice The royalties sent to creator recipients on secondary sales.
uint256 private constant CREATOR_ROYALTY_DENOMINATOR = BASIS_POINTS / 1000; // 10%
/// @notice The fee collected by Foundation for sales facilitated by this market contract.
uint256 private constant PROTOCOL_FEE_DENOMINATOR = BASIS_POINTS / 500; // 5%
/// @notice The fee collected by the buy referrer for sales facilitated by this market contract.
/// This fee is calculated from the total protocol fee.
/// @dev 20% of protocol fee == 1% of total sale.
uint256 private constant BUY_REFERRER_PROTOCOL_FEE_DENOMINATOR = 5;
IRoyaltyRegistry private immutable royaltyRegistry;
/// @notice The address of this contract's implementation.
/// @dev This is used when making stateless external calls to this contract,
/// saving gas over hopping through the proxy which is only necessary when accessing state.
MarketFees private immutable implementationAddress;
/// @notice True for the Drop market which only performs primary sales. False if primary & secondary are supported.
bool private immutable assumePrimarySale;
/**
* @notice Emitted when a NFT sold with a referrer.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param buyReferrer The account which received the buy referral incentive.
* @param buyReferrerFee The portion of the protocol fee collected by the buy referrer.
* @param buyReferrerSellerFee The portion of the owner revenue collected by the buy referrer (not implemented).
*/
event BuyReferralPaid(
address indexed nftContract,
uint256 indexed tokenId,
address buyReferrer,
uint256 buyReferrerFee,
uint256 buyReferrerSellerFee
);
/**
* @notice Configures the registry allowing for royalty overrides to be defined.
* @param _royaltyRegistry The registry to use for royalty overrides.
*/
constructor(address _royaltyRegistry, bool _assumePrimarySale) {
if (!_royaltyRegistry.supportsInterface(type(IRoyaltyRegistry).interfaceId)) {
revert NFTMarketFees_Address_Does_Not_Support_IRoyaltyRegistry();
}
royaltyRegistry = IRoyaltyRegistry(_royaltyRegistry);
assumePrimarySale = _assumePrimarySale;
// In the constructor, `this` refers to the implementation address. Everywhere else it'll be the proxy.
implementationAddress = this;
}
/**
* @notice Distributes funds to foundation, creator recipients, and NFT owner after a sale.
*/
function _distributeFunds(
address nftContract,
uint256 tokenId,
address payable seller,
uint256 price,
address payable buyReferrer
)
internal
returns (
uint256 totalFees,
uint256 creatorRev,
uint256 sellerRev
)
{
address payable[] memory creatorRecipients;
uint256[] memory creatorShares;
uint256 buyReferrerFee;
(totalFees, creatorRecipients, creatorShares, sellerRev, buyReferrerFee) = _getFees(
nftContract,
tokenId,
seller,
price,
buyReferrer
);
// Pay the creator(s)
unchecked {
for (uint256 i = 0; i < creatorRecipients.length; ++i) {
_sendValueWithFallbackWithdraw(
creatorRecipients[i],
creatorShares[i],
SEND_VALUE_GAS_LIMIT_MULTIPLE_RECIPIENTS
);
// Sum the total creator rev from shares
// creatorShares is in ETH so creatorRev will not overflow here.
creatorRev += creatorShares[i];
}
}
// Pay the seller
_sendValueWithFallbackWithdraw(seller, sellerRev, SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT);
// Pay the protocol fee
_sendValueWithFallbackWithdraw(getFoundationTreasury(), totalFees, SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT);
// Pay the buy referrer fee
if (buyReferrerFee != 0) {
_sendValueWithFallbackWithdraw(buyReferrer, buyReferrerFee, SEND_VALUE_GAS_LIMIT_SINGLE_RECIPIENT);
emit BuyReferralPaid(nftContract, tokenId, buyReferrer, buyReferrerFee, 0);
unchecked {
// Add the referrer fee back into the total fees so that all 3 return fields sum to the total price for events
totalFees += buyReferrerFee;
}
}
}
/**
* @notice Returns how funds will be distributed for a sale at the given price point.
* @param nftContract The address of the NFT contract.
* @param tokenId The id of the NFT.
* @param price The sale price to calculate the fees for.
* @return totalFees How much will be sent to the Foundation treasury and/or referrals.
* @return creatorRev How much will be sent across all the `creatorRecipients` defined.
* @return creatorRecipients The addresses of the recipients to receive a portion of the creator fee.
* @return creatorShares The percentage of the creator fee to be distributed to each `creatorRecipient`.
* If there is only one `creatorRecipient`, this may be an empty array.
* Otherwise `creatorShares.length` == `creatorRecipients.length`.
* @return sellerRev How much will be sent to the owner/seller of the NFT.
* If the NFT is being sold by the creator, this may be 0 and the full revenue will appear as `creatorRev`.
* @return seller The address of the owner of the NFT.
* If `sellerRev` is 0, this may be `address(0)`.
*/
function getFeesAndRecipients(
address nftContract,
uint256 tokenId,
uint256 price
)
external
view
returns (
uint256 totalFees,
uint256 creatorRev,
address payable[] memory creatorRecipients,
uint256[] memory creatorShares,
uint256 sellerRev,
address payable seller
)
{
seller = _getSellerOrOwnerOf(nftContract, tokenId);
(totalFees, creatorRecipients, creatorShares, sellerRev, ) = _getFees(
nftContract,
tokenId,
seller,
price,
// TODO add referral info
payable(0)
);
// Sum the total creator rev from shares
for (uint256 i = 0; i < creatorShares.length; ++i) {
creatorRev += creatorShares[i];
}
}
/**
* @notice Returns the address of the registry allowing for royalty configuration overrides.
* @dev See https://royaltyregistry.xyz/
* @return registry The address of the royalty registry contract.
*/
function getRoyaltyRegistry() external view returns (address registry) {
return address(royaltyRegistry);
}
/**
* @notice **For internal use only.**
* @dev This function is external to allow using try/catch but is not intended for external use.
* This checks the token creator.
*/
function internalGetTokenCreator(address nftContract, uint256 tokenId)
external
view
returns (address payable creator)
{
creator = ITokenCreator(nftContract).tokenCreator{ gas: READ_ONLY_GAS_LIMIT }(tokenId);
}
/**
* @notice **For internal use only.**
* @dev This function is external to allow using try/catch but is not intended for external use.
* If ERC2981 royalties (or getRoyalties) are defined by the NFT contract, allow this standard to define immutable
* royalties that cannot be later changed via the royalty registry.
*/
function internalGetImmutableRoyalties(address nftContract, uint256 tokenId)
external
view
returns (address payable[] memory recipients, uint256[] memory splitPerRecipientInBasisPoints)
{
// 1st priority: ERC-2981
if (nftContract.supportsERC165InterfaceUnchecked(type(IRoyaltyInfo).interfaceId)) {
try IRoyaltyInfo(nftContract).royaltyInfo{ gas: READ_ONLY_GAS_LIMIT }(tokenId, BASIS_POINTS) returns (
address receiver,
uint256 royaltyAmount
) {
// Manifold contracts return (address(this), 0) when royalties are not defined
// - so ignore results when the amount is 0
if (royaltyAmount > 0) {
recipients = new address payable[](1);
recipients[0] = payable(receiver);
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
// 2nd priority: getRoyalties
if (nftContract.supportsERC165InterfaceUnchecked(type(IGetRoyalties).interfaceId)) {
try IGetRoyalties(nftContract).getRoyalties{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
address payable[] memory _recipients,
uint256[] memory recipientBasisPoints
) {
if (_recipients.length != 0 && _recipients.length == recipientBasisPoints.length) {
return (_recipients, recipientBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
}
/**
* @notice **For internal use only.**
* @dev This function is external to allow using try/catch but is not intended for external use.
* This checks for royalties defined in the royalty registry or via a non-standard royalty API.
*/
// solhint-disable-next-line code-complexity
function internalGetMutableRoyalties(
address nftContract,
uint256 tokenId,
address payable creator
) external view returns (address payable[] memory recipients, uint256[] memory splitPerRecipientInBasisPoints) {
/* Overrides must support ERC-165 when registered, except for overrides defined by the registry owner.
If that results in an override w/o 165 we may need to upgrade the market to support or ignore that override. */
// The registry requires overrides are not 0 and contracts when set.
// If no override is set, the nftContract address is returned.
try royaltyRegistry.getRoyaltyLookupAddress{ gas: READ_ONLY_GAS_LIMIT }(nftContract) returns (
address overrideContract
) {
if (overrideContract != nftContract) {
nftContract = overrideContract;
// The functions above are repeated here if an override is set.
// 3rd priority: ERC-2981 override
if (nftContract.supportsERC165InterfaceUnchecked(type(IRoyaltyInfo).interfaceId)) {
try IRoyaltyInfo(nftContract).royaltyInfo{ gas: READ_ONLY_GAS_LIMIT }(tokenId, BASIS_POINTS) returns (
address receiver,
uint256 /* royaltyAmount */
) {
recipients = new address payable[](1);
recipients[0] = payable(receiver);
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
// 4th priority: getRoyalties override
if (recipients.length == 0 && nftContract.supportsERC165InterfaceUnchecked(type(IGetRoyalties).interfaceId)) {
try IGetRoyalties(nftContract).getRoyalties{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
address payable[] memory _recipients,
uint256[] memory recipientBasisPoints
) {
if (_recipients.length != 0 && _recipients.length == recipientBasisPoints.length) {
return (_recipients, recipientBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Ignore out of gas errors and continue using the nftContract address
}
// 5th priority: getFee* from contract or override
if (nftContract.supportsERC165InterfaceUnchecked(type(IGetFees).interfaceId)) {
try IGetFees(nftContract).getFeeRecipients{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
address payable[] memory _recipients
) {
if (_recipients.length != 0) {
try IGetFees(nftContract).getFeeBps{ gas: READ_ONLY_GAS_LIMIT }(tokenId) returns (
uint256[] memory recipientBasisPoints
) {
if (_recipients.length == recipientBasisPoints.length) {
return (_recipients, recipientBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
// 6th priority: tokenCreator w/ or w/o requiring 165 from contract or override
if (creator != address(0)) {
// Only pay the tokenCreator if there wasn't another royalty defined
recipients = new address payable[](1);
recipients[0] = creator;
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
// 7th priority: owner from contract or override
try IOwnable(nftContract).owner{ gas: READ_ONLY_GAS_LIMIT }() returns (address owner) {
if (owner != address(0)) {
// Only pay the owner if there wasn't another royalty defined
recipients = new address payable[](1);
recipients[0] = payable(owner);
splitPerRecipientInBasisPoints = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
return (recipients, splitPerRecipientInBasisPoints);
}
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
// If no valid payment address or creator is found, return 0 recipients
}
/**
* @notice Calculates how funds should be distributed for the given sale details.
* @dev When the NFT is being sold by the `tokenCreator`, all the seller revenue will
* be split with the royalty recipients defined for that NFT.
*/
// solhint-disable-next-line code-complexity
function _getFees(
address nftContract,
uint256 tokenId,
address payable seller,
uint256 price,
address payable buyReferrer
)
private
view
returns (
uint256 totalFees,
address payable[] memory creatorRecipients,
uint256[] memory creatorShares,
uint256 sellerRev,
uint256 buyReferrerFee
)
{
// Calculate the protocol fee
unchecked {
// SafeMath is not required when dividing by a non-zero constant.
totalFees = price / PROTOCOL_FEE_DENOMINATOR;
}
address payable creator;
try implementationAddress.internalGetTokenCreator(nftContract, tokenId) returns (address payable _creator) {
creator = _creator;
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
try implementationAddress.internalGetImmutableRoyalties(nftContract, tokenId) returns (
address payable[] memory _recipients,
uint256[] memory _splitPerRecipientInBasisPoints
) {
(creatorRecipients, creatorShares) = (_recipients, _splitPerRecipientInBasisPoints);
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
if (creatorRecipients.length == 0) {
// Check mutable royalties only if we didn't find results from the immutable API
try implementationAddress.internalGetMutableRoyalties(nftContract, tokenId, creator) returns (
address payable[] memory _recipients,
uint256[] memory _splitPerRecipientInBasisPoints
) {
(creatorRecipients, creatorShares) = (_recipients, _splitPerRecipientInBasisPoints);
} catch // solhint-disable-next-line no-empty-blocks
{
// Fall through
}
}
if (creatorRecipients.length != 0 || assumePrimarySale) {
uint256 creatorRev;
if (assumePrimarySale) {
// All revenue should go to the creator recipients
unchecked {
// totalFees is always < price.
creatorRev = price - totalFees;
}
if (creatorRecipients.length == 0) {
// If no creators were found via the royalty APIs, then set that recipient to the seller's address
creatorRecipients = new address payable[](1);
creatorRecipients[0] = seller;
creatorShares = new uint256[](1);
// The split amount is assumed to be 100% when only 1 recipient is returned
}
} else if (seller == creator || (creatorRecipients.length == 1 && seller == creatorRecipients[0])) {
// When sold by the creator, all revenue is split if applicable.
// If the seller is unknown, assume it's being sold by the creator.
unchecked {
// totalFees is always < price.
creatorRev = price - totalFees;
}
} else {
// Rounding favors the owner first, then creator, and foundation last.
unchecked {
// SafeMath is not required when dividing by a non-zero constant.
creatorRev = price / CREATOR_ROYALTY_DENOMINATOR;
}
sellerRev = price - totalFees - creatorRev;
}
// Cap the max number of recipients supported
creatorRecipients.capLength(MAX_ROYALTY_RECIPIENTS);
creatorShares.capLength(MAX_ROYALTY_RECIPIENTS);
// Sum the total shares defined
uint256 totalShares;
if (creatorRecipients.length > 1) {
unchecked {
for (uint256 i = 0; i < creatorRecipients.length; ++i) {
if (creatorShares[i] > BASIS_POINTS) {
// If the numbers are >100% we ignore the fee recipients and pay just the first instead
totalShares = 0;
break;
}
totalShares += creatorShares[i];
}
}
if (totalShares == 0) {
// If no shares were defined or shares were out of bounds, pay only the first recipient
creatorRecipients.capLength(1);
creatorShares.capLength(1);
}
}
// Send payouts to each additional recipient if more than 1 was defined
uint256 totalRoyaltiesDistributed;
for (uint256 i = 1; i < creatorRecipients.length; ) {
uint256 royalty = (creatorRev * creatorShares[i]) / totalShares;
totalRoyaltiesDistributed += royalty;
creatorShares[i] = royalty;
unchecked {
++i;
}
}
// Send the remainder to the 1st creator, rounding in their favor
creatorShares[0] = creatorRev - totalRoyaltiesDistributed;
} else {
// No royalty recipients found.
unchecked {
// totalFees is always < price.
sellerRev = price - totalFees;
}
}
if (buyReferrer != address(0) && buyReferrer != msg.sender && buyReferrer != seller && buyReferrer != creator) {
unchecked {
buyReferrerFee = totalFees / BUY_REFERRER_PROTOCOL_FEE_DENOMINATOR;
// buyReferrerFee is always <= totalFees
totalFees -= buyReferrerFee;
}
}
}
/**
* @notice This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[1000] private __gap;
}