decentralized-identity/ion

BitcoinClient should check for if the 'bitcoinWalletOrImportString' parameter is undefined

Open

#314 opened on Apr 20, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (168 forks)batch import
good first issue

Repository metrics

Stars
 (1,219 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

https://github.com/decentralized-identity/sidetree/blob/a8ba6ec2a1fb809df55ce54e47339d8ac1e7df34/lib/bitcoin/BitcoinClient.ts#L47

If the admin forgets to add in either the import string or an actual IBitcoinWallet on this parameter then we should throw here. Currently, the this.bitcoinWallet member stays undefined and we throw when we try to use it.

Suggestion:

if (typeof bitcoinWalletOrImportString === 'undefined') { // throw }

// OR

// After all the initializations
if (this.bitcoinWallet === undefined) { // throw }

Contributor guide

Research direction
Look at line 47 of BitcoinClient.ts and add an undefined check for the bitcoinWalletOrImportString parameter.
Tech stack
typescript
Domain
blockchain
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95