Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.solidscipt.zoracle.xyz/llms.txt

Use this file to discover all available pages before exploring further.

SolidScript is a TypeScript smart-contract toolchain for EVM developers. You write contracts as TypeScript classes, and SolidScript handles the rest: emitting Solidity, running security checks, compiling to bytecode, and deploying through MetaMask, Rabby, or Coinbase Wallet — no private keys in project files.

Install

Install the npm package and run doctor --fix to set up the compiler and security tools.

Quickstart

Build, verify, compile, and deploy your first contract to Base Sepolia in minutes.

Decorators

Learn how @storage, @onlyOwner, @nonReentrant, and other decorators declare contract behavior.

Security Pipeline

Understand the nine verification gates that run before every production deploy.

CLI Commands

Reference for every solidscript CLI command and its flags.

Library API

TypeScript types, decorators, runtime globals, and compiler pipeline exports.
1

Install SolidScript

npm install solidscript
npx solidscript doctor --fix
2

Initialize a project and write a contract

npx solidscript init
contracts/MyToken.ts
import { Address, onlyOwner, msg } from "solidscript";
import { ERC20 } from "solidscript/standards";

export class MyToken extends ERC20 {
  constructor(initialSupply: bigint) {
    super("MyToken", "MTK");
    this._mint(msg.sender, initialSupply);
  }

  @onlyOwner
  mint(to: Address, amount: bigint): void {
    this._mint(to, amount);
  }
}
3

Build and verify

npx solidscript build contracts
npx solidscript verify contracts --skip fuzz,invariants
npx solidscript compile out/sol
4

Deploy with your browser wallet

npx solidscript deploy MyToken -n base-sepolia -a 1000000
SolidScript opens a local page at http://127.0.0.1:7654/ where your wallet extension signs the deployment transaction.