Refactor: canary esm build and deprecating packages #535

ThomasRalee · 2025-01-20T19:58:59Z

Summary by CodeRabbit

I'll craft concise release notes highlighting the key changes and improvements across the project.

Release Notes

Module System Transition
- Migrated to ECMAScript (ESM) modules across packages
- Updated import/export syntax for better compatibility
Error Handling Improvements
- Standardized gRPC error code processing
- Enhanced error reporting mechanism in multiple API classes
Cryptography Enhancements
- Updated cryptographic utility functions
- Improved key and address management utilities
Dependency Updates
- Updated core dependencies
- Consolidated and streamlined package configurations
Test Utilities
- Reorganized test utilities
- Updated mock data generation mechanisms
Performance Optimizations
- Refined module resolution strategies
- Improved TypeScript compilation configurations

These release notes provide a high-level overview of the significant changes while maintaining confidentiality about specific implementation details.

coderabbitai · 2025-01-20T19:59:10Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes represent a comprehensive refactoring and modernization of the Injective Protocol's TypeScript SDK and related packages. The modifications span multiple areas, including module system transitions, error handling improvements, cryptographic utility updates, and dependency management. Key focus areas include migrating to ECMAScript modules, standardizing error code processing, updating cryptographic functions, and removing the test-utils package.

Changes

File/Module	Change Summary
Multiple Packages	Transition to ES Modules with `"type": "module"`
Exceptions Package	Added `GrpcErrorCode` enum and `grpcErrorCodeToErrorCode` function
SDK Packages	Updated error handling to use `grpcErrorCodeToErrorCode`
Crypto Utilities	Replaced cryptographic libraries, added address generation functions
Test Utilities	Removed standalone package, migrated utilities to `utils`

Poem

🐰 A Rabbit's Refactoring Tale

In modules green and errors bright,
We dance through code with pure delight,
ES modules sing, exceptions gleam,
Our SDK flows like a smooth stream! 🌈

Hop, hop, refactor! 🚀

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

socket-security · 2025-01-20T20:01:26Z

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source	CI
Critical CVE	npm/@babel/[email protected]	CVE: GHSA-67hx-6x53-jw92 Babel vulnerable to arbitrary code execution when compiling specifically crafted malicious code (CRITICAL) Affected versions: < 7.23.2 Patched version: 7.23.2	`yarn.lock`	⚠︎

View full report↗︎

Next steps

What is a critical CVE?

Contains a Critical Common Vulnerability and Exposure (CVE).

Remove or replace dependencies that include known critical CVEs. Consumers can use dependency overrides or npm audit fix --force to remove vulnerable dependencies.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@babel/[email protected]

coderabbitai

Actionable comments posted: 9

🔭 Outside diff range comments (10)

packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcArchiverApi.spec.ts (1)
Line range hint 16-180: Improve test robustness and error handling.

The test suite could be improved in several ways:

Tests currently swallow errors and only log them, which means they'll pass even when API calls fail

No validation of error scenarios

Missing test coverage for edge cases (e.g., invalid dates, malformed account addresses)

Consider refactoring the tests to:

Remove try-catch blocks and let Jest handle the errors

Add negative test cases

Add validation for edge cases

Example refactor for one test:
 test('fetchHistoricalBalance', async () => {
-  try {
-    const response = await indexerGrpcArchiverApi.fetchHistoricalBalance({
-      account,
-      resolution,
-    })
-
-    expect(response).toBeDefined()
-    expect(response).toEqual(
-      expect.objectContaining<
-        ReturnType<
-          typeof IndexerGrpcArchiverTransformer.grpcHistoricalBalanceResponseToHistoricalBalances
-        >
-      >(response),
-    )
-  } catch (e) {
-    console.error(
-      'IndexerGrpcArchiverApi.fetchHistoricalBalance => ' +
-        (e as any).message,
-    )
-  }
+  const response = await indexerGrpcArchiverApi.fetchHistoricalBalance({
+    account,
+    resolution,
+  })
+
+  expect(response).toBeDefined()
+  expect(response).toEqual(
+    expect.objectContaining<
+      ReturnType<
+        typeof IndexerGrpcArchiverTransformer.grpcHistoricalBalanceResponseToHistoricalBalances
+      >
+    >(response),
+  )
+})
+
+test('fetchHistoricalBalance handles invalid account', async () => {
+  await expect(
+    indexerGrpcArchiverApi.fetchHistoricalBalance({
+      account: 'invalid-account',
+      resolution,
+    })
+  ).rejects.toThrow()
 })
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcPortfolioApi.spec.ts (1)
Line range hint 15-33: Improve test robustness and error handling.

