[ERC7695] ERC721に所有権委任と利用権を分離する仕組みを理解しよう！

/// Note: the ERC-165 identifier for this interface is 0x486b6fba.
interface IERC7695 /* is IERC721, IERC165 */ {
  /// @dev This emits when a context is updated by any mechanism.
  event ContextUpdated(bytes32 indexed ctxHash, address indexed controller, uint64 detachingDuration);
  /// @dev This emits when a token is attached to a certain context by any mechanism.
  event ContextAttached(bytes32 indexed ctxHash, uint256 indexed tokenId);
  /// @dev This emits when a token is requested to detach from a certain context by any mechanism.
  event ContextDetachmentRequested(bytes32 indexed ctxHash, uint256 indexed tokenId);
  /// @dev This emits when a token is detached from a certain context by any mechanism.
  event ContextDetached(bytes32 indexed ctxHash, uint256 indexed tokenId);
  /// @dev This emits when a user is assigned to a certain context by any mechanism.
  event ContextUserAssigned(bytes32 indexed ctxHash, uint256 indexed tokenId, address indexed user);
  /// @dev This emits when a token is (un)locked in a certain context by any mechanism.
  event ContextLockUpdated(bytes32 indexed ctxHash, uint256 indexed tokenId, bool locked);
  /// @dev This emits when the ownership delegation is started by any mechanism.
  event OwnershipDelegationStarted(uint256 indexed tokenId, address indexed delegatee, uint64 until);
  /// @dev This emits when the ownership delegation is accepted by any mechanism.
  event OwnershipDelegationAccepted(uint256 indexed tokenId, address indexed delegatee, uint64 until);
  /// @dev This emits when the ownership delegation is stopped by any mechanism.
  event OwnershipDelegationStopped(uint256 indexed tokenId, address indexed delegatee);

  /// @notice Gets the longest duration the detaching can happen.
  function maxDetachingDuration() external view returns (uint64);

  /// @notice Gets controller address and detachment duration of a context.
  /// @dev MUST revert if the context is not existent.
  /// @param ctxHash            A hash of context to query the controller.
  /// @return controller        The address of the context controller.
  /// @return detachingDuration The duration must be waited for detachment in second(s).
  function getContext(bytes32 ctxHash) external view returns (address controller, uint64 detachingDuration);

  /// @notice Creates a new context.
  /// @dev MUST revert if the context is already existent.
  /// MUST revert if the controller address is zero address.
  /// MUST revert if the detaching duration is larger than max detaching duration.
  /// MUST emit the event {ContextUpdated} to reflect context created and controller set.
  /// @param controller        The address that controls the created context.
  /// @param detachingDuration The duration must be waited for detachment in second(s).
  /// @param ctxMsg            The message of new context to be used for hashing.
  /// @return ctxHash          Hash of the created context.
  function createContext(address controller, uint64 detachingDuration, bytes calldata ctxMsg)
    external
    returns (bytes32 ctxHash);

  /// @notice Updates an existing context.
  /// @dev MUST revert if method caller is not the current controller.
  /// MUST revert if the context is non-existent.
  /// MUST revert if the new controller address is zero address.
  /// MUST revert if the detaching duration is larger than max detaching duration.
  /// MUST emit the event {ContextUpdated} on success.
  /// @param ctxHash              Hash of the context to set.
  /// @param newController        The address of new controller.
  /// @param newDetachingDuration The new duration must be waited for detachment in second(s).
  function updateContext(bytes32 ctxHash, address newController, uint64 newDetachingDuration) external;

  /// @notice Queries if a token is attached to a certain context.
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to query.
  /// @return        True if the token is attached to the context, false if not.
  function isAttachedWithContext(bytes32 ctxHash, uint256 tokenId) external view returns (bool);

  /// @notice Attaches a token with a certain context.
  /// @dev See "attachContext rules" in "Token (Un)lock Rules".
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be attached.
  /// @param data    Additional data with no specified format, MUST be sent unaltered in call to the {IERC7695ContextCallback} hook(s) on controller.
  function attachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;

