tmkms-stack/stack-orchestrator/stacks/tmkms
2025-06-11 19:07:47 +05:30
..
README.md Update script to check for existing priv validator key 2025-06-11 19:07:47 +05:30
stack.yml Update script to check for existing priv validator key 2025-06-11 19:07:47 +05:30

tmkms

Instructions for running TMKMS service

Prerequisites

Setup

  • Clone the stack repo:

    laconic-so fetch-stack git.vdb.to/LaconicNetwork/tmkms-stack --git-ssh --pull
    
  • Build the container images:

    laconic-so --stack ~/cerc/tmkms-stack/stack-orchestrator/stacks/tmkms build-containers --force-rebuild
    

    This should create the cerc/tmkms docker image locally

Create a deployment

  • Create a spec file for the deployment:

    laconic-so --stack ~/cerc/tmkms-stack/stack-orchestrator/stacks/tmkms deploy init --output tmkms-spec.yml
    
  • Create deployment from the spec file:

    laconic-so --stack ~/cerc/tmkms-stack/stack-orchestrator/stacks/tmkms deploy create --spec-file tmkms-spec.yml --deployment-dir tmkms-deployment
    

Configuration

  • Copy the private validator key to the tmp directory:

    cp <path/to/priv_validator_key.json> tmkms-deployment/data/tmkms-data/tmp
    
  • Inside the tmkms-deployment deployment directory, open config.env file and set following env variables:

    # Chain ID
    CHAIN_ID=
    
    # Public IP address of the node
    NODE_IP=
    
    # Port on which the node is listening for consensus messages (default: 26659)
    NODE_PORT=
    
    # Key prefix
    KEY_PREFIX=
    

Run

  • Start the deployment:

    laconic-so --dir tmkms-deployment start
    
  • Check the logs:

    laconic-so --dir tmkms-deployment logs -f
    

Clean up

  • Stop the deployment:

    laconic-so --dir tmkms-deployment stop
    
  • To stop the deployment and also delete data:

    laconic-so --dir tmkms-deployment stop --delete-volumes
    
    sudo rm -rf tmkms-deployment
    
  • Remove cerc/tmkms docker image:

    docker rmi cerc/tmkms:local