Coco Cashu Docs

Appearance

Start using Coco ​

Coco is a TypeScript library that simplifies the development of Cashu applications. It provides a unified, platform-agnostic API for creating Cashu wallets, allowing you to focus on building across browsers, Node.js, and React Native.

Initialization ​

To get started all you got to do is create a Coco Manager instance. This instance will be your entry-point to your Coco Cashu wallet.

ts
import { initializeCoco } from 'coco-cashu-core';

const coco = await initializeCoco({ repo, seedGetter });

// After initialization you can start to use your coco wallet
const balances = await coco.wallet.getBalances();

BIP-39 Seed ​

In order to work properly coco requires you to supply a BIP39 conforming seed. Coco will never persist that seed, so you need to supply it via a seedGetter function. This function is expected to be passed when instantiating coco and will be called automatically when coco needs the key to derive new secrets from it

ts
import { initializeCoco } from 'coco-cashu-core';

async function seedGetter(): Uint8Array {
  // add your implementation here
  // e.g. reading a mnemonic from SecureStorage and converting it to a BIP-39 seed
}

const coco = await initializeCoco({ seedGetter });

// Before receiving tokens, you need to add and trust the mint
await coco.mint.addMint('https://mint.url', { trusted: true });

// Coco will now use the seed to derive deterministic secrets when required.
await coco.wallet.receive('cashuB...');

Note: Wallet operations like receiving tokens require the mint to be explicitly trusted. See Adding a Mint for more details.

Setting up persistence ​

By default coco uses an in-memory store that will be lost as soon as the process finishes. As that is undesirable in most cases, coco comes with a range of Storage Adapters to attach it to a database of your choice.

ts
import { initializeCoco } from 'coco-cashu-core';
import { IndexedDbRespositories } from 'coco-cashu-indexeddb';

const repo = new IndexedDbRepositories({ name: 'coco' });
const coco = await initializeCoco({
  repo,
});

// Add and trust a mint before performing wallet operations
await coco.mint.addMint('https://mint.url', { trusted: true });

// Whenever coco now saves data it will use the provided database
await coco.wallet.receive('cashuB...');

Configuring Coco ​

Coco can be configured in various ways to fit different environments. When calling initializeCoco with only the required options sane defaults will be applies. When you want to further configure Coco check out Coco Config.