Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SIP-24: WebSocket connections for Keyring Snaps #143

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add SIP-24: WebSocket connections for Keyring Snaps #143

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db9da21
Initial draft for SIP-24.
tmpfs Aug 8, 2024
14f061a
Prefer adding allowedOrigins to endowment:network-access.
tmpfs Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions SIPS/sip-24.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sip: 24
title: WebSocket Connections
status: Draft
discussions-to: https://github.com/MetaMask/SIPs/discussions/142
author: Muji (@tmpfs)
created: 2024-08-08
---

## Abstract

This SIP describes a way for Snaps using the Keyring API to establish WebSocket connections.

## Motivation

Snaps that need to perform multi-party computation (MPC) for threshold signatures schemes (TSS) require sending various messages in rounds to participants over the network; MPC communication is best suited to a session-based WebSocket connection. This SIP is concerned with using WebSocket connections to sign transactions as part of the Keyring API and not the more generic use case defined in [SIP-20](/SIPS/sip-20.md).

## Specification

> Formal specifications are written in TypeScript.

### Language

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" written in uppercase in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)

### Snap Manifest

This SIP specifies an addendum that MAY be applied to existing and future Snap handler permissions for `endowment:network-access`. The addendum is that the `allowedOrigins` array may contain URLs using the `wss:` or `ws:` schemes.

The caveat is specified as follows in the manifest:

```json
{
"initialPermissions": {
"endowment:network-access": {
"allowedOrigins": [
"https://tss.ac",
"wss://relay.tss.ac"
]
},
}
}
```

## Copyright

Copyright and related rights waived via [CC0](../LICENSE).
Loading