Rename the repo and crates

The current names are long and annoying, lets rename them.

This is based on top of the 0.3.0 releases so that there is some
continuity.

The repository changes from `rust-bitcoind-json-rpc` to `corepc`.

Crate name changes:

- `bitcoind-json-rpc-client` becomes `corepc-client`
- `bitcoind-json-rpc-types` becomes `corepc-types`
- `bitcoind-json-rpc-regtest` becomes `corepc-node`

Directory name changes:

- `json` becomes `types` (to match the crate name)
- `regtest` becomes `bitcoind` (to match the original project name)

Next, bump version numbers

In preparation for release bump the version number, add changelog
entries, and update the lock-files.

Done for all three released crates.

Author: tcharding

CHANGELOG.md

@@ -85,39 +85,39 @@ dependencies = [
 ]
 
 [[package]]
-name = "bitcoind-json-rpc-client"
-version = "0.3.0"
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
+[[package]]
+name = "cc"
+version = "1.0.28"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bb4a8b715cb4597106ea87c7c84b2f1d452c7492033765df7f32651e66fcf749"
+
+[[package]]
+name = "corepc-client"
+version = "0.4.0"
 dependencies = [
  "bitcoin",
- "bitcoind-json-rpc-types",
+ "corepc-types",
  "jsonrpc",
  "log",
  "serde",
  "serde_json",
 ]
 
 [[package]]
-name = "bitcoind-json-rpc-types"
-version = "0.3.0"
+name = "corepc-types"
+version = "0.4.0"
 dependencies = [
  "bitcoin",
  "bitcoin-internals",
  "serde",
  "serde_json",
 ]
 
-[[package]]
-name = "byteorder"
-version = "1.5.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
-
-[[package]]
-name = "cc"
-version = "1.0.28"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bb4a8b715cb4597106ea87c7c84b2f1d452c7492033765df7f32651e66fcf749"
-
 [[package]]
 name = "hex-conservative"
 version = "0.2.1"
@@ -297,3 +297,7 @@ name = "winapi-x86_64-pc-windows-gnu"
 version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[patch.unused]]
+name = "corepc-node"
+version = "0.4.0"

Cargo-minimal.lock

@@ -85,39 +85,39 @@ dependencies = [
 ]
 
 [[package]]
-name = "bitcoind-json-rpc-client"
-version = "0.3.0"
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
+[[package]]
+name = "cc"
+version = "1.0.28"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bb4a8b715cb4597106ea87c7c84b2f1d452c7492033765df7f32651e66fcf749"
+
+[[package]]
+name = "corepc-client"
+version = "0.4.0"
 dependencies = [
  "bitcoin",
- "bitcoind-json-rpc-types",
+ "corepc-types",
  "jsonrpc",
  "log",
  "serde",
  "serde_json",
 ]
 
 [[package]]
-name = "bitcoind-json-rpc-types"
-version = "0.3.0"
+name = "corepc-types"
+version = "0.4.0"
 dependencies = [
  "bitcoin",
  "bitcoin-internals",
  "serde",
  "serde_json",
 ]
 
-[[package]]
-name = "byteorder"
-version = "1.5.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
-
-[[package]]
-name = "cc"
-version = "1.0.28"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bb4a8b715cb4597106ea87c7c84b2f1d452c7492033765df7f32651e66fcf749"
-
 [[package]]
 name = "hex-conservative"
 version = "0.2.1"
@@ -297,3 +297,7 @@ name = "winapi-x86_64-pc-windows-gnu"
 version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[patch.unused]]
+name = "corepc-node"
+version = "0.4.0"

Cargo-recent.lock

@@ -1,13 +1,16 @@
 [workspace]
-members = ["client", "json", "jsonrpc"]
-exclude = ["integration_test", "regtest"]
+members = ["client", "types", "jsonrpc"]
+exclude = ["integration_test", "bitcoind"]
 resolver = "2"
 
-[patch.crates-io.bitcoind-json-rpc-client]
+[patch.crates-io.corepc-client]
 path = "client"
 
-[patch.crates-io.bitcoind-json-rpc-types]
-path = "json"
+[patch.crates-io.corepc-types]
+path = "types"
+
+[patch.crates-io.corepc-node]
+path = "bitcoind"
 
 [patch.crates-io.jsonrpc]
 path = "jsonrpc"

Cargo.toml

@@ -1,25 +1,29 @@
-# `bitcoind` JSON-RPC support
+# Bitcoin Core JSON-RPC support
 
-There are two primary purposes of this repository.
+There are two primary purposes of this repository:
 
