https://github.com/ACINQ/bitcoin-kmp

Kotlin Multiplatform Bitcoin Library
https://github.com/ACINQ/bitcoin-kmp

bitcoin kotlin kotlin-multiplatform

Last synced: 3 months ago
JSON representation

Kotlin Multiplatform Bitcoin Library

• Host: GitHub
• URL: https://github.com/ACINQ/bitcoin-kmp
• Owner: ACINQ
• License: apache-2.0
• Created: 2020-03-24T13:30:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T10:37:50.000Z (5 months ago)
• Last Synced: 2024-07-12T21:13:59.035Z (4 months ago)
• Topics: bitcoin, kotlin, kotlin-multiplatform
• Language: Kotlin
• Homepage:
• Size: 6.63 MB
• Stars: 64
• Watchers: 12
• Forks: 15
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• kmp-awesome - bitcoin-kmp - Kotlin Multiplatform Bitcoin Library (Libraries / 🧩 Service SDK)

README

        
[![Kotlin](https://img.shields.io/badge/Kotlin-1.9.22-blue.svg?style=flat&logo=kotlin)](http://kotlinlang.org)

[![Maven Central](https://img.shields.io/maven-central/v/fr.acinq.bitcoin/bitcoin-kmp)](https://search.maven.org/search?q=g:fr.acinq.bitcoin%20a:bitcoin-kmp*)

![Github Actions](https://github.com/ACINQ/bitcoin-kmp/actions/workflows/test.yml/badge.svg)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/ACINQ/bitcoin-kmp/blob/master/LICENSE)

# Kotlin Multiplatform Bitcoin Library

## Overview

This is a simple Kotlin Multiplatform library which implements most of the bitcoin protocol:

* base58 encoding/decoding

* block headers, block and tx parsing

* tx creation, signature and verification

* script parsing and execution (including OP_CLTV and OP_CSV)

* pay to public key tx

* pay to script tx / multisig tx

* BIP 32 (deterministic wallets)

* BIP 39 (mnemonic code for generating deterministic keys)

* BIP 86 (key derivation for p2tr outputs)

* BIP 173 (Base32 address format for native v0-16 witness outputs)

* BIP 174 (Partially Signed Bitcoin Transaction Format v0)

* BIP 341 and 342 (taproot and tapscript transactions)

* BIP 350 (Bech32m format)

## Objectives

Our goal is not to re-implement a full Bitcoin node but to build a library that implements all the primitives that you need to create bitcoin applications: building and signing transactions, verifying transactions, working with custom bitcoin scripts, parsing blocks, headers, transactions, building BIP39 wallets...

And of course we use this library in our new multiplaform lightning engine https://github.com/ACINQ/lightning-kmp.

Our runtime targets are:

* JVM

* Android

* iOS

* Linux 64 bits (for testing/prototyping only, you should use the JVM for production applications)

## Status

* [X] Message parsing (blocks, transactions, inv, ...)

* [X] Building transactions (P2PK, P2PKH, P2SH, P2WPK, P2WSH)

* [X] Signing transactions

* [X] Verifying signatures

* [X] Passing core reference tests (scripts & transactions)

* [X] Passing core reference segwit tests

* [X] Passing core reference psbt v0 tests

## Install

`bitcoin-kmp` is available on [maven central](https://search.maven.org/search?q=g:fr.acinq.bitcoin%20a:bitcoin-kmp*)

* **Multiplatform**: Add the `fr.acinq.bitcoin:bitcoin-kmp` dependency to your common source set dependencies (you need Gradle 5.0 minimum).

* **JVM**: Add the `fr.acinq.bitcoin:bitcoin-kmp-jvm` dependency to your project.

## libscp256k1 support

**You need to add a JVM implementation of Secp256k1** to your project in order to use bitcoin-kmp with JVM.

Please refer the [Secp256k1 installation section](https://github.com/ACINQ/secp256k1-kmp#installation).

## Usage

Please have a look at unit tests, more samples will be added soon.