hashgraph / hashgraph/hedera-sdk-reference

The difference between `KeyList` and `ThresholdKey` is ambiguous and poorly documented

Open
#76 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
7
Forks
3
PR merge metrics
No merged PRs in 30d

Description

At some point, the decision was made to combine `KeyList` and `ThresholdKey` objects, such that if a `threshold` value is set, then a `ThresholdKey` protobuf is produced, otherwise producing a `KeyList` protobuf

This invites misuse: a `KeyList` is intended to have specialized behavior related to files. It isn't just a `ThresholdKey` where N of N keys are required to sign.

1. If a developer *wants* the special `KeyList` behavior, but sets a `threshold` value without understanding the implications, they might not know that suddenly they no longer have a `KeyList` at all
2. If a developer doesn't know anything about the specialized file related behavior of a `KeyList`, and assumes setting no threshold == requiring N of N signatures (logical, IMO), they could get be blindsided by specialized `KeyList` behavior

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.