  /// @notice Requests to detach a token from a certain context.
  /// @dev See "requestDetachContext rules" in "Token (Un)lock Rules".
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be detached.
  /// @param data    Additional data with no specified format, MUST be sent unaltered in call to the {IERC7695ContextCallback} hook(s) on controller.
  function requestDetachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;

  /// @notice Executes context detachment.
  /// @dev See "execDetachContext rules" in "Token (Un)lock Rules".
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be detached.
  /// @param data    Additional data with no specified format, MUST be sent unaltered in call to the {IERC7695ContextCallback} hook(s) on controller.
  function execDetachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;

  /// @notice Finds the context user of a token.
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be detached.
  /// @return user   Address of the context user.
  function getContextUser(bytes32 ctxHash, uint256 tokenId) external view returns (address user);

  /// @notice Updates the context user of a token.
  /// @dev MUST revert if the method caller is not context controller.
  /// MUST revert if the context is non-existent.
  /// MUST revert if the token is not attached to the context.
  /// MUST emit the event {ContextUserAssigned} on success.
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be update.
  /// @param user    Address of the new user.
  function setContextUser(bytes32 ctxHash, uint256 tokenId, address user) external;

  /// @notice Queries if the lock a token is locked in a certain context.
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be queried.
  /// @return        True if the token context is locked, false if not.
  function isTokenContextLocked(bytes32 ctxHash, uint256 tokenId) external view returns (bool);

  /// @notice (Un)locks a token in a certain context.
  /// @dev See "setContextLock rules" in "Token (Un)lock Rules".
  /// @param ctxHash Hash of a context.
  /// @param tokenId The NFT to be queried.
  /// @param lock    New status to be (un)locked.
  function setContextLock(bytes32 ctxHash, uint256 tokenId, bool lock) external;

  /// @notice Finds the ownership manager of a specified token.
  /// @param tokenId  The NFT to be queried.
  /// @return manager Address of delegatee.
  function getOwnershipManager(uint256 tokenId) external view returns(address manager);

  /// @notice Finds the ownership delegatee of a token.
  /// @dev MUST revert if there is no (or an expired) ownership delegation.
  /// @param tokenId    The NFT to be queried.
  /// @return delegatee Address of delegatee.
  /// @return until     The delegation expiry time.
  function getOwnershipDelegatee(uint256 tokenId) external view returns (address delegatee, uint64 until);

  /// @notice Finds the pending ownership delegatee of a token.
  /// @dev MUST revert if there is no (or an expired) pending ownership delegation.
  /// @param tokenId    The NFT to be queried.
  /// @return delegatee Address of pending delegatee.
  /// @return until     The delegation expiry time in the future.
  function pendingOwnershipDelegatee(uint256 tokenId) external view returns (address delegatee, uint64 until);

  /// @notice Starts ownership delegation and retains ownership until a specific timestamp.
  /// @dev Replaces the pending delegation if any.
  /// See "startDelegateOwnership rules" in "Ownership Delegation Rules".
  /// @param tokenId   The NFT to be delegated.
  /// @param delegatee Address of new delegatee.
  /// @param until     The delegation expiry time.
  function startDelegateOwnership(uint256 tokenId, address delegatee, uint64 until) external;

  /// @notice Accepts ownership delegation request.
  /// @dev See "acceptOwnershipDelegation rules" in "Ownership Delegation Rules".
  /// @param tokenId The NFT to be accepted.
  function acceptOwnershipDelegation(uint256 tokenId) external;

  /// @notice Stops the current ownership delegation.
  /// @dev See "stopOwnershipDelegation rules" in "Ownership Delegation Rules".
  /// @param tokenId The NFT to be stopped.
  function stopOwnershipDelegation(uint256 tokenId) external;
}

// Note: ERC-165 identifier for IERC7695 is 0x486b6fba.
interface IERC7695 /* is IERC721, IERC165 */ {
  event ContextUpdated(bytes32 indexed ctxHash, address indexed controller, uint64 detachingDuration);
  event ContextAttached(bytes32 indexed ctxHash, uint256 indexed tokenId);
  event ContextDetachmentRequested(bytes32 indexed ctxHash, uint256 indexed tokenId);
  event ContextDetached(bytes32 indexed ctxHash, uint256 indexed tokenId);
  event ContextUserAssigned(bytes32 indexed ctxHash, uint256 indexed tokenId, address indexed user);
  event ContextLockUpdated(bytes32 indexed ctxHash, uint256 indexed tokenId, bool locked);
  event OwnershipDelegationStarted(uint256 indexed tokenId, address indexed delegatee, uint64 until);
  event OwnershipDelegationAccepted(uint256 indexed tokenId, address indexed delegatee, uint64 until);
  event OwnershipDelegationStopped(uint256 indexed tokenId, address indexed delegatee);

