update doc

LedgerHQ · Aug 2, 2019 · af56707 · af56707
1 parent a0ec825
commit af56707
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/packages/hw-app-btc/README.md b/packages/hw-app-btc/README.md
@@ -129,8 +129,7 @@ To sign a transaction involving standard (P2PKH) inputs, call createPaymentTrans
 -   `sigHashType` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** is the hash type of the transaction to sign, or default (all) (optional, default `SIGHASH_ALL`)
 -   `segwit` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** is an optional boolean indicating wether to use segwit or not (optional, default `false`)
 -   `initialTimestamp` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** is an optional timestamp of the function call to use for coins that necessitate timestamps only, (not the one that the tx will include)
--   `additionals` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** list of additionnal options:
-    -   "bech32" for spending native segwit outputs
+-   `additionals` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** list of additionnal options-   "bech32" for spending native segwit outputs
     -   "abc" for bch
     -   "gold" for btg
     -   "bipxxx" for using BIPxxx

diff --git a/packages/hw-app-btc/src/Btc.js b/packages/hw-app-btc/src/Btc.js
@@ -620,6 +620,8 @@ export default class Btc {
    * @param segwit is an optional boolean indicating wether to use segwit or not
    * @param initialTimestamp is an optional timestamp of the function call to use for coins that necessitate timestamps only, (not the one that the tx will include)
    * @param additionals list of additionnal options
+   *
+   * - "bech32" for spending native segwit outputs
    * - "abc" for bch
    * - "gold" for btg
    * - "bipxxx" for using BIPxxx