From 2ccb3aa04e9f05936983e23023697a7780727642 Mon Sep 17 00:00:00 2001 From: Tomas Susanka Date: Wed, 29 Apr 2020 09:45:48 +0200 Subject: [PATCH] docs/third-parties: explain connect dependencies --- docs/misc/third-parties.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/misc/third-parties.md b/docs/misc/third-parties.md index 97db206ed..a8b919631 100644 --- a/docs/misc/third-parties.md +++ b/docs/misc/third-parties.md @@ -24,10 +24,28 @@ _Updating HWI to the latest version should be enough._ - Blockstream Green iOS https://github.com/Blockstream/green_ios ### Using Connect: -_This usually only requires updating Connect to the latest version._ -See https://github.com/trezor/connect/network/dependents for a full list -of projects depending on Connect. +_See https://github.com/trezor/connect/network/dependents for a full list +of projects depending on Connect._ + +#### Connect dependencies introduction + +Javascript projects that have Connect as a dependency are using the [Connect NPM +package](https://www.npmjs.com/package/trezor-connect) on version specified in their +yarn.lock (or similar). This NPM package is not a complete Connect library, it is a +simple layer that deals with opening an iframe and loading the newest Connect from +connect.trezor.io. + +Such project must have the newest MAJOR version of this NPM package (v8 at the moment). +But then the main logic library (dealing with devices etc.) is fetched from +connect.trezor.io and is therefore under our control and can be updated easily. + +So in a nutshell: +- If there is a new MAJOR version of Connect we indeed want to notify these parties below. +- In other cases we do not, we just need to deploy updated Connect before releasing +firmwares. + +#### Notable third-parties - Exodus (closed source) - MagnumWallet (closed source)