  function maxDetachingDuration() external view returns (uint64);
  function getContext(bytes32 ctxHash) external view returns (address controller, uint64 detachingDuration);
  function createContext(address controller, uint64 detachingDuration, bytes calldata ctxMsg) external returns (bytes32 ctxHash);
  function updateContext(bytes32 ctxHash, address newController, uint64 newDetachingDuration) external;
  function isAttachedWithContext(bytes32 ctxHash, uint256 tokenId) external view returns (bool);
  function attachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;
  function requestDetachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;
  function execDetachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;
  function getContextUser(bytes32 ctxHash, uint256 tokenId) external view returns (address user);
  function setContextUser(bytes32 ctxHash, uint256 tokenId, address user) external;
  function isTokenContextLocked(bytes32 ctxHash, uint256 tokenId) external view returns (bool);
  function setContextLock(bytes32 ctxHash, uint256 tokenId, bool lock) external;
  function getOwnershipManager(uint256 tokenId) external view returns(address manager);
  function getOwnershipDelegatee(uint256 tokenId) external view returns (address delegatee, uint64 until);
  function pendingOwnershipDelegatee(uint256 tokenId) external view returns (address delegatee, uint64 until);
  function startDelegateOwnership(uint256 tokenId, address delegatee, uint64 until) external;
  function acceptOwnershipDelegation(uint256 tokenId) external;
  function stopOwnershipDelegation(uint256 tokenId) external;
}

// Note: ERC-165 identifier for IERC7695Enumerable is 0xcebf44b7.
interface IERC7695Enumerable /* is IERC165 */ {
  function getContext(uint256 index) external view returns(bytes32 ctxHash);
  function getContextCount() external view returns(uint256);
  function getAttachedContext(uint256 tokenId, uint256 index) external view returns(bytes32 ctxHash);
  function getAttachedContextCount(uint256 tokenId) external view returns(uint256);
}

// Note: ERC-165 identifier for IERC7695ContextCallback is 0xad0491f1.
interface IERC7695ContextCallback /* is IERC165 */  {
  function onAttached(bytes32 ctxHash, uint256 tokenId, address operator, bytes calldata data) external;
  function onDetachRequested(bytes32 ctxHash, uint256 tokenId, address operator, bytes calldata data) external;
  function onExecDetachContext(bytes32 ctxHash, uint256 tokenId, address user, address operator, bytes calldata data) external;
}

event ContextUpdated(bytes32 indexed ctxHash, address indexed controller, uint64 detachingDuration);

event ContextAttached(bytes32 indexed ctxHash, uint256 indexed tokenId);

event ContextDetachmentRequested(bytes32 indexed ctxHash, uint256 indexed tokenId);

event ContextDetached(bytes32 indexed ctxHash, uint256 indexed tokenId);

event ContextUserAssigned(bytes32 indexed ctxHash, uint256 indexed tokenId, address indexed user);

event ContextLockUpdated(bytes32 indexed ctxHash, uint256 indexed tokenId, bool locked);

event OwnershipDelegationStarted(uint256 indexed tokenId, address indexed delegatee, uint64 until);

event OwnershipDelegationAccepted(uint256 indexed tokenId, address indexed delegatee, uint64 until);

event OwnershipDelegationStopped(uint256 indexed tokenId, address indexed delegatee);

function maxDetachingDuration() external view returns (uint64);

function getContext(bytes32 ctxHash) external view returns (address controller, uint64 detachingDuration);

function createContext(address controller, uint64 detachingDuration, bytes calldata ctxMsg)
  external
  returns (bytes32 ctxHash);

function updateContext(bytes32 ctxHash, address newController, uint64 newDetachingDuration) external;

