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.

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

Major bump to comment lines ratio #73

Merged
Prev Previous commit
Next Next commit
IMintBurn code comments
  • Loading branch information
jaketimothy committed Jun 15, 2023
commit 7e74663e572b309f0128797a125ec13ad12d7a88
8 changes: 7 additions & 1 deletion src/IMintBurn.sol
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;

/// @notice
/// @notice Interface for token minting and burning
/// @author Dinari (https://github.com/dinaricrypto/issuer-contracts/blob/main/src/IMintBurn.sol)
/// Implemented by BridgedERC20
interface IMintBurn {
/// @notice Mint new tokens
/// @param to Address to mint tokens to
/// @param value Amount of tokens to mint
function mint(address to, uint256 value) external;

/// @notice Burn tokens
/// @param value Amount of tokens to burn
function burn(uint256 value) external;
}
1 change: 1 addition & 0 deletions src/issuer/BuyOrderIssuer.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {IMintBurn} from "../IMintBurn.sol";

/// @notice Contract managing market purchase orders for bridged assets
/// @author Dinari (https://github.com/dinaricrypto/issuer-contracts/blob/main/src/BuyOrderIssuer.sol)
/// Implicitly assumes that asset tokens are BridgedERC20 and can be minted
contract BuyOrderIssuer is OrderProcessor {
// Handle token transfers safely
using SafeERC20 for IERC20;
Expand Down
1 change: 1 addition & 0 deletions src/issuer/DirectBuyIssuer.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {IMintBurn} from "../IMintBurn.sol";
/// @author Dinari (https://github.com/dinaricrypto/issuer-contracts/blob/main/src/issuer/DirectBuyIssuer.sol)
/// The escrowed payment is taken by the operator before the order is filled
/// The operator can return unused escrowed payment to the user
/// Implicitly assumes that asset tokens are BridgedERC20 and can be minted
contract DirectBuyIssuer is BuyOrderIssuer {
using SafeERC20 for IERC20;

Expand Down
1 change: 1 addition & 0 deletions src/issuer/SellOrderProcessor.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {IMintBurn} from "../IMintBurn.sol";

/// @notice Contract managing market sell orders for bridged assets
/// @author Dinari (https://github.com/dinaricrypto/issuer-contracts/blob/main/src/issuer/SellOrderProcessor.sol)
/// Implicitly assumes that asset tokens are BridgedERC20 and can be burned
contract SellOrderProcessor is OrderProcessor {
using SafeERC20 for IERC20;

Expand Down