OCC_Modular.sol

Introduction

OCC stands for "On-Chain Credit".

A "Bullet" loan is an interest-only loan, with principal repaid in full at the end.

An "Amortization" loan is a principal and interest loan, with consistent payments until fully "Repaid".

This locker is responsible for handling accounting of loans.

This locker is responsible for handling payments and distribution of payments.

This locker is responsible for handling defaults and liquidations (if needed).

State Variables

Loan

This struct stores information for loans.

Combine

This struct stores information for loan combinations.

LoanState

This enumerator tracks loan states.

LoanSchedule

This enumerator tracks the payment schedule type for a loan.

Sections

Read Functions

• canPush() - Permission for owner to call pushToLocker(). See ZivoeLocker.sol

• canPull() - Permission for owner to call pullFromLocker(). See ZivoeLocker.sol

• canPullPartial() - Permission for owner to call pullFromLockerPartial(). See ZivoeLocker.sol

• loanInfo() - Returns information for a given loan. Refer to Loan

• amountOwed() - Returns information for amount owed on next payment of a particular loan

Write Functions - Core

• acceptOffer() - Funds and initiates a loan.

• callLoan() - Pays off the loan in full, plus additional interest for paymentInterval.

• cancelOffer() - Cancels a loan offer.

• createOffer() - Create a loan offer.

• makePayment() - Make a payment on a loan. Anyone is allowed to make a payment on someone's loan.

• markDefault() - Mark a loan insolvent if a payment hasn't been made beyond the corresponding grace period.

• markRepaid() - Underwriter specifies a loan has been repaid fully via interest deposits in terms of off-chain debt.

• processPayment() - Process a payment for a loan, on behalf of another borrower.

• resolveDefault() - Make a full (or partial) payment to resolve an insolvent loan.

• supplyInterest() - Supply interest to a repaid loan (for arbitrary interest repayment).

• updateOCTYDL() - Updates the OCT_YDL endpoint.

Write Functions - Loan Management

• applyCombine() - Combines multiple loans into a single loan.

• applyConversionToAmortization() - Converts a loan to amortization payment schedule.

• applyConversionBullet() - Converts a loan to bullet payment schedule.

• applyExtension() - Applies an extension to a loan.

• applyRefinance() - Refinances a loan.

• approveCombine() - Approves a borrower for combining loans.

• approveConversionToAmortization() - Approves a loan for conversion to amortization payment schedule.

• approveConversionToBullet() - Approves a loan for conversion to bullet payment schedule.

• approveExtension() - Approves an extension for a loan.

• approveRefinance() - Approves a loan for refinancing.

• unapproveCombine() - Unapproves a borrower for combining loans.

• unapproveConversionToAmortization() - Unapproves a loan for conversion to amortization payment schedule.

• unapproveConversionBullet() - Unapproves a loan for conversion to bullet payment schedule.

• unapproveExtension() - Unapproves an extension for a loan.

• unapproveRefinance() - Unapproves a loan for refinancing.

Events

• CombineApplied()

• CombineApproved()

• CombineLoanCreated()

• CombineUnapproved()

• ConversionToAmortizationApplied()

• ConversionToAmortizationApproved()

• ConversionToAmortizationUnapproved()

• ConversionToBulletApplied()

• #converesiontobulletapproved

• ConversionToBulletUnapproved()

• DefaultMarked()

• DefaultResolved()

• ExtensionApplied()

• ExtensionApproved()

• ExtensionUnapproved()

• InterestSupplied()

• LoanCalled()

• OfferAccepted()

• OfferCancelled()

• OfferCreated()

• PaymentMade()

• RefinanceApplied()

• RefinanceApproved()

• RefinanceUnapproved()

• RepaidMarked()

• UpdatedOCTYDL()

Read Functions

canPush()

Permission for owner to call pushToLocker(). See ZivoeLocker.sol

 function canPush() public override pure returns (bool) { return true; }

canPull()

Permission for owner to call pullFromLocker(). See ZivoeLocker.sol

function canPull() public override pure returns (bool) { return true; }

canPullPartial()

Permission for owner to call pullFromLockerPartial(). See ZivoeLocker.sol

function canPullPartial() public override pure returns (bool) { return true; }

loanInfo()

Returns information for a given loan. Refer to Loan

function loanInfo(uint256 id) public view returns (
    address borrower, 
    int8 paymentSchedule,
    uint256[10] memory details
);

Returns

/// @return info The remaining information for the loan:
///                  info[0] = principalOwed
///                  info[1] = APR
///                  info[2] = APRLateFee
///                  info[3] = paymentDueBy
///                  info[4] = paymentsRemaining
///                  info[5] = term
///                  info[6] = paymentInterval
///                  info[7] = offerExpiry
///                  info[8] = gracePeriod
///                  info[9] = loanState

