Merge pull request #4615 from WalletConnect/chore/remove-metadata-val…

…idation chore: remove metadata validation
WalletConnect · Jun 14, 2024 · fd1da7d · fd1da7d
2 parents 6653afa + d092b56
commit fd1da7d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 62 deletions.
diff --git a/packages/sign-client/src/client.ts b/packages/sign-client/src/client.ts
@@ -63,18 +63,6 @@ export class SignClient extends ISignClient {
     return this.core.pairing.pairings;
   }
 
-  private validateMetadata(metadata: SignClientTypes.Metadata) {
-    if (!metadata.name) {
-      throw new Error("name is required value in metadata");
-    }
-    if (!metadata.description) {
-      throw new Error("description is required value in metadata");
-    }
-    if (!metadata.url) {
-      throw new Error("url is required value in metadata");
-    }
-  }
-
   // ---------- Events ----------------------------------------------- //
 
   public on: ISignClientEvents["on"] = (name, listener) => {
@@ -257,7 +245,6 @@ export class SignClient extends ISignClient {
   private async initialize() {
     this.logger.trace(`Initialized`);
     try {
-      await this.validateMetadata(this.metadata);
       await this.core.start();
       await this.session.init();
       await this.proposal.init();

diff --git a/packages/sign-client/test/sdk/client.spec.ts b/packages/sign-client/test/sdk/client.spec.ts
@@ -50,52 +50,27 @@ describe("Sign Client Integration", () => {
     await deleteClients({ A: client, B: undefined });
   });
 
-  it("should not initialize without metadata object", async () => {
+  it("should initialize without metadata object", async () => {
     const options = TEST_SIGN_CLIENT_OPTIONS;
     delete options.metadata;
-
-    await expect(
-      SignClient.init({
-        ...options,
-        name: "init",
-        signConfig: { disableRequestQueue: true },
-      }),
-    ).rejects.toThrowError("name is required value in metadata");
-  });
-
-  it("should not initialize with empty metadata", async () => {
-    await expect(
-      SignClient.init({
-        ...TEST_SIGN_CLIENT_OPTIONS,
-        metadata: TEST_EMPTY_METADATA,
-        name: "init",
-        signConfig: { disableRequestQueue: true },
-      }),
-    ).rejects.toThrowError("name is required value in metadata");
+    const client = await SignClient.init({
+      ...options,
+      name: "init",
+      signConfig: { disableRequestQueue: true },
+    });
+    expect(client).to.be.exist;
+    await deleteClients({ A: client, B: undefined });
   });
 
-  it("should not initialize with invalid metadata", async () => {
-    await expect(
-      SignClient.init({
-        ...TEST_SIGN_CLIENT_OPTIONS,
-        metadata: TEST_INVALID_METADATA,
-        name: "init",
-        signConfig: { disableRequestQueue: true },
-      }),
-    ).rejects.toThrowError("description is required value in metadata");
-  });
-  it("should not initialize with invalid metadata url", async () => {
-    await expect(
-      SignClient.init({
-        ...TEST_SIGN_CLIENT_OPTIONS,
-        metadata: {
-          ...TEST_INVALID_METADATA,
-          description: "description",
-        },
-        name: "init",
-        signConfig: { disableRequestQueue: true },
-      }),
-    ).rejects.toThrowError("url is required value in metadata");
+  it("should initialize with empty metadata", async () => {
+    const client = await SignClient.init({
+      ...TEST_SIGN_CLIENT_OPTIONS,
+      metadata: TEST_EMPTY_METADATA,
+      name: "init",
+      signConfig: { disableRequestQueue: true },
+    });
+    expect(client).to.be.exist;
+    await deleteClients({ A: client, B: undefined });
   });
 
   describe("connect", () => {

diff --git a/providers/ethereum-provider/src/EthereumProvider.ts b/providers/ethereum-provider/src/EthereumProvider.ts
@@ -560,17 +560,12 @@ export class EthereumProvider implements IEthereumProvider {
   protected async initialize(opts: EthereumProviderOptions) {
     this.rpc = this.getRpcConfig(opts);
 
-    const metadata = this.rpc.metadata;
-    if (metadata === undefined) {
-      throw new Error("Metadata field is required");
-    }
-
     this.chainId = this.rpc.chains.length
       ? getEthereumChainId(this.rpc.chains)
       : getEthereumChainId(this.rpc.optionalChains);
     this.signer = await UniversalProvider.init({
       projectId: this.rpc.projectId,
-      metadata,
+      metadata: this.rpc.metadata,
       disableProviderPing: opts.disableProviderPing,
       relayUrl: opts.relayUrl,
       storageOptions: opts.storageOptions,

diff --git a/providers/universal-provider/src/types/misc.ts b/providers/universal-provider/src/types/misc.ts
@@ -8,7 +8,7 @@ import { IProvider } from "./providers";
 
 export interface UniversalProviderOpts {
   projectId?: string;
-  metadata: Metadata;
+  metadata?: Metadata;
   logger?: string | Logger;
   client?: SignClient;
   relayUrl?: string;