Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/satsigner/satsigner/llms.txt

Use this file to discover all available pages before exploring further.

Overview

SatSigner is a privacy-first Bitcoin signer available for iOS and Android devices. This guide will walk you through installing the app on your mobile device.
SatSigner is currently in active development (v0.2.0). While functional, the app may contain bugs or incomplete features. Always test with small amounts first.

System Requirements

iOS

  • iOS 13.0 or later
  • Compatible with iPhone and iPad
  • NFC capability (for NFC-based signing features)

Android

  • Android 10 (API level 29) or later
  • NFC support (for NFC-based signing features)
  • Minimum 2GB RAM recommended

Installation Methods

SatSigner is currently available as a development build. Follow these steps to build and install:
1

Install Prerequisites

Ensure you have Node.js v22.4.0 or higher installed:
node --version
Install Yarn package manager:
npm install --global yarn
2

Clone Repository

Clone the SatSigner repository:
git clone https://github.com/satsigner/satsigner.git
cd satsigner
3

Install Dependencies

Install all project dependencies:
yarn install
4

Navigate to Mobile App

Change to the mobile app directory:
cd apps/mobile
5

Build and Install

For Android:
yarn android
For iOS:
yarn ios
This will build the app and install it on your connected device or emulator.

Verification

After installation, verify SatSigner is working correctly:
1

Launch the App

Tap the SatSigner icon on your device to launch the application.
2

Check Version

Navigate to Settings → About to verify you’re running version 0.2.0 or higher.
3

Grant Permissions

SatSigner will request necessary permissions:
  • Camera: For scanning QR codes
  • NFC: For NFC-based signing (if available on your device)
Grant these permissions to enable full functionality.

Troubleshooting

App Won’t Install

If installing a development build, ensure USB debugging is enabled:
  1. Go to Settings → About Phone
  2. Tap Build Number 7 times to enable Developer Options
  3. Go to Settings → Developer Options
  4. Enable USB Debugging
For development builds, you may need to trust the developer certificate:
  1. Go to Settings → General → VPN & Device Management
  2. Tap your developer certificate
  3. Tap Trust
If you encounter build errors:
# Clear cache and reinstall
cd apps/mobile
rm -rf node_modules
cd ../..
yarn install
cd apps/mobile
yarn android  # or yarn ios

Permission Issues

If SatSigner cannot access camera or NFC:
  • iOS: Go to Settings → SatSigner and enable required permissions
  • Android: Go to Settings → Apps → SatSigner → Permissions and grant necessary permissions

Next Steps

Now that you have SatSigner installed:

Initial Setup

Configure your security settings and network preferences

Create Your First Wallet

Set up your first Bitcoin wallet with SatSigner

Community Support

Need help with installation?