lbcd/integration/rpctest/README.md

rpctest
=======

[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/integration/rpctest)

Package rpctest provides a btcd-specific RPC testing harness crafting and
executing integration tests by driving a `btcd` instance via the `RPC`
interface. Each instance of an active harness comes equipped with a simple
in-memory HD wallet capable of properly syncing to the generated chain,
creating new addresses, and crafting fully signed transactions paying to an
arbitrary set of outputs.

This package was designed specifically to act as an RPC testing harness for
`btcd`. However, the constructs presented are general enough to be adapted to
any project wishing to programmatically drive a `btcd` instance of its
systems/integration tests.

## Installation and Updating

```bash
$ go get -u github.com/btcsuite/btcd/integration/rpctest
```

## License

Package rpctest is licensed under the [copyfree](http://copyfree.org) ISC
License.
rpctest: Make subpackage of integration. This makes the rpctest package a subpackage of the integration package since its primary purpose is for integration testing. 2016-10-26 11:55:49 -05:00			`rpctest`
			`=======`

docs: update shields 2021-03-04 17:12:45 -05:00			`[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)`
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files. 2017-05-25 11:29:23 -05:00			`[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)`
docs: update shields 2021-03-04 17:12:45 -05:00			`[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/integration/rpctest)`
rpctest: Make subpackage of integration. This makes the rpctest package a subpackage of the integration package since its primary purpose is for integration testing. 2016-10-26 11:55:49 -05:00
			`Package rpctest provides a btcd-specific RPC testing harness crafting and`
			executing integration tests by driving a `btcd` instance via the `RPC`
			`interface. Each instance of an active harness comes equipped with a simple`
			`in-memory HD wallet capable of properly syncing to the generated chain,`
			`creating new addresses, and crafting fully signed transactions paying to an`
			`arbitrary set of outputs.`

			`This package was designed specifically to act as an RPC testing harness for`
			`btcd`. However, the constructs presented are general enough to be adapted to
			any project wishing to programmatically drive a `btcd` instance of its
			`systems/integration tests.`

			`## Installation and Updating`

			```bash
multi: correct all import paths 2018-05-14 20:44:11 -07:00			`$ go get -u github.com/btcsuite/btcd/integration/rpctest`
rpctest: Make subpackage of integration. This makes the rpctest package a subpackage of the integration package since its primary purpose is for integration testing. 2016-10-26 11:55:49 -05:00			```

			`## License`

			`Package rpctest is licensed under the [copyfree](http://copyfree.org) ISC`
			`License.`