LoadContractOptions

Defined in: src/Contract.ts:228

Options for loading a contract.

Exactly one of these must be provided:

• module + zkConfig: Direct module and zkConfig (works everywhere)
• path: Load from filesystem path (Node.js only)
• moduleUrl + zkConfigBaseUrl: Load from URLs (browser)

Since

0.2.0

Extended by

• CreateContractOptions

Type Parameters

M

M extends ContractModule = ContractModule

The contract module type (for type inference)

Properties

module?

optional module: M

Defined in: src/Contract.ts:231

Contract module

---

moduleUrl?

optional moduleUrl: string

Defined in: src/Contract.ts:241

URL to contract module JS file

---

path?

optional path: string

Defined in: src/Contract.ts:237

Filesystem path to contract directory (auto-loads module + zkConfig)

---

privateStateId?

optional privateStateId: string

Defined in: src/Contract.ts:249

Override privateStateId (defaults to contract name)

---

witnesses?

optional witnesses: Record<string, unknown>

Defined in: src/Contract.ts:247

Witnesses for the contract

---

zkConfig?

optional zkConfig: ZKConfigProvider<string>

Defined in: src/Contract.ts:233

ZK configuration provider for this contract

---

zkConfigBaseUrl?

optional zkConfigBaseUrl: string

Defined in: src/Contract.ts:243

Base URL for ZK artifacts