Skip to content

Sepolia TokenStaking proxy deploy, ExtendedTokenStaking upgrade, and operator setup tooling#176

Open
lionakhnazarov wants to merge 21 commits intomainfrom
feat/testnet4-deployment-support
Open

Sepolia TokenStaking proxy deploy, ExtendedTokenStaking upgrade, and operator setup tooling#176
lionakhnazarov wants to merge 21 commits intomainfrom
feat/testnet4-deployment-support

Conversation

@lionakhnazarov
Copy link
Copy Markdown

Sepolia TokenStaking proxy deploy, ExtendedTokenStaking upgrade, and operator setup tooling

Summary

This branch makes Sepolia a first-class network for TokenStaking: deploy the UUPS/transparent proxy the same way as mainnet, add a hardhat-deploy path to upgrade the proxy to ExtendedTokenStaking (so operators can call stake()), and add scripts for funding, keystores, and end-to-end operator registration against deployed tbtc-v2 Sepolia artifacts.

It also aligns IStaking / TokenStaking with approveApplication and increaseAuthorization, and updates ExtendedTokenStaking in the test harness with override where needed.

Motivation

  • Sepolia needs proxy-deployed TokenStaking and an upgrade to ExtendedTokenStaking so staking providers can stake native T and authorize Random Beacon / Wallet Registry apps—required for a working testnet operator stack.
  • Operational scripts reduce manual cast steps and document the flow (fund T + ETH, stake, increaseAuthorization, register operator, join sortition pools).

Changes

Contracts

  • IStaking: declare approveApplication and increaseAuthorization.
  • TokenStaking: implement approveApplication and increaseAuthorization (governance + authorizer flows, application callbacks).
  • TokenStakingTestSet.sol: add override on ExtendedTokenStaking methods that now override the base.

Deploy / upgrade

  • deploy/07_deploy_token_staking.ts: use OpenZeppelin proxy deploy for sepolia as well as mainnet.
  • deploy/54_upgrade_token_staking_extended.ts (new): Sepolia-only upgrade of the TokenStaking proxy to ExtendedTokenStaking, with Tenderly verify when tagged.
  • scripts/upgrade-token-staking.ts: standalone upgrade + refresh deployments/<network>/TokenStaking.json ABI/address.
  • package.json: add yarn upgrade:token-staking; pin packageManager (Yarn 4).

Artifacts / repo layout

  • TokenStaking.json added at repo root (deployment/ABI snapshot).
  • deployments/mainnet/TokenStaking.json removed (superseded / relocated—confirm in review if anything still expects the old path).

New scripts (operator / maintainer)

  • setup-new-staking-provider.js, fund-new-operator.sh, run-new-operator-setup.sh, setup-multiple-operators.sh
  • create-operator-keystore.js, get-operator-key.js
  • create-spv-maintainer-keystore.js

…rease in TokenStaking

- Introduced  method in  and  to allow governance to approve applications.
- Added  method to enable staking providers to increase their authorization for applications.
- Updated deployment scripts for TokenStaking upgrade and added new scripts for operator keystore management.
- Modified  to include a new script for upgrading token staking.
- Created new JSON file for TokenStaking ABI and removed outdated deployment data.
Copy link
Copy Markdown
Member

@lrsaturnino lrsaturnino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two critical findings from multi-model code review (3/3 models confirmed both).

Comment thread contracts/test/TokenStakingTestSet.sol Outdated
Comment thread package.json Outdated
lionakhnazarov and others added 11 commits April 13, 2026 16:02
- Updated the approveApplication function to include the onlyGovernance modifier, ensuring that only governance can approve applications.
… for Yarn

- Upgraded actions/setup-node from v3 to v4 across multiple workflow files.
- Added a step to enable Corepack for Yarn in the workflows, ensuring compatibility with the package manager specified in the project.
…ld-network/solidity-contracts into feat/testnet4-deployment-support
- Removed comments from .yarnrc.yml to streamline configuration.
- Updated packageManager in package.json to Yarn version 4.12.0 for improved performance and features.
…docs file

- Changed the workflow to use the local path for reusable-solidity-docs.yml instead of the remote repository reference.
- Ensured that both documentation generation and publishing jobs point to the correct local file.
- Remove private key logging from create-operator-keystore and
  get-operator-key; address is sufficient for confirmation
- Remove staking provider and operator private keys from generated
  .env files; keys written to disk are a git-leak risk
- Print staking provider key once to terminal with a prominent
  "copy now" warning instead of persisting it to .env
- Require non-empty password in create-operator-keystore and
  setup-new-staking-provider; empty-password keystores are
  trivially decryptable
- Require explicit keystore path in get-operator-key; remove the
  hardcoded developer-machine UUID default that caused ENOENT for
  all other users
- Fix --list path in get-operator-key: ../../operator-1-keystore
  resolved above repo root; corrected to ../operator-1-keystore
- Convert sync fs calls to fs.promises and add try/catch inside
  main() across all three scripts
…args

Passing --private-key as a CLI argument exposes the key in ps aux
output and persists in shell history. Using ETH_PRIVATE_KEY as an
inline env assignment (ETH_PRIVATE_KEY="$key" cast send ...) keeps
the key out of the argv list.

