decentralized-identity/ion

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

Open

#314 创建于 2020年4月20日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)HTML (1,219 star) (168 fork)batch import
good first issue

描述

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 }

贡献者指南

技术栈
typescript
领域
backendapiblockchain
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic JavaScript/TypeScriptunderstanding of BitcoinClient class
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.