Merge remote-tracking branch 'rpc/master'

Author: shumkov

.editorconfig

@@ -0,0 +1,5 @@
+# see https://editorconfig.org for more options, and setup instructions for yours editor
+
+[*]
+indent_style = space
+indent_size = 4

.github/workflows/rust.yml

@@ -22,7 +22,7 @@ jobs:
           - rust: nightly
             env:
               # TODO: running with DO_BENCH: true causes the test to fail
-#              DO_BENCH: true
+              #              DO_BENCH: true
               AS_DEPENDENCY: true
               DO_NO_STD: false
               DO_DOCS: true
@@ -86,3 +86,61 @@ jobs:
 #        run: cd hashes/embedded && cargo run --target thumbv7m-none-eabi
 #      - name: Run hashes/embedded with alloc
 #        run: cd hashes/embedded && cargo run --target thumbv7m-none-eabi --features=alloc
+
+    rpc-tests:
+      name: Tests
+      runs-on: ubuntu-latest
+      strategy:
+        matrix:
+          include:
+            - rust: stable
+              env:
+                RUSTFMTCHK: true
+            - rust: nightly
+              env:
+                RUSTFMTCHK: false
+            - rust: 1.29.0
+              env:
+                PIN_VERSIONS: true
+      steps:
+        - name: Checkout Crate
+          uses: actions/checkout@v2
+        - name: Checkout Toolchain
+          uses: actions-rs/toolchain@v1
+          with:
+            profile: minimal
+            toolchain: ${{ matrix.rust }}
+            override: true
+        - name: Running test script
+          env: ${{ matrix.env }}
+          run: ./contrib/test.sh
+
+    integrations-tests:
+      name: Integration Tests
+      runs-on: ubuntu-latest
+      strategy:
+        matrix:
+          rust: [stable]
+          bitcoinversion:
+            [
+              "0.18.0",
+              "0.18.1",
+              "0.19.0.1",
+              "0.19.1",
+              "0.20.0",
+              "0.20.1",
+              "0.21.0",
+            ]
+      steps:
+        - name: Checkout Crate
+          uses: actions/checkout@v2
+        - name: Checkout Toolchain
+          uses: actions-rs/toolchain@v1
+          with:
+            profile: minimal
+            toolchain: ${{ matrix.rust }}
+            override: true
+        - name: Running test script
+          env:
+            BITCOINVERSION: ${{ matrix.bitcoinversion }}
+          run: ./contrib/test.sh

.rustfmt.toml

@@ -0,0 +1 @@
+use_small_heuristics = "Off"

CHANGELOG.md

@@ -353,3 +353,189 @@ See `Transaction::verify` and `Script::verify` methods.
 
 * Remove `num` dependency at Matt's request; agree this is obnoxious to require all
 downstream users to also have a `num` dependency just so they can use `Uint256::from_u64`.
