Safe Network DBCs
| Crate | Documentation | CI | Safe Rust |
|---|---|---|---|
 |
 |
 |
| MaidSafe website | SAFE Dev Forum | SAFE Network Forum |
|---|
This crate provides an example spentbook node and an example wallet. Both are CLI only (no GUI).
The spentbook_node and the wallet are each implemented in a single source file to demonstrate how simple it is and make it easier to understand. See the src/bin directory.
These examples demonstrate a simple wallet communicating with a spentbook consisting of 3 mock spentbook nodes simulating a single Safe Network "section". It is useful for:
- proving out the sn_dbc wallet and spentbook APIs in a quasi-real setup
- providing a hands-on way to interact with DBCs.
- demonstrating/learning the sn_dbc API (creating transactions, etc)
- begin exploring similarities and differences with existing cryptocurrency wallets. In particular, DBCs offer a "bearer" capability and also DBCs are transferred outside the system, (not via a blockchain/ledger).
With the included wallet example, one can:
- issue a Genesis DBC
- reissue any number of other DBCs, either bearer or owned.
- generate new receiving public key(s)
- deposit a DBC into a wallet
- check wallet balance
- list unspent DBCs in wallet
- not production code. definitely not "mainnet".
- not an implementation of the "real" Safe Network spentbook/mint.
- not the final APIs
- not any indication of what final wallet/ui will be like.
These examples use the sn_dbc and qp2p crates directly. They do not use or rely on the Safe Network node or API. The Safe Network is building a distributed spentbook/mint that should implement approximately the same public API as sn_dbc::SpentbookNodeMock, but will be very different in implementation details.
Key components are:
- sn_dbc - Safe Network DBCs
- blst_ringct - RingCt using bls curve
- blsttc - BLS keys
- qp2p - Quic protocol P2P library
See https://www.rust-lang.org/tools/install
On ubuntu you will need to:
apt install build-essential
$ git clone https://github.com/maidsafe/sn_dbc_examples.git
$ cd sn_dbc_examples
$ cargo build
ultraman makes it easy to start/stop multiple spentbook nodes, but is not required.
note: ultraman is a rust port of foreman from the ruby ecosystem.
$ git clone https://github.com/dan-da/ultraman.git
$ cd ultraman
$ cargo build
$ cargo install --path .
ultraman only runs on unix, but foreman can be used on windows.
For this, you need ruby installed.
In powershell:
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('<https://chocolatey.org/install.ps1>'))" && SET PATH=%PATH%;%systemdrive%\chocolatey\bin
cinst ruby
gem install foreman
This will start 3 spentbook nodes.
$ cd sn_dbc_examples
$ RUST_LOG=info ultraman start
To stop the nodes, just ctrl-c the ultraman proc.
note: substitute foreman for ultraman if using the former.
shell1:
cargo run --bin spentbook_node -- --spentbook-file .sb-node1.dat --port 1111 --quorum-size 3
shell2:
cargo run --bin spentbook_node -- --spentbook-file .sb-node2.dat --port 2222 127.0.0.1:1111 --quorum-size 3
shell3:
cargo run --bin spentbook_node -- --spentbook-file .sb-node2.dat --port 3333 127.0.0.1:1111 --quorum-size 3
In another shell:
$ cd sn_dbc_examples
$ cargo run --bin wallet
In another shell:
$ cd sn_dbc_examples
$ cargo run --bin wallet -- --wallet-file .wallet2.dat
(be sure to use a different wallet filename for each instance)
The spentbook and wallet data are persisted to disk (by default in the directory in which they are run). To reset the data, end all wallet and spentbook processes and then:
$ cd sn_dbc_examples
$ ./wipe_wallet_and_spendbook_data.sh
Here's a summary of what we want to do, exact instructions to follow:
Open up three shells (aka terminal windows, command prompts, tabs) in the sn_dbc_examples directory. If starting the spentbook manually, you will need 5 shells.
In the first shell run ultraman or foreman to start a distributed spentbook with 3 nodes. Or alternatively start each spentbook node manually in a separate shell.
In another shell (Alice) create a wallet and issue the genesis dbc.
In another shell (Bob) create a wallet and a public key to receive funds.
In the Alice shell create a DBC payment to Bob and copy the generated DBC.
In the Bob shell deposit the DBC.
Ready? Let's go!
$ ultraman start
20:35:57 system | peer3.1 start at pid: 14351
20:35:57 system | peer2.1 start at pid: 14352
20:35:57 system | peer1.1 start at pid: 14353
20:35:57 peer2.1 | Spentbook [c35b8e..] listening for messages at: 127.0.0.1:5099
20:35:57 peer1.1 | Spentbook [2f33dd..] listening for messages at: 127.0.0.1:1111
20:35:57 peer3.1 | Spentbook [007608..] listening for messages at: 127.0.0.1:5199
20:35:59 peer1.1 | SpentbookNode created. ready to process spentbook requests.
20:35:59 peer2.1 | SpentbookNode created. ready to process spentbook requests.
20:35:59 peer3.1 | SpentbookNode created. ready to process spentbook requests.
(alternatively, use foreman or start spentbook nodes manually. See instructions
under 'Running' above.)
in shell 1:
$ cargo run --bin wallet
Finished dev [unoptimized + debuginfo] target(s) in 0.14s
Running `target/debug/wallet`
__ _
(_ _._|__ |\ | __|_ _ ._|
__)(_| |(/_ | \|(/_|_\/\/(_)| |<
██╗ ██╗ █████╗ ██╗ ██╗ ███████╗████████╗
██║ ██║██╔══██╗██║ ██║ ██╔════╝╚══██╔══╝
██║ █╗ ██║███████║██║ ██║ █████╗ ██║
██║███╗██║██╔══██║██║ ██║ ██╔══╝ ██║
╚███╔███╔╝██║ ██║███████╗███████╗███████╗ ██║
╚══╝╚══╝ ╚═╝ ╚═╝╚══════╝╚══════╝╚══════╝ ╚═╝
got spentbook peers: {
007608(00000000)..: 127.0.0.1:5199,
2f33dd(00101111)..: 127.0.0.1:1111,
c35b8e(11000011)..: 127.0.0.1:5099,
}
Type 'help' to get started.
>> balance
Available balance: 0
in shell 1:
>> issue_genesis
Attempting to issue the Genesis Dbc...
>> balance
Available balance: 18446744073709551615
note: The genesis DBC will only ever be created once in the history of the network, so it would not be a feature of regular wallet software. But we have to bootstrap things somehow!
Bob wants to receive a payment from Alice, so he generates a new receive key/address:
in shell 2:
$ cargo run --bin wallet -- --wallet-file .wallet2.dat
...
>> newkey
Receive PublicKey: a5c4a0e24ff643b9a7056af9efe3ed447472cd8b5a6f272cca4d0e2684e80325b4602c01862c9aa6aca7b7dbea1afb19
in shell 1:
>> reissue
Available balance: 18446744073709551615
Amount to spend: 100000
[b]earer or [o]wned: o
Recipient's public key: a5c4a0e24ff643b9a7056af9efe3ed447472cd8b5a6f272cca4d0e2684e80325b4602c01862c9aa6aca7b7dbea1afb19
-- Begin DBC --
01000000a5c4a0e24ff643b9a7056af9efe3ed447472cd8b ...
-- End Dbc--
note: this DBC is owned by a third party
note: change DBC deposited to our wallet.
in shell 2:
>> deposit
Paste Dbc:
01000000a5c4a0e24ff643b9a7056af9efe3ed447472cd8b ...
Notes (optional): from Alice
Deposited 100000
in shell 2:
>> balance
Available balance: 100000
>> unspent
-- Unspent Dbcs --
a56e45ddf45f880b588b75f243fa88328d190c928596c5237c2d3bffe993a66c, rcvd: 2022-03-24T04:24:14.208444897+00:00, amount: 100000 (mine)
This SAFE Network library is dual-licensed under the Modified BSD (LICENSE-BSD https://opensource.org/licenses/BSD-3-Clause) or the MIT license (LICENSE-MIT https://opensource.org/licenses/MIT) at your option.
Want to contribute? Great 🎉
There are many ways to give back to the project, whether it be writing new code, fixing bugs, or just reporting errors. All forms of contributions are encouraged!
For instructions on how to contribute, see our Guide to contributing.