Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 2.61 KB

KeyList.md

File metadata and controls

114 lines (76 loc) · 2.61 KB

class KeyList extends Collection<Key> implements Key

A list of Keys with an optional threshold. If a threshold is set the key list will be treated as a protobuf ThresholdKey type, otherwise the key list will be treated as a KeyList protobuf type.

KeyList: A list of keys that requires all keys (M-of-M) to sign unless otherwise specified in documentation. A KeyList may contain repeated keys, but all repeated keys are only required to sign once.

ThresholdKey: A set of public keys that are used together to form a threshold signature. If the threshold is N and there are M keys, then this is an N of M threshold signature. If an account is associated with ThresholdKeys, then a transaction to move cryptocurrency out of it must be signed by a list of M signatures, where at most M-N of them are blank, and the other at least N of them are valid signatures corresponding to at least N of the public keys listed here.

Note: This class implements the collection interface of the implementation language and thus can look very different between each SDK.

Note: A KeyList can be used anywhere that a Key is expected in the SDK. This includes setKey in AccountCreateTransaction and setSubmitKey in TopicCreateTransaction.

** Java **

// imperative
var keyList = KeyList.withThreshold(1);
keyList.add(keyA);
keyList.add(keyB);

// fluid
var keyList = KeyList.of(keyA, keyB).setThreshold(1);

** JavaScript **

// imperative
const keyList = KeyList.withThreshold(1);
keyList.add(key1);
keyList.addAll(List.of(key2, key3));

// fluid
const keyList = KeyList.of(keyA, keyB).setThreshold(1);

** Go **

// imperative
keyList := NewKeyList()
keyList = keyList.SetThreshold(1)
keyList = keyList.Append(keyA)
keyList = keyList.Append(keyB)

// from array
keyList := NewKeyListFromSlice([]{
    keyA,
    keyB,
}).SetThreshold(1)

// fluid
keyList := NewKeyListWith(keyA, keyB).SetThreshold(1)

Constructor

constructor ()

Create a new, empty list of keys with no threshold.

Static Methods

of (keyArray : Key[]): KeyList

Construct a new KeyList from a list of keys

withThreshold ( threshold: Uint ): KeyList

Create a new, empty list of keys with the given threshold.

Methods

toString (): String

Stringify the KeyList structure into a readable format

Properties

keys: List < Key >

The list of keys

threshold: Uint

A threshold indicating that a valid signature set must have at least this many signatures.