Browse Source

update wiki documentation

The MMGen Project 1 month ago
parent
commit
7300c1ec84

+ 4 - 4
doc/wiki/Recovering-Your-Keys-Without-the-MMGen-Wallet-Software.md

@@ -19,11 +19,11 @@ I recover my coins?”
 
 
 Let’s take this scenario to its logical extreme and assume you’ve lost all
 Let’s take this scenario to its logical extreme and assume you’ve lost all
 backup copies of the software, the MMGen Wallet project page has disappeared
 backup copies of the software, the MMGen Wallet project page has disappeared
-from all of [Github][04], [Gitlab][05], [Gitflic][06] and [mmgen.org][07] (or
+from all of [Github][04], [Gitlab][05], [Codeberg][06] and [mmgen.org][07] (or
 been hacked), and no other verifiable repositories or copies are available on
 been hacked), and no other verifiable repositories or copies are available on
 the Internet.  The following tutorial will show you how to recover the private
 the Internet.  The following tutorial will show you how to recover the private
-keys for your coin addresses in the event this very unlikely combination of
-circumstances ever occurs.
+keys for your coin addresses in the event this extremely unlikely combination
+of circumstances ever occurs.
 
 
 In addition to private keys, this tutorial can also be used to recover passwords
 In addition to private keys, this tutorial can also be used to recover passwords
 generated with the `mmgen-passgen` command.
 generated with the `mmgen-passgen` command.
@@ -506,5 +506,5 @@ False
 [03]: https://github.com/spesmilo/electrum/blob/1.9.5/lib/mnemonic.py
 [03]: https://github.com/spesmilo/electrum/blob/1.9.5/lib/mnemonic.py
 [04]: https://github.com/mmgen/mmgen-wallet
 [04]: https://github.com/mmgen/mmgen-wallet
 [05]: https://gitlab.com/mmgen/mmgen-wallet
 [05]: https://gitlab.com/mmgen/mmgen-wallet
-[06]: https://gitflic.ru/project/mmgen/mmgen-wallet
+[06]: https://codeberg.org/mmgen/mmgen-wallet
 [07]: https://mmgen.org/project/mmgen/mmgen-wallet
 [07]: https://mmgen.org/project/mmgen/mmgen-wallet

+ 1 - 1
doc/wiki/commands/command-help-addrgen.md

@@ -120,5 +120,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025                MMGEN-ADDRGEN(1)
+  MMGEN v15.1.dev18              March 2025                   MMGEN-ADDRGEN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-addrimport.md

@@ -31,5 +31,5 @@
 
 
   It’s recommended to use ‘--rpc-backend=aio’ with ‘--rescan’.
   It’s recommended to use ‘--rpc-backend=aio’ with ‘--rescan’.
 
 
