[DDW-722] Add sequence diagram

Author: renanvalentin

source/renderer/app/stores/HardwareWalletsStore.address-verification.uml

@@ -0,0 +1,52 @@
+title Ledger Address Verification
+
+participant NanoS
+participant Daedalus
+participant WalletReceivePage
+participant initiateAddressVerification
+participant establishHardwareWalletConnection
+participant getCardanoAdaApp
+participant getExtendedPublicKey
+participant verifyAddress
+participant getHardwareWalletChannel
+participant deviceDetection
+
+
+autoactivation on
+WalletReceivePage->initiateAddressVerification:Start address verification
+
+group Wait for device
+
+
+initiateAddressVerification->getHardwareWalletChannel:Subscribe to WAIT_FOR_LEDGER_DEVICES channel
+
+
+getHardwareWalletChannel->deviceDetection:check for new devices
+
+NanoS->deviceDetection:Enter Pin
+
+getHardwareWalletChannel<--deviceDetection:Device info
+
+initiateAddressVerification<--getHardwareWalletChannel:Reply WAIT_FOR_LEDGER_DEVICES channel\nwith device info
+
+end
+deactivateafter initiateAddressVerification
+autoactivation off
+
+
+initiateAddressVerification->establishHardwareWalletConnection:get transport info
+initiateAddressVerification<--establishHardwareWalletConnection:device transport
+
+activate initiateAddressVerification
+initiateAddressVerification->initiateAddressVerification:start Ada App polling
+
+
+NanoS->deviceDetection:Open Ada App
+getCardanoAdaApp<--deviceDetection:App opened
+
+deactivate initiateAddressVerification
+
+getCardanoAdaApp->getExtendedPublicKey:Get public key
+getExtendedPublicKey->verifyAddress:Address verification
+
+WalletReceivePage<--verifyAddress:address verified

source/renderer/app/stores/HardwareWalletsStore.transaction.uml

@@ -0,0 +1,48 @@
+title Ledger Initiate Transaction
+
+participant NanoS
+participant Daedalus
+participant WalletReceivePage
+participant initiateTransaction
+participant getCardanoAdaApp
+participant getExtendedPublicKey
+participant signTransactionLedger
+participant getHardwareWalletChannel
+participant deviceDetection
+
+
+autoactivation on
+WalletReceivePage->initiateTransaction:Start a new transaction
+
+group Wait for device
+
+
+initiateTransaction->getHardwareWalletChannel:Subscribe to WAIT_FOR_LEDGER_DEVICES channel
+
+
+getHardwareWalletChannel->deviceDetection:check for new devices
+
+NanoS->deviceDetection:Enter Pin
+
+getHardwareWalletChannel<--deviceDetection:Device info
+
+initiateTransaction<--getHardwareWalletChannel:Reply WAIT_FOR_LEDGER_DEVICES channel\nwith device info
+
+end
+deactivateafter initiateTransaction
+autoactivation off
+
+
+activate initiateTransaction
+initiateTransaction->initiateTransaction:start Ada App polling
+
+
+NanoS->deviceDetection:Open Ada App
+getCardanoAdaApp<--deviceDetection:App opened
+
+deactivate initiateTransaction
+
+getCardanoAdaApp->getExtendedPublicKey:Get public key
+getExtendedPublicKey->signTransactionLedger:Verify transaction
+
+WalletReceivePage<--signTransactionLedger:transaction completed

source/renderer/app/stores/HardwareWalletsStore.wallet-pairing.uml

@@ -0,0 +1,73 @@
+# visit https://sequencediagram.org/
+
+title Ledger Wallet Pairing
+
+participant NanoS
+participant Daedalus
+participant WalletAddPage
+participant HardwareWalletsStore
+participant changeHardwareWalletConnectionStatus
+participant initiateWalletPairing
+participant establishHardwareWalletConnection
+participant getCardanoAdaApp
+participant getExtendedPublicKey
+participant getHardwareWalletChannel
+participant deviceDetection
+participant localStorage
+
+Daedalus->HardwareWalletsStore:Setup HW store
+
+HardwareWalletsStore->changeHardwareWalletConnectionStatus:setup listeners
+
+changeHardwareWalletConnectionStatus->getHardwareWalletChannel:subscribe to\n GET_HARDWARE_WALLET_CONNECTION_CHANNEL
+activate changeHardwareWalletConnectionStatus
+activate getHardwareWalletChannel
+
+getHardwareWalletChannel->deviceDetection:listen for new devices
+activate getHardwareWalletChannel
+activate deviceDetection
+
+par Device not connected
+WalletAddPage->initiateWalletPairing: start pairing
+
+initiateWalletPairing->establishHardwareWalletConnection:Try to get device info
+
+note over initiateWalletPairing,establishHardwareWalletConnection:This method can:\n1- Return transport payload\n2- Start Ada App\n3- Mutate flag to wait for device
+
+
+HardwareWalletsStore<--establishHardwareWalletConnection:Wait for device\nisListeningForDevice=true
+
+
+
+end
+
+NanoS->deviceDetection:Enter Pin
+
+getHardwareWalletChannel<--deviceDetection:Device information
+deactivate getHardwareWalletChannel
+deactivate deviceDetection
+
+
+changeHardwareWalletConnectionStatus<--getHardwareWalletChannel:Reply to\n GET_HARDWARE_WALLET_CONNECTION_CHANNEL
+deactivate changeHardwareWalletConnectionStatus
+deactivate getHardwareWalletChannel
+
+changeHardwareWalletConnectionStatus->localStorage:Save temporary device info
+
+changeHardwareWalletConnectionStatus->establishHardwareWalletConnection:Re-start connection process
+
+activate establishHardwareWalletConnection
+establishHardwareWalletConnection->establishHardwareWalletConnection:start Ada App polling()
+
+
+NanoS->deviceDetection:Open Ada App
+getCardanoAdaApp<--deviceDetection:App opened
+
+deactivate establishHardwareWalletConnection
+
+getCardanoAdaApp->getExtendedPublicKey:Get public key
+getExtendedPublicKey->localStorage:Save device info
+
+getExtendedPublicKey<--localStorage:Device saved
+
+getExtendedPublicKey-->WalletAddPage:Redirect to wallet page