function isAttachedWithContext(bytes32 ctxHash, uint256 tokenId) external view returns (bool);

function attachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;

function requestDetachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;

function execDetachContext(bytes32 ctxHash, uint256 tokenId, bytes calldata data) external;

function getContextUser(bytes32 ctxHash, uint256 tokenId) external view returns (address user);

function setContextUser(bytes32 ctxHash, uint256 tokenId, address user) external;

function isTokenContextLocked(bytes32 ctxHash, uint256 tokenId) external view returns (bool);

function setContextLock(bytes32 ctxHash, uint256 tokenId, bool lock) external;

function getOwnershipManager(uint256 tokenId) external view returns(address manager);

function getOwnershipDelegatee(uint256 tokenId) external view returns (address delegatee, uint64 until);

function pendingOwnershipDelegatee(uint256 tokenId) external view returns (address delegatee, uint64 until);

function startDelegateOwnership(uint256 tokenId, address delegatee, uint64 until) external;

function acceptOwnershipDelegation(uint256 tokenId) external;

function stopOwnershipDelegation(uint256 tokenId) external;

/// Note: the ERC-165 identifier for this interface is 0xcebf44b7.
interface IERC7695Enumerable /* is IERC165 */ {
  /// @dev Returns a created context in this contract at `index`.
  /// An index must be a value between 0 and {getContextCount}, non-inclusive.
  /// Note: When using {getContext} and {getContextCount}, make sure you perform all queries on the same block.
  function getContext(uint256 index) external view returns(bytes32 ctxHash);

  /// @dev Returns the number of contexts created in the contract.
  function getContextCount() external view returns(uint256);

  /// @dev Returns a context attached to a token at `index`.
  /// An index must be a value between 0 and {getAttachedContextCount}, non-inclusive.
  /// Note: When using {getAttachedContext} and {getAttachedContextCount}, make sure you perform all queries on the same block.
  function getAttachedContext(uint256 tokenId, uint256 index) external view returns(bytes32 ctxHash);

  /// @dev Returns the number of contexts attached to the token.
  function getAttachedContextCount(uint256 tokenId) external view returns(uint256);
}

function getContext(uint256 index) external view returns(bytes32 ctxHash);

function getContextCount() external view returns(uint256);

function getAttachedContext(uint256 tokenId, uint256 index) external view returns(bytes32 ctxHash);

function getAttachedContextCount(uint256 tokenId) external view returns(uint256);

/// Note: the ERC-165 identifier for this interface is 0xad0491f1.
interface IERC7695ContextCallback /* is IERC165 */  {
  /// @dev This method is called once the token is attached by any mechanism.
  /// This function MAY throw to revert and reject the attachment.
  /// @param ctxHash  The hash of context invoked this call.
  /// @param tokenId  NFT identifier which is being attached.
  /// @param operator The address which called {attachContext} function.
  /// @param data     Additional data with no specified format.
  function onAttached(bytes32 ctxHash, uint256 tokenId, address operator, bytes calldata data) external;

  /// @dev This method is called once the token detachment is requested by any mechanism.
  /// @param ctxHash  The hash of context invoked this call.
  /// @param tokenId  NFT identifier which is being requested for detachment.
  /// @param operator The address which called {requestDetachContext} function.
  /// @param data     Additional data with no specified format.
  function onDetachRequested(bytes32 ctxHash, uint256 tokenId, address operator, bytes calldata data) external;

  /// @dev This method is called once a token context is detached by any mechanism.
  /// @param ctxHash  The hash of context invoked this call.
  /// @param tokenId  NFT identifier which is being detached.
  /// @param user     The address of the context user which is being detached.
  /// @param operator The address which called {execDetachContext} function.
  /// @param data     Additional data with no specified format.
  function onExecDetachContext(bytes32 ctxHash, uint256 tokenId, address user, address operator, bytes calldata data) external;
}

function onAttached(bytes32 ctxHash, uint256 tokenId, address operator, bytes calldata data) external;

function onDetachRequested(bytes32 ctxHash, uint256 tokenId, address operator, bytes calldata data) external;

function onExecDetachContext(bytes32 ctxHash, uint256 tokenId, address user, address operator, bytes calldata data) external;