Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cevin/btcd

Offline Bitcoin transaction processor , simple self-hosted Bitcoin payment support (create and parse address, create and sign offline transaction)
https://github.com/cevin/btcd

bitcoin bitcoin-api bitcoin-offline btc rawtransaction

Last synced: about 1 month ago
JSON representation

Offline Bitcoin transaction processor , simple self-hosted Bitcoin payment support (create and parse address, create and sign offline transaction)

Host: GitHub
URL: https://github.com/cevin/btcd
Owner: cevin
License: mit
Created: 2023-09-21T03:25:47.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-01-19T07:06:37.000Z (12 months ago)
Last Synced: 2024-06-21T15:26:57.438Z (7 months ago)
Topics: bitcoin, bitcoin-api, bitcoin-offline, btc, rawtransaction
Language: Go
Homepage:
Size: 36.1 KB
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

English | [简体中文](https://github.com/cevin/btcd/blob/main/README_zh.md)

# Offline Bitcoin transaction processor

Simple self-hosted Bitcoin payment support

# Usage

## Start

`./btcd -addr localhost:8000`

## Address

### Create Address

#### Usual address

`GET /address/new` `POST /address/new`

Response

```json
{
"code": 200,
"address": "18JS3qcfWmmGQiwuvWQhc19jU3ML71zAmj",
"bech32_address": "bc1q2q2de9qwewgfzwve8scxdlgw5c57e456fdtf5z",
"wif": "L2ihBrcpk2bwJnrbBd9kv6yCFymewj1oNpuDNKWYwaBFEHR9qCQZ",
"private_key_hex": "a418caa27fe90edf145de85389bc0521a9af750ff9f64a2e5815820d10755009",
"public_key_hex": "030f9849b7ba1a8e935663ab68e4fee6ac53f5ff853cf76fd8c4e921958b7bd2f9"
}
```

#### MultiSig address

```text
GET /address/new-multi-sig?public_key_hexes=031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a,02623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d6,023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f&required=2
```

```text
POST /address/new-multi-sig

# json
{
"required": 2,
"public_key_hexes": "031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a,02623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d6,023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f"
}
```

Response

```json
{
"code": 200,
"address": "34P2BVSiDrHNHmmediJzPnp3rcztKPAytS",
"script": "5221023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f2102623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d621031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a53ae",
"asm": "2 023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f 02623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d6 031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a 3 OP_CHECKMULTISIG",
"type": "multisig",
"reqSigs": 2,
"addresses": [
"1NDcMyNeyZmLRTkAiAgDUvhy9GLU7S2npd",
"1LNXg6moCRSDPvAwTEaRfSA2TxrjqJQk9J",
"1PAfPcvnwMJ8Lok14u1UYGyPawxzNZmLrv"
]
}
```

#### Parse Address

##### Compressed Hex Public Key

`GET /address/parse?public_key_hex=023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f`

```text
POST /address/parse

# json
{"public_key_hex":"023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f"}

# form
public_key_hex=023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f
```
Response

```json
{
"code": 200,
"address": "1NDcMyNeyZmLRTkAiAgDUvhy9GLU7S2npd",
"public_key_hex": "023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f"
}
```

##### WIF

`GET /address/parse?wif=L4G8o9MCkkQnL48yw1GnkQ6SzDZeDVn3GennEHHVqB4aqWjtBymJ`

```text
POST /address/parse

# json
{"wif":"L4G8o9MCkkQnL48yw1GnkQ6SzDZeDVn3GennEHHVqB4aqWjtBymJ"}

# form
wif=L4G8o9MCkkQnL48yw1GnkQ6SzDZeDVn3GennEHHVqB4aqWjtBymJ
```

Response

```json
{
"code": 200,
"address": "1NDcMyNeyZmLRTkAiAgDUvhy9GLU7S2npd",
"bech32_address": "bc1qaz7jd0lg23ppfjkme8lhdesacykln2j06aww2u",
"wif": "L4G8o9MCkkQnL48yw1GnkQ6SzDZeDVn3GennEHHVqB4aqWjtBymJ",
"private_key_hex": "d21be41dc8e073e02d7ad36ca6f13c952752a28bc81b1c1140bd323e9fb7d933",
"public_key_hex": "023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f"
}
```

##### Script (MultiSig)

```text
GET /address/parse?script=5221023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f2102623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d621031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a53ae
```

```text
POST /address/parse

# json
{
"script": "5221023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f2102623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d621031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a53ae"
}

# form
script=5221023b95f449bbe5b01e9f791a19266cc9f94d98e09488bde3afa4a75f823efd751f2102623db1f69a896b1f6bf54ab786773ce5f9385b58eb8eed58696fc7a4111d22d621031af2a6177e1179cd119657112aab53725155ee305a4199a722c8b3097782d21a53ae
```

Response

## Transaction

### Decode raw transaction

`GET /transaction/decode?tx=0100000001fe75a438b72fdc302b80cc216d66d5e3bbb0359bce3bb4cecf743f5fda1f4eb101000000fdfd000048304502210096b617a5b2bd676ee8d3f8d8d91bf60c599e16382d1e12a61a1f9562c35b2cb102204379706a55c07bb45d20336159f80ebe9786938e34b9309e49ed422e6d2a44470147304402201550a8bb0c28107098289fe6fe64488bdee46800d28bfbb0b0a1e1b2d64b9fb4022004684015095b999185b3da1a23d239452ad73b199a032f71978760f8ae42313f014c6952210265e6f7fb614a369c9230912a3bb09c33c5c5be2e1bcfc2293ecaed46708e0b5c2103f546edf7b434b50aa0115c1c82a0f9a96505d9eff55d2fe3b848c4b51c06b6432102908375f301c7ea583f7e113939eab1164abda4ac27898b1cf78abf1c82f02da953aeffffffff01f8a70000000000001976a914bd63bf79e39f4cd52361c092c3fba9264662285688ac00000000`

```text
POST /transaction/decode

# json
{
"tx":"0100000001fe75a438b72fdc302b80cc216d66d5e3bbb0359bce3bb4cecf743f5fda1f4eb101000000fdfd000048304502210096b617a5b2bd676ee8d3f8d8d91bf60c599e16382d1e12a61a1f9562c35b2cb102204379706a55c07bb45d20336159f80ebe9786938e34b9309e49ed422e6d2a44470147304402201550a8bb0c28107098289fe6fe64488bdee46800d28bfbb0b0a1e1b2d64b9fb4022004684015095b999185b3da1a23d239452ad73b199a032f71978760f8ae42313f014c6952210265e6f7fb614a369c9230912a3bb09c33c5c5be2e1bcfc2293ecaed46708e0b5c2103f546edf7b434b50aa0115c1c82a0f9a96505d9eff55d2fe3b848c4b51c06b6432102908375f301c7ea583f7e113939eab1164abda4ac27898b1cf78abf1c82f02da953aeffffffff01f8a70000000000001976a914bd63bf79e39f4cd52361c092c3fba9264662285688ac00000000"
}

# form
tx=0100000001fe75a438b72fdc302b80cc216d66d5e3bbb0359bce3bb4cecf743f5fda1f4eb101000000fdfd000048304502210096b617a5b2bd676ee8d3f8d8d91bf60c599e16382d1e12a61a1f9562c35b2cb102204379706a55c07bb45d20336159f80ebe9786938e34b9309e49ed422e6d2a44470147304402201550a8bb0c28107098289fe6fe64488bdee46800d28bfbb0b0a1e1b2d64b9fb4022004684015095b999185b3da1a23d239452ad73b199a032f71978760f8ae42313f014c6952210265e6f7fb614a369c9230912a3bb09c33c5c5be2e1bcfc2293ecaed46708e0b5c2103f546edf7b434b50aa0115c1c82a0f9a96505d9eff55d2fe3b848c4b51c06b6432102908375f301c7ea583f7e113939eab1164abda4ac27898b1cf78abf1c82f02da953aeffffffff01f8a70000000000001976a914bd63bf79e39f4cd52361c092c3fba9264662285688ac00000000
```

Response

```json
{
"code": 200,
"transaction": {
"txid": "c7d1582d4cf85fbd10732002c5bb06068d4b86cfd5cca151ef88104c6702435a",
"size": 340,
"vsize": 340,
"weight": 0,
"version": 1,
"locktime": 0,
"vin": [
{
"txid": "b14e1fda5f3f74cfceb43bce9b35b0bbe3d5666d21cc802b30dc2fb738a475fe",
"vout": 1,
"scriptSig": {
"asm": "0 304502210096b617a5b2bd676ee8d3f8d8d91bf60c599e16382d1e12a61a1f9562c35b2cb102204379706a55c07bb45d20336159f80ebe9786938e34b9309e49ed422e6d2a444701 304402201550a8bb0c28107098289fe6fe64488bdee46800d28bfbb0b0a1e1b2d64b9fb4022004684015095b999185b3da1a23d239452ad73b199a032f71978760f8ae42313f01 52210265e6f7fb614a369c9230912a3bb09c33c5c5be2e1bcfc2293ecaed46708e0b5c2103f546edf7b434b50aa0115c1c82a0f9a96505d9eff55d2fe3b848c4b51c06b6432102908375f301c7ea583f7e113939eab1164abda4ac27898b1cf78abf1c82f02da953ae",
"hex": "0048304502210096b617a5b2bd676ee8d3f8d8d91bf60c599e16382d1e12a61a1f9562c35b2cb102204379706a55c07bb45d20336159f80ebe9786938e34b9309e49ed422e6d2a44470147304402201550a8bb0c28107098289fe6fe64488bdee46800d28bfbb0b0a1e1b2d64b9fb4022004684015095b999185b3da1a23d239452ad73b199a032f71978760f8ae42313f014c6952210265e6f7fb614a369c9230912a3bb09c33c5c5be2e1bcfc2293ecaed46708e0b5c2103f546edf7b434b50aa0115c1c82a0f9a96505d9eff55d2fe3b848c4b51c06b6432102908375f301c7ea583f7e113939eab1164abda4ac27898b1cf78abf1c82f02da953ae"
},
"sequence": 4294967295
}
],
"vout": [
{
"value": 0.00043,
"n": 0,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 bd63bf79e39f4cd52361c092c3fba92646622856 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a914bd63bf79e39f4cd52361c092c3fba9264662285688ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": [
"1JGQCsBmRqksmJArpEqVKSJyao3SZuZru3"
]
}
}
]
}
}
```

### Create raw transaction

> Get unspent txs can use https://blockchain.info/unspent?active=$address

> total unspent - total send = transaction fee
>
> Or you can send the excess to your own bitcoin address and the rest as a transaction fee

```text
POST /transaction/create

# json
{
"txin": [
{
"txid": "transaction hash id",
"vout": int, # input vout
}
],
"pay_to_addresses": [
{
"address": "any bitcoin address",
"amount": int (satoshi)
}
]
}
```

Response

```json
{
"code": 200,
"raw": "unsigned hex-encoded raw transaction"
}
```

### Sign raw transaction

MultiSig transactions require multiple times signature with multiple private keys.

As long as a SegWIt transaction is included in the Inputs, then all Inputs must include the corresponding income amount of the Input.

```text
POST /transaction/sign

# json
{
"raw": "unsigned hex-encoded raw transaction",
"txin": [
{
"txid": "transaction hash id",
"wif": "WIF private key",
"redeem-script": "multisig redeem script",
"segwit": bool,
"amount": int (satoshi) (optional, when segwit transaction required)
}
]
}
```

Response

```json
{
"code": 200,
"raw": "signed hex-encoded raw transaction"
}
```

### Create and signing transaction

`POST /transaction/create-and-sign`

```text
{
"txin": [
{
"txid": "transaction hash id",
"vout": int, # input vout
"wif": "WIF private key",
"redeem-script": "multisig redeem script",
"segwit": bool,
"amount": int (satoshi) (optional, when segwit transaction required)
}
],
"pay_to_addresses": [
{
"address": "any Bitcoin address",
"amount": int (satoshi)
}
]
}
```

Response

```json
{
"code": 200,
"raw": "signed hex-encoded raw transaction"
}
```

## Broadcast transaction

Transactions that have been signed can be broadcast to the Bitcoin network through an online broadcast service.

https://coinb.in/#broadcast

https://explorer.btc.com/tools/tx/publish

---

Donate

Bitcoin: 1DMHiyzcjNzuYhWCbB4tx3wKfcvid1qgC4