+
+### Dashcore RPC
+
+# 0.15.0
+
+- bump bitcoin crate version to 0.28.0
+- add `get_block_stats`
+- add `add_node`
+- add `remove_node`
+- add `onetry_node`
+- add `disconnect_node`
+- add `disconnect_node_by_id`
+- add `get_added_node_info`
+- add `get_node_addresses`
+- add `list_banned`
+- add `clear_banned`
+- add `add_ban`
+- add `remove_ban`
+- make `Auth::get_user_pass` public
+- add `ScriptPubkeyType::witness_v1_taproot`
+
+# 0.14.0
+
+- add `wallet_conflicts` field in `WalletTxInfo`
+- add `get_chain_tips`
+- add `get_block_template`
+- implement `From<u64>` and `From<Option<u64>>` for `ImportMultiRescanSince`
+- bump rust-bitcoin dependency to 0.27
+- bump json-rpc dependency to 0.12.0
+- remove dependency on `hex`
+
+# 0.13.0
+
+- add `wallet_process_psbt`
+- add `unlock_unspent_all`
+- compatibility with Bitcoin Core v0.21
+- bump rust-bitcoin dependency to 0.26
+- implement Deserialize for ImportMultiRescanSince
+- some fixes for some negative confirmation values
+
+# 0.12.0
+
+- bump `bitcoin` dependency to version `0.25`, increasing our MSRV to `1.29.0`
+- test against `bitcoind` `0.20.0` and `0.20.1`
+- add `get_balances`
+- add `get_mempool_entry`
+- add `list_since_block`
+- add `get_mempool_entry`
+- add `list_since_block`
+- add `uptime`
+- add `get_network_hash_ps`
+- add `get_tx_out_set_info`
+- add `get_net_totals`
+- partially implement `scantxoutset`
+- extend `create_wallet` and related APIs
+- extend `GetWalletInfoResult`
+- extend `WalletTxInfo`
+- extend testsuite
+- fix `GetPeerInfoResult`
+- fix `GetNetworkInfoResult`
+- fix `GetTransactionResultDetailCategory`
+- fix `GetMempoolEntryResult` for bitcoind prior to `0.19.0`
+- fix `GetBlockResult` and `GetBlockHeaderResult`
+
+# 0.11.0
+
+- fix `minimum_sum_amount` field name in `ListUnspentQueryOptions`
+- add missing "orphan" variant for `GetTransactionResultDetailCategory`
+- add `ImportMultiRescanSince` to support "now" for `importmulti`'s
+  `timestamp` parameter
+- rename logging target to `bitcoincore_rpc` instead of `bitcoincore_rpc::client`
+- other logging improvements
+
+# 0.10.0
+
+- rename `dump_priv_key` -> `dump_private_key` + change return type
+- rename `get_block_header_xxx` methods to conform with `get_block_xxx` methods
+- rename `get_raw_transaction_xxx` methods to conform with `get_block_xxx` methods
+- rename `GetBlockHeaderResult` fields
+- rename `GetMiningInfoResult` fields
+- represent difficulty values as `f64` instead of `BigUint`
+- fix `get_peer_info`
+- fix `get_transaction`
+- fix `get_balance`
+- fix `get_blockchain_info` and make compatible with both 0.18 and 0.19
+- fix `get_address_info`
+- fix `send_to_address`
+- fix `estimate_smart_fee`
+- fix `import_private_key`
+- fix `list_received_by_address`
+- fix `import_address`
+- fix `finalize_psbt`
+- fix `fund_raw_transaction`
+- fix `test_mempool_accept`
+- fix `stop`
+- fix `rescan_blockchain`
+- add `import_address_script`
+- add `get_network_info`
+- add `version`
+- add `Error::UnexpectedStructure`
+- add `GetTransactionResultDetailCategory::Immature`
+- make `list_unspent` more ergonomic
+- made all exported enum types implement `Copy`
+- export `jsonrpc` dependency.
+- remove `num_bigint` dependency
+
+# v0.9.1
+
+- Add `wallet_create_funded_psbt`
+- Add `get_descriptor_info`
+- Add `combine_psbt`
+- Add `derive_addresses`
+- Add `finalize_psbt`
+- Add `rescan_blockchain`
+
+# v0.7.0
+
+- use `bitcoin::PublicKey` instead of `secp256k1::PublicKey`
+- fix get_mining_info result issue
+- fix test_mempool_accept issue
+- fix get_transaction result issues
+- fix bug in fund_raw_transaction
+- add list_transactions
+- add get_raw_mempool
+- add reconsider_block
+- add import_multi
+- add import_public_key
+- add set_label
+- add lock_unspent
+- add unlock_unspent
+- add create_wallet
+- add load_wallet
+- add unload_wallet
+- increased log level for requests to debug
+
+# v0.6.0
+
+- polish Auth to use owned Strings
+- fix using Amount type and Address types where needed
+- use references of sha256d::Hashes instead of owned/copied
+
+# v0.5.1
+
+- add get_tx_out_proof
+- add import_address
+- add list_received_by_address
+
+# v0.5.0
+
+- add support for cookie authentication
+- add fund_raw_transaction command
+- deprecate sign_raw_transaction
+- use PrivateKey type for calls instead of string
+- fix for sign_raw_transaction
+- use 32-bit integers for confirmations, signed when needed
+
+# v0.4.0
+
+- add RawTx trait for commands that take raw transactions
+- update jsonrpc dependency to v0.11.0
+- fix for create_raw_transaction
+- fix for send_to_address
+- fix for get_new_address
+- fix for get_tx_out
+- fix for get_raw_transaction_verbose
+- use `secp256k1::SecretKey` type in API
+
+# v0.3.0
+
+- removed the GetTransaction and GetScript traits
+    (those methods are now directly implemented on types)
+- introduce RpcApi trait
+- use bitcoin_hashes library
+- add signrawtransactionwithkey command
+- add testmempoolaccept command
+- add generate command
+- improve hexadecimal byte value representation
+- bugfix getrawtransaction (support coinbase txs)
+- update rust-bitcoin dependency v0.16.0 -> v0.18.0
+- add RetryClient example
+
+# v0.2.0
+
+- add send_to_address command
+- add create_raw_transaction command
+- Client methods take self without mut

