BIP340 - Perform MPC keygen

POST 
/bip340/keygen

Generate secret shares for the given number of parties and threshold, using the given key_id, as well as a public key. Keygen does not return anything 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

key_id KeyIdrequired
num_parties uint16required

Possible values: >= 1

others_keygen_ids string[]required

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_uuid stringrequired
threshold uint16required

Possible values: >= 1

Responses

200

400

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [already_performed_keygen, api_key_not_found, bad_n_and_t_params, bad_request_params, batch_too_large, executor_result, key_id_not_exists, key_operation_before_keygen, policy_in_use_by_keys, policy_in_use_by_users, policy_not_found, policy_validation_failed, room_creation_problem, rule_in_use, rule_not_found, rule_not_in_policy, server_share_backup_setting_disabled, unique_violation, user_has_associated_keys, user_id_not_exists, user_name_already_exists, you_have_to_be_admin]

Example (from schema)

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

401

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [access_denied]

Example (from schema)

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

404

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [not_found]

Example (from schema)

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

500

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [internal_problem]

Example (from schema)

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

Loading...