Liminal provides Liminal Express, a Docker image designed as a wrapper for the Liminal SDK. This image allows developers to seamlessly access SDK functionalities within a Docker container. It runs on any system with Docker support, eliminating the need for manual environment or dependency setup.

❗️
Warning
If you are currently using or updating to a Liminal Express SDK version 1.2.19 or higher, please refer to the expected breaking changes that may occur if you whitelist the Express Server IP address associated with your API key.

Refer to the Caveat section to update your Docker image as required.

Refer to the changelog to learn about the expected breaking change behavior.

Refer to the Liminal Express API (Production) changelog for the latest version.

Take the following steps to update the Liminal Express version.

1. Check the MPC version.

Run the following command to check the TSM-Version of your MPC Docker image.

curl http://localhost:8000/version

The response from this command will provide the TSM-Version, which you will need for the next step.

2. Stop and delete the Liminal Express container

Run the following command, replacing container_id with the actual container ID of your Liminal Express container.

docker stop container_id && docker rm container_id

📘
Note

Do not delete the MPC Docker image.

3. Pull the latest image

Run the following command to pull the latest Docker image of Liminal Express. Refer to Liminal Express API changelog to view the list of all Liminal Express versions for production and development environments in chronological order.

Use the following command for the latest version 1.3.16 in the production environment:

docker pull 641754881946.dkr.ecr.us-west-2.amazonaws.com/liminal-sdk-api:1.3.16

📘
Note

For any permission-related issues, run the following command to pull the new image.

aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 641754881946.dkr.ecr.us-west-2.amazonaws.com

4. Start the Docker container

Start the Docker container with the following command, replacing the placeholders with your specific configuration details:

docker run --restart=on-failure -e AWS_DEFAULT_REGION=YOUR_AWS_DEFAULT_REGION 
            -e REGION=YOUR_AWS_DEFAULT_REGION 
            -e NODE_ENV=prod 
            -e TSM_URL=YOUR_TSM_URL 
	        -e TSM_VERSION=YOUR_MPC_VERSION 
            -e TSM_USER_ID=YOUR_TSM_USER_ID 
            -e TSM_PASSWORD=YOUR_TSM_PASSWORD
            -e TRANSACTION_SIGN_SUBMIT_JOB_INTERVAL_MINUTE=1
            -e TSM_PUBLIC_KEY=YOUR_TSM_PUBLIC_KEY 
            -p 8081:8081 -d 641754881946.dkr.ecr.us-west-2.amazonaws.com/liminal-sdk-api:1.3.16

📘
Note
TRANSACTION_SIGN_SUBMIT_JOB_INTERVAL_MINUTE=1 is used for v2 withdrawal wallets.
This is the interval at which the CRON job runs in Liminal for submitting fully approved Firewall transactions, using the Start or stop transaction execution API.
Ensure to replace the placeholders with your specific configuration details.
YOUR_AWS_DEFAULT_REGION: Replace with your AWS default region.  
YOUR_TSM_VERSION: Replace with your TSM version obtained from Step 1.  
YOUR_TSM_URL: Replace with the URL of your TSM.  
YOUR_TSM_USER_ID: Replace with your TSM user ID.  
YOUR_TSM_PASSWORD: Replace with your TSM password.  
YOUR_TSM_PUBLIC_KEY: Replace with your TSM public key.
Ensure to use the same version of the Liminal Express in the following configuration as you did in step 3.
 -p 8081:8081 -d 641754881946.dkr.ecr.us-west-2.amazonaws.com/liminal-sdk-api:1.3.16

5. Verify the new Liminal Express version.

Run the following cURL command to ensure that you have successfully updated the version.

curl http://localhost:8081/info