highperfocused/amethyst
1
0
Fork 0
mirror of https://github.com/vitorpamplona/amethyst.git synced 2025-11-10 14:47:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updating the documentation on the use of Quartz

Browse Source
This commit is contained in:
Vitor Pamplona
2025-10-02 15:53:10 -04:00
committed by GitHub
parent c3b87e83cb
commit 1c82417a0a
1 changed files with 24 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -259,25 +259,25 @@ implementation('com.vitorpamplona.quartz:quartz-iossimulatorarm64:<Amethyst Vers
Manage logged in users with the `KeyPair` class Manage logged in users with the `KeyPair` class
```kt ```kt
val keys = KeyPair() // creates a random key val keyPair = KeyPair() // creates a random key
val keys = KeyPair("hex...".hexToByteArray()) val keyPair = KeyPair("hex...".hexToByteArray())
val keys = KeyPair("nsec1...".bechToBytes()) val keyPair = KeyPair("nsec1...".bechToBytes())
val keys = KeyPair(Nip06().privateKeyFromMnemonic("<mnemonic>")) val keyPair = KeyPair(Nip06().privateKeyFromMnemonic("<mnemonic>"))
val readOnly = KeyPair(pubKey = "hex...".hexToByteArray()) val readOnly = KeyPair(pubKey = "hex...".hexToByteArray())
val readOnly = KeyPair(pubKey = "npub1...".bechToBytes()) val readOnly = KeyPair(pubKey = "npub1...".bechToBytes())
``` ```
Create signers that can be internal, when you have the private key or when it is a read-only user Create signers that can be Internal, when you have the private key or a read-only public key,
or external, when it is controlled by Amber in NIP-55 or External, when it is controlled by Amber in NIP-55.
the `NostrSignerInternal` and `NostrSignerExternal` classes. Use either the `NostrSignerInternal` or `NostrSignerExternal` class:
```kt ```kt
val signer = NostrSignerInternal(keyPair) val signer = NostrSignerInternal(keyPair)
val amberSigner = NostrSignerExternal( val amberSigner = NostrSignerExternal(
pubKey = keyPair.pubKey.toHexKey(), pubKey = keyPair.pubKey.toHexKey(),
packageName = signerPackageName, packageName = signerPackageName, // Amber package name
contentResolver = appContext.contentResolver, contentResolver = appContext.contentResolver,
) )
``` ```
@@ -299,16 +299,19 @@ val client = NostrClient(socketBuilder, appScope)
If you want to auth, given a logged-in `signer`: If you want to auth, given a logged-in `signer`:
```kt ```kt
val authCoordinator = RelayAuthenticator(client, applicationIOScope) { challenge, relay -> val authCoordinator = RelayAuthenticator(client, appScope) { challenge, relay ->
val authedEvent = RelayAuthEvent.create(relayUrl, challenge, signer) val authedEvent = RelayAuthEvent.create(relay.url, challenge, signer)
client.sendIfExists(authedEvent, relay.url) client.sendIfExists(authedEvent, relay.url)
} }
``` ```
To manage subscriptions, the suggested approach is to use subscriptions in the Application class. To manage subscriptions, the simplest approach is to build mutable subscriptions in
the Application class. To use the best of the outbox model, this class allows you to
build filters for as many relays as needed. The `NostrClient` will connect to the
complete set of relays for all subscriptions.
```kt ```kt
val metadataSub = RelayClientSubscription( val metadataSub = NostrClientSubscription(
client = client, client = client,
filter = { filter = {
val filters = listOf( val filters = listOf(
@@ -330,6 +333,14 @@ val metadataSub = RelayClientSubscription(
} }
``` ```
In that way, you can simply call `metadataSub.updateFilter()` when you need to update
subscriptions to all relays. Or call `metadataSub.closeSubscription()` to stop the sub
without deleting it.
When your app goes to the background, you can use NostrClient's `connect` and `disconnect`
methods to stop all communication to relays. Add the `connect` to your `onResume` and `disconnect`
to `onPause` methods.
## Contributing ## Contributing
Issues can be logged on: [https://gitworkshop.dev/repo/amethyst](https://gitworkshop.dev/repo/amethyst) Issues can be logged on: [https://gitworkshop.dev/repo/amethyst](https://gitworkshop.dev/repo/amethyst)