Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/porco-rosso-j/safe-recovery-noir
https://github.com/porco-rosso-j/safe-recovery-noir
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/porco-rosso-j/safe-recovery-noir
- Owner: porco-rosso-j
- Created: 2023-08-18T18:15:30.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-02-11T22:40:42.000Z (9 months ago)
- Last Synced: 2024-02-12T23:32:18.840Z (9 months ago)
- Language: Solidity
- Size: 2.4 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-noir - SafeRecover - Recovery of ownership of Gnosis Safe accounts (Projects / Authentication)
README
# safe-recovery-noir
## Introduction
A safe plugin that allows Safe owners to recover account ownership in the case where they lose access to their Safe. All the recovery methods leverage Noir, a DSL for writing zero-knowledge proof circuits, to help owners recover their account in a secure and private manner.
This product is developed as a grantee of the Safe Grant Program Wave I. Here is [the proposal on Safe Grant website](https://app.charmverse.io/safe-grants-program/page-43692424934796636) and [Announcement](https://t.co/Pdc4Pxvg3s).
#### Recovery Mechanisms
Available recovery methods:
- Private Backup Address Recovery:
This method allows backup signer, whose eth address is hashed and stored in smart contract, to recover account by proving that the the hashed hidden address matches the the hash of an eth address that is ec-recovered with provided public keys, signature, and message in k256 circuit.
- TouchID Recovery:
This method allows for account recovery via the correct verification of ECDSA with p256 curve for a provided fingerprint signature generated through WebAuthn on user device.
- Secret Word Recovery:
This method lets a user recover account by privately proving the knowledge of a particular secret word.
- Social Recovery:
This method allows private guardians, whose eth addresses are included in a merkle root stored on smart contract, to recover account ownership by proving their membership in the merkle root. Recovery can successfully be executed if the suffcient number of guardians approve a proposed recovery.
- Other zk-powered methods to be explored:
1. 2FA,
2. email
3. other biometrics
This recovery app is built on top of [safe-core-protocol](https://github.com/5afe/safe-core-protocol), a modular smart account protocol so that Safe and other wallet apps can easily integrate to enhance the security of user funds. The recovery plugin performs a batched call that executes `swapOwner` and `changeThreshold` simultaneously to flexibly rearrange the account authority: replace `owners` and change `threshold`.
## Test
Noir circuits
- Noir version: `0.19.2+47f0130c0d154f1b70eb23f376783beb3f23ad72`
- To install
```shell
noirup -v 0.19.2
```
- Nargo commands
```shell
cd circuits/{CIRCUIT_NAME}
nargo compile
nargo test --show-output
nargo prove
nargo verify
```
Smart contracts
```shell
forge build
forge test --match-contract RecoveryPluginNoirTest -vvv
```
## Deploy
run forked goerli chain
```shell
anvil --fork-url goerli
forge script script/Deploy.s.sol:Deploy --rpc-url localhost --broadcast
```
start frontend
```shell
cd front
yarn
yarn start
```
### Deployment
[https://safe-recover-noir.netlify.app/](https://safe-recover-noir.netlify.app/)
#### Goerli
- SafeProtocolRegistry: `0xe08E526eD40feBD25041eF1666eBDCf1B9896789`
- SafeProtocolManager: `0xC0e4565287B0fd807CdE3F89bAB469E0ca6Cc190`
- SafeRecoverFactory: `0xaa88410f04089bD7031cc6f5A122b231d7452278`
## References
#### Past Projects
- [AnonAA](https://github.com/porco-rosso-j/zk-ecdsAA)
- [noir-browser-p256](https://github.com/porco-rosso-j/noir-browser-p256)
- [zksync-account-webauthn](https://github.com/porco-rosso-j/zksync-account-webauthn)
#### Others
- [Noir](https://noir-lang.org/)
- [Safe {Core} Protocol](https://docs.safe.global/safe-core-protocol/safe-core-protocol)
- [safe-core-protocol](https://github.com/5afe/safe-core-protocol)