fix: ethers-providers-type-compatibility

spruceid · Apr 12, 2024 · 5439afc · 5439afc
1 parent b6fbd05
commit 5439afc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/packages/siwe/lib/client.ts b/packages/siwe/lib/client.ts
@@ -4,11 +4,9 @@ import {
   ParsedMessage,
   parseIntegerNumber,
 } from '@spruceid/siwe-parser';
-// @ts-expect-error -- ethers v6 compatibility hack
-import { providers } from 'ethers';
 import * as uri from 'valid-url';
 
-import { getAddress, verifyMessage } from './ethersCompat';
+import { getAddress, Provider, verifyMessage } from './ethersCompat';
 import {
   SiweError,
   SiweErrorType,
@@ -194,7 +192,7 @@ export class SiweMessage {
    * @param signature Signature to match the address in the message.
    * @param provider Ethers provider to be used for EIP-1271 validation
    */
-  async validate(signature: string, provider?: providers.Provider) {
+  async validate(signature: string, provider?: Provider) {
     console.warn(
       'validate() has been deprecated, please update your code to use verify(). validate() may be removed in future versions.'
     );

diff --git a/packages/siwe/lib/ethersCompat.ts b/packages/siwe/lib/ethersCompat.ts
@@ -52,6 +52,11 @@ try {
   ethersGetAddress = ethers.getAddress as (address: string) => string;
 }
 
+// @ts-expect-error -- v6 compatibility hack
+type ProviderV5 = ethers.providers.Provider
+type ProviderV6 = ethers.Provider
+
+export type Provider = ProviderV6 extends undefined ? ProviderV5 : ProviderV6
 export const verifyMessage = ethersVerifyMessage;
 export const hashMessage = ethersHashMessage;
 export const getAddress = ethersGetAddress;