Freezing An Amount On A Utxo Based Blockchain

Basic Description

This endpoint is used to freeze funds on a UTXO-based blockchains in Taurus-PROTECT via a Change. Freezing funds may be used for compliance purposes and can be done on any UTXO-based blockchain.

This endpoint would accept a POST Request with a JSON payload containing the Change details.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them.

Here is the list of required Roles for this particular endpoint:

• Admin
• TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

Certain API endpoints require specific input parameters. Every UTXO can be individually identified by blockchain. Due to this, "utxoid" and "utxoblockhain" are the two parameters in "changes".

Call Example

You can find a basic example in cURL below. Here, we are freezing funds on Litecoin, a UTXO based blockchain. Every UTXO can be individually identified by blockchain and frozen.

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/changes" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken" \
--data '{  
    "action": "create",  
    "entity": "manualutxofreeze",  
    "changes": {  
        "utxoid": "1188",  
        "utxoblockchain": "LTC"  
    },  
    "changeComment": "Freezing for compliance purposes"  
}'

This piece of code sends a POST request to https://your-protect-instance.example.com/api/rest/v1/changes with the JSON string in the request body.

👍

Call Result

A successful response for the POST call to create a change for freezing funds might look like this:

{
    "result": {
        "id": "4626"
    }
}

In this example, Taurus-PROTECT has provisionally created a new change for the admin quorum to review, and has assigned the relevant Change the unique ID of "4626".

Requirements for Future Use

For this particular endpoint, we do not have any storage requirements other than the Changeid that is included in the JSON Body Response. This id will be used to Approve the Change with a different Admin in the next steps.

You can find the Swagger-generated page for this endpoint in the following link.