Skip to content

Commit

Permalink
chore: add comments to belief methods
Browse files Browse the repository at this point in the history
  • Loading branch information
marcuspang committed Oct 5, 2023
1 parent 66c22d3 commit 94c6923
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
2 changes: 0 additions & 2 deletions src/Beliefs/Beliefs.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
11 changes: 11 additions & 0 deletions src/Beliefs/IBeliefs.sol
Original file line number Diff line number Diff line change
@@ -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;
}

0 comments on commit 94c6923

Please sign in to comment.