-1. Provide the [`bitcoind-json-rpc-types`](https://crates.io/crates/bitcoind-json-rpc-types) crate
-   for use in production software.
-2. Provide tools to the community for integration testing code written in Rust that interacts with
-   the Bitcoin network. Primarily consumers of the [`rust-bitcoin`](https://crates.io/crates/bitcoin)
-   library. And enable doing so against multiple versions of Bitcoin Core.
+1. Provide the [`corepc-types`](https://crates.io/crates/corepc-types) crate for use in production
+   software. 
+   
+2. Provide tools for integration testing Rust code that interacts with the Bitcoin network.
+   Primarily consumers of the [`rust-bitcoin`](https://crates.io/crates/bitcoin) library. And enable
+   doing so against multiple versions of Bitcoin Core.
 
 If you require a JSON RPC client in production software it is expected you write your own and only
-use the `bitcoind-json-rpc-types` crate in your dependency graph. Feel free to copy/steal/plagiarise
-or otherwise enjoy yourself with anything in this repository - no attribution required.
+use the `corepc-types` crate in your dependency graph. Feel free to copy/steal/plagiarise or
+otherwise enjoy yourself with anything in this repository - no attribution required.
 
-**Please do not use `client` in production and raise bugs, issues, or feature requests.**
+**Please do not use `corepc` in production and raise bugs, issues, or feature requests.**
 
-## Crate listing
+## Crate/directory listing
 
-- [`json`](https://crates.io/crates/bitcoind-json-rpc-types): Rust types returned by the JSON-RPC API of Bitcoin Core (`bitcoind-json-rpc-types`).
-- [`regtest`](https://crates.io/crates/bitcoind-json-rpc-regtest): Runs `bitcoind` regtest nodes.
-- [`client`](https://crates.io/crates/bitcoind-json-rpc-client): A blocking JSON-RPC client used to test `bitcoind-json-rpc-types`.
-- `integration_test`: Integration tests that use `client` and `regtest` to test `json`.
+- `types/`: [`corepc-types`](https://crates.io/crates/corepc-types): Rust types returned by the JSON-RPC API of Bitcoin Core.
+- `bitcoind/`: [`corepc-node`](https://crates.io/crates/corepc-node): Runs `bitcoind` regtest nodes.
+- `client/`: [`corepc-client`](https://crates.io/crates/corepc-client): A blocking JSON-RPC client used to test `corepc-types`.
+- `integration_test/`: Integration tests that use `corepc` and `corepc-node` to test `corepc-types`.
+
+
+## `corepc-types` Design
 
 ## Original code
 

README.md

@@ -1,3 +1,9 @@
+# 0.4.0 - 2024-11-14
+
+- Add support for Bitcoin Core v28
+- Re-name the repository from `rust-bitcoind-josn-rpc` to `corepc`.
+- Re-name the crate from `bitcoind-josn-rpc-regtest` to `corepc-node`.
+
 # 0.3.0 - 2024-06-21
 
 - Call `into_model` when creating/loading wallet.

regtest/CHANGELOG.md renamed to bitcoind/CHANGELOG.md

@@ -1,9 +1,9 @@
 [package]
-name = "bitcoind-json-rpc-regtest"
-version = "0.3.0"
+name = "corepc-node"
+version = "0.4.0"
 authors = ["Riccardo Casatta <[email protected]>", "Tobin C. Harding <[email protected]>"]
 license = "MIT"
-repository = "https://github.com/rust-bitcoin/rust-bitcoind-json-rpc"
+repository = "https://github.com/tcharding/corepc/corepc-node"
 description = "Utility to run a regtest bitcoind process, useful in integration testing environments"
 categories = ["cryptography::cryptocurrencies", "development-tools::testing"]
 keywords = ["bitcoin", "bitcoind", "json-rpc"]
@@ -13,7 +13,7 @@ rust-version = "1.63.0"
 exclude = ["tests", "contrib"]
 
 [dependencies]
-bitcoind-json-rpc-client = { version = "0.3", features = ["client-sync"] }
+corepc-client = { version = "0.4", features = ["client-sync"] }
 log = "0.4"
 which = "4.2.5"
 anyhow = "1.0.66"
@@ -73,8 +73,8 @@ anyhow = "1.0.66"
 features = ["download", "doc", "26_2"]
 rustdoc-args = ["--cfg", "docsrs"]
 
-[patch.crates-io.bitcoind-json-rpc-client]
+[patch.crates-io.corepc-client]
 path = "../client"
 
-[patch.crates-io.bitcoind-json-rpc-types]
-path = "../json"
+[patch.crates-io.corepc-types]
+path = "../types"