Add keycard support

.changeset/wise-bats-wish.md

@@ -0,0 +1,2 @@
+---
+---

README.md

@@ -351,14 +351,15 @@ console.log(hardhatConfig.etherscan());
 
 ### hardhatConfig.getEnvVariableNames()
 
-Returns an API key required for Etherscan V2 contract verification API and a single `MNEMONIC` variable that can be used to configure all networks.
+Returns environment variable names that are expected to be set for Hardhat configuration.
 
 ```ts
 import { hardhatConfig } from '@api3/contracts';
 console.log(hardhatConfig.getEnvVariableNames());
 /*
 [
   'MNEMONIC',
+  'KEYCARD_ACCOUNT',
   'ETHERSCAN_API_KEY',
   'HARDHAT_HTTP_RPC_URL_APECHAIN_ARBITRUM_SEPOLIA_TESTNET',
   ...

deploy/1_deploy.ts

@@ -105,7 +105,12 @@ module.exports = async () => {
     api3ReaderProxyV1Metadata
   );
   if ((await ethers.provider.getCode(expectedApi3ReaderProxyV1Address)) === '0x') {
-    await api3ReaderProxyV1Factory.deployApi3ReaderProxyV1(dapiName, dappId, api3ReaderProxyV1Metadata);
+    const proxyTransactionResponse = await api3ReaderProxyV1Factory.deployApi3ReaderProxyV1(
+      dapiName,
+      dappId,
+      api3ReaderProxyV1Metadata
+    );
+    await proxyTransactionResponse.wait(1);
     log(`Deployed example Api3ReaderProxyV1 at ${expectedApi3ReaderProxyV1Address}`);
   }
 

example.env

@@ -1,2 +1,3 @@
 MNEMONIC=
+KEYCARD_ACCOUNT=
 ETHERSCAN_API_KEY=

hardhat.config.ts

@@ -3,6 +3,7 @@ import * as fs from 'node:fs';
 import { glob } from 'glob';
 import type { HardhatUserConfig } from 'hardhat/config';
 import '@nomicfoundation/hardhat-toolbox';
+import 'keycard-hardhat-provider';
 import 'hardhat-deploy';
 import 'dotenv/config';
 import { task } from 'hardhat/config';

package.json

@@ -93,6 +93,7 @@
     "hardhat": "^2.26.2",
     "hardhat-deploy": "1.0.2",
     "hardhat-gas-reporter": "^2.3.0",
+    "keycard-hardhat-provider": "^0.1.1",
     "jest": "^30.0.5",
     "prettier": "^3.5.3",
     "prettier-plugin-solidity": "^2.0.0",

scripts/check-example-env-file.ts

@@ -1,6 +1,6 @@
 import * as fs from 'node:fs';
 
-const expectedEnvVars = ['MNEMONIC', 'ETHERSCAN_API_KEY'];
+const expectedEnvVars = ['MNEMONIC', 'KEYCARD_ACCOUNT', 'ETHERSCAN_API_KEY'];
 const expectedExampleEnvFileContents = expectedEnvVars.reduce((fileContents: string, envVariableName: string) => {
   return `${fileContents}${envVariableName}=\n`;
 }, '');

src/hardhat-config.test.ts

@@ -24,7 +24,7 @@ describe(getEnvVariableNames.name, () => {
   it('returns an array with expected env variables', () => {
     const apiKeyEnvName = etherscanApiKeyName();
     const networkRpcUrlNames = CHAINS.map((chain) => networkHttpRpcUrlName(chain));
-    const expected = ['MNEMONIC', apiKeyEnvName, ...networkRpcUrlNames];
+    const expected = ['MNEMONIC', 'KEYCARD_ACCOUNT', apiKeyEnvName, ...networkRpcUrlNames];
     expect(getEnvVariableNames()).toStrictEqual(expected);
   });
 });

src/hardhat-config.ts

@@ -12,7 +12,7 @@ export function getEnvVariableNames(): string[] {
 
   const networkRpcUrlNames = CHAINS.map((chain) => networkHttpRpcUrlName(chain));
 
-  return ['MNEMONIC', apiKeyEnvName, ...networkRpcUrlNames];
+  return ['MNEMONIC', 'KEYCARD_ACCOUNT', apiKeyEnvName, ...networkRpcUrlNames];
 }
 
 export function etherscanApiKeyName(): string {
@@ -77,12 +77,16 @@ export function networks(): HardhatNetworksConfig {
     throw new Error('Cannot be called outside of a Node.js environment');
   }
 
+  const credentials = process.env.KEYCARD_ACCOUNT
+    ? { keycardAccount: process.env.KEYCARD_ACCOUNT }
+    : { accounts: { mnemonic: process.env.MNEMONIC ?? '' } };
+
   return CHAINS.reduce((networks, chain) => {
     const defaultProvider = chain.providers.find((p) => p.alias === 'default');
     const overrides = chain.hardhatConfigOverrides?.networks ?? {};
 
     networks[chain.alias] = {
-      accounts: { mnemonic: process.env.MNEMONIC ?? '' },
+      ...credentials,
       chainId: Number(chain.id),
       url: process.env[networkHttpRpcUrlName(chain)] ?? defaultProvider!.rpcUrl!,
       ...overrides,

src/types.ts

@@ -84,7 +84,8 @@ export type ChainProvider = z.infer<typeof chainProviderSchema>;
 
 export interface HardhatNetworksConfig {
   [key: string]: {
-    accounts: { mnemonic: string };
+    accounts?: { mnemonic: string };
+    keycardAccount?: string;
     chainId: number;
     url: string;
   };