Skip to main content
@eco-incorp/sauce/actions reads JSON action programs ({ version, chainId?, actions }), validates them against the JSON Schema exported as @eco-incorp/sauce/actions/action-program.schema.json, and compiles them for a chain. A token field takes a registry symbol and a contract field a namespace reference, beside an address.
Generated from the type declarations of @eco-incorp/sauce.

parseProgram

Function · @eco-incorp/sauce/actions Parses and validates an action program - JSON text, or an already-parsed value. Returns a fresh copy with its keys in canonical order. Throws a ProgramError whose issues lists every problem, each with its path.

serializeProgram

Function · @eco-incorp/sauce/actions The canonical JSON text of program: validated first, keys in schema order, so two equal programs serialize to the same text. space indents as JSON.stringify does.

programSchema

Function · @eco-incorp/sauce/actions The JSON Schema every action program satisfies.

JsonSchema

Type · @eco-incorp/sauce/actions

ProgramError

Class · @eco-incorp/sauce/actions Thrown for a program that breaks any rule. issues lists every problem found, in order; chain is set when they are the compiled chain’s - a name it lacks - rather than the document’s own.

ProgramIssue

Interface · @eco-incorp/sauce/actions One problem with a program, located by a path into the document (actions[2].amountRef).