Deployment Scripts via Forge & Contract docs #482

alysiahuggins · 2025-09-02T14:05:44Z

Closes #<ISSUE_NUMBER>

This PR:

adds docs for the timeboost-contracts
removes the contracts folder and adds thetimelock-contracts repo as a submodule (here is the sister Port EspressoSystems/timeboost#482 into timeboost-contracts timeboost-contracts#2)

This PR does not:

Key places to review:

How to test this PR:

run the timeboost-contract tests cargo test -p timeboost-contract

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1210330229095213
- https://app.asana.com/0/0/1210330229095217

…st contracts

…ct deployment code in the contracts dir, along with readmes

…ubmodules

akonring

Great with contract docs 💯.
LGTM, but I'll let others chime in.

contracts/README.md

contracts/script/deploy.sh

akonring · 2025-09-05T11:54:40Z

contracts/script/deploy.sh

+
+# Use environment variables with defaults
+RPC_URL=${RPC_URL:-"http://localhost:8545"}
+ACCOUNT_INDEX=${ACCOUNT_INDEX:-0}


Suggested change

ACCOUNT_INDEX=${ACCOUNT_INDEX:-0}

ACCOUNT_INDEX=${ACCOUNT_INDEX:-0}

MNEMONIC=${MNEMONIC:-"test test test test test test test test test test test junk"}

pls use attend year erase basket blind adapt stove broccoli isolate unveil acquire category as the default mnemonic,

@alysiahuggins need to fund this account

# default test wallet's private key FAUCET_PRIVATE_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" # Fund the manager account cast send --value 1ether --private-key "$FAUCET_PRIVATE_KEY" "$MANAGER_ADDRESS"

Agree. As long as we fund the default.

since this is now in a seperate repo, this concern is no longer here (as discussed during the standup)

contracts/src/KeyManager.sol

lukeiannucci

this looks good to me! i have nothing to add here. Thanks!

alxiong · 2025-09-07T05:15:04Z

should we first move this work to https://github.com/EspressoSystems/timeboost-contracts? @alysiahuggins @lukeiannucci ?

alxiong

thanks @alysiahuggins, the documentation looks fine. but we already have deployment via rust binary timeboost-contract/src/binaries/deploy.rs and we tried to avoid .env as per Toralf's suggestion since we want to centralize our config in the config files (you can see test-configs/c0/node_0.toml for an example instead of having both these node config files and .env files.

i also added a bash script in scripts/test-contract-deploy to 1) spawn anvil; 2) deploy contracts; 3) register committee (by invoking the binary register.rs).

(special note is that for the test wallet, I didn't use test test ... junk mnemonic phrase, as i explained here)

update: I take back my comments on avoiding .env and forge script. ignore that comment there.

timeboost-proto/protos

Cargo.toml

contracts/README.md

lukeiannucci · 2025-09-07T14:51:00Z

should we first move this work to https://github.com/EspressoSystems/timeboost-contracts? @alysiahuggins @lukeiannucci ?

i was thinking since we already started leaving comments here, we could finish it here then port it over. but if want to move the discussion and changes there, i have no problem

lukeiannucci · 2025-09-07T14:55:24Z

thanks @alysiahuggins, the documentation looks fine. but we already have deployment via rust binary timeboost-contract/src/binaries/deploy.rs and we tried to avoid .env as per Toralf's suggestion since we want to centralize our config in the config files (you can see test-configs/c0/node_0.toml for an example instead of having both these node config files and .env files.

i also added a bash script in scripts/test-contract-deploy to 1) spawn anvil; 2) deploy contracts; 3) register committee (by invoking the binary register.rs).

(special note is that for the test wallet, I didn't use test test ... junk mnemonic phrase, as i explained here)

i personally like the secondary script to deploy, as we are going to be moving this contracts folder to its own respective repository, and when I am working in the nitro repository setting up tests there may come a time where i will need this, but I do see your point im fine either way.

alxiong · 2025-09-08T02:01:39Z

i was thinking since we already started leaving comments here, we could finish it here then port it over. but if want to move the discussion and changes there, i have no problem

agree. my suggestion is: continue the discussion and address all comments in the current PR.
after all comments are addressed, dump all changes into a git diff file and apply in the new repo.
(namely: git diff --cached > pr482.patch then in the new repo, create a new PR via git apply pr482.patch)

i personally like the secondary script to deploy, ...when I am working in the nitro repository setting up tests there may come a time where i will need this, but I do see your point im fine either way.

i think i see your point. the cyclic dep issue if the nitro repo requires timeboost's binary to deploy these contract.
I agree that having this forge script (and bash script) is good.

my only concern is drifting config (.env and test-configs, e.g. the mnemonic used in .env file differs from what we expect, then the deployed contract address in test-configs all need to be revised). But i guess we can detect that discrepancy during integration test running in the CI.

timeboost-contract/README.md

Co-authored-by: Anders Konring <[email protected]>

…instructions

…tain, now it entails an overview of the crate

timeboost-contract/Cargo.toml

alxiong

The contract side looks good to me, @alysiahuggins you can follow #482 (comment) and migrate the changes to the new contract repo.

then can we rebase (completely rewrite the git history of this branch) and only leave changes made to timeboost-contract and timeboost-proto?
@lukeiannucci do you have better suggestion?

twittner

With this we have multiple ways to deploy the contract, a Rust binary (deploy.rs) plus shell script and now also a forge script, shell script and .env file. My preference would be to consolidate this and have only one way to deploy, specifically I would remove deploy.rs and test-contract-deploy. Unless I am missing something the .env file and deploy.sh in here can also be removed and we can add the forge script command to the existing justfile.

twittner · 2025-09-09T09:07:27Z

contracts/script/deploy.sh

+export MANAGER_ADDRESS=$MANAGER_ADDRESS
+
+# Build forge command
+FORGE_CMD="forge script script/DeployKeyManager.s.sol:DeployKeyManager --rpc-url $RPC_URL --broadcast --mnemonics \"$MNEMONIC\" --mnemonic-indexes $ACCOUNT_INDEX"


Not quite sure why we need an .env file and deploy.sh? Can we not just run this forge command directly, e.g. from our Justfile?

good q and we don't need both but the contracts directory is actually going to be moved to this new repo and it would be good to have standalone deployment scripts there (and so far that repo doesn't use a justfile)

