Cluster BIP340 - Perform MPC keygen

POST 
/cluster/bip340/keygen

Generate secret shares for the given number of parties and threshold, using the given cluster_name. This is a cluster keygen operation, which means that the keygen is performed with the parties in the cluster. Keygen returns a new key_id to the caller. The secret share is generated and stored by the Vertex. The secret share can then be used to sign messages and perform other key operations using the same key_id.

Request

Header Parameters

AUTHORIZATION stringrequired

The AUTHORIZATION header must be set to the API Key of the user. The API Key is returned when a new user is created using the /admin/create-user endpoint.

application/json

Body

required

cluster_namestringrequired

The name of the cluster

num_partiesuint16required

Possible values: >= 1

relay_address

object

An Optional relay address to use only for this specific MPC operation. If not provided, the default relay address will be used. The relay address should be in the format of host:port.

anyOf

HostAddress

string

room_uuidstringrequired
thresholduint16required

Possible values: >= 1

Responses

200

application/json

Schema

Schema

key_idKeyIdrequired

Example (from schema)

{
  "key_id": "string"
}

400

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [already_performed_keygen, api_key_not_found, bad_n_and_t_params, bad_request_params, batch_too_large, cluster_already_exists, cluster_not_found, executor_result, invalid_domain, key_not_found, key_operation_before_keygen, policy_already_exists, policy_in_use_by_keys, policy_in_use_by_users, policy_not_found, policy_validation_failed, room_creation_problem, rule_already_exists, rule_in_use, rule_not_found, rule_not_in_policy, server_share_backup_setting_disabled, server_share_backup_setting_incompatible, user_already_exists, user_has_associated_keys, user_not_found, vertex_already_exists, vertex_not_found, you_have_to_be_admin]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "already_performed_keygen"
}

401

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [access_denied]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "access_denied"
}

404

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "not_found"
}

500

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [internal_problem]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "internal_problem"
}