Skip to content

Commit

Permalink
update: audit/deployments information in readme (#24)
Browse files Browse the repository at this point in the history
* update: audit/deployments information in readme

* fix: wording
  • Loading branch information
yoanslvy authored Jan 11, 2024
1 parent ec83ce3 commit 0931921
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# P256 Signer

This library implements the decoding and verification of a signed [Webauthn](https://www.w3.org/TR/webauthn-2/) payload following the [EIP 1271](https://eips.ethereum.org/EIPS/eip-1271) providing an implementation of Standard Signature Validation Method when the account is a smart contract.

## Contracts overview
Expand All @@ -20,7 +21,14 @@ The `P256Signer` contract represents a Gnosis Safe signer for a given secp256r1

The `P256SignerFactory` contract is a factory for P256Signers. It allows us to have deterministic addresses for a given secp256r1 public key.

## Audits

Gnosis chain audit: https://gnosischain.notion.site/p256-signer-Audit-a9e7807bc9dd4a768d0f78e3919d3eac

We've updated our contracts following the audit's recommandations, see deployments: https://github.com/cometh-hq/p256-signer/pull/23

## Signature malleability

Clients need to note there is a potential signature malleability by replacing `(r, s)` by `(r, -s mod n)`.
It is the responsibility of the client to check the message signed is played only once if necessary.

Expand All @@ -30,21 +38,25 @@ You will need `INFURA_ID=<your_infura_id>` in your env variables.
You will need forge installed, see foundry book for instructions [here](https://book.getfoundry.sh/getting-started/installation).

Install FCL dependency:

```bash
forge install
```

To launch both hardhat and forge tests:

```bash
yarn test
```

### Hardhat

```bash
npx hardhat test
```

### Forge

```bash
forge test
```
Expand All @@ -53,4 +65,4 @@ forge test

```bash
HARDHAT_NETWORK=<target_network> npx hardhat deploy
```
```

0 comments on commit 0931921

Please sign in to comment.