https://github.com/cabol/btx
Bitcoin Toolkit for Elixir
https://github.com/cabol/btx
bitcoin bitcoin-api bitcoin-core elixir
Last synced: 11 months ago
JSON representation
Bitcoin Toolkit for Elixir
- Host: GitHub
- URL: https://github.com/cabol/btx
- Owner: cabol
- Created: 2025-07-16T18:18:15.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-24T19:04:00.000Z (11 months ago)
- Last Synced: 2025-07-25T00:03:11.432Z (11 months ago)
- Topics: bitcoin, bitcoin-api, bitcoin-core, elixir
- Language: Elixir
- Homepage:
- Size: 180 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSEmd
Awesome Lists containing this project
README
# ⚡₿𝕋𝕩
> Bitcoin Toolkit for Elixir.
[](http://codecov.io/gh/cabol/btx/graph/badge.svg)
[](http://hex.pm/packages/btx)
[](http://hexdocs.pm/btx)
## About
**BTx** is a modern Elixir library for Bitcoin development, starting with a
powerful JSON-RPC client for Bitcoin Core. Designed for developers building
Bitcoin applications, `BTx` provides an idiomatic Elixir interface with plans
to expand into comprehensive Bitcoin tooling.
## Features
- **Full JSON-RPC Compliance**: Complete implementation of Bitcoin Core's
JSON-RPC API (`BTx.RPC`).
- **Idiomatic Elixir Interface**: Clean, functional API that feels natural
in Elixir applications.
- **Configurable Client**: Built on Tesla for flexible HTTP client
configuration.
- **Automatic Encoding**: Bitcoin methods automatically encoded using Ecto
embedded schemas.
- **Response Handling**: Intelligent response parsing and error handling.
## Installation
Add `btx` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:btx, "~> 0.1.0"}
]
end
```
## Quick Start
The first step is to ensure that you have a Bitcoin node running locally.
You can use the `docker-compose.yml` file in the repo to spin up the Bitcoin
node (running in `regtest` mode), like so:
```shell
docker-compose up -d
```
Now we can start using the JSON RPC API. Let's create a wallet:
```elixir
# Create a new client
iex> client =
...> BTx.RPC.client(
...> base_url: "http://127.0.0.1:18443",
...> username: "my-user",
...> password: "my-pass"
...> )
# Create a wallet (using the `BTx.RPC.Wallets` context)
iex> BTx.RPC.Wallets.create_wallet!(client,
...> wallet_name: "my-wallet",
...> passphrase: "my-passphrase",
...> avoid_reuse: true,
...> descriptors: true
...> )
%BTx.RPC.Wallets.CreateWalletResult{
name: "my-wallet",
warning: nil
}
```
## Roadmap
BTx is under active development with plans to expand beyond JSON-RPC:
- **Phase 1** (Current): Complete JSON-RPC client implementation
- **Phase 2**: Wallet management utilities
- **Phase 3**: Transaction building and signing
- **Phase 4**: Blockchain analysis and utilities
- **Phase 5**: Advanced Bitcoin primitives
## Development Status
⚠️ **Work in Progress**: `BTx` is currently under active development. While the
core JSON-RPC functionality is being implemented, the API may change between
versions. Not recommended for production use yet.
## Contributing
Contributions to **BTx** are very welcome and appreciated!
Use the [issue tracker](https://github.com/cabol/btx/issues)
for bug reports or feature requests. Open a
[pull request](https://github.com/cabol/btx/pulls)
when you are ready to contribute.
When submitting a pull request you should not update the
[CHANGELOG.md](CHANGELOG.md), and also make sure you test your changes
thoroughly, include unit tests alongside new or changed code.
Before to submit a PR it is highly recommended to run `mix test.ci` and ensure
all checks run successfully.
## Copyright and License
Copyright (c) 2025 Carlos Andres Bolaños R.A.
Nebulex source code is licensed under the [MIT License](LICENSE).