10101 combines the power of a self-custodial on-chain and off-chain wallet with the vast world of trading. 10101 - a numeral palindrome and the binary representation of 21 - as in 21 million possible bitcoin. The vision of 10101 embodies what Bitcoin stands for: Decentralized and censorship resistant money.
To begin, ensure that you have a working installation of the following items:
- Docker and docker-compose
- Flutter SDK
- Rust language
- Appropriate Rust targets for cross-compiling to your device
- For Android targets:
- Install cargo-ndk
- Install Android NDK 22, then put its path in one of the
gradle.properties, e.g.:
echo "ANDROID_NDK=.." >> ~/.gradle/gradle.properties
- For iOS targets:
- XCode
- Cocoapods
You can see whether you have all the sufficient dependencies for your platform by running flutter doctor.
We encourage community contributions whether it be a bug fix or an improvement to the documentation. Please have a look at the contributing guidelines.
A lot of complexity for building the app has been encapsulated in a just-file.
You can install just with cargo install just.
To see the available commands with explanations, simply run just --list.
To install necessary project dependencies for all targets, run the following:
just depsSome crates, e.g. the coordinator use diesel for the database connection.
This may require installing dependencies, such as e.g. libpql for the postgres database for the coordinator.
On macOS, one can install libpq with the following command:
brew install libpqBear in mind that libpq is keg-only (not installed globally). This means that you have to add the library path the linker manually.
The are a number ways to do that (e.g. by setting rustflags), however the easiest one is to add the following lines to your .zshrc/.bashrc
export LDFLAGS="-L/usr/local/opt/libpq/lib"
export CPPFLAGS="-I/usr/local/opt/libpq/include"This will ensure that libpq is available during building the project
The following command will build and start all the necessary services, including the native desktop 10101 app.
just allNote: Ensure that the iOS simulator is running on your machine so it can be selected as target.
The following command will build and start all the necessary services, including the native desktop 10101 app.
just all-iosNote: Ensure that the Android simulator is running on your machine so it can be selected as target.
Also ensure that you have run just deps-android to install the right targets for build.
The following command will build and start all the necessary services, including the android app.
just all-androidThe app currently works only on regtest, which means that the wallet needs to be fauceted with the provided steps before you can start trading.
-
If you have run the app before, we recommend to clear the dev environment by running
just wipe -
Start the complete project stack with
just all.
-
Create an invoice in your 10101 app by navigating to the receive screen.
-
Click on the "pay the invoice with 10101 faucet" button.
- Follow coordinator's logs -
tail -f data/coordinator/regtest.log - Block explorer - http://localhost:8080/
- Lightning & Bitcoin faucet - http://localhost:8080/faucet/
- Manually open a lightning channel - http://localhost:8080/channel/
- Create a
./mobile/android/key.propertieswith the content from the key generation step from here https://docs.flutter.dev/deployment/android#signing-the-app just cleannever hurts but might not be necessary ;)just genjust android-releaseNETWORK=regtest just build-android-app-bundleNETWORK=regtest just upload-app-bundle
TL;DR; a shortcut for this is available but it is recommended to execute each step separately:
just release-app-bundle-regtest