-
Notifications
You must be signed in to change notification settings - Fork 86
/
WalletRpcTest.scala
616 lines (543 loc) · 20.1 KB
/
WalletRpcTest.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
package org.bitcoins.rpc.common
import org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts
import org.bitcoins.commons.jsonmodels.bitcoind.RpcOpts.AddressType
import org.bitcoins.core.config.RegTest
import org.bitcoins.core.crypto.ECPrivateKeyUtil
import org.bitcoins.core.currency.{Bitcoins, CurrencyUnit, Satoshis}
import org.bitcoins.core.number.UInt32
import org.bitcoins.core.protocol.script.{
EmptyScriptWitness,
P2WPKHWitnessV0,
P2WSHWitnessV0,
ScriptSignature
}
import org.bitcoins.core.protocol.transaction._
import org.bitcoins.core.protocol.{Bech32Address, BitcoinAddress, P2PKHAddress}
import org.bitcoins.core.script.crypto.HashType
import org.bitcoins.core.wallet.fee.SatoshisPerByte
import org.bitcoins.core.wallet.signer.BitcoinSigner
import org.bitcoins.core.wallet.utxo.{ECSignatureParams, P2WPKHV0InputInfo}
import org.bitcoins.crypto.{DoubleSha256DigestBE, ECPrivateKey, ECPublicKey}
import org.bitcoins.rpc.client.common.{BitcoindRpcClient, BitcoindVersion}
import org.bitcoins.rpc.util.RpcUtil
import org.bitcoins.testkit.rpc.{
BitcoindFixturesCachedPairNewest,
BitcoindRpcTestUtil
}
import org.bitcoins.testkit.util.AkkaUtil
import org.scalatest.{FutureOutcome, Outcome}
import java.io.File
import java.util.Scanner
import scala.concurrent.duration.DurationInt
import scala.concurrent.{Await, Future}
import scala.reflect.io.Directory
class WalletRpcTest extends BitcoindFixturesCachedPairNewest {
override def withFixture(test: OneArgAsyncTest): FutureOutcome = {
val f: Future[Outcome] = for {
clients <- clientsF
futOutcome = with2BitcoindsCached(test, clients)
fut <- futOutcome.toFuture
} yield fut
new FutureOutcome(f)
}
// This client's wallet is encrypted
lazy val walletClientF: Future[BitcoindRpcClient] = clientsF.flatMap { _ =>
val walletClient =
BitcoindRpcClient.withActorSystem(BitcoindRpcTestUtil.instance())
for {
_ <- startClient(walletClient)
_ <- walletClient.getNewAddress.flatMap(
walletClient.generateToAddress(101, _))
_ <- walletClient.encryptWallet(password)
_ <- walletClient.stop()
_ <- RpcUtil.awaitServerShutdown(walletClient)
// Very rarely we are prevented from starting the client again because Core
// hasn't released its locks on the datadir. This is prevent that.
_ <- AkkaUtil.nonBlockingSleep(1.second)
_ <- walletClient.start()
} yield walletClient
}
var password = "password"
behavior of "WalletRpc"
it should "be able to dump the wallet" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
result <- {
val datadir = client.getDaemon.datadir.getAbsolutePath
client.dumpWallet(datadir + "/test.dat")
}
} yield {
assert(result.filename.exists)
assert(result.filename.isFile)
}
}
it should "be able to list wallets" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
wallets <- client.listWallets
} yield {
val expectedFileName =
if (client.instance.getVersion == BitcoindVersion.V16) "wallet.dat"
else ""
assert(wallets == Vector(expectedFileName))
}
}
it should "be able to backup the wallet" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
_ <- {
val datadir = client.getDaemon.datadir.getAbsolutePath
client.backupWallet(datadir + "/backup.dat")
}
} yield {
val datadir = client.getDaemon.datadir.getAbsolutePath
val file = new File(datadir + "/backup.dat")
assert(file.exists)
assert(file.isFile)
}
}
it should "be able to lock and unlock the wallet" in { _: FixtureParam =>
for {
walletClient <- walletClientF
_ <- walletClient.walletLock()
_ <- walletClient.walletPassphrase(password, 1000)
info <- walletClient.getWalletInfo
_ = assert(info.unlocked_until.nonEmpty)
_ = assert(info.unlocked_until.get > 0)
_ <- walletClient.walletLock()
newInfo <- walletClient.getWalletInfo
} yield assert(newInfo.unlocked_until.contains(0))
}
it should "be able to get an address from bitcoind" in {
nodePair: FixtureParam =>
val client = nodePair.node1
for {
_ <- {
val addrFuts =
List(client.getNewAddress,
client.getNewAddress(AddressType.Bech32),
client.getNewAddress(AddressType.P2SHSegwit),
client.getNewAddress(AddressType.Legacy))
Future.sequence(addrFuts)
}
} yield succeed
}
it should "be able to get a new raw change address" in {
nodePair: FixtureParam =>
val client = nodePair.node1
for {
_ <- {
val addrFuts =
List(
client.getRawChangeAddress,
client.getRawChangeAddress(AddressType.Legacy),
client.getRawChangeAddress(AddressType.Bech32),
client.getRawChangeAddress(AddressType.P2SHSegwit)
)
Future.sequence(addrFuts)
}
} yield succeed
}
it should "be able to get the amount recieved by some address" in {
nodePair: FixtureParam =>
val client = nodePair.node1
for {
address <- client.getNewAddress
amount <- client.getReceivedByAddress(address)
} yield assert(amount == Bitcoins(0))
}
it should "be able to get the unconfirmed balance" in {
nodePair: FixtureParam =>
val client = nodePair.node1
for {
balance <- client.getUnconfirmedBalance
transaction <- BitcoindRpcTestUtil.sendCoinbaseTransaction(client,
client)
newBalance <- client.getUnconfirmedBalance
} yield {
assert(balance == Bitcoins(0))
assert(newBalance == transaction.amount)
}
}
it should "be able to get the wallet info" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
info <- client.getWalletInfo
} yield {
assert(info.balance.toBigDecimal > 0)
assert(info.txcount > 0)
assert(info.keypoolsize > 0)
assert(!info.unlocked_until.contains(0))
}
}
it should "be able to refill the keypool" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
info <- client.getWalletInfo
_ <- client.keyPoolRefill(info.keypoolsize + 1)
newInfo <- client.getWalletInfo
} yield assert(newInfo.keypoolsize == info.keypoolsize + 1)
}
it should "be able to change the wallet password" in { _: FixtureParam =>
val newPass = "new_password"
for {
walletClient <- walletClientF
_ <- walletClient.walletLock()
_ <- walletClient.walletPassphraseChange(password, newPass)
_ = {
password = newPass
}
_ <- walletClient.walletPassphrase(password, 1000)
info <- walletClient.getWalletInfo
_ <- walletClient.walletLock()
newInfo <- walletClient.getWalletInfo
} yield {
assert(info.unlocked_until.nonEmpty)
assert(info.unlocked_until.get > 0)
assert(newInfo.unlocked_until.contains(0))
}
}
it should "be able to list address groupings" in { nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
val amount = Bitcoins(1.25)
def getChangeAddressAndAmount(
client: BitcoindRpcClient,
address: BitcoinAddress,
txid: DoubleSha256DigestBE): Future[(BitcoinAddress, CurrencyUnit)] = {
for {
rawTx <- client.getRawTransactionRaw(txid)
} yield {
val outs = rawTx.outputs.filterNot(_.value == amount)
val changeAddresses = outs
.map(out =>
(BitcoinAddress.fromScriptPubKey(out.scriptPubKey, networkParam),
out.value))
assert(changeAddresses.size == 1)
assert(changeAddresses.head._1 != address)
(changeAddresses.head._1, changeAddresses.head._2)
}
}
for {
groupingsBefore <- client.listAddressGroupings
address <- client.getNewAddress
txid <- BitcoindRpcTestUtil.fundBlockChainTransaction(client,
otherClient,
address,
amount)
(changeAddress, changeAmount) <-
getChangeAddressAndAmount(client, address, txid)
groupingsAfter <- client.listAddressGroupings
} yield {
// the address should appear in a new address grouping
assert(!groupingsBefore.exists(vec => vec.exists(_.address == address)))
val rpcAddress =
groupingsAfter.find(vec => vec.exists(_.address == address)).get.head
assert(rpcAddress.address == address)
assert(rpcAddress.balance == amount)
// the change address should be added to an exiting address grouping
assert(
!groupingsBefore.exists(vec => vec.exists(_.address == changeAddress)))
val changeGroupingOpt =
groupingsAfter.find(vec => vec.exists(_.address == changeAddress))
assert(changeGroupingOpt.nonEmpty)
val changeGrouping = changeGroupingOpt.get
assert(changeGrouping.size > 1)
val rpcChangeAddress =
changeGrouping.find(addr => addr.address == changeAddress).get
assert(rpcChangeAddress.address == changeAddress)
assert(rpcChangeAddress.balance == changeAmount)
}
}
it should "be able to send to an address" in { nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
for {
address <- otherClient.getNewAddress
txid <- client.sendToAddress(address, Bitcoins(1))
transaction <- client.getTransaction(txid)
} yield {
assert(transaction.amount == Bitcoins(-1))
assert(transaction.details.head.address.contains(address))
}
}
it should "be able to send btc to many addresses" in {
nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
for {
address1 <- otherClient.getNewAddress
address2 <- otherClient.getNewAddress
txid <-
client
.sendMany(Map(address1 -> Bitcoins(1), address2 -> Bitcoins(2)))
transaction <- client.getTransaction(txid)
} yield {
assert(transaction.amount == Bitcoins(-3))
assert(transaction.details.exists(_.address.contains(address1)))
assert(transaction.details.exists(_.address.contains(address2)))
}
}
it should "be able to list transactions by receiving addresses" in {
nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
for {
address <- otherClient.getNewAddress
txid <-
BitcoindRpcTestUtil
.fundBlockChainTransaction(client,
otherClient,
address,
Bitcoins(1.5))
receivedList <- otherClient.listReceivedByAddress()
} yield {
val entryList =
receivedList.filter(entry => entry.address == address)
assert(entryList.length == 1)
val entry = entryList.head
assert(entry.txids.head == txid)
assert(entry.address == address)
assert(entry.amount == Bitcoins(1.5))
assert(entry.confirmations == 1)
}
}
it should "be able to import an address" in { nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
val address = Bech32Address
.fromString("bcrt1q9h9wkz6ad49szfl035wh3qdacuslkp6j9pfp4j")
for {
_ <- otherClient.importAddress(address)
txid <- BitcoindRpcTestUtil.fundBlockChainTransaction(client,
otherClient,
address,
Bitcoins(1.5))
list <- otherClient.listReceivedByAddress(includeWatchOnly = true)
} yield {
val entry =
list
.find(_.involvesWatchonly.contains(true))
.get
assert(entry.address == address)
assert(entry.involvesWatchonly.contains(true))
assert(entry.amount == Bitcoins(1.5))
assert(entry.txids.head == txid)
}
}
it should "be able to get the balance" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
balance <- client.getBalance
_ <- client.getNewAddress.flatMap(client.generateToAddress(1, _))
newBalance <- client.getBalance
} yield {
assert(balance.toBigDecimal > 0)
assert(balance.toBigDecimal < newBalance.toBigDecimal)
}
}
it should "be able to dump a private key" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
address <- client.getNewAddress
_ <- client.dumpPrivKey(address)
} yield succeed
}
it should "be able to import a private key" in { nodePair: FixtureParam =>
val client = nodePair.node1
val ecPrivateKey = ECPrivateKey.freshPrivateKey
val publicKey = ecPrivateKey.publicKey
val address = P2PKHAddress(publicKey, networkParam)
for {
_ <- client.importPrivKey(ecPrivateKey, rescan = false)
key <- client.dumpPrivKey(address)
result <-
client
.dumpWallet(
client.getDaemon.datadir.getAbsolutePath + "/wallet_dump.dat")
} yield {
assert(key == ecPrivateKey)
val reader = new Scanner(result.filename)
var found = false
while (reader.hasNext) {
if (reader.next == ECPrivateKeyUtil.toWIF(ecPrivateKey, networkParam)) {
found = true
}
}
assert(found)
}
}
it should "be able to import a public key" in { nodePair: FixtureParam =>
val client = nodePair.node1
val pubKey = ECPublicKey.freshPublicKey
for {
_ <- client.importPubKey(pubKey)
} yield succeed
}
it should "be able to import multiple addresses with importMulti" in {
nodePair: FixtureParam =>
val client = nodePair.node1
val privKey = ECPrivateKey.freshPrivateKey
val address1 = P2PKHAddress(privKey.publicKey, networkParam)
val privKey1 = ECPrivateKey.freshPrivateKey
val privKey2 = ECPrivateKey.freshPrivateKey
for {
firstResult <-
client
.createMultiSig(2, Vector(privKey1.publicKey, privKey2.publicKey))
address2 = firstResult.address
secondResult <-
client
.importMulti(
Vector(
RpcOpts.ImportMultiRequest(RpcOpts.ImportMultiAddress(address1),
UInt32(0)),
RpcOpts.ImportMultiRequest(RpcOpts.ImportMultiAddress(address2),
UInt32(0))),
rescan = false
)
} yield {
assert(secondResult.length == 2)
assert(secondResult(0).success)
assert(secondResult(1).success)
}
}
it should "be able to import a wallet" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
walletClient <- walletClientF
address <- client.getNewAddress
walletFile =
client.getDaemon.datadir.getAbsolutePath + "/client_wallet.dat"
fileResult <- client.dumpWallet(walletFile)
_ <- walletClient.walletPassphrase(password, 1000)
_ <- walletClient.importWallet(walletFile)
_ <- walletClient.dumpPrivKey(address)
} yield assert(fileResult.filename.exists)
}
it should "be able to load a wallet" in { nodePair: FixtureParam =>
val client = nodePair.node1
val name = "tmp_wallet"
for {
walletClient <- walletClientF
walletFile =
client.getDaemon.datadir.getAbsolutePath + s"/regtest/wallets/$name"
_ <- client.createWallet(walletFile)
_ <- client.unloadWallet(walletFile)
loadResult <- walletClient.loadWallet(walletFile)
} yield {
// clean up
val directory = new Directory(new File(walletFile))
directory.deleteRecursively()
assert(loadResult.name == walletFile)
}
}
it should "be able to set the tx fee" in { nodePair: FixtureParam =>
val client = nodePair.node1
for {
success <- client.setTxFee(Bitcoins(0.01))
info <- client.getWalletInfo
} yield {
assert(success)
assert(info.paytxfee == SatoshisPerByte(Satoshis(1000)))
}
}
it should "be able to bump a mem pool tx fee" in { nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
for {
address <- otherClient.getNewAddress
unspent <- client.listUnspent
changeAddress <- client.getRawChangeAddress
rawTx <- {
val output =
unspent.find(output => output.amount.toBigDecimal > 1).get
val input =
TransactionInput(
TransactionOutPoint(output.txid.flip, UInt32(output.vout)),
ScriptSignature.empty,
UInt32.max - UInt32(2))
val inputs = Vector(input)
val outputs =
Map(address -> Bitcoins(0.5),
changeAddress -> Bitcoins(output.amount.toBigDecimal - 0.55))
client.createRawTransaction(inputs, outputs)
}
stx <- BitcoindRpcTestUtil.signRawTransaction(client, rawTx)
txid <- client.sendRawTransaction(stx.hex, 0)
tx <- client.getTransaction(txid)
bumpedTx <- client.bumpFee(txid)
} yield assert(tx.fee.get < bumpedTx.fee)
}
it should "be able to sign a raw transaction with the wallet" in {
nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
for {
address <- otherClient.getNewAddress
transactionWithoutFunds <-
client
.createRawTransaction(Vector.empty, Map(address -> Bitcoins(1)))
transactionResult <- client.fundRawTransaction(transactionWithoutFunds)
transaction = transactionResult.hex
singedTx <- client.signRawTransactionWithWallet(transaction).map(_.hex)
// Will throw error if invalid
_ <- client.sendRawTransaction(singedTx)
} yield {
assert(transaction.inputs.length == 2)
assert(
transaction.outputs.contains(
TransactionOutput(Bitcoins(1), address.scriptPubKey)))
}
}
it should "generate the same (low R) signatures as bitcoin-s" in {
nodePair: FixtureParam =>
val client = nodePair.node1
val otherClient = nodePair.node2
for {
address <- otherClient.getNewAddress
transactionWithoutFunds <-
client
.createRawTransaction(Vector.empty, Map(address -> Bitcoins(1)))
transactionResult <- client.fundRawTransaction(transactionWithoutFunds)
transaction = transactionResult.hex
signedTx <- client.signRawTransactionWithWallet(transaction).map(_.hex)
// Validate signature against bitcoin-s generated one
outPoint = transaction.inputs.head.previousOutput
prevTx <- client.getRawTransactionRaw(outPoint.txIdBE)
output = prevTx.outputs(outPoint.vout.toInt)
privKey <- client.dumpPrivKey(
BitcoinAddress.fromScriptPubKey(output.scriptPubKey, RegTest))
} yield {
val partialSig = BitcoinSigner.signSingle(
ECSignatureParams(
P2WPKHV0InputInfo(outPoint, output.value, privKey.publicKey),
prevTx,
privKey,
HashType.sigHashAll),
transaction,
isDummySignature = false)
signedTx match {
case btx: NonWitnessTransaction =>
assert(
btx.inputs.head.scriptSignature.signatures.head == partialSig.signature)
case wtx: WitnessTransaction =>
wtx.witness.head match {
case p2wpkh: P2WPKHWitnessV0 =>
assert(p2wpkh.pubKey == partialSig.pubKey)
assert(p2wpkh.signature == partialSig.signature)
case _: P2WSHWitnessV0 | EmptyScriptWitness =>
fail("Expected P2WPKH")
}
}
}
}
def startClient(client: BitcoindRpcClient): Future[Unit] = {
BitcoindRpcTestUtil.startServers(Vector(client))
}
override def afterAll(): Unit = {
val stopF = walletClientF.map(BitcoindRpcTestUtil.stopServer)
Await.result(stopF, duration)
super.afterAll()
}
}