-  MMGEN v15.1.dev17              February 2025             MMGEN-ADDRIMPORT(1)
+  MMGEN v15.1.dev18              March 2025                MMGEN-ADDRIMPORT(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-autosign.md

@@ -127,5 +127,5 @@
   Always remember to power off the signing machine when your signing session
   Always remember to power off the signing machine when your signing session
   is over.
   is over.
 
 
-  MMGEN v15.1.dev17              February 2025               MMGEN-AUTOSIGN(1)
+  MMGEN v15.1.dev18              March 2025                  MMGEN-AUTOSIGN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-keygen.md

@@ -125,5 +125,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025                 MMGEN-KEYGEN(1)
+  MMGEN v15.1.dev18              March 2025                    MMGEN-KEYGEN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-msg.md

@@ -106,5 +106,5 @@
   Verify and display the exported JSON signature data:
   Verify and display the exported JSON signature data:
   $ mmgen-msg verify signatures.json
   $ mmgen-msg verify signatures.json
 
 
-  MMGEN v15.1.dev17              February 2025                    MMGEN-MSG(1)
+  MMGEN v15.1.dev18              March 2025                       MMGEN-MSG(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-passchg.md

@@ -53,5 +53,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025                MMGEN-PASSCHG(1)
+  MMGEN v15.1.dev18              March 2025                   MMGEN-PASSCHG(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-passgen.md

@@ -101,5 +101,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025                MMGEN-PASSGEN(1)
+  MMGEN v15.1.dev18              March 2025                   MMGEN-PASSGEN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-regtest.md

@@ -25,5 +25,5 @@
     wallet_cli      - execute a wallet RPC call with supplied arguments (wallet
     wallet_cli      - execute a wallet RPC call with supplied arguments (wallet
                       is first argument)
                       is first argument)
 
 
-  MMGEN v15.1.dev17              February 2025                MMGEN-REGTEST(1)
+  MMGEN v15.1.dev18              March 2025                   MMGEN-REGTEST(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-seedjoin.md

@@ -62,5 +62,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025               MMGEN-SEEDJOIN(1)
+  MMGEN v15.1.dev18              March 2025                  MMGEN-SEEDJOIN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-seedsplit.md

@@ -144,5 +144,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025              MMGEN-SEEDSPLIT(1)
+  MMGEN v15.1.dev18              March 2025                 MMGEN-SEEDSPLIT(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-subwalletgen.md

@@ -97,5 +97,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025            MMGEN-SUBWALLETGEN(1)
+  MMGEN v15.1.dev18              March 2025               MMGEN-SUBWALLETGEN(1)
 ```
 ```

+ 22 - 1
doc/wiki/commands/command-help-swaptxcreate.md

@@ -23,6 +23,8 @@
   -I, --inputs       i  Specify transaction inputs (comma-separated list of
   -I, --inputs       i  Specify transaction inputs (comma-separated list of
                         MMGen IDs or coin addresses).  Note that ALL unspent
                         MMGen IDs or coin addresses).  Note that ALL unspent
                         outputs associated with each address will be included.
                         outputs associated with each address will be included.
+  -l, --trade-limit L   Minimum swap amount, as either percentage or absolute
+                        coin amount (see TRADE LIMIT below)
   -L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
   -L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
   -m, --minconf      n  Minimum number of confirmations required to spend
   -m, --minconf      n  Minimum number of confirmations required to spend
                         outputs (default: 1)
                         outputs (default: 1)
@@ -102,6 +104,25 @@
   send value.
   send value.
 
 
 
 
+                                  TRADE LIMIT
+
+  A target value for the swap may be set, known as the “trade limit”.  If
+  this target cannot be met, the network will refund the user’s coins, minus
+  transaction fees (note that the refund goes to the address associated with the
+  transaction’s first input, leading to coin reuse).  Since under certain
+  circumstances large amounts of slippage can occur, resulting in significant
+  losses, setting a trade limit is highly recommended.
+
+  The target may be given as either an absolute coin amount or percentage value.
+  In the latter case, it’s interpreted as the percentage below the “expected
+  amount out” returned by the swap quote server.  Zero or negative percentage
+  values are also accepted, but are likely to result in your coins being
+  refunded.
+
+  The trade limit is rounded to four digits of precision in order to reduce
+  transaction size.
+
+
   ADDRESS TYPES:
   ADDRESS TYPES:
 
 
     Code Type           Description
     Code Type           Description
@@ -175,5 +196,5 @@
 
 
       $ mmgen-tool --coin=bch --bch-rpc-host=gemini twview minconf=0
       $ mmgen-tool --coin=bch --bch-rpc-host=gemini twview minconf=0
 
 
-  MMGEN v15.1.dev17              February 2025            MMGEN-SWAPTXCREATE(1)
+  MMGEN v15.1.dev18              March 2025               MMGEN-SWAPTXCREATE(1)
 ```
 ```

+ 22 - 1
doc/wiki/commands/command-help-swaptxdo.md

@@ -31,6 +31,8 @@
   -k, --keys-from-file f Provide additional keys for non-MMGen addresses
   -k, --keys-from-file f Provide additional keys for non-MMGen addresses
   -K, --keygen-backend n Use backend 'n' for public key generation.  Options
   -K, --keygen-backend n Use backend 'n' for public key generation.  Options
                          for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
                          for BTC: 1:libsecp256k1 [default] 2:python-ecdsa
+  -l, --trade-limit L    Minimum swap amount, as either percentage or absolute
+                         coin amount (see TRADE LIMIT below)
   -L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
   -L, --autochg-ignore-labels Ignore labels when autoselecting change addresses
   -m, --minconf n        Minimum number of confirmations required to spend
   -m, --minconf n        Minimum number of confirmations required to spend
                          outputs (default: 1)
                          outputs (default: 1)
@@ -123,6 +125,25 @@
   send value.
   send value.
 
 
 
 
+                                  TRADE LIMIT
+
+  A target value for the swap may be set, known as the “trade limit”.  If
+  this target cannot be met, the network will refund the user’s coins, minus
+  transaction fees (note that the refund goes to the address associated with the
+  transaction’s first input, leading to coin reuse).  Since under certain
+  circumstances large amounts of slippage can occur, resulting in significant
+  losses, setting a trade limit is highly recommended.
+
+  The target may be given as either an absolute coin amount or percentage value.
+  In the latter case, it’s interpreted as the percentage below the “expected
+  amount out” returned by the swap quote server.  Zero or negative percentage
+  values are also accepted, but are likely to result in your coins being
+  refunded.
+
+  The trade limit is rounded to four digits of precision in order to reduce
+  transaction size.
+
+
   ADDRESS TYPES:
   ADDRESS TYPES:
 
 
     Code Type           Description
     Code Type           Description
@@ -239,5 +260,5 @@
 
 
       $ mmgen-tool --coin=bch --bch-rpc-host=gemini twview minconf=0
       $ mmgen-tool --coin=bch --bch-rpc-host=gemini twview minconf=0
 
 
-  MMGEN v15.1.dev17              February 2025               MMGEN-SWAPTXDO(1)
+  MMGEN v15.1.dev18              March 2025                  MMGEN-SWAPTXDO(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-tool(detail).md

@@ -1240,5 +1240,5 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
 ```
 ```
 
 
 ```text
 ```text
-MMGEN v15.1.dev17              February 2025              MMGEN-TOOL(DETAIL)(1)
+MMGEN v15.1.dev18              March 2025                 MMGEN-TOOL(DETAIL)(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-tool(usage).md

@@ -187,5 +187,5 @@ EXAMPLES:
   Same as above, but supply input via STDIN:
   Same as above, but supply input via STDIN:
   $ echo "deadbeefcafe" | mmgen-tool hexreverse -
   $ echo "deadbeefcafe" | mmgen-tool hexreverse -
 
 
-  MMGEN v15.1.dev17              February 2025            MMGEN-TOOL(USAGE)(1)
+  MMGEN v15.1.dev18              March 2025               MMGEN-TOOL(USAGE)(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-tool.md

@@ -198,5 +198,5 @@
 
 
   Type ‘mmgen-tool help <command>’ for help on a particular command
   Type ‘mmgen-tool help <command>’ for help on a particular command
 
 
-  MMGEN v15.1.dev17              February 2025                   MMGEN-TOOL(1)
+  MMGEN v15.1.dev18              March 2025                      MMGEN-TOOL(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-txbump.md

@@ -116,5 +116,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025                 MMGEN-TXBUMP(1)
+  MMGEN v15.1.dev18              March 2025                    MMGEN-TXBUMP(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-txcreate.md

@@ -123,5 +123,5 @@
 
 
       $ mmgen-txcreate B
       $ mmgen-txcreate B
 
 
-  MMGEN v15.1.dev17              February 2025               MMGEN-TXCREATE(1)
+  MMGEN v15.1.dev18              March 2025                  MMGEN-TXCREATE(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-txdo.md

@@ -187,5 +187,5 @@
 
 
       $ mmgen-txdo B
       $ mmgen-txdo B
 
 
-  MMGEN v15.1.dev17              February 2025                   MMGEN-TXDO(1)
+  MMGEN v15.1.dev18              March 2025                      MMGEN-TXDO(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-txsend.md

@@ -18,5 +18,5 @@
   -v, --verbose   Be more verbose
   -v, --verbose   Be more verbose
   -y, --yes       Answer 'yes' to prompts, suppress non-essential output
   -y, --yes       Answer 'yes' to prompts, suppress non-essential output
 
 
-  MMGEN v15.1.dev17              February 2025                 MMGEN-TXSEND(1)
+  MMGEN v15.1.dev18              March 2025                    MMGEN-TXSEND(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-txsign.md

@@ -82,5 +82,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025                 MMGEN-TXSIGN(1)
+  MMGEN v15.1.dev18              March 2025                    MMGEN-TXSIGN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-walletchk.md

@@ -51,5 +51,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025              MMGEN-WALLETCHK(1)
+  MMGEN v15.1.dev18              March 2025                 MMGEN-WALLETCHK(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-walletconv.md

@@ -62,5 +62,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025             MMGEN-WALLETCONV(1)
+  MMGEN v15.1.dev18              March 2025                MMGEN-WALLETCONV(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-walletgen.md

@@ -54,5 +54,5 @@
     MMGenWallet        .mmdat    wallet,w
     MMGenWallet        .mmdat    wallet,w
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
     PlainHexSeedFile   .hex      hex,rawhex,plainhex
 
 
-  MMGEN v15.1.dev17              February 2025              MMGEN-WALLETGEN(1)
+  MMGEN v15.1.dev18              March 2025                 MMGEN-WALLETGEN(1)
 ```
 ```

+ 1 - 1
doc/wiki/commands/command-help-xmrwallet.md

@@ -499,5 +499,5 @@
   to delete your old hot wallets, make sure to do so securely using ‘shred’,
   to delete your old hot wallets, make sure to do so securely using ‘shred’,
   ‘wipe’ or some other secure deletion utility.
   ‘wipe’ or some other secure deletion utility.
 
 
-  MMGEN v15.1.dev17              February 2025              MMGEN-XMRWALLET(1)
+  MMGEN v15.1.dev18              March 2025                 MMGEN-XMRWALLET(1)
 ```
 ```