Skip to content
linky-fitPublic

About

Bitcoin wallet and messaging app in one. Build your bitcoin network!

Resources

Contributing

Stars

26 stars

Watchers

2 watching

Forks

Repository files navigation

Linky

A Bun monorepo for local-first Bitcoin apps on Nostr, Cashu and Evolu: the Linky and Fazole apps, their websites and services, and the TypeScript packages they share. Data lives in Evolu (SQLite) on the device and syncs between devices through an Evolu relay; Users talk to each other using Nostr. Wallets talk to Cashu mints directly. Some packages publish to npm for anyone to use.

Linky

Linky release app.linky.fit linky.fit push.linky.fit

Linky

A mobile-first PWA for contacts, private Nostr messaging and Lightning/Cashu payments. It runs in the browser, on Android and as a macOS desktop app.

Download Linky!

Public sites

Code

Fazole

Fazole release app.fazole.fit fazole.fit

Fazole

A payment terminal PWA for Czech merchants: bank transfers (SPD QR), Lightning and Cashu. It runs on Linky's packages and shares Linky accounts, but ships on its own version and release.

Public sites

Code

docs/releases.md covers how each Linky and Fazole target ships.

Published packages

npm release

We also publish npm packages, to make it easier for other developers to work with tools we use. Those packages are in very early stage of it's development so please, use with caution. The three libraries share one SemVer version and publish together; see docs/npm-releases.md.

  • @linky-fit/linkstr packages/linkstr: typed Nostr messaging, profiles and relay services, built on Effect
  • @linky-fit/linkshu packages/linkshu: typed Cashu wallet services with pluggable storage, built on Effect
  • @linky-fit/linkauth packages/linkauth: log in with a Nostr key, with origin-bound assertions for servers and browsers

Internal packages

Tools: apps/linkshu-cli (terminal Cashu wallet), tools/nostr-error-tracker (error dashboard), docker/evolu-relay (relay image and per-owner quota).

Development

Requirements: Bun and Docker (local Nostr relay, Evolu relay, FakeWallet Cashu mint and npubcash-server). Android builds need Java 17.

bun install
bun run dev           # Docker stack, Linky app on :5173, push service on :8787
bun run fazole:dev    # Fazole app on :5280; needs the Docker stack `bun run dev` starts
bun run onchain-operator:dev  # on-chain operator console on :5295; also needs `bun run bitcoin:up`
bun run test          # unit tests in every workspace
bun run check-code    # typecheck, eslint --fix, prettier --write
bun run test-changed  # unit tests in the workspaces this branch reaches
bun run check-changed # check-code in the workspaces this branch reaches

The stack's npubcash-server (upstream v3, the commit npub.linky.fit runs) serves the hosted lightning address on http://localhost:3400. The FakeWallet mint settles every invoice, so asking it for one pays the address: curl "$(curl -s localhost:3400/.well-known/lnurlp/<npub> | jq -r .callback)?amount=21000". The v1 compatibility service does not run locally.

Bitcoin regtest for on-chain transfers (Docker profile bitcoin, not started by bun run dev or the e2e stack): bitcoind RPC on localhost:18443 (linky/linky), Esplora API on http://localhost:3002, block explorer on http://localhost:3003.

bun run bitcoin:up                            # start bitcoind, electrs and the explorer
bun run bitcoin -- init                       # create the funded `dev` wallet (101 blocks)
bun run bitcoin -- send <address> <btc>       # pay from `dev`, prints the txid
bun run bitcoin -- mine <n> [address]         # mine blocks, waits until Esplora indexed them
bun run bitcoin -- balance                    # also: newaddress [type], cli <bitcoin-cli args...>
bun run bitcoin -- import-descriptor <wallet> <descriptor>  # e.g. the dev operator's BIP86 tprv
bun run bitcoin:down                          # stop it; chain and wallets stay in Docker volumes

End-to-end tests (Playwright against a Docker stack owned by the checkout, so worktrees can run them side by side):

bun run e2e          # linky-app suite; extra args go to Playwright
bun run e2e site     # linky-site suite
bun run e2e down     # stop the stack and drop its data

AGENTS.md lists the invariants and conventions; GLOSSARY.md defines the domain terms.

Contributing

See CONTRIBUTING.md.

License

Zero-Clause BSD (0BSD), see LICENSE.

About

Bitcoin wallet and messaging app in one. Build your bitcoin network!

Resources

Contributing

Stars

26 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages