From 94c692396594c99b21eb937cc2f60631c6b7f351 Mon Sep 17 00:00:00 2001 From: marcuspang Date: Fri, 6 Oct 2023 01:00:20 +0200 Subject: [PATCH] chore: add comments to belief methods --- src/Beliefs/Beliefs.sol | 2 -- src/Beliefs/IBeliefs.sol | 11 +++++++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/Beliefs/Beliefs.sol b/src/Beliefs/Beliefs.sol index a6c874f..d29c700 100644 --- a/src/Beliefs/Beliefs.sol +++ b/src/Beliefs/Beliefs.sol @@ -17,8 +17,6 @@ contract Beliefs is IBeliefs, Editions { // array of users who have believed in some project address[] internal _believers; - /// user methods - function believeProject(uint256 editionId, string memory tags) external payable override { if (msg.value < futureFundFee) { revert NotEnoughFunds(); diff --git a/src/Beliefs/IBeliefs.sol b/src/Beliefs/IBeliefs.sol index 90c2fe1..8a91d40 100644 --- a/src/Beliefs/IBeliefs.sol +++ b/src/Beliefs/IBeliefs.sol @@ -1,11 +1,22 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.13; +/// @title Interface for belief related methods +/// @author marcuspang.eth +/// @notice Explain to an end user what this does +/// @dev Explain to a developer any extra details interface IBeliefs { event EditionBelieved(uint256 indexed editionId, address indexed believer, string tags); event EditionBeliefRemoved(uint256 indexed editionId, address indexed believer); + /// @notice Believe in a project and distribute funds to the project and other projects in the same pool + /// @dev Remaining fees are distributed to RADAR + /// @param editionId The specified edition to believe in + /// @param tags The tags that the project is involved with function believeProject(uint256 editionId, string memory tags) external payable; + /// @notice Removes belief from a project + /// @dev Funds are not re-distributed back to the user + /// @param editionId The specified edition to remove belief from function removeBelief(uint256 editionId) external; }