ERC-4519: 绑定到物理资产的非同质化代币

pragma solidity ^0.8.0;
 /// @title EIP-4519 NFT: 对 EIP-721 非同质化代币标准的扩展。
///  注意：此接口的 EIP-165 标识符为 0x8a68abe3
 interface EIP-4519 NFT is EIP721/*,EIP165*/{
    /// @dev 当 NFT 被分配为新用户的实用程序时，会发出此事件。
    ///  当令牌的用户更改时，会发出此事件。
    ///  （`_addressUser` == 0）当未分配用户时。
    event UserAssigned(uint256 indexed tokenId, address indexed _addressUser);
    
    /// @dev 当用户和资产成功完成相互身份验证过程时，会发出此事件。
    ///  当用户和资产都证明它们共享安全通信通道时，会发出此事件。
    event UserEngaged(uint256 indexed tokenId);
    
    /// @dev 当所有者和资产成功完成相互身份验证过程时，会发出此事件。
    ///  当所有者和资产都证明它们共享安全通信通道时，会发出此事件。
    event OwnerEngaged(uint256 indexed tokenId);
    
    /// @dev 当检查到超时已过期时，会发出此事件。
    ///  当 EIP-4519 NFT 的时间戳未在超时内更新时，会发出此事件。
    event TimeoutAlarm(uint256 indexed tokenId);
    /// @notice 此函数定义了如何将 NFT 分配为新用户的实用程序（如果定义了“addressUser”）。
    /// @dev 只有 EIP-4519 NFT 的所有者才能分配用户。如果定义了“addressAsset”，则令牌的状态必须为
    /// "engagedWithOwner"、"waitingForUser" 或 "engagedWithUser"，并且此函数将由 "_tokenId" 定义的令牌的状态更改为
    /// "waitingForUser"。如果未定义“addressAsset”，则状态设置为“userAssigned”。在这两种情况下，此函数都将参数
    /// "addressUser" 设置为 "_addressUser"。
    /// @param _tokenId 是与资产绑定的 EIP-4519 NFT 的 tokenId。
    /// @param _addressUser 是新用户的地址。
    function setUser(uint256 _tokenId, address _addressUser) external payable; 
    /// @notice 此函数定义了所有者和资产之间的相互身份验证过程的初始化。
    /// @dev 只有令牌的所有者才能启动此身份验证过程（如果定义了“addressAsset”且令牌的状态为“waitingForOwner”）。
    /// 该函数不会更改令牌的状态，并将“_dataEngagement”
    /// 和“_hashK_OA”保存在令牌的参数中。
    /// @param _tokenId 是与资产绑定的 EIP-4519 NFT 的 tokenId。
    /// @param _dataEngagement 是所有者为共享密钥的协议提出的公共数据。
    /// @param _hashK_OA 是所有者提出的与资产共享的密钥的哈希。
    function startOwnerEngagement(uint256 _tokenId, uint256 _dataEngagement, uint256 _hashK_OA) external payable;
 
    /// @notice 此函数完成所有者和资产之间的相互身份验证过程。
    /// @dev 只有与令牌绑定的资产才能完成此身份验证过程，前提是令牌的状态为 
    /// "waitingForOwner" 且 dataEngagement 与 0 不同。此函数比较保存在
    /// 令牌中的 hashK_OA 与 hashK_A。如果它们相等，则令牌的状态更改为“engagedWithOwner”，dataEngagement 设置为 0，
    /// 并发出事件“OwnerEngaged”。
    /// @param _hashK_A 是资产生成的与所有者共享的密钥的哈希。
    function ownerEngagement(uint256 _hashK_A) external payable; 
 
    /// @notice 此函数定义了用户和资产之间的相互身份验证过程的初始化。
    /// @dev 只有令牌的用户才能启动此身份验证过程（如果定义了“addressAsset”和“addressUser”且
    /// 令牌的状态为“waitingForUser”）。该函数不会更改令牌的状态，并将“_dataEngagement”
    /// 和“_hashK_UA”保存在令牌的参数中。
    /// @param _tokenId 是与资产绑定的 EIP-4519 NFT 的 tokenId。
    /// @param _dataEngagement 是用户为共享密钥的协议提出的公共数据。
    /// @param _hashK_UA 是用户提出的与资产共享的密钥的哈希。
    function startUserEngagement(uint256 _tokenId, uint256 _dataEngagement, uint256 _hashK_UA) external payable;
    
    /// @notice 此函数完成用户和资产之间的相互身份验证过程。
    /// @dev 只有与令牌绑定的资产才能完成此身份验证过程，前提是令牌的状态为 
    /// "waitingForUser" 且 dataEngagement 与 0 不同。此函数比较保存在
    /// 令牌中的 hashK_UA 与 hashK_A。如果它们相等，则令牌的状态更改为“engagedWithUser”，dataEngagement 设置为 0，
    /// 并发出事件“UserEngaged”。
    /// @param _hashK_A 是资产生成的与用户共享的密钥的哈希。
    function userEngagement(uint256 _hashK_A) external payable; 
 
    /// @notice 此函数检查超时是否已过期。
    /// @dev 任何人都可以调用此函数来检查超时是否已过期。如果超时已过期，则会发出事件“TimeoutAlarm”。
    /// @param _tokenId 是与资产绑定的 EIP-4519 NFT 的 tokenId。
    /// @return 如果超时已过期，则为 true，否则为 false。
    function checkTimeout(uint256 _tokenId) external returns (bool);
    
    /// @notice 此函数设置超时的值。
    /// @dev 只有令牌的所有者才能设置此值，前提是令牌的状态为“engagedWithOwner”、
    /// "waitingForUser" 或 "engagedWithUser"。
    /// @param _tokenId 是与资产绑定的 EIP-4519 NFT 的 tokenId。
    /// @param _timeout 是要分配给超时的值。
    function setTimeout(uint256 _tokenId, uint256 _timeout) external; 
    
    /// @notice 此函数更新时间戳，从而避免超时警报。
    /// @dev 只有与令牌绑定的资产才能更新其自己的时间戳。
    function updateTimestamp() external; 
    
    /// @notice 此函数允许从地址获取 tokenId。
    /// @dev 任何人都可以调用此函数。执行的代码仅从以太坊读取。
    /// @param _addressAsset 是要从中获取 tokenId 的地址。
    /// @return 与生成 _addressAsset 的资产绑定的令牌的 tokenId。
    function tokenFromBCA(address _addressAsset) external view returns (uint256);
    
    /// @notice 此函数允许从与令牌绑定的资产的地址了解令牌的所有者。
    /// @dev 任何人都可以调用此函数。执行的代码仅从以太坊读取。
    /// @param _addressAsset 是要从中获取所有者的地址。
    /// @return 绑定到生成 _addressAsset 的资产的令牌的所有者。
    function ownerOfFromBCA(address _addressAsset) external view returns (address);
    
    /// @notice 此函数允许从其 tokenId 了解令牌的用户。
    /// @dev 任何人都可以调用此函数。执行的代码仅从以太坊读取。
    /// @param _tokenId 是与资产绑定的 EIP-4519 NFT 的 tokenId。
    /// @return 来自其 _tokenId 的令牌的用户。
    function userOf(uint256 _tokenId) external view returns (address);
    
    /// @notice 此函数允许从与令牌绑定的资产的地址了解令牌的用户。
    /// @dev 任何人都可以调用此函数。执行的代码仅从以太坊读取。
    /// @param _addressAsset 是要从中获取用户的地址。
    /// @return 与生成 _addressAsset 的资产绑定的令牌的用户。
    function userOfFromBCA(address _addressAsset) external view returns (address);
    
    /// @notice 此函数允许了解分配给用户的令牌数量。
    /// @dev 任何人都可以调用此函数。执行的代码仅从以太坊读取。
    /// @param _addressUser 是用户的地址。
    /// @return 分配给用户的令牌数量。
    function userBalanceOf(address _addressUser) external view returns (uint256);
    
    /// @notice 此函数允许了解特定所有者的多少个令牌分配给用户。
    /// @dev 任何人都可以调用此函数。执行的代码仅从以太坊读取。
    /// @param _addressUser 是用户的地址。
    /// @param _addressOwner 是所有者的地址。
    /// @return 从所有者分配给用户的令牌数量。
    function userBalanceOfAnOwner(address _addressUser, address _addressOwner) external view returns (uint256);
}