IHatsIdUtilities.sol
1 // SPDX-License-Identifier: AGPL-3.0 2 // Copyright (C) 2023 Haberdasher Labs 3 // 4 // This program is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Affero General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // This program is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Affero General Public License for more details. 13 // 14 // You should have received a copy of the GNU Affero General Public License 15 // along with this program. If not, see <https://www.gnu.org/licenses/>. 16 17 pragma solidity >=0.8.13; 18 19 interface IHatsIdUtilities { 20 function buildHatId(uint256 _admin, uint16 _newHat) external pure returns (uint256 id); 21 22 function getHatLevel(uint256 _hatId) external view returns (uint32 level); 23 24 function getLocalHatLevel(uint256 _hatId) external pure returns (uint32 level); 25 26 function isTopHat(uint256 _hatId) external view returns (bool _topHat); 27 28 function isLocalTopHat(uint256 _hatId) external pure returns (bool _localTopHat); 29 30 function isValidHatId(uint256 _hatId) external view returns (bool validHatId); 31 32 function getAdminAtLevel(uint256 _hatId, uint32 _level) external view returns (uint256 admin); 33 34 function getAdminAtLocalLevel(uint256 _hatId, uint32 _level) external pure returns (uint256 admin); 35 36 function getTopHatDomain(uint256 _hatId) external view returns (uint32 domain); 37 38 function getTippyTopHatDomain(uint32 _topHatDomain) external view returns (uint32 domain); 39 40 function noCircularLinkage(uint32 _topHatDomain, uint256 _linkedAdmin) external view returns (bool notCircular); 41 42 function sameTippyTopHatDomain(uint32 _topHatDomain, uint256 _newAdminHat) 43 external 44 view 45 returns (bool sameDomain); 46 }