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. You write contracts as TypeScript classes, and SolidScript emits Solidity, runs security checks, compiles bytecode, and deploys to EVM chains. It targets TypeScript developers who want a restricted, checked path into smart-contract development without starting in raw Solidity. This page introduces the core idea, shows the flagship example, and points you to the next steps.
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);
  }
}
The tradeoff is intentional: SolidScript does not expose every Solidity edge case. It gives you a smaller authoring surface, OpenZeppelin-backed defaults, and a deploy flow that keeps private keys out of project files.

​
What the pipeline gives you

  • OpenZeppelin inheritance auto-wired by decorators such as @onlyOwner
  • Constructor base arguments injected where SolidScript owns the mapping
  • Native validation for common footguns such as tx.origin auth and unchecked low-level calls
  • Solc compilation, SMTChecker, Slither, fuzz harnesses, invariant tests, and build attestation
  • Source maps from generated Solidity back to TypeScript
  • Browser-wallet deploys for MetaMask, Rabby, and Coinbase Wallet

​
Where to go next

Install

Add the package and let doctor --fix prepare native tools.

Quickstart

Build, verify, compile, and deploy a contract to Base Sepolia.

Decorators

Learn how contract behavior is declared in TypeScript.

Commands

Scan every CLI command and flag from the manifest.