|
255 | 255 | <define name="BX_EK_TO_EC_INVALID_PASSPHRASE" value="The passphrase is incorrect." /> |
256 | 256 | <define name="BX_EK_TO_EC_REQUIRES_ICU" value="The command requires an ICU build." /> |
257 | 257 | </command> |
258 | | - |
259 | | - <!-- TODO: document no unconfirmed history for 3.0 [done] --> |
| 258 | + |
260 | 259 | <command symbol="fetch-balance" output="balance_row" category="ONLINE" network="true" description="Get the balance in satoshi of a payment address. Requires a Libbitcoin server connection."> |
261 | 260 | <option name="format" type="encoding" description="The output format. Options are 'info', 'json' and 'xml', defaults to 'info'." /> |
262 | 261 | <argument name="PAYMENT_ADDRESS" stdin="true" type="payment_address" description="The payment address. If not specified the address is read from STDIN." /> |
|
268 | 267 | <option name="height" shortcut="t" type="uint32_t" description="The block height."/> |
269 | 268 | </command> |
270 | 269 |
|
271 | | - <!-- TODO: document new public-key argument for 3.1 --> |
272 | 270 | <command symbol="fetch-height" formerly="fetch-last-height" output="uint32_t" category="ONLINE" network="true" description="Get the last block height. Requires a Libbitcoin server connection."> |
273 | 271 | <argument name="server-url" description="The URL of the Libbitcoin server to use. If not specified the URL is obtained from configuration settings or defaults."/> |
274 | 272 | <argument name="public-key" description="The public key of the Libbitcoin server. If not specified the key is obtained from configuration settings or defaults."/> |
275 | 273 | </command> |
276 | | - |
277 | | - <!-- TODO: document simplified output format (3.1) and no unconfirmed history for 3.0 [done] --> |
| 274 | + |
278 | 275 | <command symbol="fetch-history" output="history_row" category="ONLINE" network="true" description="Get list of output points, values, and spends for a payment address. Requires a Libbitcoin server connection."> |
279 | 276 | <option name="format" type="encoding" description="The output format. Options are 'info', 'json' and 'xml', defaults to 'info'." /> |
280 | 277 | <argument name="PAYMENT_ADDRESS" stdin="true" type="payment_address" description="The payment address. If not specified the address is read from STDIN." /> |
|
285 | 282 | <define name="BX_FETCH_PUBLIC_KEY_NOT_IMPLEMENTED" value="This command is not yet implemented." /> |
286 | 283 | </command> |
287 | 284 |
|
288 | | - <!-- TODO: document new limit (8 bit filter) for 3.1 --> |
289 | 285 | <command symbol="fetch-stealth" output="stealth_row" category="ONLINE" network="true" description="Get metadata on potential payment transactions by stealth prefix filter. Requires a Libbitcoin server connection."> |
290 | 286 | <option name="format" type="encoding" description="The output format. Options are 'info', 'json' and 'xml', defaults to 'info'." /> |
291 | 287 | <option name="height" shortcut="t" type="uint32_t" description="The minimum block height of transactions to include."/> |
292 | 288 | <!--<option name="scan_secret" type="ec_private" description="The Base16 EC private key to use locally in confirming stealth transactions."/>--> |
293 | 289 | <!--<option name="scan_pubkey" shortcut="p" type="ec_public" description="The Base16 EC public key to use locally in confirming stealth transactions."/>--> |
294 | | - <argument name="FILTER" type="base2" description="The Base2 stealth prefix filter used to locate transactions. Defaults to all stealth transactions." /> |
| 290 | + <argument name="FILTER" type="base2" description="The Base2 stealth prefix filter used to locate transactions. Must be at least 8 bits in length." /> |
295 | 291 | <define name="BX_FETCH_STEALTH_PREFIX_TOO_LONG" value="Stealth prefix is limited to 32 bits." /> |
296 | 292 | <define name="BX_FETCH_STEALTH_FILTER_TOO_SHORT" value="Stealth prefix must be at least 8 bits." /> |
297 | 293 | </command> |
|
407 | 403 | <command symbol="mnemonic-encode" formerly="mnemonic" output="string" multipleX="true" category="ELECTRUM" obsolete="true" description="Convert an Electrum mnemonic to its seed."> |
408 | 404 | <define name="BX_MNEMONIC_ENCODE_OBSOLETE" value="Electrum style key functions are obsolete. Use mnemonic-new (BIP39) command instead." /> |
409 | 405 | </command> |
410 | | - |
411 | | - <!-- TODO: update online documentation for 3.x release additional languages ('cs', 'ru', 'uk'). --> |
| 406 | + |
412 | 407 | <command symbol="mnemonic-new" output="string" multipleX="true" category="WALLET" description="Create a mnemonic seed (BIP39) from entropy. WARNING: mnemonic should be created from properly generated entropy."> |
413 | 408 | <option name="language" type="language" description="The language identifier of the mnemonic dictionary to use. Options are 'en', 'es', 'fr', 'it', 'ja', 'cs', 'ru', 'uk', 'zh_Hans', 'zh_Hant' and 'any', defaults to 'en'." /> |
414 | 409 | <argument name="SEED" stdin="true" type="base16" description="The Base16 entropy from which the mnemonic is created. The length must be evenly divisible by 32 bits. If not specified the entropy is read from STDIN." /> |
|
586 | 581 | <define name="BX_VALIDATE_TX_INVALID" value="The transaction is invalid for the current state of the node: %1%." /> |
587 | 582 | </command> |
588 | 583 |
|
589 | | - <!-- TODO: document no format and no stealth for 3.1 release. --> |
590 | 584 | <command symbol="watch-address" formerly="monitor" output="transaction" category="ONLINE" network="true" description="Watch the network for transactions in which an address participates. Requires a Libbitcoin server connection."> |
591 | 585 | <option name="duration" type="uint32_t" default="600" description="The duration of the watch in seconds, defaults to 600." /> |
592 | 586 | <!--<option name="format" type="encoding" description="The output format. Options are 'info', 'json' and 'xml', defaults to 'info'." />--> |
593 | 587 | <argument name="PAYMENT_ADDRESS" stdin="true" type="payment_address" description="The participating payment address. If not specified the address is read from STDIN." /> |
594 | 588 | <define name="BX_WATCH_ADDRESS_WAITING" value="Watching address: %1%..." /> |
595 | 589 | </command> |
596 | 590 |
|
597 | | - <!-- TODO: document new command and no format for 3.1 release. --> |
598 | 591 | <command symbol="watch-stealth" output="transaction" category="ONLINE" network="true" description="Watch the network for transactions by stealth prefix. Requires a Libbitcoin server connection."> |
599 | 592 | <option name="duration" type="uint32_t" default="600" description="The duration of the watch in seconds, defaults to 600." /> |
600 | 593 | <!--<option name="format" type="encoding" description="The output format. Options are 'info', 'json' and 'xml', defaults to 'info'." />--> |
601 | 594 | <!--<option name="scan_secret" type="ec_private" description="The Base16 EC private key to use locally in confirming stealth transactions."/>--> |
602 | 595 | <!--<option name="scan_pubkey" shortcut="p" type="ec_public" description="The Base16 EC public key to use locally in confirming stealth transactions."/>--> |
603 | | - <argument name="PREFIX" stdin="true" type="base2" description="The Base2 stealth prefix to watch. If not specified the prefix is read from STDIN." /> |
| 596 | + <argument name="PREFIX" stdin="true" type="base2" description="The Base2 stealth prefix to watch. Must be at least 8 bits in length. If not specified the prefix is read from STDIN." /> |
604 | 597 | <define name="BX_WATCH_STEALTH_PREFIX_WAITING" value="Watching stealth prefix: %1%..." /> |
605 | 598 | <define name="BX_WATCH_STEALTH_PREFIX_TOO_LONG" value="Stealth prefix is limited to 32 bits." /> |
606 | 599 | <define name="BX_WATCH_STEALTH_PREFIX_TOO_SHORT" value="Stealth prefix must be at least 8 bits." /> |
|
0 commit comments