0xc2...5e66
Delegate Token
DT
Collection
Collection
This contract's source code is verified!
Contract Metadata
Compiler
0.8.21+commit.d9974bed
Language
Solidity
Contract Source Code
File 1 of 34: Address.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
Contract Source Code
File 2 of 34: Base64.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Base64.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides a set of functions to operate with Base64 strings.
*
* _Available since v4.5._
*/
library Base64 {
/**
* @dev Base64 Encoding/Decoding Table
*/
string internal constant _TABLE = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
/**
* @dev Converts a `bytes` to its Bytes64 `string` representation.
*/
function encode(bytes memory data) internal pure returns (string memory) {
/**
* Inspired by Brecht Devos (Brechtpd) implementation - MIT licence
* https://github.com/Brechtpd/base64/blob/e78d9fd951e7b0977ddca77d92dc85183770daf4/base64.sol
*/
if (data.length == 0) return "";
// Loads the table into memory
string memory table = _TABLE;
// Encoding takes 3 bytes chunks of binary data from `bytes` data parameter
// and split into 4 numbers of 6 bits.
// The final Base64 length should be `bytes` data length multiplied by 4/3 rounded up
// - `data.length + 2` -> Round up
// - `/ 3` -> Number of 3-bytes chunks
// - `4 *` -> 4 characters for each chunk
string memory result = new string(4 * ((data.length + 2) / 3));
/// @solidity memory-safe-assembly
assembly {
// Prepare the lookup table (skip the first "length" byte)
let tablePtr := add(table, 1)
// Prepare result pointer, jump over length
let resultPtr := add(result, 32)
// Run over the input, 3 bytes at a time
for {
let dataPtr := data
let endPtr := add(data, mload(data))
} lt(dataPtr, endPtr) {
} {
// Advance 3 bytes
dataPtr := add(dataPtr, 3)
let input := mload(dataPtr)
// To write each character, shift the 3 bytes (18 bits) chunk
// 4 times in blocks of 6 bits for each character (18, 12, 6, 0)
// and apply logical AND with 0x3F which is the number of
// the previous character in the ASCII table prior to the Base64 Table
// The result is then added to the table to get the character to write,
// and finally write it in the result pointer but with a left shift
// of 256 (1 byte) - 8 (1 ASCII char) = 248 bits
mstore8(resultPtr, mload(add(tablePtr, and(shr(18, input), 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(add(tablePtr, and(shr(12, input), 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(add(tablePtr, and(shr(6, input), 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
mstore8(resultPtr, mload(add(tablePtr, and(input, 0x3F))))
resultPtr := add(resultPtr, 1) // Advance
}
// When data `bytes` is not exactly 3 bytes long
// it is padded with `=` characters at the end
switch mod(mload(data), 3)
case 1 {
mstore8(sub(resultPtr, 1), 0x3d)
mstore8(sub(resultPtr, 2), 0x3d)
}
case 2 {
mstore8(sub(resultPtr, 1), 0x3d)
}
}
return result;
}
}
Contract Source Code
File 3 of 34: Context.sol
// 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;
}
}
Contract Source Code
File 4 of 34: DelegateToken.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.21;
import {IDelegateToken, IERC721Metadata, IERC721Receiver, IERC1155Receiver} from "./interfaces/IDelegateToken.sol";
import {MarketMetadata} from "./MarketMetadata.sol";
import {PrincipalToken} from "./PrincipalToken.sol";
import {ReentrancyGuard} from "openzeppelin/security/ReentrancyGuard.sol";
import {IDelegateRegistry, DelegateTokenErrors as Errors, DelegateTokenStructs as Structs, DelegateTokenHelpers as Helpers} from "./libraries/DelegateTokenLib.sol";
import {DelegateTokenStorageHelpers as StorageHelpers} from "./libraries/DelegateTokenStorageHelpers.sol";
import {DelegateTokenRegistryHelpers as RegistryHelpers, RegistryHashes} from "./libraries/DelegateTokenRegistryHelpers.sol";
import {DelegateTokenTransferHelpers as TransferHelpers, SafeERC20, IERC721, IERC20, IERC1155} from "./libraries/DelegateTokenTransferHelpers.sol";
contract DelegateToken is ReentrancyGuard, IDelegateToken {
/*//////////////////////////////////////////////////////////////
/ IMMUTABLES /
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IDelegateToken
address public immutable override delegateRegistry;
/// @inheritdoc IDelegateToken
address public immutable override principalToken;
/// @inheritdoc IDelegateToken
address public immutable marketMetadata;
/*//////////////////////////////////////////////////////////////
/ STORAGE /
//////////////////////////////////////////////////////////////*/
/// @dev delegateId, a hash of (msg.sender, salt), points a unique id to the StoragePosition
mapping(uint256 delegateTokenId => uint256[3] info) internal delegateTokenInfo;
/// @notice mapping for ERC721 balances
mapping(address delegateTokenHolder => uint256 balance) internal balances;
/// @notice approve for all mapping
mapping(address account => mapping(address operator => bool enabled)) internal accountOperator;
/// @notice internal variables for Principle Token callbacks
Structs.Uint256 internal principalMintAuthorization = Structs.Uint256(StorageHelpers.MINT_NOT_AUTHORIZED);
Structs.Uint256 internal principalBurnAuthorization = Structs.Uint256(StorageHelpers.BURN_NOT_AUTHORIZED);
/// @notice internal variable 11155 callbacks
Structs.Uint256 internal erc1155PullAuthorization = Structs.Uint256(TransferHelpers.ERC1155_NOT_PULLED);
/*//////////////////////////////////////////////////////////////
/ CONSTRUCTOR /
//////////////////////////////////////////////////////////////*/
//slither-disable-next-line missing-zero-check
constructor(address _delegateRegistry, address _principalToken, address _marketMetadata) {
delegateRegistry = _delegateRegistry;
principalToken = _principalToken;
marketMetadata = _marketMetadata;
}
/*//////////////////////////////////////////////////////////////
/ MULTICALL /
//////////////////////////////////////////////////////////////*/
function multicall(bytes[] calldata data) external returns (bytes[] memory results) {
results = new bytes[](data.length);
bool success;
unchecked {
for (uint256 i = 0; i < data.length; ++i) {
//slither-disable-next-line calls-loop,delegatecall-loop
(success, results[i]) = address(this).delegatecall(data[i]);
if (!success) revert Errors.MulticallFailed();
}
}
}
/*//////////////////////////////////////////////////////////////
/ INTERFACES /
//////////////////////////////////////////////////////////////*/
function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
return interfaceId == 0x2a55205a // ERC165 Interface ID for ERC2981
|| interfaceId == 0x01ffc9a7 // ERC165 Interface ID for ERC165
|| interfaceId == 0x80ac58cd // ERC165 Interface ID for ERC721
|| interfaceId == 0x5b5e139f // ERC165 Interface ID for ERC721Metadata
|| interfaceId == 0x150b7a02 // ERC165 Interface ID for ERC721TokenReceiver
|| interfaceId == 0x4e2312e0; // ERC165 Interface ID for ERC1155TokenReceiver
}
/*//////////////////////////////////////////////////////////////
/ ERCTOKENRECEIVER METHODS /
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IERC721Receiver
function onERC721Received(address operator, address, uint256, bytes calldata) external view returns (bytes4) {
if (address(this) == operator) return IERC721Receiver.onERC721Received.selector;
revert Errors.InvalidERC721TransferOperator();
}
/// @inheritdoc IERC1155Receiver
function onERC1155Received(address operator, address, uint256, uint256, bytes calldata) external returns (bytes4) {
TransferHelpers.revertInvalidERC1155PullCheck(erc1155PullAuthorization, operator);
return IERC1155Receiver.onERC1155Received.selector;
}
/// @inheritdoc IERC1155Receiver
function onERC1155BatchReceived(address, address, uint256[] calldata, uint256[] calldata, bytes calldata) external pure returns (bytes4) {
revert Errors.BatchERC1155TransferUnsupported();
}
/*//////////////////////////////////////////////////////////////
/ ERC721 METHODS /
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IERC721
function balanceOf(address delegateTokenHolder) external view returns (uint256) {
if (delegateTokenHolder == address(0)) revert Errors.DelegateTokenHolderZero();
return balances[delegateTokenHolder];
}
/// @inheritdoc IERC721
function ownerOf(uint256 delegateTokenId) external view returns (address delegateTokenHolder) {
delegateTokenHolder = RegistryHelpers.loadTokenHolder(delegateRegistry, StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId));
if (delegateTokenHolder == address(0)) revert Errors.DelegateTokenHolderZero();
}
/// @inheritdoc IERC721
function getApproved(uint256 delegateTokenId) external view returns (address) {
StorageHelpers.revertNotMinted(delegateTokenInfo, delegateTokenId);
return StorageHelpers.readApproved(delegateTokenInfo, delegateTokenId);
}
/// @inheritdoc IERC721
function isApprovedForAll(address account, address operator) external view returns (bool) {
return accountOperator[account][operator];
}
/// @inheritdoc IERC721
function safeTransferFrom(address from, address to, uint256 delegateTokenId, bytes calldata data) external {
transferFrom(from, to, delegateTokenId);
Helpers.revertOnInvalidERC721ReceiverCallback(from, to, delegateTokenId, data);
}
/// @inheritdoc IERC721
function safeTransferFrom(address from, address to, uint256 delegateTokenId) external {
transferFrom(from, to, delegateTokenId);
Helpers.revertOnInvalidERC721ReceiverCallback(from, to, delegateTokenId);
}
/// @inheritdoc IERC721
function approve(address spender, uint256 delegateTokenId) external {
bytes32 registryHash = StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId);
StorageHelpers.revertNotMinted(registryHash, delegateTokenId);
address delegateTokenHolder = RegistryHelpers.loadTokenHolder(delegateRegistry, registryHash);
StorageHelpers.revertNotOwner(delegateTokenHolder);
StorageHelpers.writeApproved(delegateTokenInfo, delegateTokenId, spender);
emit Approval(delegateTokenHolder, spender, delegateTokenId);
}
/// @inheritdoc IERC721
function setApprovalForAll(address operator, bool approved) external {
accountOperator[msg.sender][operator] = approved;
emit ApprovalForAll(msg.sender, operator, approved);
}
/// @inheritdoc IERC721
/// @dev should revert if msg.sender does not meet one of the following:
/// - msg.sender is from address
/// - from has approved msg.sender for all
/// - msg.sender is approved for the delegateTokenId
/// @dev balances should be incremented / decremented for from / to
/// @dev approved for the delegateTokenId should be deleted (reset)
/// @dev must emit the ERC721 Transfer(from, to, delegateTokenId) event
/// @dev toAmount stored in the related registry delegation must be retrieved directly from registry storage and
/// not via the CheckDelegate method to avoid invariants with "[specific rights]" and "" classes
/// @dev registryHash for the DelegateTokenId must point to the new registry delegation associated with the to
/// address
function transferFrom(address from, address to, uint256 delegateTokenId) public {
if (to == address(0)) revert Errors.ToIsZero();
bytes32 registryHash = StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId);
StorageHelpers.revertNotMinted(registryHash, delegateTokenId);
(address delegateTokenHolder, address underlyingContract) = RegistryHelpers.loadTokenHolderAndContract(delegateRegistry, registryHash);
if (from != delegateTokenHolder) revert Errors.FromNotDelegateTokenHolder();
// We can use `from` here instead of delegateTokenHolder since we've just verified that from == delegateTokenHolder
StorageHelpers.revertNotApprovedOrOperator(accountOperator, delegateTokenInfo, from, delegateTokenId);
StorageHelpers.incrementBalance(balances, to);
StorageHelpers.decrementBalance(balances, from);
StorageHelpers.writeApproved(delegateTokenInfo, delegateTokenId, address(0));
emit Transfer(from, to, delegateTokenId);
IDelegateRegistry.DelegationType underlyingType = RegistryHashes.decodeType(registryHash);
bytes32 underlyingRights = RegistryHelpers.loadRights(delegateRegistry, registryHash);
bytes32 newRegistryHash = 0;
if (underlyingType == IDelegateRegistry.DelegationType.ERC721) {
uint256 underlyingTokenId = RegistryHelpers.loadTokenId(delegateRegistry, registryHash);
newRegistryHash = RegistryHashes.erc721Hash(address(this), underlyingRights, to, underlyingTokenId, underlyingContract);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, newRegistryHash);
RegistryHelpers.transferERC721(delegateRegistry, registryHash, from, newRegistryHash, to, underlyingRights, underlyingContract, underlyingTokenId);
} else if (underlyingType == IDelegateRegistry.DelegationType.ERC20) {
newRegistryHash = RegistryHashes.erc20Hash(address(this), underlyingRights, to, underlyingContract);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, newRegistryHash);
RegistryHelpers.transferERC20(
delegateRegistry,
registryHash,
from,
newRegistryHash,
to,
StorageHelpers.readUnderlyingAmount(delegateTokenInfo, delegateTokenId),
underlyingRights,
underlyingContract
);
} else if (underlyingType == IDelegateRegistry.DelegationType.ERC1155) {
uint256 underlyingTokenId = RegistryHelpers.loadTokenId(delegateRegistry, registryHash);
newRegistryHash = RegistryHashes.erc1155Hash(address(this), underlyingRights, to, underlyingTokenId, underlyingContract);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, newRegistryHash);
RegistryHelpers.transferERC1155(
delegateRegistry,
registryHash,
from,
newRegistryHash,
to,
StorageHelpers.readUnderlyingAmount(delegateTokenInfo, delegateTokenId),
underlyingRights,
underlyingContract,
underlyingTokenId
);
}
}
/*//////////////////////////////////////////////////////////////
/ EXTENDED ERC721 METHODS /
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IERC721Metadata
function name() external pure returns (string memory) {
return "Delegate Token";
}
/// @inheritdoc IERC721Metadata
function symbol() external pure returns (string memory) {
return "DT";
}
/// @inheritdoc IERC721Metadata
function tokenURI(uint256 delegateTokenId) external view returns (string memory) {
return MarketMetadata(marketMetadata).delegateTokenURI(delegateTokenId, getDelegateTokenInfo(delegateTokenId));
}
/// @inheritdoc IDelegateToken
function isApprovedOrOwner(address spender, uint256 delegateTokenId) external view returns (bool) {
bytes32 registryHash = StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId);
StorageHelpers.revertNotMinted(registryHash, delegateTokenId);
address delegateTokenHolder = RegistryHelpers.loadTokenHolder(delegateRegistry, registryHash);
return spender == delegateTokenHolder || accountOperator[delegateTokenHolder][spender] || StorageHelpers.readApproved(delegateTokenInfo, delegateTokenId) == spender;
}
/// @inheritdoc IDelegateToken
function baseURI() external view returns (string memory) {
return MarketMetadata(marketMetadata).baseURI();
}
/// @inheritdoc IDelegateToken
function contractURI() external view returns (string memory) {
return MarketMetadata(marketMetadata).delegateTokenContractURI();
}
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount) {
(receiver, royaltyAmount) = MarketMetadata(marketMetadata).royaltyInfo(tokenId, salePrice);
}
/*//////////////////////////////////////////////////////////////
/ DELEGATE TOKEN METHODS /
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IDelegateToken
function getDelegateTokenInfo(uint256 delegateTokenId) public view returns (Structs.DelegateInfo memory delegateInfo) {
bytes32 registryHash = StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId);
StorageHelpers.revertNotMinted(registryHash, delegateTokenId);
delegateInfo.tokenType = RegistryHashes.decodeType(registryHash);
(delegateInfo.delegateHolder, delegateInfo.tokenContract) = RegistryHelpers.loadTokenHolderAndContract(delegateRegistry, registryHash);
delegateInfo.rights = RegistryHelpers.loadRights(delegateRegistry, registryHash);
delegateInfo.principalHolder = IERC721(principalToken).ownerOf(delegateTokenId);
delegateInfo.expiry = StorageHelpers.readExpiry(delegateTokenInfo, delegateTokenId);
if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC20) delegateInfo.tokenId = 0;
else delegateInfo.tokenId = RegistryHelpers.loadTokenId(delegateRegistry, registryHash);
if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC721) delegateInfo.amount = 0;
else delegateInfo.amount = StorageHelpers.readUnderlyingAmount(delegateTokenInfo, delegateTokenId);
}
/// @inheritdoc IDelegateToken
function getDelegateTokenId(address caller, uint256 salt) external view returns (uint256 delegateTokenId) {
delegateTokenId = Helpers.delegateIdNoRevert(caller, salt);
StorageHelpers.revertAlreadyExisted(delegateTokenInfo, delegateTokenId);
}
/// @inheritdoc IDelegateToken
function burnAuthorizedCallback() external view {
StorageHelpers.checkBurnAuthorized(principalToken, principalBurnAuthorization);
}
/// @inheritdoc IDelegateToken
function mintAuthorizedCallback() external view {
StorageHelpers.checkMintAuthorized(principalToken, principalMintAuthorization);
}
/// @inheritdoc IDelegateToken
function create(Structs.DelegateInfo calldata delegateInfo, uint256 salt) external nonReentrant returns (uint256 delegateTokenId) {
TransferHelpers.pullAssetsAndCheckType(erc1155PullAuthorization, delegateInfo);
Helpers.revertOldExpiry(delegateInfo.expiry);
if (delegateInfo.delegateHolder == address(0)) revert Errors.ToIsZero();
delegateTokenId = Helpers.delegateIdNoRevert(msg.sender, salt);
StorageHelpers.revertAlreadyExisted(delegateTokenInfo, delegateTokenId);
StorageHelpers.incrementBalance(balances, delegateInfo.delegateHolder);
StorageHelpers.writeExpiry(delegateTokenInfo, delegateTokenId, delegateInfo.expiry);
emit Transfer(address(0), delegateInfo.delegateHolder, delegateTokenId);
bytes32 newRegistryHash = 0;
if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC721) {
newRegistryHash = RegistryHashes.erc721Hash(address(this), delegateInfo.rights, delegateInfo.delegateHolder, delegateInfo.tokenId, delegateInfo.tokenContract);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, newRegistryHash);
RegistryHelpers.delegateERC721(delegateRegistry, newRegistryHash, delegateInfo);
} else if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC20) {
StorageHelpers.writeUnderlyingAmount(delegateTokenInfo, delegateTokenId, delegateInfo.amount);
newRegistryHash = RegistryHashes.erc20Hash(address(this), delegateInfo.rights, delegateInfo.delegateHolder, delegateInfo.tokenContract);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, newRegistryHash);
RegistryHelpers.incrementERC20(delegateRegistry, newRegistryHash, delegateInfo);
} else if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC1155) {
StorageHelpers.writeUnderlyingAmount(delegateTokenInfo, delegateTokenId, delegateInfo.amount);
newRegistryHash = RegistryHashes.erc1155Hash(address(this), delegateInfo.rights, delegateInfo.delegateHolder, delegateInfo.tokenId, delegateInfo.tokenContract);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, newRegistryHash);
RegistryHelpers.incrementERC1155(delegateRegistry, newRegistryHash, delegateInfo);
}
StorageHelpers.mintPrincipal(principalToken, principalMintAuthorization, delegateInfo.principalHolder, delegateTokenId);
}
/// @inheritdoc IDelegateToken
function extend(uint256 delegateTokenId, uint256 newExpiry) external {
StorageHelpers.revertNotMinted(delegateTokenInfo, delegateTokenId);
Helpers.revertOldExpiry(newExpiry);
uint256 previousExpiry = StorageHelpers.readExpiry(delegateTokenInfo, delegateTokenId);
if (newExpiry <= previousExpiry) revert Errors.ExpiryTooSmall();
if (PrincipalToken(principalToken).isApprovedOrOwner(msg.sender, delegateTokenId)) {
StorageHelpers.writeExpiry(delegateTokenInfo, delegateTokenId, newExpiry);
emit ExpiryExtended(delegateTokenId, previousExpiry, newExpiry);
return;
}
revert Errors.NotApproved(msg.sender, delegateTokenId);
}
/// @inheritdoc IDelegateToken
function rescind(uint256 delegateTokenId) external {
transferFrom(
RegistryHelpers.loadTokenHolder(delegateRegistry, StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId)),
IERC721(principalToken).ownerOf(delegateTokenId),
delegateTokenId
);
}
/// @inheritdoc IDelegateToken
function withdraw(uint256 delegateTokenId) external nonReentrant {
bytes32 registryHash = StorageHelpers.readRegistryHash(delegateTokenInfo, delegateTokenId);
StorageHelpers.writeRegistryHash(delegateTokenInfo, delegateTokenId, bytes32(StorageHelpers.ID_USED));
// Sets registry pointer to used flag
StorageHelpers.revertNotMinted(registryHash, delegateTokenId);
(address delegateTokenHolder, address underlyingContract) = RegistryHelpers.loadTokenHolderAndContract(delegateRegistry, registryHash);
StorageHelpers.revertInvalidWithdrawalConditions(delegateTokenInfo, accountOperator, delegateTokenId, delegateTokenHolder);
StorageHelpers.decrementBalance(balances, delegateTokenHolder);
delete delegateTokenInfo[delegateTokenId][StorageHelpers.PACKED_INFO_POSITION]; // Deletes both expiry and approved
emit Transfer(delegateTokenHolder, address(0), delegateTokenId);
IDelegateRegistry.DelegationType delegationType = RegistryHashes.decodeType(registryHash);
bytes32 underlyingRights = RegistryHelpers.loadRights(delegateRegistry, registryHash);
if (delegationType == IDelegateRegistry.DelegationType.ERC721) {
uint256 erc721UnderlyingTokenId = RegistryHelpers.loadTokenId(delegateRegistry, registryHash);
RegistryHelpers.revokeERC721(delegateRegistry, registryHash, delegateTokenHolder, underlyingContract, erc721UnderlyingTokenId, underlyingRights);
StorageHelpers.burnPrincipal(principalToken, principalBurnAuthorization, delegateTokenId);
IERC721(underlyingContract).transferFrom(address(this), msg.sender, erc721UnderlyingTokenId);
} else if (delegationType == IDelegateRegistry.DelegationType.ERC20) {
uint256 erc20UnderlyingAmount = StorageHelpers.readUnderlyingAmount(delegateTokenInfo, delegateTokenId);
StorageHelpers.writeUnderlyingAmount(delegateTokenInfo, delegateTokenId, 0); // Deletes amount
RegistryHelpers.decrementERC20(delegateRegistry, registryHash, delegateTokenHolder, underlyingContract, erc20UnderlyingAmount, underlyingRights);
StorageHelpers.burnPrincipal(principalToken, principalBurnAuthorization, delegateTokenId);
SafeERC20.safeTransfer(IERC20(underlyingContract), msg.sender, erc20UnderlyingAmount);
} else if (delegationType == IDelegateRegistry.DelegationType.ERC1155) {
uint256 erc1155UnderlyingAmount = StorageHelpers.readUnderlyingAmount(delegateTokenInfo, delegateTokenId);
StorageHelpers.writeUnderlyingAmount(delegateTokenInfo, delegateTokenId, 0); // Deletes amount
uint256 erc1155UnderlyingTokenId = RegistryHelpers.loadTokenId(delegateRegistry, registryHash);
RegistryHelpers.decrementERC1155(
delegateRegistry, registryHash, delegateTokenHolder, underlyingContract, erc1155UnderlyingTokenId, erc1155UnderlyingAmount, underlyingRights
);
StorageHelpers.burnPrincipal(principalToken, principalBurnAuthorization, delegateTokenId);
IERC1155(underlyingContract).safeTransferFrom(address(this), msg.sender, erc1155UnderlyingTokenId, erc1155UnderlyingAmount, "");
}
}
/// @inheritdoc IDelegateToken
function flashloan(Structs.FlashInfo calldata info) external payable nonReentrant {
StorageHelpers.revertNotOperator(accountOperator, info.delegateHolder);
if (info.tokenType == IDelegateRegistry.DelegationType.ERC721) {
RegistryHelpers.revertERC721FlashUnavailable(delegateRegistry, info);
IERC721(info.tokenContract).transferFrom(address(this), info.receiver, info.tokenId);
Helpers.revertOnCallingInvalidFlashloan(info);
TransferHelpers.checkERC721BeforePull(info.amount, info.tokenContract, info.tokenId);
TransferHelpers.pullERC721AfterCheck(info.tokenContract, info.tokenId);
} else if (info.tokenType == IDelegateRegistry.DelegationType.ERC20) {
RegistryHelpers.revertERC20FlashAmountUnavailable(delegateRegistry, info);
SafeERC20.safeTransfer(IERC20(info.tokenContract), info.receiver, info.amount);
Helpers.revertOnCallingInvalidFlashloan(info);
TransferHelpers.checkERC20BeforePull(info.amount, info.tokenContract, info.tokenId);
TransferHelpers.pullERC20AfterCheck(info.tokenContract, info.amount);
} else if (info.tokenType == IDelegateRegistry.DelegationType.ERC1155) {
RegistryHelpers.revertERC1155FlashAmountUnavailable(delegateRegistry, info);
TransferHelpers.checkERC1155BeforePull(erc1155PullAuthorization, info.amount);
IERC1155(info.tokenContract).safeTransferFrom(address(this), info.receiver, info.tokenId, info.amount, "");
Helpers.revertOnCallingInvalidFlashloan(info);
TransferHelpers.pullERC1155AfterCheck(erc1155PullAuthorization, info.amount, info.tokenContract, info.tokenId);
}
}
}
Contract Source Code
File 5 of 34: DelegateTokenLib.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;
import {IDelegateRegistry} from "delegate-registry/src/IDelegateRegistry.sol";
import {IDelegateFlashloan} from "../interfaces/IDelegateFlashloan.sol";
import {IERC721Receiver} from "openzeppelin/token/ERC721/IERC721Receiver.sol";
library DelegateTokenStructs {
struct Uint256 {
uint256 flag;
}
/// @notice Struct for creating delegate tokens and returning their information
struct DelegateInfo {
address principalHolder;
IDelegateRegistry.DelegationType tokenType;
address delegateHolder;
uint256 amount;
address tokenContract;
uint256 tokenId; // The id of the underlying escrowed token, not the delegate token
bytes32 rights;
uint256 expiry; // Expires when block.timestamp >= expiry
}
struct FlashInfo {
address receiver; // The address to receive the loaned assets
address delegateHolder; // The holder of the delegation
IDelegateRegistry.DelegationType tokenType; // The type of contract, e.g. ERC20
address tokenContract; // The contract of the underlying being loaned
uint256 tokenId; // The tokenId of the underlying being loaned, if applicable
uint256 amount; // The amount being lent, if applicable
bytes data; // Arbitrary data structure, intended to contain user-defined parameters
}
}
library DelegateTokenErrors {
error MulticallFailed();
error DelegateTokenHolderZero();
error ToIsZero();
error NotERC721Receiver();
error InvalidERC721TransferOperator();
error ERC1155PullNotRequested(address operator);
error BatchERC1155TransferUnsupported();
error InsufficientAllowanceOrInvalidToken();
error CallerNotOwnerOrInvalidToken();
error NotOwner(address caller, address account);
error NotOperator(address caller, address account);
error NotApproved(address caller, uint256 delegateTokenId);
error FromNotDelegateTokenHolder();
error HashMismatch();
error NotMinted(uint256 delegateTokenId);
error AlreadyExisted(uint256 delegateTokenId);
error WithdrawNotAvailable(uint256 delegateTokenId, uint256 expiry, uint256 timestamp);
error ExpiryInPast();
error ExpiryTooLarge();
error ExpiryTooSmall();
error WrongAmountForType(IDelegateRegistry.DelegationType tokenType, uint256 wrongAmount);
error WrongTokenIdForType(IDelegateRegistry.DelegationType tokenType, uint256 wrongTokenId);
error InvalidTokenType(IDelegateRegistry.DelegationType tokenType);
error ERC721FlashUnavailable();
error ERC20FlashAmountUnavailable();
error ERC1155FlashAmountUnavailable();
error BurnNotAuthorized();
error MintNotAuthorized();
error CallerNotPrincipalToken();
error BurnAuthorized();
error MintAuthorized();
error ERC1155Pulled();
error ERC1155NotPulled();
}
library DelegateTokenHelpers {
function revertOnCallingInvalidFlashloan(DelegateTokenStructs.FlashInfo calldata info) internal {
if (IDelegateFlashloan(info.receiver).onFlashloan{value: msg.value}(msg.sender, info) == IDelegateFlashloan.onFlashloan.selector) return;
revert IDelegateFlashloan.InvalidFlashloan();
}
function revertOnInvalidERC721ReceiverCallback(address from, address to, uint256 delegateTokenId, bytes calldata data) internal {
if (to.code.length == 0 || IERC721Receiver(to).onERC721Received(msg.sender, from, delegateTokenId, data) == IERC721Receiver.onERC721Received.selector) return;
revert DelegateTokenErrors.NotERC721Receiver();
}
function revertOnInvalidERC721ReceiverCallback(address from, address to, uint256 delegateTokenId) internal {
if (to.code.length == 0 || IERC721Receiver(to).onERC721Received(msg.sender, from, delegateTokenId, "") == IERC721Receiver.onERC721Received.selector) return;
revert DelegateTokenErrors.NotERC721Receiver();
}
/// @dev won't revert if expiry is too large (i.e. > type(uint96).max)
function revertOldExpiry(uint256 expiry) internal view {
//slither-disable-next-line timestamp
if (block.timestamp < expiry) return;
revert DelegateTokenErrors.ExpiryInPast();
}
function delegateIdNoRevert(address caller, uint256 salt) internal pure returns (uint256) {
return uint256(keccak256(abi.encode(caller, salt)));
}
}
Contract Source Code
File 6 of 34: DelegateTokenRegistryHelpers.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;
import {RegistryStorage} from "delegate-registry/src/libraries/RegistryStorage.sol";
import {RegistryHashes} from "delegate-registry/src/libraries/RegistryHashes.sol";
import {IDelegateRegistry, DelegateTokenErrors as Errors, DelegateTokenStructs as Structs} from "./DelegateTokenLib.sol";
library DelegateTokenRegistryHelpers {
/**
* @notice Loads a delegateTokenHolder directly from a given registryHash
* @param delegateRegistry The address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @return delegateTokenHolder Which is the delegate "to" address corresponding to the registryHash
* @dev Will not revert or return address(0) if delegation has been 'revoked'
*/
function loadTokenHolder(address delegateRegistry, bytes32 registryHash) internal view returns (address delegateTokenHolder) {
unchecked {
return RegistryStorage.unpackAddress(
IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_SECOND_PACKED))
);
}
}
/**
* @notice Loads a underlyingContract directly from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @return underlyingContract Which is the "contract_" address corresponding to the registryHash
* @dev Two slots need to be loaded in the registry given the packed configuration, this function should only be used when you don't need "to" or "from"
* @dev Will not revert or return address(0) if delegation has been 'revoked`
*/
function loadContract(address delegateRegistry, bytes32 registryHash) internal view returns (address underlyingContract) {
unchecked {
uint256 registryLocation = uint256(RegistryHashes.location(registryHash));
//slither-disable-next-line unused-return
(,, underlyingContract) = RegistryStorage.unpackAddresses(
IDelegateRegistry(delegateRegistry).readSlot(bytes32(registryLocation + RegistryStorage.POSITIONS_FIRST_PACKED)),
IDelegateRegistry(delegateRegistry).readSlot(bytes32(registryLocation + RegistryStorage.POSITIONS_SECOND_PACKED))
);
}
}
/**
* @notice Loads a delegateTokenHolder and a underlyingContract from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @return delegateTokenHolder Which is the delegate "to" address corresponding to the registryHash
* @return underlyingContract Which is the "contract_" address corresponding to the registryHash
* @dev Two slots need to be loaded from the registry given the packed position
* @dev Will not revert or return address(0), address(0) if delegation has been revoked
*/
function loadTokenHolderAndContract(address delegateRegistry, bytes32 registryHash) internal view returns (address delegateTokenHolder, address underlyingContract) {
unchecked {
uint256 registryLocation = uint256(RegistryHashes.location(registryHash));
//slither-disable-next-line unused-return
(, delegateTokenHolder, underlyingContract) = RegistryStorage.unpackAddresses(
IDelegateRegistry(delegateRegistry).readSlot(bytes32(registryLocation + RegistryStorage.POSITIONS_FIRST_PACKED)),
IDelegateRegistry(delegateRegistry).readSlot(bytes32(registryLocation + RegistryStorage.POSITIONS_SECOND_PACKED))
);
}
}
/**
* @notice Loads the "from" address from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @dev Will not revert if delegation has been revoked or never existed
*/
function loadFrom(address delegateRegistry, bytes32 registryHash) internal view returns (address) {
unchecked {
return RegistryStorage.unpackAddress(
IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_FIRST_PACKED))
);
}
}
/**
* @notice Loads the "amount" from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
*/
function loadAmount(address delegateRegistry, bytes32 registryHash) internal view returns (uint256) {
unchecked {
return uint256(IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_AMOUNT)));
}
}
/**
* @notice Loads the "rights" from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @dev Will not return empty or revert if delegation has been revoked
*/
function loadRights(address delegateRegistry, bytes32 registryHash) internal view returns (bytes32) {
unchecked {
return IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_RIGHTS));
}
}
/**
* @notice Loads the "tokenId" from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @dev Will not revert or return 0 if delegation has been revoked
*/
function loadTokenId(address delegateRegistry, bytes32 registryHash) internal view returns (uint256) {
unchecked {
return uint256(IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_TOKEN_ID)));
}
}
/**
* @notice Calculates a new decreased value given an "amount" from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @param decreaseAmount The value to decrement "amount" by
* @dev Assumes the decreased amount won't underflow with "amount"
*/
function calculateDecreasedAmount(address delegateRegistry, bytes32 registryHash, uint256 decreaseAmount) internal view returns (uint256) {
unchecked {
return
uint256(IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_AMOUNT))) - decreaseAmount;
}
}
/**
* @notice Calculates a new increased value given an "amount" from a given registryHash
* @param delegateRegistry Address of the DelegateRegistry v2 contract
* @param registryHash The hash of the delegation to retrieve data for
* @param increaseAmount The value to increment "amount" by
* @dev Assumes the increased amount won't overflow with "amount"
*/
function calculateIncreasedAmount(address delegateRegistry, bytes32 registryHash, uint256 increaseAmount) internal view returns (uint256) {
unchecked {
return
uint256(IDelegateRegistry(delegateRegistry).readSlot(bytes32(uint256(RegistryHashes.location(registryHash)) + RegistryStorage.POSITIONS_AMOUNT))) + increaseAmount;
}
}
function revertERC721FlashUnavailable(address delegateRegistry, Structs.FlashInfo calldata info) internal view {
// We touch registry directly to check for active delegation of the respective hash, as bubbling up to contract
// and all delegations is not required
// Important to notice that we cannot rely on this method for the fungibles since delegate token doesn't ever
// delete the fungible delegations
if (
loadFrom(delegateRegistry, RegistryHashes.erc721Hash(address(this), "", info.delegateHolder, info.tokenId, info.tokenContract)) == address(this)
|| loadFrom(delegateRegistry, RegistryHashes.erc721Hash(address(this), "flashloan", info.delegateHolder, info.tokenId, info.tokenContract)) == address(this)
) return;
revert Errors.ERC721FlashUnavailable();
}
function revertERC20FlashAmountUnavailable(address delegateRegistry, Structs.FlashInfo calldata info) internal view {
uint256 availableAmount = 0;
unchecked {
// We sum the delegation amounts for "flashloan" and "" rights since liquid delegate doesn't allow double spends for different rights
availableAmount = loadAmount(delegateRegistry, RegistryHashes.erc20Hash(address(this), "flashloan", info.delegateHolder, info.tokenContract))
+ loadAmount(delegateRegistry, RegistryHashes.erc20Hash(address(this), "", info.delegateHolder, info.tokenContract));
} // Unreasonable that this block will overflow
if (info.amount > availableAmount) revert Errors.ERC20FlashAmountUnavailable();
}
function revertERC1155FlashAmountUnavailable(address delegateRegistry, Structs.FlashInfo calldata info) internal view {
uint256 availableAmount = 0;
unchecked {
availableAmount = loadAmount(delegateRegistry, RegistryHashes.erc1155Hash(address(this), "flashloan", info.delegateHolder, info.tokenId, info.tokenContract))
+ loadAmount(delegateRegistry, RegistryHashes.erc1155Hash(address(this), "", info.delegateHolder, info.tokenId, info.tokenContract));
} // Unreasonable that this block will overflow
if (info.amount > availableAmount) {
revert Errors.ERC1155FlashAmountUnavailable();
}
}
/// @dev Will not revert if from didn't have a delegation in the first place
function transferERC721(
address delegateRegistry,
bytes32 registryHash,
address from,
bytes32 newRegistryHash,
address to,
bytes32 underlyingRights,
address underlyingContract,
uint256 underlyingTokenId
) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC721(from, underlyingContract, underlyingTokenId, underlyingRights, false) == registryHash
&& IDelegateRegistry(delegateRegistry).delegateERC721(to, underlyingContract, underlyingTokenId, underlyingRights, true) == newRegistryHash
) return;
revert Errors.HashMismatch();
}
/// @dev Will not revert if from didn't have a delegation in the first place
/// @dev Will not revert an underflow value if from's existing delegation amount > underlyingAmount
/// @dev Will not revert an overflow value if to's existing delegation + underlyingAmount > type(uint256).max
function transferERC20(
address delegateRegistry,
bytes32 registryHash,
address from,
bytes32 newRegistryHash,
address to,
uint256 underlyingAmount,
bytes32 underlyingRights,
address underlyingContract
) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC20(
from, underlyingContract, underlyingRights, calculateDecreasedAmount(delegateRegistry, registryHash, underlyingAmount)
) == bytes32(registryHash)
&& IDelegateRegistry(delegateRegistry).delegateERC20(
to, underlyingContract, underlyingRights, calculateIncreasedAmount(delegateRegistry, newRegistryHash, underlyingAmount)
) == newRegistryHash
) return;
revert Errors.HashMismatch();
}
/// @dev Will not revert if from didn't have a delegation in the first place
/// @dev Will not revert an underflow value if from's existing delegation amount > underlyingAmount
/// @dev Will not revert an overflowed value if to's existing delegation + underlyingAmount > type(uint256).max
function transferERC1155(
address delegateRegistry,
bytes32 registryHash,
address from,
bytes32 newRegistryHash,
address to,
uint256 underlyingAmount,
bytes32 underlyingRights,
address underlyingContract,
uint256 underlyingTokenId
) internal {
uint256 amount = calculateDecreasedAmount(delegateRegistry, registryHash, underlyingAmount);
if (IDelegateRegistry(delegateRegistry).delegateERC1155(from, underlyingContract, underlyingTokenId, underlyingRights, amount) != registryHash) {
revert Errors.HashMismatch();
}
amount = calculateIncreasedAmount(delegateRegistry, newRegistryHash, underlyingAmount);
if (IDelegateRegistry(delegateRegistry).delegateERC1155(to, underlyingContract, underlyingTokenId, underlyingRights, amount) != newRegistryHash) {
revert Errors.HashMismatch();
}
}
/// @dev Will not revert if delegateHolder had a delegation in the first place
function delegateERC721(address delegateRegistry, bytes32 newRegistryHash, Structs.DelegateInfo calldata delegateInfo) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC721(delegateInfo.delegateHolder, delegateInfo.tokenContract, delegateInfo.tokenId, delegateInfo.rights, true)
== newRegistryHash
) return;
revert Errors.HashMismatch();
}
/// @dev Will not revert if delegateHolder had a delegation in the first place
/// @dev Will not revert an overflow value if delegateHolder's existing delegation + amount > type(uint256).max
function incrementERC20(address delegateRegistry, bytes32 newRegistryHash, Structs.DelegateInfo calldata delegateInfo) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC20(
delegateInfo.delegateHolder, delegateInfo.tokenContract, delegateInfo.rights, calculateIncreasedAmount(delegateRegistry, newRegistryHash, delegateInfo.amount)
) == newRegistryHash
) return;
revert Errors.HashMismatch();
}
/// @dev Will not revert if delegateHolder had a delegation in the first place
/// @dev Will not revert an overflow value if delegateHolder's existing delegation + amount > type(uint256).max
function incrementERC1155(address delegateRegistry, bytes32 newRegistryHash, Structs.DelegateInfo calldata delegateInfo) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC1155(
delegateInfo.delegateHolder,
delegateInfo.tokenContract,
delegateInfo.tokenId,
delegateInfo.rights,
calculateIncreasedAmount(delegateRegistry, newRegistryHash, delegateInfo.amount)
) == newRegistryHash
) return;
revert Errors.HashMismatch();
}
/// @dev Will not revert if delegateHolder never had a delegation in the first place
function revokeERC721(
address delegateRegistry,
bytes32 registryHash,
address delegateTokenHolder,
address underlyingContract,
uint256 underlyingTokenId,
bytes32 underlyingRights
) internal {
if (IDelegateRegistry(delegateRegistry).delegateERC721(delegateTokenHolder, underlyingContract, underlyingTokenId, underlyingRights, false) == registryHash) {
return;
}
revert Errors.HashMismatch();
}
/// @dev Will not revert if delegateHolder never had a delegation in the first place
/// @dev Will not revert an underflow value if delegateHolder's existing delegation - underlyingAmount < 0
function decrementERC20(
address delegateRegistry,
bytes32 registryHash,
address delegateTokenHolder,
address underlyingContract,
uint256 underlyingAmount,
bytes32 underlyingRights
) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC20(
delegateTokenHolder, underlyingContract, underlyingRights, calculateDecreasedAmount(delegateRegistry, registryHash, underlyingAmount)
) == registryHash
) return;
revert Errors.HashMismatch();
}
/// @dev Will not revert if delegateHolder never had a delegation in the first place
/// @dev Will not revert an underflow value if delegateHolder's existing delegation - underlyingAmount < 0
function decrementERC1155(
address delegateRegistry,
bytes32 registryHash,
address delegateTokenHolder,
address underlyingContract,
uint256 underlyingTokenId,
uint256 underlyingAmount,
bytes32 underlyingRights
) internal {
if (
IDelegateRegistry(delegateRegistry).delegateERC1155(
delegateTokenHolder, underlyingContract, underlyingTokenId, underlyingRights, calculateDecreasedAmount(delegateRegistry, registryHash, underlyingAmount)
) == registryHash
) return;
revert Errors.HashMismatch();
}
}
Contract Source Code
File 7 of 34: DelegateTokenStorageHelpers.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;
import {DelegateTokenErrors as Errors, DelegateTokenStructs as Structs} from "./DelegateTokenLib.sol";
import {PrincipalToken} from "../PrincipalToken.sol";
library DelegateTokenStorageHelpers {
/// @dev Use this to syntactically store the max of the expiry
uint256 internal constant MAX_EXPIRY = type(uint96).max;
///////////// ID Flags /////////////
/// @dev Standardizes registryHash storage flags to prevent double-creation and griefing
/// @dev ID_AVAILABLE should be zero since this is the default for a storage slot
uint256 internal constant ID_AVAILABLE = 0;
uint256 internal constant ID_USED = 1;
///////////// Info positions /////////////
/// @dev Standardizes storage positions of delegateInfo mapping data
/// @dev must start at zero and end at 2
uint256 internal constant REGISTRY_HASH_POSITION = 0;
uint256 internal constant PACKED_INFO_POSITION = 1; // PACKED (address approved, uint96 expiry)
uint256 internal constant UNDERLYING_AMOUNT_POSITION = 2; // Not used by 721 delegations
///////////// Callback Flags /////////////
/// @dev all callback flags should be non zero to reduce storage read / write costs
/// @dev all callback flags should be unique
/// Principal Token callbacks
uint256 internal constant MINT_NOT_AUTHORIZED = 1;
uint256 internal constant MINT_AUTHORIZED = 2;
uint256 internal constant BURN_NOT_AUTHORIZED = 3;
uint256 internal constant BURN_AUTHORIZED = 4;
/// @dev should preserve the expiry in the lower 96 bits in storage, and update the upper 160 bits with approved address
function writeApproved(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId, address approved) internal {
uint96 expiry = uint96(delegateTokenInfo[delegateTokenId][PACKED_INFO_POSITION]);
delegateTokenInfo[delegateTokenId][PACKED_INFO_POSITION] = (uint256(uint160(approved)) << 96) | expiry;
}
/// @dev should preserve approved in the upper 160 bits, and update the lower 96 bits with expiry
/// @dev should revert if expiry exceeds 96 bits
function writeExpiry(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId, uint256 expiry) internal {
if (expiry > MAX_EXPIRY) revert Errors.ExpiryTooLarge();
address approved = address(uint160(delegateTokenInfo[delegateTokenId][PACKED_INFO_POSITION] >> 96));
delegateTokenInfo[delegateTokenId][PACKED_INFO_POSITION] = (uint256(uint160(approved)) << 96) | expiry;
}
function writeRegistryHash(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId, bytes32 registryHash) internal {
delegateTokenInfo[delegateTokenId][REGISTRY_HASH_POSITION] = uint256(registryHash);
}
function writeUnderlyingAmount(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId, uint256 underlyingAmount) internal {
delegateTokenInfo[delegateTokenId][UNDERLYING_AMOUNT_POSITION] = underlyingAmount;
}
function incrementBalance(mapping(address delegateTokenHolder => uint256 balance) storage balances, address delegateTokenHolder) internal {
unchecked {
++balances[delegateTokenHolder];
} // Infeasible that this will overflow
}
function decrementBalance(mapping(address delegateTokenHolder => uint256 balance) storage balances, address delegateTokenHolder) internal {
unchecked {
--balances[delegateTokenHolder];
} // Reasonable to expect this not to underflow
}
/// @notice helper function for burning a principal token
/// @dev must revert if burnAuthorized is not set to BURN_NOT_AUTHORIZED flag
function burnPrincipal(address principalToken, Structs.Uint256 storage principalBurnAuthorization, uint256 delegateTokenId) internal {
if (principalBurnAuthorization.flag == BURN_NOT_AUTHORIZED) {
principalBurnAuthorization.flag = BURN_AUTHORIZED;
PrincipalToken(principalToken).burn(msg.sender, delegateTokenId);
principalBurnAuthorization.flag = BURN_NOT_AUTHORIZED;
return;
}
revert Errors.BurnAuthorized();
}
/// @notice helper function for minting a principal token
/// @dev must revert if mintAuthorized has already been set to MINT_AUTHORIZED flag
function mintPrincipal(address principalToken, Structs.Uint256 storage principalMintAuthorization, address principalRecipient, uint256 delegateTokenId) internal {
if (principalMintAuthorization.flag == MINT_NOT_AUTHORIZED) {
principalMintAuthorization.flag = MINT_AUTHORIZED;
PrincipalToken(principalToken).mint(principalRecipient, delegateTokenId);
principalMintAuthorization.flag = MINT_NOT_AUTHORIZED;
return;
}
revert Errors.MintAuthorized();
}
/// @dev must revert if delegate token did not call burn on the Principal Token for the delegateTokenId
/// @dev must revert if principal token is not the caller
function checkBurnAuthorized(address principalToken, Structs.Uint256 storage principalBurnAuthorization) internal view {
principalIsCaller(principalToken);
if (principalBurnAuthorization.flag == BURN_AUTHORIZED) return;
revert Errors.BurnNotAuthorized();
}
/// @dev must revert if delegate token did not call burn on the Principal Token for the delegateTokenId
/// @dev must revert if principal token is not the caller
function checkMintAuthorized(address principalToken, Structs.Uint256 storage principalMintAuthorization) internal view {
principalIsCaller(principalToken);
if (principalMintAuthorization.flag == MINT_AUTHORIZED) return;
revert Errors.MintNotAuthorized();
}
/// @notice helper function to revert if caller is not Principal Token
/// @dev must revert if msg.sender is not the principal token
function principalIsCaller(address principalToken) internal view {
if (msg.sender == principalToken) return;
revert Errors.CallerNotPrincipalToken();
}
function readApproved(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId) internal view returns (address) {
return address(uint160(delegateTokenInfo[delegateTokenId][PACKED_INFO_POSITION] >> 96));
}
function readExpiry(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId) internal view returns (uint256) {
return uint96(delegateTokenInfo[delegateTokenId][PACKED_INFO_POSITION]);
}
function readRegistryHash(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId) internal view returns (bytes32) {
return bytes32(delegateTokenInfo[delegateTokenId][REGISTRY_HASH_POSITION]);
}
function readUnderlyingAmount(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId) internal view returns (uint256) {
return delegateTokenInfo[delegateTokenId][UNDERLYING_AMOUNT_POSITION];
}
function revertNotOwner(address account) internal view {
if (msg.sender == account) return;
revert Errors.NotOwner(msg.sender, account);
}
function revertNotOperator(mapping(address account => mapping(address operator => bool enabled)) storage accountOperator, address account) internal view {
if (msg.sender == account || accountOperator[account][msg.sender]) return;
revert Errors.NotOperator(msg.sender, account);
}
function revertNotApprovedOrOperator(
mapping(address account => mapping(address operator => bool enabled)) storage accountOperator,
mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo,
address account,
uint256 delegateTokenId
) internal view {
if (msg.sender == account || accountOperator[account][msg.sender] || msg.sender == readApproved(delegateTokenInfo, delegateTokenId)) return;
revert Errors.NotApproved(msg.sender, delegateTokenId);
}
/// @dev should only revert if expiry has not expired AND caller is not the delegateTokenHolder AND not approved for the delegateTokenId AND not an operator for
/// delegateTokenHolder
function revertInvalidWithdrawalConditions(
mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo,
mapping(address account => mapping(address operator => bool enabled)) storage accountOperator,
uint256 delegateTokenId,
address delegateTokenHolder
) internal view {
//slither-disable-next-line timestamp
if (block.timestamp < readExpiry(delegateTokenInfo, delegateTokenId)) {
if (msg.sender == delegateTokenHolder || accountOperator[delegateTokenHolder][msg.sender] || msg.sender == readApproved(delegateTokenInfo, delegateTokenId)) {
return;
}
revert Errors.WithdrawNotAvailable(delegateTokenId, readExpiry(delegateTokenInfo, delegateTokenId), block.timestamp);
}
}
function revertAlreadyExisted(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId) internal view {
if (delegateTokenInfo[delegateTokenId][REGISTRY_HASH_POSITION] == ID_AVAILABLE) return;
revert Errors.AlreadyExisted(delegateTokenId);
}
function revertNotMinted(mapping(uint256 delegateTokenId => uint256[3] info) storage delegateTokenInfo, uint256 delegateTokenId) internal view {
uint256 registryHash = delegateTokenInfo[delegateTokenId][REGISTRY_HASH_POSITION];
if (registryHash == ID_AVAILABLE || registryHash == ID_USED) {
revert Errors.NotMinted(delegateTokenId);
}
}
/// @dev does not read from storage, make sure the registryHash of the corresponding delegateTokenId is passed to have the intended effect
function revertNotMinted(bytes32 registryHash, uint256 delegateTokenId) internal pure {
if (uint256(registryHash) == ID_AVAILABLE || uint256(registryHash) == ID_USED) {
revert Errors.NotMinted(delegateTokenId);
}
}
}
Contract Source Code
File 8 of 34: DelegateTokenTransferHelpers.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;
import {IDelegateRegistry, DelegateTokenErrors as Errors, DelegateTokenStructs as Structs} from "./DelegateTokenLib.sol";
import {IERC1155} from "openzeppelin/token/ERC1155/IERC1155.sol";
import {IERC721} from "openzeppelin/token/ERC721/IERC721.sol";
import {IERC20} from "openzeppelin/token/ERC20/IERC20.sol";
import {SafeERC20} from "openzeppelin/token/ERC20/utils/SafeERC20.sol";
library DelegateTokenTransferHelpers {
/// 1155 callbacks
uint256 internal constant ERC1155_NOT_PULLED = 5;
uint256 internal constant ERC1155_PULLED = 6;
/// @dev Pulls assets into escrow, and reverts if delegation type is not ERC20/721/1155
function pullAssetsAndCheckType(Structs.Uint256 storage erc1155Pulled, Structs.DelegateInfo calldata delegateInfo) internal {
if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC721) {
checkERC721BeforePull(delegateInfo.amount, delegateInfo.tokenContract, delegateInfo.tokenId);
pullERC721AfterCheck(delegateInfo.tokenContract, delegateInfo.tokenId);
} else if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC20) {
checkERC20BeforePull(delegateInfo.amount, delegateInfo.tokenContract, delegateInfo.tokenId);
pullERC20AfterCheck(delegateInfo.tokenContract, delegateInfo.amount);
} else if (delegateInfo.tokenType == IDelegateRegistry.DelegationType.ERC1155) {
checkERC1155BeforePull(erc1155Pulled, delegateInfo.amount);
pullERC1155AfterCheck(erc1155Pulled, delegateInfo.amount, delegateInfo.tokenContract, delegateInfo.tokenId);
} else {
revert Errors.InvalidTokenType(delegateInfo.tokenType);
}
}
/// @dev Should revert for a typical 20 / 1155, and pass for a typical 721
function checkERC721BeforePull(uint256 underlyingAmount, address underlyingContract, uint256 underlyingTokenId) internal view {
if (underlyingAmount != 0) {
revert Errors.WrongAmountForType(IDelegateRegistry.DelegationType.ERC721, underlyingAmount);
}
if (IERC721(underlyingContract).ownerOf(underlyingTokenId) != msg.sender) {
revert Errors.CallerNotOwnerOrInvalidToken();
}
}
function pullERC721AfterCheck(address underlyingContract, uint256 underlyingTokenId) internal {
IERC721(underlyingContract).transferFrom(msg.sender, address(this), underlyingTokenId);
}
/// @dev Should revert for a typical 721 / 1155 and pass for a typical 20
function checkERC20BeforePull(uint256 underlyingAmount, address underlyingContract, uint256 underlyingTokenId) internal view {
if (underlyingTokenId != 0) {
revert Errors.WrongTokenIdForType(IDelegateRegistry.DelegationType.ERC20, underlyingTokenId);
}
if (underlyingAmount == 0) {
revert Errors.WrongAmountForType(IDelegateRegistry.DelegationType.ERC20, underlyingAmount);
}
if (IERC20(underlyingContract).allowance(msg.sender, address(this)) < underlyingAmount) {
revert Errors.InsufficientAllowanceOrInvalidToken();
}
}
function pullERC20AfterCheck(address underlyingContract, uint256 pullAmount) internal {
SafeERC20.safeTransferFrom(IERC20(underlyingContract), msg.sender, address(this), pullAmount);
}
function checkERC1155BeforePull(Structs.Uint256 storage erc1155Pulled, uint256 pullAmount) internal {
if (pullAmount == 0) revert Errors.WrongAmountForType(IDelegateRegistry.DelegationType.ERC1155, pullAmount);
if (erc1155Pulled.flag == ERC1155_NOT_PULLED) {
erc1155Pulled.flag = ERC1155_PULLED;
} else {
revert Errors.ERC1155Pulled();
}
}
function pullERC1155AfterCheck(Structs.Uint256 storage erc1155Pulled, uint256 pullAmount, address underlyingContract, uint256 underlyingTokenId) internal {
IERC1155(underlyingContract).safeTransferFrom(msg.sender, address(this), underlyingTokenId, pullAmount, "");
if (erc1155Pulled.flag == ERC1155_PULLED) {
revert Errors.ERC1155NotPulled();
}
}
function checkERC1155Pulled(Structs.Uint256 storage erc1155Pulled, address operator) internal returns (bool) {
if (erc1155Pulled.flag == ERC1155_PULLED && address(this) == operator) {
erc1155Pulled.flag = ERC1155_NOT_PULLED;
return true;
}
return false;
}
function revertInvalidERC1155PullCheck(Structs.Uint256 storage erc1155PullAuthorization, address operator) internal {
if (!checkERC1155Pulled(erc1155PullAuthorization, operator)) revert Errors.ERC1155PullNotRequested(operator);
}
}
Contract Source Code
File 9 of 34: ERC165.sol
// 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;
}
}
Contract Source Code
File 10 of 34: ERC2981.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/common/ERC2981.sol)
pragma solidity ^0.8.0;
import "../../interfaces/IERC2981.sol";
import "../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of the NFT Royalty Standard, a standardized way to retrieve royalty payment information.
*
* Royalty information can be specified globally for all token ids via {_setDefaultRoyalty}, and/or individually for
* specific token ids via {_setTokenRoyalty}. The latter takes precedence over the first.
*
* Royalty is specified as a fraction of sale price. {_feeDenominator} is overridable but defaults to 10000, meaning the
* fee is specified in basis points by default.
*
* IMPORTANT: ERC-2981 only specifies a way to signal royalty information and does not enforce its payment. See
* https://eips.ethereum.org/EIPS/eip-2981#optional-royalty-payments[Rationale] in the EIP. Marketplaces are expected to
* voluntarily pay royalties together with sales, but note that this standard is not yet widely supported.
*
* _Available since v4.5._
*/
abstract contract ERC2981 is IERC2981, ERC165 {
struct RoyaltyInfo {
address receiver;
uint96 royaltyFraction;
}
RoyaltyInfo private _defaultRoyaltyInfo;
mapping(uint256 => RoyaltyInfo) private _tokenRoyaltyInfo;
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC165) returns (bool) {
return interfaceId == type(IERC2981).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @inheritdoc IERC2981
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice) public view virtual override returns (address, uint256) {
RoyaltyInfo memory royalty = _tokenRoyaltyInfo[tokenId];
if (royalty.receiver == address(0)) {
royalty = _defaultRoyaltyInfo;
}
uint256 royaltyAmount = (salePrice * royalty.royaltyFraction) / _feeDenominator();
return (royalty.receiver, royaltyAmount);
}
/**
* @dev The denominator with which to interpret the fee set in {_setTokenRoyalty} and {_setDefaultRoyalty} as a
* fraction of the sale price. Defaults to 10000 so fees are expressed in basis points, but may be customized by an
* override.
*/
function _feeDenominator() internal pure virtual returns (uint96) {
return 10000;
}
/**
* @dev Sets the royalty information that all ids in this contract will default to.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/
function _setDefaultRoyalty(address receiver, uint96 feeNumerator) internal virtual {
require(feeNumerator <= _feeDenominator(), "ERC2981: royalty fee will exceed salePrice");
require(receiver != address(0), "ERC2981: invalid receiver");
_defaultRoyaltyInfo = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev Removes default royalty information.
*/
function _deleteDefaultRoyalty() internal virtual {
delete _defaultRoyaltyInfo;
}
/**
* @dev Sets the royalty information for a specific token id, overriding the global default.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/
function _setTokenRoyalty(uint256 tokenId, address receiver, uint96 feeNumerator) internal virtual {
require(feeNumerator <= _feeDenominator(), "ERC2981: royalty fee will exceed salePrice");
require(receiver != address(0), "ERC2981: Invalid parameters");
_tokenRoyaltyInfo[tokenId] = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev Resets royalty information for the token id back to the global default.
*/
function _resetTokenRoyalty(uint256 tokenId) internal virtual {
delete _tokenRoyaltyInfo[tokenId];
}
}
Contract Source Code
File 11 of 34: ERC721.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.0;
import "./IERC721.sol";
import "./IERC721Receiver.sol";
import "./extensions/IERC721Metadata.sol";
import "../../utils/Address.sol";
import "../../utils/Context.sol";
import "../../utils/Strings.sol";
import "../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/
contract ERC721 is Context, ERC165, IERC721, IERC721Metadata {
using Address for address;
using Strings for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
// Mapping from token ID to owner address
mapping(uint256 => address) private _owners;
// Mapping owner address to token count
mapping(address => uint256) private _balances;
// Mapping from token ID to approved address
mapping(uint256 => address) private _tokenApprovals;
// Mapping from owner to operator approvals
mapping(address => mapping(address => bool)) private _operatorApprovals;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/
function balanceOf(address owner) public view virtual override returns (uint256) {
require(owner != address(0), "ERC721: address zero is not a valid owner");
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId) public view virtual override returns (address) {
address owner = _ownerOf(tokenId);
require(owner != address(0), "ERC721: invalid token ID");
return owner;
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
_requireMinted(tokenId);
string memory baseURI = _baseURI();
return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI, tokenId.toString())) : "";
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overridden in child contracts.
*/
function _baseURI() internal view virtual returns (string memory) {
return "";
}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) public virtual override {
address owner = ERC721.ownerOf(tokenId);
require(to != owner, "ERC721: approval to current owner");
require(
_msgSender() == owner || isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not token owner or approved for all"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId) public view virtual override returns (address) {
_requireMinted(tokenId);
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved) public virtual override {
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(address from, address to, uint256 tokenId) public virtual override {
//solhint-disable-next-line max-line-length
require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner or approved");
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) public virtual override {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual override {
require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner or approved");
_safeTransfer(from, to, tokenId, data);
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* `data` is additional data, it has no specified format and it is sent in call to `to`.
*
* This internal function is equivalent to {safeTransferFrom}, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
_transfer(from, to, tokenId);
require(_checkOnERC721Received(from, to, tokenId, data), "ERC721: transfer to non ERC721Receiver implementer");
}
/**
* @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
*/
function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
return _owners[tokenId];
}
/**
* @dev Returns whether `tokenId` exists.
*
* Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
*
* Tokens start existing when they are minted (`_mint`),
* and stop existing when they are burned (`_burn`).
*/
function _exists(uint256 tokenId) internal view virtual returns (bool) {
return _ownerOf(tokenId) != address(0);
}
/**
* @dev Returns whether `spender` is allowed to manage `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function _isApprovedOrOwner(address spender, uint256 tokenId) internal view virtual returns (bool) {
address owner = ERC721.ownerOf(tokenId);
return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == spender);
}
/**
* @dev Safely mints `tokenId` and transfers it to `to`.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeMint(address to, uint256 tokenId) internal virtual {
_safeMint(to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeMint(address to, uint256 tokenId, bytes memory data) internal virtual {
_mint(to, tokenId);
require(
_checkOnERC721Received(address(0), to, tokenId, data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @dev Mints `tokenId` and transfers it to `to`.
*
* WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
*
* Requirements:
*
* - `tokenId` must not exist.
* - `to` cannot be the zero address.
*
* Emits a {Transfer} event.
*/
function _mint(address to, uint256 tokenId) internal virtual {
require(to != address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId, 1);
// Check that tokenId was not minted by `_beforeTokenTransfer` hook
require(!_exists(tokenId), "ERC721: token already minted");
unchecked {
// Will not overflow unless all 2**256 token ids are minted to the same owner.
// Given that tokens are minted one by one, it is impossible in practice that
// this ever happens. Might change if we allow batch minting.
// The ERC fails to describe this case.
_balances[to] += 1;
}
_owners[tokenId] = to;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId, 1);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
* This is an internal function that does not check if the sender is authorized to operate on the token.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/
function _burn(uint256 tokenId) internal virtual {
address owner = ERC721.ownerOf(tokenId);
_beforeTokenTransfer(owner, address(0), tokenId, 1);
// Update ownership in case tokenId was transferred by `_beforeTokenTransfer` hook
owner = ERC721.ownerOf(tokenId);
// Clear approvals
delete _tokenApprovals[tokenId];
unchecked {
// Cannot overflow, as that would require more tokens to be burned/transferred
// out than the owner initially received through minting and transferring in.
_balances[owner] -= 1;
}
delete _owners[tokenId];
emit Transfer(owner, address(0), tokenId);
_afterTokenTransfer(owner, address(0), tokenId, 1);
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
* As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
*
* Emits a {Transfer} event.
*/
function _transfer(address from, address to, uint256 tokenId) internal virtual {
require(ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner");
require(to != address(0), "ERC721: transfer to the zero address");
_beforeTokenTransfer(from, to, tokenId, 1);
// Check that tokenId was not transferred by `_beforeTokenTransfer` hook
require(ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner");
// Clear approvals from the previous owner
delete _tokenApprovals[tokenId];
unchecked {
// `_balances[from]` cannot overflow for the same reason as described in `_burn`:
// `from`'s balance is the number of token held, which is at least one before the current
// transfer.
// `_balances[to]` could overflow in the conditions described in `_mint`. That would require
// all 2**256 token ids to be minted, which in practice is impossible.
_balances[from] -= 1;
_balances[to] += 1;
}
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
_afterTokenTransfer(from, to, tokenId, 1);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits an {Approval} event.
*/
function _approve(address to, uint256 tokenId) internal virtual {
_tokenApprovals[tokenId] = to;
emit Approval(ERC721.ownerOf(tokenId), to, tokenId);
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits an {ApprovalForAll} event.
*/
function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
require(owner != operator, "ERC721: approve to caller");
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Reverts if the `tokenId` has not been minted yet.
*/
function _requireMinted(uint256 tokenId) internal view virtual {
require(_exists(tokenId), "ERC721: invalid token ID");
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address.
* The call is not executed if the target address is not a contract.
*
* @param from address representing the previous owner of the given token ID
* @param to target address that will receive the tokens
* @param tokenId uint256 ID of the token to be transferred
* @param data bytes optional data to send along with the call
* @return bool whether the call correctly returned the expected magic value
*/
function _checkOnERC721Received(
address from,
address to,
uint256 tokenId,
bytes memory data
) private returns (bool) {
if (to.isContract()) {
try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
return retval == IERC721Receiver.onERC721Received.selector;
} catch (bytes memory reason) {
if (reason.length == 0) {
revert("ERC721: transfer to non ERC721Receiver implementer");
} else {
/// @solidity memory-safe-assembly
assembly {
revert(add(32, reason), mload(reason))
}
}
}
} else {
return true;
}
}
/**
* @dev Hook that is called before any token transfer. This includes minting and burning. If {ERC721Consecutive} is
* used, the hook may be called as part of a consecutive (batch) mint, as indicated by `batchSize` greater than 1.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s tokens will be transferred to `to`.
* - When `from` is zero, the tokens will be minted for `to`.
* - When `to` is zero, ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
* - `batchSize` is non-zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(address from, address to, uint256 firstTokenId, uint256 batchSize) internal virtual {}
/**
* @dev Hook that is called after any token transfer. This includes minting and burning. If {ERC721Consecutive} is
* used, the hook may be called as part of a consecutive (batch) mint, as indicated by `batchSize` greater than 1.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s tokens were transferred to `to`.
* - When `from` is zero, the tokens were minted for `to`.
* - When `to` is zero, ``from``'s tokens were burned.
* - `from` and `to` are never both zero.
* - `batchSize` is non-zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(address from, address to, uint256 firstTokenId, uint256 batchSize) internal virtual {}
/**
* @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
*
* WARNING: Anyone calling this MUST ensure that the balances remain consistent with the ownership. The invariant
* being that for any address `a` the value returned by `balanceOf(a)` must be equal to the number of tokens such
* that `ownerOf(tokenId)` is `a`.
*/
// solhint-disable-next-line func-name-mixedcase
function __unsafe_increaseBalance(address account, uint256 amount) internal {
_balances[account] += amount;
}
}
Contract Source Code
File 12 of 34: IDelegateFlashloan.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;
import {DelegateTokenStructs as Structs} from "../libraries/DelegateTokenLib.sol";
interface IDelegateFlashloan {
error InvalidFlashloan();
/**
* @dev Receive a delegate flashloan
* @param initiator Caller of the flashloan
* @param flashInfo Info about the flashloan
* @return selector The function selector for onFlashloan
*/
function onFlashloan(address initiator, Structs.FlashInfo calldata flashInfo) external payable returns (bytes32);
}
Contract Source Code
File 13 of 34: IDelegateRegistry.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity >=0.8.13;
/**
* @title IDelegateRegistry
* @custom:version 2.0
* @custom:author foobar (0xfoobar)
* @notice A standalone immutable registry storing delegated permissions from one address to another
*/
interface IDelegateRegistry {
/// @notice Delegation type, NONE is used when a delegation does not exist or is revoked
enum DelegationType {
NONE,
ALL,
CONTRACT,
ERC721,
ERC20,
ERC1155
}
/// @notice Struct for returning delegations
struct Delegation {
DelegationType type_;
address to;
address from;
bytes32 rights;
address contract_;
uint256 tokenId;
uint256 amount;
}
/// @notice Emitted when an address delegates or revokes rights for their entire wallet
event DelegateAll(address indexed from, address indexed to, bytes32 rights, bool enable);
/// @notice Emitted when an address delegates or revokes rights for a contract address
event DelegateContract(address indexed from, address indexed to, address indexed contract_, bytes32 rights, bool enable);
/// @notice Emitted when an address delegates or revokes rights for an ERC721 tokenId
event DelegateERC721(address indexed from, address indexed to, address indexed contract_, uint256 tokenId, bytes32 rights, bool enable);
/// @notice Emitted when an address delegates or revokes rights for an amount of ERC20 tokens
event DelegateERC20(address indexed from, address indexed to, address indexed contract_, bytes32 rights, uint256 amount);
/// @notice Emitted when an address delegates or revokes rights for an amount of an ERC1155 tokenId
event DelegateERC1155(address indexed from, address indexed to, address indexed contract_, uint256 tokenId, bytes32 rights, uint256 amount);
/// @notice Thrown if multicall calldata is malformed
error MulticallFailed();
/**
* ----------- WRITE -----------
*/
/**
* @notice Call multiple functions in the current contract and return the data from all of them if they all succeed
* @param data The encoded function data for each of the calls to make to this contract
* @return results The results from each of the calls passed in via data
*/
function multicall(bytes[] calldata data) external payable returns (bytes[] memory results);
/**
* @notice Allow the delegate to act on behalf of `msg.sender` for all contracts
* @param to The address to act as delegate
* @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
* @param enable Whether to enable or disable this delegation, true delegates and false revokes
* @return delegationHash The unique identifier of the delegation
*/
function delegateAll(address to, bytes32 rights, bool enable) external payable returns (bytes32 delegationHash);
/**
* @notice Allow the delegate to act on behalf of `msg.sender` for a specific contract
* @param to The address to act as delegate
* @param contract_ The contract whose rights are being delegated
* @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
* @param enable Whether to enable or disable this delegation, true delegates and false revokes
* @return delegationHash The unique identifier of the delegation
*/
function delegateContract(address to, address contract_, bytes32 rights, bool enable) external payable returns (bytes32 delegationHash);
/**
* @notice Allow the delegate to act on behalf of `msg.sender` for a specific ERC721 token
* @param to The address to act as delegate
* @param contract_ The contract whose rights are being delegated
* @param tokenId The token id to delegate
* @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
* @param enable Whether to enable or disable this delegation, true delegates and false revokes
* @return delegationHash The unique identifier of the delegation
*/
function delegateERC721(address to, address contract_, uint256 tokenId, bytes32 rights, bool enable) external payable returns (bytes32 delegationHash);
/**
* @notice Allow the delegate to act on behalf of `msg.sender` for a specific amount of ERC20 tokens
* @dev The actual amount is not encoded in the hash, just the existence of a amount (since it is an upper bound)
* @param to The address to act as delegate
* @param contract_ The address for the fungible token contract
* @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
* @param amount The amount to delegate, > 0 delegates and 0 revokes
* @return delegationHash The unique identifier of the delegation
*/
function delegateERC20(address to, address contract_, bytes32 rights, uint256 amount) external payable returns (bytes32 delegationHash);
/**
* @notice Allow the delegate to act on behalf of `msg.sender` for a specific amount of ERC1155 tokens
* @dev The actual amount is not encoded in the hash, just the existence of a amount (since it is an upper bound)
* @param to The address to act as delegate
* @param contract_ The address of the contract that holds the token
* @param tokenId The token id to delegate
* @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
* @param amount The amount of that token id to delegate, > 0 delegates and 0 revokes
* @return delegationHash The unique identifier of the delegation
*/
function delegateERC1155(address to, address contract_, uint256 tokenId, bytes32 rights, uint256 amount) external payable returns (bytes32 delegationHash);
/**
* ----------- CHECKS -----------
*/
/**
* @notice Check if `to` is a delegate of `from` for the entire wallet
* @param to The potential delegate address
* @param from The potential address who delegated rights
* @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
* @return valid Whether delegate is granted to act on the from's behalf
*/
function checkDelegateForAll(address to, address from, bytes32 rights) external view returns (bool);
/**
* @notice Check if `to` is a delegate of `from` for the specified `contract_` or the entire wallet
* @param to The delegated address to check
* @param contract_ The specific contract address being checked
* @param from The cold wallet who issued the delegation
* @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
* @return valid Whether delegate is granted to act on from's behalf for entire wallet or that specific contract
*/
function checkDelegateForContract(address to, address from, address contract_, bytes32 rights) external view returns (bool);
/**
* @notice Check if `to` is a delegate of `from` for the specific `contract` and `tokenId`, the entire `contract_`, or the entire wallet
* @param to The delegated address to check
* @param contract_ The specific contract address being checked
* @param tokenId The token id for the token to delegating
* @param from The wallet that issued the delegation
* @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
* @return valid Whether delegate is granted to act on from's behalf for entire wallet, that contract, or that specific tokenId
*/
function checkDelegateForERC721(address to, address from, address contract_, uint256 tokenId, bytes32 rights) external view returns (bool);
/**
* @notice Returns the amount of ERC20 tokens the delegate is granted rights to act on the behalf of
* @param to The delegated address to check
* @param contract_ The address of the token contract
* @param from The cold wallet who issued the delegation
* @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
* @return balance The delegated balance, which will be 0 if the delegation does not exist
*/
function checkDelegateForERC20(address to, address from, address contract_, bytes32 rights) external view returns (uint256);
/**
* @notice Returns the amount of a ERC1155 tokens the delegate is granted rights to act on the behalf of
* @param to The delegated address to check
* @param contract_ The address of the token contract
* @param tokenId The token id to check the delegated amount of
* @param from The cold wallet who issued the delegation
* @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
* @return balance The delegated balance, which will be 0 if the delegation does not exist
*/
function checkDelegateForERC1155(address to, address from, address contract_, uint256 tokenId, bytes32 rights) external view returns (uint256);
/**
* ----------- ENUMERATIONS -----------
*/
/**
* @notice Returns all enabled delegations a given delegate has received
* @param to The address to retrieve delegations for
* @return delegations Array of Delegation structs
*/
function getIncomingDelegations(address to) external view returns (Delegation[] memory delegations);
/**
* @notice Returns all enabled delegations an address has given out
* @param from The address to retrieve delegations for
* @return delegations Array of Delegation structs
*/
function getOutgoingDelegations(address from) external view returns (Delegation[] memory delegations);
/**
* @notice Returns all hashes associated with enabled delegations an address has received
* @param to The address to retrieve incoming delegation hashes for
* @return delegationHashes Array of delegation hashes
*/
function getIncomingDelegationHashes(address to) external view returns (bytes32[] memory delegationHashes);
/**
* @notice Returns all hashes associated with enabled delegations an address has given out
* @param from The address to retrieve outgoing delegation hashes for
* @return delegationHashes Array of delegation hashes
*/
function getOutgoingDelegationHashes(address from) external view returns (bytes32[] memory delegationHashes);
/**
* @notice Returns the delegations for a given array of delegation hashes
* @param delegationHashes is an array of hashes that correspond to delegations
* @return delegations Array of Delegation structs, return empty structs for nonexistent or revoked delegations
*/
function getDelegationsFromHashes(bytes32[] calldata delegationHashes) external view returns (Delegation[] memory delegations);
/**
* ----------- STORAGE ACCESS -----------
*/
/**
* @notice allows external contract to read arbitrary storage slot
*/
function readSlot(bytes32 location) external view returns (bytes32);
/**
* @notice allows external contracts to read an arbitrary array of storage slots
*/
function readSlots(bytes32[] calldata locations) external view returns (bytes32[] memory);
}
Contract Source Code
File 14 of 34: IDelegateToken.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;
import {IERC721Metadata} from "openzeppelin/token/ERC721/extensions/IERC721Metadata.sol";
import {IERC721Receiver} from "openzeppelin/token/ERC721/IERC721Receiver.sol";
import {IERC1155Receiver} from "openzeppelin/token/ERC1155/IERC1155Receiver.sol";
import {IERC2981} from "openzeppelin/interfaces/IERC2981.sol";
import {DelegateTokenStructs as Structs} from "../libraries/DelegateTokenLib.sol";
interface IDelegateToken is IERC721Metadata, IERC721Receiver, IERC1155Receiver, IERC2981 {
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
/**
* To prevent doubled event emissions, the latest version of the DelegateToken uses the ERC721 Transfer(from, to, id) event standard to infer meaning that was
* previously double covered by "RightsCreated" and "RightsBurned" events
* A Transfer event with from = address(0) is a "create" event
* A Transfer event with to = address(0) is a "withdraw" event
*/
/// @notice Emitted when a principal token holder extends the expiry of the delegate token
event ExpiryExtended(uint256 indexed delegateTokenId, uint256 previousExpiry, uint256 newExpiry);
/*//////////////////////////////////////////////////////////////
VIEW & INTROSPECTION
//////////////////////////////////////////////////////////////*/
/// @notice The v2 delegate registry address
function delegateRegistry() external view returns (address);
/// @notice The principal token deployed in tandem with this delegate token
function principalToken() external view returns (address);
/// @notice The onchain metadata contract for both DT and PT
function marketMetadata() external view returns (address);
/// @notice Image metadata location, but attributes are stored onchain
function baseURI() external view returns (string memory);
/// @notice Adapted from solmate's
/// [ERC721](https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC721.sol)
function isApprovedOrOwner(address spender, uint256 delegateTokenId) external view returns (bool);
/**
* @notice Fetches the info struct of a delegate token
* @param delegateTokenId The id of the delegateToken to query info for
* @return delegateInfo The DelegateInfo struct
*/
function getDelegateTokenInfo(uint256 delegateTokenId) external view returns (Structs.DelegateInfo memory delegateInfo);
/**
* @notice Deterministic function for generating a delegateId. Because msg.sender and freely chosen salt are fixed, no griefing
* @param creator The caller of create
* @param salt Allows the creation of a new unique id
* @return delegateId
*/
function getDelegateTokenId(address creator, uint256 salt) external view returns (uint256 delegateId);
/// @notice Returns contract-level metadata URI for OpenSea
/// (reference)[https://docs.opensea.io/docs/contract-level-metadata]
function contractURI() external view returns (string memory);
/*//////////////////////////////////////////////////////////////
STATE CHANGING
//////////////////////////////////////////////////////////////*/
/**
* @notice Create rights token pair pulling underlying token from `msg.sender`
* @param delegateInfo struct containing the details of the delegate token to be created
* @param salt A randomly chosen value, never repeated, to generate unique delegateIds for a particular `msg.sender`
* @return delegateTokenId New rights ID that is also the token ID of both the newly created principal and delegate tokens.
*/
function create(Structs.DelegateInfo calldata delegateInfo, uint256 salt) external returns (uint256 delegateTokenId);
/**
* @notice Allows the principal token owner or any approved operator to extend the expiry of the delegation rights.
* @param delegateTokenId The ID of the rights being extended.
* @param newExpiry The absolute timestamp to set the expiry
*/
function extend(uint256 delegateTokenId, uint256 newExpiry) external;
/**
* @notice Allows the delegate owner or any approved operator to return a delegate token to the principal rights holder early, allowing the principal rights holder to redeem
* the underlying token(s) early
* @param delegateTokenId Which delegate right to rescind
*/
function rescind(uint256 delegateTokenId) external;
/**
* @notice Allows principal rights owner or approved operator to withdraw the underlying token once the delegation rights have either met their expiration or been rescinded.
* Can also be called early if the caller is approved or owner of the delegate token (i.e. they wouldn't need to
* call rescind & withdraw), or approved operator of the delegate token holder
* "Burns" the delegate token, principal token, and returns the underlying tokens to the caller.
* @param delegateTokenId id of the corresponding delegate token
*/
function withdraw(uint256 delegateTokenId) external;
/**
* @notice Allows delegate token owner or approved operator to borrow their underlying tokens for the duration of a single atomic transaction
* @dev At the conclusion of the flashloan transaction, the asset must be held and approved in `msg.sender` address, not `info.receiver`
* @param info IDelegateFlashloan FlashInfo struct
*/
function flashloan(Structs.FlashInfo calldata info) external payable;
/// @notice Callback function for principal token during the create flow
function burnAuthorizedCallback() external;
/// @notice Callback function for principal token during the withdraw flow
function mintAuthorizedCallback() external;
}
Contract Source Code
File 15 of 34: IERC1155.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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;
}
Contract Source Code
File 16 of 34: IERC1155Receiver.sol
// 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);
}
Contract Source Code
File 17 of 34: IERC165.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
Contract Source Code
File 18 of 34: IERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 amount) external returns (bool);
}
Contract Source Code
File 19 of 34: IERC20Permit.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
Contract Source Code
File 20 of 34: IERC2981.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC2981.sol)
pragma solidity ^0.8.0;
import "../utils/introspection/IERC165.sol";
/**
* @dev Interface for the NFT Royalty Standard.
*
* A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
* support for royalty payments across all NFT marketplaces and ecosystem participants.
*
* _Available since v4.5._
*/
interface IERC2981 is IERC165 {
/**
* @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
* exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
*/
function royaltyInfo(
uint256 tokenId,
uint256 salePrice
) external view returns (address receiver, uint256 royaltyAmount);
}
Contract Source Code
File 21 of 34: IERC721.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the caller.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}
Contract Source Code
File 22 of 34: IERC721Metadata.sol
// 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);
}
Contract Source Code
File 23 of 34: IERC721Receiver.sol
// 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);
}
Contract Source Code
File 24 of 34: MarketMetadata.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.21;
import {DelegateTokenStructs, DelegateTokenErrors} from "./libraries/DelegateTokenLib.sol";
import {IDelegateRegistry} from "delegate-registry/src/IDelegateRegistry.sol";
import {Ownable2Step} from "openzeppelin/access/Ownable2Step.sol";
import {ERC2981} from "openzeppelin/token/common/ERC2981.sol";
import {Base64} from "openzeppelin/utils/Base64.sol";
import {Strings} from "openzeppelin/utils/Strings.sol";
contract MarketMetadata is Ownable2Step, ERC2981 {
using Strings for address;
using Strings for uint256;
string public baseURI;
string internal constant DT_NAME = "Delegate Token";
string internal constant PT_NAME = "Principal Token";
string internal constant DT_DESCRIPTION =
"The Delegate Marketplace lets you escrow your token for a chosen time period and receive a token representing its delegate rights. These tokens represent tokenized delegate rights.";
string internal constant PT_DESCRIPTION =
"The Delegate Marketplace lets you escrow your token for a chosen time period and receive a token representing its delegate rights. These tokens represents the right to claim the escrowed spot asset once the delegate token expires.";
constructor(address initialOwner, string memory initialBaseURI) {
baseURI = initialBaseURI;
_transferOwnership(initialOwner);
}
function setBaseURI(string calldata uri) external onlyOwner {
baseURI = uri;
}
function setDefaultRoyalty(address receiver, uint96 feeNumerator) external onlyOwner {
_setDefaultRoyalty(receiver, feeNumerator);
}
function deleteDefaultRoyalty() external onlyOwner {
_deleteDefaultRoyalty();
}
function delegateTokenContractURI() external view returns (string memory) {
return string.concat(baseURI, "delegateContract");
}
function principalTokenContractURI() external view returns (string memory) {
return string.concat(baseURI, "principalContract");
}
/// @dev Attributes are "collection address", "token id", "expires at", "principal owner address", "delegate status"
function delegateTokenURI(uint256 delegateTokenId, DelegateTokenStructs.DelegateInfo calldata info) external view returns (string memory) {
string memory imageUrl = string.concat(baseURI, "delegate/", delegateTokenId.toString());
// Split attributes construction into two parts to avoid stack-too-deep
string memory attributes1 = string.concat(
'[{"trait_type":"Token Type","value":"',
_tokenTypeToString(info.tokenType),
'"},{"trait_type":"Principal Holder","value":"',
info.principalHolder.toHexString(),
'"},{"trait_type":"Delegate Holder","value":"',
info.delegateHolder.toHexString(),
'"},{"trait_type":"Token Contract","value":"',
info.tokenContract.toHexString()
);
string memory attributes2 = string.concat(
'"},{"trait_type":"Token Id","value":"',
info.tokenId.toString(),
'"},{"trait_type":"Token Amount","display_type":"number","value":',
info.amount.toString(),
'},{"trait_type":"Rights","value":"',
fromSmallString(info.rights),
'"},{"trait_type":"Expiry","display_type":"date","value":',
info.expiry.toString(),
"}]"
);
string memory attributes = string.concat(attributes1, attributes2);
string memory metadataString = string.concat('{"name": "', DT_NAME, '","description":"', DT_DESCRIPTION, '","image":"', imageUrl, '","attributes":', attributes, "}");
return string.concat("data:application/json;base64,", Base64.encode(bytes(metadataString)));
}
function principalTokenURI(uint256 delegateTokenId, DelegateTokenStructs.DelegateInfo calldata info) external view returns (string memory) {
string memory imageUrl = string.concat(baseURI, "principal/", delegateTokenId.toString());
// Split attributes construction into two parts to avoid stack-too-deep
string memory attributes1 = string.concat(
'[{"trait_type":"Token Type","value":"',
_tokenTypeToString(info.tokenType),
'"},{"trait_type":"Principal Holder","value":"',
info.principalHolder.toHexString(),
'"},{"trait_type":"Delegate Holder","value":"',
info.delegateHolder.toHexString(),
'"},{"trait_type":"Token Contract","value":"',
info.tokenContract.toHexString()
);
string memory attributes2 = string.concat(
'"},{"trait_type":"Token Id","value":"',
info.tokenId.toString(),
'"},{"trait_type":"Token Amount","display_type":"number","value":',
info.amount.toString(),
'},{"trait_type":"Rights","value":"',
fromSmallString(info.rights),
'"},{"trait_type":"Expiry","display_type":"date","value":',
info.expiry.toString(),
"}]"
);
string memory attributes = string.concat(attributes1, attributes2);
string memory metadataString = string.concat('{"name": "', PT_NAME, '","description":"', PT_DESCRIPTION, '","image":"', imageUrl, '","attributes":', attributes, "}");
return string.concat("data:application/json;base64,", Base64.encode(bytes(metadataString)));
}
function _tokenTypeToString(IDelegateRegistry.DelegationType tokenType) internal pure returns (string memory) {
if (tokenType == IDelegateRegistry.DelegationType.ALL) {
return "ALL";
} else if (tokenType == IDelegateRegistry.DelegationType.CONTRACT) {
return "CONTRACT";
} else if (tokenType == IDelegateRegistry.DelegationType.ERC721) {
return "ERC721";
} else if (tokenType == IDelegateRegistry.DelegationType.ERC20) {
return "ERC20";
} else if (tokenType == IDelegateRegistry.DelegationType.ERC1155) {
return "ERC1155";
} else {
revert DelegateTokenErrors.InvalidTokenType(tokenType);
}
}
/// @dev Returns a string from a small bytes32 string.
function fromSmallString(bytes32 smallString) internal pure returns (string memory result) {
if (smallString == bytes32(0)) return result;
/// @solidity memory-safe-assembly
assembly {
result := mload(0x40)
let n
for {} 1 {} {
n := add(n, 1)
if iszero(byte(n, smallString)) { break } // Scan for '\0'.
}
mstore(result, n)
let o := add(result, 0x20)
mstore(o, smallString)
mstore(add(o, n), 0)
mstore(0x40, add(result, 0x40))
}
}
}
Contract Source Code
File 25 of 34: Math.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 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 256, 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 << 3) < value ? 1 : 0);
}
}
}
Contract Source Code
File 26 of 34: Ownable.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling 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);
}
}
Contract Source Code
File 27 of 34: Ownable2Step.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.0;
import "./Ownable.sol";
/**
* @dev Contract module which provides 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} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2Step is Ownable {
address private _pendingOwner;
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
require(pendingOwner() == sender, "Ownable2Step: caller is not the new owner");
_transferOwnership(sender);
}
}
Contract Source Code
File 28 of 34: PrincipalToken.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.21;
import {IDelegateToken} from "./interfaces/IDelegateToken.sol";
import {ERC721} from "openzeppelin-contracts/contracts/token/ERC721/ERC721.sol";
import {IERC2981} from "openzeppelin-contracts/contracts/interfaces/IERC2981.sol";
import {MarketMetadata} from "./MarketMetadata.sol";
/// @notice A simple NFT that doesn't store any user data, being tightly linked to the stateful Delegate Token.
/// @notice The holder of the PT is eligible to reclaim the escrowed NFT when the DT expires or is burned.
contract PrincipalToken is ERC721("Principal Token", "PT"), IERC2981 {
IDelegateToken public immutable delegateToken;
error DelegateTokenZero();
error CallerNotDelegateToken();
error NotApproved(address spender, uint256 id);
constructor(address _delegateToken) {
if (_delegateToken == address(0)) revert DelegateTokenZero();
delegateToken = IDelegateToken(_delegateToken);
}
function _checkDelegateTokenCaller() internal view {
if (msg.sender == address(delegateToken)) return;
revert CallerNotDelegateToken();
}
/// @notice Mints a PT if and only if the DT contract calls and has authorized
function mint(address to, uint256 id) external {
_checkDelegateTokenCaller();
_mint(to, id);
delegateToken.mintAuthorizedCallback();
}
/// @notice Burns a PT if the DT contract authorizes and the spender isApprovedOrOwner and DT owner authorizes
function burn(address spender, uint256 id) external {
_checkDelegateTokenCaller();
if (_isApprovedOrOwner(spender, id)) {
_burn(id);
delegateToken.burnAuthorizedCallback();
return;
}
revert NotApproved(spender, id);
}
function isApprovedOrOwner(address account, uint256 id) external view returns (bool) {
return _isApprovedOrOwner(account, id);
}
/// @inheritdoc IERC2981
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount) {
(receiver, royaltyAmount) = MarketMetadata(delegateToken.marketMetadata()).royaltyInfo(tokenId, salePrice);
}
function contractURI() external view returns (string memory) {
return MarketMetadata(delegateToken.marketMetadata()).principalTokenContractURI();
}
function tokenURI(uint256 id) public view override returns (string memory) {
_requireMinted(id);
return MarketMetadata(delegateToken.marketMetadata()).principalTokenURI(id, delegateToken.getDelegateTokenInfo(id));
}
}
Contract Source Code
File 29 of 34: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
}
Contract Source Code
File 30 of 34: RegistryHashes.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.21;
import {IDelegateRegistry} from "../IDelegateRegistry.sol";
/**
* @title Library for calculating the hashes and storage locations used in the delegate registry
*
* The encoding for the 5 types of delegate registry hashes should be as follows
*
* ALL: keccak256(abi.encodePacked(rights, from, to))
* CONTRACT: keccak256(abi.encodePacked(rights, from, to, contract_))
* ERC721: keccak256(abi.encodePacked(rights, from, to, contract_, tokenId))
* ERC20: keccak256(abi.encodePacked(rights, from, to, contract_))
* ERC1155: keccak256(abi.encodePacked(rights, from, to, contract_, tokenId))
*
* To avoid collisions between the hashes with respect to type, the hash is shifted left by one byte and the last byte is then encoded with a unique number for the
* delegation type.
*
*/
library RegistryHashes {
/// @dev Used to delete everything but the last byte of a 32 byte word with and(word, EXTRACT_LAST_BYTE)
uint256 internal constant EXTRACT_LAST_BYTE = 0xff;
/// @dev uint256 constant for the delegate registry delegation type enumeration, related unit test should fail if these mismatch
uint256 internal constant ALL_TYPE = 1;
uint256 internal constant CONTRACT_TYPE = 2;
uint256 internal constant ERC721_TYPE = 3;
uint256 internal constant ERC20_TYPE = 4;
uint256 internal constant ERC1155_TYPE = 5;
/// @dev uint256 constant for the location of the delegations array in the delegate registry, assumed to be zero
uint256 internal constant DELEGATION_SLOT = 0;
/**
* @notice Helper function to decode last byte of a delegation hash to obtain its delegation type
* @param inputHash to decode the type from
* @return decodedType of the delegation
* @dev function itself will not revert if decodedType > type(IDelegateRegistry.DelegationType).max
* @dev may lead to a revert with Conversion into non-existent enum type after the function is called if inputHash was encoded with type outside the DelegationType
* enum range
*/
function decodeType(bytes32 inputHash) internal pure returns (IDelegateRegistry.DelegationType decodedType) {
assembly {
decodedType := and(inputHash, EXTRACT_LAST_BYTE)
}
}
/**
* @notice Helper function that computes the storage location of a particular delegation array
* @param inputHash is the hash of the delegation
* @return computedLocation is the storage key of the delegation array at position 0
* @dev Storage keys further down the array can be obtained by adding computedLocation with the element position
* @dev Follows the solidity storage location encoding for a mapping(bytes32 => fixedArray) at the position of the delegationSlot
*/
function location(bytes32 inputHash) internal pure returns (bytes32 computedLocation) {
assembly ("memory-safe") {
// This block only allocates memory in the scratch space
mstore(0, inputHash)
mstore(32, DELEGATION_SLOT)
computedLocation := keccak256(0, 64) // Run keccak256 over bytes in scratch space to obtain the storage key
}
}
/**
* @notice Helper function to compute delegation hash for all delegation
* @param from is the address making the delegation
* @param rights it the rights specified by the delegation
* @param to is the address receiving the delegation
* @return hash of the delegation parameters encoded with ALL_TYPE
* @dev returned hash should be equivalent to keccak256(abi.encodePacked(rights, from, to)) followed by a shift left by 1 byte and writing the delegation type to the
* cleaned last byte
* @dev will not revert if from or to are > uint160, any input larger than uint160 for from and to will be cleaned to their last 20 bytes
*/
function allHash(address from, bytes32 rights, address to) internal pure returns (bytes32 hash) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer
let ptr := mload(64) // Load the free memory pointer
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
hash := or(shl(8, keccak256(ptr, 72)), ALL_TYPE) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the last
// byte
}
}
/**
* @notice Helper function to compute delegation location for all delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @return computedLocation is the storage location of the all delegation with those parameters in the delegations mapping
* @dev gives the same location hash as location(allHash(rights, from, to)) would
* @dev will not revert if from or to are > uint160, any input larger than uint160 for from and to will be cleaned to their last 20 bytes
*/
function allLocation(address from, bytes32 rights, address to) internal pure returns (bytes32 computedLocation) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer and in the scratch space
let ptr := mload(64) // Load the free memory pointer
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
mstore(0, or(shl(8, keccak256(ptr, 72)), ALL_TYPE)) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the
// last byte, and stores the result in the scratch space
mstore(32, DELEGATION_SLOT)
computedLocation := keccak256(0, 64) // Runs keccak over the scratch space to obtain the storage key
}
}
/**
* @notice Helper function to compute delegation hash for contract delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param contract_ is the address of the contract specified by the delegation
* @return hash of the delegation parameters encoded with CONTRACT_TYPE
* @dev returned hash should be equivalent to keccak256(abi.encodePacked(rights, from, to, contract_)) with the last byte overwritten with CONTRACT_TYPE
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function contractHash(address from, bytes32 rights, address to, address contract_) internal pure returns (bytes32 hash) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer
let ptr := mload(64) // Load the free memory pointer
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
hash := or(shl(8, keccak256(ptr, 92)), CONTRACT_TYPE) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the last byte
}
}
/**
* @notice Helper function to compute delegation location for contract delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param contract_ is the address of the contract specified by the delegation
* @return computedLocation is the storage location of the contract delegation with those parameters in the delegations mapping
* @dev gives the same location hash as location(contractHash(rights, from, to, contract_)) would
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function contractLocation(address from, bytes32 rights, address to, address contract_) internal pure returns (bytes32 computedLocation) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer and in the scratch space
let ptr := mload(64) // Load free memory pointer
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
mstore(0, or(shl(8, keccak256(ptr, 92)), CONTRACT_TYPE)) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the
// last byte, and stores the result in the scratch space
mstore(32, DELEGATION_SLOT)
computedLocation := keccak256(0, 64) // Runs keccak over the scratch space to obtain the storage key
}
}
/**
* @notice Helper function to compute delegation hash for ERC721 delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param tokenId is the id of the token specified by the delegation
* @param contract_ is the address of the contract specified by the delegation
* @return hash of the parameters encoded with ERC721_TYPE
* @dev returned hash should be equivalent to keccak256(abi.encodePacked(rights, from, to, contract_, tokenId)) with the last byte overwritten with ERC721_TYPE
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function erc721Hash(address from, bytes32 rights, address to, uint256 tokenId, address contract_) internal pure returns (bytes32 hash) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer
let ptr := mload(64) // Cache the free memory pointer.
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 92), tokenId)
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
hash := or(shl(8, keccak256(ptr, 124)), ERC721_TYPE) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the last byte
}
}
/**
* @notice Helper function to compute delegation location for ERC721 delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param tokenId is the id of the erc721 token
* @param contract_ is the address of the erc721 token contract
* @return computedLocation is the storage location of the erc721 delegation with those parameters in the delegations mapping
* @dev gives the same location hash as location(erc721Hash(rights, from, to, contract_, tokenId)) would
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function erc721Location(address from, bytes32 rights, address to, uint256 tokenId, address contract_) internal pure returns (bytes32 computedLocation) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer and in the scratch space
let ptr := mload(64) // Cache the free memory pointer.
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 92), tokenId)
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
mstore(0, or(shl(8, keccak256(ptr, 124)), ERC721_TYPE)) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the
// last byte, and stores the result in the scratch space
mstore(32, DELEGATION_SLOT)
computedLocation := keccak256(0, 64) // Runs keccak256 over the scratch space to obtain the storage key
}
}
/**
* @notice Helper function to compute delegation hash for ERC20 delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param contract_ is the address of the erc20 token contract
* @return hash of the parameters encoded with ERC20_TYPE
* @dev returned hash should be equivalent to keccak256(abi.encodePacked(rights, from, to, contract_)) with the last byte overwritten with ERC20_TYPE
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function erc20Hash(address from, bytes32 rights, address to, address contract_) internal pure returns (bytes32 hash) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer
let ptr := mload(64) // Load free memory pointer
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
hash := or(shl(8, keccak256(ptr, 92)), ERC20_TYPE) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the last byte
}
}
/**
* @notice Helper function to compute delegation location for ERC20 delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param contract_ is the address of the erc20 token contract
* @return computedLocation is the storage location of the erc20 delegation with those parameters in the delegations mapping
* @dev gives the same location hash as location(erc20Hash(rights, from, to, contract_)) would
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function erc20Location(address from, bytes32 rights, address to, address contract_) internal pure returns (bytes32 computedLocation) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer and in the scratch space
let ptr := mload(64) // Loads the free memory pointer
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
mstore(0, or(shl(8, keccak256(ptr, 92)), ERC20_TYPE)) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the
// last byte, and stores the result in the scratch space
mstore(32, DELEGATION_SLOT)
computedLocation := keccak256(0, 64) // Runs keccak over the scratch space to obtain the storage key
}
}
/**
* @notice Helper function to compute delegation hash for ERC1155 delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param tokenId is the id of the erc1155 token
* @param contract_ is the address of the erc1155 token contract
* @return hash of the parameters encoded with ERC1155_TYPE
* @dev returned hash should be equivalent to keccak256(abi.encodePacked(rights, from, to, contract_, tokenId)) with the last byte overwritten with ERC1155_TYPE
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function erc1155Hash(address from, bytes32 rights, address to, uint256 tokenId, address contract_) internal pure returns (bytes32 hash) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer
let ptr := mload(64) // Load the free memory pointer.
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 92), tokenId)
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
hash := or(shl(8, keccak256(ptr, 124)), ERC1155_TYPE) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the last byte
}
}
/**
* @notice Helper function to compute delegation hash for ERC1155 delegation
* @param from is the address making the delegation
* @param rights is the rights specified by the delegation
* @param to is the address receiving the delegation
* @param tokenId is the id of the erc1155 token
* @param contract_ is the address of the erc1155 token contract
* @return computedLocation is the storage location of the erc1155 delegation with those parameters in the delegations mapping
* @dev gives the same location hash as location(erc1155Hash(rights, from, to, contract_, tokenId)) would
* @dev will not revert if from, to, or contract_ are > uint160, any input larger than uint160 for from, to, or contract_ will be cleaned to their last 20 bytes
*/
function erc1155Location(address from, bytes32 rights, address to, uint256 tokenId, address contract_) internal pure returns (bytes32 computedLocation) {
assembly ("memory-safe") {
// This block only allocates memory after the free memory pointer and in the scratch space
let ptr := mload(64) // Cache the free memory pointer.
// Layout the variables from last to first, agnostic to upper 96 bits of address words.
mstore(add(ptr, 92), tokenId)
mstore(add(ptr, 60), contract_)
mstore(add(ptr, 40), to)
mstore(add(ptr, 20), from)
mstore(ptr, rights)
mstore(0, or(shl(8, keccak256(ptr, 124)), ERC1155_TYPE)) // Runs keccak over the packed encoding, shifts left by one byte, then writes the type to the
// last byte, and stores the result in the scratch space
mstore(32, DELEGATION_SLOT)
computedLocation := keccak256(0, 64) // Runs keccak over the scratch space to obtain the storage key
}
}
}
Contract Source Code
File 31 of 34: RegistryStorage.sol
// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.21;
library RegistryStorage {
/// @dev Standardizes from storage flags to prevent double-writes in the delegation in/outbox if the same delegation is revoked and rewritten
address internal constant DELEGATION_EMPTY = address(0);
address internal constant DELEGATION_REVOKED = address(1);
/// @dev Standardizes storage positions of delegation data
uint256 internal constant POSITIONS_FIRST_PACKED = 0; // | 4 bytes empty | first 8 bytes of contract address | 20 bytes of from address |
uint256 internal constant POSITIONS_SECOND_PACKED = 1; // | last 12 bytes of contract address | 20 bytes of to address |
uint256 internal constant POSITIONS_RIGHTS = 2;
uint256 internal constant POSITIONS_TOKEN_ID = 3;
uint256 internal constant POSITIONS_AMOUNT = 4;
/// @dev Used to clean address types of dirty bits with and(address, CLEAN_ADDRESS)
uint256 internal constant CLEAN_ADDRESS = 0x00ffffffffffffffffffffffffffffffffffffffff;
/// @dev Used to clean everything but the first 8 bytes of an address
uint256 internal constant CLEAN_FIRST8_BYTES_ADDRESS = 0xffffffffffffffff << 96;
/// @dev Used to clean everything but the first 8 bytes of an address in the packed position
uint256 internal constant CLEAN_PACKED8_BYTES_ADDRESS = 0xffffffffffffffff << 160;
/**
* @notice Helper function that packs from, to, and contract_ address to into the two slot configuration
* @param from The address making the delegation
* @param to The address receiving the delegation
* @param contract_ The contract address associated with the delegation (optional)
* @return firstPacked The firstPacked storage configured with the parameters
* @return secondPacked The secondPacked storage configured with the parameters
* @dev Will not revert if from, to, and contract_ are > uint160, any inputs with dirty bits outside the last 20 bytes will be cleaned
*/
function packAddresses(address from, address to, address contract_) internal pure returns (bytes32 firstPacked, bytes32 secondPacked) {
assembly {
firstPacked := or(shl(64, and(contract_, CLEAN_FIRST8_BYTES_ADDRESS)), and(from, CLEAN_ADDRESS))
secondPacked := or(shl(160, contract_), and(to, CLEAN_ADDRESS))
}
}
/**
* @notice Helper function that unpacks from, to, and contract_ address inside the firstPacked secondPacked storage configuration
* @param firstPacked The firstPacked storage to be decoded
* @param secondPacked The secondPacked storage to be decoded
* @return from The address making the delegation
* @return to The address receiving the delegation
* @return contract_ The contract address associated with the delegation
* @dev Will not revert if from, to, and contract_ are > uint160, any inputs with dirty bits outside the last 20 bytes will be cleaned
*/
function unpackAddresses(bytes32 firstPacked, bytes32 secondPacked) internal pure returns (address from, address to, address contract_) {
assembly {
from := and(firstPacked, CLEAN_ADDRESS)
to := and(secondPacked, CLEAN_ADDRESS)
contract_ := or(shr(64, and(firstPacked, CLEAN_PACKED8_BYTES_ADDRESS)), shr(160, secondPacked))
}
}
/**
* @notice Helper function that can unpack the from or to address from their respective packed slots in the registry
* @param packedSlot The slot containing the from or to address
* @return unpacked The `from` or `to` address
* @dev Will not work if you want to obtain the contract address, use unpackAddresses
*/
function unpackAddress(bytes32 packedSlot) internal pure returns (address unpacked) {
assembly {
unpacked := and(packedSlot, CLEAN_ADDRESS)
}
}
}
Contract Source Code
File 32 of 34: SafeERC20.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/IERC20Permit.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20 token, address spender, uint256 value) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return
success && (returndata.length == 0 || abi.decode(returndata, (bool))) && Address.isContract(address(token));
}
}
Contract Source Code
File 33 of 34: SignedMath.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}
Contract Source Code
File 34 of 34: Strings.sol
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
import "./math/Math.sol";
import "./math/SignedMath.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 `int256` to its ASCII `string` decimal representation.
*/
function toString(int256 value) internal pure returns (string memory) {
return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMath.abs(value))));
}
/**
* @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);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return keccak256(bytes(a)) == keccak256(bytes(b));
}
}
Settings
{
"compilationTarget": {
"src/DelegateToken.sol": "DelegateToken"
},
"evmVersion": "shanghai",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 9999999
},
"remappings": [
":@rari-capital/solmate/=lib/seaport/lib/solmate/",
":delegate-registry/=lib/delegate-registry/",
":ds-test/=lib/forge-std/lib/ds-test/src/",
":erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/",
":forge-std/=lib/forge-std/src/",
":murky/=lib/murky/src/",
":openzeppelin-contracts/=lib/openzeppelin-contracts/",
":openzeppelin/=lib/openzeppelin-contracts/contracts/",
":seaport-core/=lib/seaport/contracts/",
":seaport-sol/=lib/seaport/contracts/helpers/sol/",
":seaport/=lib/seaport/",
":solady/=lib/seaport/lib/solady/",
":solarray/=lib/seaport/lib/solarray/src/",
":solmate/=lib/seaport/lib/solmate/src/"
]
}ABI
[{"inputs":[{"internalType":"address","name":"_delegateRegistry","type":"address"},{"internalType":"address","name":"_principalToken","type":"address"},{"internalType":"address","name":"_marketMetadata","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"AlreadyExisted","type":"error"},{"inputs":[],"name":"BatchERC1155TransferUnsupported","type":"error"},{"inputs":[],"name":"BurnAuthorized","type":"error"},{"inputs":[],"name":"BurnNotAuthorized","type":"error"},{"inputs":[],"name":"CallerNotOwnerOrInvalidToken","type":"error"},{"inputs":[],"name":"CallerNotPrincipalToken","type":"error"},{"inputs":[],"name":"DelegateTokenHolderZero","type":"error"},{"inputs":[],"name":"ERC1155FlashAmountUnavailable","type":"error"},{"inputs":[],"name":"ERC1155NotPulled","type":"error"},{"inputs":[{"internalType":"address","name":"operator","type":"address"}],"name":"ERC1155PullNotRequested","type":"error"},{"inputs":[],"name":"ERC1155Pulled","type":"error"},{"inputs":[],"name":"ERC20FlashAmountUnavailable","type":"error"},{"inputs":[],"name":"ERC721FlashUnavailable","type":"error"},{"inputs":[],"name":"ExpiryInPast","type":"error"},{"inputs":[],"name":"ExpiryTooLarge","type":"error"},{"inputs":[],"name":"ExpiryTooSmall","type":"error"},{"inputs":[],"name":"FromNotDelegateTokenHolder","type":"error"},{"inputs":[],"name":"HashMismatch","type":"error"},{"inputs":[],"name":"InsufficientAllowanceOrInvalidToken","type":"error"},{"inputs":[],"name":"InvalidERC721TransferOperator","type":"error"},{"inputs":[],"name":"InvalidFlashloan","type":"error"},{"inputs":[{"internalType":"enum IDelegateRegistry.DelegationType","name":"tokenType","type":"uint8"}],"name":"InvalidTokenType","type":"error"},{"inputs":[],"name":"MintAuthorized","type":"error"},{"inputs":[],"name":"MintNotAuthorized","type":"error"},{"inputs":[],"name":"MulticallFailed","type":"error"},{"inputs":[{"internalType":"address","name":"caller","type":"address"},{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"NotApproved","type":"error"},{"inputs":[],"name":"NotERC721Receiver","type":"error"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"NotMinted","type":"error"},{"inputs":[{"internalType":"address","name":"caller","type":"address"},{"internalType":"address","name":"account","type":"address"}],"name":"NotOperator","type":"error"},{"inputs":[{"internalType":"address","name":"caller","type":"address"},{"internalType":"address","name":"account","type":"address"}],"name":"NotOwner","type":"error"},{"inputs":[],"name":"ToIsZero","type":"error"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"},{"internalType":"uint256","name":"expiry","type":"uint256"},{"internalType":"uint256","name":"timestamp","type":"uint256"}],"name":"WithdrawNotAvailable","type":"error"},{"inputs":[{"internalType":"enum IDelegateRegistry.DelegationType","name":"tokenType","type":"uint8"},{"internalType":"uint256","name":"wrongAmount","type":"uint256"}],"name":"WrongAmountForType","type":"error"},{"inputs":[{"internalType":"enum IDelegateRegistry.DelegationType","name":"tokenType","type":"uint8"},{"internalType":"uint256","name":"wrongTokenId","type":"uint256"}],"name":"WrongTokenIdForType","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"approved","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"delegateTokenId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"previousExpiry","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newExpiry","type":"uint256"}],"name":"ExpiryExtended","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"approve","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"delegateTokenHolder","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"baseURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"burnAuthorizedCallback","outputs":[],"stateMutability":"view","type":"function"},{"inputs":[],"name":"contractURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"principalHolder","type":"address"},{"internalType":"enum IDelegateRegistry.DelegationType","name":"tokenType","type":"uint8"},{"internalType":"address","name":"delegateHolder","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"address","name":"tokenContract","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bytes32","name":"rights","type":"bytes32"},{"internalType":"uint256","name":"expiry","type":"uint256"}],"internalType":"struct DelegateTokenStructs.DelegateInfo","name":"delegateInfo","type":"tuple"},{"internalType":"uint256","name":"salt","type":"uint256"}],"name":"create","outputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"delegateRegistry","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"},{"internalType":"uint256","name":"newExpiry","type":"uint256"}],"name":"extend","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"receiver","type":"address"},{"internalType":"address","name":"delegateHolder","type":"address"},{"internalType":"enum IDelegateRegistry.DelegationType","name":"tokenType","type":"uint8"},{"internalType":"address","name":"tokenContract","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"internalType":"struct DelegateTokenStructs.FlashInfo","name":"info","type":"tuple"}],"name":"flashloan","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"getApproved","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"caller","type":"address"},{"internalType":"uint256","name":"salt","type":"uint256"}],"name":"getDelegateTokenId","outputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"getDelegateTokenInfo","outputs":[{"components":[{"internalType":"address","name":"principalHolder","type":"address"},{"internalType":"enum IDelegateRegistry.DelegationType","name":"tokenType","type":"uint8"},{"internalType":"address","name":"delegateHolder","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"address","name":"tokenContract","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bytes32","name":"rights","type":"bytes32"},{"internalType":"uint256","name":"expiry","type":"uint256"}],"internalType":"struct DelegateTokenStructs.DelegateInfo","name":"delegateInfo","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"isApprovedOrOwner","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"marketMetadata","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"mintAuthorizedCallback","outputs":[],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes[]","name":"data","type":"bytes[]"}],"name":"multicall","outputs":[{"internalType":"bytes[]","name":"results","type":"bytes[]"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256[]","name":"","type":"uint256[]"},{"internalType":"uint256[]","name":"","type":"uint256[]"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155BatchReceived","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC721Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"ownerOf","outputs":[{"internalType":"address","name":"delegateTokenHolder","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"principalToken","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"rescind","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"salePrice","type":"uint256"}],"name":"royaltyInfo","outputs":[{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"royaltyAmount","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"delegateTokenId","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"tokenURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"transferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"delegateTokenId","type":"uint256"}],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"}]
