Functions

getEpochLength

Returns the length of an epoch.

Returns

getRecurringPaymentInformation

Returns the RecurringPayment instance with id id.

Parameters

Returns

listRecurringPaymentIds

Returns total list of RecurringPayment ids.

List is in ascending order.

Returns

getPreviousPaymentId

Returns the id of previous RecurringPayment.

Parameters

Returns

isExistingRecurringPaymentId

Returns whether RecurringPayment with id id exists.

Parameters

Returns

getEpochFromTimestamp

Calculates the epoch from a given uint timestamp.

Calculation is: timestamp divided by epochLength.

Parameters

Returns

getCurrentEpoch

Calculates the current epoch.

Calculation is: block.timestamp divided by epochLength.

Returns

getFutureEpoch

Calculates a future epoch x epochs from now.

Calculation is: current epoch + X epochs in the future = futureEpoch.

Parameters

Returns

addRecurringPayment

Adds a recurring payment to the manager.

a new id is created for each Payment.

Parameters

Returns

removeRecurringPayment

Removes a recurring Payment.

Parameters

trigger

Triggers the start of the due payments for all recurring payment orders.

triggerFor

See trigger() but enables you to determine which ids you want to trigger payment ordes for.

this is to being able to bypass the unlikely event of having a runOutOfGas error for the normal trigger function.

Parameters

Events

RecurringPaymentAdded

Event emitted when a new recurring payment added.

Parameters

RecurringPaymentRemoved

Event emitted when a recurring payment was removed.

Parameters

RecurringPaymentsTriggered

Event emitted when a recurring payment was triggered.

Parameters

EpochLengthSet

Event emitted when the epoch length is set.

Parameters

Errors

Module__LM_PC_RecurringPayments__InvalidRecurringPaymentId

Given RecurringPayment id is invalid.

Module__LM_PC_RecurringPayments__InvalidStartEpoch

Start epoch cant be placed before the current epoch.

Module__LM_PC_RecurringPayments__InvalidEpochLength

Given EpochLength is invalid.

Module__LM_PC_RecurringPayments__StartIdNotBeforeEndId

Given startId is not position before endId.

Structs

RecurringPayment

Struct that holds the information of a RecurringPayment.

Properties