add support for btcrelay's validation fees

Author: caktux

Gruntfile.js

@@ -10,7 +10,6 @@ module.exports = function(grunt) {
           "lib/keccak.js": "src/keccak.js",
           "lib/btc-swap.js": "src/btc-swap.js",
           "lib/abi/btc-swap.js": "src/abi/btc-swap.js",
-          "lib/abi/debug.js": "src/abi/debug.js",
           "lib/abi/btcrelay.js": "src/abi/btcrelay.js"
         }
       }

README.md

@@ -42,13 +42,15 @@ first parameter and the Ethereum transaction hash as second parameter. The
 `completed` callback gets fired when the transaction is mined and returns the
 reserved ticket object.
 
-#### `claimTicket(ticketId, txHex, txHash, txIndex, merkleSibling, txBlockHash, success, completed, failure)`
+#### `claimTicket(ticketId, txHex, txHash, txIndex, merkleSibling, txBlockHash,
+  feeWei, success, completed, failure)`
 Claim a ticket with ID `ticketId`, with the signed BTC transaction hex `txHex`,
 the BTC transaction hash `txHash`, BTC transaction index `txIndex`, BTC merkle
-siblings `merkleSibling` and BTC block hash `txBlockHash`. The `success`
-callback gets fired when the Ethereum transaction is sent and returns the
-Ethereum transaction hash. The `completed` callback gets fired when the
-transaction is mined and returns the ticket ID.
+siblings `merkleSibling` and BTC block hash `txBlockHash`. `feeWei` can be
+obtained by calling `getFeeAmount(txBlockHash)` and will be the transaction's
+value if it's above zero. The `success` callback gets fired when the Ethereum
+transaction is sent and returns the Ethereum transaction hash. The `completed`
+callback gets fired when the transaction is mined and returns the ticket ID.
 
 #### `cancelTicket(ticketId, success, failure)`
 Cancel a ticket with `ticketId`, if the ticket is still reservable and by
@@ -120,10 +122,15 @@ Query the [btcrelay](https://github.com/ethereum/btcrelay) contract for its last
 stored BTC block number. The `success` callback gets fired on a successful call
 and returns the block number of the latest block.
 
-#### `storeBlockHeader(blockHash, success, failure)`
+#### `getFeeAmount(blockHash, success, failure)`
+Get the fee from [btcrelay](https://github.com/ethereum/btcrelay) to validate a
+transaction in a given `blockHash`. The `success` callback gets fired on a
+successful call and returns the fee amount in wei.
+
+#### `storeBlockWithFee(blockHash, feeWei, success, failure)`
 Query the [blockr](https://blockr.io) API for the raw block data of a block
 with hash `blockHash`, generate the BTC block header from that data, call the
-`storeBlockHeader` method of [btcrelay](https://github.com/ethereum/btcrelay)
+`storeBlockWithFee` method of [btcrelay](https://github.com/ethereum/btcrelay)
 and send an Ethereum transaction for that same method if successful, effectively
 storing the block header. The `success` callback gets fired when the transaction
 is mined and returns the BTC block number for which the block header was stored.

contracts/btc-swap.se

@@ -43,9 +43,7 @@ macro CLAIM_FAIL_TX_ENCODING: -27
 
 # Events
 event ticketEvent(ticketId:indexed, rval)
-
-# TODO testing only
-event claimSuccess(btcAddr, numSatoshi, ethAddr, satoshiIn2ndOutput)
+event claimSuccess(btcAddr, numSatoshi, ethAddr, satoshiIn2ndOutput, feeWei)
 
 # Macros
 
@@ -239,8 +237,7 @@ def claimTicket(ticketId, txStr:str, txHash, txIndex, sibling:arr, txBlockHash):
         log(type=ticketEvent, ticketId, CLAIM_FAIL_WRONG_BTC_ADDR)
         return(CLAIM_FAIL_WRONG_BTC_ADDR)
 
-
-    if self.trustedBtcRelay.verifyTx(txHash, txIndex, sibling, txBlockHash):
+    if self.trustedBtcRelay.verifyTx(txHash, txIndex, sibling, txBlockHash, value=msg.value):
 
         satoshiIn2ndOutput = outputData[2]
 
@@ -257,8 +254,7 @@ def claimTicket(ticketId, txStr:str, txHash, txIndex, sibling:arr, txBlockHash):
 
         deleteTicket(ticketId)
 
-        # TODO for testing only; remove when deploying
-        log(type=claimSuccess, addrBtcWasSentTo, numSatoshi, ethAddr, satoshiIn2ndOutput)
+        log(type=claimSuccess, addrBtcWasSentTo, numSatoshi, ethAddr, satoshiIn2ndOutput, msg.value)
 
         return(ticketId)
     else:

contracts/btc-swap.yaml

@@ -11,7 +11,7 @@
 # Private testnet relay: 0x3056d0b2379c86e6be6771c34f39f5affb65d855
 # ConsenSys testnet relay: 0x2fd4f3ae10608cd6192339e72d4f6a0c182dee22
 - set:
-    BtcRelay: "0xa9eb7eec49f39a3030baacc95111fb94192be354"
+    BtcRelay: "0xd34e752661c770ee2eb078326ed7a2a09acff135"
 -
   deploy:
     BtcSwap:

contracts/tests/test_btc-swap.py

@@ -408,9 +408,11 @@ def testAnyClaimMustStillBeValidTx(self):
 
     def assertClaimSuccessLogs(self, eventArr, satoshiOutputOne, btcAddr, ethAddr, satoshiOutputTwo, ticketId):
         assert eventArr[1] == {
-            '_event_type': 'claimSuccess', 'numSatoshi': satoshiOutputOne,
+            '_event_type': 'claimSuccess',
+            'numSatoshi': satoshiOutputOne,
             'btcAddr': btcAddr,
             'ethAddr': ethAddr,
+            'feeWei': 0,
             'satoshiIn2ndOutput': satoshiOutputTwo
         }
         eventArr.pop()