safe-global / safe-client-gateway
93%
main: 90%

LAST BUILD BRANCH: notificationRecoverSignature
DEFAULT BRANCH: main
Repo Added
Files 754
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH HEAD
branch: HEAD
CHANGE BRANCH
x

coverage: 93.029% (+0.01%) from 93.019%
7830407802

push

github

web-flow 
Add route to retrieve email address (#1116)

- Adds a new route to retrieve an email address: `GET /v1/chains/:chainId/safes/:safeAddress/emails/:signerAddress`
- This route returns the `emailAddress` and respective verification status for authenticated requests. If there are no emails associated with the signer a `404 Not Found` is returned. 

```
GET /v1/chains/:chainId/safes/:safeAddress/emails/:signerAddress

{
  email: <string>, // the signer's email address
  verified: <boolean>, // the current verification status of the email
}
```

- This new route requires two headers to be set:
  * `Safe-Wallet-Signature` – which includes the signature of the expected message
  * `Safe-Wallet-Signature-Timestamp` – which includes the timestamp that is signed with the message
- The expected message to be signed is: `email-retrieval-${chainId}-${safe}-${signer}-${timestamp}`
- A signature is only valid for 5 minutes. If a signature is re-used after these 5 minutes, a `403 Forbidden` is returned.

Future work:

We can move the authentication components to the headers instead for the other endpoints that require some sort of authentication. This decouples the authentication part with the payload part of each request which was an issue when building this `GET` endpoint.

1515 of 1819 branches covered (0.0%)

Branch coverage included in aggregate %.

5812 of 6057 relevant lines covered (95.96%)

182.51 hits per line

Relevant lines Covered
6057 RELEVANT LINES 5812 COVERED LINES
182.51 HITS PER LINE
Source Files on HEAD

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
7830407802 HEAD Add route to retrieve email address (#1116) - Adds a new route to retrieve an email address: `GET /v1/chains/:chainId/safes/:safeAddress/emails/:signerAddress` - This route returns the `emailAddress` and respective verification status for authen... push web-flow github
93.03
See All Builds (6448)