- Notifications
You must be signed in to change notification settings - Fork2
SchoolOfFreelancing/The-Parity-Bitcoin-client
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Gitter
Installingpbtc from source requiresrustc andcargo.
Minimal supported version isrustc 1.23.0 (766bd11c8 2018-01-01)
Bothrustc andcargo are a part of rust tool-chain.
An easy way to install the stable binaries for Linux and Mac is to run this in your shell:
curl -sSf https://static.rust-lang.org/rustup.sh | shWindows binaries can be downloaded fromrust-lang website.
You will need the cc and gcc compilers to build some of the dependencies.
sudo apt-get updatesudo apt-get install build-essentialNow let's clonepbtc and enter it's directory:
git clone https://github.com/paritytech/parity-bitcoincd parity-bitcoinpbtc can be build in two modes.--debug and--release. Debug is the default.
# builds pbtc in debug modecargo build -p pbtc# builds pbtc in release modecargo build -p pbtc --releasepbtc is now available at either./target/debug/pbtc or./target/release/pbtc.
In any of thesupported Linux distros:
sudo snap install parity-bitcoin --edgepbtc has internal unit tests and it conforms to external integration tests.
Assuming that repository is already cloned, we can run unit tests with this command:
cargo test --allRunning integration tests is automated, as the regtests repository is one of the submodules. Let's download it first:
git submodule update --initNow we can run them using the command:
./tools/regtests.shIt is also possible to run regtests manually:
# let's start pbtc in regtest compatible mode./target/release/pbtc --btc --regtest# now in second shell windowcd $HOMEgit clone https://github.com/TheBlueMatt/test-scriptscd test-scriptsjava -jar pull-tests-f56eec3.jarBy default parity connects to bitcoind-seednodes. Full list is availablehere.
Before starting synchronization, you must decide - which fork to follow - Bitcoin Core (--btc flag) or Bitcoin Cash (--bch flag). On next start, passing the same flag is optional, as the database is already bound to selected fork and won't be synchronized using other verification rules.
To start syncing the main network, just start the client, passing selected fork flag. For example:
./target/release/pbtc --btcTo start syncing the testnet:
./target/release/pbtc --btc --testnetTo not print any syncing progress add--quiet flag:
./target/release/pbtc --btc --quietIt is possible to import existingbitcoind database:
# where $BITCOIND_DB is path to your bitcoind database, e.g., "/Users/user/Library/Application Support"./target/release/pbtc import "$BITCOIND_DB/Bitcoin/blocks"By default import verifies imported the blocks. You can disable this, by adding--verification-level=none flag.
./target/release/pbtc --btc --verification-level=none import "$BITCOIND_DB/Bitcoin/blocks"Full list of CLI options, which is available underpbtc --help:
pbtc 0.1.0Parity Technologies <info@parity.io>Parity Bitcoin clientUSAGE: pbtc [FLAGS] [OPTIONS] [SUBCOMMAND]FLAGS: --bch Use Bitcoin Cash verification rules (BCH). --btc Use Bitcoin Core verification rules (BTC). -h, --help Prints help information --no-jsonrpc Disable the JSON-RPC API server. -q, --quiet Do not show any synchronization information in the console. --regtest Use a private network for regression tests. --testnet Use the test network (Testnet3). -V, --version Prints version informationOPTIONS: --blocknotify <COMMAND> Execute COMMAND when the best block changes (%s in COMMAND is replaced by the block hash). -c, --connect <IP> Connect only to the specified node. -d, --data-dir <PATH> Specify the database and configuration directory PATH. --db-cache <SIZE> Sets the database cache size. --jsonrpc-apis <APIS> Specify the APIs available through the JSONRPC interface. APIS is a comma-delimited list of API names. --jsonrpc-cors <URL> Specify CORS header for JSON-RPC API responses. --jsonrpc-hosts <HOSTS> List of allowed Host header values. --jsonrpc-interface <INTERFACE> The hostname portion of the JSONRPC API server. --jsonrpc-port <PORT> Specify the PORT for the JSONRPC API server. --only-net <NET> Only connect to nodes in network version <NET> (ipv4 or ipv6). --port <PORT> Listen for connections on PORT. -s, --seednode <IP> Connect to a seed-node to retrieve peer addresses, and disconnect. --verification-edge <BLOCK> Non-default verification-level is applied until a block with given hash is met. --verification-level <LEVEL> Sets the Blocks verification level to full (default), header (scripts are not verified), or none (no verification at all).SUBCOMMANDS: help Prints this message or the help of the given subcommand(s) import Import blocks from a Bitcoin Core database. rollback Rollback the database to given canonical-chain block.The JSON-RPC interface is served on port :8332 for mainnet and :18332 for testnet unless you specified otherwise. So if you are using testnet, you will need to change the port in the sample curl requests shown below.
The Parity-bitcoinnetwork interface.
Add the node.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "addnode", "params": ["127.0.0.1:8888", "add"], "id":1 }' localhost:8332Remove the node.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "addnode", "params": ["127.0.0.1:8888", "remove"], "id":1 }' localhost:8332Connect to the node.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "addnode", "params": ["127.0.0.1:8888", "onetry"], "id":1 }' localhost:8332Query info for all added nodes.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "id":"1", "method": "getaddednodeinfo", "params": [true] }' localhost:8332Query info for the specified node.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "id":"1", "method": "getaddednodeinfo", "params": [true, "192.168.0.201"] }' localhost:8332Get the peer count.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "id":"1", "method": "getconnectioncount", "params": [] }' localhost:8332The Parity-bitcoinblockchain data interface.
Get hash of best block.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getbestblockhash", "params": [], "id":1 }' localhost:8332Get height of best block.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getblockcount", "params": [], "id":1 }' localhost:8332Get hash of block at given height.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getblockhash", "params": [0], "id":1 }' localhost:8332Get proof-of-work difficulty as a multiple of the minimum difficulty
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getdifficulty", "params": [], "id":1 }' localhost:8332Get information on given block.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getblock", "params": ["000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f"], "id":1 }' localhost:8332Get details about an unspent transaction output.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "gettxout", "params": ["4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b", 0], "id":1 }' localhost:8332Get statistics about the unspent transaction output set.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "gettxoutsetinfo", "params": [], "id":1 }' localhost:8332The Parity-bitcoinminer data interface.
Get block template for mining.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getblocktemplate", "params": [{"capabilities": ["coinbasetxn", "workid", "coinbase/append"]}], "id":1 }' localhost:8332The Parity-bitcoinraw data interface.
Return the raw transaction data.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "getrawtransaction", "params": ["4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b"], "id":1 }' localhost:8332Return an object representing the serialized, hex-encoded transaction.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "decoderawtransaction", "params": ["01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff4d04ffff001d0104455468652054696d65732030332f4a616e2f32303039204368616e63656c6c6f72206f6e206272696e6b206f66207365636f6e64206261696c6f757420666f722062616e6b73ffffffff0100f2052a01000000434104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5fac00000000"], "id":1 }' localhost:8332Create a transaction spending the given inputs and creating new outputs.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "createrawtransaction", "params": [[{"txid":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","vout":0}],{"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa":0.01}], "id":1 }' localhost:8332Adds transaction to the memory pool && relays it to the peers.
curl -H 'content-type: application/json' --data-binary '{"jsonrpc": "2.0", "method": "sendrawtransaction", "params": ["01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff4d04ffff001d0104455468652054696d65732030332f4a616e2f32303039204368616e63656c6c6f72206f6e206272696e6b206f66207365636f6e64206261696c6f757420666f722062616e6b73ffffffff0100f2052a01000000434104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5fac00000000"], "id":1 }' localhost:8332This is a section only for developers and power users.
You can enable detailed client logging by setting the environment variableRUST_LOG, e.g.,
RUST_LOG=verification=info ./target/release/pbtc --btcpbtc started with this environment variable will print all logs coming fromverification module with verbosityinfo or higher. Available log levels are:
errorwarninfodebugtrace
It's also possible to start logging from multiple modules in the same time:
RUST_LOG=sync=trace,p2p=trace,verification=trace,db=trace ./target/release/pbtc --btcOnce released,pbtc documentation will be availablehere. Meanwhile it's only possible to build it locally:
cd parity-bitcoin./tools/doc.shopen target/doc/pbtc/index.htmlAbout
The Parity Bitcoin Client
Topics
Resources
License
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Languages
- Rust99.6%
- Other0.4%