decentralized-identity/ion

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

Open

#314 ouverte le 20 avr. 2020

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)HTML (1 219 stars) (168 forks)batch import
good first issue

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 }

Guide contributeur

Stack technique
typescript
Domaine
backendapiblockchain
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic JavaScript/TypeScriptunderstanding of BitcoinClient class
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
Examine the file lib/bitcoin/BitcoinClient.ts around line 47. The constructor takes a bitcoinWalletOrImportString parameter but does not validate it. Implement a check at the start of the constructor to throw an error if the parameter is undefined. Alternatively, after all initializations, check if this.bitcoinWallet is undefined and throw. Ensure consistent error handling with the rest of the codebase.