Skip to content

Commit

Permalink
Added contract Natspec
Browse files Browse the repository at this point in the history
  • Loading branch information
naddison36 committed Oct 28, 2024
1 parent e1c04d9 commit ee3ef88
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/contracts/AbstractARM.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol";
import {OwnableOperable} from "./OwnableOperable.sol";
import {IERC20, ICapManager} from "./Interfaces.sol";

/**
* @title Generic Automated Redemption Manager (ARM)
* @author Origin Protocol Inc
*/
abstract contract AbstractARM is OwnableOperable, ERC20Upgradeable {
////////////////////////////////////////////////////
/// Constants
Expand Down
4 changes: 4 additions & 0 deletions src/contracts/Ownable.sol
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.23;

/**
* @title Base contract that provides ownership control
* @author Origin Protocol Inc
*/
contract Ownable {
/// @notice The slot used to store the owner of the contract.
/// This is also used as the proxy admin.
Expand Down
4 changes: 4 additions & 0 deletions src/contracts/OwnableOperable.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ pragma solidity ^0.8.23;

import {Ownable} from "./Ownable.sol";

/**
* @title Base contract that provides ownership and operational control
* @author Origin Protocol Inc
*/
contract OwnableOperable is Ownable {
/// @notice The account that can request and claim withdrawals.
address public operator;
Expand Down

0 comments on commit ee3ef88

Please sign in to comment.