Core/mwixnet
0
0
Fork 0
mirror of https://github.com/mimblewimble/mwixnet.git synced 2025-02-01 08:51:09 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme to match interactive password changes

Browse source
This commit is contained in:
scilio 2022-07-01 05:53:34 -04:00
parent b74fd18afc
commit 40bf97a841
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -5,17 +5,18 @@ A set of n CoinSwap servers (node<sub>i</sub> with i=1...n) are agreed upon in a
### Setup
#### init-config
To setup a new server, run `mwixnet --pass "server-password-here" init-config`.
To setup a new server, run `mwixnet init-config`. Then enter a password for the server key when prompted.
This will generate a key for the server and then create a new config file named `mwixnet-config.toml` in the current working directory.
The configuration file will contain the private key of the server encrypted with the server password you provided.
**Back this config file up! It's the only copy of the server's private key!**
#### Wallet
A grin-wallet account must be created for receiving extra mwixnet fees.
A grin-wallet account must be created for receiving extra mwixnet fees. The wallet's owner API should be available (run `grin-wallet owner_api`).
### Usage
With your wallet and fully synced node both online and listening at the addresses configured, the mwixnet server can be started by running `mwixnet --pass "server-password-here" --wallet_pass "wallet-password-here"`
With your wallet and fully synced node both online and listening at the addresses configured, the mwixnet server can be started by running `mwixnet` and providing the server key password and wallet password when prompted.
### SWAP API
The first CoinSwap server (n<sub>1</sub>) provides the `swap` API, publicly available for use by GRIN wallets.