Skip to content

Commit 3ca4b12

Browse files
authored
chore(synthetic-chain): Better document proposal eval configuration (#239)
**eval.sh** vs. core-eval scripts/permits/bundles in **submission/**.
1 parent 42310a1 commit 3ca4b12

File tree

1 file changed

+7
-5
lines changed
  • packages/synthetic-chain/public/upgrade-test-scripts

1 file changed

+7
-5
lines changed

packages/synthetic-chain/public/upgrade-test-scripts/run_eval.sh

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,24 @@ fi
1313

1414
startAgd
1515

16-
echo "[$PROPOSAL] Agd started. Running CoreEval submission."
16+
echo "[$PROPOSAL] Agd started. Submitting proposal."
1717
cd /usr/src/proposals/"$PROPOSAL/" || fail "Proposal $PROPOSAL does not exist"
1818

1919
if [ -f "eval.sh" ]; then
20-
# this is what the script used to do. Also allows a proposal to override how they are eval-ed
20+
# Allows a proposal to control its evaluation; used in particular for
21+
# param-change proposals but also valid for other types such as core-eval.
2122
echo "[$PROPOSAL] Running eval.sh"
2223
./eval.sh
2324
else
24-
# newer proposals declare a submission
25-
echo "[$PROPOSAL] Running proposal declared in package.json"
25+
# Straightforward core-eval proposals can be specified directly in a "submission" directory
26+
# containing $name.js scripts, $name-permit.json permits, and b1-$hash.json bundles.
27+
echo "[$PROPOSAL] Running core-evals from submission/"
2628
# copy to run in the proposal package so the dependencies can be resolved
2729
cp /usr/src/upgrade-test-scripts/eval_submission.js .
2830
./eval_submission.js
2931
fi
3032

31-
echo "[$PROPOSAL] Eval completed. Running 10 blocks and exiting."
33+
echo "[$PROPOSAL] Proposal eval completed. Running 10 blocks and exiting."
3234
waitForBlock 10
3335

3436
killAgd

0 commit comments

Comments
 (0)