[READY] Migrate signer-service to Typescript #352

Sharqiewicz · 2025-01-06T18:15:42Z

PR 🦈🟢

Migrate all files in signer-service to Typescript
Configure SWC ( TS Compiler )
Configure commands:
yarn build Compiles TypeScript code into JavaScript using the fast SWC compiler
yarn start Runs the compiled application
yarn build:start Compiles and then immediately runs the application (When you want to test production)
yarn dev Runs the application in development mode with automatic reloading on code changes

How to review

There are only two new files .swcrc and tsconfig.json they are short and consistent.
The challenge with the review is going through every migrated file. I tried to keep the logic the same, but sometimes there were a lot of TypeScript errors, so I had to make changes to the files.

netlify · 2025-01-06T18:16:07Z

✅ Deploy Preview for pendulum-pay ready!

Name	Link
🔨 Latest commit	`98a669d`
🔍 Latest deploy log	https://app.netlify.com/sites/pendulum-pay/deploys/67ac972484295900083e4bbb
😎 Deploy Preview	https://deploy-preview-352--pendulum-pay.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

gianfra-t · 2025-01-17T16:38:34Z

signer-service/src/api/controllers/moonbeam.controller.ts

+  const { id, payload } = req.body;
+
+  try {
+    if (!MOONBEAM_EXECUTOR_PRIVATE_KEY) {


We already check for this variable (and any required one) on index.ts, using validateRequiredEnvVars, when the service starts.

Because we should never reach this function without the variable because the process will break in the middle.

gianfra-t · 2025-01-17T17:00:53Z

signer-service/src/api/controllers/quote.controller.ts

+  toFiat: FiatCurrency,
+  amount: string,
+  network?: string,
+) => Promise<unknown>;


We could provide type AnyQuote = AlchemyPayQuote | MoonpayQuote | QuoteResult; wdyt?

Very good catch!

gianfra-t · 2025-01-17T17:10:35Z

signer-service/src/api/controllers/quote.controller.ts

+export const getQuoteForProvider = async (req: Request, res: Response, next: NextFunction) => {
+  const { provider, fromCrypto, toFiat, amount, network } = req.query;
+
+  if (!provider || typeof provider !== 'string') {


These checks are also in the validators, but I guess we need them for the typing 🤔.

Yes, we need it for TS

gianfra-t · 2025-01-17T17:27:38Z

signer-service/src/api/controllers/siwe.controller.ts

+import { createAndSendNonce, verifyAndStoreSiweMessage } from '../services/siwe.service';
+import { DEFAULT_LOGIN_EXPIRATION_TIME_HOURS } from '../../constants/constants';
+
+interface SiweRequestBody {


I think we are not using this interface.

gianfra-t · 2025-01-20T12:18:58Z

signer-service/src/api/helpers/memoDerivation.ts

+type HashValue = `0x${string}` | Uint8Array;
+
+/**
+ * Returns the hash value for the address.


I think the previous comment was off. And the name of the function itself. It is returning the raw data/ decoded value of the address actually, not the hash.

I agree, very good suggestion

signer-service/src/api/middlewares/auth.ts

gianfra-t

Thanks for this refactor @Sharqiewicz ! I only left mostly type and preference related comments.
The one I think we may need to change is this one. The way it is right now it can work, but it will always pick up the first cookie, which may or may not match with the address the user wants to use (substrate or evm). The previous for loop may be required.

gianfra-t

Never mind my last comment, only small comments!

ebma

Thanks for going through this tedious process @Sharqiewicz 👌 Looks good overall, I just found a few things we might want to improve.

Some remarks:

IIRC our deployment currently assumes that yarn start is enough to run the signer-service. If we now split it up into yarn build and yarn start, we'll have to touch the deployment instructions of the service or it won't start. This is an important consideration before we merge this. Either we a) combine building and running in yarn start or b) change the deployment steps. b) is favorable IMO.
The linting seems to be broken. yarn lint finds lots of issues that doesn't seem like issues to me. Maybe we need to change the config files.

ebma · 2025-01-21T19:06:16Z

signer-service/package.json

  "license": "MIT",
  "engines": {
    "node": ">=12",
    "yarn": "*"
  },
  "scripts": {
-    "precommit": "yarn lint-staged && yarn lint",


We should keep the precommit script so that the code formatting is consistent.

ebma · 2025-01-21T19:18:08Z

signer-service/src/api/controllers/googleSpreadSheet.controller.ts

+    const credentials: GoogleCredentials = {
+      email: config.spreadsheet.googleCredentials.email ?? '',
+      key: config.spreadsheet.googleCredentials.key ?? '',
+    };


We have multiple defintions for the type GoogleCredentials, one with string | undefined and one with string. I think it makes more sense to keep the interface string | undefined and don't do the ?? '' check here. initGoogleSpreadsheet() checks if the values are undefined anyway.

ebma · 2025-01-21T19:22:03Z

signer-service/src/constants/constants.ts


 const PENDULUM_FUNDING_SEED = process.env.PENDULUM_FUNDING_SEED;
 const FUNDING_SECRET = process.env.FUNDING_SECRET;
 const MOONBEAM_EXECUTOR_PRIVATE_KEY = process.env.MOONBEAM_EXECUTOR_PRIVATE_KEY;
 const SEP10_MASTER_SECRET = FUNDING_SECRET;
 const CLIENT_DOMAIN_SECRET = process.env.CLIENT_DOMAIN_SECRET;

-module.exports = {
+export {


How about we group all constants in an object const constants = { ... } and export only that object? Makes importing all these constants easier, I think.

I don't think we import all of them anywhere. If we need to import all of them, we can simply use import * as constants from 'constants'

ebma · 2025-01-21T19:24:38Z

signer-service/src/api/controllers/moonbeam.controller.ts

+};
+
+export const executeXcmController = async (req: Request, res: Response): Promise<void> => {
+  const { id, payload } = req.body;


Nit: We could also define the types for the body like you did for other controller functions.

ebma · 2025-01-21T19:26:55Z

signer-service/src/api/routes/v1/index.ts

+import { sendStatusWithPk as sendStellarStatusWithPk } from '../../services/stellar.service';
+import { sendStatusWithPk as sendPendulumStatusWithPk } from '../../services/pendulum/pendulum.service';
+import { sendStatusWithPk as sendMoonbeamStatusWithPk } from '../../controllers/moonbeam.controller';


Nit: This is not consistent. Sometimes it's using a function from a *.service or form a *.controller. There even is a function sendStatusWithPkControlller in pendulum.controller which is never used.

ebma · 2025-01-22T15:50:16Z

signer-service/src/api/middlewares/validators.ts

+const validateQuoteInput: RequestHandler = (req, res, next) => {
+  const { provider, fromCrypto, toFiat, amount, network } = req.query as unknown as QuoteQuery;


Can't we define all of these types directly on the RequestHandler instead of casting?

Suggested change

const validateQuoteInput: RequestHandler = (req, res, next) => {

const { provider, fromCrypto, toFiat, amount, network } = req.query as unknown as QuoteQuery;

const validateQuoteInput: RequestHandler<_,_,QuoteQuery> = (req, res, next) => {

const { provider, fromCrypto, toFiat, amount, network } = req.query as unknown as QuoteQuery;

ebma · 2025-01-22T15:51:34Z

signer-service/src/api/middlewares/validators.ts

+export {
+  validateChangeOpInput,
+  validateQuoteInput,
+  validateCreationInput,
+  validatePreSwapSubsidizationInput,
+  validatePostSwapSubsidizationInput,
+  validateStorageInput,
+  validateEmailInput,
+  validateRatingInput,
+  validateExecuteXCM,
+  validateSep10Input,
+  validateSiweCreate,
+  validateSiweValidate,
+};


I think it would be better to just add the export keyword to each function instead of exporting them in a batch.

ebma · 2025-01-22T15:53:29Z

signer-service/src/api/routes/v1/moonbeam.route.ts

+import { executeXcmController } from '../../controllers/moonbeam.controller';
+import { validateExecuteXCM } from '../../middlewares/validators';
+
+const router: Router = Router({ mergeParams: true });


We didn't define mergeParams: true here before. Could lead to issues if we are not careful.

ebma · 2025-01-22T15:54:10Z

signer-service/src/api/routes/v1/pendulum.route.ts

+import { Router } from 'express';
+import { fundEphemeralAccountController } from '../../controllers/pendulum.controller';
+
+const router: Router = Router({ mergeParams: true });


mergeParams also wasn't defined here before.

ebma · 2025-01-22T16:01:45Z

signer-service/src/api/services/siwe.service.ts

 };

-module.exports = { verifySiweMessage, verifyAndStoreSiweMessage, createAndSendNonce, validateSignatureAndGetMemo };
+export { verifySiweMessage, verifyAndStoreSiweMessage, createAndSendNonce, validateSignatureAndGetMemo };


Maybe also remove the batched export. What's your general opinion on this @Sharqiewicz?

I agree, I also don't like batched exports

…om:pendulum-chain/vortex into 281-switch-to-typescript-in-signer-service

Sharqiewicz · 2025-02-07T16:35:34Z

@ebma
I changed the commands to:

    "build": "swc src -d dist --strip-leading-paths",
    "serve": "node dist/index.js",
    "start": "yarn build && yarn serve"

so yarn start is enough for the deployment

gianfra-t · 2025-02-11T17:30:03Z

signer-service/src/api/controllers/pendulum.controller.ts

+  }
+};
+
+export const sendStatusWithPkController = async (_req: Request, res: Response, _next: NextFunction) => {


I think we're not using this fn anymore.

Good catch @gianfra-t

gianfra-t

Thanks for addressing the comments @Sharqiewicz !

Sharqiewicz added 5 commits January 6, 2025 18:24

add typescript @types and swc

b602482

add tsconfig.json

57ca30e

add .swcrc

7b213eb

migrate index.ts

6d57274

migrate tokenConfig

95886f8

Sharqiewicz linked an issue Jan 6, 2025 that may be closed by this pull request

Switch to TypeScript in signer service #281

Open

Sharqiewicz added 23 commits January 6, 2025 19:37

migrate constants.ts

d502b32

migrate express.ts

9c9a50e

migrate vars

70e0117

migrate logger.ts

acc515a

migrate alchemypay

25322f3

migrate pendulum service and moonpay service

b4f7965

migrate sep10

6ddf848

migrate siwe

b9a8769

migrate slack

7ee59ba

migrate spreadsheet

ea26b5c

migrate transak

5789b0e

migrate stellar

95f8380

migrate anchors

55e338f

migrate memoDerivation

e3f1255

migrate siweMessageFormatter

fe9adc2

fix siwe service

438e8a4

migrate api-error

c3e2b8a

migrate extendable-error

c68f9ec

migrate googleSpreadSheet controller

3be486d

fix type mismatch googleSpreadSheet

38f5b03

migrate moonbeam

a419963

migrate pendulum controller

f357687

migrate quote controller

a11f768

gianfra-t reviewed Jan 17, 2025

View reviewed changes

gianfra-t reviewed Jan 20, 2025

View reviewed changes

signer-service/src/api/middlewares/auth.ts Show resolved Hide resolved

gianfra-t requested changes Jan 20, 2025

View reviewed changes

gianfra-t approved these changes Jan 20, 2025

View reviewed changes

Rename package to vortex-signer-service

fa0906f

ebma reviewed Jan 22, 2025

View reviewed changes

Sharqiewicz added 3 commits February 7, 2025 14:16

Merge branch 'staging' into 281-switch-to-typescript-in-signer-service

c6a7891

remove unnecessary js files

743011e

Merge branch '281-switch-to-typescript-in-signer-service' of github.c…

04ba37a

…om:pendulum-chain/vortex into 281-switch-to-typescript-in-signer-service

Sharqiewicz changed the base branch from polygon-prototype-staging to staging February 7, 2025 13:46

Sharqiewicz added 7 commits February 7, 2025 14:58

change fn name to getRawAddressValue

ecb4f3a

remove unnecessary key check

f08a4e5

use Quotes types instead of unknown

74f437c

remove unused Siwe interface

0f88ca5

export alchemypay quote interface

7c90e91

export Moonpay quote interface

fbf1a55

add TransakQuoteResult interface

9fd5252

Sharqiewicz added 4 commits February 7, 2025 17:35

change project build commands

b4f0a20

restructure code to reduce cognitive load

1799c99

remove type assertion

b991a7e

Merge branch 'staging' into 281-switch-to-typescript-in-signer-service

fac9072

gianfra-t reviewed Feb 11, 2025

View reviewed changes

gianfra-t approved these changes Feb 11, 2025

View reviewed changes

Sharqiewicz added 2 commits February 12, 2025 13:39

remove unused handler

c759022

Merge branch 'staging' into 281-switch-to-typescript-in-signer-service

98a669d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[READY] Migrate signer-service to Typescript #352

[READY] Migrate signer-service to Typescript #352

Sharqiewicz commented Jan 6, 2025 •

edited

Loading

netlify bot commented Jan 6, 2025 •

edited

Loading

gianfra-t Jan 17, 2025 •

edited

Loading

gianfra-t Jan 17, 2025

Sharqiewicz Feb 7, 2025

gianfra-t Jan 17, 2025

Sharqiewicz Feb 7, 2025

gianfra-t Jan 17, 2025

gianfra-t Jan 20, 2025

Sharqiewicz Feb 7, 2025

gianfra-t left a comment •

edited

Loading

gianfra-t left a comment

ebma left a comment

ebma Jan 21, 2025

ebma Jan 21, 2025

ebma Jan 21, 2025

Sharqiewicz Feb 10, 2025

ebma Jan 21, 2025

ebma Jan 21, 2025

ebma Jan 22, 2025

ebma Jan 22, 2025

ebma Jan 22, 2025

ebma Jan 22, 2025

ebma Jan 22, 2025

Sharqiewicz Feb 11, 2025

Sharqiewicz commented Feb 7, 2025

gianfra-t Feb 11, 2025

Sharqiewicz Feb 12, 2025

gianfra-t left a comment

		const validateQuoteInput: RequestHandler = (req, res, next) => {
		const { provider, fromCrypto, toFiat, amount, network } = req.query as unknown as QuoteQuery;

[READY] Migrate signer-service to Typescript #352

Are you sure you want to change the base?

[READY] Migrate signer-service to Typescript #352

Conversation

Sharqiewicz commented Jan 6, 2025 • edited Loading

PR 🦈🟢

How to review

netlify bot commented Jan 6, 2025 • edited Loading

✅ Deploy Preview for pendulum-pay ready!

gianfra-t Jan 17, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gianfra-t left a comment • edited Loading

Choose a reason for hiding this comment

gianfra-t left a comment

Choose a reason for hiding this comment

ebma left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sharqiewicz commented Feb 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gianfra-t left a comment

Choose a reason for hiding this comment

Sharqiewicz commented Jan 6, 2025 •

edited

Loading

netlify bot commented Jan 6, 2025 •

edited

Loading

gianfra-t Jan 17, 2025 •

edited

Loading

gianfra-t left a comment •

edited

Loading