From 0bf110b0ab79822b5b189e907be9934e5fd313e0 Mon Sep 17 00:00:00 2001
From: "nicoacosta.eth" <nicoacosta8@gmail.com>
Date: Sat, 12 Oct 2024 02:28:56 -0300
Subject: [PATCH] questions: create interface IQuestion

---
 src/voting/interfaces/IQuestion.sol | 82 +++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 src/voting/interfaces/IQuestion.sol

diff --git a/src/voting/interfaces/IQuestion.sol b/src/voting/interfaces/IQuestion.sol
new file mode 100644
index 0000000..e980d7b
--- /dev/null
+++ b/src/voting/interfaces/IQuestion.sol
@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+import { IPoints } from "../../points/interfaces/IPoints.sol";
+
+interface IQuestion {
+	// Enums
+	enum Status {
+		Null,
+		Active,
+		Ended
+	}
+
+	// Structs
+	struct Option {
+		string title;
+		string description;
+		address proposer;
+	}
+
+	struct OptionView {
+		string title;
+		string description;
+		address proposer;
+		uint256 voteCount;
+		uint256 pointsAccrued;
+		bool userVoted;
+	}
+
+	struct QuestionView {
+		string title;
+		string description;
+		uint256 deadline;
+		uint256 totalVoteCount;
+		OptionView[] options;
+		Status status;
+		address owner;
+	}
+
+	// Events
+	event QuestionUpdated(string newTitle, string newDescription, uint256 newDeadline);
+	event Voted(address indexed voter, uint256 indexed optionId, uint256 timestamp);
+	event NewOption(address indexed proposer, uint256 indexed optionId, string title);
+
+	// Errors
+	error VotingEnded();
+	error AlreadyVoted();
+	error InvalidOption();
+
+	// Public variables
+	function title() external view returns (string memory);
+
+	function description() external view returns (string memory);
+
+	function deadline() external view returns (uint256);
+
+	function points() external view returns (IPoints);
+
+	// External functions
+	function vote(uint256 optionId) external;
+
+	function updateTitle(string memory _title) external;
+
+	function updateDescription(string memory _description) external;
+
+	function updateDeadline(uint256 _deadline) external;
+
+	function getOptions() external view returns (Option[] memory);
+
+	function getOption(uint256 optionId) external view returns (Option memory);
+
+	function getQuestionView(address user) external view returns (QuestionView memory);
+
+	// Public functions
+	function getStatus() external view returns (Status);
+
+	function getOptionVoteCount(uint256 optionId) external view returns (uint256);
+
+	function getOptionPointsAccrued(uint256 optionId) external view returns (uint256);
+
+	function hasVoted(address voter, uint256 optionId) external view returns (bool);
+}