The current test implementation has several issues:

Test will pass even if an error occurs (errors are only logged)

Missing assertion count to ensure all assertions are executed

Missing error scenarios

Consider this improved implementation:
 describe('IndexerGrpcAccountPortfolioApi', () => {
   test('fetchAccountPortfolio', async () => {
+    expect.assertions(2);
     try {
       const response = await indexerGrpcPortfolioApi.fetchAccountPortfolio(
         injectiveAddress,
       )

       expect(response).toBeDefined()
       expect(response).toEqual(
         expect.objectContaining<
           ReturnType<
             typeof IndexerGrpcAccountPortfolioTransformer.accountPortfolioResponseToAccountPortfolio
           >
         >(response),
       )
     } catch (e) {
-      console.error(
-        'IndexerGrpcAccountPortfolioApi.fetchAccountPortfolio => ' +
-          (e as any).message,
-      )
+      throw e
     }
   })
+
+  test('fetchAccountPortfolio handles errors', async () => {
+    expect.assertions(1);
+    const invalidAddress = 'invalid-address';
+    
+    await expect(
+      indexerGrpcPortfolioApi.fetchAccountPortfolio(invalidAddress)
+    ).rejects.toThrow();
+  })
 })
packages/sdk-ts/src/client/olp/grpc/OLPGrpcApi.spec.ts (1)
Line range hint 11-170: Improve test error handling and coverage.

The test suite has several areas for improvement:

Tests currently catch and log errors without failing, which could mask test failures

Error handling code is duplicated across all tests

Missing test cases for error scenarios

Consider refactoring the tests using this pattern:
describe('OLPGrpcApi', () => {
  // Common error handler
  const handleTestError = (methodName: string) => (error: unknown) => {
    console.error(`OLPGrpcApi.${methodName} => ${(error as Error).message}`);
    throw error; // Re-throw to fail the test
  };

  // Example of improved test structure
  test('fetchEpochs', async () => {
    const response = await dmmGrpcApi.fetchEpochs().catch(handleTestError('fetchEpochs'));
    
    expect(response).toBeDefined();
    expect(response).toEqual(
      expect.objectContaining<ReturnType<typeof DmmGrpcTransformer.epochsResponseToEpochs>>(response),
    );
  });

  // Add error scenario tests
  test('fetchEpochs handles network errors', async () => {
    const errorApi = new OLPGrpcApi('invalid-url');
    await expect(errorApi.fetchEpochs()).rejects.toThrow();
  });
});
packages/sdk-ts/src/client/chain/grpc/ChainGrpcTokenFactoryApi.ts (1)
Line range hint 78-82: Fix incorrect error context string.

The error context string in fetchDenomAuthorityMetadata is incorrect. It's using 'TokenFactoryDenomsFromCreator' instead of 'TokenFactoryDenomAuthorityMetadata'.

Apply this fix:
  throw new GrpcUnaryRequestException(new Error(e.toString()), {
    code: grpcErrorCodeToErrorCode(e.code),
-   context: 'TokenFactoryDenomsFromCreator',
+   context: 'TokenFactoryDenomAuthorityMetadata',
    contextModule: this.module,
  })
packages/sdk-ts/src/core/tx/api/TxGrpcApi.ts (1)
Line range hint 208-223: Update error handling in deprecated broadcastBlock method.

The deprecated broadcastBlock method still uses the removed GeneralException. Consider updating it to use the new error handling pattern before removal.

Apply this diff to update the error handling:
-        throw new GeneralException(
-          new Error('There was an issue broadcasting the transaction'),
-        )
+        throw new GrpcUnaryRequestException(
+          new Error('There was an issue broadcasting the transaction'),
+          {
+            context: 'TxGrpcApi',
+            contextModule: 'broadcast-block',
+          },
+        )
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcExplorerApi.ts (1)
Line range hint 424-426: Remove duplicate condition check for before parameter.

The before condition is checked twice in the fetchTxs method, which is redundant.

