bcoin-org / bcoin-org/bcoin-org.github.io

Error: wallet create options incomplete

Open Beginner friendly
#80 0 comments 0 reactions 0 assignees View on GitHub
bug guide
Dominant language
JavaScript
Stars
19
Forks
38
PR merge metrics
No merged PRs in 30d

Description

The data in the box here: http://bcoin.io/api-docs/index.html?javascript#wallet-options
is incomplete. You can see that it does not include `passphrase`, which is included in the create wallet example:

```javascript
let id, passphrase, witness, accountKey;
id='foo'
passphrase='bar'
witness='false'
accountKey='tpubDDh2XgSds1vBbeVgye88gsGQeCityoywRndtyrXcmvWqCgsFUyUKwzeDv8HiJhu9fC8jRAFMqxr4jj8eRTNTycmMao5wmsAScVf4jSMdPYZ'
const client = new bcoin.http.Client();
const options = {
id: id,
passphrase: passphrase,
witness: witness,
watchOnly: true,
accountKey: accountKey
};

(async() => {
const newWallet = await client.createWallet(options)
})();
```

Because of the link to see all of the options leading up the the box that is incomplete, a user may miss out on the fact that a passphrase can be sent along

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the wallet API documentation at the linked wallet-options section and compare its create-wallet options box with the JavaScript create wallet example in the issue. Update the options listing so passphrase is included, then verify that the documented options match the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.