Refactored Pairing API to a single array of inner arrays

Author: Talha Ali

.gitignore

@@ -18,3 +18,6 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# Jetbrains IDEs
+.idea/

docs/specs/clients/core/pairing/data-structures.md

@@ -56,3 +56,14 @@ Relay is defined by the transport protocol used for the two clients to publish a
   "data": string, // optional
 }
 ```
+
+## Protocol Types
+
+```jsonc
+ const ProtocolType = {
+ 	Sign: "sign",
+ 	Auth: "auth",
+  Chat: "chat",
+  Push: "push"
+ }
+```

docs/specs/clients/core/pairing/pairing-api.md

@@ -17,7 +17,7 @@ abstract class PairingClient {
   public abstract activate(params: { topic: string }): Promise<void>;
 
   // for both to subscribe on methods requests
-  public abstract register(params: { reqMethods: string[], optMethods: string[] }): Promise<void>;
+  public abstract register(params: { method: string, type: ProtocolType }): Promise<void>;
 
   // for either to update the expiry of an existing pairing.
   public abstract updateExpiry(params: { topic: string, expiry: number }): Promise<void>;

docs/specs/clients/core/pairing/pairing-methods.md

@@ -1,98 +1,70 @@
 # Pairing Methods Validation Test Cases
 
 
-## 1. Peer B matches the required list and the optional list
+## 1. Peer B matches URI's list exactly
 
 ### Peer A's pairing uri:
-    uri = "...req-methods="wc_sessionPropose,wc_authRequest"&opt-methods="wc_authBatchRequest"" 
+    uri = "...methods=[wc_sessionPropose],[wc_authRequest,wc_authBatchRequest]"
+
 
 ### Peer B's registered methods:
-    var requiredList = ["wc_sessionPropose", "wc_authRequest"]
-    var optionalList = ["wc_authBatchRequest"]
+    var registeredMethods = [{ method = "wc_sessionPropose", type = ProtocolType.Sign }, { method = "wc_authRequest", type = ProtocolType.Auth }, { method = "wc_authBatchRequest", type = ProtocolType.Auth }]
 
 
 is valid? Yes
 
 ---
 
-## 2. Peer B matches the required list and partially matches the optional list
+## 2. Peer B matches one inner array exactly and partially matches another inner array
 
 ### Peer A's pairing uri:
-    uri = "...req-methods="wc_sessionPropose"&opt-methods="wc_authBatchRequest,wc_pushMessage"" 
+    uri = "...methods=[wc_sessionPropose],[wc_authBatchRequest]"
+
 
 ### Peer B's registered methods:
-    var requiredList = ["wc_sessionPropose"]
-    var optionalList = ["wc_authBatchRequest"]
+    var registeredMethods = [{ method = "wc_sessionPropose", type = ProtocolType.Sign }, { method = "wc_authRequest", type = ProtocolType.Auth }, { method = "wc_authBatchRequest", type = ProtocolType.Auth }]
 
 
 is valid? Yes
 
 ---
 
-## 3. Peer B matches the required list and does not paritially match the optional list
+## 3. Peer B contains more methods than URI's list of methods
 
 ### Peer A's pairing uri:
-    uri = "...req-methods="wc_sessionPropose"&opt-methods="wc_authBatchRequest,wc_pushMessage"" 
+    uri = "...methods=[wc_sessionPropose]"
+
 
 ### Peer B's registered methods:
-    var requiredList = ["wc_sessionPropose"]
-    var optionalList = []
+    var registeredMethods = [{ method = "wc_sessionPropose", type = ProtocolType.Sign }, { method = "wc_authRequest", type = ProtocolType.Auth }, { method = "wc_authBatchRequest", type = ProtocolType.Auth }]
 
 
 is valid? Yes
 
 ---
 
-## 4. Required list is empty and Peer B's paritially matches the optional list
+## 4. Peer B matches an inner array and does not partically match the other inner array
 
 ### Peer A's pairing uri:
-    uri = "...opt-methods="wc_authBatchRequest,wc_pushMessage"" 
-    
-### Peer B's registered methods:
-    var requiredList = []
-    var optionalList = ["wc_pushMessage"]
+    uri = "...methods=[wc_sessionPropose],[wc_authRequest]"
 
 
-is valid? Yes
-
----
-
-## 5. Peer B does not match the required list and matches the optional list
-
-### Peer A's pairing uri:
-    uri = "...req-methods="wc_sessionRequest"&opt-methods="wc_authBatchRequest,wc_pushMessage"" 
-    
 ### Peer B's registered methods:
-    var requiredList = ["wc_sessionPropose"]
-    var optionalList = ["wc_authBatchRequest","wc_pushMessage"]
+    var registeredMethods = [{ method = "wc_sessionPropose", type = ProtocolType.Sign }]
 
 
 is valid? No
 
 ---
 
-## 6. Peer B does not match the required list and partially matches the optional list
+## 5. Peer B does not match any inner arrays
 
 ### Peer A's pairing uri:
-    uri = "...req-methods="wc_sessionRequest"&opt-methods="wc_authBatchRequest,wc_pushMessage"" 
-    
-### Peer B's registered methods:
-    var requiredList = ["wc_sessionPropose"]
-    var optionalList = ["wc_authBatchRequest"]
-
-
-is valid? No
-
----
+    uri = "...methods=[wc_sessionPropose],[wc_authRequest]"
 
-## 7. Peer B does not match the required list and does not partially matches the optional list
 
-### Peer A's pairing uri:
-    uri = "...req-methods="wc_sessionRequest"&opt-methods="wc_authBatchRequest,wc_pushMessage"" 
-    
 ### Peer B's registered methods:
-    var requiredList = ["wc_sessionPropose"]
-    var optionalList = []
+    var registeredMethods = [{ method = "wc_sessionProposeV2", type = ProtocolType.Sign },{ method = "wc_authBatchRequest", type = ProtocolType.Auth }]
 
 
 is valid? No

docs/specs/clients/core/pairing/pairing-uri.md

@@ -17,8 +17,7 @@
 
 - `symKey` (STRING) = symmetric key used for pairing encryption
 - `relay-protocol` (STRING) = protocol name used for relay
-- `req-methods` (STRING) = comma separated list of methods that are all required when registered with the Pairing API's `register` method
-- `opt-methods` (STRING) = comma separated list of methods that are optional when registered with the Pairing API's `register` method
+- `methods` (STRING) = comma separated array of inner arrays of methods. Inner arrays are grouped by `ProtocolType`
 
 ### Optional
 
@@ -30,9 +29,8 @@
     version = 2
     symKey = "587d5484ce2a2a6ee3ba1962fdd7e8588e06200c46823bd18fbd67def96ad303"
     relay = { protocol: "irn", data: "" }
-    req-methods = ["wc_sessionPropose"]
-    opt-methods = ["wc_authBatchRequest","wc_authRequest"]
+    req-methods = [wc_sessionPropose],[wc_authRequest,wc_authBatchRequest]
 
 ```