Apply this diff to remove the duplicate check:
    if (before) {
      request.before = before.toString()
    }

    if (startTime) {
      request.startTime = startTime.toString()
    }

-   if (before) {
-     request.before = before.toString()
-   }

    if (endTime) {
      request.endTime = endTime.toString()
    }
Also applies to: 445-447
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts (1)
Implement the commented out isConditional parameter code

The isConditional parameter is actively used in the derivatives API and should be implemented in the spot API for feature parity. The implementation is already written but commented out.

Uncomment the isConditional implementation in both methods

Fix the spacing in request.isConditional =isConditional to request.isConditional = isConditional

🔗 Analysis chain

Line range hint 164-166: Address commented out code for isConditional parameter.

There are commented out code blocks for the isConditional parameter in multiple methods. These should either be implemented or removed to maintain code cleanliness.

Please verify if this feature is still needed. If it is:

Implement the feature

Add appropriate tests
If not, remove the commented code.

Also applies to: 275-277
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Check if isConditional is used elsewhere in the codebase

# Search for isConditional usage
rg "isConditional" --type ts
Length of output: 1895

Script:
#!/bin/bash
# Get the full context of methods using isConditional in spot API
ast-grep --pattern 'function $_($$$) {
  $$$
  if (isConditional !== undefined) {
    $$$
  }
  $$$
}' packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts

# Also get the commented sections mentioned in the review
rg -A 2 -B 2 "isConditional" packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts
Length of output: 761
packages/utils/jest.config.js (1)
Line range hint 5-7: Update tsConfig to tsconfig in ts-jest configuration.

The ts-jest configuration uses tsConfig, which has been deprecated. Update it to tsconfig to align with the latest ts-jest options.

Apply this diff:
   globals: {
     'ts-jest': {
-      tsConfig: 'tsconfig.build.esm.json',
+      tsconfig: 'tsconfig.build.esm.json',
     },
   },
packages/exceptions/jest.config.js (1)
Line range hint 5-7: Update tsConfig to tsconfig in ts-jest configuration.

Similar to the change in packages/utils/jest.config.js, update tsConfig to tsconfig in the ts-jest configuration for consistency and to use the correct option name.

Apply this diff:
   globals: {
     'ts-jest': {
-      tsConfig: 'tsconfig.build.esm.json',
+      tsconfig: 'tsconfig.build.esm.json',
     },
   },
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Ninji.ts (1)
Line range hint 256-256: Fix incorrect event listener name.

The event listener is using 'leap_keystorechange' instead of 'ninji_keystorechange', which is inconsistent with the wallet type.

Apply this diff to fix the event name:
-    window.addEventListener('leap_keystorechange', listener)
+    window.addEventListener('ninji_keystorechange', listener)

🧹 Nitpick comments (19)

deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Ledger/hw/index.ts (1)

3-4: Consider the impact of updating deprecated packages.

This file is in a deprecated package but is still receiving updates. This could mislead users into thinking the package is still maintained.

Consider either:

Moving the actively maintained code to a new package

Adding clear deprecation notices with migration paths for users

packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcPortfolioApi.spec.ts (1)

Line range hint 35-61: Remove commented out code.

If the fetchAccountPortfolioTokenHolders test is no longer needed, remove it entirely. If it's still relevant, implement it properly. Keeping commented out code reduces maintainability.
packages/sdk-ts/src/client/olp/grpc/OLPGrpcApi.spec.ts (1)
Line range hint 23-25: Standardize error handling across tests.

The error handling in the test suite has several inconsistencies:

Unsafe type casting with as any

String concatenation instead of template literals

Inconsistent error message formatting

Consider standardizing error handling:
// Create a typed error handler
type GrpcError = Error & { code?: number; message: string };

const formatErrorMessage = (method: string, error: GrpcError) => 
  `OLPGrpcApi.${method} failed: ${error.message}${error.code ? ` (code: ${error.code})` : ''}`;

// Usage in tests
} catch (error) {
  console.error(formatErrorMessage('fetchEpochs', error as GrpcError));
}
Also applies to: 45-47, 68-71, 89-91, 112-115, 136-138, 159-162
packages/sdk-ts/src/core/modules/exchange/msgs/MsgDeposit.spec.ts (1)

2-2: Consider documenting the ESM migration strategy.

