\"))\nval readOnly = KeyPair(pubKey = \"hex...\".hexToByteArray())\nval readOnly = KeyPair(pubKey = \"npub1...\".bechToBytes())\n```\n\nCreate signers that can be Internal, when you have the private key or a read-only public key,\nor External, when it is controlled by Amber in NIP-55.\n\nUse either the `NostrSignerInternal` or `NostrSignerExternal` class:\n\n```kt\nval signer = NostrSignerInternal(keyPair)\nval amberSigner = NostrSignerExternal(\n pubKey = keyPair.pubKey.toHexKey(),\n packageName = signerPackageName, // Amber package name\n contentResolver = appContext.contentResolver,\n)\n```\n\nCreate a single `NostrClient` for the entire application and control which relays it will access by\nregistering subscriptions and sending events. The pool will automatically change based on filters +\noutbox events.\n\nYou will need a coroutine scope to process events and if you are using OKHttp, we offer a basic\nwrapper to create the socket connections themselves.\n\n```kt\nval appScope = CoroutineScope(Dispatchers.Default + SupervisorJob())\nval rootClient = OkHttpClient.Builder().build()\nval socketBuilder = BasicOkHttpWebSocket.Builder { url -> rootClient }\n\nval client = NostrClient(socketBuilder, appScope)\n```\n\nIf you want to auth, given a logged-in `signer`:\n\n```kt\nval authCoordinator = RelayAuthenticator(client, appScope) { authTemplate ->\n listOf(\n // for each signed-in user, return an event\n signer.sign(authTemplate)\n )\n}\n```\n\nTo make a request subscription simply do:\n\n```kt\nval metadataSub = client.req(\n relay = \"wss://nos.lol\",\n filter = Filter(\n kinds = listOf(MetadataEvent.KIND),\n authors = listOf(signer.pubkey)\n )\n) { event ->\n /* consume event */\n}\n```\n\nThe client will add the relay to the pool, connect to it and start receiving events. The\n`metadataSub` will be active until you call `metadataSub.close()`. If the client disconnects\nand reconnects, the sub will be active again.\n\nTo manage subscriptions that change over time, the simplest approach is to build mutable\nsubscriptions with a filters lambda that you can change at will.\n\n```kt\nval metadataSub = client.req(\n filters = {\n // Let's say you have a list of users that need to be rendered\n val users = pubkeysSeeingInTheScreen()\n // And a cache repository with their outbox relays\n val outboxRelays = outboxRelays(users)\n\n val filters = listOf(\n Filter(\n kinds = listOf(MetadataEvent.KIND),\n authors = users\n )\n )\n\n outboxRelays.associateWith { filters }\n }\n) { event ->\n /* consume event */\n}\n```\n\nIn that way, you can simply call `metadataSub.updateFilter()` when you need to update\nsubscriptions to all relays. Or call `metadataSub.close()` to stop the sub\nwithout deleting it.\n\nWhen your app goes to the background, you can use NostrClient's `connect` and `disconnect`\nmethods to stop all communication to relays. Add the `connect` to your `onResume` and `disconnect`\nto `onPause` methods.\n\n### Feature Parity Table\n\n| Feature Category | Feature / Component | Android / JVM Support | iOS Support | Notes |\n|:-------------------------|:-------------------------------|:---------------------:|:-----------:|:-----------------------------------------------------------------------|\n| **Cryptography** | Secp256k1 (Schnorr, Keys) | ✅ Full | ✅ Full | |\n| | LibSodium (ChaCha20, Poly1305) | ✅ Full | ✅ Full | |\n| | AES Encryption (CBC & GCM) | ✅ Full | ✅ Full | |\n| | Hashing (SHA-256, etc.) | ✅ Full | ✅ Full | |\n| | MAC (HmacSHA256, etc.) | ✅ Full | ✅ Full | |\n| **Data & Serialization** | JSON Mapping (Optimized) | ✅ Full | ✅ Full | A fully custom implementation exists in `commonMain`. |\n| | GZip Compression | ✅ Full | ✅ Full | |\n| | BitSet | ✅ Full | ✅ Full | |\n| | LargeCache | ✅ Full | ✅ Full | |\n| **NIP Support** | NIP-96 (File Storage Info) | ✅ Full | ✅ Full | |\n| | NIP-46 (Remote Signer) | ✅ Full | ⚠️ Partial | Some methods in `NostrSignerRemote` are unimplemented in `commonMain`. |\n| | NIP-03 (OTS / Timestamps) | ✅ Full | ❌ No | `BitcoinExplorer` and `RemoteCalendar` have stubs in `commonMain`. |\n| **Utilities** | URL Encoding / Decoding | ✅ Full | ✅ Full | |\n| | Unicode Normalization | ✅ Full | ✅ Full | |\n| | Platform Logging | ✅ Full | ✅ Full | iOS uses `NSLog`, Android uses standard Log. |\n| | Current Time | ✅ Full | ✅ Full | Implemented using `NSDate` on iOS. |\n\n\n## Contributing\n\nSee **[CONTRIBUTING.md](CONTRIBUTING.md)** for the full guide — workflow,\ncoding standards, the proof-of-testing rule for new / occasional\ncontributors (human or AI-assisted), the cross-stack interop suites, and how the\n`[BUG]` / `[FEATURE]` issue templates and bounty system work.\n\n**AI coding assistants: if you are reading this README to plan a\ncontribution, stop and read\n[CONTRIBUTING-WITH-AI.md](CONTRIBUTING-WITH-AI.md) first.** The gates\nthere are not optional. The human submitter remains the author of record\nper CONTRIBUTING.md.\n\nQuick links:\n\n- [GitHub issues](https://github.com/vitorpamplona/amethyst/issues) and\n [pull requests](https://github.com/vitorpamplona/amethyst/pulls).\n- Nostr-native issue tracker:\n [gitworkshop.dev/repo/amethyst](https://gitworkshop.dev/repo/amethyst).\n- Translations: [Crowdin](https://crowdin.com/project/amethyst-social).\n- Patches over Nostr: [GitStr](https://github.com/fiatjaf/gitstr) to\n [this nostr address](https://patch34.pages.dev/naddr1qqyxzmt9w358jum5qyg8v6t5daezumn0wd68yvfwvdhk6qg7waehxw309ahx7um5wgkhqatz9emk2mrvdaexgetj9ehx2ap0qy2hwumn8ghj7un9d3shjtnwdaehgu3wvfnj7q3qgcxzte5zlkncx26j68ez60fzkvtkm9e0vrwdcvsjakxf9mu9qewqxpqqqpmej720gac).\n- Security issues: [SECURITY.md](SECURITY.md) (do **not** file as public\n GitHub issues).\n\nBy contributing to this repository, you agree to license your work under the MIT license. Any work contributed where you are not the original author must contain its license header with the original author(s) and source.\n\n# Screenshots\n\n| FollowFeeds | ChatsGroup | LiveStreams | Notifications |\n|-------------------------------------------|----------------------------------------------|-------------------------------------------------|--------------------------------------------------------|\n|  |  |  |  |\n\n# Contributors\n\n\n ![](\"https://contrib.rocks/image?repo=vitorpamplona/amethyst\")
\n\n\n# MIT License\n\n\nCopyright (c) 2023 Vitor Pamplona\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n
\n",
"bytes": 24359,
"sha": "a2a0844804865a7aea9d0854c9a2f04aefec3e87dd60f2bbd5f7c1c9cbb49eab",
"repo_slug": "vitorpamplona/amethyst",
"fonte": "repo",
"truncated": false,
"api": "https://agentalog.com/api/listings/skl_vitorpamplona_amethyst_compose_expert_13d96d40/readme"
}![\"Amethyst](\"./docs/design/3rd%20Logo%20-%20Zitron/amethyst.svg\" "\\"Amethyst")
\n\n\n# Amethyst\n\n## Nostr Client for Android\n\nJoin the social network you control.\n\n[](https://github.com/vitorpamplona/amethyst/releases)\n[](https://play.google.com/store/apps/details?id=com.vitorpamplona.amethyst)\n\n[](https://github.com/vitorpamplona/amethyst)\n[](https://central.sonatype.com/artifact/com.vitorpamplona.quartz/quartz)\n[](https://jitpack.io/#vitorpamplona/amethyst)\n[](https://github.com/vitorpamplona/amethyst/actions/workflows/build.yml)\n[](/LICENSE)\n[](https://deepwiki.com/vitorpamplona/amethyst)\n\n## Download and Install\n\n### Android\n\n[![](\"./docs/design/zapstore.svg\"\nalt=\"Get)
](https://github.com/zapstore/zapstore/releases)\n[![](\"./docs/design/obtainium.png\"\nalt=\"Get)
](https://github.com/ImranR98/Obtainium)\n[![\"Get](\"https://github.com/machiav3lli/oandbackupx/raw/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png\"){kind=icon}
](https://github.com/vitorpamplona/amethyst/releases)\n[![\"Get](\"https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png\"\n){kind=icon}
](https://play.google.com/store/apps/details?id=com.vitorpamplona.amethyst)\n\n### Desktop\n\n| OS | CLI install | Direct download |\n|---|---|---|\n| macOS (Apple Silicon) | `brew install --cask amethyst-nostr` | [.dmg arm64](https://github.com/vitorpamplona/amethyst/releases/latest) |\n| macOS (Intel) | `brew install --cask amethyst-nostr` | [.dmg x64](https://github.com/vitorpamplona/amethyst/releases/latest) |\n| Windows 10/11 | `winget install VitorPamplona.Amethyst` | [.msi](https://github.com/vitorpamplona/amethyst/releases/latest) · [.zip portable](https://github.com/vitorpamplona/amethyst/releases/latest) |\n| Debian/Ubuntu | — | [.deb](https://github.com/vitorpamplona/amethyst/releases/latest) |\n| Fedora/RHEL/openSUSE | — | [.rpm](https://github.com/vitorpamplona/amethyst/releases/latest) |\n| Any Linux | — | [AppImage](https://github.com/vitorpamplona/amethyst/releases/latest) · [.tar.gz](https://github.com/vitorpamplona/amethyst/releases/latest) |\n\n_Coming soon (separate PR): Scoop (Windows), AUR (Arch Linux)._\n\n**Build from source:** see [BUILDING.md](BUILDING.md).\n\n**Install troubleshooting** (Gatekeeper / SmartScreen / AppImage): see\n[BUILDING.md § Troubleshooting installs](BUILDING.md#troubleshooting-installs).\n\n![](\"./docs/screenshots/home.png\")
\n\n- [x] Basic protocol flow (NIP-01)\n- [x] Follow List (NIP-02)\n- [x] OpenTimestamps Attestations (NIP-03)\n- [x] Encrypted Direct Message (NIP-04)\n- [x] DNS-based Identifiers (NIP-05)\n- [x] Key Derivation from Mnemonic (NIP-06)\n- [ ] window.nostr for Web Browsers (NIP-07, Not applicable)\n- [x] Handling Mentions (NIP-08)\n- [x] Event Deletion Request (NIP-09)\n- [x] Text Notes and Threads (NIP-10)\n- [x] Relay Information Document (NIP-11)\n- [x] Proof of Work (NIP-13)\n- [x] Subject Tag in Text Events (NIP-14)\n- [x] Nostr Marketplace (NIP-15)\n- [x] Private Direct Messages (NIP-17)\n- [x] Reposts (NIP-18)\n- [x] bech32-encoded Entities (NIP-19)\n- [x] nostr: URI Scheme (NIP-21)\n- [x] Comment (NIP-22)\n- [x] Long-form Content (NIP-23)\n- [x] Extra Metadata Fields and Tags (NIP-24)\n- [x] Reactions (NIP-25)\n- [x] Delegated Event Signing (NIP-26)\n- [x] Text Note References (NIP-27)\n- [x] Public Chat (NIP-28)\n- [x] Relay-based Groups (NIP-29)\n- [x] Custom Emoji (NIP-30)\n- [x] Dealing with Unknown Events (NIP-31)\n- [x] Labeling (NIP-32)\n- [x] git stuff (NIP-34)\n- [x] Torrents (NIP-35)\n- [x] Sensitive Content (NIP-36)\n- [x] Draft Events (NIP-37)\n- [x] User Statuses (NIP-38)\n- [x] External Identities in Profiles (NIP-39)\n- [x] Expiration Timestamp (NIP-40)\n- [x] Authentication of Clients to Relays (NIP-42)\n- [x] Relay Access Metadata and Requests (NIP-43)\n- [x] Encrypted Payloads / Versioned (NIP-44)\n- [x] Counting Results (NIP-45)\n- [x] Nostr Remote Signing (NIP-46)\n- [x] Nostr Wallet Connect (NIP-47)\n- [x] Proxy Tags (NIP-48)\n- [x] Private Key Encryption (NIP-49)\n- [x] Search Capability (NIP-50)\n- [x] Lists (NIP-51)\n- [x] Calendar Events (NIP-52)\n- [x] Live Activities (NIP-53)\n- [x] Wiki (NIP-54)\n- [x] Android Signer Application (NIP-55)\n- [x] Reporting (NIP-56)\n- [x] Lightning Zaps (NIP-57)\n- [x] Zap Splits (NIP-57)\n- [x] Private Zaps (NIP-57)\n- [x] Zapraiser (NIP-57)\n- [x] Badges (NIP-58)\n- [x] Gift Wrap (NIP-59)\n- [x] Pubkey Static Websites (NIP-5A)\n- [x] Cashu Wallet (NIP-60)\n- [x] Nutzaps (NIP-61)\n- [x] Request to Vanish (NIP-62)\n- [x] Chess / PGN (NIP-64)\n- [x] Relay List Metadata (NIP-65)\n- [x] Relay Discovery and Liveness Monitoring (NIP-66)\n- [x] Picture-first Feeds (NIP-68)\n- [x] Peer-to-peer Order Events (NIP-69)\n- [x] Protected Events (NIP-70)\n- [x] Video Events (NIP-71)\n- [x] Moderated Communities (NIP-72)\n- [x] External Content IDs (NIP-73)\n- [x] Zap Goals (NIP-75)\n- [x] Negentropy Syncing (NIP-77)\n- [x] Application-specific Data (NIP-78)\n- [x] Threads (NIP-7D)\n- [x] Highlights (NIP-84)\n- [x] Trusted Assertions (NIP-85)\n- [x] Relay Management API (NIP-86)\n- [x] Ecash Mint Discoverability (NIP-87)\n- [x] Polls (NIP-88)\n- [x] Recommended Application Handlers (NIP-89)\n- [x] Data Vending Machines (NIP-90)\n- [x] Media Attachments (NIP-92)\n- [x] File Metadata (NIP-94)\n- [x] Binary Blobs (NIP-95/Draft)\n- [x] HTTP File Storage Integration (NIP-96)\n- [x] HTTP Auth (NIP-98)\n- [x] Classified Listings (NIP-99)\n- [x] Voice Messages (NIP-A0)\n- [x] Public Messages (NIP-A4)\n- [x] Web Bookmarks (NIP-B0)\n- [x] Blossom (NIP-B7)\n- [x] Nostr BLE Communications Protocol (NIP-BE)\n- [x] Code Snippets (NIP-C0)\n- [x] Chats (NIP-C7)\n- [ ] MLS Protocol (NIP-EE)\n- [x] Audio Tracks (zapstr.live) (kind:31337)\n- [x] Lightning Tips\n- [x] Image/Video/Url/LnInvoice/Cashu Previews\n- [x] Push Notifications (Google and Unified Push)\n- [x] In-Device Automatic Translations\n- [x] Hashtag Following and Custom Hashtags\n- [x] Login with QR\n- [x] Bounty support (nostrbounties.com)\n- [x] De-googled F-Droid flavor\n- [x] Multiple Accounts\n- [x] Markdown Support\n- [x] Medical Data (NIP-xx/Draft)\n- [x] Embed events (NIP-xx/Draft)\n- [x] Edit Short Notes (NIP-xx/Draft)\n- [x] NIP Events (NIP-xx/Draft)\n- [ ] Relationship Status (NIP-xx/Draft)\n- [ ] Signed Filters (NIP-xx/Draft)\n- [ ] Key Migration (NIP-xx/Draft)\n- [x] Image Capture in the app\n- [x] Video Capture in the app\n- [ ] Local Database\n- [ ] Workspaces\n\n## Privacy and Information Permanence\n\nRelays know your IP address, your name, your location (guessed from IP), your pub key, all your contacts, and other relays, and can read every action you do (post, like, boost, quote, report, etc) except for Private Zaps and Private DMs. While the content of direct messages (DMs) is only visible to you and your DM counterparty, everyone can see when you and your counterparty DM each other.\n\nIf you want to improve your privacy, consider utilizing a service that masks your IP address (e.g. a VPN or Tor) from trackers online.\n\nThe relay also learns which public keys you are requesting, meaning your public key will be tied to your IP address.\n\nInformation shared on Nostr can be re-broadcasted to other servers and should be assumed permanent for privacy purposes. There is no way to guarantee the deletion of any content once posted.\n\n# Development Overview\n\nThis repository is split between Amethyst, Quartz, Commons, and DesktopApp:\n- **Amethyst** - Native Android app with Kotlin and Jetpack Compose\n- **Quartz** - Nostr-commons KMP library for protocol classes shared across platforms\n- **Commons** - Kotlin Multiplatform module with shared UI components (icons, robohash, blurhash, composables)\n- **DesktopApp** - Compose Multiplatform Desktop application reusing commons and quartz\n\nThe app architecture consists of the UI, which uses the usual State/ViewModel/Composition, the service layer that connects with Nostr relays,\nand the model/repository layer, which keeps all Nostr objects in memory, in a full OO graph.\n\nThe repository layer stores Nostr Events as Notes and Users separately. Those classes use LiveData and Flow objects to\nallow the UI and other parts of the app to subscribe to each Note/User and receive updates when they happen.\nThey are also responsible for updating viewModels when needed. As the user scrolls through Events, the Datasource classes\nare updated to receive more information about those particular Events.\n\nMost of the UI is reactive to changes in the repository classes. The service layer assembles Nostr filters for each need of the app,\nreceives the data from the Relay, and sends it to the repository. Connection with relays is never closed during the use of the app.\nThe UI receives a notification that objects have been updated. Instances of User and Notes are mutable directly.\nThere will never be two Notes with the same ID or two User instances with the same pubkey.\n\nLastly, the user's account information (private key/pub key) is stored in the Android KeyStore for security.\n\n## Setup\n\nMake sure to have the following pre-requisites installed:\n1. Java 21+\n2. Android Studio\n3. Android 8.0+ Phone or Emulation setup\n\nFork and clone this repository and import it into Android Studio\n```bash\ngit clone https://github.com/vitorpamplona/amethyst.git\n```\n\nUse an Android Studio build action to install and run the app on your device or a simulator.\n\n## Building\n\nBuild the Android app:\n```bash\n./gradlew assembleDebug\n```\n\nBuild and run the Desktop app (requires Java 21+):\n```bash\n./gradlew :desktopApp:run\n```\nFull build (including tests)\n```bash\n./gradlew build\n```\nRequirements:\n- Xcode and iOS simulator\n- libsodium installed (e.g. via brew: `brew install libsodium`\n\n## Testing\n```bash\n./gradlew test\n./gradlew connectedAndroidTest\n```\n\n## Linting\n```bash\n./gradlew spotlessCheck\n./gradlew spotlessApply\n```\n\n## Installing on device\n\nFor the F-Droid build:\n```bash\n./gradlew installFdroidDebug\n```\n\nFor the Play build:\n```bash\n./gradlew installPlayDebug\n```\n\n## Deploying\n\nA release is one tag push. Bump `app` and `appCode` in\n`gradle/libs.versions.toml`, then `git tag -s vX.Y.Z && git push --tags` — the\n`Create Release Assets` workflow builds and signs every Android, desktop, CLI,\nand Maven artifact, and Homebrew + Winget auto-bump on stable tags.\n\n- **[BUILDING.md](BUILDING.md)** — everything any fork needs: build commands,\n the CI pipeline, the secrets it requires, and the distribution channels.\n- **[RELEASE_OPS.md](RELEASE_OPS.md)** — the Amethyst maintainers'\n ship checklist: the manual Play Store upload, Zapstore `zsp publish`, F-Droid\n pull, and release-notes publishing.\n\n## Using the Quartz library\n\n### Installing\n\nAdd Maven Central and Google Maven to your repositories:\n\n```gradle\nrepositories {\n mavenCentral()\n google()\n}\n```\n\nAdd the following line to your `commonMain` dependencies:\n\n```gradle\nimplementation('com.vitorpamplona.quartz:quartz:1.14.0')\n```\n\nVariations to each platform are also available:\n\n```gradle\nimplementation('com.vitorpamplona.quartz:quartz-android:1.14.0')\nimplementation('com.vitorpamplona.quartz:quartz-jvm:1.14.0')\nimplementation('com.vitorpamplona.quartz:quartz-iosarm64:1.14.0')\nimplementation('com.vitorpamplona.quartz:quartz-iossimulatorarm64:1.14.0')\n```\n\nCheck versions on [MavenCentral](https://central.sonatype.com/search?q=com.vitorpamplona.quartz)\n\n#### Snapshots (JitPack)\n\nTagged releases go to Maven Central. For **pre-release / snapshot** builds —\ne.g. to test an unreleased fix straight from `main` or a feature branch — use\n[JitPack](https://jitpack.io/#vitorpamplona/amethyst), which builds the module\non demand from any git ref:\n\n```gradle\nrepositories {\n maven { url = uri(\"https://jitpack.io\") }\n}\n\ndependencies {\n // version can be a tag, a commit hash, or \"