Skip to content

Commit 702a1b3

Browse files
committed
fix: natspec fix
1 parent cff2d76 commit 702a1b3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/ProofOfPassportRegister.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ contract ProofOfPassportRegister is IProofOfPassportRegister, Ownable {
107107
* @param verifier The new verifier address to set
108108
* @param nullifierIndexInPubSigArray The index of the nullifier in the pubSignals array
109109
* @dev This function is used to set a new verifier address.
110-
* It will check if the verifier address by first calling the _performVerifierChecks function.
110+
* It will check if the verifier address is valid by first calling the _performVerifierChecks function.
111111
* It will also check if the verifier address is valid by calling the verifyProof function of the verifier contract
112112
*/
113113
function setVerifier(uint256 signatureAlgorithm, address verifier, uint256 nullifierIndexInPubSigArray)
@@ -210,7 +210,7 @@ contract ProofOfPassportRegister is IProofOfPassportRegister, Ownable {
210210
* @param verifierAddress The verifier address to check
211211
* @notice Meant to check if the verifier address is valid. It shouldn't be a zero address and should be a contract address.
212212
* @dev This function is used to check if the verifier address is valid.
213-
* It is meant to be used in the setVerifier and setCSCAVerifier functions
213+
* It is meant to be used in the setVerifier functions
214214
*/
215215
function _performVerifierChecks(address verifierAddress) internal view {
216216
if (verifierAddress == address(0)) {
@@ -228,7 +228,7 @@ contract ProofOfPassportRegister is IProofOfPassportRegister, Ownable {
228228

229229
/**
230230
* @param proof The proof used to return the nullifier
231-
* @notice The nullifier is the fourth element of the pubSignals array
231+
* @notice The nullifier index is defined in the s_nullifierIndexPerSignatureAlgorithm mapping
232232
* @return nullifier The nullifier of the proof
233233
*/
234234
function _getNullifierFromProof(Proof calldata proof) internal view returns (uint256) {

0 commit comments

Comments
 (0)