amountOwed()

Returns information for amount owed on next payment of a particular loan

function amountOwed(uint256 id) public view returns (
    uint256 principal, 
    uint256 interest,
    uint256 lateFee, 
    uint256 total
);

Returns

Write Functions - Core

acceptOffer()

Funds and initiates a loan.

function acceptOffer(uint256 id) external nonReentrant;

Emits the OfferAccepted() event

callLoan()

Pays off the loan in full, plus additional interest for paymentInterval.

function callLoan(uint256 id) external nonReentrant;

Emits the LoanCalled() event

cancelOffer()

Cancels a loan offer.

function cancelOffer(uint256 id) isUnderwriter external;

Emits the OfferCancelled() event

createOffer()

Create a loan offer.

function createOffer(
    address borrower,
    uint256 borrowAmount,
    uint256 APR,
    uint256 APRLateFee,
    uint256 term,
    uint256 paymentInterval,
    uint256 gracePeriod,
    int8 paymentSchedule
) isUnderwriter external;

Emits the OfferCreated() event

makePayment()

Make a payment on a loan. Anyone is allowed to make a payment on someone's loan.

function makePayment(uint256 id) external nonReentrant;

Emits the PaymentMade() event

markDefault()

Mark a loan insolvent if a payment hasn't been made beyond the corresponding grace period.

function markDefault(uint256 id) external isUnderwriter;

Emits the DefaultMarked() event

markRepaid()

Underwriter specifies a loan has been repaid fully via interest deposits in terms of off-chain debt.

function markRepaid(uint256 id) external isUnderwriter;

Emits the RepaidMarked() event

processPayment()

Process a payment for a loan, on behalf of another borrower.

function processPayment(uint256 id) external nonReentrant;

Emits the PaymentMade() event

resolveDefault()

Make a full (or partial) payment to resolve an insolvent loan.

function resolveDefault(uint256 id, uint256 amount) external;

Emits the DefaultResolved() event

supplyInterest()

Supply interest to a repaid loan (for arbitrary interest repayment).

function supplyInterest(uint256 id, uint256 amount) external nonReentrant;

Emits the InterestSupplied() event

updateOCTYDL()

Updates the OCT_YDL endpoint.

function updateOCTYDL(address _OCT_YDL) external;

Emits the UpdatedOCTYDL() event

Write Functions - Loan Management

applyCombine()

Combines multiple loans into a single loan.

function applyCombine(uint256 id) external;

Emits the CombineApplied() and CombineLoanCreated() event(s)

applyConversionToAmortization()

Converts a loan to amortization payment schedule.

function applyConversionToAmortization(uint256 id) external;

Emits the ConversionToAmortizationApplied() event

applyConversionBullet()

Converts a loan to bullet payment schedule.

function applyConversionToBullet(uint256 id) external;

Emits the ConversionToBulletApplied() event

applyExtension()

Applies an extension to a loan.

function applyExtension(uint256 id) external;

Emits the ExtensionApplied() event

applyRefinance()

Refinances a loan.

function applyRefinance(uint256 id) external;

Emits the RefinanceApplied()

approveCombine()

Approves a borrower for combining loans.

function approveCombine(
    uint256[] calldata loanIDs, 
    uint256 term,
    uint256 paymentInterval, 
    uint256 gracePeriod,
    int8 paymentSchedule
) external isUnderwriter;

Emits the CombineApproved() event

approveConversionToAmortization()

Approves a loan for conversion to amortization payment schedule.

function approveConversionToAmortization(uint256 id) external isUnderwriter;

Emits the ConversionToAmortizationApproved() event

approveConversionToBullet()

Approves a loan for conversion to bullet payment schedule.

function approveConversionToBullet(uint256 id) external isUnderwriter;

Emits the ConversionToBulletApproved() event

approveExtension()

Approves an extension for a loan.

function approveExtension(uint256 id, uint256 intervals) external isUnderwriter;

Emits the ExtensionApproved() event

approveRefinance()

Approves a loan for refinancing.

function approveRefinance(uint256 id, uint256 apr) external isUnderwriter;

Emits the RefinanceApproved() event

unapproveCombine()

Unapproves a borrower for combining loans.

function unapproveCombine(uint256 id) external isUnderwriter;

Emits the CombineUnapproved() event

unapproveConversionToAmortization()

Unapproves a loan for conversion to amortization payment schedule.

function unapproveConversionToAmortization(uint256 id) external isUnderwriter;

Emits the ConversionToAmortizationUnapproved() event

unapproveConversionBullet()

Unapproves a loan for conversion to bullet payment schedule.

function unapproveConversionToBullet(uint256 id) external isUnderwriter;

Emits the ConversionToBulletUnapproved() event

unapproveExtension()

Unapproves an extension for a loan.

function unapproveExtension(uint256 id) external isUnderwriter;

