Practical overview
When it fits
Use Locklift when a TVM contract project needs a CLI workflow for setup, compilation, network configuration, automated tests or scripted contract interaction.
Who it is for
- Developers building or maintaining Everscale or Venom TVM smart contracts.
- Teams that want a project workflow for contract compilation, network-specific tests and scripted interactions.
Documented uses
- Initialize a sample contract project with configuration, scripts and tests.
- Compile and link project contracts using configured TVM tooling.
- Run Mocha contract tests against a configured network.
- Manage network settings and execute scripts in a specified environment.
- Associate external contracts with ABI and address or code-hash configuration for interaction.
Requirements & limits
The documented installation uses npm, and the quick start requires Node.js 14 or later. The repository identifies the project as Apache-2.0 licensed.
- The project requires Node.js 14 or later; installation and initialization use npm and the Locklift CLI.
- Contract builds depend on a configured TON Solidity compiler and TVM linker.
- Network connection, blockchain configuration and any required giver credentials must be supplied in the project configuration.
- The README cautions developers not to commit key phrases.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install and initialize a Locklift project
Add Locklift to an npm project and create its sample project structure.
Before you start
- Node.js 14 or later
- An empty project folder and npm
Steps
Initialize an npm project in the folder.
Install Locklift as a development dependency with the command below.
npm install --save-dev lockliftRun the command below to initialize the current directory, or use the command below to create a project at a specified path.
npx locklift init -fnpx locklift init --path
Expected outcome
An initialized project with sample contract, configuration, deployment-script and test files.
Guide limitations
- This setup does not configure a network, compiler or linker for building or testing contracts.
Build contracts and run Mocha tests
Build project contracts and run the configured test suite against a selected network.
Before you start
- An initialized Locklift project
- A configured TON Solidity compiler and TVM linker
- A configured network; the documented test command uses
local
Steps
Configure the compiler, linker and network in
locklift.config.ts.Run the command below to build project contracts.
npx locklift buildRun the command below to execute the Mocha tests.
npx locklift test --network local
Expected outcome
The build command compiles and links project contracts; the test command runs the project’s Mocha suite on the selected network.
Guide limitations
- The local network must be configured for the project.
- The README’s example output is illustrative and does not establish that a particular project or environment will build or pass.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 9 October 2026
- Original website title
- broxus/locklift · Official homepage title · retained in its source language