[DEVOPS-1250] backport RCD-47 fix about 'hasSpendingPassword' metadata with extra sanity check

[KtorZ]

Description

Since a few users have already ran the migration, they might have migrated wallet with incorrect metadata, wrongly stating that
their wallet has no spending password, and as a consequence, preventing them from doing anything with their wallet. So, we do now
run an extra sanity check upon every start to make sure that the wallet acid state metadata matches what we find in the keystore.

Linked issue

[DEVOPS-150]

Type of change

• 🐞 Bug fix (non-breaking change which fixes an issue)
• 🛠 New feature (non-breaking change which adds functionality)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
• 🏭 Refactoring that does not change existing functionality but does improve things like code readability, structure etc
• 🔨 New or improved tests for existing code
• ⛑ git-flow chore (backport, hotfix, etc)

Developer checklist

• I have read the style guide document, and my code follows the code style of this project.
• If my code deals with exceptions, it follows the guidelines.
• I have updated any documentation accordingly, if needed. Documentation changes can be reflected in opening a PR on cardanodocs.com, amending the inline Haddock comments, any relevant README file or one of the document listed in the docs directory.
• CHANGELOG entry has been added and is linked to the correct PR on GitHub.

Testing checklist

• I have added tests to cover my changes.
• All new and existing tests passed.

QA Steps

Creating Wallets on 1.3.x

$ curl -vkX POST "http://localhost:8090/api/v1/wallets" \
  -H "Content-Type: application/json;charset=utf-8" \
  -d '{
  "operation": "create",
  "spendingPassword": "",
  "backupPhrase": [...],
  "assuranceLevel": "normal",
  "name": "Without Password"
}' | jq .data

{
  "id": "Ae2tdPwUPEZ1UMga1bnFFD7FoFN9ZFoPLCWLaGcqNnfovcrcT3oMSuAz8DD",
  "name": "Without Password",
  "hasSpendingPassword": false,
  [..]
}

$ curl -vkX POST "http://localhost:8090/api/v1/wallets" \
  -H "Content-Type: application/json;charset=utf-8" \
  -d '{
  "operation": "create",
  "backupPhrase": [...],
  "spendingPassword": "5416b2988745725998907addf4613c9b0764f04959030e1b81c603b920a115d0",
  "assuranceLevel": "normal",
  "name": "With Password"
}' | jq .data

{
    "id": "Ae2tdPwUPEYvuFeJoBAiYtbFWaZwzya1om6Mqvbz9aL85TncK47bRhL4oZv",
    "name": "With Password",
    "hasSpendingPassword": true,
    [..]
}

Migrating wallet (without patch) from 1.3.x --> 3.0.x

Logs

[2019-03-21 11:32:50.15 UTC] Migrating HdRoot { id: HdRootId Ae2tdPw...SuAz8DD, name: <Migrated Wallet>, hasPassword: no ... }
[2019-03-21 11:32:51.27 UTC] Migrating HdRoot { id: HdRootId Ae2tdPw...RhL4oZv, name: <Migrated Wallet>, hasPassword: no ... }
[2019-03-21 11:32:52.14 UTC] Migration succeeded, restoration of migrated wallets in progress...

Wallet State

$ curl -kX GET http://localhost:8090/api/v1/wallets | jq .data
[
  {
    "id": "Ae2tdPwUPEZ1UMga1bnFFD7FoFN9ZFoPLCWLaGcqNnfovcrcT3oMSuAz8DD",
    "name": "<Migrated Wallet>",
    "hasSpendingPassword": false,
    [...]
  },
  {
    "id": "Ae2tdPwUPEYvuFeJoBAiYtbFWaZwzya1om6Mqvbz9aL85TncK47bRhL4oZv",
    "name": "<Migrated Wallet>",
    "hasSpendingPassword": false,
    [...]
  }
]

Restarting (with patch) an already migrated wallet (without patch) from 1.3.x --> 3.0.x

Logs

[cardano-sl.node:Info:ThreadId 1727] [2019-03-21 11:42:23.90 UTC] Starting wallet(s) migration
[cardano-sl.node:Info:ThreadId 1727] [2019-03-21 11:42:23.90 UTC] No legacy DB at state-devops1250/wallet-db, migration is not needed.

Wallet State

$ curl -kX GET http://localhost:8090/api/v1/wallets | jq .data
[
  {
    "id": "Ae2tdPwUPEZ1UMga1bnFFD7FoFN9ZFoPLCWLaGcqNnfovcrcT3oMSuAz8DD",
    "name": "<Migrated Wallet>",
    "hasSpendingPassword": false,
    [...]
  },
  {
    "id": "Ae2tdPwUPEYvuFeJoBAiYtbFWaZwzya1om6Mqvbz9aL85TncK47bRhL4oZv",
    "name": "<Migrated Wallet>",
    "hasSpendingPassword": true,
    [...]
  }
]

Migrating wallet (with patch) from 1.3.x --> 3.0.x

Logs

[2019-03-21 11:49:03.24 UTC] Migrating HdRoot { id: HdRootId Ae2tdPw...SuAz8DD, name: <Migrated Wallet>, hasPassword: no ... }
[2019-03-21 11:49:04.50 UTC] Migrating HdRoot { id: HdRootId Ae2tdPw...RhL4oZv, name: <Migrated Wallet>, hasPassword: updated 1553168943743216 ... }
[2019-03-21 11:49:04.50 UTC] Migration succeeded, restoration of migrated wallets in progress...

Wallet State

$ curl -kX GET http://localhost:8090/api/v1/wallets | jq .data
[
  {
    "id": "Ae2tdPwUPEZ1UMga1bnFFD7FoFN9ZFoPLCWLaGcqNnfovcrcT3oMSuAz8DD",
    "name": "<Migrated Wallet>",
    "hasSpendingPassword": false,
    [..]
  },
  {
    "id": "Ae2tdPwUPEYvuFeJoBAiYtbFWaZwzya1om6Mqvbz9aL85TncK47bRhL4oZv",
    "name": "<Migrated Wallet>",
    "hasSpendingPassword": true,
    [...]
  }
]

Screenshots (if available)

How to merge

Send the message bors r+ to merge this PR. For more information, see
docs/how-to/bors.md.

[dcoutts]

LGTM, pending QA.

[dcoutts]

Yep, ok. So the Just case is when the password does match the empty password, hence NoSpendingPassword.

[dcoutts]

Yep, logic seems right here too.

[KtorZ]

It's not entirely necessary but I thought it would be a good idea to only make updates to the DB when necessary.

[disassembler]

bors r+

[iohk-bors]

Build succeeded

• buildkite/cardano-sl
• ci/hydra:serokell:cardano-sl:required