The use of '.js' extensions in imports and the consolidation of utility packages indicate a transition to ECMAScript modules. Consider:

Documenting the migration strategy

Updating the package.json type field

Adding ESM-specific export maps
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCancelBinaryOptionsOrder.spec.ts (1)
1-1: Consider using explicit file extension for local imports.

For consistency with ECMAScript modules, consider adding the .js extension to the local import.
-import MsgCancelBinaryOptionsOrder from './MsgCancelBinaryOptionsOrder'
+import MsgCancelBinaryOptionsOrder from './MsgCancelBinaryOptionsOrder.js'
packages/sdk-ts/src/client/chain/grpc/ChainGrpcWasmXApi.ts (1)

Line range hint 61-61: Address TODO comment in fetchModuleState.

The TODO comment in the response handling needs to be addressed for completeness.

Would you like me to help implement the proper state handling for the module state response?
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcWeb3GwApi.ts (1)
12-12: Consider standardizing error type handling.

While the error code standardization is good, consider also standardizing the error type handling. Currently, e.type is directly passed through while error codes are transformed.
 throw new TransactionException(new Error(e.toString()), {
-  type: e.type,
+  type: ErrorType.Web3Gateway,
   context: 'Web3Gateway.PrepareEip712',
   code: grpcErrorCodeToErrorCode(e.code),
 })
Also applies to: 106-107
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcPortfolioApi.ts (1)
Line range hint 47-48: Consider type-safe error message checking.

