Class

ClusterDescriptor

ClusterDescriptor

Cluster descriptor

The cluster descriptor contains relevant cluster configuration information. This is the structure returned by the cluster_information operation in the client.

Members

# id

Cluster identifier Returns the cluster identifier as a string.

View Source nillion_client_wasm.js, line 344

Example
const descriptor = await nillionClient.cluster_information();
const id = descriptor.id;

# kappa

The security parameter kappa for this cluster.

View Source nillion_client_wasm.js, line 419

Example
const descriptor = await nillionClient.cluster_information();
const kappa = descriptor.kappa;

# parties

Cluster parties Returns the parties in the cluster.

View Source nillion_client_wasm.js, line 370

Example
const descriptor = await nillionClient.cluster_information();
const parties = descriptor.parties;

# prime

The prime number to be used in this cluster.

View Source nillion_client_wasm.js, line 394

Example
const descriptor = await nillionClient.cluster_information();
const prime = descriptor.prime;