Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Latest commit

 

History

History
139 lines (90 loc) · 4.39 KB

README.md

File metadata and controls

139 lines (90 loc) · 4.39 KB
Raw

Argent Account on zkSync

⚠️ Warning ⚠️

This project and in particular the ArgentAccount.sol contract, is deprecated and should not be used to store significant value.

This repository is excluded from any bug bounty program operated by Argent

Overview

The account is similar to a 2-of-2 multisig. With two parties with different roles, the owner and the guardian.

The owner key is under user control. Typically stored on the user's phone. Users must keep a safe back up of this key.

The guardian is both as a co-validator for typical operations of the wallet (including fraud monitoring), and an actor that can help recover the wallet in case the owner key is lost or compromised.

It's important to note that the guardian alone will not have control over the wallet. Normal operations of the wallet require the approval of both parties to be executed.

The user can always opt-out of the guardian service and manage the account himself, losing the protection offered by the guardian.

Alternatively, he/she can add a second guardian_backup key to the account. It can be used as a replacement for the guardian. This will provide the highest guarantee for guardian censorship resistance.

Under this model we can build a simple yet highly secure non-custodial wallet.

Escape

In case one party is not cooperating (maybe keys were lost or compromised), the other party alone can trigger the escape mode (a.k.a. recovery) on the wallet.

An escape takes 7 days before being ready. After the time delay, the non-cooperating party can be replaced ("escaped").

The wallet is asymmetric in favor of the owner who can override an escape triggered by the guardian. So in case both parties try to escape each other the owner has the upper hand.

A triggered escape can always be canceled with the approval of both parties.

Upgrade

To enable the model to evolve if needed, the account is a proxy to a target implementation. Upgrading to a new implementation requires the approval of both the owner and a guardian.

Required signatures in each method

Action Owner Guardian Comments
regular transaction X X
upgrade X X
changeOwner X X
changeGuardian X X
changeGuardianBackup X X
cancelEscape X X
triggerEscapeOwner X Fails if guardian escape in progress
escapeOwner X After security period
triggerEscapeGuardian X Overrides an owner escape in progress
escapeGuardian X After security period

Development

Local setup

Install Docker Desktop.

yarn

This will install the latest zkSync local node in local-setup/ and pull its Docker images.

Use the local node

yarn start
yarn stop

Compile the contracts

yarn hardhat compile

Test the contracts

Locally:

yarn test

On goerli:

yarn test test/account.test.ts --network zkSyncTestnet

Deployment

Run once for every new contract version, the addresses will be stored in config/.

  1. Update the contract version in ArgentAccount.sol.

  2. Create corresponding deployment folder:

version="0.1.2"
env="mainnet"
name="$version-$env"
network="zkSyncMainnet"

mkdir deployments/$name
  1. Deploy implementation and factory:
VERIFY=true yarn hardhat run scripts/deploy-infrastructure.ts --network $network
  1. Update the deployment:
cp config/$network.json deployments/$name/config.json
cp artifacts-zk/contracts/{ArgentAccount.sol/ArgentAccount.json,AccountFactory.sol/AccountFactory.json} deployments/$name
  1. Deploy a new account:
VERIFY=true yarn hardhat run scripts/deploy-account.ts --network $network
  1. Run some tests:
yarn test test/account.test.ts --network $network
  1. Tag and push
git tag v$version
git push --tags