@cashu/cashu-ts NPM

Cashu TS

GitHub Workflow Status GitHub issues GitHub package.json version npm npm type definitions npm bundle size code coverage

⚠️ Don't be reckless: This project is in early development, it does however work with real sats! Always use amounts you don't mind losing.

Cashu TS is a JavaScript library for Cashu wallets written in Typescript.

Wallet Features:

connect to mint (load keys)
request minting tokens
minting tokens
sending tokens (get encoded token for chosen value)
receiving tokens
melting tokens
check if tokens are spent
...

Implemented NUTs:

Supported token formats:

v1 read
v2 read (deprecated)
v3 read/write

Usage

Go to the docs for detailed usage, or have a look at the integration tests for examples on how to implement a wallet.

Install

npm i @cashu/cashu-ts

Example

import { CashuMint, CashuWallet, getEncodedToken } from '@cashu/cashu-ts';

const mint = new CashuMint(mintUrl);
const wallet = new CashuWallet(mint);
const request = await wallet.getMintQuote(64);
const tokens = await wallet.mintTokens(64, request.quote);