// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @author: manifold.xyz + @quentinmerabet
////////////////////////////////////////////////////////////////////////////////////////
// //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ██████████████▌ ╟██ ████████████████ j██████████████ //
// ██████████████▌ ╟███ ███████████████ j██████████████ //
// ██████████████▌ ╟███▌ ██████████████ j██████████████ //
// ██████████████▌ ╟████▌ █████████████ j██████████████ //
// ██████████████▌ ╟█████▌ ╙████████████ j██████████████ //
// ██████████████▌ ╟██████▄ ╙███████████ j██████████████ //
// ██████████████▌ ╟███████ ╙██████████ j██████████████ //
// ██████████████▌ ╟████████ ╟█████████ j██████████████ //
// ██████████████▌ ╟█████████ █████████ j██████████████ //
// ██████████████▌ ╟██████████ ████████ j██████████████ //
// ██████████████▌ ╟██████████▌ ███████ j██████████████ //
// ██████████████▌ ╟███████████▌ ██████ j██████████████ //
// ██████████████▌ ╟████████████▄ ╙█████ ,████████████████ //
// ██████████████▌ ╟█████████████ ╙████ ▄██████████████████ //
// ██████████████▌ ╟██████████████ ╙███ ▄████████████████████ //
// ██████████████▌ ╟███████████████ ╟██ ,███████████████████████ //
// ██████████████▌ ,████ ███████████████████████████ //
// ██████████████▌ ▄██████▌ ██████████████████████████ //
// ██████████████▌ ▄█████████▌ █████████████████████████ //
// ██████████████▌ ,█████████████▄ ████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// //
////////////////////////////////////////////////////////////////////////////////////////
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "../resources/IResources.sol";
import "./IDeed.sol";
contract Deed is ERC721, IDeed, IERC1155Receiver, Ownable, ReentrancyGuard {
using Strings for uint256;
using EnumerableSet for EnumerableSet.UintSet;
uint256 private constant MAX_UINT64 = 0xFFFFFFFFFFFFFFFF;
// Resources contract address
address public immutable RESOURCES_ADDRESS;
// Token id counter
uint256 private _currentTokenId;
// Mint trigger
bool private _mintEnabled;
// Metadata
string private _metadataDescription = "Loading...";
string private _metadataImageBaseURI = "https://deed.lvcidia.xyz/viewer/";
// Resource id to contribution state
mapping(uint256 => ContributionState) private _contribution;
// User to resource id to contribution count
mapping(address => mapping(uint256 => uint256))
private _userContributionCount;
// Deed token id to resource id to contribution count
mapping(uint256 => mapping(uint256 => uint256))
private _deedContributionCount;
// Set of resource id's
EnumerableSet.UintSet private _resources;
// Royalty configuration
uint256 private _royaltyBps;
address payable private _royaltyRecipient;
bytes4 private constant _INTERFACE_ID_ROYALTIES_CREATORCORE = 0xbb3bafd6;
bytes4 private constant _INTERFACE_ID_ROYALTIES_EIP2981 = 0x2a55205a;
bytes4 private constant _INTERFACE_ID_ROYALTIES_RARIBLE = 0xb7799584;
constructor(address resourcesAddress) ERC721("LVCIDIA// DEED", "DEED") {
RESOURCES_ADDRESS = resourcesAddress;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(
bytes4 interfaceId
) public view virtual override(ERC721, IERC165) returns (bool) {
return
ERC721.supportsInterface(interfaceId) ||
interfaceId == _INTERFACE_ID_ROYALTIES_CREATORCORE ||
interfaceId == _INTERFACE_ID_ROYALTIES_EIP2981 ||
interfaceId == _INTERFACE_ID_ROYALTIES_RARIBLE;
}
/**
* @dev See {IDeed-updateContribution}.
*/
function updateContribution(
uint256[] calldata resourceIds,
Contribution[] calldata resourceContributions
) external override onlyOwner {
require(
resourceIds.length == resourceContributions.length,
"Invalid input"
);
for (uint i = 0; i < resourceIds.length; ) {
Contribution memory contribution = resourceContributions[i];
_contribution[resourceIds[i]] = ContributionState({
name: contribution.name,
perUnit: contribution.perUnit,
maxUnits: contribution.maxUnits,
totalUnits: _contribution[resourceIds[i]].totalUnits
});
if (contribution.maxUnits == 0) {
_resources.remove(resourceIds[i]);
} else {
_resources.add(resourceIds[i]);
}
unchecked {
i++;
}
}
}
/**
* @dev See {IDeed-getContributionState}
*/
function getContributionState(
uint256 resourceId
) external view override returns (ContributionState memory) {
return _contribution[resourceId];
}
/**
* @dev See {IDeed-getUserContributions}
*/
function getUserContributions(
address user
)
public
view
override
returns (
ContributionInfo[] memory contributions,
uint256 totalContributions
)
{
contributions = new ContributionInfo[](_resources.length());
for (uint i; i < _resources.length(); ) {
uint256 resourceId = _resources.at(i);
ContributionState memory contribution = _contribution[resourceId];
uint256 units = _userContributionCount[user][resourceId];
contributions[i] = ContributionInfo({
resourceId: resourceId,
resourceName: contribution.name,
units: units,
perUnit: contribution.perUnit
});
totalContributions += units;
unchecked {
++i;
}
}
}
/**
* @dev See {IDeed-getDeedContributions}
*/
function getDeedContributions(
uint256 tokenId
)
public
view
override
returns (
ContributionInfo[] memory contributions,
uint256 totalContributions
)
{
contributions = new ContributionInfo[](_resources.length());
for (uint i; i < _resources.length(); ) {
uint256 resourceId = _resources.at(i);
contributions[i] = ContributionInfo({
resourceId: resourceId,
resourceName: _contribution[resourceId].name,
units: _deedContributionCount[tokenId][resourceId],
perUnit: _contribution[resourceId].perUnit
});
totalContributions += _deedContributionCount[tokenId][resourceId];
unchecked {
++i;
}
}
}
/**
* @dev See {IDeed-setMintEnabled}.
*/
function setMintEnabled(bool enabled) external override onlyOwner {
require(enabled != _mintEnabled, "should be a different value");
_mintEnabled = enabled;
}
/**
* @dev See {IDeed-mint}.
*/
function mint() external override {
if (!_mintEnabled) revert("Mint not open yet");
uint256 tokenId = ++_currentTokenId;
bool hasContributed = false;
for (uint i = 0; i < _resources.length(); ) {
uint256 resourceId = _resources.at(i);
uint256 userContribution = _userContributionCount[msg.sender][
resourceId
];
_deedContributionCount[tokenId][resourceId] = userContribution;
_userContributionCount[msg.sender][resourceId] = 0;
if (
_deedContributionCount[tokenId][resourceId] > 0 &&
!hasContributed
) {
hasContributed = true;
}
unchecked {
i++;
}
}
require(hasContributed, "No contributions yet");
_mint(msg.sender, tokenId);
}
/**
* @dev See {IDeed-merge}.
*/
function merge(uint256[] calldata tokenIds) external override nonReentrant {
uint256 newToken = ++_currentTokenId;
uint256 resourcesLength = _resources.length();
uint256 tokensLength = tokenIds.length;
require(
tokenIds.length > 1,
"At least two tokens are required for merging"
);
for (uint i = 0; i < tokensLength; ) {
uint256 tokenId = tokenIds[i];
require(_exists(tokenId), "Nonexistent or duplicated token");
require(ownerOf(tokenId) == msg.sender, "Not owner");
for (uint j = 0; j < resourcesLength; ) {
uint256 resourceId = _resources.at(j);
uint256 contribution = _deedContributionCount[tokenId][
resourceId
];
if (contribution > 0) {
delete _deedContributionCount[tokenId][resourceId];
}
_deedContributionCount[newToken][resourceId] += contribution;
unchecked {
j++;
}
}
_burn(tokenId);
unchecked {
i++;
}
}
_mint(msg.sender, newToken);
}
/**
* @dev See {IDeed-split}.
*/
function split(
uint256 tokenA,
uint256[] calldata tokenBUnits
) external override nonReentrant {
require(_exists(tokenA), "Nonexistent token");
require(ownerOf(tokenA) == msg.sender, "Not owner");
uint256 resourcesLength = _resources.length();
require(
tokenBUnits.length == resourcesLength,
"Invalid ressources info"
);
uint256 tokenB = ++_currentTokenId;
uint256 tokenC = ++_currentTokenId;
bool hasContributionsB;
bool hasContributionsC;
for (uint i = 0; i < resourcesLength; ) {
uint256 resourceId = _resources.at(i);
uint256 contributionA = _deedContributionCount[tokenA][resourceId];
uint256 contributionB = tokenBUnits[i];
require(
contributionA >= contributionB,
"Not enough resources to split"
);
uint256 contributionC = contributionA - tokenBUnits[i];
if (contributionA > 0) {
delete _deedContributionCount[tokenA][resourceId];
}
_deedContributionCount[tokenB][resourceId] = contributionB;
_deedContributionCount[tokenC][resourceId] = contributionC;
if (contributionB > 0) hasContributionsB = true;
if (contributionC > 0) hasContributionsC = true;
unchecked {
i++;
}
}
require(
hasContributionsB && hasContributionsC,
"A new deed must have contributions"
);
_burn(tokenA);
_mint(msg.sender, tokenB);
_mint(msg.sender, tokenC);
}
function onERC1155Received(
address,
address from,
uint256 id,
uint256 value,
bytes calldata
) external override returns (bytes4) {
require(!_mintEnabled, "Cannot contribute anymore");
ContributionState storage contribution = _contribution[id];
require(
msg.sender == RESOURCES_ADDRESS && contribution.maxUnits > 0,
"Invalid resource"
);
uint256 unitsAvailable = contribution.maxUnits -
contribution.totalUnits;
require(unitsAvailable > 0, "Contribution limit reached");
require(value % contribution.perUnit == 0, "Invalid amount");
uint256 unitsRequested = value / contribution.perUnit;
uint256 units;
if (unitsRequested > unitsAvailable) {
units = unitsAvailable;
} else {
units = unitsRequested;
}
require(units > 0 && units <= MAX_UINT64, "Invalid units");
_userContributionCount[from][id] += units;
emit Contribute(id, from, uint64(units));
contribution.totalUnits += uint64(units);
uint256[] memory resourceIds = new uint256[](1);
resourceIds[0] = id;
uint256[] memory amounts = new uint256[](1);
amounts[0] = units * contribution.perUnit;
IResources(RESOURCES_ADDRESS).burn(address(this), resourceIds, amounts);
if (units != unitsRequested) {
IResources(RESOURCES_ADDRESS).safeTransferFrom(
address(this),
from,
id,
(unitsRequested - units) * contribution.perUnit,
""
);
}
return this.onERC1155Received.selector;
}
function onERC1155BatchReceived(
address,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata
) external override returns (bytes4) {
require(!_mintEnabled, "Cannot contribute anymore");
uint256 resourceLength = ids.length;
require(
msg.sender == RESOURCES_ADDRESS && resourceLength == values.length,
"Invalid resource"
);
bool hasContribution = false;
bool hasExcess = false;
uint256[] memory refundAmounts = new uint256[](resourceLength);
uint256[] memory burnAmounts = new uint256[](resourceLength);
for (uint i = 0; i < resourceLength; i++) {
ContributionState storage contribution = _contribution[ids[i]];
uint256 unitsAvailable = contribution.maxUnits -
contribution.totalUnits;
if (unitsAvailable == 0 || values[i] % contribution.perUnit != 0) {
hasExcess = true;
refundAmounts[i] = values[i];
continue;
}
uint256 unitsRequested = values[i] / contribution.perUnit;
uint256 units;
if (unitsRequested > unitsAvailable) {
units = unitsAvailable;
} else {
units = unitsRequested;
}
require(units <= MAX_UINT64, "Invalid amount");
_userContributionCount[from][ids[i]] += units;
emit Contribute(ids[i], from, uint64(units));
contribution.totalUnits += uint64(units);
burnAmounts[i] = units * contribution.perUnit;
hasContribution = true;
if (units != unitsRequested) {
hasExcess = true;
refundAmounts[i] =
(unitsRequested - units) *
contribution.perUnit;
}
}
IResources(RESOURCES_ADDRESS).burn(address(this), ids, burnAmounts);
if (hasExcess) {
IResources(RESOURCES_ADDRESS).safeBatchTransferFrom(
address(this),
from,
ids,
refundAmounts,
""
);
}
return this.onERC1155BatchReceived.selector;
}
/**
* @dev See {IDeed-setMetadata}.
*/
function setMetadata(
string calldata description,
string calldata imageBaseURI
) external override onlyOwner {
if (bytes(description).length > 0) _metadataDescription = description;
if (bytes(imageBaseURI).length > 0)
_metadataImageBaseURI = imageBaseURI;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
require(
_exists(tokenId),
"ERC721Metadata: URI query for nonexistent token"
);
(
ContributionInfo[] memory contributions,
uint256 totalContributions
) = getDeedContributions(tokenId);
string memory traits;
// Ownership
traits = string(
abi.encodePacked(
traits,
'{"trait_type":"Planet Ownership","value":"',
_unitToPercentage(totalContributions),
'%"},'
)
);
// Material
traits = string(
abi.encodePacked(
traits,
'{"trait_type":"Background Material","value":"',
_getDeedMaterial(totalContributions, false),
'"}'
)
);
// Ressources yes/no
for (uint i = 0; i < _resources.length(); ) {
string memory activated;
contributions[i].units > 0 ? activated = "YES" : activated = "NO";
traits = string(
abi.encodePacked(
traits,
',{"trait_type":"',
contributions[i].resourceName,
'","value":"',
activated,
'"}'
)
);
unchecked {
i++;
}
}
// Ressources levels
for (uint i = 0; i < _resources.length(); ) {
traits = string(
abi.encodePacked(
traits,
',{"trait_type":"',
contributions[i].resourceName,
'","value":',
(contributions[i].units * contributions[i].perUnit)
.toString(),
"}"
)
);
unchecked {
i++;
}
}
return
string(
abi.encodePacked(
"data:application/json;utf8,",
'{"name":"',
_getDeedMaterial(totalContributions, true),
" DEED// #",
tokenId.toString(),
'","created_by":"LVCIDIA","description":"',
_metadataDescription,
'","image":"',
_metadataImageBaseURI,
tokenId.toString(),
'.png","attributes":[',
traits,
"]}"
)
);
}
/**
* @dev Helper to convert deed unit to a string percentage
*/
function _unitToPercentage(
uint256 unit
) private pure returns (string memory) {
string memory result = Strings.toString(unit / 1000);
string memory decimal = Strings.toString(unit % 1000);
while (bytes(decimal).length < 3) {
decimal = string(abi.encodePacked("0", decimal));
}
result = string(abi.encodePacked(result, ".", decimal));
return result;
}
/**
* @dev Returns the material of the deed based on the total contributions
*/
function _getDeedMaterial(
uint256 totalContributions,
bool caps
) private pure returns (string memory) {
if (totalContributions < 10) {
if (caps) {
return "BLACK";
} else {
return "Black";
}
} else if (totalContributions < 50) {
if (caps) {
return "MARBLE";
} else {
return "Marble";
}
} else if (totalContributions < 200) {
if (caps) {
return "CHROME";
} else {
return "Chrome";
}
} else if (totalContributions < 1000) {
if (caps) {
return "JADE";
} else {
return "Jade";
}
} else {
if (caps) {
return "GOLD";
} else {
return "Gold";
}
}
}
/**
* @dev Update royalties
*/
function updateRoyalties(
address payable recipient,
uint256 bps
) external onlyOwner {
_royaltyRecipient = recipient;
_royaltyBps = bps;
}
/**
* ROYALTY FUNCTIONS
*/
function getRoyalties(
uint256
)
external
view
returns (address payable[] memory recipients, uint256[] memory bps)
{
if (_royaltyRecipient != address(0x0)) {
recipients = new address payable[](1);
recipients[0] = _royaltyRecipient;
bps = new uint256[](1);
bps[0] = _royaltyBps;
}
return (recipients, bps);
}
function getFeeRecipients(
uint256
) external view returns (address payable[] memory recipients) {
if (_royaltyRecipient != address(0x0)) {
recipients = new address payable[](1);
recipients[0] = _royaltyRecipient;
}
return recipients;
}
function getFeeBps(uint256) external view returns (uint[] memory bps) {
if (_royaltyRecipient != address(0x0)) {
bps = new uint256[](1);
bps[0] = _royaltyBps;
}
return bps;
}
function royaltyInfo(
uint256,
uint256 value
) external view returns (address, uint256) {
return (_royaltyRecipient, (value * _royaltyBps) / 10000);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/structs/EnumerableSet.sol)
// This file was procedurally generated from scripts/generate/templates/EnumerableSet.js.
pragma solidity ^0.8.0;
/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
*
* ```
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*
* [WARNING]
* ====
* Trying to delete such a structure from storage will likely result in data corruption, rendering the structure
* unusable.
* See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
*
* In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an
* array of EnumerableSet.
* ====
*/
library EnumerableSet {
// To implement this library for multiple types with as little code
// repetition as possible, we write it in terms of a generic Set type with
// bytes32 values.
// The Set implementation uses private functions, and user-facing
// implementations (such as AddressSet) are just wrappers around the
// underlying Set.
// This means that we can only create new EnumerableSets for types that fit
// in bytes32.
struct Set {
// Storage of set values
bytes32[] _values;
// Position of the value in the `values` array, plus 1 because index 0
// means a value is not in the set.
mapping(bytes32 => uint256) _indexes;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function _add(Set storage set, bytes32 value) private returns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes
// and use 0 as a sentinel value
set._indexes[value] = set._values.length;
return true;
} else {
return false;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function _remove(Set storage set, bytes32 value) private returns (bool) {
// We read and store the value's index to prevent multiple reads from the same storage slot
uint256 valueIndex = set._indexes[value];
if (valueIndex != 0) {
// Equivalent to contains(set, value)
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in
// the array, and then remove the last element (sometimes called as 'swap and pop').
// This modifies the order of the array, as noted in {at}.
uint256 toDeleteIndex = valueIndex - 1;
uint256 lastIndex = set._values.length - 1;
if (lastIndex != toDeleteIndex) {
bytes32 lastValue = set._values[lastIndex];
// Move the last value to the index where the value to delete is
set._values[toDeleteIndex] = lastValue;
// Update the index for the moved value
set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
}
// Delete the slot where the moved value was stored
set._values.pop();
// Delete the index for the deleted slot
delete set._indexes[value];
return true;
} else {
return false;
}
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function _contains(Set storage set, bytes32 value) private view returns (bool) {
return set._indexes[value] != 0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function _length(Set storage set) private view returns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function _at(Set storage set, uint256 index) private view returns (bytes32) {
return set._values[index];
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function _values(Set storage set) private view returns (bytes32[] memory) {
return set._values;
}
// Bytes32Set
struct Bytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(Bytes32Set storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
return _at(set._inner, index);
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
bytes32[] memory store = _values(set._inner);
bytes32[] memory result;
/// @solidity memory-safe-assembly
assembly {
result := store
}
return result;
}
// AddressSet
struct AddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(AddressSet storage set, address value) internal returns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(AddressSet storage set, address value) internal returns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(AddressSet storage set, address value) internal view returns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(AddressSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(AddressSet storage set, uint256 index) internal view returns (address) {
return address(uint160(uint256(_at(set._inner, index))));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(AddressSet storage set) internal view returns (address[] memory) {
bytes32[] memory store = _values(set._inner);
address[] memory result;
/// @solidity memory-safe-assembly
assembly {
result := store
}
return result;
}
// UintSet
struct UintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(UintSet storage set, uint256 value) internal returns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(UintSet storage set, uint256 value) internal returns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(UintSet storage set, uint256 value) internal view returns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(UintSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(UintSet storage set, uint256 index) internal view returns (uint256) {
return uint256(_at(set._inner, index));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(UintSet storage set) internal view returns (uint256[] memory) {
bytes32[] memory store = _values(set._inner);
uint256[] memory result;
/// @solidity memory-safe-assembly
assembly {
result := store
}
return result;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @author: manifold.xyz + @quentinmerabet
////////////////////////////////////////////////////////////////////////////////////////
// //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ██████████████▌ ╟██ ████████████████ j██████████████ //
// ██████████████▌ ╟███ ███████████████ j██████████████ //
// ██████████████▌ ╟███▌ ██████████████ j██████████████ //
// ██████████████▌ ╟████▌ █████████████ j██████████████ //
// ██████████████▌ ╟█████▌ ╙████████████ j██████████████ //
// ██████████████▌ ╟██████▄ ╙███████████ j██████████████ //
// ██████████████▌ ╟███████ ╙██████████ j██████████████ //
// ██████████████▌ ╟████████ ╟█████████ j██████████████ //
// ██████████████▌ ╟█████████ █████████ j██████████████ //
// ██████████████▌ ╟██████████ ████████ j██████████████ //
// ██████████████▌ ╟██████████▌ ███████ j██████████████ //
// ██████████████▌ ╟███████████▌ ██████ j██████████████ //
// ██████████████▌ ╟████████████▄ ╙█████ ,████████████████ //
// ██████████████▌ ╟█████████████ ╙████ ▄██████████████████ //
// ██████████████▌ ╟██████████████ ╙███ ▄████████████████████ //
// ██████████████▌ ╟███████████████ ╟██ ,███████████████████████ //
// ██████████████▌ ,████ ███████████████████████████ //
// ██████████████▌ ▄██████▌ ██████████████████████████ //
// ██████████████▌ ▄█████████▌ █████████████████████████ //
// ██████████████▌ ,█████████████▄ ████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// //
////////////////////////////////////////////////////////////////////////////////////////
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
interface IDeed is IERC165 {
event Contribute(
uint256 indexed resourceId,
address indexed contributor,
uint64 units
);
struct Contribution {
string name;
uint64 perUnit;
uint64 maxUnits;
}
struct ContributionState {
string name;
uint64 perUnit;
uint64 maxUnits;
uint64 totalUnits;
}
struct UserContribution {
uint256 resourceId;
uint256 units;
}
struct DeedContribution {
uint256 resourceId;
uint256 units;
}
struct ContributionInfo {
uint256 resourceId;
string resourceName;
uint256 units;
uint64 perUnit;
}
/**
* Update/set contribution configuration
*/
function updateContribution(
uint256[] calldata resourceIds,
Contribution[] calldata resourceContributions
) external;
/**
* Getter for contribution state of a resource
*/
function getContributionState(
uint256 resourceId
) external returns (ContributionState memory);
/**
* Get a user's contributions
*/
function getUserContributions(
address user
)
external
returns (
ContributionInfo[] memory contributions,
uint256 totalContributions
);
/**
* Get a deed's contributions
*/
function getDeedContributions(
uint256 tokenId
)
external
returns (
ContributionInfo[] memory contributions,
uint256 totalContributions
);
/**
* Open/Close the minting phase
*/
function setMintEnabled(bool enabled) external;
/**
* Mint a deed
*/
function mint() external;
/**
* Split a deed (A) into two new deeds (B and C)
*/
function split(uint256 tokenA, uint256[] calldata tokenBUnits) external;
/**
* Merge a list of deeds.
*/
function merge(uint256[] calldata tokenIds) external;
/**
* Set metadata
*/
function setMetadata(
string calldata description,
string calldata imageBaseURI
) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/IERC1155.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC1155 compliant contract, as defined in the
* https://eips.ethereum.org/EIPS/eip-1155[EIP].
*
* _Available since v3.1._
*/
interface IERC1155 is IERC165 {
/**
* @dev Emitted when `value` tokens of token type `id` are transferred from `from` to `to` by `operator`.
*/
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
/**
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
* transfers.
*/
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
/**
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
* `approved`.
*/
event ApprovalForAll(address indexed account, address indexed operator, bool approved);
/**
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
*
* If an {URI} event was emitted for `id`, the standard
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
* returned by {IERC1155MetadataURI-uri}.
*/
event URI(string value, uint256 indexed id);
/**
* @dev Returns the amount of tokens of token type `id` owned by `account`.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function balanceOf(address account, uint256 id) external view returns (uint256);
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(address[] calldata accounts, uint256[] calldata ids)
external
view
returns (uint256[] memory);
/**
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the caller.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
*
* See {setApprovalForAll}.
*/
function isApprovedForAll(address account, address operator) external view returns (bool);
/**
* @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
* - `from` must have a balance of tokens of type `id` of at least `amount`.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function safeTransferFrom(
address from,
address to,
uint256 id,
uint256 amount,
bytes calldata data
) external;
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - `ids` and `amounts` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata amounts,
bytes calldata data
) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC1155/IERC1155Receiver.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev _Available since v3.1._
*/
interface IERC1155Receiver is IERC165 {
/**
* @dev Handles the receipt of a single ERC1155 token type. This function is
* called at the end of a `safeTransferFrom` after the balance has been updated.
*
* NOTE: To accept the transfer, this must return
* `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
* (i.e. 0xf23a6e61, or its own function selector).
*
* @param operator The address which initiated the transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param id The ID of the token being transferred
* @param value The amount of tokens being transferred
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
*/
function onERC1155Received(
address operator,
address from,
uint256 id,
uint256 value,
bytes calldata data
) external returns (bytes4);
/**
* @dev Handles the receipt of a multiple ERC1155 token types. This function
* is called at the end of a `safeBatchTransferFrom` after the balances have
* been updated.
*
* NOTE: To accept the transfer(s), this must return
* `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
* (i.e. 0xbc197c81, or its own function selector).
*
* @param operator The address which initiated the batch transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param ids An array containing ids of each token being transferred (order and length must match values array)
* @param values An array containing amounts of each token being transferred (order and length must match ids array)
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
*/
function onERC1155BatchReceived(
address operator,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external returns (bytes4);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC721/IERC721Receiver.sol)
pragma solidity ^0.8.0;
/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/
interface IERC721Receiver {
/**
* @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
* by `operator` from `from`, this function is called.
*
* It must return its Solidity selector to confirm the token transfer.
* If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted.
*
* The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @author: manifold.xyz
////////////////////////////////////////////////////////////////////////////////////////
// //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ██████████████▌ ╟██ ████████████████ j██████████████ //
// ██████████████▌ ╟███ ███████████████ j██████████████ //
// ██████████████▌ ╟███▌ ██████████████ j██████████████ //
// ██████████████▌ ╟████▌ █████████████ j██████████████ //
// ██████████████▌ ╟█████▌ ╙████████████ j██████████████ //
// ██████████████▌ ╟██████▄ ╙███████████ j██████████████ //
// ██████████████▌ ╟███████ ╙██████████ j██████████████ //
// ██████████████▌ ╟████████ ╟█████████ j██████████████ //
// ██████████████▌ ╟█████████ █████████ j██████████████ //
// ██████████████▌ ╟██████████ ████████ j██████████████ //
// ██████████████▌ ╟██████████▌ ███████ j██████████████ //
// ██████████████▌ ╟███████████▌ ██████ j██████████████ //
// ██████████████▌ ╟████████████▄ ╙█████ ,████████████████ //
// ██████████████▌ ╟█████████████ ╙████ ▄██████████████████ //
// ██████████████▌ ╟██████████████ ╙███ ▄████████████████████ //
// ██████████████▌ ╟███████████████ ╟██ ,███████████████████████ //
// ██████████████▌ ,████ ███████████████████████████ //
// ██████████████▌ ▄██████▌ ██████████████████████████ //
// ██████████████▌ ▄█████████▌ █████████████████████████ //
// ██████████████▌ ,█████████████▄ ████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// ████████████████████████████████████████████████████████████████████████████████ //
// //
////////////////////////////////////////////////////////////////////////////////////////
import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
interface IResources is IERC1155 {
/**
* @dev Mint tokens
*/
function mint(address to, uint256[] memory tokenIds, uint256[] memory amounts) external;
/**
* @dev Set the tokenURI of a token.
*/
function setTokenURI(uint256 tokenId, string calldata uri_) external;
/**
* @dev set the tokenURI of multiple tokens.
*/
function setTokenURIs(uint256[] memory tokenIds, string[] calldata uris) external;
/**
* @dev burn tokens. Can only be called by token owner or approved address.
* On burn, calls back to the registered extension's onBurn method
*/
function burn(address account, uint256[] calldata tokenIds, uint256[] calldata amounts) external;
/**
* @dev Total amount of tokens of resource with a given id.
*/
function totalSupply(uint256 tokenId) external view returns (uint256);
/**
* @dev Total amount of burned tokens of resource with a given id.
*/
function burnedSupply(uint256 tokenId) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(
uint256 x,
uint256 y,
uint256 denominator
) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1);
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(
uint256 x,
uint256 y,
uint256 denominator,
Rounding rounding
) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10**64) {
value /= 10**64;
result += 64;
}
if (value >= 10**32) {
value /= 10**32;
result += 32;
}
if (value >= 10**16) {
value /= 10**16;
result += 16;
}
if (value >= 10**8) {
value /= 10**8;
result += 8;
}
if (value >= 10**4) {
value /= 10**4;
result += 4;
}
if (value >= 10**2) {
value /= 10**2;
result += 2;
}
if (value >= 10**1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10**result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result * 8) < value ? 1 : 0);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
import "./math/Math.sol";
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
}