Migrate From ContractKit to Viem

aaronmgdr commented 1 month ago

Description

Rather than use ContractKit use viem as the rpc caller / contracts library.

Changes

WalletSigner now takes a sign191 function instead of a contractKit instance. this makes it easy to use with whatever library you like such as viem client.signMessage or ethers.signMessage as long as they support eip191.
Many places that were expecting an address but typed as a regular string are now typed as 0x{string} aka Address
almost everywhere kit has been replaced with client and in some cases walletClient
@celo/phone-number-privacy-common/lib/contracts contract instances used internally (viem getContract + abi + address) getAccountsContract, getCUSDContract, getOdisPaymentsContract,
ContractKit is still needed for the @celo/identity/lib/offchain functions however these are not used in social connect as such ck is now a peer dependencies and marked as optional. Pottentially these offchain functions can be either deprecated or moved to a different codebase.

Tested

Needs someone who understand the system really well to really test it out.

TODO

need to re mock the getDataEncryptionKey method in the authentication.test in common package. one was done but the rest still need it and each seems to require different implementatation
try to replace contractkit with @celo/metadata-claims@1.0.0-beta.0

dont merge until we get this deployed to staging.

Related issues

Fixes https://github.com/celo-org/social-connect/issues/296

Backwards compatibility

No. This is a Major Change

Documentation

documented in changesets the differences

changeset-bot[bot] commented 1 month ago

🦋 Changeset detected

Latest commit: 1f8fb50ff32a99541fa638456b5fbec47a529080

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages

| Name | Type | | ----------------------------------- | ----- | | @celo/phone-number-privacy-monitor | Major | | @celo/phone-number-privacy-combiner | Major | | @celo/identity | Major | | @celo/encrypted-backup | Patch | | @celo/phone-number-privacy-common | Major | | @celo/phone-number-privacy-signer | Major | | odis-example-scripts | Patch |

Not sure what this means? Click here to learn what changesets are.

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

gitguardian[bot] commented 1 month ago

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [10990680](https://dashboard.gitguardian.com/workspace/286247/incidents/10990680?occurrence=164141646) | Triggered | Generic High Entropy Secret | 4a7b2c89a3d73f31a93b4f990642f4f3e83a5394 | packages/common/src/test/values.ts | [View secret](https://github.com/celo-org/social-connect/commit/4a7b2c89a3d73f31a93b4f990642f4f3e83a5394#diff-aa6f35428977e8794b45db673f986523b391c1591bb387ba55a99eb118971e86L7) |

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secret safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate this secret](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/generics/generic_high_entropy_secret#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

socket-security[bot] commented 1 month ago

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@celo/contractkit@8.3.0	filesystem, network	`+5`	5.28 MB	app-tooling
npm/viem@2.21.14	network Transitive: environment, filesystem	`+17`	20.9 MB	jmoxey

View full report↗︎

celo-org / social-connect