WebSockets on the IC – A proof-of-concept

We are happy to share with you our WebSockets proof-of-concept, which demonstrates the potential of enabling WebSockets on the IC through a dedicated gateway.


To facilitate WebSocket connections between frontends and canisters on the IC, we use a gateway. This gateway provides a standard WebSocket endpoint for frontends and handles the communication with the canister. It establishes WebSocket connections with canisters through update calls and uses polling to obtain the latest messages and deliver them to the client.

We invite you to explore the code on GitHub, available at GitHub - dfinity/ic-websocket-poc. This repository can serve as a starting point for developers interested in leveraging WebSockets on the IC. However, please note that this proof-of-concept requires further improvements to enhance security and stability (e.g. using SSL and enhancing error handling) and is not usable in production.

We encourage you to give it a try and let us know what you think!

38 Likes

Amazing, Dfinity opening up its wide harms.

3 Likes

Hey! that’s an amazing feature. Let people to create DApps where communication is not a problem. Congrats to Dfinity team!

5 Likes

Supercool.

Regarding security, what is the vision there? E.g. will the websockets support certified data, equivalent to certified queries? I.e. will a developer be able to take data, sign it as for certified queries, then post it and have it validated by the service worker? The crypto part is definitely possible to do oneself; does it make sense to include such functionality out of the box to make it easy for developers to write secure code first time?

1 Like

The proof-of-concept already makes use of certification and signatures so that the gateway is trustless. :slight_smile: Messages from the canister (together with a timestamp and a sequence number) are certified. Likewise messages from the client are signed using the key the client registered in the first update call.

5 Likes

Me and @ilbert are planning to continue the work on this PoC. If interested in more details check this out.

3 Likes

Powerful proof-of-concept ! Any updates or an ETA for production workloads?

Just saw the beta release from the community. Cool !

1 Like

We’re slowly starting to release a stable version out. In the tutorial that we wrote at WebSockets 🔌 on the Internet Computer: Getting Started | by Luca Bertelli | Medium you can find all the details to get started using the IC WebSocket integration.

Motoko CDK will follow.

The WebSocket Gateway can now be considered trustless as it cannot tamper, reorder or block the messages without being detected by both the client and the canister. We’re waiting for the vetKeys to become generally available to integrate them into our libraries and make sure the Gateway can’t even read the messages.

Let us know if you need any further help.

2 Likes

Nice tutorial, ping-pong is the hello world of network stack code, awesome! Imho, what matters isn’t that it’s available for multiple of languages, but instead it’s rock :mountain: solid in just one language. There are definitely a couple of use cases w/o a sensitive message payload, and there are workarounds for encrypting a message payload before vetKeys goes GA. Great work @massimoalbarello & @ilbert, w(h)en production-ready :rocket:?

2 Likes

We expect in few weeks.

3 Likes

Check this out! There will likely be frequent minor updates in the next weeks to the SDKs, but they can already be used!

2 Likes