doc: update the readme

This commit is contained in:
Vlad Stan 2022-08-05 16:31:29 +03:00
parent 8075503566
commit ac203046a6

View file

@ -8,7 +8,7 @@ You can now use this wallet on the LNBits [SatsPayServer](https://github.com/lnb
### Wallet Account ### Wallet Account
- a user can add one or more `xPubs` or `descriptors` - a user can add one or more `xPubs` or `descriptors`
- the `xPub` fingerprint must be unique per user - the `xPub` must be unique per user
- such and entry is called an `Wallet Account` - such and entry is called an `Wallet Account`
- the addresses in a `Wallet Account` are split into `Receive Addresses` and `Change Address` - the addresses in a `Wallet Account` are split into `Receive Addresses` and `Change Address`
- the user interacts directly only with the `Receive Addresses` (by sharing them) - the user interacts directly only with the `Receive Addresses` (by sharing them)
@ -17,6 +17,7 @@ You can now use this wallet on the LNBits [SatsPayServer](https://github.com/lnb
- when a `Wallet Account` is created, there are generated `20 Receive Addresses` and `5 Change Address` - when a `Wallet Account` is created, there are generated `20 Receive Addresses` and `5 Change Address`
- the limits can be change from the `Config` page (see `screenshot 1`) - the limits can be change from the `Config` page (see `screenshot 1`)
- regular wallets only scan up to `20` empty receive addresses. If the user generates addresses beyond this limit a warning is shown (see `screenshot 4`) - regular wallets only scan up to `20` empty receive addresses. If the user generates addresses beyond this limit a warning is shown (see `screenshot 4`)
- an account can be added `From Hardware Device`
### Scan Blockchain ### Scan Blockchain
- when the user clicks `Scan Blockchain`, the wallet will loop over the all addresses (for each account) - when the user clicks `Scan Blockchain`, the wallet will loop over the all addresses (for each account)
@ -54,20 +55,19 @@ You can now use this wallet on the LNBits [SatsPayServer](https://github.com/lnb
- the `Max` button next to an address is for sending the remaining funds to this address (no change) - the `Max` button next to an address is for sending the remaining funds to this address (no change)
- the user can select the inputs (UTXOs) manually, or it can use of the basic selection algorithms - the user can select the inputs (UTXOs) manually, or it can use of the basic selection algorithms
- amounts have to be provided for the `Send Addresses` beforehand (so the algorithm knows the amount to be selected) - amounts have to be provided for the `Send Addresses` beforehand (so the algorithm knows the amount to be selected)
- `Show Advanced` allows to (see `screenshot 2`): - `Show Change` allows to select from which account the change address will be selected (defaults to the first one)
- select from which account the change address will be selected (defaults to the first one) - `Show Custom Fee` allows to manually select the fee
- select the `Fee Rate`
- it defaults to the `Medium` value at the moment the `New Payment` button was clicked - it defaults to the `Medium` value at the moment the `New Payment` button was clicked
- it can be refreshed - it can be refreshed
- warnings are shown if the fee is too Low or to High - warnings are shown if the fee is too Low or to High
### Create PSBT ### Check & Send
- based on the Inputs & Outputs selected by the user a PSBT will be generated - creates the PSBT and sends it to the Hardware Wallet
- this wallet is watch-only, therefore does not support signing - a confirmation will be shown for each Output and for the Fee
- it is not mandatory for the `Selected Amount` to be grater than `Payed Amount` - after the user confirms the addresses and amounts, the transaction will be signed on the Hardware Device
- the generated PSBT can be combined with other PSBTs that add more inputs.
- the generated PSBT can be imported for signing into different wallets like Electrum ### Share PSBT
- import the PSBT into Electrum and check the In/Outs/Fee (see `screenshot 3`) - Show the PSBT without sending it to the Hardware Wallet
## Screensots ## Screensots
- screenshot 1: - screenshot 1: