OSDN Git Service

change the project readme file.
[bytom/bytom-spanner.git] / README.md
1 # btm-spanner
2 Python based Bytom wallet tools
3
4 Requirements: Python 3.x, with requests package
5
6 Dependencies:
7    ```
8     pip install requests
9    ```
10 Prepare:
11    ```
12     bytomd init --chain_id mainnet
13    ```
14    If you don't know how to run bytomd please check this [wiki](https://github.com/Bytom/bytom/wiki/Build-and-Install)
15
16 ## [btm-sender](https://github.com/Bytom/btm-spanner/blob/master/btmsender/README.md)
17
18 ## utxo-merger
19
20 This is a bytom tool that can merge some utxos to one.
21
22 > utxo-merger Usage:
23   
24   ```shell
25 python btmspanner.py utxomerger [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
26                      [-x MAX_AMOUNT] [-s MIN_AMOUNT] [-l] [-m MERGE_LIST] [-y]
27
28 Bytom merge utxo tool
29
30 optional arguments:
31   -h, --help            show this help message and exit
32   -o URL, --url URL     API url to connect
33   -a ACCOUNT_ALIAS, --account ACCOUNT_ALIAS
34                         account alias
35   -p PASSWORD, --pass PASSWORD
36                         account password
37   -x MAX_AMOUNT, --max MAX_AMOUNT
38                         range lower than max_amount
39   -s MIN_AMOUNT, --min MIN_AMOUNT
40                         range higher than min_amount
41   -l, --list            Show UTXO list without merge
42   -m MERGE_LIST, --merge MERGE_LIST
43                         UTXO to merge
44   -y, --yes             confirm transfer
45   ```
46
47 > see more details in [utxo-merger README.md](https://github.com/Bytom/btm-spanner/blob/master/utxomerger/README.md) file.