// SPDX-License-Identifier: GPL-3.0-or-later
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

pragma solidity ^0.7.0;

/**
 * @dev Registry of protocol IDs for external integrations with Balancer. The IDs chosen are arbitrary and do not affect
 * behavior of any Balancer contracts. They are used only to tag specific contracts (usually pools) at the data layer.
 */
interface IProtocolIdRegistry {
    // Emitted when a new protocol ID is registered.
    event ProtocolIdRegistered(uint256 indexed protocolId, string name);

    // Emitted when a protocol IDs name has been updated.
    event ProtocolIdRenamed(uint256 indexed protocolId, string name);

    /**
     * @dev Registers an ID (and name) to differentiate among protocols. Protocol IDs cannot be deregistered.
     */
    function registerProtocolId(uint256 protocolId, string memory name) external;

    /**
     * @dev Changes the name of an existing protocol ID. Should only be used to update in the case of mistakes.
     */
    function renameProtocolId(uint256 protocolId, string memory newName) external;

    /**
     * @dev Returns true if `protocolId` has been registered and can be queried.
     */
    function isValidProtocolId(uint256 protocolId) external view returns (bool);

    /**
     * @dev Returns the name associated with a given `protocolId`.
     */
    function getProtocolName(uint256 protocolId) external view returns (string memory);
}

library ProtocolId {
    // This list is not exhaustive - more protocol IDs can be added to the system. It is expected for this list to be
    // extended with new protocol IDs as they are registered, to keep them all in one place and reduce
    // likelihood of user error.
    // solhint-disable private-vars-leading-underscore
    uint256 internal constant AAVE_V1 = 0;
    uint256 internal constant AAVE_V2 = 1;
    uint256 internal constant AAVE_V3 = 2;
    uint256 internal constant AMPLEFORTH = 3;
    uint256 internal constant BEEFY = 4;
    uint256 internal constant EULER = 5;
    uint256 internal constant GEARBOX = 6;
    uint256 internal constant IDLE = 7;
    uint256 internal constant MORPHO = 8;
    uint256 internal constant RADIANT = 9;
    uint256 internal constant REAPER = 10;
    uint256 internal constant SILO = 11;
    uint256 internal constant STARGATE = 12;
    uint256 internal constant STURDY = 13;
    uint256 internal constant TESSERA = 14;
    uint256 internal constant TETU = 15;
    uint256 internal constant YEARN = 16;
    uint256 internal constant MIDAS = 17;
    uint256 internal constant AGAVE = 18;
    // solhint-enable private-vars-leading-underscore
}