Skip to content

docs: update SDK documentation for clarity and accuracy #4

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

Merged
Mackenzie-OO7 merged 1 commit into from
Nov 2, 2026
Merged

docs: update SDK documentation for clarity and accuracy #4

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
2 changes: 0 additions & 2 deletions sdk/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ It covers two savings primitives:
- **Target Savings**: the user saves toward a target by a deadline, with scheduled deposits that the contract collects and deposits the user makes by hand.
- **Spend & Save**: each time the user spends, a share of the spend is saved, either to a Spend & Save balance or into a Target Savings goal. The balance can be withdrawn on one day each month.

The SDK has its own contracts, separate from the Loktin app's for now.

## Status

This is `1.0.0`, the first stable release, so the API changes only in a new major version. It works on Stellar testnet only.
Expand Down
6 changes: 3 additions & 3 deletions sdk/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: "Roles, pause, upgrades, fees and audit status of the Loktin SDK's contracts."
---

# Security and trust
# Security

This page says who can do what on the Loktin contracts, and what no one can do.

Expand Down Expand Up @@ -71,12 +71,12 @@ Every fee and penalty calculation rounds any fraction down, in the user's favour

## There is no yield

There is no yield. Savings are held as they are deposited. The contracts' yield slot is switched off, and the constructor refuses any yield source.
There is no yield. Savings are held as they are deposited. The contracts' yield slot is switched off, and at present, the constructor refuses any yield source.

## Libraries and audit status

The contracts use OpenZeppelin stellar-contracts 0.8.0, which has been audited. The Loktin contracts themselves have not been audited.

## Testnet only

The contracts have no mainnet deployment, and the SDK refuses the public network.
The contracts have no mainnet deployment, and the SDK only runs on the testnet.
Loading