refactor(common,cli): kms deployer gets keyId from environment (#2760)

Co-authored-by: Kevin Ingersoll <[email protected]>
latticexyz · Apr 29, 2024 · e03830e · e03830e
1 parent 3031868
commit e03830e
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 8 deletions.
diff --git a/.changeset/quick-lions-rest.md b/.changeset/quick-lions-rest.md
@@ -0,0 +1,10 @@
+---
+"@latticexyz/cli": patch
+---
+
+The key ID for deploying via KMS signer is now set via an `AWS_KMS_KEY_ID` environment variable to better align with Foundry tooling. To enable KMS signing with this environment variable, use the `--kms` flag.
+
+```diff
+-mud deploy --awsKmsKeyId [key ID]
++AWS_KMS_KEY_ID=[key ID] mud deploy --kms
+```
diff --git a/packages/cli/src/commands/dev-contracts.ts b/packages/cli/src/commands/dev-contracts.ts
@@ -92,7 +92,7 @@ const commandModule: CommandModule<typeof devOptions, InferredOptionTypes<typeof
             worldAddress,
             srcDir,
             salt: "0x",
-            awsKmsKeyId: undefined,
+            kms: undefined,
           });
           worldAddress = deploy.address;
           // if there were changes while we were deploying, trigger it again

diff --git a/packages/cli/src/runDeploy.ts b/packages/cli/src/runDeploy.ts
@@ -43,9 +43,9 @@ export const deployOptions = {
     type: "string",
     desc: "The deployment salt to use. Defaults to a random salt.",
   },
-  awsKmsKeyId: {
-    type: "string",
-    desc: "Optional AWS KMS key ID. If set, the World is deployed using a KMS signer instead of local private key.",
+  kms: {
+    type: "boolean",
+    desc: "Deploy the World with an AWS KMS key instead of local private key.",
   },
 } as const satisfies Record<string, Options>;
 
@@ -87,8 +87,14 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
   const resolvedConfig = resolveConfig({ config, forgeSourceDir: srcDir, forgeOutDir: outDir });
 
   const account = await (async () => {
-    if (opts.awsKmsKeyId) {
-      const keyId = opts.awsKmsKeyId ?? process.env.AWS_KMS_KEY_ID;
+    if (opts.kms) {
+      const keyId = process.env.AWS_KMS_KEY_ID;
+      if (!keyId) {
+        throw new MUDError(
+          "Missing `AWS_KMS_KEY_ID` environment variable. This is required when using with `--kms` option.",
+        );
+      }
+
       return await kmsKeyToAccount({ keyId });
     } else {
       const privateKey = process.env.PRIVATE_KEY;

diff --git a/packages/common/src/account/kms/getAddressFromKms.ts b/packages/common/src/account/kms/getAddressFromKms.ts
@@ -1,6 +1,6 @@
 import { Address, toHex } from "viem";
 import { publicKeyToAddress } from "viem/utils";
-import { KMSClient, SignCommandInput } from "@aws-sdk/client-kms";
+import { GetPublicKeyCommandInput, KMSClient } from "@aws-sdk/client-kms";
 import { getPublicKey } from "./getPublicKey";
 // @ts-expect-error Could not find a declaration file for module 'asn1.js'.
 import asn1 from "asn1.js";
@@ -25,7 +25,7 @@ export async function getAddressFromKms({
   keyId,
   client,
 }: {
-  keyId: SignCommandInput["KeyId"];
+  keyId: GetPublicKeyCommandInput["KeyId"];
   client: KMSClient;
 }): Promise<Address> {
   const KMSKey = await getPublicKey({ keyId, client });