fix some info of nip55 to be same as other nips

nostr-protocol · Oct 7, 2024 · 7bb8997 · 7bb8997
1 parent e830a73
commit 7bb8997
Showing 1 changed file with 89 additions and 35 deletions.
diff --git a/55.md b/55.md
@@ -101,10 +101,10 @@ launcher.launch(intent)
     context.startActivity(intent)
     ```
   - 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
-      val npub = intent.data?.getStringExtra("signature")
+      val pubkey = intent.data?.getStringExtra("signature")
       // The package name of the signer application
       val packageName = intent.data?.getStringExtra("package")
       ```
@@ -118,8 +118,8 @@ launcher.launch(intent)
     intent.putExtra("type", "sign_event")
     // To handle results when not waiting between intents
     intent.putExtra("id", event.id)
-    // Send the current logged in user npub
-    intent.putExtra("current_user", npub)
+    // Send the current logged in user pubkey
+    intent.putExtra("current_user", pubkey)
 
     context.startActivity(intent)
     ```
@@ -142,10 +142,10 @@ launcher.launch(intent)
     intent.putExtra("type", "nip04_encrypt")
     // 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 npub
-    intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
-    // Send the hex pubKey that will be used for encrypting the data
-    intent.putExtra("pubKey", pubKey)
+    // Send the current logged in user pubkey
+    intent.putExtra("current_user", account.keyPair.pubkey)
+    // Send the hex pubkey that will be used for encrypting the data
+    intent.putExtra("pubkey", pubkey)
 
     context.startActivity(intent)
     ```
@@ -167,10 +167,10 @@ launcher.launch(intent)
     intent.putExtra("type", "nip44_encrypt")
     // 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 npub
-    intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
-    // Send the hex pubKey that will be used for encrypting the data
-    intent.putExtra("pubKey", pubKey)
+    // Send the current logged in user pubkey
+    intent.putExtra("current_user", account.keyPair.pubkey)
+    // Send the hex pubkey that will be used for encrypting the data
+    intent.putExtra("pubkey", pubkey)
 
     context.startActivity(intent)
     ```
@@ -192,10 +192,10 @@ launcher.launch(intent)
     intent.putExtra("type", "nip04_decrypt")
     // 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 npub
-    intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
-    // Send the hex pubKey that will be used for decrypting the data
-    intent.putExtra("pubKey", pubKey)
+    // Send the current logged in user pubkey
+    intent.putExtra("current_user", account.keyPair.pubkey)
+    // Send the hex pubkey that will be used for decrypting the data
+    intent.putExtra("pubkey", pubkey)
 
     context.startActivity(intent)
     ```
@@ -217,10 +217,10 @@ launcher.launch(intent)
     intent.putExtra("type", "nip04_decrypt")
     // 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 npub
-    intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
-    // Send the hex pubKey that will be used for decrypting the data
-    intent.putExtra("pubKey", pubKey)
+    // Send the current logged in user pubkey
+    intent.putExtra("current_user", account.keyPair.pubkey)
+    // Send the hex pubkey that will be used for decrypting the data
+    intent.putExtra("pubkey", pubkey)
 
     context.startActivity(intent)
     ```
@@ -233,6 +233,29 @@ launcher.launch(intent)
       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**
   - params:
 
@@ -242,8 +265,8 @@ launcher.launch(intent)
     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
     intent.putExtra("id", "some_id")
-    // Send the current logged in user npub
-    intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
+    // Send the current logged in user pubkey
+    intent.putExtra("current_user", account.keyPair.pubkey)
     context.startActivity(intent)
     ```
   - result:
@@ -259,7 +282,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.
 
-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
 
@@ -282,15 +305,15 @@ If the user chose to always reject the event, signer application will return the
     )
     ```
   - result:
-    - Will return the **npub** in the signature column
+    - Will return the **pubkey** in the signature column
 
       ```kotlin
         if (result == null) return
 
         if (result.moveToFirst()) {
             val index = it.getColumnIndex("signature")
             if (index < 0) return
-            val npub = it.getString(index)
+            val pubkey = it.getString(index)
         }
       ```
 
@@ -300,7 +323,7 @@ If the user chose to always reject the event, signer application will return the
     ```kotlin
     val result = context.contentResolver.query(
         Uri.parse("content://com.example.signer.SIGN_EVENT"),
-        listOf("$eventJson", "", "${logged_in_user_npub}"),
+        listOf("$eventJson", "", "${logged_in_user_pubkey}"),
         null,
         null,
         null
@@ -326,7 +349,7 @@ If the user chose to always reject the event, signer application will return the
     ```kotlin
     val result = context.contentResolver.query(
         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
@@ -350,7 +373,7 @@ If the user chose to always reject the event, signer application will return the
     ```kotlin
     val result = context.contentResolver.query(
         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
@@ -374,7 +397,7 @@ If the user chose to always reject the event, signer application will return the
     ```kotlin
     val result = context.contentResolver.query(
         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
@@ -398,7 +421,7 @@ If the user chose to always reject the event, signer application will return the
     ```kotlin
     val result = context.contentResolver.query(
         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
@@ -416,13 +439,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**
   - params:
 
     ```kotlin
     val result = context.contentResolver.query(
         Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"),
-        listOf("$eventJson", "", "${logged_in_user_npub}"),
+        listOf("$eventJson", "", "${logged_in_user_pubkey}"),
         null,
         null,
         null
@@ -472,28 +519,35 @@ Android intents and browser urls have limitations, so if you are using the `retu
   - params:
 
     ```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**
   - params:
 
     ```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**
   - params:
 
     ```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**
   - params:
 
     ```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**