4b576a70ad
feat(pairing)!: add fallback flow to pairing This commit includes the following changes: *Breaking change in connection string* The local pairing code that was parsing the connection string had a few non-upgradable features: - It was strictly checking the number of parameters, throwing an error if the number was different. This made it impossible to add parameters to it without breaking. - It was strictly checking the version number. This made increasing the version number impossible as older client would just refuse to connect. The code has been changed so that: - Version is not used. Better not to use something than to use it wrongly, rarely version is needed if the protocol is correctly upgraded. - Two parameters have been added, `installation-id` and `key-uid`. Those are needed for the fallback flow. I have also removed version from the payload, since it wasn't used. This means that we don't support v1 anymore. V2 parsing should be supported (a new might be able to parse a v2 client, but not the other way around). It is to be considered a complete breaking change. 2.30 -> 2.30 syncing only is supported, but going forward there's a clear strategy on how to update the protocol (append parameters, don't change existing one). *Changed `MessengerResponse` to use internally a map of `installations` rather than an array (minor)* Just moving towards maps as arrays tend to lead to subtle bugs. *Moved pairing methods to messenger_pairing.go* Just moved some methods *Added 2 new methods for the fallback flow* `FinishPairingThroughSeedPhraseProcess` https://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R29 `EnableAndSyncInstallation` https://github.com/status-im/status-go/pull/5567/files#diff-1ad620b07fa3bd5fbc96c9f459d88829938a162bf1aaf41c61dea6e38b488d54R18 *Flow for clients* Client A1 is logged in Client A2 is logged out 1) Client A1 shows a QR code 2) Client A2 scans a QR code 3) If connection fails on A2, the user will be prompted to enter a seed phrase. 4) If the generated account matches the `key-uid` from the QR code, A2 should call `FinishPairingThroughSeedPhraseProcess` with the installation id passed in the QR code. This will send installation information over waku. The user should be shown its own installation id and prompted to check the other device. 5) Client A1 will receive new installation data through waku, if they are still on the qr code page, they should show a popup to the user showing the received installation id, and a way to `Enable and Sync`, which should call the `EnableAndSyncInstallation` endpoint. This should finish the fallback syncing flow. *Current issues* Currently I haven't tested that all the data is synced after finishing the flow. I see that the two devices are paired correctly, but for example the `DisplayName` is not changed on the receiving device. I haven't had time to look into it further.
Mobile
Package mobile implements gomobile bindings for status-go. Current implementation servers as a drop-in replacement for lib package.
Individual bindings and their descriptions are available in status.go.
The primary consumer of this package is status-mobile project.
The framework name is generated from the package name, hence these things are done intentionally:
(1) this package's name isn't equal to the directory name (statusgo vs mobile respectively);
(2) this package name is statusgo and not status which produces the right framework name.
Usage
For properly using this package, please refer to Makefile in the root of status-go directory.
To manually build library, run following commands:
iOS
gomobile bind -v -target=ios -ldflags="-s -w" github.com/status-im/status-go/mobile
This will produce Statusgo.framework file in the current directory, which can be used in iOS project.
Android
gomobile bind -v -target=android -ldflags="-s -w" github.com/status-im/status-go/mobile
This will generate Statusgo.aar file in the current dir.
Notes
See https://github.com/golang/go/wiki/Mobile for more information on gomobile usage.