refactor: make DefaultInputs type clearer with chain being a required field

Before you could pass to the config just a token in defaultInputs object but everywhere
defaultInputs is referenced chain is required and you can't just pass a token

Author: bradleyplaydon

src/config/ui.ts

@@ -47,11 +47,14 @@ export type Experimental = {
   [Experiment in Experiments]?: boolean;
 };
 
+export interface ChainTokenSelection {
+  chain: Chain;
+  token?: string;
+}
+
 export interface DefaultInputs {
-  fromChain?: Chain;
-  toChain?: Chain;
-  fromToken?: string; // Address or symbol
-  toToken?: string; // Address or symbol
+  from?: ChainTokenSelection;
+  to?: ChainTokenSelection;
   requiredChain?: Chain;
   preferredRouteName?: string;
 }

src/config/utils.ts

@@ -135,72 +135,72 @@ export const validateDefaults = (
   tokens: TokenCache,
 ) => {
   if (!defaults) return;
-  if (defaults.fromChain) {
-    const chain = chains[defaults.fromChain];
+  if (defaults.from?.chain) {
+    const chain = chains[defaults.from.chain];
     if (!chain) {
       error(
-        `Invalid chain name "${defaults.fromChain}" specified for defaultInputs.fromChain`,
+        `Invalid chain name "${defaults.from.chain}" specified for defaultInputs.fromChain`,
       );
-      delete defaults.fromChain;
+      delete defaults.from;
     }
   }
-  if (defaults.toChain) {
-    const chain = chains[defaults.toChain];
+  if (defaults.to?.chain) {
+    const chain = chains[defaults.to.chain];
     if (!chain) {
       error(
-        `Invalid chain name "${defaults.toChain}" specified for defaultInputs.toChain`,
+        `Invalid chain name "${defaults.to.chain}" specified for defaultInputs.toChain`,
       );
-      delete defaults.fromChain;
+      delete defaults.to;
     }
   }
-  if (defaults.fromChain && defaults.toChain) {
-    if (defaults.fromChain === defaults.toChain) {
+  if (defaults.from?.chain && defaults.to?.chain) {
+    if (defaults.from.chain === defaults.to.chain) {
       error(
         `Source and destination chain cannot be the same, check the defaultInputs configuration`,
       );
     }
   }
 
-  if (defaults.fromChain && defaults.toChain && defaults.requiredChain) {
+  if (defaults.from?.chain && defaults.to?.chain && defaults.requiredChain) {
     const requiredConfig = chains[defaults.requiredChain];
     if (!requiredConfig) {
       error(
         `Invalid network value "${defaults.requiredChain}" specified for defaultInputs.requiredChain`,
       );
     }
     if (
-      defaults.toChain !== defaults.requiredChain &&
-      defaults.fromChain !== defaults.requiredChain
+      defaults.to.chain !== defaults.requiredChain &&
+      defaults.from.chain !== defaults.requiredChain
     ) {
       error(
         `Source chain or destination chain must equal the required network`,
       );
     }
   }
 
-  if (defaults.fromChain && defaults.fromToken) {
+  if (defaults.from?.chain && defaults.from?.token) {
     const token = tokens.findByAddressOrSymbol(
-      defaults.fromChain,
-      defaults.fromToken,
+      defaults.from.chain,
+      defaults.from.token,
     );
     if (!token) {
       error(
-        `Invalid token "${defaults.fromToken}" specified for defaultInputs.fromToken`,
+        `Invalid token "${defaults.from?.token}" specified for defaultInputs.fromToken`,
       );
-      delete defaults.fromToken;
+      delete defaults.from.token;
     }
   }
 
-  if (defaults.toChain && defaults.toToken) {
+  if (defaults.to?.chain && defaults.to?.token) {
     const token = tokens.findByAddressOrSymbol(
-      defaults.toChain,
-      defaults.toToken,
+      defaults.to.chain,
+      defaults.to.token,
     );
     if (!token) {
       error(
-        `Invalid token "${defaults.toToken}" specified for defaultInputs.toToken`,
+        `Invalid token "${defaults.to?.token}" specified for defaultInputs.toToken`,
       );
-      delete defaults.toToken;
+      delete defaults.to.token;
     }
   }
 

src/store/transferInput.ts

@@ -51,15 +51,17 @@ export interface TransferInputState {
 
 // This is a function because config might have changed since we last cleared this store
 function getInitialState(): TransferInputState {
-  const { fromChain, toChain, fromToken, toToken } =
-    config.ui.defaultInputs || {};
-
+  const { from, to } = config.ui.defaultInputs || {};
+  const fromChain = from?.chain;
+  const fromToken = from?.token;
+  const toChain = to?.chain;
+  const toToken = to?.token;
   const fromTokenTuple =
-    fromChain && fromToken
+    fromToken && fromChain
       ? config.tokens.findByAddressOrSymbol(fromChain, fromToken)?.tuple
       : undefined;
   const toTokenTuple =
-    toChain && toToken
+    toToken && toChain
       ? config.tokens.findByAddressOrSymbol(toChain, toToken)?.tuple
       : undefined;