minercraft - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

demo/feeratecalc.js

@@ -15,3 +15,3 @@ /********************************************************************
     let f = miner.fee.get({
-      rate: { data: rate.data.mine, standard: rate.standard.mine },
+      rate: rate.mine,
       tx: "0100000001648ed7d1c1a27ec923445c8d404e227145218c4ce01cf958a898c5a048e8f264020000006a47304402207dc1953455be091c8df18e7f7e1424bc4efdced3e400642f8316e3ef298c3f30022062d833b3f1b94593ec7c088b930e2987475c7d99bf19f5714b12a9facff100df41210273f105be3e7ca116e96c7c40f17267ae05ede7160eb099aa2146a88b6328f4ecffffffff030000000000000000fdc901006a223144535869386876786e36506434546176686d544b7855374255715337636e7868770c57544458565633505a4b474414e5ae89e5bebd2fe585ade5ae892fe99c8de982b119323032302d30342d30365430363a30303a30302b30383a30304c697b22617169223a223538222c22706d3235223a223332222c22706d3130223a223636222c22736f32223a2235222c226e6f32223a223235222c22636f223a22302e373530222c226f33223a223635222c22706f6c223a22504d3130222c22717561223a22e889af227d4cfb78da75d1c16a02311006e077c959964cb29944dfa1d07bf1209e0a6b57b137114aaf2d2d5e446d7b29d59e3c492f22f834d9ea5b3859e826bba4b73fc34cf898b999b0dee89675184ad662c3815094a5293370ca1a298f73415151ba2b9370cdfd9c124f34c55c563fe419c5eb2b9aa5b1fb1e3d7edf66c5cf93fdfa2ed6072a66ae2621d15203775d99fb070013c50da7cab45599c09b04062688999437993f53d91933ade6a7f5d16e37e7e5676842307553aa1b2685c19e02137a93a94c92c74c69dc54bc7f9c173bfbf21882745b379784a60e0a0f071ea4fce1a45f521a399cfae770f6f0605f67f6795f0381688010dd1da7dd0b690c97db22020000000000001976a914666675d887a7ae09835af934096d9fcbbb70eed288ac61290000000000001976a9149e7520bc258934a3d58704ab98ed0200e2c1bb9688ac00000000"
@@ -18,0 +18,0 @@ })

fee.js

@@ -21,8 +21,6 @@ const bsv = require('bsv')
         } else {
-          let fees = {}
+          let fees = { mine: {}, relay: {} }
           response.fees.forEach((f) => {
-            fees[f.feeType] = {
-              mine: f.miningFee.satoshis/f.miningFee.bytes,
-              relay: f.relayFee.satoshis/f.relayFee.bytes
-            }
+            fees.mine[f.feeType] = f.miningFee.satoshis/f.miningFee.bytes
+            fees.relay[f.feeType] = f.relayFee.satoshis/f.relayFee.bytes
           })
@@ -29,0 +27,0 @@ return fees

package.json

 {
   "name": "minercraft",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "interact with bitcoin miner apis",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -101,2 +101,5 @@ # Minercraft
   url: "https://merchantapi.matterpool.io",
+  headers: {
+    "Content-Type": "application/json"
+  }
 })
@@ -118,7 +121,14 @@ ```
 fee rate: {
-  standard: { mine: 0.5, relay: 0.25 },
-  data: { mine: 0.5, relay: 0.25 }
+  mine: { standard: 0.5, data: 0.5 },
+  relay: { standard: 0.25, data: 0.25 }
 }
 ```
 
+You can also pass in an additional parameter `verbose: true` to get the raw response from the API, which includes other metadata such as minerID and signature, which you can use to verify authenticity:
+
+```
+let rate = await miner.fee.rate({ verbose: true })
+console.log("verbose fee rate:", rate)
+```
+
 ## 2. Calculate fee for a transaction
@@ -140,3 +150,3 @@
 let fee = miner.fee.get({
-  rate: rate,
+  rate: rate.mine,  // use the mining rate
   tx: "0100000001648ed7d1c1a27ec923445c8d404e227145218c4ce01cf958a898c5a048e8f264020000006a47304402207dc1953455be091c8df18e7f7e1424bc4efdced3e400642f8316e3ef298c3f30022062d833b3f1b94593ec7c088b930e2987475c7d99bf19f5714b12a9facff100df41210273f105be3e7ca116e96c7c40f17267ae05ede7160eb099aa2146a88b6328f4ecffffffff030000000000000000fdc901006a223144535869386876786e36506434546176686d544b7855374255715337636e7868770c57544458565633505a4b474414e5ae89e5bebd2fe585ade5ae892fe99c8de982b119323032302d30342d30365430363a30303a30302b30383a30304c697b22617169223a223538222c22706d3235223a223332222c22706d3130223a223636222c22736f32223a2235222c226e6f32223a223235222c22636f223a22302e373530222c226f33223a223635222c22706f6c223a22504d3130222c22717561223a22e889af227d4cfb78da75d1c16a02311006e077c959964cb29944dfa1d07bf1209e0a6b57b137114aaf2d2d5e446d7b29d59e3c492f22f834d9ea5b3859e826bba4b73fc34cf898b999b0dee89675184ad662c3815094a5293370ca1a298f73415151ba2b9370cdfd9c124f34c55c563fe419c5eb2b9aa5b1fb1e3d7edf66c5cf93fdfa2ed6072a66ae2621d15203775d99fb070013c50da7cab45599c09b04062688999437993f53d91933ade6a7f5d16e37e7e5676842307553aa1b2685c19e02137a93a94c92c74c69dc54bc7f9c173bfbf21882745b379784a60e0a0f071ea4fce1a45f521a399cfae770f6f0605f67f6795f0381688010dd1da7dd0b690c97db22020000000000001976a914666675d887a7ae09835af934096d9fcbbb70eed288ac61290000000000001976a9149e7520bc258934a3d58704ab98ed0200e2c1bb9688ac00000000"
@@ -178,2 +188,32 @@ })
 
+If you want to get a more detailed response, including the minerID and signature, you can call the method with `{verbose: true}`:
+
+```
+let status = await miner.tx.status(txid, { verbose: true })
+console.log(status)
+```
+
+will print something like:
+
+```
+{
+  "payload": {
+    "apiVersion": "0.1.0",
+    "timestamp": "2020-04-19T15:06:56.299Z",
+    "returnResult": "success",
+    "resultDescription": "",
+    "blockHash": "000000000000000004a5686ff15cdb3950939bdc5725970d963e2b03d3d43d45",
+    "blockHeight": 630700,
+    "confirmations": 603,
+    "minerId": "03e92d3e5c3f7bd945dfbf48e7a99393b1bfb3f11f380ae30d286e7ff2aec5a270",
+    "txSecondMempoolExpiry": 0
+  },
+  "signature": "3044022032eb418ea68a0825767fa6bf038cca200acbbbabeadd7f7e3b203594e3ef3ee60220224fc0657a5c7c8b3b4a8b71de897655a990b975ae9e9f8d574eb806663bc839",
+  "publicKey": "03e92d3e5c3f7bd945dfbf48e7a99393b1bfb3f11f380ae30d286e7ff2aec5a270",
+  "encoding": "UTF-8",
+  "mimetype": "application/json"
+}
+```
+
+
 ## 4. Push transaction
@@ -186,1 +226,11 @@
 ```
+
+Again, to get more verbose response, you can pass in `{ verbose: true }`:
+
+```
+let response = await miner.tx.push("0100000001648ed7d1c1a27ec923445c8d404e227145218c4ce01cf958a898c5a048e8f264020000006a47304402207dc1953455be091c8df18e7f7e1424bc4efdced3e400642f8316e3ef298c3f30022062d833b3f1b94593ec7c088b930e2987475c7d99bf19f5714b12a9facff100df41210273f105be3e7ca116e96c7c40f17267ae05ede7160eb099aa2146a88b6328f4ecffffffff030000000000000000fdc901006a223144535869386876786e36506434546176686d544b7855374255715337636e7868770c57544458565633505a4b474414e5ae89e5bebd2fe585ade5ae892fe99c8de982b119323032302d30342d30365430363a30303a30302b30383a30304c697b22617169223a223538222c22706d3235223a223332222c22706d3130223a223636222c22736f32223a2235222c226e6f32223a223235222c22636f223a22302e373530222c226f33223a223635222c22706f6c223a22504d3130222c22717561223a22e889af227d4cfb78da75d1c16a02311006e077c959964cb29944dfa1d07bf1209e0a6b57b137114aaf2d2d5e446d7b29d59e3c492f22f834d9ea5b3859e826bba4b73fc34cf898b999b0dee89675184ad662c3815094a5293370ca1a298f73415151ba2b9370cdfd9c124f34c55c563fe419c5eb2b9aa5b1fb1e3d7edf66c5cf93fdfa2ed6072a66ae2621d15203775d99fb070013c50da7cab45599c09b04062688999437993f53d91933ade6a7f5d16e37e7e5676842307553aa1b2685c19e02137a93a94c92c74c69dc54bc7f9c173bfbf21882745b379784a60e0a0f071ea4fce1a45f521a399cfae770f6f0605f67f6795f0381688010dd1da7dd0b690c97db22020000000000001976a914666675d887a7ae09835af934096d9fcbbb70eed288ac61290000000000001976a9149e7520bc258934a3d58704ab98ed0200e2c1bb9688ac00000000", {
+  verbose: true
+})
+```
+
+This will provide more information about the response.

No alert changes

Improved metrics

Total package byte prevSize

6260553

increased by0.05%

Number of lines in readme file

232

increased by27.47%

Worsened metrics

Lines of code

36490

decreased by-0.01%

No dependency changes