1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 | 18× 16× 9× 9× 1× 1× 14× 14× 2× 2× 2× 2× 65× 65× 64× 1× 1× 1× 1× 1× 2× 1× 1× 3× 3× 3× 1× 1× 1× 1× 6× 6× 1× 1× 4× 1× 1× 1× 6× 2× 2× 2× 6× 2× 2× 2× 2× 1× 1× 1× 7× 7× 7× 41× 18× 18× 18× 2× 2× 2× 12× 12× 11× 10× 10× 10× 10× 10× 4× 3× 2× 2× 2× 2× 2× 2× 13× 13× 12× 10× 10× 10× 10× 10× 10× 10× 15× 15× 15× 15× 4× 4× 4× 4× 9× 9× 9× 1× 1× 8× | // SPDX-License-Identifier: MIT // SPDX-FileCopyrightText: Copyright (C) 2022 Spanning Labs Inc. pragma solidity ^0.8.0; import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol"; import "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol"; import "@openzeppelin/contracts/utils/Address.sol"; import "@openzeppelin/contracts/utils/Context.sol"; import "@openzeppelin/contracts/utils/Strings.sol"; import "@openzeppelin/contracts/utils/introspection/ERC165.sol"; import "../../ISpanningDelegate.sol"; import "./ISpanningERC721.sol"; import "../../SpanningUtils.sol"; import "../../Spanning.sol"; /** * @dev Implementation of the {ISpanningERC721} interface. */ abstract contract SpanningERC721 is Spanning, Context, ERC165, ISpanningERC721, IERC721Metadata { // This allows us to efficiently unpack data in our address specification. using SpanningAddress for bytes32; using Address for address; using Strings for uint256; // Standard metadata: token name string private name_; // Standard metadata: token symbol string private symbol_; // Mapping from token ID to owner address mapping(uint256 => bytes32) private owners_; // Mapping owner address to token count mapping(bytes32 => uint256) private balances_; // Mapping from token ID to approved address mapping(uint256 => bytes32) private tokenApprovals_; // Mapping from sender to receiver approvals mapping(bytes32 => mapping(bytes32 => bool)) private operatorApprovals_; // Convenience modifier for common bounds checks modifier onlyOwnerOrApproved(uint256 tokenId) { require( _isApprovedOrOwner(spanningMsgSender(), tokenId), "onlyOwnerOrApproved: bad role" ); _; } /** * @dev Creates the instance and assigns required values. * * @param nameIn - Desired name for the token collection * @param symbolIn - Desired symbol for the token collection * @param delegate - Legacy (local) address for the Spanning Delegate */ constructor( string memory nameIn, string memory symbolIn, address delegate ) Spanning(delegate) { name_ = nameIn; symbol_ = symbolIn; } /** * @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 accountLegacyAddress) public view virtual override returns (uint256) { bytes32 accountAddress = getAddressFromLegacy(accountLegacyAddress); return balanceOf(accountAddress); } /** * @dev Returns the number of tokens owned by an account. * * @param accountAddress - Address to be queried * * @return uint256 - Number of tokens owned by an account */ function balanceOf(bytes32 accountAddress) public view virtual override returns (uint256) { Erequire( accountAddress.valid(), "ERC721: balance query for the invalid address" ); return balances_[accountAddress]; } /** * @dev See {IERC721-ownerOf}. */ function ownerOf(uint256 tokenId) public view virtual override returns (address) { bytes32 ownerAddress = ownerOfSpanning(tokenId); // To prevent incorrect data leakage, we return the legacy address // only if that user is local to the current domain. bytes4 ownerDomain = getDomainFromAddress(ownerAddress); Erequire( ownerDomain == getDomain(), "ERC721: remote account requesting legacy address" ); return getLegacyFromAddress(ownerAddress); } /** * @dev See {IERC721-ownerOf}. */ function ownerOfSpanning(uint256 tokenId) public view virtual override returns (bytes32) { bytes32 ownerAddress = owners_[tokenId]; require( ownerAddress.valid(), "ERC721: owner query for nonexistent token" ); return ownerAddress; } /** * @dev See {IERC721Metadata-name}. */ function name() public view virtual override returns (string memory) { return name_; } /** * @dev See {IERC721Metadata-symbol}. */ function symbol() public view virtual override returns (string memory) { return symbol_; } /** * @dev See {IERC721Metadata-tokenURI}. */ function tokenURI(uint256 tokenId) public view virtual override returns (string memory) { Erequire( _exists(tokenId), "ERC721Metadata: URI query for nonexistent token" ); string memory baseURI = _baseURI(); return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI, tokenId.toString())) : ""; } /** * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each * token will be the concatenation of the `baseURI` and the `tokenId`. Empty * by default, can be overridden in child contracts. */ function _baseURI() internal view virtual returns (string memory) { return ""; } /** * @dev See {IERC721-approve}. */ function approve(address receiverLegacyAddress, uint256 tokenId) public virtual override { bytes32 receiverAddress = getAddressFromLegacy(receiverLegacyAddress); approve(receiverAddress, tokenId); } /** * @dev Sets a token allowance for a pair of addresses (sender and receiver). * * @param receiverAddress - Address of the allowance receiver * @param tokenId - Token allowance to be approved */ function approve(bytes32 receiverAddress, uint256 tokenId) public virtual override onlyOwnerOrApproved(tokenId) { bytes32 tokenOwner = SpanningERC721.ownerOfSpanning(tokenId); Erequire( receiverAddress != tokenOwner, "ERC721: approval to current owner" ); _approve(receiverAddress, tokenId); } /** * @dev See {IERC721-getApproved}. */ function getApproved(uint256 tokenId) public view virtual override returns (address) { bytes32 ownerAddress = getApprovedSpanning(tokenId); // To prevent incorrect data leakage, we return the legacy address // only if that user is local to the current domain. bytes4 ownerDomain = getDomainFromAddress(ownerAddress); Erequire( ownerDomain == getDomain(), "ERC721: remote account requesting legacy address" ); return getLegacyFromAddress(ownerAddress); } function getApprovedSpanning(uint256 tokenId) public view virtual override returns (bytes32) { Erequire( _exists(tokenId), "ERC721: approved query for nonexistent token" ); return tokenApprovals_[tokenId]; } /** * @dev See {IERC721-setApprovalForAll}. */ function setApprovalForAll( address receiverLegacyAddress, bool shouldApprove ) public virtual override { bytes32 receiverAddress = getAddressFromLegacy(receiverLegacyAddress); setApprovalForAll(receiverAddress, shouldApprove); } /** * @dev Allows an account to have control over another account's tokens. * * @param receiverAddress - Address of the allowance receiver (gains control) * @param shouldApprove - Whether to approve or revoke the approval */ function setApprovalForAll(bytes32 receiverAddress, bool shouldApprove) public virtual override { _setApprovalForAll(receiverAddress, shouldApprove); } /** * @dev See {IERC721-isApprovedForAll}. */ function isApprovedForAll( address senderLegacyAddress, address receiverLegacyAddress ) public view virtual override returns (bool) { bytes32 senderAddress = getAddressFromLegacy(senderLegacyAddress); bytes32 receiverAddress = getAddressFromLegacy(receiverLegacyAddress); return isApprovedForAll(senderAddress, receiverAddress); } /** * @dev Indicates if an account has total control over another's assets. * * @param senderAddress - Address of the allowance sender (cede control) * @param receiverAddress - Address of the allowance receiver (gains control) * * @return bool - Indicates whether the account is approved for all */ function isApprovedForAll(bytes32 senderAddress, bytes32 receiverAddress) public view virtual override returns (bool) { return operatorApprovals_[senderAddress][receiverAddress]; } /** * @dev See {IERC721-transferFrom}. */ function transferFrom( address senderLegacyAddress, address receiverLegacyAddress, uint256 tokenId ) public virtual override { bytes32 senderAddress = getAddressFromLegacy(senderLegacyAddress); bytes32 receiverAddress = getAddressFromLegacy(receiverLegacyAddress); transferFrom(senderAddress, receiverAddress, tokenId); } /** * @dev Moves requested tokens between accounts. * * @param senderAddress - Address of the sender * @param receiverAddress - Address of the receiver * @param tokenId - Token to be transferred */ function transferFrom( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId ) public virtual override onlyOwnerOrApproved(tokenId) { _transfer(senderAddress, receiverAddress, tokenId); } /** * @dev See {IERC721-safeTransferFrom}. */ function safeTransferFrom( address senderLegacyAddress, address receiverLegacyAddress, uint256 tokenId ) public virtual override { bytes32 senderAddress = getAddressFromLegacy(senderLegacyAddress); bytes32 receiverAddress = getAddressFromLegacy(receiverLegacyAddress); safeTransferFrom(senderAddress, receiverAddress, tokenId, ""); } /** * @dev Safely moves requested tokens between accounts. * * @param senderAddress - Address of the sender * @param receiverAddress - Address of the receiver * @param tokenId - Token to be transferred */ function safeTransferFrom( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId ) public virtual override { safeTransferFrom(senderAddress, receiverAddress, tokenId, ""); } /** * @dev See {IERC721-safeTransferFrom}. */ function safeTransferFrom( address senderLegacyAddress, address receiverLegacyAddress, uint256 tokenId, bytes memory payload ) public virtual override { bytes32 senderAddress = getAddressFromLegacy(senderLegacyAddress); bytes32 receiverAddress = getAddressFromLegacy(receiverLegacyAddress); safeTransferFrom(senderAddress, receiverAddress, tokenId, payload); } /** * @dev Safely moves requested tokens between accounts, including data. * * @param senderAddress - Address of the sender * @param receiverAddress - Address of the receiver * @param tokenId - Token to be transferred * @param payload - Additional, unstructured data to be included */ function safeTransferFrom( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId, bytes memory payload ) public virtual override onlyOwnerOrApproved(tokenId) { _safeTransfer(senderAddress, receiverAddress, tokenId, payload); } /** * @dev Safely transfers a token between accounts, checking for ERC721 validity. * * @param senderAddress - Address of the sender * @param receiverAddress - Address of the receiver * @param tokenId - Token to be transferred * @param payload - Additional, unstructured data to be included */ function _safeTransfer( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId, bytes memory payload ) internal virtual { _transfer(senderAddress, receiverAddress, tokenId); Erequire( _checkOnERC721Received( senderAddress, receiverAddress, tokenId, payload ), "ERC721: transfer to non ERC721Receiver implementer" ); } /** * @dev Checks if the token exists (has been minted but not burned). * * @param tokenId - Token to be checked * * @return bool - Whether the token exists */ function _exists(uint256 tokenId) internal view virtual returns (bool) { return owners_[tokenId].valid(); } /** * @dev Checks if the account is authorized to spend the token. * * @param receiverAddress - Address of the receiver * @param tokenId - Token to be checked * * @return bool - Whether the account is authorized to spend the token */ function _isApprovedOrOwner(bytes32 receiverAddress, uint256 tokenId) internal view virtual returns (bool) { Erequire( _exists(tokenId), "ERC721: operator query for nonexistent token" ); bytes32 tokenOwner = SpanningERC721.ownerOfSpanning(tokenId); return (receiverAddress == tokenOwner || isApprovedForAll(tokenOwner, receiverAddress) || getApprovedSpanning(tokenId) == receiverAddress); } /** * @dev Safely mints a new token to an account * * @param receiverAddress - Address of the receiver * @param tokenId - Token to be minted */ function _safeMint(bytes32 receiverAddress, uint256 tokenId) internal virtual { _safeMint(receiverAddress, tokenId, ""); } /** * @dev Safely mints a new token to an account * * @param receiverAddress - Address of the receiver * @param tokenId - Token to be minted * @param payload - Additional, unstructured data to be included */ function _safeMint( bytes32 receiverAddress, uint256 tokenId, bytes memory payload ) internal virtual { _mint(receiverAddress, tokenId); Erequire( _checkOnERC721Received( SpanningAddress.invalidAddress(), receiverAddress, tokenId, payload ), "ERC721: transfer to non ERC721Receiver implementer" ); } /** * @dev Mints a new token to an account * * @param receiverAddress - Address of the receiver * @param tokenId - Token to be minted */ function _mint(bytes32 receiverAddress, uint256 tokenId) internal virtual { Erequire(receiverAddress.valid(), "ERC721: mint to the zero address"); require(!_exists(tokenId), "ERC721: token already minted"); _beforeTokenTransfer( SpanningAddress.invalidAddress(), receiverAddress, tokenId ); balances_[receiverAddress] += 1; owners_[tokenId] = receiverAddress; emit SpanningTransfer( SpanningAddress.invalidAddress(), receiverAddress, tokenId ); emit Transfer( address(0), getLegacyFromAddress(receiverAddress), tokenId ); _afterTokenTransfer( SpanningAddress.invalidAddress(), receiverAddress, tokenId ); } /** * @dev Burns the token * * @param tokenId - Token to be burned */ function _burn(uint256 tokenId) internal virtual { bytes32 tokenOwner = SpanningERC721.ownerOfSpanning(tokenId); _beforeTokenTransfer( tokenOwner, SpanningAddress.invalidAddress(), tokenId ); // Clear approvals _approve(SpanningAddress.invalidAddress(), tokenId); balances_[tokenOwner] -= 1; delete owners_[tokenId]; emit SpanningTransfer( tokenOwner, SpanningAddress.invalidAddress(), tokenId ); emit Transfer(getLegacyFromAddress(tokenOwner), address(0), tokenId); _afterTokenTransfer( tokenOwner, SpanningAddress.invalidAddress(), tokenId ); } /** * @dev Transfers the token between accounts * * @param senderAddress - Address of the sender * @param receiverAddress - Address of the receiver * @param tokenId - Token to be transferred */ function _transfer( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId ) internal virtual { Erequire( SpanningERC721.ownerOfSpanning(tokenId).equals(senderAddress), "ERC721: transfer from incorrect owner" ); require( receiverAddress.valid(), "ERC721: transfer to the zero address" ); _beforeTokenTransfer(senderAddress, receiverAddress, tokenId); // Clear approvals from the previous owner _approve(SpanningAddress.invalidAddress(), tokenId); balances_[senderAddress] -= 1; balances_[receiverAddress] += 1; owners_[tokenId] = receiverAddress; emit Transfer( getLegacyFromAddress(senderAddress), getLegacyFromAddress(receiverAddress), tokenId ); emit SpanningTransfer(senderAddress, receiverAddress, tokenId); _afterTokenTransfer(senderAddress, receiverAddress, tokenId); } /** * @dev Sets a token allowance for a pair of addresses (sender and receiver). * * @param receiverAddress - Address of the allowance receiver * @param tokenId - Token allowance to be approved */ function _approve(bytes32 receiverAddress, uint256 tokenId) internal virtual { tokenApprovals_[tokenId] = receiverAddress; bytes32 owner = SpanningERC721.ownerOfSpanning(tokenId); emit Approval( getLegacyFromAddress(owner), getLegacyFromAddress(receiverAddress), tokenId ); emit SpanningApproval(owner, receiverAddress, tokenId); } /** * @dev Allows an account to have control over another account's tokens. * * @param receiverAddress - Address of the allowance receiver (gains control) * @param shouldApprove - Whether to approve or revoke the approval */ function _setApprovalForAll(bytes32 receiverAddress, bool shouldApprove) internal virtual { Erequire( !spanningMsgSender().equals(receiverAddress), "ERC721: approve to caller" ); operatorApprovals_[spanningMsgSender()][ receiverAddress ] = shouldApprove; emit ApprovalForAll( getLegacyFromAddress(spanningMsgSender()), getLegacyFromAddress(receiverAddress), shouldApprove ); emit SpanningApprovalForAll( spanningMsgSender(), receiverAddress, shouldApprove ); } /** * @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address. * The call is not executed if the target address is not a contract. * * @param senderAddress - Address of the sender * @param receiverAddress - Address of the receiver * @param tokenId - Token to be transferred * @param payload - Additional, unstructured data to be included * * @return bool - If call correctly returned the expected magic value */ function _checkOnERC721Received( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId, bytes memory payload ) private returns (bool) { address senderLegacyAddress = getLegacyFromAddress(senderAddress); address receiverLegacyAddress = getLegacyFromAddress(receiverAddress); // Only dispatch if the destination is a contract and also on the same domain if ( receiverLegacyAddress.isContract() && getDomainFromAddress(receiverAddress) == getDomain() ) { // TODO(jade) Implement SpanningERC721Receiver // https://linear.app/spanninglabs/issue/ENG-135/implement-spanningerc721receiver-for-safe-transfers try IERC721Receiver(receiverLegacyAddress).onERC721Received( getLegacyFromAddress(spanningMsgSender()), senderLegacyAddress, tokenId, payload ) returns (bytes4 retval) { return retval == IERC721Receiver.onERC721Received.selector; } catch (bytes memory reason) { if (reason.length == 0) { revert( "ERC721: transfer to non ERC721Receiver implementer" ); } else { assembly { revert(add(32, reason), mload(reason)) } } } } else { return true; } } /** * @dev Hook that is called before any transfer of tokens. * * @param senderAddress - Address initiating the transfer * @param receiverAddress - Address receiving the transfer * @param tokenId - Token to be transferred */ function _beforeTokenTransfer( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId ) internal virtual {} /** * @dev Hook that is called after any burn of tokens. * * @param senderAddress - Address sending tokens to burn * @param receiverAddress - Unused * @param tokenId - Token to be burned */ function _afterTokenTransfer( bytes32 senderAddress, bytes32 receiverAddress, uint256 tokenId ) internal virtual {} } |