Skip to content

refactor(cli): migrate base, utils, test-utils to viem [4/8]#769

Closed
pahor167 wants to merge 1 commit into
pahor/viem-C-sdk-peripheralsfrom
pahor/viem-D1-cli-base
Closed

refactor(cli): migrate base, utils, test-utils to viem [4/8]#769
pahor167 wants to merge 1 commit into
pahor/viem-C-sdk-peripheralsfrom
pahor/viem-D1-cli-base

Conversation

@pahor167

@pahor167 pahor167 commented Apr 1, 2026

Copy link
Copy Markdown
Contributor

Stack

A β†’ B β†’ C β†’ D1 β†’ D2 β†’ D3 β†’ D4 β†’ D5 (CI)

Changes

  • base.ts: remove web3 from base command class
  • utils/cli.ts: replace displaySendTx with displayViemTx
  • utils/command.ts: migrate transaction helpers to viem
  • utils/checks.ts, governance.ts, release-gold-base.ts: remove web3 types
  • test-utils/: chain-setup, cliUtils, mockRpc updated for viem
  • Delete exchange.ts and exchange.test.ts (dead code)

Part of the web3 β†’ viem migration. No CI requirement on this PR.


PR-Codex overview

This PR primarily focuses on refactoring the codebase to replace instances of Web3 with a new Provider interface, enhancing consistency and functionality across the code. It also removes outdated methods and optimizes the transaction handling process.

Detailed summary

  • Deleted exchange.ts and exchange.test.ts files.
  • Updated tsconfig.json to exclude all test files.
  • Removed requireCall function from require.ts.
  • Replaced Web3 with Provider in several files.
  • Modified transaction handling to use viem actions for receipts.
  • Adjusted utility functions and tests to accommodate Provider.
  • Enhanced gas estimation and transaction sending methods.
  • Updated mock functions to use the new Provider interface.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

- base.ts: remove web3 from base command class
- utils/cli.ts: replace displaySendTx with displayViemTx
- utils/command.ts: migrate transaction helpers to viem
- utils/checks.ts, governance.ts, release-gold-base.ts: remove web3 types
- test-utils/: chain-setup, cliUtils, mockRpc updated for viem
- Remove exchange.ts and exchange.test.ts (dead code)
@pahor167 pahor167 requested a review from a team as a code owner April 1, 2026 09:08
@changeset-bot

changeset-bot Bot commented Apr 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 6929a33

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

πŸ’‘ Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6929a3371c

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with πŸ‘.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


