cardano-wallet-diff

Sign Metadata

POST /wallets/{walletId}/signatures/{role}/{index}

status: experimental

⚠️ WARNING ⚠️

This endpoint is experimental and for internal use in the Catalyst project. This functionality will be refined in the forthcoming future and the interface is likely to change in NON-BACKWARD COMPATIBLE WAYS.

Note: Only Soft indexes are supported by this endpoint.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

  • role string Required

    Values are utxo_external, utxo_internal, or mutable_account.

  • index string Required

    An individual segment within a derivation path.

    The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.

application/json

Body Required

  • passphrase string Required

    A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds)

    Minimum length is 0, maximum length is 255.

  • metadata object | null Required

    Any of:
    full object | null simple object | null

Responses

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a request is not well-formed; that is, it fails to parse successfully. This could be the case when some required parameters are missing or, when malformed values are provided.

    • code string Required

      Value is bad_request.
  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.
  • 415 application/json

    Unsupported Media Type

    Hide response attributes Show response attributes object
    • message string Required

      A descriptive error message.

    • code string Required

      A specific error code for this error, more precise than HTTP ones.
  • 200 application/octet-stream

    OK
POST /wallets/{walletId}/signatures/{role}/{index} 
curl \
 -X POST https://localhost:8090/v2/wallets/{walletId}/signatures/{role}/1852H \
 -H "Content-Type: application/json" \
 -d '{"passphrase":"Secure Passphrase","metadata":{"0":{"string":"cardano"},"1":{"int":14},"2":{"bytes":"2512a00e9653fe49a44a5886202e24d77eeb998f"},"3":{"list":[{"int":14},{"int":42},{"string":"1337"}]},"4":{"map":[{"k":{"string":"key"},"v":{"string":"value"}},{"k":{"int":14},"v":{"int":42}}]}}}'
Request example 
{
  "passphrase": "Secure Passphrase",
  "metadata": {
    "0": {
      "string": "cardano"
    },
    "1": {
      "int": 14
    },
    "2": {
      "bytes": "2512a00e9653fe49a44a5886202e24d77eeb998f"
    },
    "3": {
      "list": [
        {
          "int": 14
        },
        {
          "int": 42
        },
        {
          "string": "1337"
        }
      ]
    },
    "4": {
      "map": [
        {
          "k": {
            "string": "key"
          },
          "v": {
            "string": "value"
          }
        },
        {
          "k": {
            "int": 14
          },
          "v": {
            "int": 42
          }
        }
      ]
    }
  }
}
Response examples (400) 
{
  "message": "string",
  "code": "bad_request"
}
Response examples (406) 
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (415) 
{
  "message": "string",
  "code": "an_error_code"
}