-uri = "wc:7f6e504bfad60b485450578e05678ed3e8e8c4751d3c6160be17160d63ec90f9@2?relay-protocol=irn&symKey=587d5484ce2a2a6ee3ba1962fdd7e8588e06200c46823bd18fbd67def96ad303&req-methods=["wc_sessionPropose"]&opt-methods=["wc_authBatchRequest","wc_authRequest"]"
+uri = "wc:7f6e504bfad60b485450578e05678ed3e8e8c4751d3c6160be17160d63ec90f9@2?relay-protocol=irn&symKey=587d5484ce2a2a6ee3ba1962fdd7e8588e06200c46823bd18fbd67def96ad303&methods=[wc_sessionPropose],[wc_authRequest,wc_authBatchRequest]"
 ```

docs/specs/clients/core/pairing/readme.md

@@ -30,9 +30,9 @@ User visits a new website that requires a Sign session for submitting transactio
 2. A's pairing client registers protocol P by passing the list of methods required for protocol P
 3. A encrypts request with symKey S. Pairing client does not expects any response. P is responsible for response subscription.
 4. A sends request on pairing topic.
-5. A generates URI and appends the query parameter with the keys "req-methods" and "opt-methods", the value of each being an array.
+5. A generates URI and appends the query parameter with the keys "methods" and the value is an array of inner arrays.
 6. B's pairing client registers protocol P by passing lists of methods needed for Protocol P
-7. B verifies that the URI's "req-methods" query parameter's value equals B's cached "required" list of protocol methods along with checking if B's cached "optional" list matches any values in the URI's "opt-methods' query parameter's value and then subscribes to pairing topic from provided URI
+7. B verifies that the URI's "methods" query parameter's value against B's cached "registered methods" list of protocol methods. If verification being valid then B subscribes to pairing topic from provided URI
 8. B receives protocol P request.
 
 
@@ -42,9 +42,9 @@ User visits a new website that requires a Sign session for submitting transactio
 2. A's pairing client registers protocol P by passing the list of methods needed for protocol P
 3. A encrypts request with symKey S. Pairing client does not expects any response. P is responsible for response subscription.
 4. A sends request on pairing topic.
-5. A generates URI and appends the query parameter with a key "req-methods" with the value being a list of the required methods registered and a key "opt-methods" with the value being a list of optional methods.
+5. A generates URI and appends the query parameter with a key "methods" with the value being a list of the required methods registered.
 6. B's pairing client registers protocol P by passing the list of methods needed for Protocol P
-7. B verifies that the URI's "req-methods" query parameter's value equals B's cached "required" list of protocol methods along with checking if B's cached "optional" list matches any values in the URI's "opt-methods' query parameter's value. The verification fails by either not having all of the required methods or missing any of the optional methods. B will notify user that it cannot pair with A, and internally publish a wc_deletePairing with a reason.
+7. B verifies that the URI's "methods" query parameter equals B's cached "registered methods" list of protocol methods. The verification fails by based on any of the cases in [Pairing Methods](/docs/specs/clients/core/pairing/pairing-methods.md). B will notify user that it cannot pair with A, and internally publish a wc_deletePairing with a reason.
 
 ## Pairing lifecycle