unspent/README.md

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

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