Merge pull request #38 from INFURA/subscription_fixes

fixes to websocket subscription docs

Author: captDaylight

docs/gettingStarted/usefulLinks.md

@@ -4,3 +4,4 @@
 - [IPFS API documentation](https://ipfs.io/docs/api/)
 - [Ethereum Pub/Sub API documentation](https://github.com/ethereum/go-ethereum/wiki/RPC-PUB-SUB)
 - [Parity Ethereum Pub/Sub API documentation](https://wiki.parity.io/JSONRPC-Parity-Pub-Sub-module.html)
+- [Parity Pub/Sub API documentation](https://wiki.parity.io/JSONRPC-Eth-Pub-Sub-Module)

docs/wss/eth_subscribe.md

@@ -1,33 +1,30 @@
 # eth_subscribe
 
 Creates a new subscription over particular events. The node will return a subscription id. For each event that matches the subscription a notification with relevant data is send together with the subscription id.
-NOTE: eth_unsubscribe is only supported on geth nodes (Mainnet, Ropsten, Rinkeby networks)
 
 ### REQUEST PARAMS
 - `SUBSCRIPTION TYPE NAME` _[required]_ 
     - `newHeads`- Subscribing to this, fires a notification each time a new header is appended to the chain, including chain reorganizations. Users can use the bloom filter to determine if the block contains logs that are interested to them.
     - `logs` - Returns logs that are included in new imported blocks and match the given filter criteria. In case of a chain reorganization previous sent logs that are on the old chain will be resend with the removed property set to true. Logs from transactions that ended up in the new chain are emitted. Therefore a subscription can emit logs for the same transaction multiple times.
-        - `address` - either an address or an array of addresses. Only logs that are created from these addresses are returned (optional)
-        - `topics` - only logs which match the specified topics (optional)
-    - `syncing` - Indicates when the node starts or stops synchronizing. The result can either be a boolean indicating that the synchronization has started (true), finished (false) or an object with various progress indicators.
+        - `address` (optional) - either an address or an array of addresses. Only logs that are created from these addresses are returned (optional)
+        - `topics` (optional) - only logs which match the specified topics (optional)
     - `newPendingTransactions` - Returns the hash for all transactions that are added to the pending state and are signed with a key that is available in the node. When a transaction that was previously part of the canonical chain isn't part of the new canonical chain after a reogranization its again emitted.
-- `OPTIONAL ARGUMENTS` 
-    - `includeTransactions` - A flag indicating to whether include transactions in the response 
+    - `syncing` - Indicates when the node starts or stops synchronizing. The result can either be a boolean indicating that the synchronization has started (true), finished (false) or an object with various progress indicators. NOT SUPPORTED ON KOVAN!
 
 #### EXAMPLE
 ```bash
 >wscat -c wss://mainnet.infura.io/ws 
 
 // newHeads
->{"id": 1, "method": "eth_subscribe", "params": ["newHeads", {"includeTransactions": true}]}
+>{"id": 1, "method": "eth_subscribe", "params": ["newHeads"]}
 
 // logs
 >{"id": 1, "method": "eth_subscribe", "params": ["logs", {"address": "0x8320fe7702b96808f7bbc0d4a888ed1468216cfd", "topics": ["0xd78a0cb8bb633d06981248b816e7bd33c2a35a6089241d099fa519e361cab902"]}]}
 
 // newPendingTransactions
 >{"id": 1, "method": "eth_subscribe", "params": ["newPendingTransactions"]}
 
-// syncing
+// syncing (not supported on Kovan)
 >{"id": 1, "method": "eth_subscribe", "params": ["syncing"]}
 ```
 
@@ -97,7 +94,7 @@ NOTE: eth_unsubscribe is only supported on geth nodes (Mainnet, Ropsten, Rinkeby
     }
 }
 
-// syncing subscription
+// syncing subscription (not supported on Kovan)
 {
     "subscription":"0xe2ffeb2703bcf602d42922385829ce96",
     "result": { 

docs/wss/eth_unsubscribe.md

@@ -1,7 +1,6 @@
 # eth_unsubscribe
 
 Subscriptions are cancelled with a regular RPC call with eth_unsubscribe as method and the subscription id as first parameter. It returns a bool indicating if the subscription was cancelled successful.
-NOTE: eth_unsubscribe is only supported on geth nodes (Mainnet, Ropsten, Rinkeby networks)
 
 ### REQUEST PARAMS
 - `SUBSCRIPTION ID` _[required]_ 

docs/wss/faq.md

@@ -29,4 +29,11 @@ Any unrecognized requests will trigger the server to close the connection with a
 
 web3.js 1.0.0-beta.34 has an open issue with request headers https://github.com/ethereum/web3.js/issues/1559. Please revert/downgrade to 1.0.0-beta.33.
 
+**Why is includeTransactions option not working for eth_subscribe?**
+
+Though the includeTransactions option is included in the Ethereum Pub/Sub API documentation, currently it is not returning the expected results.
+For more information: https://github.com/ethereum/go-ethereum/issues/15804.
+
+
+
 

docs/wss/parity_subscribe.md

@@ -1,7 +1,7 @@
 # parity_subscribe
 
 Starts a subscription (on WebSockets / IPC / TCP transports) to results of calling some other RPC method. For every change in returned value of that RPC call a JSON-RPC notification with result and subscription ID will be sent to a client.
-NOTE: parity_unsubscribe is only supported on parity nodes (Kovan network)
+NOTE: parity_subscribe is only supported on the Kovan network
 
 ### REQUEST PARAMS
 - `RPC method name` _[required]_

docs/wss/parity_unsubscribe.md

@@ -1,7 +1,7 @@
 # parity_unsubscribe
 
 Unsubscribes from a subscription.
-NOTE: parity_unsubscribe is only supported on parity nodes (Kovan network)
+NOTE: parity_unsubscribe is only supported on the Kovan network
 
 ### REQUEST PARAMS
 - `SUBSCRIPTION ID` _[required]_