|
1 | | -# Spaced - Bitcoin Spaces daemon |
| 1 | +# Bitcoin Spaces |
2 | 2 |
|
3 | | -Spaces is a naming protocol that leverages the existing infrastructure and security of Bitcoin without requiring a new blockchain or any modifications to Bitcoin itself [learn more](https://spacesprotocol.org). |
| 3 | +Checkout [releases](https://github.com/spacesprotocol/spaces/releases) for an immediately usable binary version of this software. |
4 | 4 |
|
5 | | -## Project Structure |
6 | 5 |
|
7 | | -| Package | Requires std | Description | |
8 | | -|----------|------------------|------------------------------------------------| |
9 | | -| node | Yes | Daemon and wallet service | |
10 | | -| wallet | Yes (no-std WIP) | wallet library for building spaces transactions| |
11 | | -| protocol | No | Protocol consensus library | |
| 6 | +## What does it do? |
12 | 7 |
|
13 | | -## Setup |
| 8 | +Spaces are sovereign Bitcoin identities. They leverage the existing infrastructure and security of Bitcoin without requiring a new blockchain or any modifications to Bitcoin itself [learn more](https://spacesprotocol.org). |
14 | 9 |
|
15 | | -First, download Bitcoin Core and set it up to connect to `regtest` |
16 | | -using these steps: |
17 | 10 |
|
18 | | -```bash |
19 | | -# Create a directory for Bitcoin regtest data |
20 | | -mkdir $HOME/bitcoin-regtest |
21 | | -echo "rpcuser=test" > $HOME/bitcoin-regtest/bitcoin.conf |
22 | | -echo "rpcpassword=test" >> $HOME/bitcoin-regtest/bitcoin.conf |
23 | | -bitcoind -regtest -datadir=$HOME/bitcoin-regtest |
24 | | -``` |
| 11 | +`spaced` is a tiny layer that connects to Bitcoin Core over RPC and scans transactions relevant to the protocol. |
| 12 | + |
| 13 | +`space-cli` is a Bitcoin wallet that supports opening auctions, bidding and registering spaces. |
| 14 | + |
| 15 | +## Quick Start |
| 16 | + |
| 17 | +Check out the [documentation](httsp://docs.spacesprotocol.org) |
25 | 18 |
|
26 | | -```bash |
| 19 | +## Development setup on testnet4 |
| 20 | + |
| 21 | +### Install Bitcoin Core |
| 22 | +Bitcoin Core of version 28+ is required. It can be installed from the official [download page](https://bitcoincore.org/en/download/). |
| 23 | + |
| 24 | +### Install Spaces Daemon |
| 25 | + |
| 26 | +`spaced` is a tiny layer that connects to Bitcoin Core over RPC and scans transactions relevant to the protocol. Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed before proceeding. |
| 27 | + |
| 28 | +```sh |
27 | 29 | git clone https://github.com/spacesprotocol/spaced && cd spaced |
28 | | -cargo build |
| 30 | +cargo install --path node --locked |
29 | 31 | ``` |
30 | 32 |
|
31 | | -Connect `spaced` to Bitcoin core |
| 33 | +Make sure it's in your path |
32 | 34 |
|
33 | | -```bash |
34 | | -spaced --chain regtest --bitcoin-rpc-user test --bitcoin-rpc-password test |
| 35 | +```sh |
| 36 | +echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc |
| 37 | +source ~/.bashrc |
35 | 38 | ``` |
| 39 | + |
| 40 | +Verify installation |
| 41 | + |
| 42 | +``` |
| 43 | +spaced --version |
| 44 | +space-cli --version |
| 45 | +``` |
| 46 | + |
| 47 | +### Setup |
| 48 | + |
| 49 | +First, download Bitcoin Core and set it up to connect to `testnet4` using these steps: |
| 50 | + |
| 51 | +```sh |
| 52 | +mkdir $HOME/bitcoin-testnet4 |
| 53 | + |
| 54 | +# Create a configuration file with RPC credentials |
| 55 | +echo "rpcuser=testnet4" > $HOME/bitcoin-testnet4/bitcoin.conf |
| 56 | +echo "rpcpassword=testnet4" >> $HOME/bitcoin-testnet4/bitcoin.conf |
| 57 | + |
| 58 | +# Start Bitcoin Core specifying testnet4 network |
| 59 | +bitcoind -testnet4 -datadir=$HOME/bitcoin-testnet4 |
| 60 | +``` |
| 61 | + |
| 62 | +Next, run spaced with the following: |
| 63 | +```sh |
| 64 | +spaced --chain testnet4 --bitcoin-rpc-user testnet4 --bitcoin-rpc-password testnet4 |
| 65 | +``` |
| 66 | + |
| 67 | +## Project Structure |
| 68 | + |
| 69 | +| Package | Requires std | Description | |
| 70 | +|----------|------------------|------------------------------------------------| |
| 71 | +| node | Yes | Daemon and wallet service | |
| 72 | +| wallet | Yes (no-std WIP) | wallet library for building spaces transactions| |
| 73 | +| protocol | No | Protocol consensus library | |
| 74 | + |
| 75 | + |
| 76 | +## License |
| 77 | + |
| 78 | +Spaces is released under the terms of the MIT license. See LICENSE for more information or see https://opensource.org/licenses/MIT. |
0 commit comments