Introduction

The Tokamak Rollup Hub SDK is a command-line tool that allows users to easily deploy Layer 2 appchains or rollups using the available stacks and integration options within the Tokamak ecosystem, providing a seamless and deployer-friendly experience.

One thing to note here is the current SDK is available in MacOS and Linux .

This guide is structured into four main stages:

  1. SDK Setup – Installing and configuring the SDK for first-time use.
  2. Devnet Deployment – Deploying a local appchain instance on your machine for development and testing purposes.
  3. Testnet Deployment – Launching an appchain using Sepolia Ethereum as the Layer 1 and TON as the native gas token. More gas token options will be added in the future.
  4. Mainnet Deployment (Steps will be added soon) – Deploying an appchain on Ethereum mainnet with TON as the native gas token. Additional gas token options will be supported in future updates.

Hardware requirements

CPU RAM Storage
Minimum 2 vCPU 8 20
Recommended 4 vCPU 16 50
Excellent 8 vCPU 32 50

Set up the SDK

  1. Download the setup.sh file

    curl [<https://raw.githubusercontent.com/tokamak-network/trh-sdk/main/setup.sh>](<https://raw.githubusercontent.com/tokamak-network/trh-sdk/main/setup.sh>) > setup.sh

  2. Run the setup.sh file

    chmod +x setup.sh
./setup.sh

  3. Source the shell config

    MacOS

    source ~/.zshrc

    Linux

    source ~/.bashrc

  4. Verify the installation

    trh-sdk version

## The expected output of this command
v0.0.0-${commit-id}

ℹ️ Please use sudo for every command for our sdk.
e.g. sudo trh-sdk deploy

Please refer to the troubleshooting guide for common issues. If your issue isn't listed, reach out via help form or Discord.