Browse Source

Improve README

hard_work
codesoap 1 year ago
parent
commit
d465857815
  1. 43
      README.md

43
README.md

@ -1,10 +1,22 @@ @@ -1,10 +1,22 @@
**WORK IN PROGRESS**
atto is a tiny Nano wallet, which focuses on ease of use through
simplicity.
atto is a tiny Nano wallet, targeted at friends of the UNIX philosophy.
The design goal is to provide a minimal set of actions to manipulate
your Nano account. atto provides no means of inspecting transaction
history as it is completely stateless. Use a Nano crawler like
https://nanocrawler.cc/ if you need such info.
Disclaimer: I am no cryptographer and atto has not been audited. I
cannot guarantee that atto is free of security compromising bugs.
# Installation
I recommend building atto yourself, but you can also
download precompiled binaries from the [releases
page](https://github.com/codesoap/atto/releases). Building atto yourself
works like this; go 1.15 or higher is required:
```shell
git clone 'https://github.com/codesoap/atto.git'
cd atto
go build
# The atto binary is now available at ./atto.
# You could also install to ~/go/bin/ by executing "go install".
```
# Usage
```console
@ -29,6 +41,7 @@ Creating receive block for 0.100 from nano_39nd8eksw1ia6aokn96z4uthocke47hfsx9gr @@ -29,6 +41,7 @@ Creating receive block for 0.100 from nano_39nd8eksw1ia6aokn96z4uthocke47hfsx9gr
$ # Choosing a representative is important for keeping the network
$ # decentralized.
$ pass nano | atto representative nano_1jr699mk1fi6mxy1y76fmuyf3dgms8s5pzcsge5cyt1az93x4n18uxjenx93
Creating change block (may take many minutes)... done
$ # Careful with the send subcommand: No confirmation is required!
$ pass nano | atto send 0.1 nano_11zdqnjpisos53uighoaw95satm4ptdruck7xujbjcs44pbkkbw1h3zomns5
@ -59,3 +72,21 @@ ACCOUNT_INDEX is an optional parameter, which must be a number between 0 @@ -59,3 +72,21 @@ ACCOUNT_INDEX is an optional parameter, which must be a number between 0
and 4,294,967,295. It allows you to use multiple accounts derived from
the same seed. By default the account with index 0 is chosen.
```
# Technical details
atto is written with less than 1000 lines of code and uses minimal
external dependencies. This makes it easy to audit the code yourself
and ensure, that it does nothing you wouldn't want it to do.
To change some defaults, take a look at `config.go`.
Signatures and proof of work are created without the help of external
services. This means that the creation of new blocks will take some
time and CPU power. Depending on your CPU, operating system and chance,
calculating the proof of work for "send" and "change" blocks can take
anywhere from a few seconds to 15 minutes or more.
atto does not have any persistance and writes nothing to your
file system. This makes atto very portable, but also means, that
no history is stored locally. I recommend using a service like
https://nanocrawler.cc/ to investigate transaction history.

Loading…
Cancel
Save