README.md

   1 # spanner
   2 Python based bytom and vapor 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    OR
  15    ```
  16     vapord init --chain_id mainnet
  17    ```
  18    If you don't know how to run bytomd or vapord please check [bytom wiki](https://github.com/Bytom/bytom/wiki/Build-and-Install) or [vapor wiki](https://github.com/Bytom/vapor/wiki/Build-and-Install)
  19
  20 ## btm-sender
  21
  22 Tool send BTM to large numbers of address
  23
  24 Usage:
  25    ```
  26     spanner.py btmsender [-h] -n N -i I -a A [-s S] [-c C] [-u] [-t T]
  27    ```
  28 Options:
  29    ```
  30   -h, --help      show this help message and exit
  31   -n node         bytomd or vapord node address
  32   -i input        transaction txt file
  33   -a account      wallet account id
  34   -s asset_id     transaction asset id
  35   -c count        transaction output count
  36   -u              use unconfirmed UTXO build transaction
  37   -t time_range   the transaction will not be submitted into block after this height
  38   ```
  39 See more details in btm-sender [README.md](https://github.com/Bytom/spanner/blob/master/btmsender/README.md) file.
  40 ## utxo-merger
  41
  42 Tool merge some utxos to one for loops.
  43
  44 Usage:
  45 ```
  46 spanner.py utxomerger [-h] [-o URL] [-a ACCOUNT_ALIAS] [-p PASSWORD]
  47                      [-x MAX_AMOUNT] [-s MIN_AMOUNT] [-l] [-m MERGE_LIST]
  48                      [-f FOR_LOOP] [-y]
  49 ```
  50 Options:
  51 ```
  52   -h, --help            show this help message and exit
  53   -o URL, --url URL     API url to connect
  54   -a ACCOUNT_ALIAS, --account ACCOUNT_ALIAS
  55                         account alias
  56   -p PASSWORD, --pass PASSWORD
  57                         account password
  58   -x MAX_AMOUNT, --max MAX_AMOUNT
  59                         range lower than max_amount
  60   -s MIN_AMOUNT, --min MIN_AMOUNT
  61                         range higher than min_amount
  62   -l, --list            Show UTXO list without merge
  63   -m MERGE_LIST, --merge MERGE_LIST
  64                         UTXO to merge
  65   -f FOR_LOOP, --forloop FOR_LOOP
  66                         size for loop of UTXO to merge
  67   -y, --yes             confirm transfer
  68
  69   ```
  70
  71 See more details in utxo-merger [README.md](https://github.com/Bytom/spanner/blob/master/utxomerger/README.md) file.
  72