Add dataset card with schema, provenance, B2/B3 mitigations

README.md

@@ -1,76 +1,98 @@
 ---
-dataset_info:
-- config_name: full
-  features:
-  - name: task_id
-    dtype: large_string
-  - name: domain
-    dtype: large_string
-  - name: contract_name
-    dtype: large_string
-  - name: contract_address
-    dtype: large_string
-  - name: pragma
-    dtype: large_string
-  - name: pragma_major_minor
-    dtype: large_string
-  - name: resolved_solc_version
-    dtype: large_string
-  - name: target_function_signature
-    dtype: large_string
-  - name: prompt_context
-    dtype: large_string
-  - name: workspace_tar
-    dtype: large_string
-  - name: scoring_tar
-    dtype: large_string
-  - name: canary_substrings
-    list: string
-  splits:
-  - name: train
-    num_bytes: 134949194
-    num_examples: 3044
-  download_size: 104615982
-  dataset_size: 134949194
-- config_name: lite
-  features:
-  - name: task_id
-    dtype: large_string
-  - name: domain
-    dtype: large_string
-  - name: contract_name
-    dtype: large_string
-  - name: contract_address
-    dtype: large_string
-  - name: pragma
-    dtype: large_string
-  - name: pragma_major_minor
-    dtype: large_string
-  - name: resolved_solc_version
-    dtype: large_string
-  - name: target_function_signature
-    dtype: large_string
-  - name: prompt_context
-    dtype: large_string
-  - name: workspace_tar
-    dtype: large_string
-  - name: scoring_tar
-    dtype: large_string
-  - name: canary_substrings
-    list: string
-  splits:
-  - name: train
-    num_bytes: 9132818
-    num_examples: 200
-  download_size: 7186378
-  dataset_size: 9132818
+license: mit
+task_categories:
+  - text-generation
+language:
+  - en
+tags:
+  - solidity
+  - smart-contracts
+  - code-generation
+  - agentic-eval
+  - foundry
+  - differential-fuzzing
+size_categories:
+  - 1K<n<10K
 configs:
-- config_name: full
-  data_files:
-  - split: train
-    path: full/train-*
-- config_name: lite
-  data_files:
-  - split: train
-    path: lite/train-*
+  - config_name: lite
+    data_files:
+      - split: train
+        path: lite/train-*
+  - config_name: full
+    data_files:
+      - split: train
+        path: full/train-*
+    default: true
 ---
