Merge branch 'jac/fix_examples'

README.md

@@ -10,22 +10,33 @@ A lightweight JavaScript sdk to connect to the Blocknative backend Ethereum node
 
 ### Quick Start (client)
 
+#### Transaction Monitor
+
 ```javascript
+import WebSocket from 'ws'
 import BlocknativeSdk from 'bnc-sdk'
 import Web3 from 'web3'
 
-const web3 = new Web3(window.ethereum)
+const wsapi_url = 'wss://api.blocknative.com/v0'
+
+const web3 = new Web3(wsapi_url)
 
 // create options object
 const options = {
-  dappId: 'Your dappId here',
+  dappId: process.env.BN_API_KEY,
+  ws: WebSocket,
   networkId: 1,
   transactionHandlers: [event => console.log(event.transaction)]
 }
 
 // initialize and connect to the api
 const blocknative = new BlocknativeSdk(options)
 
+const txOptions = {
+    from: "0x7A132e43013cAA14a3744721EF179f1F3d2b3921",
+    to: "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D",
+}
+
 // initiate a transaction via web3.js
 web3.eth.sendTransaction(txOptions).on('transactionHash', hash => {
   // call with the transaction hash of the transaction that you would like to receive status updates for
@@ -44,8 +55,41 @@ web3.eth.sendTransaction(txOptions).on('transactionHash', hash => {
   emitter.on('all', transaction => {
     console.log(`Transaction event: ${transaction.eventCode}`)
   })
+})
+
 ```
 
+#### Address Listener
+
+```javascript
+import WebSocket from 'ws'
+import BlocknativeSdk from 'bnc-sdk'
+import Web3 from 'web3'
+
+const wsapi_url = 'wss://api.blocknative.com/v0'
+
+const web3 = new Web3(wsapi_url)
+
+// create options object
+const options = {
+  dappId: process.env.BN_API_KEY,
+  ws: WebSocket,
+  networkId: 1
+}
+
+// initialize and connect to the api
+const blocknative = new BlocknativeSdk(options)
+
+const address = "0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D"
+
+const { emitter, details } = blocknative.account(address)
+
+emitter.on("all", transaction => {
+    console.log(transaction)
+})
+```
+
+
 ## Documentation
 
 For detailed documentation head to [docs.blocknative.com](https://docs.blocknative.com/notify-sdk)