OSDN Git Service

Merge pull request #1 from Bytom/dev
[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
17
18 Bytom tool send BTM to large numbers of address
19
20 Usage:
21    ```
22     btmspanner.py btmsender [-h] -i I -a A -p P [-c C]
23    ```
24 Options:
25    ```
26   -h, --help      show this help message and exit
27   -i input        transaction txt file
28   -a account      wallet account id
29   -p password     wallet account password
30   -c count        transaction output count
31   ```
32 See more details in btm-sender [README.md](https://github.com/Bytom/btm-spanner/blob/master/btmsender/README.md) file.
33 ## utxo-merger
34
35 Bytom tool merge some utxos to one for loops.
36
37 Usage:
38   
39   ```
40   $ python btmspanner.py utxomerger -h
41 usage: btmspanner.py [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
42                      [-x MAX_AMOUNT] [-s MIN_AMOUNT] [-l] [-m MERGE_LIST]
43                      [-f FOR_LOOP] [-y]
44
45 Bytom merge utxo tool
46
47 optional arguments:
48   -h, --help            show this help message and exit
49   -o URL, --url URL     API url to connect
50   -a ACCOUNT_ALIAS, --account ACCOUNT_ALIAS
51                         account alias
52   -p PASSWORD, --pass PASSWORD
53                         account password
54   -x MAX_AMOUNT, --max MAX_AMOUNT
55                         range lower than max_amount
56   -s MIN_AMOUNT, --min MIN_AMOUNT
57                         range higher than min_amount
58   -l, --list            Show UTXO list without merge
59   -m MERGE_LIST, --merge MERGE_LIST
60                         UTXO to merge
61   -f FOR_LOOP, --forloop FOR_LOOP
62                         size for loop of UTXO to merge
63   -y, --yes             confirm transfer
64   
65   ```
66
67 See more details in utxo-merger [README.md](https://github.com/Bytom/btm-spanner/blob/master/utxomerger/README.md) file.
68