test(test-d): add test-d files for vitest typechecking: (#1248)

# Pull Request Checklist

- [x] Did you add new tests and confirm existing tests pass? (`yarn test`)
- [x] Did you update relevant docs? (docs are found in the `site` folder, and guidelines for updating/adding docs can be found in the [contribution guide](https://github.com/alchemyplatform/aa-sdk/blob/main/CONTRIBUTING.md))
- [x] Do your commits follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard?
- [x] Does your PR title also follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard?
- [x] If you have a breaking change, is it [correctly reflected in your commit message](https://www.conventionalcommits.org/en/v1.0.0/#examples)? (e.g. `feat!: breaking change`)
- [x] Did you run lint (`yarn lint:check`) and fix any issues? (`yarn lint:write`)
- [x] Did you follow the [contribution guidelines](https://github.com/alchemyplatform/aa-sdk/blob/main/CONTRIBUTING.md)?

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on enhancing type checking and testing for the `account-kit` packages, particularly by adding `test-d.ts` files and updating test commands. It also removes unused code related to Alchemy transport.

### Detailed summary
- Added `test-d.ts` files for type definitions in multiple packages.
- Updated `.github/workflows/on-pull-request.yml` to include type checking in tests.
- Modified `package.json` to add a new `test:typecheck` script.
- Updated `CONTRIBUTING.md` to reflect changes in testing commands.
- Removed Alchemy-related code from `client.test.ts`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->

.github/workflows/on-pull-request.yml

@@ -101,6 +101,9 @@ jobs:
 
       - name: Unit Test
         run: yarn test:ci
+
+      - name: Typecheck Test
+        run: yarn test:typecheck
 
   build_ios:
     name: Build iOS
@@ -131,3 +134,4 @@ jobs:
       - name: Build example for iOS
         run: |
           yarn turbo run build:ios
+

.vitest/vitest.shared.ts

@@ -3,6 +3,9 @@ import { configDefaults, defineConfig } from "vitest/config";
 
 export const sharedConfig = defineConfig({
   test: {
+    typecheck: {
+      ignoreSourceErrors: true,
+    },
     alias: {
       "~test": join(__dirname, "./src"),
     },

CONTRIBUTING.md

@@ -12,11 +12,11 @@ We are excited to have you contribute to the `aa-sdk`. Here's a step-by-step gui
 
    - Use the Node version specified in `package.json` (currently 18.16.0). Run `node -v` to check your version.
    - Build the project with `yarn build`.
-   - Run existing tests using `yarn test` to ensure everything is working correctly.
+   - Run existing tests using `yarn test` & `yarn test:typecheck` to ensure everything is working correctly.
 
 4. **Make Changes**: Now, you can start making changes to the packages or docs. When updating or adding new functionality, update or add a new doc in `site/packages/*` corresponding to the package you have worked on to document the changes.
 
-5. **Re-verify Tests**: After making your changes, re-run `yarn test` to ensure all tests still pass.
+5. **Re-verify Tests**: After making your changes, re-run `yarn test` & `yarn test:typecheck` to ensure all tests still pass.
 
 6. **Code Formatting**:
 

aa-sdk/core/package.json

@@ -17,6 +17,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

aa-sdk/core/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts"

aa-sdk/ethers/package.json

@@ -17,6 +17,7 @@
     "!.env",
     "!dist/**/*.tsbuildinfo",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

aa-sdk/ethers/tsconfig.build.json

@@ -5,6 +5,7 @@
     "**/*/__tests__",
     "**/*/*.e2e.test.ts",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "vitest.config.ts"
   ],
   "include": ["src"],

account-kit/core/package.json

@@ -18,6 +18,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/core/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts"

account-kit/infra/package.json

@@ -18,6 +18,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/infra/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts"

account-kit/logging/package.json

@@ -18,6 +18,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/logging/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts"

account-kit/plugingen/package.json

@@ -17,6 +17,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/plugingen/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts"

account-kit/react/package.json

@@ -19,6 +19,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/react/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts",

account-kit/react/tsconfig.storybook.json

@@ -9,6 +9,7 @@
   "exclude": [
     "src/**/*.spec.ts",
     "src/**/*.test.ts",
+    "src/**/*.test-d.ts",
     "src/**/*.spec.js",
     "src/**/*.test.js",
     "src/**/*.spec.tsx",

account-kit/signer/package.json

@@ -18,6 +18,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/signer/tsconfig.build.json

@@ -4,6 +4,7 @@
     "node_modules",
     "**/*/__tests__",
     "**/*/*.test.ts",
+    "**/*/*.test-d.ts",
     "**/*/*.e2e.test.ts",
     "vitest.config.ts",
     "vitest.config.e2e.ts"

account-kit/smart-contracts/package.json

@@ -19,6 +19,7 @@
     "!vitest.config.ts",
     "!.env",
     "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
     "!src/__tests__/**/*"
   ],
   "exports": {

account-kit/smart-contracts/src/light-account/clients/client.test-d.ts

@@ -0,0 +1,125 @@
+import {
+  erc7677Middleware,
+  LocalAccountSigner,
+  type SmartAccountClient,
+  type SmartAccountSigner,
+} from "@aa-sdk/core";
+import {
+  custom,
+  type Address,
+  type Chain,
+  type Client,
+  type CustomTransport,
+} from "viem";
+import { accounts } from "~test/constants.js";
+import { local060Instance } from "~test/instances.js";
+import type { LightAccountVersion } from "../types.js";
+import { createLightAccountClient } from "./client.js";
+import {
+  alchemy,
+  polygonMumbai,
+  alchemyEnhancedApiActions,
+  type AlchemyTransport,
+  type AlchemySmartAccountClient,
+  type AlchemyEnhancedApis,
+} from "@account-kit/infra";
+import { Alchemy, Network } from "alchemy-sdk";
+
+describe("Types: Light Account Tests", () => {
+  const instance = local060Instance;
+  const signer: SmartAccountSigner = new LocalAccountSigner(
+    accounts.fundedAccountOwner
+  );
+
+  const givenConnectedProvider = ({
+    signer,
+    version = "v1.1.0",
+    accountAddress,
+    usePaymaster = false,
+  }: {
+    signer: SmartAccountSigner;
+    version?: LightAccountVersion<"LightAccount">;
+    usePaymaster?: boolean;
+    accountAddress?: Address;
+  }) =>
+    createLightAccountClient({
+      signer,
+      accountAddress,
+      version,
+      transport: custom(instance.getClient()),
+      chain: instance.chain,
+      ...(usePaymaster ? erc7677Middleware() : {}),
+    });
+
+  const givenAlchemyConnectedProvider = async ({
+    signer,
+    chain,
+  }: {
+    signer: SmartAccountSigner;
+    chain: Chain;
+  }) =>
+    createLightAccountClient({
+      transport: alchemy({
+        jwt: "test",
+      }),
+      chain,
+      signer,
+      accountAddress: "0x86f3B0211764971Ad0Fc8C8898d31f5d792faD84",
+    });
+  it("Should have some alchemy specific types", async () => {
+    const alchemy = new Alchemy({
+      network: Network.MATIC_MUMBAI,
+      apiKey: "test",
+    });
+    const chain = polygonMumbai;
+
+    const provider = (
+      await givenAlchemyConnectedProvider({ signer, chain })
+    ).extend(alchemyEnhancedApiActions(alchemy));
+
+    assertType<Client<AlchemyTransport>>(provider);
+    assertType<AlchemySmartAccountClient>(provider);
+    assertType<SmartAccountClient>(provider);
+    assertType<AlchemyEnhancedApis>(provider);
+    assertType<AlchemyEnhancedApis>(
+      // @ts-expect-error
+      await givenAlchemyConnectedProvider({ signer, chain })
+    );
+    // @ts-expect-error
+    assertType<Client<CustomTransport>>(provider);
+  });
+  it("Should have some non-alchemy specific types", async () => {
+    const chain = polygonMumbai;
+
+    const signer: SmartAccountSigner = new LocalAccountSigner(
+      accounts.fundedAccountOwner
+    );
+    const provider = await givenConnectedProvider({
+      signer,
+      version: "v1.0.1",
+    });
+
+    assertType<SmartAccountClient>(provider);
+    assertType<Client<CustomTransport>>(provider);
+    assertType<AlchemyEnhancedApis>(
+      // @ts-expect-error
+      await givenAlchemyConnectedProvider({ signer, chain })
+    );
+    // @ts-expect-error
+    assertType<Client<AlchemyTransport>>(provider);
+    // @ts-expect-error
+    assertType<AlchemySmartAccountClient>(provider);
+    // @ts-expect-error
+    assertType<AlchemyEnhancedApis>(provider);
+
+    expect(() => {
+      const alchemy = new Alchemy({
+        network: Network.MATIC_MUMBAI,
+        apiKey: "test",
+      });
+
+      // @ts-expect-error
+      provider.extend(alchemyEnhancedApiActions(alchemy));
+    }).not.toBeFalsy();
+  });
+});