ERC-5639: 委托注册表

/**
 * @title 一个不可变的注册合约，可以作为独立的原始合约部署
 * @dev 新项目启动可以从此读取之前的冷钱包 -> 热钱包委托
 *  并将这些权限集成到他们的流程中
 */
interface IDelegationRegistry {
    /// @notice 委托类型
    enum DelegationType {
        NONE,
        ALL,
        CONTRACT,
        TOKEN
    }

    /// @notice 有关单个委托的信息，用于链上枚举
    struct DelegationInfo {
        DelegationType type_;
        address vault;
        address delegate;
        address contract_;
        uint256 tokenId;
    }

    /// @notice 有关单个合约级委托的信息
    struct ContractDelegation {
        address contract_;
        address delegate;
    }

    /// @notice 有关单个 token 级委托的信息
    struct TokenDelegation {
        address contract_;
        uint256 tokenId;
        address delegate;
    }

    /// @notice 当用户委托他们的整个钱包时发出
    event DelegateForAll(address vault, address delegate, bool value);

    /// @notice 当用户委托一个特定的合约时发出
    event DelegateForContract(address vault, address delegate, address contract_, bool value);

    /// @notice 当用户委托一个特定的 token 时发出
    event DelegateForToken(address vault, address delegate, address contract_, uint26 tokenId, bool value);

    /// @notice 当用户撤销所有委托时发出
    event RevokeAllDelegates(address vault);

    /// @notice 当用户撤销给定委托的所有委托时发出
    event RevokeDelegate(address vault, address delegate);

    /**
     * -----------  WRITE -----------
     */

    /**
     * @notice 允许委托代表您对所有合约执行操作
     * @param delegate 代表您执行操作的热钱包
     * @param value 是否为此地址启用或禁用委托，true 用于设置，false 用于撤销
     */
    function delegateForAll(address delegate, bool value) external;

    /**
     * @notice 允许委托代表您对特定合约执行操作
     * @param delegate 代表您执行操作的热钱包
     * @param contract_ 您要委托的合约的地址
     * @param value 是否为此地址启用或禁用委托，true 用于设置，false 用于撤销
     */
    function delegateForContract(address delegate, address contract_, bool value) external;

    /**
     * @notice 允许委托代表您对特定 token 执行操作
     * @param delegate 代表您执行操作的热钱包
     * @param contract_ 您要委托的合约的地址
     * @param tokenId 您要委托的 token 的 token id
     * @param value 是否为此地址启用或禁用委托，true 用于设置，false 用于撤销
     */
    function delegateForToken(address delegate, address contract_, uint256 tokenId, bool value) external;

    /**
     * @notice 撤销所有委托
     */
    function revokeAllDelegates() external;

    /**
     * @notice 撤销特定委托的所有权限
     * @param delegate 要撤销的热钱包
     */
    function revokeDelegate(address delegate) external;

    /**
     * @notice 将自己从特定 vault 的委托中移除
     * @param vault 将 msg.sender 委托给 vault，应将其移除
     */
    function revokeSelf(address vault) external;

    /**
     * -----------  READ -----------
     */

    /**
     * @notice 返回给定委托能够代表执行的所有活动委托
     * @param delegate 您想要检索其委托的委托
     * @return info DelegationInfo 结构的数组
     */
    function getDelegationsByDelegate(address delegate) external view returns (DelegationInfo[] memory);

    /**
     * @notice 返回给定 vault 的所有钱包级委托的数组
     * @param vault 发出委托的冷钱包
     * @return addresses 给定 vault 的所有钱包级委托的数组
     */
    function getDelegatesForAll(address vault) external view returns (address[] memory);

    /**
     * @notice 返回给定 vault 和合约的所有合约级委托的数组
     * @param vault 发出委托的冷钱包
     * @param contract_ 您要委托的合约的地址
     * @return addresses 给定 vault 和合约的所有合约级委托的数组
     */
    function getDelegatesForContract(address vault, address contract_) external view returns (address[] memory);

    /**
     * @notice 返回给定 vault 的 token 的所有合约级委托的数组
     * @param vault 发出委托的冷钱包
     * @param contract_ 包含 token 的合约的地址
     * @param tokenId 您要委托的 token 的 token id
     * @return addresses 给定 vault 的 token 的所有合约级委托的数组
     */
    function getDelegatesForToken(address vault, address contract_, uint256 tokenId)
        external
        view
        returns (address[] memory);

    /**
     * @notice 返回给定 vault 的所有合约级委托
     * @param vault 发出委托的冷钱包
     * @return delegations ContractDelegation 结构的数组
     */
    function getContractLevelDelegations(address vault)
        external
        view
        returns (ContractDelegation[] memory delegations);

    /**
     * @notice 返回给定 vault 的所有 token 级委托
     * @param vault 发出委托的冷钱包
     * @return delegations TokenDelegation 结构的数组
     */
    function getTokenLevelDelegations(address vault) external view returns (TokenDelegation[] memory delegations);

    /**
     * @notice 如果该地址被委托代表整个 vault 执行操作，则返回 true
     * @param delegate 代表您执行操作的热钱包
     * @param vault 发出委托的冷钱包
     */
    function checkDelegateForAll(address delegate, address vault) external view returns (bool);

    /**
     * @notice 如果该地址被委托代表您对 token 合约或整个 vault 执行操作，则返回 true
     * @param delegate 代表您执行操作的热钱包
     * @param contract_ 您要委托的合约的地址
     * @param vault 发出委托的冷钱包
     */
    function checkDelegateForContract(address delegate, address vault, address contract_)
        external
        view
        returns (bool);

    /**
     * @notice 如果该地址被委托代表您对特定 token、token 的合约或整个 vault 执行操作，则返回 true
     * @param delegate 代表您执行操作的热钱包
     * @param contract_ 您要委托的合约的地址
     * @param tokenId 您要委托的 token 的 token id
     * @param vault 发出委托的冷钱包
     */
    function checkDelegateForToken(address delegate, address vault, address contract_, uint256 tokenId)
        external
        view
        returns (bool);
}