VaultCheckSettings

Documentation for eth_defi.vault_report.vault_checks.VaultCheckSettings Python class.

class VaultCheckSettings

Bases: object

How to run the investability check.

Built from environment variables by from_env() in the operator scripts generate-monthly-vault-report.py and check-top-list-vaults.py.

Attributes summary

agent

Agent CLI, or None to only reuse existing decisions (VAULT_CHECK_AGENT=reuse); a round without reusable decisions then fails instead of spending tokens

model

Model override for the agent CLI; Claude CLI defaults to CLAUDE_CHECK_MODEL

effort

Thinking effort override for Claude CLI, defaults to CLAUDE_CHECK_EFFORT

reuse_dirs

Directories searched for reusable decisions, in addition to the report bundle

overrides_path

Hand-written decisions that override the agent, e.g.

timeout

Agent timeout per round, in seconds; the whole process group is killed after it

repository_root

Repository root the agent runs in; the skill, flag.py and the probe scripts are found from here

max_workers

Parallel threads for the deterministic probes

Methods summary

__init__([agent, model, effort, reuse_dirs, ...])

from_env([default_agent])

Read the settings from environment variables.
agent: Optional[Literal['claude', 'codex']]

Agent CLI, or None to only reuse existing decisions (VAULT_CHECK_AGENT=reuse); a round without reusable decisions then fails instead of spending tokens

model: Optional[str]

Model override for the agent CLI; Claude CLI defaults to CLAUDE_CHECK_MODEL

effort: Optional[str]

Thinking effort override for Claude CLI, defaults to CLAUDE_CHECK_EFFORT

reuse_dirs: list[pathlib.Path]

Directories searched for reusable decisions, in addition to the report bundle

overrides_path: Optional[pathlib.Path]

Hand-written decisions that override the agent, e.g. from an editor’s review

timeout: float

Agent timeout per round, in seconds; the whole process group is killed after it

repository_root: pathlib.Path

Repository root the agent runs in; the skill, flag.py and the probe scripts are found from here

max_workers: int

Parallel threads for the deterministic probes

classmethod from_env(default_agent='none')

Read the settings from environment variables.

See the Investability check section of README-vault-report.md for the variables: VAULT_CHECK_AGENT, VAULT_CHECK_MODEL, VAULT_CHECK_EFFORT, VAULT_CHECK_DECISIONS, VAULT_CHECK_OVERRIDES, VAULT_CHECK_TIMEOUT (minutes) and MAX_WORKERS.

reuse runs the check without an agent: it only accepts saved decisions that match the current candidates, which is how an editor reruns the report with overrides without paying for another agent run.

Parameters

default_agent (str) – VAULT_CHECK_AGENT when unset: claude, codex, reuse or none. The report script defaults to none, so a plain run costs no LLM tokens; check-top-list-vaults.py defaults to claude.

Returns

Settings, or None when the check is disabled with none.

Return type

Optional[eth_defi.vault_report.vault_checks.VaultCheckSettings]

__init__(agent=None, model=None, effort=None, reuse_dirs=<factory>, overrides_path=None, timeout=3600.0, repository_root=PosixPath('/home/runner/work/web3-ethereum-defi/web3-ethereum-defi'), max_workers=8)
Parameters
Return type

None