Merge pull request cgaebel#3 from GambolingPangolin/master

removes deprecated rpc call 'generate'

.gitignore

@@ -10,4 +10,5 @@ dist-newstyle/
 cabal-dev/
 cabal.sandbox.config
 .cabal-sandbox/
+.stack-work
 tags

CHANGELOG

@@ -1,3 +1,12 @@
+1.9.0
+
+  * removes 'generate' rpc call
+  * adds test case for 'generateToAddress' and updates tests
+
+1.8.5
+
+  * ...
+
 1.1.0
 
   * Added missing HashData fields

README.md

@@ -1,7 +1,9 @@
 network-bitcoin
 ====
 
-See the [Hackage documentation](http://hackage.haskell.org/package/network-bitcoin).
+This library supports [Bitcoin Core][1] `v0.18` only.
+
+See the [Hackage documentation][2].
 
 Testing
 ----
@@ -12,3 +14,6 @@ Invoke `bitcoind` with:
 ```shell
 $ bitcoind -regtest -rpcuser=bitcoinrpc -rpcpassword=bitcoinrpcpassword -rpcport=18444
 ```
+
+[1]: https://github.com/bitcoin/bitcoin
+[2]: http://hackage.haskell.org/package/network-bitcoin

network-bitcoin.cabal

@@ -1,5 +1,5 @@
 Name:                network-bitcoin
-Version:             1.8.5
+Version:             1.9.0
 Synopsis:            An interface to bitcoind.
 Description:
     This can be used to send Bitcoins, query balances, etc.  It
@@ -18,7 +18,7 @@ License:             BSD3
 License-file:        LICENSE
 Author:              Michael Hendricks <[email protected]>
                      Clark Gaebel <[email protected]>
-Maintainer:          Matt Wraith <[email protected]> 
+Maintainer:          Matt Wraith <[email protected]>
 Homepage:            http://github.com/bitnomial/network-bitcoin
 Bug-reports:         http://github.com/bitnomial/network-bitcoin/issues
 Copyright:           2012 Michael Hendricks <[email protected]>

src/Network/Bitcoin.hs

@@ -31,6 +31,7 @@ module Network.Bitcoin
     , dumpPrivateKey
     -- * Mining Operations
     , generate
+    , generateToAddress
     , getGenerate
     , setGenerate
     , getHashesPerSec

src/Network/Bitcoin/Mining.hs

@@ -34,6 +34,7 @@ module Network.Bitcoin.Mining ( Client
 import           Control.Monad
 import           Data.Aeson               as A
 import           Network.Bitcoin.Internal
+import           Network.Bitcoin.Wallet   (getNewAddress)
 
 -- | Returns whether or not bitcoind is generating bitcoins.
 getGenerate :: Client -- ^ bitcoind RPC client
@@ -70,10 +71,8 @@ generate :: Client
          -> IO [HexString] -- ^ An array containing the block header
                            --   hashes of the generated blocks
                            --   (may be empty if used with generate 0)
-generate client blocks Nothing =
-    callApi client "generate" [ tj blocks ]
-generate client blocks (Just maxTries) =
-    callApi client "generate" [ tj blocks, tj maxTries]
+generate client blocks maxTries =
+    getNewAddress client Nothing >>= flip (generateToAddress client blocks) maxTries
 
 -- | The generatetoaddress RPC mines blocks immediately to a specified address.
 --   See https://bitcoin.org/en/developer-reference#generatetoaddress for more details.
@@ -189,8 +188,7 @@ instance FromJSON Transaction where
                                        <*> o .:  "sigops"
     parseJSON _ = mzero
 
-data CoinBaseAux = CoinBaseAux { cbFlags :: HexString
-                               }
+newtype CoinBaseAux = CoinBaseAux { cbFlags :: HexString }
     deriving ( Show, Read, Ord, Eq )
 
 instance FromJSON CoinBaseAux where
@@ -255,7 +253,7 @@ getBlockTemplate client = callApi client "getblocktemplate" []
 --   the string "rejected" on failure.
 --
 --   We use 'StupidReturnValue' to parse this ridiculous API.
-data StupidReturnValue = SRV { unStupid :: Bool }
+newtype StupidReturnValue = SRV { unStupid :: Bool }
 
 instance FromJSON StupidReturnValue where
     parseJSON Null = return $ SRV True

src/Network/Bitcoin/RawTransaction.hs

@@ -217,7 +217,7 @@ instance FromJSON RawTransactionInfo where
 getRawTransactionInfo :: Client -> TransactionID -> IO RawTransactionInfo
 getRawTransactionInfo client txid =
     callApi client "getrawtransaction" [ tj txid, tj verbose ]
-        where verbose = 1 :: Int
+        where verbose = True
 
 data UnspentTransaction =
     UnspentTransaction { unspentTransactionId :: TransactionID

src/Network/Bitcoin/Wallet.hs

@@ -365,7 +365,7 @@ data ReceivedByAddress =
 
 instance FromJSON ReceivedByAddress where
     parseJSON (Object o) = ReceivedByAddress <$> o .: "address"
-                                             <*> o .: "account"
+                                             <*> o .: "label"
                                              <*> o .: "amount"
                                              <*> o .: "confirmations"
     parseJSON _ = mzero

src/Test/Main.hs

@@ -6,12 +6,14 @@
 module Main where
 
 
+import           Control.Monad            (void)
 import           Data.Either              (isRight)
 import           Data.Text                (Text)
 import           Data.Vector              (empty)
 import qualified Data.Vector              as V
 import           Network.Bitcoin
 import           Network.Bitcoin.Internal (callApi, tj)
+import qualified Network.Bitcoin.Mining   as M
 import           Test.QuickCheck
 import           Test.QuickCheck.Monadic
 import           Test.Tasty               (TestName, TestTree, defaultMain,
@@ -21,7 +23,8 @@ import           Test.Tasty.QuickCheck
 
 main :: IO ()
 main = defaultMain . testGroup "network-bitcoin tests" $
-    [ canListUnspent
+    [ canGenerateBlocks
+    , canListUnspent
     , canGetBlock
     , canGetOutputInfo
     , canGetRawTransaction
@@ -37,9 +40,18 @@ client = getClient "http://127.0.0.1:18444" "bitcoinrpc" "bitcoinrpcpassword"
 nbTest name = testProperty name . once . monadicIO
 
 
+canGenerateBlocks :: TestTree
+canGenerateBlocks = nbTest "generateToAddress" $ do
+    void . run $ do
+        c          <- client
+        rewardAddr <- getNewAddress c Nothing
+        M.generateToAddress c 101 rewardAddr Nothing
+    assert True
+
+
 canListUnspent :: TestTree
 canListUnspent = nbTest "listUnspent" $ do
-    _ <- run $ do
+    void . run $ do
         c <- client
         listUnspent c Nothing Nothing Data.Vector.empty
     assert True
@@ -51,8 +63,8 @@ getTopBlock c = getBlockCount c >>= getBlockHash c >>= getBlock c
 
 canGetBlock :: TestTree
 canGetBlock = nbTest "getBlockCount / getBlockHash / getBlock" $ do
-        run $ client >>= getTopBlock
-        assert True
+    run $ client >>= getTopBlock
+    assert True
 
 
 canGetRawTransaction :: TestTree
@@ -83,14 +95,14 @@ canGetAddress = nbTest "getNewAddress" $ do
 
 canSendPayment :: TestTree
 canSendPayment = nbTest "send payment" $ do
-    c <- run client
+    c   <- run client
     bal <- run $ getBalance c
     amt <- pick . suchThat arbitrary $ \x -> x < bal && x > 0
 
     (addr, recv) <- run $ do
         addr <- getNewAddress c Nothing
         sendToAddress c addr amt Nothing Nothing
-        _ :: [Text] <- callApi c "generate" [ tj (2 :: Int) ]
+        M.generate c 6 Nothing
         (addr,) <$> listReceivedByAddress c
 
     assert . V.elem (addr, amt) . fmap f $ recv