farcasterxyz / contracts

Implementation of the Farcaster contracts
https://www.farcaster.xyz/
MIT License
340 stars 122 forks source link

refactor(Bundler): clean up documentation, parameter names and types #248

Closed varunsrin closed 1 year ago

varunsrin commented 1 year ago

Motivation

Make Bundler contract easier to audit and understand, improve trustedBatchRegister functionality to cover all migration types.

Change Summary

See PR Codex below for a full list of changes.

Merge Checklist


PR-Codex overview

This PR focuses on changing the function name changeTrustedCaller to setTrustedCaller in the IdRegistry and Bundler contracts. It also updates the corresponding event names and adds a recovery parameter to the UserData struct.

Detailed summary

The following files were skipped due to too many changes: src/Bundler.sol

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

github-actions[bot] commented 1 year ago

Coverage after merging varunsrin/bundler-cleanup into main will be

98.79%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
src
   Bundler.sol94.12%83.33%100%100%151, 153
   FnameResolver.sol96.30%75%100%100%121
   IdRegistry.sol97.30%100%92.31%97.44%315
   StorageRent.sol98.85%98.44%100%98.90%468, 470