nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-11-09 22:09:06 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix some info of nip55 to be same as other nips

Browse Source
This commit is contained in:
DASHU 2024-07-02 16:02:31 +08:00
parent a551c5b693
commit d2d494d728
1 changed files with 89 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
55.md
View File

@ -99,10 +99,10 @@ launcher.launch(intent)
context.startActivity(intent) context.startActivity(intent)
``` ```
- result: - result:
- If the user approved intent it will return the **npub** in the signature field - If the user approved intent it will return the **pubkey** in the signature field
```kotlin ```kotlin
val npub = intent.data?.getStringExtra("signature") val pubkey = intent.data?.getStringExtra("signature")
// The package name of the signer application // The package name of the signer application
val packageName = intent.data?.getStringExtra("package") val packageName = intent.data?.getStringExtra("package")
``` ```
@ -116,8 +116,8 @@ launcher.launch(intent)
intent.putExtra("type", "sign_event") intent.putExtra("type", "sign_event")
// To handle results when not waiting between intents // To handle results when not waiting between intents
intent.putExtra("id", event.id) intent.putExtra("id", event.id)
// Send the current logged in user npub // Send the current logged in user pubkey
intent.putExtra("current_user", npub) intent.putExtra("current_user", pubkey)
context.startActivity(intent) context.startActivity(intent)
``` ```
@ -140,10 +140,10 @@ launcher.launch(intent)
intent.putExtra("type", "nip04_encrypt") intent.putExtra("type", "nip04_encrypt")
// to control the result in your application in case you are not waiting the result before sending another intent // to control the result in your application in case you are not waiting the result before sending another intent
intent.putExtra("id", "some_id") intent.putExtra("id", "some_id")
// Send the current logged in user npub // Send the current logged in user pubkey
intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) intent.putExtra("current_user", account.keyPair.pubkey)
// Send the hex pubKey that will be used for encrypting the data // Send the hex pubkey that will be used for encrypting the data
intent.putExtra("pubKey", pubKey) intent.putExtra("pubkey", pubkey)
context.startActivity(intent) context.startActivity(intent)
``` ```
@ -165,10 +165,10 @@ launcher.launch(intent)
intent.putExtra("type", "nip44_encrypt") intent.putExtra("type", "nip44_encrypt")
// to control the result in your application in case you are not waiting the result before sending another intent // to control the result in your application in case you are not waiting the result before sending another intent
intent.putExtra("id", "some_id") intent.putExtra("id", "some_id")
// Send the current logged in user npub // Send the current logged in user pubkey
intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) intent.putExtra("current_user", account.keyPair.pubkey)
// Send the hex pubKey that will be used for encrypting the data // Send the hex pubkey that will be used for encrypting the data
intent.putExtra("pubKey", pubKey) intent.putExtra("pubkey", pubkey)
context.startActivity(intent) context.startActivity(intent)
``` ```
@ -190,10 +190,10 @@ launcher.launch(intent)
intent.putExtra("type", "nip04_decrypt") intent.putExtra("type", "nip04_decrypt")
// to control the result in your application in case you are not waiting the result before sending another intent // to control the result in your application in case you are not waiting the result before sending another intent
intent.putExtra("id", "some_id") intent.putExtra("id", "some_id")
// Send the current logged in user npub // Send the current logged in user pubkey
intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) intent.putExtra("current_user", account.keyPair.pubkey)
// Send the hex pubKey that will be used for decrypting the data // Send the hex pubkey that will be used for decrypting the data
intent.putExtra("pubKey", pubKey) intent.putExtra("pubkey", pubkey)
context.startActivity(intent) context.startActivity(intent)
``` ```
@ -215,10 +215,10 @@ launcher.launch(intent)
intent.putExtra("type", "nip04_decrypt") intent.putExtra("type", "nip04_decrypt")
// to control the result in your application in case you are not waiting the result before sending another intent // to control the result in your application in case you are not waiting the result before sending another intent
intent.putExtra("id", "some_id") intent.putExtra("id", "some_id")
// Send the current logged in user npub // Send the current logged in user pubkey
intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) intent.putExtra("current_user", account.keyPair.pubkey)
// Send the hex pubKey that will be used for decrypting the data // Send the hex pubkey that will be used for decrypting the data
intent.putExtra("pubKey", pubKey) intent.putExtra("pubkey", pubkey)
context.startActivity(intent) context.startActivity(intent)
``` ```
@ -231,6 +231,29 @@ launcher.launch(intent)
val id = intent.data?.getStringExtra("id") val id = intent.data?.getStringExtra("id")
``` ```
- **get_relays**
- params:
```kotlin
val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:"))
intent.`package` = "com.example.signer"
intent.putExtra("type", "get_relays")
// to control the result in your application in case you are not waiting the result before sending another intent
intent.putExtra("id", "some_id")
// Send the current logged in user pubkey
intent.putExtra("current_user", account.keyPair.pubkey)
context.startActivity(intent)
```
- result:
- If the user approved intent it will return the **signature** and **id** fields
```kotlin
val relayJsonText = intent.data?.getStringExtra("signature")
// the id you sent
val id = intent.data?.getStringExtra("id")
```
- **decrypt_zap_event** - **decrypt_zap_event**
- params: - params:
@ -240,8 +263,8 @@ launcher.launch(intent)
intent.putExtra("type", "decrypt_zap_event") intent.putExtra("type", "decrypt_zap_event")
// to control the result in your application in case you are not waiting the result before sending another intent // to control the result in your application in case you are not waiting the result before sending another intent
intent.putExtra("id", "some_id") intent.putExtra("id", "some_id")
// Send the current logged in user npub // Send the current logged in user pubkey
intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) intent.putExtra("current_user", account.keyPair.pubkey)
context.startActivity(intent) context.startActivity(intent)
``` ```
- result: - result:
@ -257,7 +280,7 @@ launcher.launch(intent)
To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result.
If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null If the user did not check the "remember my choice" option, the pubkey is not in Signer Application or the signer type is not recognized the `contentResolver` will return null
For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json
@ -280,7 +303,7 @@ If the user chose to always reject the event, signer application will return the
) )
``` ```
- result: - result:
- Will return the **npub** in the signature column - Will return the **pubkey** in the signature column
```kotlin ```kotlin
if (result == null) return if (result == null) return
@ -288,7 +311,7 @@ If the user chose to always reject the event, signer application will return the
if (result.moveToFirst()) { if (result.moveToFirst()) {
val index = it.getColumnIndex("signature") val index = it.getColumnIndex("signature")
if (index < 0) return if (index < 0) return
val npub = it.getString(index) val pubkey = it.getString(index)
} }
``` ```
@ -298,7 +321,7 @@ If the user chose to always reject the event, signer application will return the
```kotlin ```kotlin
val result = context.contentResolver.query( val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.SIGN_EVENT"), Uri.parse("content://com.example.signer.SIGN_EVENT"),
listOf("$eventJson", "", "${logged_in_user_npub}"), listOf("$eventJson", "", "${logged_in_user_pubkey}"),
null, null,
null, null,
null null
@ -324,7 +347,7 @@ If the user chose to always reject the event, signer application will return the
```kotlin ```kotlin
val result = context.contentResolver.query( val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), Uri.parse("content://com.example.signer.NIP04_ENCRYPT"),
listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
null, null,
null, null,
null null
@ -348,7 +371,7 @@ If the user chose to always reject the event, signer application will return the
```kotlin ```kotlin
val result = context.contentResolver.query( val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), Uri.parse("content://com.example.signer.NIP44_ENCRYPT"),
listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
null, null,
null, null,
null null
@ -372,7 +395,7 @@ If the user chose to always reject the event, signer application will return the
```kotlin ```kotlin
val result = context.contentResolver.query( val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.NIP04_DECRYPT"), Uri.parse("content://com.example.signer.NIP04_DECRYPT"),
listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
null, null,
null, null,
null null
@ -396,7 +419,7 @@ If the user chose to always reject the event, signer application will return the
```kotlin ```kotlin
val result = context.contentResolver.query( val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.NIP44_DECRYPT"), Uri.parse("content://com.example.signer.NIP44_DECRYPT"),
listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
null, null,
null, null,
null null
@ -414,13 +437,37 @@ If the user chose to always reject the event, signer application will return the
} }
``` ```
- **get_relays**
- params:
```kotlin
val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.GET_RELAYS"),
listOf("${logged_in_user_pubkey}"),
null,
null,
null
)
```
- result:
- Will return the **signature** column
```kotlin
if (result == null) return
if (result.moveToFirst()) {
val index = it.getColumnIndex("signature")
val relayJsonText = it.getString(index)
}
```
- **decrypt_zap_event** - **decrypt_zap_event**
- params: - params:
```kotlin ```kotlin
val result = context.contentResolver.query( val result = context.contentResolver.query(
Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"),
listOf("$eventJson", "", "${logged_in_user_npub}"), listOf("$eventJson", "", "${logged_in_user_pubkey}"),
null, null,
null, null,
null null
@ -470,28 +517,35 @@ Android intents and browser urls have limitations, so if you are using the `retu
- params: - params:
```js ```js
window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`;
``` ```
- **nip44_encrypt** - **nip44_encrypt**
- params: - params:
```js ```js
window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`;
``` ```
- **nip04_decrypt** - **nip04_decrypt**
- params: - params:
```js ```js
window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`;
``` ```
- **nip44_decrypt** - **nip44_decrypt**
- params: - params:
```js ```js
window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`;
```
- **get_relays**
- params:
```js
window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_relays&callbackUrl=https://example.com/?event=`;
``` ```
- **decrypt_zap_event** - **decrypt_zap_event**