feat: make key nickname required (#1198)

interledger · Mar 6, 2024 · dc36ba4 · dc36ba4
1 parent 76f8169
commit dc36ba4
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 22 deletions.
diff --git a/packages/wallet/backend/migrations/20240306113102_default_keys_nickname.js b/packages/wallet/backend/migrations/20240306113102_default_keys_nickname.js
@@ -0,0 +1,23 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function (knex) {
+  return knex.schema.alterTable('walletAddressKeys', async (table) => {
+    await knex('walletAddressKeys')
+      .update({ nickname: 'Testnet managed' })
+      .whereNull('nickname')
+
+    table.string('nickname').notNullable().alter()
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function (knex) {
+  return knex.schema.alterTable('walletAddressKeys', async (table) => {
+    table.string('nickname').nullable().alter()
+  })
+}
diff --git a/packages/wallet/backend/src/user/service.ts b/packages/wallet/backend/src/user/service.ts
@@ -165,6 +165,7 @@ export class UserService implements IUserService {
         userId: boutiqueInfo.createdUser.id,
         accountId: boutiqueInfo.defaultAccount.id,
         walletAddressId: boutiqueWallet.id,
+        nickname: 'Testnet managed',
         keyPair: {
           publicKeyPEM: this.env.DEFAULT_BOUTIQUE_KEYS.public_key,
           privateKeyPEM: this.env.DEFAULT_BOUTIQUE_KEYS.private_key,

diff --git a/packages/wallet/backend/src/walletAddressKeys/controller.ts b/packages/wallet/backend/src/walletAddressKeys/controller.ts
@@ -16,12 +16,6 @@ interface IWalletAddressKeyController {
   list: ControllerFunction<WalletAddressKeys[]>
 }
 
-interface KeyPair {
-  publicKey: string
-  privateKey: string
-  keyId: string
-}
-
 export class WalletAddressKeyController implements IWalletAddressKeyController {
   constructor(private walletAddressKeyService: WalletAddressKeyService) {}
 
@@ -75,7 +69,7 @@ export class WalletAddressKeyController implements IWalletAddressKeyController {
 
   registerKey = async (
     req: Request,
-    res: CustomResponse<KeyPair>,
+    res: CustomResponse<KeyResponse>,
     next: NextFunction
   ) => {
     try {

diff --git a/packages/wallet/backend/src/walletAddressKeys/model.ts b/packages/wallet/backend/src/walletAddressKeys/model.ts
@@ -5,7 +5,7 @@ import { WalletAddress } from '@/walletAddress/model'
 export class WalletAddressKeys extends BaseModel {
   static tableName = 'walletAddressKeys'
 
-  nickname?: string
+  nickname!: string
   readonly walletAddressId!: string
   readonly rafikiId!: string
   readonly publicKey!: string

diff --git a/packages/wallet/backend/src/walletAddressKeys/service.ts b/packages/wallet/backend/src/walletAddressKeys/service.ts
@@ -11,7 +11,7 @@ export type KeyResponse = {
   privateKey: string
   publicKey: string
   keyId: string
-  nickname?: string
+  nickname: string
 }
 
 interface WalletAddressKeyArgs {
@@ -21,7 +21,7 @@ interface WalletAddressKeyArgs {
 }
 
 interface RegisterKeyArgs extends WalletAddressKeyArgs {
-  nickname?: string
+  nickname: string
   keyPair?: {
     publicKeyPEM: string
     privateKeyPEM: string

diff --git a/packages/wallet/backend/src/walletAddressKeys/validation.ts b/packages/wallet/backend/src/walletAddressKeys/validation.ts
@@ -2,12 +2,10 @@ import { z } from 'zod'
 
 export const generateWalletAddressKey = z.object({
   body: z.object({
-    nickname: z.optional(
-      z
-        .string()
-        .trim()
-        .min(3, { message: 'Name must be at least 3 characters long' })
-    )
+    nickname: z
+      .string()
+      .trim()
+      .min(3, { message: 'Name must be at least 3 characters long' })
   })
 })
 export const patchWalletAddressKey = z.object({
@@ -21,12 +19,10 @@ export const patchWalletAddressKey = z.object({
 
 export const uploadWalletAddressKey = z.object({
   body: z.object({
-    nickname: z.optional(
-      z
-        .string()
-        .trim()
-        .min(3, { message: 'Name must be at least 3 characters long' })
-    ),
+    nickname: z
+      .string()
+      .trim()
+      .min(3, { message: 'Name must be at least 3 characters long' }),
     base64Key: z.string()
   })
 })