Skip to content

Commit

Permalink
docs: add @ShubhamParkhi to RAB pragma
Browse files Browse the repository at this point in the history
  • Loading branch information
ShubhamParkhi committed Aug 17, 2024
1 parent 1ac5a19 commit ead340b
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
10 changes: 5 additions & 5 deletions contracts/CrossChainProofOfHumanity.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @authors: [@andreimvp]
* @reviewers: [@unknownunknown1*, @fnanni-0*, @hrishibhat*, @divyangchauhan, @Harman-singh-waraich, @wadader, @fcanela]
* @reviewers: [@unknownunknown1*, @fnanni-0*, @hrishibhat*, @divyangchauhan, @Harman-singh-waraich, @wadader, @fcanela, @ShubhamParkhi]
* @auditors: []
* @bounties: []
* @deployments: []
Expand Down Expand Up @@ -241,11 +241,11 @@ contract CrossChainProofOfHumanity is ICrossChainProofOfHumanity {
emit UpdateInitiated(_humanityId, owner, expirationTime, humanityClaimed, _bridgeGateway);
}

/** @notice Execute transfering the humanity to the foreign chain
/** @notice Execute transferring the humanity to the foreign chain
* @param _bridgeGateway address of the bridge gateway to use
*/
function transferHumanity(address _bridgeGateway) external allowedGateway(_bridgeGateway) {
// Function will require humanity to be claimed by sender, have no pending requests and human not vouching at the time
// Function will require humanity to be claimed by sender, have no pending requests and human not vouching for others at the time
(bytes20 humanityId, uint40 expirationTime) = proofOfHumanity.ccDischargeHumanity(msg.sender);

CrossChainHumanity storage humanity = humanityData[humanityId];
Expand Down Expand Up @@ -319,7 +319,7 @@ contract CrossChainProofOfHumanity is ICrossChainProofOfHumanity {
emit UpdateReceived(_humanityId, _owner, _expirationTime, _isActive);
}

/** @notice Receives the transfered humanity from the foreign proxy
/** @notice Receives the transferred humanity from the foreign proxy
* @dev Can only be called by a trusted gateway
* @param _owner Address of the human corresponding to the humanity
* @param _humanityId ID of the humanity
Expand Down Expand Up @@ -407,7 +407,7 @@ contract CrossChainProofOfHumanity is ICrossChainProofOfHumanity {

/** @notice Get the humanity corresponding to an address. Returns null humanity if it does not correspond to a humanity
* @notice First check state in main contract and, if no humanity returned, derive from state of this contract
* @param _account The address of the account to get the correspding humanity of
* @param _account The address of the account to get the corresponding humanity of
* @return humanityId The humanity corresponding to the account
*/
function humanityOf(address _account) external view returns (bytes20 humanityId) {
Expand Down
20 changes: 10 additions & 10 deletions contracts/ProofOfHumanity.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @authors: [@andreimvp]
* @reviewers: [@unknownunknown1, @shotaronowhere*, @gratestas, Param, @fnanni-0*, @divyangchauhan, @Harman-singh-waraich, @wadader, @fcanela]
* @reviewers: [@unknownunknown1, @shotaronowhere*, @gratestas, Param, @fnanni-0*, @divyangchauhan, @Harman-singh-waraich, @wadader, @fcanela, @ShubhamParkhi]
* @auditors: []
* @bounties: []
* @deployments: []
Expand All @@ -22,7 +22,7 @@ import {CappedMath} from "./libraries/CappedMath.sol";
* New registration requests firstly should gain sufficient amount of vouches from other registered users and only after that they can be accepted or challenged.
* The users who vouched for a human that lost the challenge with the reason Duplicate or DoesNotExist would be penalized with optional fine or ban period.
* @notice An impersonation attack can be performed by registering on the side-chain's contract instance with the same humanityId already registered on the
* home chain. The behaviour of this edgecase should be to keep the current owner of the identity on this chain as the owner. If this is an impersonation,
* home chain. The behaviour of this edge case should be to keep the current owner of the identity on this chain as the owner. If this is an impersonation,
* it's up to the impersonated to ask removal of the impersonator humanity so he can get it back.
* @notice This contract trusts that the Arbitrator is honest and will not reenter or modify its costs during a call.
* The arbitrator must support appeal period.
Expand Down Expand Up @@ -193,7 +193,7 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
/// @dev Stores the arbitrator data of the contract. Updated each time the data is changed.
ArbitratorData[] public arbitratorDataHistory;

/// @dev Maps the humanity id to the Humanity data. humanityData[humanityId].
/// @dev Maps the humanity ID to the Humanity data. humanityData[humanityId].
mapping(bytes20 => Humanity) private humanityData;

/// @dev Maps the address to the humanityId. It includes mapping to the humanity the owner or the account is in process of claiming. accountHumanity[address].
Expand Down Expand Up @@ -435,7 +435,7 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
* @param _clearingMetaEvidence The URI of the meta evidence object for clearing requests.
* @param _requestBaseDeposit The base deposit to make a request for a humanity.
* @param _humanityLifespan Time in seconds during which the claimed humanity won't automatically lose its status.
* @param _renewalPeriodDuration Value that defines the duration of humanity's renewal period.
* @param _renewalPeriodDuration Duration of the renewal period for a humanity.
* @param _challengePeriodDuration The time in seconds during which the request can be challenged.
* @param _failedRevocationCooldown The time in seconds after which a revocation request can be made after a previously failed one.
* @param _multipliers The array that contains fee stake multipliers to avoid 'stack too deep' error.
Expand Down Expand Up @@ -830,12 +830,12 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
_contribute(_humanityId, _requestId, 0, 0, Party.Requester, totalCost);
}

/** @notice Vouch that the human corresponds to the humanity id.
/** @notice Vouch that the human corresponds to the humanity ID.
*
* @dev Emits {VouchAdded} event.
*
* @param _account The address of the human.
* @param _humanityId The humanity id the vouch specifies human corresponds to.
* @param _humanityId The humanity ID the vouch specifies human corresponds to.
*/
function addVouch(address _account, bytes20 _humanityId) external {
vouches[msg.sender][_account][_humanityId] = true;
Expand All @@ -847,7 +847,7 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
* @dev Emits {VouchRemoved} event.
*
* @param _account The address of the human.
* @param _humanityId The humanity id the vouch specifies human corresponds to.
* @param _humanityId The humanity ID the vouch specifies human corresponds to.
*/
function removeVouch(address _account, bytes20 _humanityId) external {
vouches[msg.sender][_account][_humanityId] = false;
Expand Down Expand Up @@ -1593,7 +1593,7 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
}

/** @notice Get the information of a particular challenge of the request.
* @param _humanityId The queried humanity Id.
* @param _humanityId The queried humanity ID.
* @param _requestId The request to query.
* @param _challengeId The challenge to query.
* @return lastRoundId Id of last round.
Expand All @@ -1611,7 +1611,7 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
}

/** @notice Get the information of a round of a request.
* @param _humanityId The queried humanity Id.
* @param _humanityId The queried humanity ID.
* @param _requestId The request to query.
* @param _challengeId The challenge to query.
* @param _round The round to query.
Expand Down Expand Up @@ -1644,7 +1644,7 @@ contract ProofOfHumanity is IProofOfHumanity, IArbitrable, IEvidence {
}

/** @notice Get the contributions made by a party for a given round of a given challenge of a request.
* @param _humanityId The humanity id.
* @param _humanityId The humanity ID.
* @param _requestId The request to query.
* @param _challengeId the challenge to query.
* @param _round The round to query.
Expand Down
2 changes: 1 addition & 1 deletion contracts/extending-old/ForkModule.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @authors: []
* @reviewers: [@divyangchauhan, @Harman-singh-waraich]
* @reviewers: [@divyangchauhan, @Harman-singh-waraich, @ShubhamParkhi]
* @auditors: []
* @bounties: []
* @deployments: []
Expand Down
8 changes: 4 additions & 4 deletions contracts/extending-old/ProofOfHumanityExtended.sol
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @authors: [@andreimvp]
* @reviewers: [@unknownunknown1, @shotaronowhere*, @gratestas, Param, @fnanni-0*, @divyangchauhan, @Harman-singh-waraich]
* @reviewers: [@unknownunknown1, @shotaronowhere*, @gratestas, Param, @fnanni-0*, @divyangchauhan, @Harman-singh-waraich, @ShubhamParkhi]
* @auditors: []
* @bounties: []
* @deployments: []
Expand Down Expand Up @@ -1367,7 +1367,7 @@ contract ProofOfHumanityExtended is IProofOfHumanity, IArbitrable, IEvidence {
resultRuling = Party.Requester;
else if (round.sideFunded == Party.Challenger) resultRuling = Party.Challenger;

// Store the rulings of each dispute for correct distribution of rewards.
// Store the ruling of each dispute for correct distribution of rewards.
challenge.ruling = resultRuling;

emit Ruling(IArbitrator(msg.sender), _disputeId, uint256(resultRuling));
Expand Down Expand Up @@ -1408,7 +1408,7 @@ contract ProofOfHumanityExtended is IProofOfHumanity, IArbitrable, IEvidence {
return;
}
}
// Challenger won or its a tie.
// Challenger won or it's a tie.
} else if (resultRuling == Party.Challenger) request.ultimateChallenger = challenge.challenger;
}

Expand Down Expand Up @@ -1610,7 +1610,7 @@ contract ProofOfHumanityExtended is IProofOfHumanity, IArbitrable, IEvidence {

/** @notice Get information of a request of a humanity.
* @param _humanityId The address of the humanity.
* @param _requestId The request
* @param _requestId The request ID
*/
function getRequestInfo(
bytes20 _humanityId,
Expand Down
4 changes: 2 additions & 2 deletions contracts/extending-old/ProofOfHumanityOld.sol
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** SPDX-License-Identifier: MIT
* @authors: [@unknownunknown1, @nix1g]
* @reviewers: [@fnanni-0, @mtsalenc*, @nix1g, @clesaege*, @hbarcelos*, @ferittuncer*, @shalzz, @MerlinEgalite, @divyangchauhan]
* @reviewers: [@fnanni-0, @mtsalenc*, @nix1g, @clesaege*, @hbarcelos*, @ferittuncer*, @shalzz, @MerlinEgalite, @divyangchauhan, @ShubhamParkhi]
* @auditors: []
* @bounties: []
* @deployments: []
Expand Down Expand Up @@ -1183,7 +1183,7 @@ contract ProofOfHumanityOld is IArbitrable, IEvidence {
request.resolved = true;
}
}
// Challenger won or its a tie.
// Challenger won or it's a tie.
} else {
request.requesterLost = true;
// Update the status of the submission if there is no more disputes left.
Expand Down

0 comments on commit ead340b

Please sign in to comment.