fix: Use local declarations instead of declare global {} in module scopes

MaximusHaximus · MaximusHaximus · commit 15523a8dd172 · 2024-10-22T22:04:20.000+01:00
- Also removed now-unnecessary eslint hints for `/* global Lit */` etc.
- Fixes mismatched type conflict with same name 'UnsignedTransaction'; ethereum's type is different than Solana.
diff --git a/local-tests/test.ts b/local-tests/test.ts
@@ -293,22 +293,22 @@ setLitActionsCodeToLocal();
     tests: {
       // testExample,
       // testBundleSpeed,
-      ...eoaSessionSigsTests,
-      ...pkpSessionSigsTests,
-      ...litActionSessionSigsTests,
-      ...litActionIpfsIdSessionSigsTests,
-      ...capacityDelegationTests,
-      ...bareAuthSigTests,
-
-      ...pkpEthersTest.eoaSessionSigs,
-      ...pkpEthersTest.pkpSessionSigs,
-      ...pkpEthersTest.litActionSessionSigs,
-
-      ...litActionCombiningTests.broadcastAndCombine,
-      ...litActionCombiningTests.decryptAndCombine,
-      ...litActionCombiningTests.ecdsaSignAndCombine,
-
-      ...relayerTests,
+      // ...eoaSessionSigsTests,
+      // ...pkpSessionSigsTests,
+      // ...litActionSessionSigsTests,
+      // ...litActionIpfsIdSessionSigsTests,
+      // ...capacityDelegationTests,
+      // ...bareAuthSigTests,
+      //
+      // ...pkpEthersTest.eoaSessionSigs,
+      // ...pkpEthersTest.pkpSessionSigs,
+      // ...pkpEthersTest.litActionSessionSigs,
+      //
+      // ...litActionCombiningTests.broadcastAndCombine,
+      // ...litActionCombiningTests.decryptAndCombine,
+      // ...litActionCombiningTests.ecdsaSignAndCombine,
+      //
+      // ...relayerTests,
       ...wrappedKeysTests,
     },
     devEnv,