Introduce _sp_cast_send_ok / _op_cast_send_ok wrappers in
run-new-operator-setup.sh that inject ETH_PRIVATE_KEY for the
respective signer, and replace all --private-key flag usages.

Update fund-new-operator.sh likewise for the deployer key.

Update run-new-operator-setup.sh usage comment to reflect that
NEW_STAKING_PROVIDER_KEY and NEW_OPERATOR_KEY are no longer
written to .env files and must be exported by the operator.
- Drop kind: "transparent" from upgradeProxy options; let the OZ
  plugin infer the proxy type from the deployed proxy admin slot.
  Hardcoding the kind risks a mismatch if the original deploy
  defaulted differently. Add a comment with the cast storage
  command to verify proxy type on-chain.
- Replace two inline const fs = require("fs") declarations with a
  single top-level import * as fs from "fs" to match TypeScript
  conventions and avoid the duplicate binding.
The file was removed in the parent branch commit without explanation.
Downstream consumers relying on deployments/mainnet/TokenStaking.json
break silently without it. Restored from the last known-good version
(commit ab29e02).
approveApplication already checks application != address(0) but
increaseAuthorization did not. The APPROVED status check provides
a functional backstop, but adding the explicit guard makes the
invariant consistent across both entry points.
lionakhnazarov and others added 2 commits April 15, 2026 12:59
…and-correctness

fix: security and correctness follow-ups for Sepolia operator tooling (PR #176)
lrsaturnino
lrsaturnino previously approved these changes Apr 17, 2026
Copy link
Copy Markdown
Member

@lrsaturnino lrsaturnino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall — clean contract changes, CEI ordering solid, access controls in place.

One small nit: the operator setup scripts generate keystores and env files (operator-1-keystore/, spv-maintainer-keystore/, .env.new-operator, .env.operator-*) that aren't covered by .gitignore. Might be worth adding entries to prevent accidental commits.

Copy link
Copy Markdown
Member

@lrsaturnino lrsaturnino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some more findings for evaluation.

Comment thread deploy/07_deploy_token_staking.ts
Comment thread deploy/54_upgrade_token_staking_extended.ts
Comment thread deploy/54_upgrade_token_staking_extended.ts Outdated
Comment thread scripts/upgrade-token-staking.ts Outdated
Comment thread scripts/setup-multiple-operators.sh Outdated
- Added new entries to .gitignore for generated operator setup artifacts.
- Updated deployment scripts to create a directory for network-specific deployments and save TokenStaking deployment data in both the root and network-specific directories.
- Refactored authorization and registration commands in setup scripts to use environment variables for private keys, improving security and readability.
- Modified upgrade script documentation to reflect the correct command usage from the repository root.
…ld-network/solidity-contracts into feat/testnet4-deployment-support
Copy link
Copy Markdown
Member

@lrsaturnino lrsaturnino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On ExtendedTokenStaking in contracts/test/TokenStakingTestSet.sol — now that approveApplication and increaseAuthorization live on the base TokenStaking, the overrides at lines 227–268 and 280–294 are duplicates. The increaseAuthorization override also doesn't emit AuthorizationIncreased or guard application != address(0), while the base does both.

Since deploy/54 makes ExtendedTokenStaking the live Sepolia implementation, Sepolia will silently stop emitting AuthorizationIncreased (no test asserts it, so CI won't flag it). Dropping both overrides should be enough — the derived contract picks up the canonical behaviour from the base.

- Introduced a  function to remove CRLF and whitespace from environment variables, preventing decoding errors.
- Updated  to ensure that the  is not overwritten by stale values.
- Modified  to store both staking provider and operator private keys in the environment file for automated setups, while ensuring sensitive information is not logged unnecessarily.
- Added error handling for missing keys in the generated environment files.
- Added validation to ensure ETH_PRIVATE_KEY is set before sending transactions.
- Introduced a mechanism to prevent overwriting the deployer key with stale values from environment files.
- Updated the script to maintain the correct private key for the contract owner during operator setup.
- Updated prerequisites for deploying operators to include AUTO_FUND_T for automatic minting of T tokens.
- Added a function to compute T token shortfall and validate the deployer's balance.
- Implemented error handling for insufficient T balance and ensured proper private key management for minting.
- Introduced normalization for addresses to improve consistency in key comparisons.
… functionality

- Added a function to compute the shortfall of T tokens and validate the deployer's balance.
- Implemented error handling for insufficient T balance and ensured proper private key resolution for minting.
- Updated prerequisites to require python3 for balance checks and minting operations.
- Improved address normalization for better key comparison consistency.
- Removed specific ignore rules for deployments in .gitignore to allow for better management of deployment files.
- Added new deployment files for Sepolia, including .chainId, NuCypherToken.json, T.json, TokenStaking.json, and VendingMachineNuCypher.json, to support the latest contract deployments.
- Enhanced the operator setup script to improve handling of ETH funding for new operators, including adjustable parameters for ETH allocation and better error handling for deployment paths.
- Updated prerequisites and usage instructions in the setup script for clarity and improved user experience.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants