Skip to content

Commit

Permalink
[Q-2] Nitpicks
Browse files Browse the repository at this point in the history
  • Loading branch information
GWSzeto committed Sep 30, 2024
1 parent 1f4335a commit 5a4848c
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 8 deletions.
1 change: 1 addition & 0 deletions src/callback/BeforeMintCallbackERC721.sol
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ contract BeforeMintCallbackERC721 {
* @notice The beforeMintERC721 hook that is called by a core token before minting tokens.
*
* @param _to The address that is minting tokens.
* @param _startTokenId The token ID being minted.
* @param _amount The amount of tokens to mint.
* @param _data Optional extra data passed to the hook.
* @return result Abi encoded bytes result of the hook.
Expand Down
1 change: 1 addition & 0 deletions src/callback/BeforeMintWithSignatureCallbackERC1155.sol
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ contract BeforeMintWithSignatureCallbackERC1155 {
* @notice The beforeMintWithSignatureERC1155 hook that is called by a core token before minting tokens.
*
* @param _to The address that is minting tokens.
* @param _id The token ID being minted.
* @param _amount The quantity of tokens to mint.
* @param _data Optional extra data passed to the hook.
* @param _signer The address that signed the minting request.
Expand Down
1 change: 1 addition & 0 deletions src/callback/BeforeMintWithSignatureCallbackERC721.sol
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ contract BeforeMintWithSignatureCallbackERC721 {
* @notice The beforeMintWithSignatureERC721 hook that is called by a core token before minting tokens.
*
* @param _to The address that is minting tokens.
* @param _startTokenId The token ID being minted.
* @param _amount The amount of tokens to mint.
* @param _data Optional extra data passed to the hook.
* @param _signer The address that signed the minting request.
Expand Down
4 changes: 4 additions & 0 deletions src/core/token/ERC20Base.sol
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ contract ERC20Base is ERC20, Multicallable, Core, EIP712 {
* @param owner The account approving the tokens
* @param spender The address to approve
* @param amount Amount of tokens to approve
* @param deadline Deadline after which the approval is no longer valid
* @param v Signature param
* @param r Signature param
* @param s Signature param
*/
function permit(address owner, address spender, uint256 amount, uint256 deadline, uint8 v, bytes32 r, bytes32 s)
public
Expand Down
10 changes: 5 additions & 5 deletions src/module/token/minting/ClaimableERC20.sol
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,8 @@ contract ClaimableERC20 is
*
* @param startTimestamp The timestamp at which the minting request is valid.
* @param endTimestamp The timestamp at which the minting request expires.
* @param recipient The address that will receive the minted tokens.
* @param amount The amount of tokens to mint.
* @param currency The address of the currency used to pay for the minted tokens.
* @param maxMintPerWallet The maximum number of tokens that can be minted per wallet.
* @param pricePerUnit The price per unit of the minted tokens.
* @param uid A unique identifier for the minting request.
*/
Expand All @@ -108,8 +107,9 @@ contract ClaimableERC20 is
/**
* @notice The parameters sent to the `beforeMintERC20` callback function.
*
* @param request The minting request.
* @param signature The signature produced from signing the minting request.
* @param currency The address of the currency used to pay for the minted tokens.
* @param pricePerUnit The price per unit of the minted tokens.
* @param recipientAllowlistProof The proof of the recipient's address in the allowlist.
*/
struct ClaimParamsERC20 {
address currency;
Expand Down Expand Up @@ -206,7 +206,7 @@ contract ClaimableERC20 is
);
}

/// @notice Callback function for the ERC20Core.mint function.
/// @notice Callback function for the ERC20Core.mintWithSignature function.
function beforeMintWithSignatureERC20(address _to, uint256 _amount, bytes memory _data, address _signer)
external
payable
Expand Down
2 changes: 1 addition & 1 deletion src/module/token/minting/ClaimableERC721.sol
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ library ClaimableStorage {
mapping(bytes32 => bool) uidUsed;
// address => how many tokens have been minted
mapping(address => uint256) totalMinted;
// sale config: primary sale recipient, and platform fee recipient + BPS.
// sale config: primary sale recipient
ClaimableERC721.SaleConfig saleConfig;
// claim condition
ClaimableERC721.ClaimCondition claimCondition;
Expand Down
2 changes: 0 additions & 2 deletions src/module/token/minting/MintableERC20.sol
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ contract MintableERC20 is
*
* @param startTimestamp The timestamp at which the minting request is valid.
* @param endTimestamp The timestamp at which the minting request expires.
* @param recipient The address that will receive the minted tokens.
* @param amount The amount of tokens to mint.
* @param currency The address of the currency used to pay for the minted tokens.
* @param pricePerUnit The price per unit of the minted tokens.
* @param uid A unique identifier for the minting request.
Expand Down

0 comments on commit 5a4848c

Please sign in to comment.