|
1 | | -<p align="center"> |
2 | | - <a href="https://github.com/synonymdev/bitkit" title="Bitkit"> |
3 | | - <img alt="bitkit" src="./src/assets/bitkit_logo_readme.png" width="150"></img> |
4 | | - </a> |
5 | | -</p> |
| 1 | +# Bitkit |
6 | 2 |
|
7 | | -<h3 align="center">Bitkit</h3> |
| 3 | +https://github.com/synonymdev/bitkit/assets/5798170/99807c8a-2cb8-41f5-810f-6146e633e95b |
8 | 4 |
|
9 | | ---- |
10 | | - |
11 | | -**⚠️ Beta software may put your money at risk.** |
| 5 | +**⚠️ Beta software that may put your money at risk.** |
12 | 6 |
|
13 | 7 | **⚠️ We recommend using only small amounts.** |
14 | 8 |
|
|
18 | 12 |
|
19 | 13 | [⬇ iPhone - Download latest TestFlight app](https://testflight.apple.com/join/lGXhnwcC) |
20 | 14 |
|
21 | | ---- |
22 | 15 |
|
23 | 16 | ## Overview |
24 | 17 |
|
25 | | -Bitkit enables users to reclaim their digital life. |
| 18 | +Reclaim your digital life with Bitkit. |
| 19 | + |
| 20 | +Bitkit offers on-chain and lightning transactions, as well as user-controlled social profiles and contacts; easy payments to contacts; key-based log-ins; and data streaming from private and public feeds into widgets. All these latter features have been built using [Slashtags](https://slashtags.to/). |
26 | 21 |
|
27 | | -Bitkit puts users in control of their money and payments, social profile, contacts, and payment preferences; allows users to authenticate to servers with just a tap; and allows users to stream data from public feeds and web accounts, all within one application. What Bitcoin has done for money and payments, Bitkit also extends to other areas of digital life. |
| 22 | +Synonym's mission is for users to have control over their own data and operate in a Web that is censorship-resistant, private, and free from walled gardens. Bitkit is Synonym’s crack at harmonizing such digital autonomy with a great user experience. |
28 | 23 |
|
29 | 24 | Bitkit is a mobile application available on Android and iOS, and implemented using React-Native. |
30 | 25 |
|
31 | 26 | ## The problem |
32 | 27 |
|
33 | | -Society, the economy, and the Web have been overcome by oppressive central controls, resulting in censorship, privacy breaches, and monopoly behaviors that stifle the marketplace of goods and ideas. Users need P2P tools that set them free. |
| 28 | +Society, the economy, and the Web suffer from oppressive central controls, resulting in censorship, privacy breaches, and monopoly behaviors. Users need P2P tools that set them free. |
34 | 29 |
|
35 | 30 | ## Bitkit's solution |
36 | 31 |
|
37 | | -Bitkit offers a Bitcoin wallet that supports both on-chain and lightning transactions. The application runs a custom, non-routing Lightning node created with the [Lightning Development Kit](https://github.com/lightningdevkit) on the user's mobile phone. It requires a connection to an external server running a Bitcoin full node and an Electrum server. |
38 | | - |
39 | | -We automatically on-board users to Lightning through the integration of our lightning service provider (LSP) [Blocktank](https://github.com/synonymdev/blocktank-client). Developers can also create their own LSP using Blocktank. In the future, we will support users to connect to their own Lightning and Bitcoin nodes, select different types of LSPs, couple hardware wallets, and manage their own Lightning channels. |
40 | | - |
41 | | -Users can back up all their on-chain Bitcoin data with a standard BIP-39 seed. Lightning channel data should automatically be stored on a backup server. The data needs to be encrypted on the client-side before it is sent to a server to ensure privacy. You can view our code [here](https://github.com/synonymdev/bitkit-backup-client). |
| 32 | +Bitkit offers a Bitcoin wallet that supports both on-chain and lightning transactions. The application runs a custom, non-routing Lightning node created with the [Lightning Development Kit](https://github.com/lightningdevkit) on the user's mobile phone. By default you connect to Synonym's Electrum-Bitcoin Core server, but you can also connect to your own server. We on-board users to Lightning through our lightning service provider (LSP) [Blocktank](https://github.com/synonymdev/blocktank-client). In the future, we will also enable connections to other LSPs and peers on the network. |
42 | 33 |
|
43 | | -The other main features Bitkit supports are the creation of social profiles; the importing and managing of contacts; dynamic payment profiles; key-based account logins; and the display of public data feeds and private account data through in-application widgets. You can experiment with these features in our [playground](https://slashtags.to/#playground). We currently support three public data widgets: a bitcoin [price feed](https://github.com/synonymdev/slashtags-widget-price-feed), a bitcoin [news feed](https://github.com/synonymdev/slashtags-widget-news-feed), a bitcoin [block data feed](https://github.com/synonymdev/slashtags-widget-bitcoin-feed). |
| 34 | +Users can back up their Bitcoin and Lightning keys with a standard BIP-39 seed and optional password. Lightning channel data is automatically replicated on our a backup server. The data is encrypted on the client-side before it is sent to our server to ensure privacy. You can view our code [here](https://github.com/synonymdev/bitkit-backup-client). |
44 | 35 |
|
45 | | -All these additional features are powered by Slashtags: an open-source protocol for creating secure and scalable peer-to-peer applications. You can view our JavaScript-based software development kit which has been used for the Bitkit wallet [here](https://github.com/synonymdev/slashtags). |
| 36 | +The other main features Bitkit supports are as follows: |
46 | 37 |
|
47 | | -The Slashtags protocol allows for the creation of cryptographic keypairs, known as "slashtags", derived from the same BIP-39 seed as the user's Bitcoin wallet. Typically these slashtags are associated with networked “drives” known as hyperdrives, which can be discovered, read, and seeded by peers on a network. The group of peers that stores some or all of the drive’s data is known as its swarm. |
| 38 | +* 📱 Social profiles and contacts |
| 39 | +* 💸 Easy payments to profiles |
| 40 | +* 🔑 Key-based account logins |
| 41 | +* 📊 Streaming of private and public data feeds into widgets |
48 | 42 |
|
49 | | -While much of the power of Slashtags comes via these hyperdrives, the keypairs that can be generated with Slashtags also can have important utility on their own. Bi-lateral, peer to peer authentication between a user and a server can, for example, be realized just on the basis of keypairs. |
| 43 | +All these additional features are powered by Slashtags: a collection of software modules and specifications that complements the Bitcoin and Lightning stacks in the building of peer-to-peer applications, specifically to enable decentralized identities and web-of-trust reputation systems. You can view our JavaScript-based software development kit which has been used for the Bitkit wallet [here](https://github.com/synonymdev/slashtags). |
50 | 44 |
|
51 | | -All Slashtags data is exchanged within a Kademlia-based distributed hash table system. |
| 45 | +You can experiment with Bitkit's Slashtags features in our [playground](https://slashtags.to/#playground). We currently support four public data widgets: |
52 | 46 |
|
53 | | -You can read more about Slashtags on our [website](https://slashtags.to/) and on our SDK's [Github page](https://github.com/synonymdev/slashtags). Slashtags predominantly builds on the lower-level functionality of the Hypercore stack. You can learn more about the Hypercore stack [here](https://docs.holepunch.to/) as well as from the two main Github projects [here](https://github.com/holepunchto/hypercore) and [here](https://github.com/holepunchto/hyperdht). |
| 47 | +* 📈 [Bitcoin Price Feed](https://github.com/synonymdev/slashtags-widget-price-feed) - [📲 Add to your phone](https://slashtags.to/playground/price) |
| 48 | +* 📰 [Bitcoin News Feed](https://github.com/synonymdev/slashtags-widget-news-feed) - [📲 Add to your phone](https://slashtags.to/playground/headlines) |
| 49 | +* 📊 [Bitcoin Block Feed](https://github.com/synonymdev/slashtags-widget-bitcoin-feed) - [📲 Add to your phone](https://slashtags.to/playground/blocks) |
| 50 | +* 📚 [Bitcoin Facts Feed](https://github.com/synonymdev/slashtags-widget-facts-feed) - [📲 Add to your phone](https://slashtags.to/playground/facts) |
54 | 51 |
|
55 | | -Slashtags user data should be automatically replicated via a [seeding server](https://github.com/synonymdev/slashtag-seeding-server). In this way, user data is always available. In addition, it allows the user to restore all their Slashtags data from just their BIP-39 seed. |
| 52 | +Slashtags user data is automatically replicated via our [seeding server](https://github.com/synonymdev/slashtag-seeding-server). In this way, user data is always available. In addition, it allows the user to restore all their Slashtags data from just their BIP-39 seed and optional password. |
56 | 53 |
|
57 | 54 | ## Support |
58 | 55 |
|
59 | | -If you are experiencing any problems with Bitkit, please open an issue and use the template provided, or reach out to us on [telegram](https://t.me/bitkitchat). |
| 56 | +If you are experiencing any problems with Bitkit, please open an issue and use the template provided, or reach out to us on [Telegram](https://t.me/bitkitchat). |
60 | 57 |
|
61 | 58 | ## Installation |
62 | 59 |
|
63 | | -[Download](https://github.com/synonymdev/bitkit/releases) or [Build it from source](./BUILD.md). |
| 60 | +[Download](https://github.com/synonymdev/bitkit/releases) or [build it from source](./BUILD.md). |
64 | 61 |
|
65 | 62 | ## Development |
66 | 63 |
|
67 | | -See [Development documentation](./DEVELOPMENT.md). |
| 64 | +See [development documentation](./DEVELOPMENT.md). |
0 commit comments