-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add comments to belief methods
- Loading branch information
1 parent
66c22d3
commit 94c6923
Showing
2 changed files
with
11 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; | ||
} |