@loktin/sdk / spend-save / EnrollmentView

Interface: EnrollmentView

Defined in: @loktin/sdk/dist/spend-save/spend-save.d.ts:15

An enrolment, with the withdrawal day that applies now.

Extends

• Enrollment

Properties

destination

readonly destination: Destination

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:33

Inherited from

Enrollment.destination

---

effectiveWithdrawalDay

readonly effectiveWithdrawalDay: number

Defined in: @loktin/sdk/dist/spend-save/spend-save.d.ts:21

The withdrawal day that applies now, with any pending change that has taken effect. For display only: it uses the device clock in UTC, and at the edge of a month the chain decides.

---

integrator

readonly integrator: string

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:25

Inherited from

Enrollment.integrator

---

integratorFeeBps

readonly integratorFeeBps: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:26

Inherited from

Enrollment.integratorFeeBps

---

loktinFeeBps

readonly loktinFeeBps: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:27

Inherited from

Enrollment.loktinFeeBps

---

monthIndex

readonly monthIndex: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:41

The month savedThisMonth belongs to.

Inherited from

Enrollment.monthIndex

---

monthlyCap

readonly monthlyCap: bigint | undefined

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:32

Inherited from

Enrollment.monthlyCap

---

pendingDay

readonly pendingDay: PendingDay | undefined

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:36

Inherited from

Enrollment.pendingDay

---

principal

readonly principal: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:38

The Spend & Save balance.

Inherited from

Enrollment.principal

---

savedThisMonth

readonly savedThisMonth: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:42

Inherited from

Enrollment.savedThisMonth

---

shares

readonly shares: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:39

Inherited from

Enrollment.shares

---

skim

readonly skim: object

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:28

percentBps

readonly percentBps: number | undefined

roundUpUnit

readonly roundUpUnit: bigint | undefined

Inherited from

Enrollment.skim

---

totalSaved

readonly totalSaved: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:44

Inherited from

Enrollment.totalSaved

---

totalSpent

readonly totalSpent: bigint

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:43

Inherited from

Enrollment.totalSpent

---

user

readonly user: string

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:24

Inherited from

Enrollment.user

---

withdrawalDay

readonly withdrawalDay: number

Defined in: @loktin/sdk/dist/spend-save/types.d.ts:35

The stored withdrawal day. A pending change may already apply: see effectiveWithdrawalDay.

Inherited from

Enrollment.withdrawalDay