@eco-incorp/sauce package reference

@eco-incorp/sauce includes a TypeScript library, the sauce command, an MCP server and agent skills. This reference lists the TypeScript exports by import path. For a working example, start with the TypeScript guide. To choose between the library, terminal and agent tools, read the SDK overview.

Requirements

Follow Installation for Node.js requirements, package setup and optional runtime dependencies. The package pins the SauceScript compiler, @eco-incorp/sauce-compiler, at exactly 2.6.1 and installs it as a dependency. The SDK pins that compiler with the engine and Kitchen releases its output runs on, one release set per compiler version; more than one compiler version can share an engine and Kitchen, and Pot addresses follow the Kitchen release. Every SDK builder that names an engine refuses one that the release sets record only for other compilers (Compiler and engine pairing). @modelcontextprotocol/sdk, zod and litesvm are optional peer dependencies: sauce mcp loads the first two, and a Solana simulation or a /testing Solana chain loads litesvm. For the sauce command, sauce runtime install installs them; a test that runs Solana needs litesvm installed in its own project.

Subpaths

Every import path is a suffix of @eco-incorp/sauce; . is the package root. The package’s exports map defines this list. routes, token, deposit and contracts are namespaces of the root, not subpaths.

Import	Contents	Reference
`.`	Chain exports (`Base`, `Solana`, …), `chain` and `Token`; the namespaces `routes`, `token`, `deposit`, `contracts` and `svmVenues`; chain and protocol queries; `v12PredictPot`, `potSalt`, `DEFAULT_POT_SALT`, `kitchenExecutionFee`; `sqrtPriceX96FromPrice`, `priceFromSqrtPriceX96`; `ready`	routes, token, deposit, contracts, helpers
`/compiler`	`compile`, `ready`, the compiler’s types, `resolveSdkModule` and `resolveSdkPackage`	compiler
`/actions`	JSON action programs: parsing, validation and compilation for a chain	actions
`/actions/action-program.schema.json`	The JSON Schema of an action program	actions
`/protocols/<slug>`	One protocol’s `protocolInfo`, `deployments`, ABIs and named SauceScript templates	protocols
`/chains`	Canonical chain identities and EVM chain metadata	chains
`/deployments`	Release addresses, Pot derivation inputs, and which engine runs which compiler’s output	deployments
`/recipes`	`settleSource`, the EVM settle program’s text	recipes
`/recipes/settle.sauce.ts`	The EVM settle program file	recipes
`/skills`	Each protocol’s Markdown document and their index, as text	protocols
`/svm`	Solana: the client, clusters, PDAs, account resolution, Kitchen instructions, transactions, token accounts, venue adapters	svm, svm venues
`/svm/engine`	The Solana engine’s wire format and instruction builders	svm
`/svm/engine-artifacts`	File paths to the packaged Solana engine and Kitchen binaries and the Kitchen IDL	svm
`/svm/verify`	Settle program and engine CPI verification on Solana	svm
`/svm/recipes/settle.sauce.ts`	The Solana settle program file	svm
`/evm/engine`	EVM Pot and Kitchen ABIs, call encoders, `potRouterUpdate`	evm/engine
`/verify`	EVM settle payload encoding, decoding and validation against the pinned program	verify
`/testing`	Running programs on a forked or empty local chain from a test	testing
`/sauce-script`	Types only: SauceScript’s builtins, chains and ABI modules, for an editor checking `*.sauce.ts` files	Builtins

import { routes, Base, requireChain } from "@eco-incorp/sauce";
import { compile, ready } from "@eco-incorp/sauce/compiler";
import { v12EngineAddress, v12KitchenAddress } from "@eco-incorp/sauce/deployments";
import { v12Pot } from "@eco-incorp/sauce/evm/engine";
import { createSauceSvmClient } from "@eco-incorp/sauce/svm";
import { validateSettleProgram } from "@eco-incorp/sauce/verify";

Each chain is a named export of the root. Importing the package puts nothing on globalThis. Bare names such as USDC and UniswapV3 are SauceScript syntax, which routes.compileSauceProgram, the sauce command, the MCP server and actions documents resolve before the compiler runs; in TypeScript the same registry entries are on the chain export (Base.USDC). See Names and Compiler or SDK.

Where each import runs

Every import runs in Node.js and in a browser except two, which are Node.js only:

/svm/engine-artifacts returns file system paths to the packaged binaries.
/testing starts a local anvil or LiteSVM chain.

In a browser, call await ready() once before anything that compiles: /compiler, routes.compileSauceProgram, the token and deposit builders, /recipes, /actions and /svm/verify. In Node.js nothing needs it. /verify never loads the compiler; it depends on viem only. No import carries an RPC endpoint. Every client you build takes its connection from you. The sauce command is the exception: it falls back to public endpoints of its own, which no import exposes.

How the reference is organized

Each sidebar group is a namespace or subpath, with one page per source module. An entry gives the export’s name, its kind, the import paths it is exported from, its doc comment and its TypeScript declaration. Declarations longer than 6,000 characters (large ABI constants) are truncated with a marker. Declarations re-exported from dependencies (viem, @solana/kit, the compiler) are listed by name on the page of the subpath that re-exports them. Protocol subpaths share one shape, shown for uniswap-v3. Release addresses are listed once, on Deployments.

Next steps

TypeScript

Compile a program for a chain and build its cook from TypeScript.

routes

compileSauceProgram, encodeEntryArguments, buildSauceEvmCall.

Compiler package

compile, its options, CompileResult, errors and ready().

Deployments

Engine, Kitchen and Router addresses of the pinned release.

Start here

Integration guides

Language reference

SauceScript libraries

Runtime and security

Troubleshooting and production

Chains and protocols

@eco-incorp/sauce

@eco-incorp/sauce-compiler

@eco-incorp/sauce package reference

Requirements

Subpaths

Where each import runs

How the reference is organized

Next steps

TypeScript

routes

Compiler package

Deployments

​Requirements

​Subpaths

​Where each import runs

​How the reference is organized

​Next steps

TypeScript

routes

Compiler package

Deployments

Requirements

Subpaths

Where each import runs

How the reference is organized

Next steps