chore: upgrade wallet-lib to v1.14.1 by r4mmer · Pull Request #216 · HathorNetwork/hathor-wallet-service

r4mmer · 2025-02-26T16:46:16Z

Motivation

Wallet-lib is a core dependency but is currently 2 major versions outdated.
This PR is the first part upgrading and refactoring the codebase to work with @hathor/wallet-lib@1.14.1

Acceptance Criteria

Upgrade the wallet-lib version to v1.14.1
Refactor codebase to work after breaking changes

Checklist

If you are requesting a merge into master, confirm this code is production-ready and can be included in future releases as soon as it gets merged
Make sure either the unit tests and/or the QA tests are capable of testing the new features
Make sure you do not include new dependencies in the project unless strictly necessary and do not include dev-dependencies as production ones. More dependencies increase the possibility of one of them being hijacked and affecting us.

Decisions

~~### Decision 1~~

~~Code: DEC-0001~~

~~Some constants are network configured and come from the /v1a/version response of the fullnode.~~

~~These constants were previously configured on the config module and updated by the hathorLib.version.checkApiVersion.~~
~~This was replaced by having an ApiConfig instance on the storage to avoid having 1 config for all wallets connected.~~

~~Currently we need to have a way to get these configured constants, we could go with one of the following:~~
~~1. Use pre-configured hardcoded constants.~~
~~2. Get from connected fullnode.~~
~~ - The method maybeRefreshWalletConstants in packages/wallet-service/src/commons.ts can be used to refresh constants based on a request to the fullnode.~~
~~3. Get from wallet-service config.~~

~~Current changes that may change after a decision is made:~~
~~- Uses of hathorLib.transaction.getMaxOutputsConstant()~~
~~ - Temporarily fixed by using constants.MAX_OUTPUTS = 255.~~
~~- Call to hathorLib.version.checkApiVersion() to update variables does not exist~~
~~ - Will use the version api directly so the data can be saved on the database.~~
~~ - Will not save the values until a decision is made.~~

~~### Decision 2~~

~~Code: DEC-0002~~

~~Some constants of the wallet-lib were deprecated, they are being used as sensible defaults but we need to check if we are still going to use these values.~~
~~An example would be the DEFAULT_SERVERS and DEFAULT_SERVER constants.~~

~~We can either:~~
~~- hardcode the values~~
~~ - includes creating a constants file to keep these values.~~
~~- create a way to ensure some settings are configured~~
~~ - This way we do not depend on sensible defaults~~
~~ - The deploy should fail if these are not configured~~

~~Currently the values are being hardcoded to avoid changing any behavior.~~

Files

List of files that were changed:

packages/daemon/src/config.ts
- Use String(process.env...) only in requiredEnvs to ensure typing as string and not string | undefined.

Files that contain @hathor/wallet-lib

Tests files will be changed last since we need to change the methods first.
Package manager files are deferred since they should be updated automatically when upgrading.

* feat: config modules * refactor: Use new config modules

r4mmer · 2025-03-13T15:30:40Z


-    const hathorConfig = hathorLib.constants.HATHOR_TOKEN_CONFIG;
+    // XXX: get config from settings?
+    const hathorConfig = constants.DEFAULT_NATIVE_TOKEN_CONFIG;


This means that the daemon only supports Hathor as native token.
If we require support for side-dags we should add a nodeConfig module on the daemon (or common).

r4mmer · 2025-03-13T15:43:03Z

  expect(returnBody.details[0].message).toBe('Signatures are not valid');
 });

+test('PUT /wallet/auth should fail if we cannot confirm the firstAddress', async () => {


This test was created just to increase coverage to pass the CI

r4mmer · 2025-03-13T15:43:29Z

  expect(wallet.status).toStrictEqual(WalletStatus.ERROR);
 }, 30000);

+test('loadWalletFailed should create alert if xpubkey is missing', async () => {


This test was created just to increase coverage to pass the CI

r4mmer · 2025-03-13T15:49:57Z

    });

    // reload module
+    jest.resetModules();


reset modules is required so that the import('@src/utils/pushnotification.utils') reimports the config and use the most recent values

andreabadesso · 2025-03-18T12:12:44Z

  // get the first address
  const xpubChangeDerivation = walletUtils.xpubDeriveChild(XPUBKEY, 0);
-  const firstAddress = walletUtils.getAddressAtIndex(xpubChangeDerivation, 0, process.env.NETWORK);
+  const firstAddressData = addressUtils.deriveAddressFromXPubP2PKH(xpubChangeDerivation, 0, process.env.NETWORK);


Use the config to get the network?

Did not seem necessary to refactor the tests to also use the config.
What do you think?

Maybe to guarantee that the config is being filled correctly?