* Port EspressoSystems/timeboost#482 into timeboost-contracts * remove redudunct readme and linked to the correct readme location for the timeboost repo * remove lock files in gitignore * improves readme

no longer needed as discussed in chat and the standup

alysiahuggins added 7 commits August 25, 2025 13:34

wip started contracts readmes and added more documentation to timeboo…

22e1481

…st contracts

deployment of contracts in timeboost-contracts for testing and contra…

e354ee3

…ct deployment code in the contracts dir, along with readmes

remove feature in cargo toml not needed at this time

e34d636

merge from main

9aa9952

refactor due to redundancies after merging in changes from main

6e13297

update timeboost proto submodule and added a just command to update s…

1285767

…ubmodules

clean up docs

8588c23

alysiahuggins marked this pull request as ready for review September 2, 2025 22:35

alysiahuggins requested a review from alxiong September 2, 2025 22:36

alysiahuggins changed the title ~~Contract docs~~ Deployment Scripts via Forge & Contract docs Sep 3, 2025

akonring reviewed Sep 5, 2025

View reviewed changes

lukeiannucci reviewed Sep 5, 2025

View reviewed changes

alxiong previously requested changes Sep 7, 2025

View reviewed changes

timeboost-proto/protos Show resolved Hide resolved

Cargo.toml Outdated Show resolved Hide resolved

contracts/README.md Outdated Show resolved Hide resolved

alxiong reviewed Sep 8, 2025

View reviewed changes

timeboost-contract/README.md Show resolved Hide resolved

alysiahuggins and others added 5 commits September 8, 2025 09:21

Update contracts/README.md

26753f4

Co-authored-by: Anders Konring <[email protected]>

Update contracts/README.md

c461755

Co-authored-by: Anders Konring <[email protected]>

responding to review feedback - improving script defaults and readme …

e2ac79b

…instructions

remove stray char

7331bb4

remove from the timeboost-contract readme, anything that is hard main…

f239243

…tain, now it entails an overview of the crate

alysiahuggins requested a review from alxiong September 8, 2025 13:55

alxiong reviewed Sep 9, 2025

View reviewed changes

timeboost-contract/Cargo.toml Outdated Show resolved Hide resolved

alxiong reviewed Sep 9, 2025

View reviewed changes

twittner reviewed Sep 9, 2025

View reviewed changes

alysiahuggins added 2 commits September 9, 2025 09:53

remove dependency no longer needed

e80f762

merge from main

78d5b90

alysiahuggins added a commit to EspressoSystems/timeboost-contracts that referenced this pull request Sep 9, 2025

Port EspressoSystems/timeboost#482 into timeboost-contracts

3b0f256

alysiahuggins added 2 commits September 9, 2025 13:17

Remove contracts directory before adding as submodule

a9357e7

add timeboost-contracts as a submodule

bfdaf1e

alysiahuggins requested review from twittner and alxiong September 9, 2025 17:32

twittner approved these changes Sep 9, 2025

View reviewed changes

Merge branch 'main' into contract-docs

04736ac

alysiahuggins added 2 commits September 9, 2025 15:26

remove new line at the end ofthe file

778c1ab

update links in readme

1038778

alysiahuggins merged commit 6164a97 into main Sep 9, 2025
8 checks passed

alysiahuggins deleted the contract-docs branch September 9, 2025 21:48

	ACCOUNT_INDEX=${ACCOUNT_INDEX:-0}
	ACCOUNT_INDEX=${ACCOUNT_INDEX:-0}
	MNEMONIC=${MNEMONIC:-"test test test test test test test test test test test junk"}

Deployment Scripts via Forge & Contract docs #482

Deployment Scripts via Forge & Contract docs #482

Uh oh!

Conversation

alysiahuggins commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This PR:

This PR does not:

Key places to review:

How to test this PR:

Uh oh!

akonring left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

akonring Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

alxiong Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akonring Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

alysiahuggins Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lukeiannucci left a comment

Choose a reason for hiding this comment

Uh oh!

alxiong commented Sep 7, 2025

Uh oh!

alxiong left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lukeiannucci commented Sep 7, 2025

Uh oh!

lukeiannucci commented Sep 7, 2025

Uh oh!

alxiong commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alxiong left a comment

Choose a reason for hiding this comment

Uh oh!

twittner left a comment

Choose a reason for hiding this comment

Uh oh!

twittner Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

alysiahuggins Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alysiahuggins commented Sep 2, 2025 •

edited

Loading

alxiong Sep 8, 2025 •

edited

Loading

alxiong left a comment •

edited

Loading

alxiong commented Sep 8, 2025 •

edited

Loading