ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-29 00:25:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for generateXAddress() (#1169)

Browse Source 
It takes an optional property for including the classic address in the
return payload

Co-authored-by: Elliot Lee
This commit is contained in:
Hans Bergren
2020-01-14 02:39:02 -05:00
committed by Elliot Lee
parent 7de677c953
commit 7c6b8398cf
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.md
View File

@@ -5613,6 +5613,7 @@ Name | Type | Description
options | object | *Optional* Options to control how the address and secret are generated.
*options.* algorithm | string | *Optional* The digital signature algorithm to generate an address for. Can be `ecdsa-secp256k1` (default) or `ed25519`.
*options.* entropy | array\<integer\> | *Optional* The entropy to use to generate the seed. Must be an array of length 16 with values from 0-255 (16 bytes of entropy)
*options.* includeClassicAddress | boolean | *Optional* Specifies whether the classic address should also be included in the returned payload.
*options.* test | boolean | *Optional* Specifies whether the address is intended for use on a test network such as Testnet or Devnet. If `true`, the address should only be used for testing, and will start with `T`. If `false`, the address should only be used on mainnet, and will start with `X`.
### Return Value