The current error message check uses unsafe type casting with as any. Consider implementing a type-safe error check.
-if ((e as any)?.message === 'account address not found') {
+if (e instanceof Error && e.message === 'account address not found') {
Also applies to: 88-89
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcOracleApi.ts (1)
3-4: LGTM! Consider enhancing error type checking.

The standardized error handling looks good. However, in the fetchOraclePriceNoThrow method, consider using a more type-safe approach for checking 'object not found' errors.
-      if ((e as any).message.includes('object not found')) {
+      if (e instanceof Error && e.message.includes('object not found')) {
Also applies to: 39-39, 83-83, 133-133
packages/sdk-ts/src/client/chain/grpc/ChainGrpcBankApi.ts (1)

1-1: Well-structured refactoring with consistent patterns.

The changes demonstrate a well-thought-out refactoring approach with two main improvements:

Service separation through dedicated explorer endpoints

Standardized error handling using grpcErrorCodeToErrorCode

The modifications are consistently applied across different modules and environments, improving maintainability and reliability.
packages/exceptions/src/exceptions/types/codes.ts (1)
23-27: Consider adding validation in the error code conversion.

The current implementation assumes the input is always a valid gRPC error code. Consider adding validation to handle invalid codes gracefully.
 export const grpcErrorCodeToErrorCode = <T extends number>(
   grpcErrorCode: T,
 ): GrpcErrorCode => {
-  return grpcErrorCode as GrpcErrorCode
+  if (grpcErrorCode >= GrpcErrorCode.OK && grpcErrorCode <= GrpcErrorCode.Unauthenticated) {
+    return grpcErrorCode as GrpcErrorCode
+  }
+  return GrpcErrorCode.Unknown
 }
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcMitoApi.ts (1)
Line range hint 1-989: Consider extracting the error handling pattern into a utility function.

The error handling pattern is repeated across multiple methods. Consider creating a utility function to reduce duplication and improve maintainability.
private handleGrpcError(e: unknown, context: string): never {
  if (e instanceof InjectiveMetaRpc.GrpcWebError) {
    throw new GrpcUnaryRequestException(new Error(e.toString()), {
      code: grpcErrorCodeToErrorCode(e.code),
      context,
      contextModule: this.module,
    })
  }

  throw new GrpcUnaryRequestException(e as Error, {
    code: UnspecifiedErrorCode,
    context,
    contextModule: this.module,
  })
}
Usage example:
 try {
   const response = await this.retry<MitoApi.GetVaultResponse>(() =>
     this.client.GetVault(request),
   )
   return IndexerGrpcMitoTransformer.vaultResponseToVault(response)
 } catch (e: unknown) {
-  if (e instanceof InjectiveMetaRpc.GrpcWebError) {
-    throw new GrpcUnaryRequestException(new Error(e.toString()), {
-      code: grpcErrorCodeToErrorCode(e.code),
-      context: 'GetVault',
-      contextModule: this.module,
-    })
-  }
-
-  throw new GrpcUnaryRequestException(e as Error, {
-    code: UnspecifiedErrorCode,
-    context: 'GetVault',
-    contextModule: this.module,
-  })
+  this.handleGrpcError(e, 'GetVault')
 }
packages/networks/tsconfig.build.esm.json (1)

1-1: Consider documenting the dual module system strategy.

The transition to supporting both CommonJS (via commonjs+node) and ESM (via NodeNext) builds is a solid architectural choice. Consider adding documentation about:

The rationale behind supporting both module systems

How consumers should choose between CJS and ESM builds

Any migration guides for downstream dependencies
packages/sdk-ts/src/utils/crypto.ts (2)
1-2: Remove commented-out import statement for cleaner codebase.

The commented-out import statement on line 1 is unnecessary and can be removed to keep the codebase clean.

Apply this diff:
-// import CryptoEs from 'crypto-es'
83-83: Simplify Buffer conversion in decompressPubKey function.

In line 83, since testBuffer is already a Buffer, using Buffer.from(testBuffer) is redundant. You can simplify the code by converting testBuffer directly to a hexadecimal string.

Apply this diff:
-    Buffer.from(testBuffer).toString('hex'),
+    testBuffer.toString('hex'),
packages/sdk-ts/src/utils/address.ts (1)
107-111: LGTM! Consider adding input validation.

The new utility functions are well-implemented and focused. However, consider adding input validation to ensure the input is a valid hex string.
 export const addHexPrefix = (hex: string) =>
+  hex && typeof hex === 'string' && /^[0-9a-fA-F]*$/.test(hex.replace('0x', '')) ?
   hex.startsWith('0x') ? hex : `0x${hex}`
+  : throw new Error('Invalid hex string')

 export const removeHexPrefix = (hex: string) =>
+  hex && typeof hex === 'string' && /^[0-9a-fA-F]*$/.test(hex.replace('0x', '')) ?
   hex.startsWith('0x') ? hex.slice(2) : hex
+  : throw new Error('Invalid hex string')
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/PrivateKey.ts (1)
254-256: Add documentation for unsupported operation.

Since private key wallets don't support account changes, consider adding a comment explaining why this operation is not implemented.

Apply this diff to improve documentation:
  async onAccountChange(
    _callback: (account: AccountAddress | string[]) => void,
  ): Promise<void> {
-    //
+    // Private key wallets don't support account changes as they are bound to a single key
  }
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Keplr.ts (1)

245-247: Consider standardizing the account change handling across wallet implementations.

The codebase shows inconsistencies in how different wallet strategies handle account changes:

Some implementations are empty (PrivateKey)

Some use incorrect event names (Ninji)

All implementations only handle single accounts despite the new type supporting arrays

Consider:

Creating an abstract base class method that enforces consistent implementation

Documenting why some wallets support multiple accounts while others don't

Adding migration notes since these files are in a deprecated directory

deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Okx/index.ts (1)

26-29: Consider extracting common wallet functionality into a base class.

All wallet strategy implementations share similar patterns for:

Type assertions for ethereum.request calls

Error handling with specific wallet exceptions

Transaction receipt polling logic

Account and chain ID change event handling

Consider creating a base Ethereum wallet strategy class that implements these common patterns, reducing code duplication and ensuring consistent behavior across wallet implementations.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between da1934e and bb6740e.

📒 Files selected for processing (157)

deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/BitGet/index.ts (7 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Keplr.ts (1 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Leap.ts (1 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Ledger/Base.ts (1 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Ledger/hw/index.ts (1 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Metamask/index.ts (7 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Ninji.ts (1 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Okx/index.ts (8 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Phantom/index.ts (8 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/PrivateKey.ts (1 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/TrustWallet/index.ts (7 hunks)
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/WalletConnect.ts (1 hunks)
etc/replacements-ledger.js (0 hunks)
etc/replacements.js (0 hunks)
jest.config.js (2 hunks)
lerna.json (0 hunks)
package.json (5 hunks)
packages/exceptions/jest.config.js (1 hunks)
packages/exceptions/package.json (1 hunks)
packages/exceptions/src/exceptions/types/codes.ts (2 hunks)
packages/exceptions/tsconfig.build.esm.json (1 hunks)
packages/exceptions/tsconfig.build.json (1 hunks)
packages/networks/jest.config.js (1 hunks)
packages/networks/package.json (1 hunks)
packages/networks/src/chainInfos.ts (1 hunks)
packages/networks/src/endpoints.ts (4 hunks)
packages/networks/tsconfig.build.esm.json (1 hunks)
packages/networks/tsconfig.build.json (1 hunks)
packages/sdk-ts/jest.config.js (1 hunks)
packages/sdk-ts/package.json (2 hunks)
packages/sdk-ts/src/client/abacus/grpc/AbacusGrpcApi.ts (4 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuctionApi.ts (4 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuthApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuthApi.ts (4 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuthZApi.ts (4 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcBankApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcBankApi.ts (9 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcDistributionApi.ts (6 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcExchangeApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcExchangeApi.ts (12 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcGovApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcGovApi.ts (7 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcIbcApi.ts (3 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcInsuranceFundApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcInsuranceFundApi.ts (6 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcMintApi.ts (4 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcOracleApi.ts (2 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcPeggyApi.ts (2 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcPermissionsApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcPermissionsApi.ts (7 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcStakingApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcStakingApi.ts (18 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcTendermintApi.ts (2 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcTokenFactoryApi.ts (5 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcWasmApi.ts (10 hunks)
packages/sdk-ts/src/client/chain/grpc/ChainGrpcWasmXApi.ts (3 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcAccountApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcAccountApi.ts (8 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcArchiverApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcArchiverApi.ts (9 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcAuctionApi.ts (5 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcCampaignApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcCampaignApi.ts (7 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcDerivativesApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcDerivativesApi.ts (16 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcExplorerApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcExplorerApi.ts (12 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcInsuranceFundApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcInsuranceFundApi.ts (3 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcMetaApi.ts (4 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcMitoApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcMitoApi.ts (23 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcOracleApi.ts (4 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcPortfolioApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcPortfolioApi.ts (3 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts (11 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcTradingApi.ts (3 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcTransactionApi.ts (6 hunks)
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcWeb3GwApi.ts (2 hunks)
packages/sdk-ts/src/client/olp/grpc/OLPGrpcApi.spec.ts (1 hunks)
packages/sdk-ts/src/client/olp/grpc/OLPGrpcApi.ts (11 hunks)
packages/sdk-ts/src/core/accounts/PrivateKey.spec.ts (2 hunks)
packages/sdk-ts/src/core/modules/auction/msgs/MsgBid.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/authz/msgs/MsgExec.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/authz/msgs/MsgGrant.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/authz/msgs/MsgGrantWithAuthorization.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/authz/msgs/MsgRevoke.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/bank/msgs/MsgSend.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/distribution/msgs/MsgWithdrawDelegatorReward.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/distribution/msgs/MsgWithdrawValidatorCommission.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgBatchCancelBinaryOptionsOrders.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgBatchCancelDerivativeOrders.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgBatchCancelSpotOrders.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCancelBinaryOptionsOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCancelDerivativeOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCancelSpotOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateBinaryOptionsLimitOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateBinaryOptionsMarketOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateDerivativeLimitOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateDerivativeMarketOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateSpotLimitOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateSpotMarketOrder.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgDeposit.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgExternalTransfer.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgIncreasePositionMargin.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgInstantSpotMarketLaunch.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/exchange/msgs/MsgWithdraw.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/feegrant/msgs/MsgGrantAllowance.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/feegrant/msgs/MsgRevokeAllowance.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/gov/msgs/MsgDeposit.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/gov/msgs/MsgVote.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/insurance/msgs/MsgCreateInsuranceFund.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/insurance/msgs/MsgRequestRedemption.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/insurance/msgs/MsgUnderwrite.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgClaimVoucher.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgCreateNamespace.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgDeleteNamespace.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgRevokeNamespaceRoles.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgUpdateNamespace.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgUpdateNamespaceRoles.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/permissions/msgs/MsgUpdateParams.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/staking/msgs/MsgBeginRedelegate.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/staking/msgs/MsgCancelUnbondingDelegation.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/staking/msgs/MsgDelegate.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/staking/msgs/MsgEditValidator.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/staking/msgs/MsgUndelegate.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/tokenfactory/msgs/MsgBurn.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/tokenfactory/msgs/MsgChangeAdmin.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/tokenfactory/msgs/MsgCreateDenom.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/tokenfactory/msgs/MsgMint.spec.ts (1 hunks)
packages/sdk-ts/src/core/modules/tokenfactory/msgs/MsgSetDenomMetadata.spec.ts (1 hunks)
packages/sdk-ts/src/core/tx/api/TxGrpcApi.ts (2 hunks)
packages/sdk-ts/src/core/tx/broadcaster/MsgBroadcasterWithPk.spec.ts (1 hunks)
packages/sdk-ts/src/core/tx/eip712/eip712.spec.ts (1 hunks)
packages/sdk-ts/src/utils/address.ts (1 hunks)
packages/sdk-ts/src/utils/crypto.ts (3 hunks)
packages/sdk-ts/tsconfig.build.esm.json (1 hunks)
packages/sdk-ts/tsconfig.build.json (1 hunks)
packages/test-utils/CHANGELOG.md (0 hunks)
packages/test-utils/README.md (0 hunks)
packages/test-utils/package.json (0 hunks)
packages/test-utils/tsconfig.build.esm.json (0 hunks)
packages/test-utils/tsconfig.build.json (0 hunks)
packages/test-utils/tsconfig.json (0 hunks)
packages/ts-types/jest.config.js (1 hunks)
packages/ts-types/package.json (2 hunks)
packages/ts-types/tsconfig.build.esm.json (1 hunks)
packages/ts-types/tsconfig.build.json (1 hunks)
packages/utils/jest.config.js (1 hunks)
packages/utils/package.json (3 hunks)
packages/utils/src/classes/LocalStorage.ts (1 hunks)
packages/utils/src/helpers.ts (2 hunks)
packages/utils/src/test-utils/msgs.ts (2 hunks)
packages/utils/tsconfig.build.esm.json (1 hunks)
packages/utils/tsconfig.build.json (1 hunks)
packages/wallet-ts/.npmignore (0 hunks)

⛔ Files not processed due to max files limit (57)

packages/wallet-ts/LICENSE
packages/wallet-ts/jest.config.js
packages/wallets/wallet-base/package.json
packages/wallets/wallet-base/src/types/enums.ts
packages/wallets/wallet-base/src/types/provider.ts
packages/wallets/wallet-base/src/types/strategy.ts
packages/wallets/wallet-base/src/utils/wallet.ts
packages/wallets/wallet-base/tsconfig.build.esm.json
packages/wallets/wallet-base/tsconfig.build.json
packages/wallets/wallet-core/package.json
packages/wallets/wallet-core/src/broadcaster/MsgBroadcaster.ts
packages/wallets/wallet-core/tsconfig.build.esm.json
packages/wallets/wallet-core/tsconfig.build.json
packages/wallets/wallet-cosmos-strategy/package.json
packages/wallets/wallet-cosmos-strategy/tsconfig.build.esm.json
packages/wallets/wallet-cosmos-strategy/tsconfig.build.json
packages/wallets/wallet-cosmos/README.md
packages/wallets/wallet-cosmos/package.json
packages/wallets/wallet-cosmos/src/strategy/strategy.ts
packages/wallets/wallet-cosmos/tsconfig.build.esm.json
packages/wallets/wallet-cosmos/tsconfig.build.json
packages/wallets/wallet-cosmostation/README.md
packages/wallets/wallet-cosmostation/package.json
packages/wallets/wallet-cosmostation/tsconfig.build.esm.json
packages/wallets/wallet-cosmostation/tsconfig.build.json
packages/wallets/wallet-evm/README.md
packages/wallets/wallet-evm/package.json
packages/wallets/wallet-evm/src/strategy/strategy.ts
packages/wallets/wallet-evm/src/utils/index.ts
packages/wallets/wallet-evm/tsconfig.build.esm.json
packages/wallets/wallet-evm/tsconfig.build.json
packages/wallets/wallet-ledger/README.md
packages/wallets/wallet-ledger/package.json
packages/wallets/wallet-ledger/src/strategy/Ledger/Base.ts
packages/wallets/wallet-ledger/src/strategy/Ledger/hw/AccountManager.ts
packages/wallets/wallet-ledger/src/strategy/Ledger/hw/index.ts
packages/wallets/wallet-ledger/src/strategy/LedgerCosmos/hw/AccountManager.ts
packages/wallets/wallet-ledger/src/strategy/LedgerCosmos/hw/index.ts
packages/wallets/wallet-ledger/tsconfig.build.esm.json
packages/wallets/wallet-ledger/tsconfig.build.json
packages/wallets/wallet-magic/README.md
packages/wallets/wallet-magic/package.json
packages/wallets/wallet-magic/tsconfig.build.esm.json
packages/wallets/wallet-magic/tsconfig.build.json
packages/wallets/wallet-private-key/README.md
packages/wallets/wallet-private-key/package.json
packages/wallets/wallet-private-key/src/strategy/strategy.ts
packages/wallets/wallet-private-key/tsconfig.build.esm.json
packages/wallets/wallet-private-key/tsconfig.build.json
packages/wallets/wallet-strategy/package.json
packages/wallets/wallet-strategy/tsconfig.build.esm.json
packages/wallets/wallet-strategy/tsconfig.build.json
packages/wallets/wallet-trezor/README.md
packages/wallets/wallet-trezor/package.json
packages/wallets/wallet-trezor/src/strategy/hw/AccountManager.ts
packages/wallets/wallet-trezor/src/strategy/hw/index.ts
packages/wallets/wallet-trezor/src/strategy/strategy.ts

💤 Files with no reviewable changes (10)

packages/wallet-ts/.npmignore
packages/test-utils/README.md
lerna.json
packages/test-utils/CHANGELOG.md
packages/test-utils/tsconfig.build.esm.json
packages/test-utils/tsconfig.json
packages/test-utils/package.json
etc/replacements-ledger.js
packages/test-utils/tsconfig.build.json
etc/replacements.js

✅ Files skipped from review due to trivial changes (30)

packages/sdk-ts/src/core/modules/authz/msgs/MsgGrantWithAuthorization.spec.ts
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateSpotLimitOrder.spec.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcAccountApi.spec.ts
packages/sdk-ts/src/core/modules/tokenfactory/msgs/MsgBurn.spec.ts
packages/sdk-ts/src/client/chain/grpc/ChainGrpcStakingApi.spec.ts
packages/sdk-ts/src/core/modules/feegrant/msgs/MsgRevokeAllowance.spec.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcCampaignApi.spec.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcDerivativesApi.spec.ts
packages/sdk-ts/src/core/modules/exchange/msgs/MsgBatchCancelSpotOrders.spec.ts
packages/sdk-ts/src/core/modules/permissions/msgs/MsgRevokeNamespaceRoles.spec.ts
packages/sdk-ts/src/core/tx/eip712/eip712.spec.ts
packages/sdk-ts/src/core/modules/permissions/msgs/MsgClaimVoucher.spec.ts
packages/sdk-ts/src/core/modules/bank/msgs/MsgSend.spec.ts
packages/sdk-ts/src/core/modules/insurance/msgs/MsgRequestRedemption.spec.ts
packages/sdk-ts/src/client/chain/grpc/ChainGrpcGovApi.spec.ts
packages/sdk-ts/src/core/modules/permissions/msgs/MsgCreateNamespace.spec.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcExplorerApi.spec.ts
packages/sdk-ts/src/client/chain/grpc/ChainGrpcPermissionsApi.spec.ts
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCancelSpotOrder.spec.ts
packages/sdk-ts/src/core/modules/exchange/msgs/MsgCreateBinaryOptionsLimitOrder.spec.ts
packages/sdk-ts/src/core/modules/exchange/msgs/MsgBatchCancelDerivativeOrders.spec.ts
packages/sdk-ts/src/client/chain/grpc/ChainGrpcBankApi.spec.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcMitoApi.spec.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.spec.ts
packages/sdk-ts/src/core/modules/insurance/msgs/MsgUnderwrite.spec.ts
packages/sdk-ts/src/core/tx/broadcaster/MsgBroadcasterWithPk.spec.ts
deprecated/packages/wallet-ts/src/strategies/wallet-strategy/strategies/Ledger/Base.ts
packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcInsuranceFundApi.spec.ts
packages/utils/src/classes/LocalStorage.ts
packages/sdk-ts/src/core/modules/feegrant/msgs/MsgGrantAllowance.spec.ts

🧰 Additional context used

🪛 GitHub Actions: Publish canary branch

packages/exceptions/package.json