…-lib-v1.14.1 * origin/master: fix: NFTs were not being properly processed (#219)

pedroferreira1 · 2025-03-20T01:04:14Z

  // get the first address
  const xpubChangeDerivation = walletUtils.xpubDeriveChild(XPUBKEY, 0);
-  const firstAddress = walletUtils.getAddressAtIndex(xpubChangeDerivation, 0, process.env.NETWORK);
+  const firstAddressData = addressUtils.deriveAddressFromXPubP2PKH(xpubChangeDerivation, 0, process.env.NETWORK);


Maybe to guarantee that the config is being filled correctly?

chore: upgrade wallet-lib to v1.14.1

acfe81d

r4mmer self-assigned this Feb 26, 2025

r4mmer added this to Hathor Network Feb 26, 2025

github-project-automation Bot moved this to Todo in Hathor Network Feb 26, 2025

r4mmer moved this from Todo to In Progress (WIP) in Hathor Network Feb 26, 2025

r4mmer added 8 commits February 26, 2025 18:30

chore: upgrade daemon

c76801f

chore: remove deprecated getAddresses for deriveAddressFromXPubP2PKH

e988c22

chore: upgrade constants used in the wallet-service files

8b9974a

chore: update nft utils tests

aa29132

chore: update tests to use most recent utils and constants

80e40be

chore: ignore type issues with the mocked apis

380cdf1

chore: skip failing test due to DEC-0001

9a3bb63

Feat/node config module (#217)

3142f9a

* feat: config modules * refactor: Use new config modules

r4mmer moved this from In Progress (WIP) to In Progress (Done) in Hathor Network Mar 13, 2025

r4mmer requested review from andreabadesso and pedroferreira1 March 13, 2025 01:44

r4mmer marked this pull request as ready for review March 13, 2025 01:44

r4mmer commented Mar 13, 2025

View reviewed changes

andreabadesso requested changes Mar 18, 2025

View reviewed changes

github-project-automation Bot moved this from In Progress (Done) to In Review (WIP) in Hathor Network Mar 18, 2025

r4mmer added 5 commits March 18, 2025 12:29

chore: review changes

0cb94ac

chore: lock dev dependency version

fa74f27

chore: review changes

18568ae

Merge remote-tracking branch 'origin/master' into feat/upgrade-wallet…

202de27

…-lib-v1.14.1 * origin/master: fix: NFTs were not being properly processed (#219)

chore: adapt changes after master update

e19170a

pedroferreira1 reviewed Mar 19, 2025

View reviewed changes

Comment thread db/migrations/20250306170811-node_version_proxy.js Outdated

Comment thread packages/wallet-service/src/schemas.ts

Comment thread packages/common/src/utils/nft.utils.ts

pedroferreira1 moved this from In Review (WIP) to In Review (Done) in Hathor Network Mar 19, 2025

r4mmer added 2 commits March 19, 2025 16:26

chore: do not directly alter constants

2477efa

chore: fix test typing for mocked data

4e8d9bf

r4mmer moved this from In Review (Done) to In Progress (Done) in Hathor Network Mar 19, 2025

chore: fix typo

4492ec3

r4mmer requested review from andreabadesso and pedroferreira1 March 19, 2025 20:03

pedroferreira1 previously approved these changes Mar 20, 2025

View reviewed changes

pedroferreira1 moved this from In Progress (Done) to In Review (WIP) in Hathor Network Mar 20, 2025

andreabadesso previously approved these changes Mar 21, 2025

View reviewed changes

Comment thread packages/wallet-service/tests/env.test.ts Outdated

r4mmer moved this from In Review (WIP) to In Review (Done) in Hathor Network Mar 24, 2025

tests: make value always the expected on the config test

dfd52bb

r4mmer dismissed stale reviews from andreabadesso and pedroferreira1 via dfd52bb March 24, 2025 23:31

andreabadesso self-requested a review March 25, 2025 13:47

andreabadesso approved these changes Mar 25, 2025

View reviewed changes

pedroferreira1 self-requested a review March 25, 2025 15:36

pedroferreira1 approved these changes Mar 25, 2025

View reviewed changes

github-project-automation Bot moved this from In Review (Done) to In Review (WIP) in Hathor Network Mar 25, 2025

pedroferreira1 moved this from In Review (WIP) to In Review (Done) in Hathor Network Mar 25, 2025

r4mmer merged commit d252f45 into master Mar 25, 2025

github-project-automation Bot moved this from In Review (Done) to Waiting to be deployed in Hathor Network Mar 25, 2025

r4mmer deleted the feat/upgrade-wallet-lib-v1.14.1 branch March 25, 2025 16:00

r4mmer mentioned this pull request Apr 1, 2025

Merge master into release-candidate #227

Merged

2 tasks

r4mmer moved this from Waiting to be deployed to Done in Hathor Network Apr 2, 2025

Conversation

r4mmer commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Acceptance Criteria

Checklist

Decisions

Files

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

r4mmer commented Feb 26, 2025 •

edited

Loading