BIP340 - Sign a message using a key share

POST 
/bip340/sign

Signs a message using the given key_id. The message is signed using the secret share generated in the /bip340/keygen operation. The signature is then returned to the caller.

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

derivation_pathuint32[]
extra_datastring

Hex encoded extra data to be passed to the Rule Server. This data should be used to pass any additional information / external state to the Rule Server that is required to properly validate the signing request.

key_idKeyIdrequired
msgstringrequired

The message to be signed. Has to be hex encoded.

room_uuidstringrequired
tweakstring

Responses

200

application/json

Schema

Schema

signaturestringrequired

Example (from schema)

{
  "signature": "string"
}

400

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [already_performed_keygen, 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, user_id_not_exists, 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"
}