# unspent

> A command line utility for Unspent Phi (₿∙ϕ) contracts

Latest version **0.2.19** (published 2025-02-12) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install unspent
pnpm add unspent
yarn add unspent
bun add unspent
```

Provides the command `unspent`.

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.19 |
| Published | 2025-02-12 |
| First published | 2022-11-22 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 7 |
| Unpacked size | 69.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | - |
| Maintainers | 2qx |
| Keywords | bitcoin, bitcoin cash, bch, tBCH, cashscript, testnet, perpetuity, unspent |

## Links

- npm: https://www.npmjs.com/package/unspent
- Repository: https://github.com/2qx/unspent
- Homepage: https://github.com/2qx/unspent#readme
- Issues: https://github.com/2qx/unspent/issues
- npm.io page: https://npm.io/package/unspent

## Dependencies (7)

- [clipanion](https://npm.io/package/clipanion.md) ^3.2.0-rc.11
- [get-stream](https://npm.io/package/get-stream.md) ^5.1.0
- [typescript](https://npm.io/package/typescript.md) ^5.7.3
- [@types/node](https://npm.io/package/@types/node.md) ^10.8.0
- [@unspent/phi](https://npm.io/package/@unspent/phi.md) 0.2.19
- [@unspent/psi](https://npm.io/package/@unspent/psi.md) 0.2.19
- [fake-indexeddb](https://npm.io/package/fake-indexeddb.md) 4.0.1

## Recent versions

- 0.2.19 (latest) — 2025-02-12
- 0.2.18 — 2025-02-12
- 0.2.17 — 2025-02-11
- 0.2.16 — 2025-02-11
- 0.2.15 — 2025-02-11
- 0.2.14 — 2025-02-11
- 0.2.13 — 2025-02-06
- 0.2.12 — 2025-02-03
- 0.2.11 — 2025-02-02
- 0.2.10 — 2025-01-17
- 0.2.6 — 2023-10-12
- 0.2.5 — 2023-10-04
- 0.2.4 — 2023-10-04
- 0.2.3 — 2023-09-26
- 0.2.0 — 2023-08-23
- … 9 more at https://npm.io/package/unspent/versions

## README

A utility for calling unspent contracts via the command line.

# Usage

With a node 23 environment:

    npm i unspent
    unspent -h

---

━━━ @unspent/cli ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

$ unspent <command>

━━━ Beneficiary ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

unspent annuity [--testnet] [--regtest] [--fee #0] [--deposit] <--address #0> [--period #0] [--allowance #0] <--installment #0> [--exAddress #0]
Regular payments over time

unspent divide [--testnet] [--regtest] [--fee #0] [--allowance #0] <--addresses #0> [--exAddress #0]
Divide money into equal payments, up to four addresses

unspent perpetuity [--testnet] [--regtest] [--fee #0] [--deposit] <--address #0> [--period #0] [--allowance #0] [--decay #0] [--exAddress #0]
Pay a fixed fraction of total value at intervals.

━━━ Distributive ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

unspent faucet [--testnet] [--regtest] [--fee #0] [--address #0] [--period #0] [--payout #0] [--index #0]
Distributes some free bitcoin per period

unspent mine [--testnet] [--regtest] [--fee #0] [--deposit] [--period #0] [--payout #0] [--difficulty #0] [--canary #0] <--exAddress #0>
Distributes some bitcoin per period, for proof of work

━━━ Informational ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

unspent query [--testnet] [--regtest] <--chaingraph #0> [--prefix #0]
Query a list of contracts.

unspent record [--testnet] [--regtest] [--fee #0] [--maxFee #0] [--index #0] [--contract #0]
Broadcast a contract to the blockchain

You can also print more details about any of these commands by calling them with

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