feat: contracts v3.1

[horsefacts]

Motivation

Ensure that fid registration and key registry adds have associated costs and limits to prevent griefing.

Design goals in priority order:

1. Require a sufficient transaction cost at fid/key "gateways" to deter speculative ID spamming and event griefing.
2. Enable changes to fee logic in the future.
3. Minimize changes to existing fid/key trust assumptions.
4. Minimize overall scope of contract changes.

Change Summary

Changes:

• Extract IdGateway and KeyGateway.
  • These contracts are now the entry point for creating fids and adding keys respectively.
  • Only these "gateway" contracts are authorized to call IdRegistry.register and KeyRegistry.add
  • Each gateway is configurable on each registry contract, so we have the ability to update policies or change fees in these contracts in the future.
• Require storage rent at registration time. All fid registrations must also rent 1 unit of storage.
• Add configurable maxKeysPerFid to KeyRegistry and enforce a key limit per fid.
  • The owner may increase, but not decrease this value.
• Skip key metadata validation during KeyRegistry migration. This enables us to migrate in existing key metadata, even though signature deadlines may have now expired.
• Refactor Pausable to Guardians. Contract owner may grant multiple guardians authority to pause(), but only the owner may unpause().
• Add custodyOf reverse mapping to IdRegistry.
• Make gateway dependencies permanently freezable by owner.
• Remove ID migration from Bundler and add flexible migration to IdRegistry.
• Add enumerable keys to KeyRegistry.

Audit fixes:

• Remove payments from KeyGateway altogether. (Fix for Macro L-1)
• Accept exact deadline timestamp as valid in sig verification. (Fix for Macro L-2)
• Remove unused imports. (Fix for Macro Q-3)
• Allow rental of extraStorage in IdGateway. (Fix for Macro Q-5 and G-2)
• Add external useNonce functions to bump nonces. (Partial fix for Macro Q-4, fix for Cyfrin M-1)
• Add current recovery address to change recovery sig. (Fix for Cyfrin M-2)

Refactors:

• Rename IdManager/KeyManager IdGateway/KeyGateway.

• Move errors and events to interfaces.

  Other:

• Update symtests.
• Update docs.

Merge Checklist

Choose all relevant options below by adding an x now or at any time before submitting for review

• [x] The PR title adheres to the conventional commits standard
• [x] The PR has been tagged with change type label(s) (i.e. documentation, feature, bugfix, or chore)
• [x] The PR's changes adhere to all the requirements in the contribution guidelines
• [x] All commits have been signed

---

PR-Codex overview

Focus:

This PR focuses on updating various import paths and adding new addresses to the environment variables.

Detailed summary:

• Updated import paths for ImmutableCreate2Deployer in multiple scripts.
• Added MIGRATOR_ADDRESS to .env.prod, .env.example, and .env.local.
• Updated import path for TransferHelper in StorageRegistry.sol.
• Added new interfaces INonces, IMetadataValidator, ISignatures, IEIP712, and IdRegistryLike.
• Updated import paths for EIP712 in FnameResolver.sol and SignedKeyRequestValidator.sol.

The following files were skipped due to too many changes: src/interfaces/IdRegistryLike.sol, src/lib/EIP712.sol, src/lib/Signatures.sol, test/KeyRegistry/utils/KeyRegistryHarness.sol, test/RecoveryProxy/RecoveryProxy.t.sol, src/interfaces/abstract/IGuardians.sol, test/KeyRegistry/KeyRegistryTestSuite.sol, test/KeyGateway/KeyGatewayTestSuite.sol, .github/workflows/ci.yml, src/abstract/Guardians.sol, test/IdRegistry/IdRegistryTestHelpers.sol, test/IdGateway/IdGatewayTestSuite.sol, src/interfaces/IKeyGateway.sol, test/KeyRegistry/KeyRegistry.integration.t.sol, src/RecoveryProxy.sol, test/Bundler/Bundler.gas.t.sol, test/IdRegistry/IdRegistry.gas.t.sol, test/Bundler/BundlerTestSuite.sol, .env.upgrade, src/abstract/Migration.sol, test/abstract/Guardians/Guardians.symbolic.t.sol, src/interfaces/abstract/IMigration.sol, test/IdRegistry/IdRegistryTestSuite.sol, src/KeyGateway.sol, test/abstract/Migration/Migration.symbolic.t.sol, src/libraries/EnumerableKeySet.sol, test/IdGateway/IdGateway.owner.t.sol, src/interfaces/IBundler.sol, test/IdRegistry/IdRegistry.owner.t.sol, test/IdRegistry/IdRegistry.symbolic.t.sol, test/StorageRegistry/StorageRegistry.t.sol, src/interfaces/IIdGateway.sol, src/IdGateway.sol, test/Deploy/DeployL2.t.sol, script/DeployL2.s.sol, src/Bundler.sol, script/UpgradeL2.s.sol, test/KeyRegistry/KeyRegistry.symbolic.t.sol, src/interfaces/IIdRegistry.sol, docs/docs.md, test/Deploy/UpgradeL2.t.sol, test/KeyGateway/KeyGateway.t.sol, src/interfaces/IKeyRegistry.sol, test/KeyRegistry/KeyRegistry.migration.t.sol, test/IdGateway/IdGateway.t.sol, test/IdRegistry/IdRegistry.migration.t.sol, src/IdRegistry.sol, src/KeyRegistry.sol, test/Bundler/Bundler.t.sol, test/KeyRegistry/KeyRegistry.t.sol, test/IdRegistry/IdRegistry.t.sol

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

[github-actions[bot]]

Coverage after merging horsefacts/v3.1.0 into main will be

100.00%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
src
Bundler.sol	100%	100%	100%	100%
FnameResolver.sol	100%	100%	100%	100%
IdGateway.sol	100%	100%	100%	100%
IdRegistry.sol	100%	100%	100%	100%
KeyGateway.sol	100%	100%	100%	100%
KeyRegistry.sol	98.56%	94.44%	100%	100%	153, 153
RecoveryProxy.sol	100%	100%	100%	100%
StorageRegistry.sol	100%	100%	100%	100%
src/abstract
EIP712.sol	100%	100%	100%	100%
Guardians.sol	100%	100%	100%	100%
Migration.sol	100%	100%	100%	100%
Nonces.sol	100%	100%	100%	100%
Signatures.sol	100%	100%	100%	100%
src/validators
SignedKeyRequestValidator.sol	100%	100%	100%	100%