# bitcore-client

> Wallet client for Bitcore node

Latest version **10.10.15** (published 2025-09-03) · 0 weekly downloads

## Install

```sh
npm install bitcore-client
pnpm add bitcore-client
yarn add bitcore-client
bun add bitcore-client
```

Provides the command `bitcore-client`.

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 10.10.15 |
| Published | 2025-09-03 |
| First published | 2019-02-27 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 17 |
| Unpacked size | 395.5 KB |
| Known vulnerabilities | 0 (+3 in 3 direct dependencies) |
| Install scripts | no |
| Author | Justin Langston |
| Maintainers | gasteve, nitsujlangston, unusualbob |

## Links

- npm: https://www.npmjs.com/package/bitcore-client
- npm.io page: https://npm.io/package/bitcore-client

## Dependencies (17)

- [async](https://npm.io/package/async.md) 2.5.0
- [bcrypt](https://npm.io/package/bcrypt.md) 5.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) 0.5.1
- [levelup](https://npm.io/package/levelup.md) 4.3.2
- [mongodb](https://npm.io/package/mongodb.md) ^3.6.0
- [request](https://npm.io/package/request.md) 2.87.0
- [level-js](https://npm.io/package/level-js.md) 4.0.2
- [progress](https://npm.io/package/progress.md) 2.0.0
- [promptly](https://npm.io/package/promptly.md) 3.0.3
- [commander](https://npm.io/package/commander.md) 11.1.0
- [leveldown](https://npm.io/package/leveldown.md) 6.1.1
- [secp256k1](https://npm.io/package/secp256k1.md) 3.7.1
- [JSONStream](https://npm.io/package/JSONStream.md) ~1.3.1
- [bitcore-mnemonic](https://npm.io/package/bitcore-mnemonic.md) ^10.10.7
- [crypto-wallet-core](https://npm.io/package/crypto-wallet-core.md) ^10.10.15
- [source-map-support](https://npm.io/package/source-map-support.md) 0.5.13
- [request-promise-native](https://npm.io/package/request-promise-native.md) 1.0.5

## Recent versions

- 10.10.15 (latest) — 2025-09-03
- 11.5.2 (beta) — 2026-02-05
- 11.5.1 — 2026-01-28
- 11.5.0 — 2026-01-23
- 11.4.7 — 2026-01-06
- 11.4.5 — 2025-12-04
- 11.4.1 — 2025-11-18
- 11.4.0 — 2025-10-30
- 11.3.7 — 2025-10-23
- 11.3.6 — 2025-10-10
- 11.3.3 — 2025-10-02
- 11.3.2 — 2025-09-10
- 11.3.1 — 2025-09-03
- 10.10.14 — 2025-08-26
- 11.2.4 — 2025-08-24
- … 136 more at https://npm.io/package/bitcore-client/versions

## README

# Bitcore Client

**A helper to create a wallet using the bitcore-v8 infrastructure.**

## Purpose

This repo should allow you to create a wallet using the bitcore-v8 infrastructure.

Currently we have the following features

- Wallet Creation
- Importing Addresses to the Wallet
- View Only
- Send Enabled by including the privKey
- Instant balance checking
- Transaction Creation
- Transaction Signing
- Transaction Broadcasting
- Multi-Sig address derive/importing

## Commands

### Wallet Create

No baseUrl flag will automatically create a wallet that points to https://api.bitcore.io/api.

```sh
./wallet-create --name TestWalletBTC --chain BTC --network mainnet
```

To create a wallet to point to local bitcore-node.

```sh
./wallet-create --name myregtestwallet --chain BCH --network regtest --baseUrl http://localhost:3000/api
```

### Register an Existing Wallet

Register an existing wallet to point to custom Bitcore API url.

```sh
./wallet-register --name myregtestwallet --baseUrl https://api.bitcore.io/api
```

Or a local Bitcore-node

```sh
./wallet-register --name myregtestwallet --baseUrl http://localhost:3000/api
```

### Wallet Address Import

You can import a jsonl file. privKey and pubKey are optional.
If you provide privKey, pubKey must be provided as well.

```sh
//~/Desktop/export.jsonl
{"address": "mXy1234", privKey: "xxxxxxx", pubKey: "yyyyyyyy"}
{"address": "mXy1234", privKey: "xxxxxxx", pubKey: "yyyyyyyy"}
{"address": "mXy1234", privKey: "xxxxxxx", pubKey: "yyyyyyyy"}
```

```sh
./wallet-import --name TestWalletBTC --file ~/Desktop/export.jsonl
```

You can also import an address in json format in the command line.

```sh
./wallet-import --name myregtestwallet --parse '[{"address":"mXy1234"}]'
```

### Balance Checking

```sh
./wallet-balance --name TestWalletBTC
```

### Balance Checking at Specific Date or Time

```sh
./wallet-balance --name TestWalletBTC --time 01-15-2019
```

Valid types of time (no slash marks allowed):

```sh
1-14-2019
"Wed Jan 16 2019 13:34:20 GMT-0500 (Eastern Standard Time)"
"2019-01-16T18:47:33.396Z"
```

### Wallet UTXOS

```sh
./bin/wallet-utxos --name TestWalletBTC
```

### Transaction Creation

```sh
./bin/wallet-tx --addresses '[{"address": "moVf5Rf1r4Dn3URQHumEzvq3vtrFbaRvNr", "satoshis": 2500000000}]' --fee 100 --utxos '[{"txid":"28321f501ce47db1fd40d9ad461624bf9fe6cb581ac0177d17304ff128b86d61","vout":0,"address":"mhwfzHhBdpUKLTzGkUEUpJWa3ipTYZHjF8","script":"21033a3c1aa3fb35e07fe7ff44423c8d378c2d4610ffac8b08c4e6747d7573566937ac","value":5000000000}]' --change "mz21R16FYXfA6G4EJdCrTsduvX9BHHecvv" --name TestWalletBTC --amount 2500000000
```

### Transaction Signing

```sh
./bin/wallet-sign --name TestWalletBTC --tx 0100000001616db828f14f30177d17c01a58cbe69fbf241646add940fdb17de41c501f32280000000000ffffffff0200f90295000000001976a914578237b9848cc709ced0e098417e0494415add1488ac9cf80295000000001976a914caf0ee682de3daa9b3640da1f6d47cc04ce2c99e88ac00000000
```

### Transaction Broadcast

```sh
./bin/wallet-broadcast --name TestWalletBTC --tx 0100000001616db828f14f30177d17c01a58cbe69fbf241646add940fdb17de41c501f32280000000048473044022052cf595274c422c37d140989c8cc31c95b39d326b5eac8d4feb8bcceebdebc3f02205635c798c24ae1d44d0871e6938dbfd76293e695131d890838654816f28b942401ffffffff0200f90295000000001976a914578237b9848cc709ced0e098417e0494415add1488ac9cf80295000000001976a914caf0ee682de3daa9b3640da1f6d47cc04ce2c99e88ac00000000
```

### Paypro Payment

```sh
./bin/wallet-paypro --name TestWalletBTC --payProUri 'https://bitpay.com/i/Dd8q13AnnVyYM7pcMBHfv'
```

## Contributing

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/Contributing.md) on the main bitcore repo for information about how to contribute.

## License

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Copyright 2013-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.

---
_Source: https://npm.io/package/bitcore-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._