Create Policy Id

POST /wallets/{walletId}/policy-id

status: stable

Create policy id for the wallet and a given mint/burn script.

Path parameters

walletId string(hex) Required

Minimum length is 40, maximum length is 40.

application/json

Body Required

policy_script_template string | object Required
One of:
Cosigner string All object Any object Some object Active from slot object Active until slot object

Leaf value for a script designating a cosigner co-sharing the script.

Format should match the following pattern: ^(cosigner#)[0-9]*$.
Hide attribute Show attribute

all array[string | object] Required

Script primitive for which all signing keys corresponding to all list cosigners' verification keys are expected to make the script valid.

At least 1 element.

One of:
Cosigner string All object Any object Some object Active from slot object Active until slot object

Leaf value for a script designating a cosigner co-sharing the script.

Format should match the following pattern: ^(cosigner#)[0-9]*$.

Hide attribute Show attribute

some object Required

Script primitive for which at least a given number of signing keys corresponding to the list cosigners' verification keys are expected to make the script valid.

Hide some attributes Show some attributes object

at_least integer Required

Minimum value is 1, maximum value is 255.

from array Required

At least 1 element.
Hide attribute Show attribute

any array[string | object] Required

Script primitive for which a signing key corresponding to any of the list cosigners' verification keys is expected to make the script valid. It is equivalent to some with "at_least"=1.

At least 1 element.

One of:
Cosigner string All object Any object Some object Active from slot object Active until slot object

Leaf value for a script designating a cosigner co-sharing the script.

Format should match the following pattern: ^(cosigner#)[0-9]*$.

Hide attribute Show attribute

some object Required

Script primitive for which at least a given number of signing keys corresponding to the list cosigners' verification keys are expected to make the script valid.

Hide some attributes Show some attributes object

at_least integer Required

Minimum value is 1, maximum value is 255.

from array Required

At least 1 element.
Hide attribute Show attribute

some object Required

Script primitive for which at least a given number of signing keys corresponding to the list cosigners' verification keys are expected to make the script valid.

Hide some attributes Show some attributes object

at_least integer Required

Minimum value is 1, maximum value is 255.

from array[string | object] Required

At least 1 element.

One of:
Cosigner string All object Any object Some object Active from slot object Active until slot object

Leaf value for a script designating a cosigner co-sharing the script.

Format should match the following pattern: ^(cosigner#)[0-9]*$.

Hide attribute Show attribute

some object Required

Script primitive for which at least a given number of signing keys corresponding to the list cosigners' verification keys are expected to make the script valid.

Hide some attributes Show some attributes object

at_least integer Required

Minimum value is 1, maximum value is 255.

from array Required

At least 1 element.
Hide attribute Show attribute

active_from integer Required

Transaction is only valid starting at the specified slot number (≥ active_from).

Minimum value is 0.
Hide attribute Show attribute

active_until integer Required

Transaction is only valid before the specified slot number (< active_until).

Minimum value is 0.

Responses

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.
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.
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.
403 application/json

Forbidden
One of:
invalid_wallet_type object missing_policy_public_key object created_wrong_policy_script_template object
Hide attributes Show attributes

message string Required

May occur when trying to perform an operation not supported by this type of wallet.

code string Required

Value is invalid_wallet_type.
Hide attributes Show attributes

message string Required

Occurs when trying to construct with minting/burning on shelley wallet without policy public key.

code string Required

Value is missing_policy_public_key.
Hide attributes Show attributes

message string Required

Occurs when a policy script template either does not pass validation or has more than one cosigner.

code string Required

Value is created_wrong_policy_script_template.
202 application/json

Accepted
Hide response attribute Show response attribute object
- policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.

POST /wallets/{walletId}/policy-id

curl \
 --request POST https://localhost:8090/v2/wallets/{walletId}/policy-id \
 --header "Content-Type: application/json" \
 --data '{"policy_script_template":"string"}'

Request examples

{
  "policy_script_template": "string"
}

Response examples (415)

{
  "message": "string",
  "code": "an_error_code"
}

Response examples (406)

{
  "message": "string",
  "code": "not_acceptable"
}

Response examples (400)

{
  "message": "string",
  "code": "bad_request"
}

Response examples (403)

{
  "message": "string",
  "code": "invalid_wallet_type"
}

{
  "message": "string",
  "code": "missing_policy_public_key"
}

{
  "message": "string",
  "code": "created_wrong_policy_script_template"
}

Response examples (202)

{
  "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b"
}

Create Policy Id

Path parameters

Body Required

policy_script_template string | object Required

Responses