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.

Sign up for GitHub

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

Add more code comments / cleanup #164

Merged
merged 1 commit into from
Dec 15, 2022
Merged

Add more code comments / cleanup #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 62 additions & 28 deletions contracts/Loan.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ import "./libraries/LoanLib.sol";
import "./upgrades/BeaconImplementation.sol";

/**
* @title Loan
*
* Empty Loan contract.
* @title Perimeter Loan contract.
*/
contract Loan is ILoan, BeaconImplementation {
using SafeMath for uint256;
Expand All @@ -34,7 +32,7 @@ contract Loan is ILoan, BeaconImplementation {
uint256 public paymentsRemaining;
uint256 public paymentDueDate;
uint256 public callbackTimestamp;
ILoanSettings settings;
ILoanSettings public settings;

event FundsReclaimed(uint256 amount, address pool);

Expand Down Expand Up @@ -255,7 +253,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Post ERC20 tokens as collateral
* @inheritdoc ILoan
*/
function postFungibleCollateral(address asset, uint256 amount)
external
Expand All @@ -277,12 +275,8 @@ contract Loan is ILoan, BeaconImplementation {
return _state;
}

function fungibleCollateral() external view returns (address[] memory) {
return _fungibleCollateral;
}

/**
* @dev Post ERC721 tokens as collateral
* @inheritdoc ILoan
*/
function postNonFungibleCollateral(address asset, uint256 tokenId)
external
Expand All @@ -303,17 +297,8 @@ contract Loan is ILoan, BeaconImplementation {
return _state;
}

function nonFungibleCollateral()
external
view
returns (ILoanNonFungibleCollateral[] memory)
{
return _nonFungibleCollateral;
}

/**
* @dev Fund the Loan
* @dev Can only be called by the pool
* @inheritdoc ILoan
*/
function fund() external onlyPool returns (ILoanLifeCycleState) {
require(
Expand All @@ -330,7 +315,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Pool administrators can reclaim funds in open term loans.
* @inheritdoc ILoan
*/
function reclaimFunds(uint256 amount) external onlyNotPaused onlyPoolAdmin {
require(settings.loanType == ILoanType.Open);
Expand All @@ -342,7 +327,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Drawdown the Loan
* @inheritdoc ILoan
*/
function drawdown(uint256 amount)
external
Expand All @@ -367,8 +352,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Prepay principal.
* @dev Only callable by open term loans
* @inheritdoc ILoan
*/
function paydownPrincipal(uint256 amount)
external
Expand All @@ -383,7 +367,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Complete the next payment according to loan schedule inclusive of all fees.
* @inheritdoc ILoan
*/
function completeNextPayment()
external
Expand Down Expand Up @@ -423,8 +407,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Preview fees for a given interest payment amount.
* @param amount allows previewing the fee for a full or prorated payment.
* @inheritdoc ILoan
*/
function previewFees(uint256 amount)
public
Expand All @@ -444,7 +427,7 @@ contract Loan is ILoan, BeaconImplementation {
}

/**
* @dev Complete the final payment of the loan.
* @inheritdoc ILoan
*/
function completeFullPayment()
external
Expand Down Expand Up @@ -529,46 +512,97 @@ contract Loan is ILoan, BeaconImplementation {
callbackTimestamp = block.timestamp;
}

/**
* @inheritdoc ILoan
*/
function fungibleCollateral() external view returns (address[] memory) {
return _fungibleCollateral;
}

/**
* @inheritdoc ILoan
*/
function nonFungibleCollateral()
external
view
returns (ILoanNonFungibleCollateral[] memory)
{
return _nonFungibleCollateral;
}

/**
* @inheritdoc ILoan
*/
function state() external view returns (ILoanLifeCycleState) {
return _state;
}

/**
* @inheritdoc ILoan
*/
function borrower() external view returns (address) {
return _borrower;
}

/**
* @inheritdoc ILoan
*/
function pool() external view returns (address) {
return _pool;
}

/**
* @inheritdoc ILoan
*/
function factory() external view returns (address) {
return _factory;
}

/**
* @inheritdoc ILoan
*/
function dropDeadTimestamp() external view returns (uint256) {
return settings.dropDeadTimestamp;
}

/**
* @inheritdoc ILoan
*/
function duration() external view returns (uint256) {
return settings.duration;
}

/**
* @inheritdoc ILoan
*/
function paymentPeriod() external view returns (uint256) {
return settings.paymentPeriod;
}

/**
* @inheritdoc ILoan
*/
function apr() external view returns (uint256) {
return settings.apr;
}

/**
* @inheritdoc ILoan
*/
function principal() external view returns (uint256) {
return settings.principal;
}

/**
* @inheritdoc ILoan
*/
function loanType() external view returns (ILoanType) {
return settings.loanType;
}

/**
* @inheritdoc ILoan
*/
function serviceConfiguration()
external
view
Expand Down
Loading