Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contracts): improve whistleblowing contract docs #18

Merged
merged 2 commits into from
Sep 12, 2024
Merged

docs(contracts): improve whistleblowing contract docs #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18e72f6
docs(contracts): improve whistleblowing contract docs
vplasencia Sep 12, 2024
b6ef35e
Update packages/contracts/contracts/SemaphoreWhistleblowing.sol
vplasencia Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"packageManager": "[email protected]",
"scripts": {
"build": "yarn build:libraries && yarn compile:libraries",
"build": "yarn build:libraries && yarn compile:contracts",
"build:libraries": "yarn workspaces foreach -A --no-private run build",
"compile:contracts": "yarn workspace contract-extensions compile",
"test": "yarn test:libraries && yarn test:contracts && yarn test:circuits",
Expand Down
4 changes: 2 additions & 2 deletions packages/contracts/contracts/SemaphoreWhistleblowing.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ contract SemaphoreWhistleblowing is ISemaphoreWhistleblowing {
_;
}

/// @dev Initializes the Semaphore group used to verify the user's ZK proofs.
/// @param _semaphore: Semaphore group address.
/// @dev Initializes the Semaphore instance.
/// @param _semaphore: Semaphore contract address.
constructor(ISemaphore _semaphore) {
semaphore = _semaphore;
}
Expand Down
4 changes: 3 additions & 1 deletion packages/contracts/contracts/interfaces/ISemaphoreWhistleblowing.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ interface ISemaphoreWhistleblowing {
/// @param leak: News leak.
event LeakPublished(uint256 indexed entityId, uint256 leak);

/// @dev Creates an entity and the associated Merkle tree/group.
/// @dev Creates an entity and its associated Merkle tree/group.
/// An entity represents a group of individuals, such as an organization or
/// event participants.
/// @param editor: Editor of the entity.
function createEntity(address editor) external;

Expand Down