-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Alexander Shevtsov <[email protected]>
- Loading branch information
1 parent
5633421
commit 6f20075
Showing
2 changed files
with
88 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2009-2024 The Bitcoin Core developers | ||
Copyright (c) 2009-2024 Bitcoin Developers | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,78 @@ | ||
# Spaced - Bitcoin Spaces daemon | ||
# Bitcoin Spaces | ||
|
||
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). | ||
Checkout [releases](https://github.com/spacesprotocol/spaces/releases) for an immediately usable binary version of this software. | ||
|
||
## Project Structure | ||
|
||
| Package | Requires std | Description | | ||
|----------|------------------|------------------------------------------------| | ||
| node | Yes | Daemon and wallet service | | ||
| wallet | Yes (no-std WIP) | wallet library for building spaces transactions| | ||
| protocol | No | Protocol consensus library | | ||
## What does it do? | ||
|
||
## Setup | ||
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). | ||
|
||
First, download Bitcoin Core and set it up to connect to `regtest` | ||
using these steps: | ||
|
||
```bash | ||
# Create a directory for Bitcoin regtest data | ||
mkdir $HOME/bitcoin-regtest | ||
echo "rpcuser=test" > $HOME/bitcoin-regtest/bitcoin.conf | ||
echo "rpcpassword=test" >> $HOME/bitcoin-regtest/bitcoin.conf | ||
bitcoind -regtest -datadir=$HOME/bitcoin-regtest | ||
``` | ||
`spaced` is a tiny layer that connects to Bitcoin Core over RPC and scans transactions relevant to the protocol. | ||
|
||
`space-cli` is a Bitcoin wallet that supports opening auctions, bidding and registering spaces. | ||
|
||
## Quick Start | ||
|
||
Check out the [documentation](httsp://docs.spacesprotocol.org) | ||
|
||
```bash | ||
## Development setup on testnet4 | ||
|
||
### Install Bitcoin Core | ||
Bitcoin Core of version 28+ is required. It can be installed from the official [download page](https://bitcoincore.org/en/download/). | ||
|
||
### Install Spaces Daemon | ||
|
||
`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. | ||
|
||
```sh | ||
git clone https://github.com/spacesprotocol/spaced && cd spaced | ||
cargo build | ||
cargo install --path node --locked | ||
``` | ||
|
||
Connect `spaced` to Bitcoin core | ||
Make sure it's in your path | ||
|
||
```bash | ||
spaced --chain regtest --bitcoin-rpc-user test --bitcoin-rpc-password test | ||
```sh | ||
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc | ||
source ~/.bashrc | ||
``` | ||
|
||
Verify installation | ||
|
||
``` | ||
spaced --version | ||
space-cli --version | ||
``` | ||
|
||
### Setup | ||
|
||
First, download Bitcoin Core and set it up to connect to `testnet4` using these steps: | ||
|
||
```sh | ||
mkdir $HOME/bitcoin-testnet4 | ||
|
||
# Create a configuration file with RPC credentials | ||
echo "rpcuser=testnet4" > $HOME/bitcoin-testnet4/bitcoin.conf | ||
echo "rpcpassword=testnet4" >> $HOME/bitcoin-testnet4/bitcoin.conf | ||
|
||
# Start Bitcoin Core specifying testnet4 network | ||
bitcoind -testnet4 -datadir=$HOME/bitcoin-testnet4 | ||
``` | ||
|
||
Next, run spaced with the following: | ||
```sh | ||
spaced --chain testnet4 --bitcoin-rpc-user testnet4 --bitcoin-rpc-password testnet4 | ||
``` | ||
|
||
## Project Structure | ||
|
||
| Package | Requires std | Description | | ||
|----------|------------------|------------------------------------------------| | ||
| node | Yes | Daemon and wallet service | | ||
| wallet | Yes (no-std WIP) | wallet library for building spaces transactions| | ||
| protocol | No | Protocol consensus library | | ||
|
||
|
||
## License | ||
|
||
Spaces is released under the terms of the MIT license. See LICENSE for more information or see https://opensource.org/licenses/MIT. |