Files
giza-kmp/README.md
T
Kgothatso NgakoandClaude Opus 5.5 b27ed2a05f docs: retire the wallet notes, and guard against a wallet coming back (wallet removal, Phase 8)
The 23 wallet notes move to docs/retired/ with a banner; every link between
notes is rewritten for the move and checked. The index lists them as one
Retired paragraph, and seven kept notes carry a line on what changed. The
README and CLAUDE.md describe a Giza with no wallet.

brand-audit.sh loses its "bennu/ exception: every such tag was a wallet's,
so one now is a wallet coming back. wallet-audit.sh --check, in check and
in CI, fails on a retired kind in the app's code, a lightning-kmp import,
a file named for a wallet's pieces, or sats in a string.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 16:15:13 +02:00

112 lines
4.6 KiB
Markdown

# Giza
Giza is a group chat app where the group can speak as one. Groups talk over
[nostr](https://github.com/nostr-protocol/nips) using the Marmot protocol's MLS encryption. A group can also run a key ceremony that gives it a threshold key, which no
single member holds. The group uses that key to sign as one: what it decides, who it makes a
subgroup of, what it says about itself, each signed by a quorum of its members. Giza keeps no
wallet ([docs/giza-wallet-removal.md](docs/giza-wallet-removal.md)).
It is a Kotlin Multiplatform app with a Compose Multiplatform UI, built for Android, iOS and
desktop (JVM).
## Giza and Bennu
Giza is a fork of [Bennu](https://code.sigidli.com/machankura/bennu-kmp), and the two still
speak the same protocol. A group can have members on both apps, and a Bennu recovery phrase
restored in Giza opens the same profile. The two install side by side as separate apps
(`mobi.giza.android` and `mobi.giza.ios`), each with its own data.
Bennu keeps wallets and Giza does not. A Bennu phrase restored in Giza brings back the profile
and nothing else, and a Bennu member who puts a wallet to a group Giza is in sees Giza's members
decline to sign for it.
[docs/giza-rebrand.md](docs/giza-rebrand.md) explains what the fork changed, what it left alone
and why.
## What it does
- **Group chat.** End-to-end encrypted groups on Marmot, with direct messages between members,
inside a group or one to one.
- **A key for the group.** A ChillDKG ceremony, run in the chat, gives the group a threshold key.
Members then approve and sign the group's events with FROST, several at a time if needed.
- **Subgroups.** A group can create subgroups, each with a key of its own, certified by its
parent's quorum.
- **Profiles.** Create a profile from a recovery phrase, sign in with an existing nsec or a
phrase, preview one from an npub, or keep several profiles on one device.
The reasoning behind each of these, including the protocol details and the failure modes, is in
[docs/](docs/README.md).
## Building
You need JDK 21 and the Android SDK. iOS builds also need Xcode on macOS.
Clone with submodules. The app builds against `lightning-kmp-app` as a composite build, and that
repository nests its own builds down to `secp256k1-kmp`:
```bash
git clone --recursive https://code.sigidli.com/giza.mobi/giza-kmp.git
```
In an existing clone, or in a git worktree, which does not get submodules automatically:
```bash
git submodule update --init --recursive
```
Each of the five nested Gradle builds needs a `local.properties` that points at the Android SDK.
The file is gitignored, so create it in each one:
```bash
for d in . lightning-kmp-app \
lightning-kmp-app/experimental/lightning-kmp \
lightning-kmp-app/experimental/lightning-kmp/experimental/bitcoin-kmp \
lightning-kmp-app/experimental/lightning-kmp/experimental/bitcoin-kmp/experimental/secp256k1-kmp; do
echo "sdk.dir=$HOME/Android/Sdk" > "$d/local.properties"
done
```
Then build each target (on Windows, use `gradlew.bat`):
- **Android:** `./gradlew :composeApp:assembleDebug`
- **Desktop:** `./gradlew :composeApp:run`
- **iOS:** open [iosApp](./iosApp) in Xcode and run it from there.
[docs/jvm-target.md](docs/jvm-target.md) explains what the desktop target needed and how it is
packaged.
## Checking your work
```bash
./gradlew :composeApp:compileDebugKotlinAndroid :composeApp:jvmTest
```
```bash
./gradlew check
```
`check` also runs the Material Design 3 audit, `docs/scripts/m3-audit.sh`. It fails a build that
adds hardcoded spacing or colours, title-case strings, or touch targets under 48dp. [CLAUDE.md](CLAUDE.md)
lists the UI conventions the audit enforces.
## Layout
- [composeApp](./composeApp/src) is the shared app. `commonMain` holds most of the code, and
`androidMain`, `iosMain` and `jvmMain` hold each platform's own parts.
- [iosApp](./iosApp) is the iOS entry point.
- [lightning-kmp-app](https://github.com/kngako/lightning-kmp-app) is a submodule. Giza takes
only its key and preference storage from it, and the threshold crypto (FROST, ChillDKG) from
the bitcoin-kmp fork it carries.
- [docs](docs/README.md) holds the design notes.
## License
Copyright (C) 2026 Machankura
This program is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
[GNU General Public License](LICENSE) for more details.