+
+# Solidity Eval (2026)
+
+Agentic Solidity benchmark. Each task hands the agent a Foundry workspace where one function body in a real Etherscan-verified contract has been replaced with `revert("TODO");`. The agent edits, builds (`forge build`), and tests (`forge test`) inside a sandbox until it returns. Reward is the differential-fuzz pass rate (Diffusc + Echidna) of the model's body against the ground-truth body.
+
+This dataset is intended for use with the [hermes-agent](https://github.com/NousResearch/hermes-agent) Solidity Eval environment, but the `workspace_tar` / `scoring_tar` shape is harness-agnostic — any agent harness that can stage a tarball into `/work` and run a scorer over `/scoring` can use it.
+
+## Configs
+
+| Config | Rows | Selection |
+| --- | --- | --- |
+| `lite` | 200 | Stratified by pragma major.minor over the full cohort (seed=0). Use this for cost-bounded eval runs. |
+| `full` | 3044 | Every row from the SolBench RACR-4k corpus that (a) has a parseable Solidity pragma, (b) satisfies the 0.5.0–0.8.34 compiler range installed in the reference image, and (c) parses cleanly through the function-stubbing step. |
+
+## Schema
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `task_id` | str | `<contract_name>_<idx>`, unique within the dataset. |
+| `domain` | str | `"unknown"` for every row — the source corpus has no domain mapping. |
+| `contract_name` | str | Solidity contract name (target of the deletion). |
+| `contract_address` | str | Etherscan address the source was scraped from. |
+| `pragma` | str | Raw pragma string from the source (`^0.8.10`, `>=0.6.0 <0.8.0`, etc.). |
+| `pragma_major_minor` | str | `"0.5"` / `"0.6"` / `"0.7"` / `"0.8"` — used for stratification. |
+| `resolved_solc_version` | str | Highest installed solc satisfying the pragma. The reference image installs every patch version of 0.5.x–0.8.x. |
+| `target_function_signature` | str | First line of the deleted function header (for the prompt). |
+| `prompt_context` | str | Surrounding code shown to the model (`sc_ba[0]` from the source corpus). |
+| `workspace_tar` | str | Base64-encoded `.tar.gz` containing `foundry.toml` + `src/<contract_name>.sol` (with the target function body replaced by `{ revert("TODO"); }`). Stage this into `/work` before the agent runs. |
+| `scoring_tar` | str | Base64-encoded `.tar.gz` containing `manifest.json` + `origin/<contract_name>.sol`. Stage into `/scoring` *only at scoring time* — never during the agent loop. |
+| `canary_substrings` | list[str] | Tokens / fragments unique to the deleted function body. The scorer fails the run with `b3_violation` if any of these appear in `/work` after the agent finishes. |
+
+## Reward semantics
+
+The in-image scorer (`/opt/scoring/run_diffusc.py` in the reference image) follows SolBench's `echidna()` rule:
+
+```
+reward = 1.0 if Diffusc compiles + Echidna passes (or vacuous "no diff" pass)
+reward = 0.0 on diffusc compile failure, echidna failure, timeout,
+              B3 canary violation, or stub-residue (revert("TODO"); left in)
+```
+
+Three pass routes are tagged in `pass_route.txt` for auditability: `exit_0`, `vacuous_no_diff`, `fail`. Runs with disproportionate vacuous passes can be flagged.
+
+## B2 / B3 reward-hack mitigations
+
+- **B2 (no exfiltration via web tools).** The verified contracts are public on Etherscan, so any agent with web access can fetch the answer with one query. Runners must disable web/browser/messaging tools; for non-Hermes agents this means setting agent-specific flags or running the sandbox container without network egress.
+- **B3 (no ground-truth in the workspace).** `scoring_tar` (containing `origin/`) is staged only after the agent loop ends. The scorer additionally greps the candidate for `canary_substrings` and zeroes the reward if any match.
+- **Stub residue.** If the agent leaves `revert("TODO");` in the candidate, the scorer flags it (`pass_route=stub_residue`) and zeros the reward — otherwise an empty implementation would coast through the vacuous-pass route.
+
+### B3 caveats
+
+- 168 of the 3044 rows have an empty `canary_substrings` list (the deleted body uses only identifiers that already appear elsewhere in the contract — common for ERC20-style getters). For these rows B3 enforcement degrades to best-effort; the canary-grep is a no-op and only the stub-residue + diff-fuzz checks remain. Auditors who want strict B3 enforcement should filter to rows with non-empty canaries.
+
+## Provenance
+
+- Source corpus: SolBench (https://github.com/ZaoyuChen/SolBench, MIT, FSE 2026), specifically the RACR-4k LCS subset.
+- Function-stubbing + tarball construction: this dataset's builder (`environments/benchmarks/solidity_eval/dataset/build_modern_subset.py` in the eval repo).
+- Reference scorer + sandbox image: `samscrack/solidity-eval-sandbox:dev` (Foundry 1.6.0-nightly, Echidna 2.2.3 from the SolBench fork, Diffusc + Slither 0.9.3 from `webthethird/slither.git@dev-diffusc-testing`, solc-select 0.5.0–0.8.34).
+
+## Skipped rows from the source corpus (164 of 3208)
+
+| Reason | Count |
+| --- | --- |
+| `cannot-stub-funit` | 143 |
+| `unsupported-pragma-0.4` | 8 |
+| `no-pragma` | 13 |
+
+`cannot-stub-funit` covers constructors, modifiers, receive/fallback declarations, and abstract function shapes the regex-based stubber can't safely rewrite. Future builder iterations could handle these explicitly.
+
+## License
+
+MIT, inherited from SolBench. The contract sources are public on Etherscan.