# SolidScript

> TypeScript smart-contract toolchain for generating, checking, and deploying Solidity.

## Docs

- [solidscript audit — Run native rules and Slither analysis](https://docs.solidscipt.zoracle.xyz/commands/audit.md): audit combines SolidScript's native rules with Slither and remaps diagnostics to TypeScript source locations via source maps. Key flags: --strict, --out.
- [solidscript audit-pack — Bundle contracts for auditors](https://docs.solidscipt.zoracle.xyz/commands/audit-pack.md): audit-pack writes per-contract bundles containing TypeScript source, generated Solidity, source maps, reports, and Slither output for auditor handoff.
- [solidscript build — Transpile TypeScript to Solidity](https://docs.solidscipt.zoracle.xyz/commands/build.md): build reads TypeScript contracts and writes generated Solidity artifacts. Key flags: --out to set the output dir, --no-optimize to skip optimizer passes.
- [solidscript compile — Compile Solidity to ABI and bytecode](https://docs.solidscipt.zoracle.xyz/commands/compile.md): compile runs solc over generated Solidity and writes ABI and bytecode artifacts for deployment and Etherscan source verification. Key flag: --out.
- [solidscript config — Manage user-level configuration](https://docs.solidscipt.zoracle.xyz/commands/config.md): config reads and writes user-level settings in ~/.solidscript/config.json. Key subcommands: set, get, list, unset. Stores API keys and network defaults.
- [solidscript deploy — Deploy a contract to an EVM network](https://docs.solidscipt.zoracle.xyz/commands/deploy.md): deploy sends a compiled contract to any EVM network. Uses browser wallet by default. Key flags: --network, --args, --wallet, --no-browser, --no-verify.
- [solidscript doctor — Check your toolchain health](https://docs.solidscipt.zoracle.xyz/commands/doctor.md): doctor reports the status of every tool SolidScript depends on — Node, solc, Slither, Forge, and Anvil. Run --fix to auto-install managed tools.
- [solidscript gasdiff — Measure optimizer impact on bytecode](https://docs.solidscipt.zoracle.xyz/commands/gasdiff.md): gasdiff builds your contracts twice — with and without optimizer passes — compiles both, and reports bytecode size differences per contract.
- [solidscript init — Scaffold a new project](https://docs.solidscipt.zoracle.xyz/commands/init.md): init scaffolds a ready-to-run SolidScript project with a starter contract, solidscript.config.ts, tsconfig.json, package scripts, and .gitignore.
- [solidscript secure-deploy — Verify then deploy atomically](https://docs.solidscipt.zoracle.xyz/commands/secure-deploy.md): secure-deploy runs all security gates and deploys only if they all pass. Key flags: --contract, --network, --args, and per-gate --no-* flags.
- [solidscript test — Run Forge-backed contract tests](https://docs.solidscipt.zoracle.xyz/commands/test.md): test transpiles your .t.ts TypeScript test files into Forge-compatible Solidity tests and runs them. Key flags: --pattern, --tests, --contracts, --root.
- [solidscript trace — Rewrite traces to TypeScript locations](https://docs.solidscipt.zoracle.xyz/commands/trace.md): trace reads Forge or compiler output and rewrites .sol:line references to .ts:line using source maps. Key flags: --input, --sourcemap-dir.
- [solidscript validate — Static-check TypeScript contracts](https://docs.solidscipt.zoracle.xyz/commands/validate.md): validate runs SolidScript's native rules to catch smart-contract footguns before compile or deploy. Key flag: --secure escalates warnings to errors.
- [solidscript verify — Run the security verification pipeline](https://docs.solidscipt.zoracle.xyz/commands/verify.md): verify runs the security pipeline — SMTChecker, Slither, fuzz, invariants, patterns — and exits nonzero on failure. Key flags: --skip, --fuzz-runs.
- [solidscript verify-source — Submit to a block explorer](https://docs.solidscipt.zoracle.xyz/commands/verify-source.md): verify-source submits the compiled contract source to an Etherscan-family explorer. Key flags: --network, --address, --args, --api-key.
- [solidscript wallet — Manage local development wallets](https://docs.solidscipt.zoracle.xyz/commands/wallet.md): wallet creates, lists, and inspects local hot wallets stored under ~/.solidscript/wallets/. Use these for Anvil and testnet deploys only.
- [Deploy EVM smart contracts using your browser wallet](https://docs.solidscipt.zoracle.xyz/concepts/browser-wallet.md): SolidScript's browser wallet flow lets you sign deployment transactions with MetaMask, Rabby, or Coinbase Wallet without storing private keys on disk.
- [How TypeScript contract decorators work in SolidScript](https://docs.solidscipt.zoracle.xyz/concepts/decorators.md): Decorators let you declare storage, access control, reentrancy guards, payable entrypoints, and invariant tests directly on TypeScript class members.
- [Multi-chain EVM contract deployment with SolidScript](https://docs.solidscipt.zoracle.xyz/concepts/multi-chain.md): SolidScript targets any EVM network by name. Five chains are built in, and you can add any chain in solidscript.config.ts with an RPC URL and chain ID.
- [SolidScript's nine-gate security verification pipeline](https://docs.solidscipt.zoracle.xyz/concepts/security-pipeline.md): Every verify and secure-deploy run passes contracts through nine gates covering static analysis, symbolic execution, fuzzing, and attestation.
- [TypeScript to Solidity type mapping in SolidScript](https://docs.solidscipt.zoracle.xyz/concepts/type-mapping.md): SolidScript maps a small set of TypeScript types to their Solidity equivalents so you write contracts in familiar syntax without losing EVM precision.
- [Troubleshoot SolidScript setup and deploy failures](https://docs.solidscipt.zoracle.xyz/guides/troubleshooting.md): Diagnose and fix setup, build, deploy, and verification errors in SolidScript, including missing tools, type errors, and Etherscan submission failures.
- [Verify a deployed SolidScript contract on Basescan](https://docs.solidscipt.zoracle.xyz/guides/verifying-on-basescan.md): Learn how to verify deployed SolidScript contracts on Basescan using a single Etherscan v2 API key that works across all supported EVM networks.
- [Add custom validation rules with a SolidScript plugin](https://docs.solidscipt.zoracle.xyz/guides/writing-a-plugin.md): Plugins let you add organization-specific validator rules and optimizer passes that run alongside SolidScript's built-in checks on every build.
- [Write and run Forge invariant tests with @invariant](https://docs.solidscipt.zoracle.xyz/guides/writing-an-invariant.md): Use the @invariant decorator to express properties that must hold after any sequence of calls, then let SolidScript generate and run Forge invariant tests.
- [Install SolidScript and configure the native toolchain](https://docs.solidscipt.zoracle.xyz/install.md): Add the SolidScript npm package and run one command to download the compiler, security analyzers, and Foundry tools your pipeline needs.
- [SolidScript: write EVM smart contracts in TypeScript](https://docs.solidscipt.zoracle.xyz/introduction.md): SolidScript is a TypeScript smart-contract toolchain for developers who want a safe, checked path to EVM deployment without writing raw Solidity.
- [Deploy your first SolidScript contract to Base Sepolia](https://docs.solidscipt.zoracle.xyz/quickstart.md): Walk through every step from an empty directory to a verified, browser-wallet-deployed ERC-20 contract on Base Sepolia in five commands.
- [SolidScript CLI command reference: every subcommand](https://docs.solidscipt.zoracle.xyz/reference/all-commands.md): Every SolidScript CLI subcommand at a glance — what each command does, its required arguments, and links to full flag documentation and examples.
- [SolidScript TypeScript library: full API reference](https://docs.solidscipt.zoracle.xyz/reference/library-api.md): Complete reference for SolidScript's TypeScript imports: contract types, decorators, compiler pipeline exports, crypto helpers, and standard implementations.