Skip to content

A Simple Bitcoin wallet for everyday transactions and secure self-custody

License

Notifications You must be signed in to change notification settings

NummusBTC/nummus-wallet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nummus Wallet

Discord Twitch Status YouTube Channel Twitter Follow License Build Status GitHub issues GitHub stars

Nummus is a non-custodial Bitcoin wallet focused on providing users with full control over their Bitcoin transactions on the base layer. Our primary goal is to create a secure, user-friendly, and fully non-custodial wallet for managing Bitcoin.

Features

  • Bitcoin transaction management
  • Secure non-custodial architecture
  • Real-time price tracking
  • Secure wallet creation and backup
  • Transaction history
  • QR code sending and receiving
  • Fee estimation
  • Biometric authentication

Tech Stack

Nummus is built using the following technologies:

  • React Native - Cross-platform mobile app framework
  • Expo - React Native development platform
  • TypeScript - Statically typed JavaScript
  • NativeWind/Tailwind CSS - Utility-first CSS framework
  • Gluestack UI - UI component library
  • Supabase - Backend as a service platform
  • Mempool.space API - Bitcoin mempool data and fee estimation
  • Bitcoin Development Kit (BDK) - For Bitcoin wallet functionality
  • Secure storage - For sensitive wallet data
  • Jest - Testing framework

Getting Started

Prerequisites

  • Node.js (v16 or later)
  • npm or yarn
  • Expo CLI

Installation

  1. Clone the repository:
git clone https://github.com/nummusBtc/nummus-wallet.git
cd nummus-wallet
  1. Install dependencies:
npm install
  1. Start the development server:
npm start

Usage

[Include basic usage instructions here]

Testing

Our project uses Jest as the testing framework. You can run tests using the following commands:

# Run tests in watch mode (default)
npm test

# or with yarn
yarn test

The test files are located in the /tests directory and use the .test.tsx extension. We utilize the following testing tools:

  • Jest with jest-expo preset
  • @testing-library/react-native for component testing
  • @testing-library/react-hooks for testing hooks

When adding new features, please ensure you include appropriate tests to maintain code quality.

Contributing

We welcome contributions to Nummus Wallet! Please read our contribution guidelines before submitting a pull request.

Contact