Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stackzoo/craftbit

Bitcoin Swiss Army Knife 🪛 🌕 🔧
https://github.com/stackzoo/craftbit

bitcoin cli cryptocurrency cryptography golang lightning-network utilities

Last synced: about 2 months ago
JSON representation

Bitcoin Swiss Army Knife 🪛 🌕 🔧

Host: GitHub
URL: https://github.com/stackzoo/craftbit
Owner: stackzoo
License: mit
Created: 2024-03-12T08:53:55.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-03-29T08:01:50.000Z (9 months ago)
Last Synced: 2024-06-21T14:13:32.101Z (7 months ago)
Topics: bitcoin, cli, cryptocurrency, cryptography, golang, lightning-network, utilities
Language: Go
Homepage:
Size: 6.3 MB
Stars: 8
Watchers: 0
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        #  CRAFTBIT  

[![CI](https://github.com/stackzoo/craftbit/actions/workflows/ci.yaml/badge.svg)](https://github.com/stackzoo/craftbit/actions/workflows/ci.yaml) [![Go Report Card](https://goreportcard.com/badge/github.com/stackzoo/craftbit)](https://goreportcard.com/report/github.com/stackzoo/craftbit)  

[![Latest Release](https://img.shields.io/github/release/stackzoo/craftbit.svg)](https://github.com/stackzoo/craftbit/releases/latest) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)  






Bitcoin Swiss Army Knife 🪛 🌕 🔧

## Abstract

This software is a lightweight, multi-platform Command Line Interface (CLI) containing multiple utilities designed for interacting with the Bitcoin ecosystem.  

Most of these utilities either serve as wrappers for [*btcd*](https://github.com/btcsuite/btcd) libraries or make calls to the [*mempool.space REST APIs*](https://mempool.space/docs/api/rest).  

> [!WARNING] 

> As certain functions leverage the APIs of the public instance of **mempool.space**, this tool may be suboptimal from a privacy perspective and inadvertently expose personally identifiable information (PII) such as transactions or addresses.  

## Why CraftBit ?

This tool serves multiple purposes:

1. It consolidates various utilities for interacting with the *Bitcoin* ecosystem into a single executable.

2. It provides reusable atomic packages and functions, organized under the `pkg` folder.

3. It aims to serve as an educational aid for individuals new to the Bitcoin world.  

## Supported Features

Following are some of the tool's supported features:  

1. Decode raw transaction

1. Generate hierarchical deterministic private key

1. Generate P2PKH address from hd private key

1. Retrieve current BTC price in multiple currencies

1. Retrieve latest block heigh in the blockchain

1. Retrieve current recommended fees

1. Retrieve Lightning networ statistics

1. Retrieve Lightning network top nodes

1. Retrieve address transaction history  

## How to install

### Homebrew

You can install craftib via *homebrew* with the following command:  

```console

brew tap stackzoo/craftbit https://github.com/stackzoo/craftbit && \

brew install craftbit

```  

### Releases

Go to the [*release*](https://github.com/stackzoo/craftbit/releases) page and download the binary for your OS.  

## How to update

### Homebrew

If you installed craftbit via *homebrew*, you can update to the latest version with the following command:  

```console

brew update && brew upgrade craftbit

```  

### Releases

Go to the [*release*](https://github.com/stackzoo/craftbit/releases) page and download the latest binary for your OS.  

## Usage

![usage](docs/images/usage.gif)