Nami Wallet Documentation

To develop Nami locally, ensure you have Node.js 20 installed. You must configure your own Blockfrost project IDs to interact with the blockchain.

1. Configure Secrets

Do not commit your keys to the repository. Copy the testing secrets template to your development or production file:

cp secrets.testing.js secrets.development.js

Then, edit ./src/config/provider.js and replace the following keys with your Blockfrost project IDs:

• secrets.PROJECT_ID_MAINNET
• secrets.PROJECT_ID_TESTNET
• secrets.PROJECT_ID_PREVIEW
• secrets.PROJECT_ID_PREPROD

2. Run Commands

Start development server:

npm start

Create production build:

npm run build

Run tests:

npm test

# Update secrets file with your own keys
cp secrets.testing.js secrets.development.js
npm start

To use Nami for testing purposes, you can install it as an unpacked extension in Chrome:

1. Download and extract the zip file from the latest Nami Release.
2. Open Chrome and navigate to chrome://extensions.
3. Enable Developer mode (usually a toggle in the top right).
4. Click Load unpacked at the top left.
5. Select the extracted build folder.

COSE messages distinguish between protected and unprotected headers using the Headers structure.

• ProtectedHeaderMap: Contains headers that are part of the signed data and must be protected.
• HeaderMap: Contains unprotected headers.
• Headers: A container holding both a ProtectedHeaderMap and an unprotected HeaderMap.

Use Headers.protected() to access the protected map and Headers.unprotected() to access the unprotected map.

The library provides several structures for representing signed data:

• COSESignature: A single signature with associated Headers.
• COSESignatures: A collection of COSESignature objects.
• CounterSignature: A wrapper for COSESignatures used in counter-signatures.
• COSESign1: A signature format that includes an optional payload.
• COSESign: A signature format that includes a payload and multiple signatures.
• SignedMessage: A top-level wrapper that can hold either a COSESign or a COSESign1 message.

Nami provides several experimental endpoints available under the api.experimental namespace to extend standard CIP-0030 functionality.

##### api.experimental.getCollateral()

cardano.getCollateral() : [TransactionUnspentOutput]

##### api.experimental.on(eventName, callback)
Register events coming from Nami. Available events are:
- `accountChange`: `((addresses : [BaseAddress]) => void)`
- `networkChange`: `((network : number) => void)`

##### api.experimental.off(eventName, callback)
Deregister the events (works also with anonymous functions).

Obtain a Blaze provider instance, which integrates Blockfrost and a WebWallet for interacting with the Cardano blockchain.

Returns: A Blaze instance configured for the current Nami network.

const blaze = await getBlazeProvider();
// Use blaze to interact with the blockchain

The API provides several ways to fetch balance information and Unspent Transaction Outputs (UTXOs) via Blockfrost.

// Get the current account's balance as a Cardano Value object
const balance = await getBalance();

// Get extended balance information
const extendedBalance = await getBalanceExtended();

// Get all UTXOs for the current account
const utxos = await getUtxos();

// Get UTXOs with pagination and a minimum amount filter
const filteredUtxos = await getUtxos('HEX_CBOR_AMOUNT', { page: 0, limit: 20 });

Query the blockchain for transaction details, metadata, UTXOs associated with a transaction, or specific blocks.

// Get a list of recent transactions
const txs = await getTransactions(1, 10);

// Get detailed info for a specific transaction hash
const txInfo = await getTxInfo('TX_HASH');

// Get UTXOs for a specific transaction
const utxos = await getTxUTxOs('TX_HASH');

// Get metadata for a transaction
const metadata = await getTxMetadata('TX_HASH');

// Get a block by hash or number
const block = await getBlock('BLOCK_HASH_OR_NUMBER');

Use checkLaceInstallation to verify if the Lace extension is installed and responsive by attempting to send a message to the Lace extension ID.

const isLaceInstalled = await checkLaceInstallation();