Cargo.toml

@@ -2,5 +2,22 @@
 members = ["dash", "hashes", "internals", "fuzz"]
 resolver = "2"
 
+
+
 [patch.crates-io.dashcore_hashes]
 path = "hashes"
+
+
+[workspace]
+
+members = [
+    "json",
+    "client",
+    "integration_test",
+]
+
+
+
+[workspace.package]
+version = "0.17.0"
+

README.md

@@ -4,7 +4,7 @@
   <img alt="Rust Dash logo by Rostislav Gorbachenko, UX engineer at Dash Core Group, see license and source files under /logo" src="./logo/rust-dash-together.png" width="300" />
 
   <p>Library with support for de/serialization, parsing and executing on data-structures
-    and network messages related to Dash Core payment chain.
+    and network messages related to Dash Core payment chain. Core RPC client.
   </p>
 
   <p>
@@ -29,36 +29,85 @@ Supports (or should support)
 * Private keys and address creation, de/serialization and validation (including full BIP32 support)
 * PSBT creation, manipulation, merging and finalization
 * Pay-to-contract support as in Appendix A of the [Blockstream sidechains whitepaper](https://www.blockstream.com/sidechains.pdf)
+* JSONRPC interaction with Dash Core
 
-For JSONRPC interaction with Dash Core, it is recommended to use
-[rust-dashcore-rpc](https://github.com/dashevo/rust-dashcore-rpc).
+# Known limitations
 
-## Known limitations
-
-### Consensus
+## Consensus
 
 This library **must not** be used for consensus code (i.e. fully validating
 blockchain data). It technically supports doing this, but doing so is very
 ill-advised because there are many deviations, known and unknown, between
 this library and the Dash Core reference implementation. In a consensus
 based cryptocurrency such as Dash it is critical that all parties are
-using the same rules to validate data, and this library does not and might 
+using the same rules to validate data, and this library does not and might
 never implement the same rules as Core.
 
 Given the complexity of both C++ and Rust, it is unlikely that this will
 ever be fixed, and there are no plans to do so. Of course, patches to
 fix specific consensus incompatibilities are welcome.
 
-### Support for 16-bit pointer sizes
+## Support for 16-bit pointer sizes
 
 16-bit pointer sizes are not supported and we can't promise they will be.
 It will be dependent on rust-bitcoin implementing them first.
 
-## Documentation
+# Usage
+Given below is an example of how to connect to the Dash Core JSON-RPC for a Dash Core node running on `localhost`
+and print out the hash of the latest block.
+
+It assumes that the node has password authentication setup, the RPC interface is enabled at port `8332` and the node
+is set up to accept RPC connections.
+
+```rust
+extern crate dashcore_rpc;
+
+use dashcore_rpc::{Auth, Client, RpcApi};
+
+fn main() {
+
+    let rpc = Client::new(
+        "localhost:19998",
+                          Auth::UserPass("<FILL RPC USERNAME>".to_string(),
+                                         "<FILL RPC PASSWORD>".to_string())).unwrap();
+    let best_block_hash = rpc.get_best_block_hash().unwrap();
+    println!("best block hash: {}", best_block_hash);
+}
+```
+
+See `client/examples/` for more usage examples.
+
+# Supported Dash Core Versions
+The following versions are officially supported and automatically tested:
+* 0.18.0
+* 0.18.1
+* 0.19.0.1
+* 0.19.1
+* 0.20.0
+* 0.20.1
+* 0.21.0
+
+# Minimum Supported Rust Version (MSRV)
+This library should always compile with any combination of features on **Rust 1.29**.
+
+Because some dependencies have broken the build in minor/patch releases, to
+compile with 1.29.0 you will need to run the following version-pinning command:
+```
+cargo update --package "cc" --precise "1.0.41"
+cargo update --package "log:0.4.x" --precise "0.4.13" # x being the highest patch version, currently 14
+cargo update --package "cfg-if" --precise "0.1.9"
+cargo update --package "serde_json" --precise "1.0.39"
+cargo update --package "serde" --precise "1.0.98"
+cargo update --package "serde_derive" --precise "1.0.98"
+cargo update --package "byteorder" --precise "1.3.4"
+```
+
+
+# Documentation
 
 Documentation can be found on [dashcore.readme.io/docs](https://dashcore.readme.io/docs).
 
-## Contributing
+# Contributing
 
 Contributions are generally welcome. If you intend to make larger changes please
 discuss them in an issue before PRing them to avoid duplicate work and