diff --git a/packages/wrapped-keys-lit-actions/src/lib/internal/ethereum/signTransaction.ts b/packages/wrapped-keys-lit-actions/src/lib/internal/ethereum/signTransaction.ts
@@ -8,7 +8,6 @@ export interface UnsignedTransaction {
   dataHex?: string;
   gasPrice?: string;
   gasLimit?: number;
-  serializedTransaction?: any;
 }
 
 export function getValidatedUnsignedTx(
diff --git a/packages/wrapped-keys-lit-actions/src/lib/internal/solana/signMessage.ts b/packages/wrapped-keys-lit-actions/src/lib/internal/solana/signMessage.ts
@@ -1,11 +1,7 @@
-import { Keypair } from '@solana/web3.js';
-import nacl from 'tweetnacl';
 import { Buffer } from 'buffer';
 
-/**
- * The global ethers library (5.7.0) is available on Lit Action (Unbundled)
- */
-import { ethers } from 'ethers';
+import { Keypair } from '@solana/web3.js';
+import nacl from 'tweetnacl';
 
 interface SignMessageParams {
   messageToSign: string;
diff --git a/packages/wrapped-keys-lit-actions/src/lib/internal/solana/signTransaction.ts b/packages/wrapped-keys-lit-actions/src/lib/internal/solana/signTransaction.ts
@@ -6,11 +6,11 @@ import {
   Transaction,
 } from '@solana/web3.js';
 
-/**
- * The global ethers library (5.7.0) is available on Lit Action (Unbundled)
- */
-import { ethers } from 'ethers';
-import { UnsignedTransaction } from '../ethereum/signTransaction';
+// Solana transactions are pre-serialized; much simpler API than ethereum transactions
+export interface UnsignedTransaction {
+  chain: string;
+  serializedTransaction: string;
+}
 
 export function validateUnsignedTransaction(
   unsignedTransaction: UnsignedTransaction
@@ -88,6 +88,7 @@ export async function signTransactionSolanaKey({
   if (!broadcast) {
     return signature;
   }
+
   // Ensure the chain is a valid Cluster type
   const chain: Cluster = unsignedTransaction.chain as Cluster;
 
diff --git a/packages/wrapped-keys-lit-actions/src/lib/litActionHandler.ts b/packages/wrapped-keys-lit-actions/src/lib/litActionHandler.ts
@@ -1,5 +1,3 @@
-/* global Lit */
-
 import { AbortError } from './abortError';
 
 export async function litActionHandler(actionFunc: () => Promise<any>) {
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/common/batchGenerateEncryptedKeys.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/common/batchGenerateEncryptedKeys.ts
@@ -14,6 +14,11 @@ interface Action {
   };
 }
 
+export interface BatchGenerateEncryptedKeysParams {
+  actions: Action[];
+  accessControlConditions: string;
+}
+
 async function processEthereumAction({
   action,
   accessControlConditions,
@@ -94,10 +99,7 @@ async function processSolanaAction({
 async function processActions({
   actions,
   accessControlConditions,
-}: {
-  actions: Action[];
-  accessControlConditions: string;
-}) {
+}: BatchGenerateEncryptedKeysParams) {
   return Promise.all(
     actions.map(async (action, ndx) => {
       const { network } = action;
@@ -159,10 +161,7 @@ function validateParams(actions: Action[]) {
 export async function batchGenerateEncryptedKeys({
   actions,
   accessControlConditions,
-}: {
-  actions: Action[];
-  accessControlConditions: string;
-}) {
+}: BatchGenerateEncryptedKeysParams) {
   validateParams(actions);
 
   return processActions({
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/common/exportPrivateKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/common/exportPrivateKey.ts
@@ -1,6 +1,6 @@
 import { getDecryptedKeyToSingleNode } from '../../internal/common/getDecryptedKeyToSingleNode';
 
-interface ExportPrivateKeyParams {
+export interface ExportPrivateKeyParams {
   accessControlConditions: string;
   ciphertext: string;
   dataToEncryptHash: string;
@@ -10,10 +10,10 @@ interface ExportPrivateKeyParams {
  *
  * Exports the private key after decrypting and removing the salt from it.
  *
- * @param {string} pkpAddress - The Eth address of the PKP which is associated with the Wrapped Key
- * @param {string} ciphertext - For the encrypted Wrapped Key
- * @param {string} dataToEncryptHash - For the encrypted Wrapped Key
- * @param {any} accessControlConditions - The access control condition that allows only the pkpAddress to decrypt the Wrapped Key
+ * @param {object} params
+ * @param {string} params.ciphertext - For the encrypted Wrapped Key
+ * @param {string} params.dataToEncryptHash - For the encrypted Wrapped Key
+ * @param {string} params.accessControlConditions - The access control condition that allows only the pkpAddress to decrypt the Wrapped Key
  *
  * @returns { Promise<string> } - Returns a decrypted private key.
  */
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/ethereum/generateEncryptedEthereumPrivateKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/ethereum/generateEncryptedEthereumPrivateKey.ts
@@ -10,7 +10,7 @@
 import { encryptPrivateKey } from '../../internal/common/encryptKey';
 import { generateEthereumPrivateKey } from '../../internal/ethereum/generatePrivateKey';
 
-interface GenerateEncryptedEthereumPrivateKeyParams {
+export interface GenerateEncryptedEthereumPrivateKeyParams {
   accessControlConditions: string;
 }
 
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/ethereum/signMessageWithEncryptedEthereumKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/ethereum/signMessageWithEncryptedEthereumKey.ts
@@ -1,7 +1,7 @@
 import { getDecryptedKeyToSingleNode } from '../../internal/common/getDecryptedKeyToSingleNode';
 import { signMessageEthereumKey } from '../../internal/ethereum/signMessage';
 
-interface SignMessageWithEncryptedEthereumKeyParams {
+export interface SignMessageWithEncryptedEthereumKeyParams {
   accessControlConditions: string;
   ciphertext: string;
   dataToEncryptHash: string;
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/ethereum/signTransactionWithEncryptedEthereumKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/ethereum/signTransactionWithEncryptedEthereumKey.ts
@@ -5,7 +5,7 @@ import {
   UnsignedTransaction,
 } from '../../internal/ethereum/signTransaction';
 
-interface SignTransactionWithEncryptedEthereumKeyParams {
+export interface SignTransactionWithEncryptedEthereumKeyParams {
   accessControlConditions: string;
   ciphertext: string;
   dataToEncryptHash: string;
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/solana/generateEncryptedSolanaPrivateKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/solana/generateEncryptedSolanaPrivateKey.ts
@@ -8,7 +8,7 @@ import { generateSolanaPrivateKey } from '../../internal/solana/generatePrivateK
  *
  * @returns { Promise<{ciphertext: string, dataToEncryptHash: string, publicKey: string}> } - Returns JSON object with ciphertext & dataToEncryptHash which are the result of the encryption. Also returns the publicKey of the newly generated Solana Wrapped Key.
  */
-interface GenerateEncryptedSolanaPrivateKeyParams {
+export interface GenerateEncryptedSolanaPrivateKeyParams {
   accessControlConditions: string;
 }
 
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/solana/signMessageWithEncryptedSolanaKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/solana/signMessageWithEncryptedSolanaKey.ts
@@ -1,7 +1,7 @@
 import { getDecryptedKeyToSingleNode } from '../../internal/common/getDecryptedKeyToSingleNode';
 import { signMessageSolanaKey } from '../../internal/solana/signMessage';
 
-interface SignMessageWithEncryptedSolanaKeyParams {
+export interface SignMessageWithEncryptedSolanaKeyParams {
   accessControlConditions: string;
   ciphertext: string;
   dataToEncryptHash: string;
diff --git a/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/solana/signTransactionWithEncryptedSolanaKey.ts b/packages/wrapped-keys-lit-actions/src/lib/raw-action-functions/solana/signTransactionWithEncryptedSolanaKey.ts
@@ -1,16 +1,12 @@
 import { getDecryptedKeyToSingleNode } from '../../internal/common/getDecryptedKeyToSingleNode';
-import { UnsignedTransaction } from '../../internal/ethereum/signTransaction';
 import {
   signTransactionSolanaKey,
   validateUnsignedTransaction,
 } from '../../internal/solana/signTransaction';
 
-/**
- * The global ethers library (5.7.0) is available on Lit Action (Unbundled)
- */
-import { ethers } from 'ethers';
+import type { UnsignedTransaction } from '../../internal/solana/signTransaction';
 
-interface SignTransactionWithEncryptedSolanaKeyParams {
+export interface SignTransactionWithEncryptedSolanaKeyParams {
   accessControlConditions: string;
   ciphertext: string; // The encrypted Wrapped Key
   dataToEncryptHash: string; // The hash of the data to encrypt
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/common/batchGenerateEncryptedKeys.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/common/batchGenerateEncryptedKeys.ts
@@ -1,12 +1,11 @@
 import { litActionHandler } from '../../litActionHandler';
 import { batchGenerateEncryptedKeys } from '../../raw-action-functions/common/batchGenerateEncryptedKeys';
 
-/* global actions accessControlConditions */
+import type { BatchGenerateEncryptedKeysParams } from '../../raw-action-functions/common/batchGenerateEncryptedKeys';
 
-declare global {
-  var actions: any[];
-  var accessControlConditions: string;
-}
+// Using local declarations to avoid _every file_ thinking these are always in scope
+declare const actions: BatchGenerateEncryptedKeysParams['actions'];
+declare const accessControlConditions: BatchGenerateEncryptedKeysParams['accessControlConditions'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/common/exportPrivateKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/common/exportPrivateKey.ts
@@ -1,13 +1,12 @@
-/* global accessControlConditions, ciphertext, dataToEncryptHash */
-
 import { litActionHandler } from '../../litActionHandler';
 import { exportPrivateKey } from '../../raw-action-functions/common/exportPrivateKey';
 
-declare global {
-  var accessControlConditions: string;
-  var ciphertext: any;
-  var dataToEncryptHash: any;
-}
+import type { ExportPrivateKeyParams } from '../../raw-action-functions/common/exportPrivateKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+declare const ciphertext: ExportPrivateKeyParams['ciphertext'];
+declare const dataToEncryptHash: ExportPrivateKeyParams['dataToEncryptHash'];
+declare const accessControlConditions: ExportPrivateKeyParams['accessControlConditions'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/ethereum/generateEncryptedEthereumPrivateKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/ethereum/generateEncryptedEthereumPrivateKey.ts
@@ -1,11 +1,10 @@
-/* global accessControlConditions */
-
 import { litActionHandler } from '../../litActionHandler';
 import { generateEncryptedEthereumPrivateKey } from '../../raw-action-functions/ethereum/generateEncryptedEthereumPrivateKey';
 
-declare global {
-  var accessControlConditions: string;
-}
+import type { GenerateEncryptedEthereumPrivateKeyParams } from '../../raw-action-functions/ethereum/generateEncryptedEthereumPrivateKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+declare const accessControlConditions: GenerateEncryptedEthereumPrivateKeyParams['accessControlConditions'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/ethereum/signMessageWithEncryptedEthereumKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/ethereum/signMessageWithEncryptedEthereumKey.ts
@@ -1,14 +1,13 @@
-/* global accessControlConditions, ciphertext, dataToEncryptHash, messageToSign */
-
 import { litActionHandler } from '../../litActionHandler';
 import { signMessageWithEncryptedEthereumKey } from '../../raw-action-functions/ethereum/signMessageWithEncryptedEthereumKey';
 
-declare global {
-  var accessControlConditions: string;
-  var ciphertext: any;
-  var dataToEncryptHash: any;
-  var messageToSign: any;
-}
+import type { SignMessageWithEncryptedEthereumKeyParams } from '../../raw-action-functions/ethereum/signMessageWithEncryptedEthereumKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+declare const accessControlConditions: SignMessageWithEncryptedEthereumKeyParams['accessControlConditions'];
+declare const ciphertext: SignMessageWithEncryptedEthereumKeyParams['ciphertext'];
+declare const dataToEncryptHash: SignMessageWithEncryptedEthereumKeyParams['dataToEncryptHash'];
+declare const messageToSign: SignMessageWithEncryptedEthereumKeyParams['messageToSign'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/ethereum/signTransactionWithEncryptedEthereumKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/ethereum/signTransactionWithEncryptedEthereumKey.ts
@@ -1,16 +1,16 @@
-/* global accessControlConditions, ciphertext, dataToEncryptHash, unsignedTransaction, broadcast */
-
-import { UnsignedTransaction } from '../../internal/ethereum/signTransaction';
 import { litActionHandler } from '../../litActionHandler';
 import { signTransactionWithEncryptedEthereumKey } from '../../raw-action-functions/ethereum/signTransactionWithEncryptedEthereumKey';
 
-declare global {
-  var accessControlConditions: string;
-  var ciphertext: any;
-  var dataToEncryptHash: any;
-  var unsignedTransaction: UnsignedTransaction;
-  var broadcast: any;
-}
+import type { SignTransactionWithEncryptedEthereumKeyParams } from '../../raw-action-functions/ethereum/signTransactionWithEncryptedEthereumKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+// Ugly, but using `declare global` causes conflicts with `solana`'s `unsignedTransaction` which is different
+// as well as making all of our functions think all other functions args are valid globals in every file in the package
+declare const accessControlConditions: SignTransactionWithEncryptedEthereumKeyParams['accessControlConditions'];
+declare const ciphertext: SignTransactionWithEncryptedEthereumKeyParams['ciphertext'];
+declare const dataToEncryptHash: SignTransactionWithEncryptedEthereumKeyParams['dataToEncryptHash'];
+declare const unsignedTransaction: SignTransactionWithEncryptedEthereumKeyParams['unsignedTransaction'];
+declare const broadcast: SignTransactionWithEncryptedEthereumKeyParams['broadcast'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/solana/generateEncryptedSolanaPrivateKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/solana/generateEncryptedSolanaPrivateKey.ts
@@ -1,11 +1,10 @@
-/* global accessControlConditions */
-
 import { litActionHandler } from '../../litActionHandler';
 import { generateEncryptedSolanaPrivateKey } from '../../raw-action-functions/solana/generateEncryptedSolanaPrivateKey';
 
-declare global {
-  var accessControlConditions: string;
-}
+import type { GenerateEncryptedSolanaPrivateKeyParams } from '../../raw-action-functions/solana/generateEncryptedSolanaPrivateKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+declare const accessControlConditions: GenerateEncryptedSolanaPrivateKeyParams['accessControlConditions'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/solana/signMessageWithEncryptedSolanaKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/solana/signMessageWithEncryptedSolanaKey.ts
@@ -1,14 +1,13 @@
-/* global accessControlConditions, ciphertext, dataToEncryptHash, messageToSign */
-
 import { litActionHandler } from '../../litActionHandler';
 import { signMessageWithEncryptedSolanaKey } from '../../raw-action-functions/solana/signMessageWithEncryptedSolanaKey';
 
-declare global {
-  var accessControlConditions: string;
-  var ciphertext: any;
-  var dataToEncryptHash: any;
-  var messageToSign: any;
-}
+import type { SignMessageWithEncryptedSolanaKeyParams } from '../../raw-action-functions/solana/signMessageWithEncryptedSolanaKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+declare const accessControlConditions: SignMessageWithEncryptedSolanaKeyParams['accessControlConditions'];
+declare const ciphertext: SignMessageWithEncryptedSolanaKeyParams['ciphertext'];
+declare const dataToEncryptHash: SignMessageWithEncryptedSolanaKeyParams['dataToEncryptHash'];
+declare const messageToSign: SignMessageWithEncryptedSolanaKeyParams['messageToSign'];
 
 (async () =>
   litActionHandler(async () =>
diff --git a/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/solana/signTransactionWithEncryptedSolanaKey.ts b/packages/wrapped-keys-lit-actions/src/lib/self-executing-actions/solana/signTransactionWithEncryptedSolanaKey.ts
@@ -1,16 +1,16 @@
-/* global accessControlConditions, ciphertext, dataToEncryptHash, unsignedTransaction, broadcast */
-
-import { UnsignedTransaction } from '../../internal/ethereum/signTransaction';
 import { litActionHandler } from '../../litActionHandler';
 import { signTransactionWithEncryptedSolanaKey } from '../../raw-action-functions/solana/signTransactionWithEncryptedSolanaKey';
 
-declare global {
-  var accessControlConditions: string;
-  var ciphertext: any;
-  var dataToEncryptHash: any;
-  var unsignedTransaction: UnsignedTransaction;
-  var broadcast: any;
-}
+import type { SignTransactionWithEncryptedSolanaKeyParams } from '../../raw-action-functions/solana/signTransactionWithEncryptedSolanaKey';
+
+// Using local declarations to avoid _every file_ thinking these are always in scope
+// Ugly, but using `declare global` causes conflicts with `ethereum`'s `unsignedTransaction` which is different
+// as well as making all of our functions think all other functions args are valid globals in every file in the package
+declare const accessControlConditions: SignTransactionWithEncryptedSolanaKeyParams['accessControlConditions'];
+declare const ciphertext: SignTransactionWithEncryptedSolanaKeyParams['ciphertext'];
+declare const dataToEncryptHash: SignTransactionWithEncryptedSolanaKeyParams['dataToEncryptHash'];
+declare const unsignedTransaction: SignTransactionWithEncryptedSolanaKeyParams['unsignedTransaction'];
+declare const broadcast: SignTransactionWithEncryptedSolanaKeyParams['broadcast'];
 
 (async () =>
   litActionHandler(async () =>

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@ export interface UnsignedTransaction {`
`8`	`8`	`dataHex?: string;`
`9`	`9`	`gasPrice?: string;`
`10`	`10`	`gasLimit?: number;`
`11`		`- serializedTransaction?: any;`
`12`	`11`	`}`
`13`	`12`
`14`	`13`	`export function getValidatedUnsignedTx(`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-/* global Lit */`
`2`		`-`
`3`	`1`	`import { AbortError } from './abortError';`
`4`	`2`
`5`	`3`	`export async function litActionHandler(actionFunc: () => Promise<any>) {`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`import { encryptPrivateKey } from '../../internal/common/encryptKey';`
`11`	`11`	`import { generateEthereumPrivateKey } from '../../internal/ethereum/generatePrivateKey';`
`12`	`12`
`13`		`-interface GenerateEncryptedEthereumPrivateKeyParams {`
	`13`	`+export interface GenerateEncryptedEthereumPrivateKeyParams {`
`14`	`14`	`accessControlConditions: string;`
`15`	`15`	`}`
`16`	`16`