// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @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;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "./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);
* }
* ```
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.20;
import {IERC721} from "./IERC721.sol";
import {IERC721Receiver} from "./IERC721Receiver.sol";
import {IERC721Metadata} from "./extensions/IERC721Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {Strings} from "../../utils/Strings.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {IERC721Errors} from "../../interfaces/draft-IERC6093.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}.
*/
abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Errors {
using Strings for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
mapping(uint256 tokenId => address) private _owners;
mapping(address owner => uint256) private _balances;
mapping(uint256 tokenId => address) private _tokenApprovals;
mapping(address owner => mapping(address operator => 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 returns (uint256) {
if (owner == address(0)) {
revert ERC721InvalidOwner(address(0));
}
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId) public view virtual returns (address) {
return _requireOwned(tokenId);
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId) public view virtual returns (string memory) {
_requireOwned(tokenId);
string memory baseURI = _baseURI();
return bytes(baseURI).length > 0 ? string.concat(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 {
_approve(to, tokenId, _msgSender());
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId) public view virtual returns (address) {
_requireOwned(tokenId);
return _getApproved(tokenId);
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved) public virtual {
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(address from, address to, uint256 tokenId) public virtual {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
// Setting an "auth" arguments enables the `_isAuthorized` check which verifies that the token exists
// (from != 0). Therefore, it is not needed to verify that the return value is not 0 here.
address previousOwner = _update(to, tokenId, _msgSender());
if (previousOwner != from) {
revert ERC721IncorrectOwner(from, tokenId, previousOwner);
}
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) public {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual {
transferFrom(from, to, tokenId);
_checkOnERC721Received(from, to, tokenId, data);
}
/**
* @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
*
* IMPORTANT: Any overrides to this function that add ownership of tokens not tracked by the
* core ERC721 logic MUST be matched with the use of {_increaseBalance} to keep balances
* consistent with ownership. The invariant to preserve is 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`.
*/
function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
return _owners[tokenId];
}
/**
* @dev Returns the approved address for `tokenId`. Returns 0 if `tokenId` is not minted.
*/
function _getApproved(uint256 tokenId) internal view virtual returns (address) {
return _tokenApprovals[tokenId];
}
/**
* @dev Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
* particular (ignoring whether it is owned by `owner`).
*
* WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
* assumption.
*/
function _isAuthorized(address owner, address spender, uint256 tokenId) internal view virtual returns (bool) {
return
spender != address(0) &&
(owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender);
}
/**
* @dev Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
* Reverts if `spender` does not have approval from the provided `owner` for the given token or for all its assets
* the `spender` for the specific `tokenId`.
*
* WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
* assumption.
*/
function _checkAuthorized(address owner, address spender, uint256 tokenId) internal view virtual {
if (!_isAuthorized(owner, spender, tokenId)) {
if (owner == address(0)) {
revert ERC721NonexistentToken(tokenId);
} else {
revert ERC721InsufficientApproval(spender, tokenId);
}
}
}
/**
* @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
*
* NOTE: the value is limited to type(uint128).max. This protect against _balance overflow. It is unrealistic that
* a uint256 would ever overflow from increments when these increments are bounded to uint128 values.
*
* WARNING: Increasing an account's balance using this function tends to be paired with an override of the
* {_ownerOf} function to resolve the ownership of the corresponding tokens so that balances and ownership
* remain consistent with one another.
*/
function _increaseBalance(address account, uint128 value) internal virtual {
unchecked {
_balances[account] += value;
}
}
/**
* @dev Transfers `tokenId` from its current owner to `to`, or alternatively mints (or burns) if the current owner
* (or `to`) is the zero address. Returns the owner of the `tokenId` before the update.
*
* The `auth` argument is optional. If the value passed is non 0, then this function will check that
* `auth` is either the owner of the token, or approved to operate on the token (by the owner).
*
* Emits a {Transfer} event.
*
* NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
*/
function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
address from = _ownerOf(tokenId);
// Perform (optional) operator check
if (auth != address(0)) {
_checkAuthorized(from, auth, tokenId);
}
// Execute the update
if (from != address(0)) {
// Clear approval. No need to re-authorize or emit the Approval event
_approve(address(0), tokenId, address(0), false);
unchecked {
_balances[from] -= 1;
}
}
if (to != address(0)) {
unchecked {
_balances[to] += 1;
}
}
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
return from;
}
/**
* @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 {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
address previousOwner = _update(to, tokenId, address(0));
if (previousOwner != address(0)) {
revert ERC721InvalidSender(address(0));
}
}
/**
* @dev Mints `tokenId`, transfers it to `to` and checks for `to` acceptance.
*
* 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 {
_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);
_checkOnERC721Received(address(0), to, tokenId, data);
}
/**
* @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 {
address previousOwner = _update(address(0), tokenId, address(0));
if (previousOwner == address(0)) {
revert ERC721NonexistentToken(tokenId);
}
}
/**
* @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 {
if (to == address(0)) {
revert ERC721InvalidReceiver(address(0));
}
address previousOwner = _update(to, tokenId, address(0));
if (previousOwner == address(0)) {
revert ERC721NonexistentToken(tokenId);
} else if (previousOwner != from) {
revert ERC721IncorrectOwner(from, tokenId, previousOwner);
}
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking that contract recipients
* are aware of the ERC721 standard 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 like {safeTransferFrom} in the sense that it invokes
* {IERC721Receiver-onERC721Received} on the receiver, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `tokenId` token must exist and be owned by `from`.
* - `to` cannot be the zero address.
* - `from` cannot be the zero address.
* - 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) internal {
_safeTransfer(from, to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeTransfer-address-address-uint256-}[`_safeTransfer`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
_transfer(from, to, tokenId);
_checkOnERC721Received(from, to, tokenId, data);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* The `auth` argument is optional. If the value passed is non 0, then this function will check that `auth` is
* either the owner of the token, or approved to operate on all tokens held by this owner.
*
* Emits an {Approval} event.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address to, uint256 tokenId, address auth) internal {
_approve(to, tokenId, auth, true);
}
/**
* @dev Variant of `_approve` with an optional flag to enable or disable the {Approval} event. The event is not
* emitted in the context of transfers.
*/
function _approve(address to, uint256 tokenId, address auth, bool emitEvent) internal virtual {
// Avoid reading the owner unless necessary
if (emitEvent || auth != address(0)) {
address owner = _requireOwned(tokenId);
// We do not use _isAuthorized because single-token approvals should not be able to call approve
if (auth != address(0) && owner != auth && !isApprovedForAll(owner, auth)) {
revert ERC721InvalidApprover(auth);
}
if (emitEvent) {
emit Approval(owner, to, tokenId);
}
}
_tokenApprovals[tokenId] = to;
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Requirements:
* - operator can't be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
if (operator == address(0)) {
revert ERC721InvalidOperator(operator);
}
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
* Returns the owner.
*
* Overrides to ownership logic should be done to {_ownerOf}.
*/
function _requireOwned(uint256 tokenId) internal view returns (address) {
address owner = _ownerOf(tokenId);
if (owner == address(0)) {
revert ERC721NonexistentToken(tokenId);
}
return owner;
}
/**
* @dev Private function to invoke {IERC721Receiver-onERC721Received} on a target address. This will revert if the
* recipient doesn't accept the token transfer. 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
*/
function _checkOnERC721Received(address from, address to, uint256 tokenId, bytes memory data) private {
if (to.code.length > 0) {
try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
if (retval != IERC721Receiver.onERC721Received.selector) {
revert ERC721InvalidReceiver(to);
}
} catch (bytes memory reason) {
if (reason.length == 0) {
revert ERC721InvalidReceiver(to);
} else {
/// @solidity memory-safe-assembly
assembly {
revert(add(32, reason), mload(reason))
}
}
}
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/ERC721Enumerable.sol)
pragma solidity ^0.8.20;
import {ERC721} from "../ERC721.sol";
import {IERC721Enumerable} from "./IERC721Enumerable.sol";
import {IERC165} from "../../../utils/introspection/ERC165.sol";
/**
* @dev This implements an optional extension of {ERC721} defined in the EIP that adds enumerability
* of all the token ids in the contract as well as all token ids owned by each account.
*
* CAUTION: `ERC721` extensions that implement custom `balanceOf` logic, such as `ERC721Consecutive`,
* interfere with enumerability and should not be used together with `ERC721Enumerable`.
*/
abstract contract ERC721Enumerable is ERC721, IERC721Enumerable {
mapping(address owner => mapping(uint256 index => uint256)) private _ownedTokens;
mapping(uint256 tokenId => uint256) private _ownedTokensIndex;
uint256[] private _allTokens;
mapping(uint256 tokenId => uint256) private _allTokensIndex;
/**
* @dev An `owner`'s token query was out of bounds for `index`.
*
* NOTE: The owner being `address(0)` indicates a global out of bounds index.
*/
error ERC721OutOfBoundsIndex(address owner, uint256 index);
/**
* @dev Batch mint is not allowed.
*/
error ERC721EnumerableForbiddenBatchMint();
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721) returns (bool) {
return interfaceId == type(IERC721Enumerable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
*/
function tokenOfOwnerByIndex(address owner, uint256 index) public view virtual returns (uint256) {
if (index >= balanceOf(owner)) {
revert ERC721OutOfBoundsIndex(owner, index);
}
return _ownedTokens[owner][index];
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
return _allTokens.length;
}
/**
* @dev See {IERC721Enumerable-tokenByIndex}.
*/
function tokenByIndex(uint256 index) public view virtual returns (uint256) {
if (index >= totalSupply()) {
revert ERC721OutOfBoundsIndex(address(0), index);
}
return _allTokens[index];
}
/**
* @dev See {ERC721-_update}.
*/
function _update(address to, uint256 tokenId, address auth) internal virtual override returns (address) {
address previousOwner = super._update(to, tokenId, auth);
if (previousOwner == address(0)) {
_addTokenToAllTokensEnumeration(tokenId);
} else if (previousOwner != to) {
_removeTokenFromOwnerEnumeration(previousOwner, tokenId);
}
if (to == address(0)) {
_removeTokenFromAllTokensEnumeration(tokenId);
} else if (previousOwner != to) {
_addTokenToOwnerEnumeration(to, tokenId);
}
return previousOwner;
}
/**
* @dev Private function to add a token to this extension's ownership-tracking data structures.
* @param to address representing the new owner of the given token ID
* @param tokenId uint256 ID of the token to be added to the tokens list of the given address
*/
function _addTokenToOwnerEnumeration(address to, uint256 tokenId) private {
uint256 length = balanceOf(to) - 1;
_ownedTokens[to][length] = tokenId;
_ownedTokensIndex[tokenId] = length;
}
/**
* @dev Private function to add a token to this extension's token tracking data structures.
* @param tokenId uint256 ID of the token to be added to the tokens list
*/
function _addTokenToAllTokensEnumeration(uint256 tokenId) private {
_allTokensIndex[tokenId] = _allTokens.length;
_allTokens.push(tokenId);
}
/**
* @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that
* while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for
* gas optimizations e.g. when performing a transfer operation (avoiding double writes).
* This has O(1) time complexity, but alters the order of the _ownedTokens array.
* @param from address representing the previous owner of the given token ID
* @param tokenId uint256 ID of the token to be removed from the tokens list of the given address
*/
function _removeTokenFromOwnerEnumeration(address from, uint256 tokenId) private {
// To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = balanceOf(from);
uint256 tokenIndex = _ownedTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary
if (tokenIndex != lastTokenIndex) {
uint256 lastTokenId = _ownedTokens[from][lastTokenIndex];
_ownedTokens[from][tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
}
// This also deletes the contents at the last position of the array
delete _ownedTokensIndex[tokenId];
delete _ownedTokens[from][lastTokenIndex];
}
/**
* @dev Private function to remove a token from this extension's token tracking data structures.
* This has O(1) time complexity, but alters the order of the _allTokens array.
* @param tokenId uint256 ID of the token to be removed from the tokens list
*/
function _removeTokenFromAllTokensEnumeration(uint256 tokenId) private {
// To prevent a gap in the tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = _allTokens.length - 1;
uint256 tokenIndex = _allTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary. However, since this occurs so
// rarely (when the last minted token is burnt) that we still do the swap here to avoid the gas cost of adding
// an 'if' statement (like in _removeTokenFromOwnerEnumeration)
uint256 lastTokenId = _allTokens[lastTokenIndex];
_allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
// This also deletes the contents at the last position of the array
delete _allTokensIndex[tokenId];
_allTokens.pop();
}
/**
* See {ERC721-_increaseBalance}. We need that to account tokens that were minted in batch
*/
function _increaseBalance(address account, uint128 amount) internal virtual override {
if (amount > 0) {
revert ERC721EnumerableForbiddenBatchMint();
}
super._increaseBalance(account, amount);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @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);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../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 address zero.
*
* 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);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/IERC721Enumerable.sol)
pragma solidity ^0.8.20;
import {IERC721} from "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Enumerable is IERC721 {
/**
* @dev Returns the total amount of tokens stored by the contract.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns a token ID owned by `owner` at a given `index` of its token list.
* Use along with {balanceOf} to enumerate all of ``owner``'s tokens.
*/
function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);
/**
* @dev Returns a token ID at a given `index` of all the tokens stored by the contract.
* Use along with {totalSupply} to enumerate all tokens.
*/
function tokenByIndex(uint256 index) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.20;
import {IERC721} from "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721Receiver.sol)
pragma solidity ^0.8.20;
/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/
interface IERC721Receiver {
/**
* @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
* by `operator` from `from`, this function is called.
*
* It must return its Solidity selector to confirm the token transfer.
* If any other value is returned or the interface is not implemented by the recipient, the transfer will be
* reverted.
*
* The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}
// SPDX-License-Identifier: MIT OR Apache-2
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/interfaces/IERC721Metadata.sol";
import "@openzeppelin/contracts/interfaces/IERC721Enumerable.sol";
// The contract for representing Infrastructure Units
// (cjdns nodes, domains VPNs, nameservers, and route servers)
// This contract is essentially declarative. You can enter anything you want and
// it will only really have effect after it's checked if the unit is actually operational.
// Each Unit is an NFT so once you create one, you can administer it.
// The contract is also Ownable and the owner can:
// 1. Nominate "trusted" contracts which can act on others' behalf.
// 2. Set the base URI for the NFT images.
//
interface IInfra is IERC721Metadata, IERC721Enumerable {
// The type of the infra unit
enum UnitType {
// Unit type zero is not valid
Invalid,
// Cjdns public peer with VPN disabled
Cjdns,
// Cjdns VPN with public peering disabled
Vpn,
// Cjdns public peer with VPN enabled
CjdnsVpn,
// Cjdns private node with VPN disabled (does not yield)
PrivateCjdns,
// Public domain name (e.g. pkt.wiki)
Domain,
// Domain name which is willing to resolve blacklisted domains
DomainDangerous,
// Nameserver
Nameserver,
// Route Server
RouteServer,
// Invalid item
InvalidTooHigh
}
// The structure which represents an infra unit
struct Unit {
// For cjdns/vpn/nameserver/routeserver
// * Non-zero = the domain to hang this node off of
// * Zero = .no-name.pkt special domain
// For domains -> Always zero
uint64 parentDomain;
// The type of the unit
UnitType unitType;
// For cjdns/vpn/nameserver/routeserver -> The hostname/subdomain
// For domains -> The FQDN
string name;
}
/**
* Emitted when a new unit is registered, anyone can cause this to be emitted
* it does NOT mean any infrastructure actually exists.
* @param sender The address which make the call
* @param newId The ID of the new unit
* @param creator Who invoked the function
* @param recipient Who will receive the NFT of the unit and therefore yield on it
* @param t The type of the unit
* @param parentDomain The ID of the domain which the unit is associated with (0 = none)
* @param name The name of the unit
*/
event RegisterUnit(address sender, uint newId, address creator, address recipient, UnitType t,
uint64 parentDomain, string name);
/**
* Emitted when someone updates some data about their infra unit.
* @param sender The address which make the call
* @param id The ID of the updated unit
* @param updateMask A bitmask of items which are being updated,
* see: Infra.UPDATE_TYPE, Infra.UPDATE_DOMAIN, Infra.UPDATE_NAME
* @param t The unit type to change to, if applicable
* @param parentDomain The new parent domain, if applicable
* @param name The name to change to, if applicable
*/
event UpdateUnit(address sender, uint id, uint8 updateMask, UnitType t, uint64 parentDomain, string name);
/// Emitted when a unit is deleted
///
/// @param sender The address which make the call
/// @param id The ID of the unit to be deleted
event DeleteUnit(address sender, uint id);
/// The unit got evicted by the domain holder.
///
/// @param sender The address which made the call
/// @param id The ID of the unit that was evicted
event DomainEvict(address sender, uint id);
// Create/Update/Delete
/**
* Register a new unit.
* Anyone can call this, it does not imply that the underlying infrastructure actually exists.
*
* @param t The type of the unit to register.
* @param parentDomain The parent domain (0 = none), the caller must have authorization to
* manipulate this domain, or if the caller is a trusted contract, the
* recipient (to) must have same authority instead.
* @param name The name / subdomain of the unit.
* @param to Who will receive the resulting NFT and begin yielding on the infra unit.
* @return The ID of the unit.
*/
function registerUnit(
UnitType t,
uint64 parentDomain,
string calldata name,
address to
) external returns (uint);
/**
* Update data about an infra unit.
*
* @param id The ID of the unit to update, the caller must be authoritative over the unit.
* If the caller is a trusted contract (see trustContract()) then onBehalfOf may
* be substituted.
* @param update The bitmask of fields to update
* see: Infra.UPDATE_TYPE, Infra.UPDATE_DOMAIN, Infra.UPDATE_NAME
* @param t The type to change the item to, if applicable
* @param parentDomain The parent domain to set, if applicable. The caller (or onBehalfOf) must
* be authoritative over the domain in order to set it.
* @param name The subdomain / name of the unit.
* @param onBehalfOf If called from a trusted contract, authority to alter the Unit and associate
* with the parentDomain will be based on this address, otherwise it is based on
* the caller. If you're not a trusted contract, just pass zero.
*/
function updateUnit(
uint id,
uint8 update,
UnitType t,
uint64 parentDomain,
string calldata name,
address onBehalfOf
) external;
/**
* Delete a unit.
*
* @param id The ID of the unit to delete.
* @param onBehalfOf If this is being called by a trusted contract, this is the address to
* impersonate, otherwise you may ignore it and pass address(0).
*/
function deleteUnit(uint id, address onBehalfOf) external;
/**
* Evict a unit from being associated with your parentDomain.
* This can be called by the owner of the domain, even if they do not have authority over the unit.
* A possible reason why a domain holder would not have authority over the unit is because either
* the domain, or the unit, was transferred. This allows the domain holder to evict the unit so it
* will not affect their domain.
*
* @param id The ID of the unit to evict.
*/
function domainEviction(uint id) external;
// Read
/**
* Get a single unit by ID.
*
* @param id The ID of the unit to get.
* @return t The type of the unit, if zero then this unit does not exist.
* @return parentDomain The parent domain of the unit.
* @return name The name of the unit.
* @return owner The owner of the unit.
*/
function getUnit(uint id) external view returns (
UnitType t,
uint64 parentDomain,
string memory name,
address owner
);
/**
* Get multiple units by ID.
*
* @param ids An array of the IDs of units to get.
* @return out An array of the resulting units.
* @return owners An array of the owners of units, address(0) means there is a unit that was deleted.
*/
function getUnits(
uint[] calldata ids
) external view returns (
Unit[] memory out,
address[] memory owners
);
/**
* Check whether an address is considered a trusted contract.
* Trusted addresses can impersonate other addresses for the purpose of the
* registerUnit() updateUnit() and deleteUnit() functions.
*
* @param c The address to check
* @return trusted whether or not the address is trusted to impersonate others
*/
function isTrustedContract(address c) external view returns (bool trusted);
/**
* @return The next higher Unit id to issue
*/
function nextId() external view returns (uint);
/**
* Access the free list of unit IDs.
*
* @param last The last ID, if zero then this gives the list head
* @return id The next ID in the list
*/
function idFreeList(uint64 last) external view returns (uint id);
// Administrative
/**
* Update the URI prefix for rendering of NFT images.
* Can only be called by the owner of the contract.
*
* @param pfx New URI prefix.
*/
function setUriPrefix(string calldata pfx) external;
/**
* Set the trusted status of an address. Trusted addresses (contracts) can impersonate other
* addresses for the purpose of the registerUnit() updateUnit() and deleteUnit() functions.
*
* @param c The address
* @param trusted True if the address should be trusted.
*/
function trustContract(address c, bool trusted) external;
/**
* Change the DNS contract, in case it needs to be upgraded.
*
* @param pns The new PNS contract address.
*/
function setPns(address pns) external;
}
// SPDX-License-Identifier: MIT OR Apache-2.0
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
interface ILockBox is IERC721 {
function lockups(
uint256 lockupId
)
external
view
returns (
uint256 amountAsset,
uint256 amountLpToken,
uint256 lpTokenValuation,
uint256 assetSecondsLocked,
uint256 lpSecondsLocked,
uint64 createTime,
uint64 lastDepositTime,
uint64 durationSeconds,
bool autoRelock
);
}
// SPDX-License-Identifier: MIT OR Apache-2
pragma solidity ^0.8.24;
import "../external/ILockBox.sol";
interface IPNS {
// Events
/// A pre-registration was created
/// @param sender who did the preregistration
/// @param nameHash The hash of the lockup ID, name, and initial records.
/// @param lockupId The lockup ID that is included in the hash.
event Preregister(address sender, bytes32 nameHash, uint64 lockupId);
/// A preregistraton was deleted
/// @param sender who destroyed the preregistration
/// @param nameHash The hash of the lockup ID, name, and initial records.
/// @param lockupId The lockup ID.
event DestroyPrereg(address sender, bytes32 nameHash, uint64 lockupId);
/// A domain was registered
/// @param sender who registered the domain (not necessarily the owner)
/// @param id The ID of the new domain
/// @param lockupId The lockup ID of the lockbox that owns the domain
/// @param name The domain name itself
/// @param records Initial records that were associated with the domain
event Register(address sender, uint64 id, uint64 lockupId, bytes name, bytes records);
/// Domain records were updated
/// @param sender who updated the records
/// @param id The ID of the (sub)domain
/// @param records The new records to enter
event UpdateRecords(address sender, uint64 id, bytes records);
/// A domain was taken over, this means either the owner is switching it to a different lockup
/// or the owner unlocked the lockup and so now it is up for grabs and someone took it.
/// @param sender who did the takeover
/// @param id The domain ID
/// @param oldLockupId The old lockup ID
/// @param newLockupId The new lockup ID
/// @param records new records that were assigned
event Takeover(address sender, uint64 id, uint64 oldLockupId, uint64 newLockupId, bytes records);
/// The owner of the domain has created a subdomain
/// @param sender who made the subdomain
/// @param id The ID of the subdomain
/// @param parentId The ID of the domain
/// @param name The fully qualified domain name of the subdomain
/// @param records The initial DNS records to set for the subdomain
event CreateSubdomain(address sender, uint64 id, uint64 parentId, bytes name, bytes records);
/// A domain or subdomain has been deleted.
/// This could be done by the owner of the domain, or in the case that the underlying lockup was
/// unlocked, this could be done by anyone - the same as takeover.
/// @param sender who did the operation.
/// @param id the ID of the (sub)domain.
event Destroy(address sender, uint64 id);
/// A (sub)domain was blacklisted or unblacklisted.
/// @param sender Who did the operation
/// @param id The ID of the domain
/// @param isBlacklisted True if the operation has made the domain blacklisted.
event Blacklist(address sender, uint64 id, bool isBlacklisted);
/// The stored representation of a domain or subdomain.
struct Domain {
/// If this is a top level domain, then this is the lockup id of the owner.
/// If this is a subdomain, then this is the ID of the top level domain.
uint64 owner;
/// Number of subdomains, if 0xff then this IS a subdomain.
uint8 subdomains;
/// True if the admin has marked this domain as blacklisted for the purpose of public resolvers.
bool blacklisted;
/// The FQDN of this domain (excluding .pkt. at the end)
bytes name;
/// Binary encoded representation of the records as updated by the owner
bytes records;
}
/// The lockbox of which the lockup holder is the owner and controller of the domain.
function lockboxContract() external returns (ILockBox);
/// The minimum amount of value that you must have locked in order to register / preregister
/// a domain. This starts at double the amount of the previous registration, and it decays
/// by 50% per halvingSeconds seconds.
function currentMinLockup() external view returns (uint256 price);
/// Get the value of assets in a given lockbox.
/// This function does not care whether the lockbox is staked for a time period or is even matured,
/// only that it is not withdrawn, because when it is withdrawn the lockup entry is deleted so
/// the values becomes zero.
function getLockupValuation(uint256 lockupId) external view returns (uint256);
/// Compute the hash which must be passed to preregister as the nameHash.
///
/// @param lockupId The lockup which will become the owner of the domain.
/// @param name The domain name, dots are forbidden in domain names because they would interfere
/// with other people creating subdomains. Other than that, no error checking is done
/// at the contract level, but capital letters or disallowed characters will result in
/// a domain that cannot be resolved.
/// @param records A byte array which represents a packed list of DNS records which will be used.
/// @return nameHash A hash that can be used for calling preregister()
function computePreregHash(
uint64 lockupId,
bytes calldata name,
bytes calldata records
) external pure returns (bytes32);
/// In order to prevent malicious actors from watching for unconfirmed name registrations and
/// frontrunning them with their own, you are required to pre-register before you register a name.
/// You pre-register by passing in the nameHash (which you can compute with computePreregHash()) plus
/// the lockup ID of the lockup that you plan to use for this name.
/// Preregistrations are valid for 24 hours, or until the underlying lockup is unstaked. After either
/// of these events, preregistrations are nolonger usable and can be removed by anyone by calling
/// destroyPrereg().
///
/// @param nameHash The hash of the name, lockupId, and records you intend to insert. Can be computed
/// using computePreregHash()
/// @param lockupId The id of the lockup which should take ownership of this domain, you must own this
/// lockup in order to pre-register. This lockup's value (i.e. getLockupValuation()) must
/// be at least equal to currentMinLockup(). This lockup must not have been used to
/// register any other currently active domain. Ownership of the domain can be switched
/// to a different lockup using the takeover() function, but that lockup must have a
/// value of at least currentMinLockup() AT THE TIME OF takeover().
/// If the lockup is unstaked while the domain is active, anyone with a qualifying lockup
/// will be able to takeover() the domain, and anyone at all will be able to destroy() it.
/// This id MUST match the one passed to computePreregHash() or else register() will fail.
function preregister(bytes32 nameHash, uint64 lockupId) external;
/// A preregistration can be removed under one of the following three conditions:
/// 1. It has expired (it is more than 24 hours old)
/// 2. The lockup which owns it has been unstaked
/// 3. You are authorized to administer the lockup (normally meaning, you're the owner)
///
/// The arguments to this function are the same as those to preregister().
function destroyPrereg(bytes32 nameHash, uint64 lockupId) external;
/// After pre-registering, you can register your domain. You cannot register in the same block as
/// pre-registering because that would enable front-running attacks. This function can be called by
/// anyone, not only the person who pre-registered, but ownership will go to the person who
/// pre-registered. The arguments to this function MUST be precisely the same as those passed to
/// computePreregHash() when creating the pre-registration hash.
function register(
uint64 lockupId,
bytes calldata name,
bytes calldata records
) external;
/// Get the lockup ID of the lockup that owns the domain.
///
/// @param id The ID of the domain
/// @return The lockbox ID of the owner lockup
function ownerLockup(uint64 id) external view returns (uint64);
/// Check if a given address is authorized to manipulate the lockup which underlies this domain.
/// See: ERC-721 getApproved() and isApprovedForAll()
///
/// @param id The ID of the domain
/// @param who The address to check
/// @return true if the address is authorized
function authorizedFor(uint64 id, address who) external view returns (bool);
/// Update the DNS records for a domain or subdomain.
/// This can only be called by an authorized party for the lockup that owns the domain.
///
/// @param id The id of the domain or subdomain, use getDomainIdByFQDN() to look it up.
/// @param records A binary packed representation of the domain records.
function updateRecords(
uint64 id,
bytes calldata records
) external;
/// Take over a domain which is either your own, and you are switching which lockup is
/// associated with the domain, or it is somebody elses and they have unstaked their lockup.
/// In order to takeover a domain, you must have the same lockup valuation that you would need to
/// preregister.
/// You cannot takeover a subdomain, but after you have taken over the parent domain, you can then
/// updateRecords() and/or destroy() any of it's subdomains as you are now the owner.
///
/// @param id The ID of the domain.
/// @param newLockupId The lockup ID that you wish to associate to this domain.
/// @param records New domain records which you wish to set to this domain. If this is an empty array
/// then the domain's records will remain unchanged.
function takeover(
uint64 id,
uint64 newLockupId,
bytes calldata records
) external;
/// Create a subdomain of your domain.
/// To create a subdomain, you must own the parent domain. You cannot create a subdomain of a subdomain
/// but you can create a subdomain with a subdomainLabel that has dots in it, for example
/// "the.coolest.subdomain" under domain "cjd" will resolve as "the.coolest.subdomain.cjd(.pkt)".
/// Subdomains cannot be sold off to anyone else, you, the lockbox owner, always own all subdomains
/// because you are uniquely able to unstake and cause the domain and all of it's subdomains to be lost.
/// Each domain can have a maximum of 254 subdomains.
///
/// @param parentId The ID of the domain underwhich to create a subdomain, use getDomainIdByFQDN() to get
/// the id of your domain.
/// @param subdomainLabel The name of the subdomain. Dots are legal in subdomain names.
/// Normal DNS rules apply to naming but are not checked at the contract level.
/// @param records A binary packed representation of the DNS records which should apply to this subdomain.
function createSubdomain(
uint64 parentId,
bytes calldata subdomainLabel,
bytes calldata records
) external;
/// Destroy a domain or subdomain. A domain cannot be destroyed until after ALL of it's subdomains have
/// been destroyed. You may destroy a domain or subdomain if you are authorized (see authorizedFor()), or
/// if the owner has unstaked the lockbox which controls it.
///
/// @param id The ID of the domain or subdomain to destroy, see getDomainIdByFQDN()
function destroy(uint64 id) external;
/// A structure allowing you to create multiple new subdomains in the same transaction.
struct NewSubdomain {
/// ID of the parent domain for the new subdomain.
uint64 parentId;
/// The subdomain label
bytes subdomainLabel;
/// Binary packed representation of domain records
bytes records;
}
/// A structure allowing for multiple DNS record updates in a single transaction.
struct RecordUpdate {
/// The ID of the domain whose records should be updated.
uint64 id;
/// A binary packed representation of the records to update.
bytes records;
}
/// Perform multiple updates in a single transaction.
///
/// @param newSubdomains New subdomains to create
/// @param recordUpdates DNS records to update
/// @param destroyDomains Domains / subdomains to destroy
function updateMultiple(
NewSubdomain[] calldata newSubdomains,
RecordUpdate[] calldata recordUpdates,
uint64[] calldata destroyDomains
) external;
// View functions
/// Get the next domain ID.
/// Any ID greater than or equal to this is guaranteed not to corrispond to an existing domain.
function nextDomainId() external view returns (uint);
/// Observe the ID free list. Calling this with last = 0 will give you the head of the list, call with the
/// value given to walk the list.
function domainIdFreeList(uint64 last) external view returns (uint);
/// Get the details of a domain by its ID.
///
/// @param id The id of the domain or subdomain to get information for, see getDomainIdByFQDN()
/// @return owner The owner of the domain, if this is a subdomain then this is the domain ID of the parent,
/// otherwise it is the lockup ID of the lockup that owns the domain.
/// @return subdomains The number of subdomains, if this is 0xff then this IS a subdomain.
/// @return blacklisted True if the domain has been blacklisted
/// @return name The name of the domain, if this is empty then it means the domain does not exist.
/// @return records A binary packed representation of the domain records.
function getDomain(uint64 id) external view returns (
uint64 owner,
uint8 subdomains,
bool blacklisted,
bytes memory name,
bytes memory records
);
/// Get multiple domains in one RPC call.
///
/// @param ids The list of IDs of domains to get.
/// @return out The domains that have been accessed. If an ID in the list doesn't exist, the resulting
/// Domain's `name` field will be empty.
function getDomains(uint64[] calldata ids) external view returns (Domain[] memory out);
/// Get the domain ID of a domain by the lockup ID of the lock box.
///
/// @param lockupId The lockup id
/// @return The domain ID, or zero if there is no domain for this lock box.
function getDomainIdByLockupId(uint64 lockupId) external view returns (uint64);
/// Get the domain ID of a domain by the full domain name (except the ".pkt." suffix).
///
/// @param fqdn The domain name, for example "the.coolest.is.cjd" will get the subdomain
/// the.coolest.is.cjd.pkt
/// @return The domain ID, or zero if there is no domain for this name.
function getDomainIdByFQDN(bytes calldata fqdn) external view returns (uint64);
/// Get the internal info about the minimum lockup value needed for registering a domain.
/// Normally you should use currentMinLockup() but this will give you the internal state.
///
/// @return lastRegTime Time of last domain registration (seconds since the epoch)
/// @return priceHalvingPeriodSeconds How many seconds it takes for the price to halve.
/// @return nextMinLockup The required lockup value if another domain were to be registered
/// at the same time as lastRegTime.
function getMinLockupInfo() external view returns (
uint64 lastRegTime,
uint64 priceHalvingPeriodSeconds,
uint256 nextMinLockup
);
/// Get the internal state of the pre-registration table. Normally you should not need this.
///
/// @param nameHash The pre-registration hash as computed by computePreregHash()
/// @return timestamp The timestamp of the pre-registration entry.
/// @return lockupId The lockup ID that is associated with the pre-registration.
function getPrereg(bytes32 nameHash) external view returns (
uint64 timestamp,
uint64 lockupId
);
/// Check if a given address is whitelisted for registration right now.
///
/// @param addr The address to check.
/// @return Whether or not the address is whitelisted.
function isAddressWhitelisted(address addr) external view returns (bool);
/// Check whether the address whitelist is currently active
function isRegistrationWhitelistActive() external view returns (bool);
/// Get the address which is currently delegated as the admin.
function getAdmin() external view returns (address);
// Administrative functions
/// Set the administrator address (owner only)
function setAdmin(address admin) external;
/// Set the price halving time (admin only)
function setPriceHalvingSeconds(uint64 halvingSeconds) external;
/// A struct for adding and removing addresses from the whitelist
struct AllowedAddress {
/// The relevant address
address addr;
/// True if the address is being added, false if removed
bool allowed;
}
/// Update the list of addresses which are allowed to register domains (admin only).
/// @param allowed The list of addresses to add/remove
/// @param activate If true, the whitelist begins enforcing, if false, then it stops enforcing.
function updateRegistrationWhitelist(AllowedAddress[] calldata allowed, bool activate) external;
/// Blacklist or unblacklist a domain (admin only)
///
/// @param id The ID of the domain or subdomain
/// @param blacklisted True to blacklist, false to unblacklist
function setDomainBlacklisted(uint64 id, bool blacklisted) external;
}
// SPDX-License-Identifier: MIT OR Apache-2
pragma solidity ^0.8.24;
library IdProvider {
struct Ids {
mapping(uint => uint) freeList;
uint nextId;
}
// Initialize the state for IDManager
function init(Ids storage self) internal {
self.nextId = 1; // Start the ID counter from 1 (or whatever number you'd like)
}
// Take an ID, either from the free list or by incrementing the next ID
function take(Ids storage self) internal returns (uint id) {
id = self.freeList[0];
if (id > 0) {
// Reuse an ID from the free list
self.freeList[0] = self.freeList[id];
delete self.freeList[id];
} else {
// No free IDs, use the next available ID
id = self.nextId++;
}
}
// Release an ID, adding it to the free list
function release(Ids storage self, uint id) internal {
uint fdid = self.freeList[0];
if (fdid > 0) {
self.freeList[id] = fdid;
}
self.freeList[0] = id;
}
}
// SPDX-License-Identifier: MIT OR Apache-2
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "./interface/IPNS.sol";
import "./interface/IInfra.sol";
import "./libraries/IdProvider.sol";
contract Infra is ERC721Enumerable, Ownable, IInfra {
using IdProvider for IdProvider.Ids;
uint8 constant UPDATE_TYPE = 1;
uint8 constant UPDATE_DOMAIN = 2;
uint8 constant UPDATE_NAME = 4;
// The name service
IPNS public self_ipns;
// An ID provider which reuses IDs when possible
IdProvider.Ids private self_ids;
// For displaying imagines on the NFTs
string private self_baseURI;
// All units
mapping(uint => Unit) self_unitById;
mapping(address => bool) self_trusted;
//--//
constructor(address pnsAddress) ERC721("PKTInfra", "PKTI") Ownable(msg.sender) {
self_ipns = IPNS(pnsAddress);
self_ids.init();
}
// Update
function registerUnit(
UnitType t,
uint64 parentDomain,
string calldata name,
address to
) external override returns (uint) {
{
address es = _effectiveSender(to);
_checkDomainAuthorized(parentDomain, es);
}
require(t > UnitType.Invalid && t < UnitType.InvalidTooHigh, "Invalid type");
uint newTokenId = self_ids.take();
Unit storage unit = self_unitById[newTokenId];
unit.unitType = t;
unit.parentDomain = parentDomain;
unit.name = name;
_safeMint(to, newTokenId);
emit RegisterUnit(msg.sender, newTokenId, msg.sender, to, t, parentDomain, name);
return newTokenId;
}
function updateUnit(
uint id,
uint8 update,
UnitType t,
uint64 parentDomain,
string calldata name,
address onBehalfOf
) external override {
onBehalfOf = _effectiveSender(onBehalfOf);
_checkAuthorized(id, onBehalfOf);
Unit storage unit = self_unitById[id];
if ((update & UPDATE_TYPE) > 0) {
require(t > UnitType.Invalid && t < UnitType.InvalidTooHigh, "Invalid type");
unit.unitType = t;
}
if ((update & UPDATE_DOMAIN) > 0) {
_checkDomainAuthorized(parentDomain, onBehalfOf);
unit.parentDomain = parentDomain;
}
if ((update & UPDATE_NAME) > 0) {
unit.name = name;
}
emit UpdateUnit(msg.sender, id, update, t, parentDomain, name);
}
function deleteUnit(uint id, address onBehalfOf) external override {
onBehalfOf = _effectiveSender(onBehalfOf);
_checkAuthorized(id, onBehalfOf);
delete self_unitById[id];
_burn(id);
self_ids.release(id);
emit DeleteUnit(msg.sender, id);
}
function domainEviction(uint id) external override {
Unit storage unit = self_unitById[id];
uint64 parentDomain = unit.parentDomain;
_checkDomainAuthorized(parentDomain, msg.sender);
unit.parentDomain = 0;
emit DomainEvict(msg.sender, id);
}
// View
function getUnit(uint id) external override view returns (
UnitType t,
uint64 parentDomain,
string memory name,
address owner
) {
owner = _ownerOf(id);
Unit storage unit = self_unitById[id];
t = unit.unitType;
parentDomain = unit.parentDomain;
name = unit.name;
}
function getUnits(
uint[] calldata ids
) external override view returns (
Unit[] memory out,
address[] memory owners
) {
out = new Unit[](ids.length);
owners = new address[](ids.length);
for (uint i = 0; i < ids.length; i++) {
out[i] = self_unitById[ids[i]];
owners[i] = _ownerOf(ids[i]);
}
}
function isTrustedContract(address c) external override view returns (bool trusted) {
return self_trusted[c];
}
function nextId() external override view returns (uint) {
return self_ids.nextId;
}
function idFreeList(uint64 last) external override view returns (uint) {
return self_ids.freeList[last];
}
// Admin
function trustContract(address c, bool trusted) external override onlyOwner {
if (trusted) {
self_trusted[c] = true;
} else {
delete self_trusted[c];
}
}
function setUriPrefix(string calldata pfx) external override onlyOwner {
self_baseURI = pfx;
}
function setPns(address pns) external override onlyOwner {
self_ipns = IPNS(pns);
}
// Internal
function _baseURI() internal view override returns (string memory) {
return self_baseURI;
}
function _effectiveSender(address to) private view returns (address) {
if (self_trusted[msg.sender]) {
return to;
}
return msg.sender;
}
function _checkDomainAuthorized(uint64 parentDomain, address addr) private view {
if (parentDomain > 0) {
require(self_ipns.authorizedFor(parentDomain, addr), "Not the owner of parentDomain");
}
}
function _checkAuthorized(uint id, address who) private view {
address owner = _ownerOf(id);
require(owner != address(0), "Unit not registered");
require(_isAuthorized(owner, who, id), "Not authorized to update unit");
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
/**
* @dev Muldiv operation overflow.
*/
error MathOverflowedMulDiv();
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an overflow flag.
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @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 towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
return a / b;
}
// (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 = x * y; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
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.
if (denominator <= prod1) {
revert MathOverflowedMulDiv();
}
///////////////////////////////////////////////
// 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.
uint256 twos = denominator & (0 - denominator);
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 (unsignedRoundsUp(rounding) && 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
* towards zero.
*
* 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 + (unsignedRoundsUp(rounding) && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* 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 + (unsignedRoundsUp(rounding) && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* 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 + (unsignedRoundsUp(rounding) && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* 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 + (unsignedRoundsUp(rounding) && 1 << (result << 3) < value ? 1 : 0);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../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.
*
* The initial owner is set to the address provided by the deployer. 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;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @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 {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @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 {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.20;
/**
* @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);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Strings.sol)
pragma solidity ^0.8.20;
import {Math} from "./math/Math.sol";
import {SignedMath} from "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @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), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(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) {
uint256 localValue = value;
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] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
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 bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in EIP-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}
{
"compilationTarget": {
"contracts/Infra.sol": "Infra"
},
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 1000
},
"remappings": []
}
[{"inputs":[{"internalType":"address","name":"pnsAddress","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"ERC721EnumerableForbiddenBatchMint","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"address","name":"owner","type":"address"}],"name":"ERC721IncorrectOwner","type":"error"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ERC721InsufficientApproval","type":"error"},{"inputs":[{"internalType":"address","name":"approver","type":"address"}],"name":"ERC721InvalidApprover","type":"error"},{"inputs":[{"internalType":"address","name":"operator","type":"address"}],"name":"ERC721InvalidOperator","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"ERC721InvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"ERC721InvalidReceiver","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"ERC721InvalidSender","type":"error"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ERC721NonexistentToken","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"ERC721OutOfBoundsIndex","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","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":false,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"uint256","name":"id","type":"uint256"}],"name":"DeleteUnit","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"uint256","name":"id","type":"uint256"}],"name":"DomainEvict","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"uint256","name":"newId","type":"uint256"},{"indexed":false,"internalType":"address","name":"creator","type":"address"},{"indexed":false,"internalType":"address","name":"recipient","type":"address"},{"indexed":false,"internalType":"enum IInfra.UnitType","name":"t","type":"uint8"},{"indexed":false,"internalType":"uint64","name":"parentDomain","type":"uint64"},{"indexed":false,"internalType":"string","name":"name","type":"string"}],"name":"RegisterUnit","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"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"uint256","name":"id","type":"uint256"},{"indexed":false,"internalType":"uint8","name":"updateMask","type":"uint8"},{"indexed":false,"internalType":"enum IInfra.UnitType","name":"t","type":"uint8"},{"indexed":false,"internalType":"uint64","name":"parentDomain","type":"uint64"},{"indexed":false,"internalType":"string","name":"name","type":"string"}],"name":"UpdateUnit","type":"event"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"approve","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"address","name":"onBehalfOf","type":"address"}],"name":"deleteUnit","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"id","type":"uint256"}],"name":"domainEviction","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getApproved","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"id","type":"uint256"}],"name":"getUnit","outputs":[{"internalType":"enum IInfra.UnitType","name":"t","type":"uint8"},{"internalType":"uint64","name":"parentDomain","type":"uint64"},{"internalType":"string","name":"name","type":"string"},{"internalType":"address","name":"owner","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"getUnits","outputs":[{"components":[{"internalType":"uint64","name":"parentDomain","type":"uint64"},{"internalType":"enum IInfra.UnitType","name":"unitType","type":"uint8"},{"internalType":"string","name":"name","type":"string"}],"internalType":"struct IInfra.Unit[]","name":"out","type":"tuple[]"},{"internalType":"address[]","name":"owners","type":"address[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint64","name":"last","type":"uint64"}],"name":"idFreeList","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"c","type":"address"}],"name":"isTrustedContract","outputs":[{"internalType":"bool","name":"trusted","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"nextId","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ownerOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"enum IInfra.UnitType","name":"t","type":"uint8"},{"internalType":"uint64","name":"parentDomain","type":"uint64"},{"internalType":"string","name":"name","type":"string"},{"internalType":"address","name":"to","type":"address"}],"name":"registerUnit","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","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":"tokenId","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"self_ipns","outputs":[{"internalType":"contract IPNS","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"pns","type":"address"}],"name":"setPns","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"string","name":"pfx","type":"string"}],"name":"setUriPrefix","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"index","type":"uint256"}],"name":"tokenByIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"tokenOfOwnerByIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"tokenURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"transferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"c","type":"address"},{"internalType":"bool","name":"trusted","type":"bool"}],"name":"trustContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"uint8","name":"update","type":"uint8"},{"internalType":"enum IInfra.UnitType","name":"t","type":"uint8"},{"internalType":"uint64","name":"parentDomain","type":"uint64"},{"internalType":"string","name":"name","type":"string"},{"internalType":"address","name":"onBehalfOf","type":"address"}],"name":"updateUnit","outputs":[],"stateMutability":"nonpayable","type":"function"}]