// TODO: How can we deploy contracts with the Celo provider w/o a CeloTransactionObject?
export async function displayWeb3Tx(name: string, txObj: any, tx?: Omit<CeloTx, 'data'>) {
export async function displayTx(name: string, txObj: any, tx?: Omit<CeloTx, 'data'>) {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Keep displaySendTx exported for existing commands

Renaming displaySendTx to displayTx here breaks the current command surface because many command modules still import and call displaySendTx (for example packages/cli/src/commands/account/register.ts, packages/cli/src/commands/governance/approve.ts, and numerous others in this commit state). Without a compatibility export, TypeScript build/runtime module loading for those commands fails until every caller is migrated in the same change.

Useful? React with πŸ‘Β / πŸ‘Ž.

Comment thread packages/cli/src/base.ts
Comment on lines +167 to 173
async newProvider(): Promise<Provider> {
if (!this._provider) {
const nodeUrl = await this.getNodeUrl()
this._provider = getProviderForKit(nodeUrl, undefined)
}
return this._provider
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Preserve BaseCommand.getWeb3 until callers are migrated

This refactor removes the getWeb3() API from BaseCommand, but multiple command files in this commit still invoke this.getWeb3() (e.g. commands/account/lock.ts, commands/account/unlock.ts, and governance commands). That leaves those commands broken as soon as they execute, so this change needs a temporary shim or an atomic migration of all call sites.

Useful? React with πŸ‘Β / πŸ‘Ž.

Comment on lines +8 to 12
export const createSafe = async (
provider: Provider,
signer: StrongAddress,
safeAddress: StrongAddress
) => {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Re-export old Safe helpers while governance commands still use them

Replacing createSafeFromWeb3 / safeTransactionMetadataFromCeloTransactionObject with new names here is a breaking API change for existing governance commands that still import the old symbols (commands/governance/approve.ts, propose.ts, withdraw.ts in this commit). Those imports will fail unless these legacy exports remain available until callers are updated.

Useful? React with πŸ‘Β / πŸ‘Ž.

pahor167 added a commit that referenced this pull request Jun 15, 2026
…es (#780)

## Summary

Combined branch containing the full web3 β†’ viem migration (the union of
the stacked PRs #766–#773) plus 24 commits of review fixes from a deep
multi-agent audit of the cumulative diff (~350 files).

### Migration (from the original stack)
- `@celo/connect`, `@celo/utils`: web3 replaced with viem-native
primitives (#766)
- `@celo/contractkit`: viem-native contract interaction across all
wrappers (#767)
- `@celo/explorer`, `@celo/governance`, wallets, dev-utils (#768)
- `@celo/celocli`: all command groups migrated (#769–#773)

### Review fixes on top (highlights, 38 findings fixed)

Funds/correctness critical:
- wallet-base: tx quantities above 2^53 were silently truncated when
hex-encoding (`1 CELO + 1 wei` signed as exactly 1 CELO); now
BigInt-backed with a regression test
- connect: `defaultFeeCurrency` was silently ignored for every
`contract.write`; dynamic chain now carries the Celo
serializers/formatters so CIP-64 serializes correctly
- contractkit: IPC provider hung forever (parsed only on socket `end`);
ws:// / wss:// node URLs fell through to the HTTP provider; HTTP error
statuses resolved `undefined`
- contractkit: `setAccount` without proof-of-possession always threw
(`'0x0'` as bytes32); `Attestations.getPendingWithdrawals` parameter
order restored to match the contract
- cli: `releasecelo:admin-revoke` lost the `{from: voteSigner}` override
β†’ revokes reverted with an authorized vote signer
- connect: fee-math radix bug inflated `maxFeePerGas` for string inputs

High:
- tuple-blind ABI signatures produced wrong selectors/topic hashes (ABI
enrichment, `methodIds`, log-explorer event matching)
- `BaseWrapper.getPastEvents` swallowed RPC errors as "no events";
unknown event names now throw (web3 parity)
- Election historical `blockNumber` queries were silently ignored (voter
rewards at past epochs)
- governance CLI commands no longer displayed on-chain event
confirmations (ProposalExecuted / HotfixExecuted / HotfixApproved /
Deposit) β€” restored, including the silently-dropped test snapshots
- `isValidChecksumAddress` accepted all-lowercase addresses; sourcify
proxy implementation address checksummed again
- BigInt-safe JSON-RPC serialization in production providers

Plus test-semantics restorations (weakened assertions,
mocked-method-under-test), test-infra robustness (receipt waits, strict
`evm_revert`), changeset corrections (contractkit correctly marked major
with full breaking-change list), and documentation of behavior changes.

Full audit trail (62 findings: 38 fixed, 12 refuted with evidence, the
rest classified pre-existing/wontfix) lives in
`.omc/ralph/pr-review-progress.md` on the working machine; findings are
also traceable through the individual commit messages.

## Test plan
- [x] Full workspace build green (all 23 packages)
- [x] Full test suite: all packages green locally except known env-flaky
timeouts under full parallel load (actions/keystores) and a pre-existing
`election:activate --wait` snapshot-order flake that reproduces on the
unmodified stack HEAD
- [x] Anvil-backed suites green: contractkit 258/258, celocli 337 passed
- [x] Live smoke tests: IPC provider against `anvil --ipc`, WebSocket
provider against `wss://forno.celo.org/ws`
- [ ] CI green on this PR

---------

Co-authored-by: Pavel Hornak <pavel.hornak@clabs.co>
Co-authored-by: Paul Lange <palango@gmx.de>
@pahor167 pahor167 closed this Jun 15, 2026
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.

1 participant