Emits the ExtensionUnapproved() event

unapproveRefinance()

Unapproves a loan for refinancing.

function unapproveRefinance(uint256 id) external isUnderwriter;

Emits the RefinanceUnapproved() event

Events

CombineApplied()

Emitted during applyCombine()

event CombineApplied(
    address indexed borrower, 
    uint256[] loanIDs, 
    uint256 term,
    uint256 paymentInterval,
    uint256 gracePeriod,
    int8 indexed paymentSchedule
);

CombineApproved()

Emitted during approveCombine()

event CombineApproved(
    uint256 indexed id, 
    uint256[] loanIDs,
    uint256 term,
    uint256 paymentInterval, 
    uint256 gracePeriod,
    uint256 expires,
    int8 indexed paymentSchedule
);

CombineLoanCreated()

Emitted during applyCombine()

event CombineLoanCreated(
    address indexed borrower,
    uint256 indexed id,
    uint256 borrowAmount,
    uint256 APR,
    uint256 APRLateFee,
    uint256 paymentDueBy,
    uint256 term,
    uint256 paymentInterval,
    uint256 gracePeriod,
    int8 indexed paymentSchedule
);

CombineUnapproved()

Emitted during unapproveCombine()

event CombineUnapproved(uint256 id);

ConversionToAmortizationApplied()

Emitted during applyConversionToAmortization()

event ConversionToAmortizationApplied(uint256 indexed id);

ConversionToAmortizationApproved()

Emitted during approveConversionToAmortization()

event ConversionToAmortizationApproved(uint256 indexed id);

ConversionToAmortizationUnapproved()

Emitted during unapproveConversionToAmortization()

event ConversionToAmortizationUnapproved(uint256 indexed id);

ConversionToBulletApplied()

Emitted during applyConversionBullet()

event ConversionToBulletApplied(uint256 indexed id);

ConversionToBulletApproved()

Emitted during approveConversionToBullet()

event ConversionToBulletApproved(uint256 indexed id);

ConversionToBulletUnapproved()

Emitted during unapproveConversionBullet()

event ConversionToBulletUnapproved(uint256 indexed id);

DefaultMarked()

Emitted during markDefault()

event DefaultMarked(uint256 indexed id, uint256 principalDefaulted);

DefaultResolved()

Emitted during resolveDefault()

event DefaultResolved(
    uint256 indexed id, 
    uint256 amount, 
    address indexed payee, 
    bool resolved
);

ExtensionApplied()

Emitted during applyExtension()

event ExtensionApplied(uint256 indexed id, uint256 intervals);

ExtensionApproved()

Emitted during approveExtension()

event ExtensionApproved(uint256 indexed id, uint256 intervals);

ExtensionUnapproved()

Emitted during unapproveExtension()

event ExtensionUnapproved(uint256 indexed id);

InterestSupplied()

Emitted during supplyInterest()

event InterestSupplied(
    uint256 indexed id, 
    uint256 amount, 
    address indexed payee
);

LoanCalled()

Emitted during callLoan()

event LoanCalled(
    uint256 indexed id, 
    uint256 amount, 
    uint256 principal, 
    uint256 interest, 
    uint256 lateFee
);

OfferAccepted()

Emitted during acceptOffer()

event OfferAccepted(
    uint256 indexed id, 
    uint256 principal, 
    address indexed borrower, 
    uint256 paymentDueBy
);

OfferCancelled()

Emitted during cancelOffer()

event OfferCancelled(uint256 indexed id);

OfferCreated()

Emitted during createOffer()

event OfferCreated(
    address indexed borrower,
    uint256 indexed id,
    uint256 borrowAmount,
    uint256 APR,
    uint256 APRLateFee,
    uint256 term,
    uint256 paymentInterval,
    uint256 offerExpiry,
    uint256 gracePeriod,
    int8 indexed paymentSchedule
);

PaymentMade()

Emitted during makePayment() and processPayment()

event PaymentMade(
    uint256 indexed id, 
    address indexed payee, 
    uint256 amount, 
    uint256 principal, 
    uint256 interest, 
    uint256 lateFee, 
    uint256 nextPaymentDue
);

RefinanceApplied()

Emitted during applyRefinance()

event RefinanceApplied(uint256 indexed id, uint256 APRNew, uint256 APRPrior);

RefinanceApproved()

Emitted during approveRefinance()

event RefinanceApproved(uint256 indexed id, uint256 APR);

RefinanceUnapproved()

Emitted during unapproveRefinance()

event RefinanceUnapproved(uint256 indexed id);

RepaidMarked()

Emitted during markRepaid()

event RepaidMarked(uint256 indexed id);

UpdatedOCTYDL()

Emitted during updateOCTYDL()

event UpdatedOCTYDL(address indexed newOCT, address indexed oldOCT);