mock-chronik-client

Mock Chronik client for unit testing.

npm: mock-chronik-client

Usage

import { MockChronikClient } from 'mock-chronik-client';

const mockChronik = new MockChronikClient();

mockChronik.setChronikInfo({ version: '1.0.0' });
mockChronik.setBlockchainInfo({ tipHeight: 800000 });

// Set UTXO
mockChronik.setUtxosByAddress(address, [{
  outpoint: { txid: '0'.repeat(64), outIdx: 0 },
  sats: 1000000n,
  script: new Uint8Array([118, 169, 20, ...]),
  blockHeight: 799000,
}]);

// Query
const utxos = await mockChronik.address(address).utxos();

Mock Errors

mockChronik.setTx(txid, new Error('Not found'));

try {
  await mockChronik.tx(txid);
} catch (e) {
  console.log(e.message); // 'Not found'
}

API Reference

Method	Description
setChronikInfo(info)	Set Chronik version
setBlockchainInfo(info)	Set blockchain state
setTx(txid, tx)	Set transaction or error
setUtxosByAddress(addr, utxos)	Set address UTXOs
setToken(tokenId, token)	Set Token info

Best Practices

beforeEach(() => {
  mockChronik = new MockChronikClient();
  mockChronik.setChronikInfo({ version: '1.0.0' });
  mockChronik.setBlockchainInfo({ tipHeight: 800000 });
});

afterEach(() => {
  mockChronik = null;
});