clean up config, add validation, add more readme

README.md

@@ -37,6 +37,22 @@ For running a local instance use the command:
 yarn start
 ```
 
+The codebase is configured to be run against the Geth <> Substrate node that can be set up by following th guide (here)[https://chainbridge.chainsafe.io/local/].
+
+All substrate specific configuration should be adjusted in `/src/Adaptors/SubstrateAdaptor.tsx`. The substrate adaptor's functionality is divided into 2 portions. Should the Substrate chain not implement things using the exact same pallet and method names, the Substrate adaptor will need to be updated to ensure correct operation.
+
+First, update the `src/bridgeTypes.json` file with the desired Substrate Chain configuration.
+
+- Home Chain
+
+  - Get relayer threshold from Chainbridge pallet
+  - Confirming current chainId from Chainbridge pallet
+  - Retrieving user token balance
+  - Handle deposit call `example.transferNative` and listening for emitted deposit nonce `chainbridge.chainNonces`
+
+- Destination Chain
+  - Subscribe to all `system.events`, parse these and filter all events with `event.section=chainbridge` and `event.method = VoteFor` or `event.method = ProposalApproved` and fire the correct actions against the reducer.
+
 ### Build
 
 Update the configs for the bridge in `src/chainbridgeContext.ts`. There should be at least 2 chains configured for correct functioning of the bridge. Each chain accepts the following configuration parameters:

src/App.tsx

@@ -29,16 +29,18 @@ if (
 }
 
 const App: React.FC<{}> = () => {
-  const tokens = chainbridgeConfig.chains.reduce((tca, bc) => {
-    if (bc.networkId) {
-      return {
-        ...tca,
-        [bc.networkId]: bc.tokens,
-      };
-    } else {
-      return tca;
-    }
-  }, {});
+  const tokens = chainbridgeConfig.chains
+    .filter((c) => c.type === "Ethereum")
+    .reduce((tca, bc) => {
+      if (bc.networkId) {
+        return {
+          ...tca,
+          [bc.networkId]: bc.tokens,
+        };
+      } else {
+        return tca;
+      }
+    }, {});
 
   return (
     <ErrorBoundary

src/Components/Pages/TransferPage.tsx

@@ -21,6 +21,7 @@ import { utils } from "ethers";
 import FeesFormikWrapped from "./FormikContextElements/Fees";
 import { useNetworkManager } from "../../Contexts/NetworkManagerContext";
 import NetworkUnsupportedModal from "../../Modules/NetworkUnsupportedModal";
+import { isValidSubstrateAddress } from "../../Utils/Helpers";
 
 const useStyles = makeStyles(({ constants, palette }: ITheme) =>
   createStyles({
@@ -274,8 +275,7 @@ const TransferPage = () => {
     receiver: string()
       .test("Valid address", "Please add a valid address", (value) => {
         if (destinationChainConfig?.type === "Substrate") {
-          // TODO: Figure out how to validate Substrate addresses
-          return true;
+          return isValidSubstrateAddress(value as string);
         }
         return utils.isAddress(value as string);
       })

src/Contexts/Adaptors/SubstrateAdaptors.tsx

@@ -111,6 +111,7 @@ export const SubstrateHomeAdaptorProvider = ({
   }, [api, api?.isConnected, getRelayerThreshold, confirmChainID]);
 
   useEffect(() => {
+    if (!homeChainConfig) return;
     let unsubscribe: VoidFn | undefined;
     if (api) {
       api.query.system
@@ -119,12 +120,14 @@ export const SubstrateHomeAdaptorProvider = ({
             data: { free: balance },
           } = result.toJSON() as any;
           setTokens({
-            CSS: {
-              balance: parseInt(utils.formatUnits(balance, 15)),
-              balanceBN: new BN(balance),
-              decimals: 15,
-              name: "Chainbridge",
-              symbol: "CSS",
+            [homeChainConfig.tokens[0].symbol || "TOKEN"]: {
+              decimals: homeChainConfig.decimals,
+              balance: parseInt(
+                utils.formatUnits(balance, homeChainConfig.decimals)
+              ),
+              balanceBN: new BN(balance).shiftedBy(-homeChainConfig.decimals),
+              name: homeChainConfig.tokens[0].name,
+              symbol: homeChainConfig.tokens[0].symbol,
             },
           });
         })
@@ -136,7 +139,7 @@ export const SubstrateHomeAdaptorProvider = ({
     return () => {
       unsubscribe && unsubscribe();
     };
-  }, [api, address]);
+  }, [api, address, homeChainConfig]);
 
   const handleConnect = useCallback(async () => {
     // Requests permission to inject the wallet
@@ -283,7 +286,6 @@ export const SubstrateHomeAdaptorProvider = ({
 export const SubstrateDestinationAdaptorProvider = ({
   children,
 }: IDestinationBridgeProviderProps) => {
-  // Comment out everything till the return statement for evm transfers to work
   const {
     depositNonce,
     destinationChainConfig,
@@ -298,7 +300,8 @@ export const SubstrateDestinationAdaptorProvider = ({
 
   const [initiaising, setInitialising] = useState(false);
   useEffect(() => {
-    // Once the chain ID has been set in the network context, the destination configuration will be automatically set thus triggering this
+    // Once the chain ID has been set in the network context, the destination configuration will be automatically
+    // set thus triggering this
     if (!destinationChainConfig || initiaising || api) return;
     setInitialising(true);
     const provider = new WsProvider(destinationChainConfig.rpcUrl);

src/Utils/Helpers.tsx

@@ -1,3 +1,16 @@
+const { decodeAddress, encodeAddress } = require("@polkadot/keyring");
+const { hexToU8a, isHex } = require("@polkadot/util");
+
 export const shortenAddress = (address: string) => {
   return `${address.substr(0, 6)}...${address.substr(address.length - 6, 6)}`;
 };
+
+export const isValidSubstrateAddress = (address: string) => {
+  try {
+    encodeAddress(isHex(address) ? hexToU8a(address) : decodeAddress(address));
+
+    return true;
+  } catch (error) {
+    return false;
+  }
+};

src/chainbridgeConfig.ts

@@ -34,71 +34,8 @@ export type ChainbridgeConfig = {
 };
 
 export const chainbridgeConfig: ChainbridgeConfig = {
-  // Goerli - Kotti Bridge
+  // Local GETH <> Local Substrate
   chains: [
-    // {
-    //   chainId: 1,
-    //   networkId: 5,
-    //   name: "Ethereum - Goerli",
-    //   decimals: 18,
-    //   bridgeAddress: "0x2524d71D163f60747630c4EBeB077a9832329646",
-    //   erc20HandlerAddress: "0xDc26320258ADfd806d125223Fb0F94e54D13FA51",
-    //   rpcUrl: "https://goerli.prylabs.net",
-    //   type: "Ethereum",
-    //   blockExplorer: "https://goerli.etherscan.io/tx",
-    //   nativeTokenSymbol: "ETH",
-    //   deployedBlockNumber: 3554182,
-    //   tokens: [
-    //     {
-    //       address: "0x735B895bCb37cBba5812154f4F34480EcE1B672C",
-    //       name: "Wrapped ETC",
-    //       symbol: "wETC",
-    //       imageUri: WETHIcon,
-    //       resourceId:
-    //         "0x000000000000000000000023A9FD05ef0c5fb9dDE964C4d4191A169Fd221f802",
-    //     },
-    //     {
-    //       address: "0x14dD060dB55c0E7cc072BD3ab4709d55583119c0",
-    //       name: "An ERC20",
-    //       symbol: "ERC20",
-    //       imageUri: ETHIcon,
-    //       resourceId:
-    //         "0x000000000000000000000014dD060dB55c0E7cc072BD3ab4709d55583119c001",
-    //     },
-    //   ],
-    // },
-    // {
-    //   chainId: 2,
-    //   networkId: 6,
-    //   name: "Ethereum Classic - Kotti",
-    //   decimals: 18,
-    //   bridgeAddress: "0x2524d71D163f60747630c4EBeB077a9832329646",
-    //   erc20HandlerAddress: "0xDc26320258ADfd806d125223Fb0F94e54D13FA51",
-    //   rpcUrl: "https://www.ethercluster.com/kotti",
-    //   type: "Ethereum",
-    //   blockExplorer: "https://blockscout.com/etc/kotti/tx",
-    //   nativeTokenSymbol: "ETC",
-    //   deployedBlockNumber: 0,
-    //   tokens: [
-    //     {
-    //       address: "0x23A9FD05ef0c5fb9dDE964C4d4191A169Fd221f8",
-    //       name: "Wrapped ETC",
-    //       symbol: "wETC",
-    //       imageUri: WETHIcon,
-    //       resourceId:
-    //         "0x000000000000000000000023A9FD05ef0c5fb9dDE964C4d4191A169Fd221f802",
-    //       isNativeWrappedToken: true,
-    //     },
-    //     {
-    //       address: "0x14dD060dB55c0E7cc072BD3ab4709d55583119c0",
-    //       name: "An ERC20",
-    //       symbol: "ERC20",
-    //       imageUri: ETHIcon,
-    //       resourceId:
-    //         "0x000000000000000000000014dD060dB55c0E7cc072BD3ab4709d55583119c001",
-    //     },
-    //   ],
-    // },
     {
       chainId: 0,
       networkId: 5,
@@ -110,14 +47,6 @@ export const chainbridgeConfig: ChainbridgeConfig = {
       type: "Ethereum",
       nativeTokenSymbol: "ETH",
       tokens: [
-        // {
-        //   address: "0x735B895bCb37cBba5812154f4F34480EcE1B672C",
-        //   name: "Wrapped ETC",
-        //   symbol: "wETC",
-        //   imageUri: WETHIcon,
-        //   resourceId:
-        //     "0x000000000000000000000023A9FD05ef0c5fb9dDE964C4d4191A169Fd221f802",
-        // },
         {
           address: "0x21605f71845f372A9ed84253d2D024B7B10999f4",
           name: "TOKEN",
@@ -131,60 +60,21 @@ export const chainbridgeConfig: ChainbridgeConfig = {
     {
       chainId: 1,
       name: "Substrate - Local",
-      decimals: 18,
+      decimals: 15,
       bridgeAddress: "0x2524d71D163f60747630c4EBeB077a9832329646",
       erc20HandlerAddress: "0xDc26320258ADfd806d125223Fb0F94e54D13FA51",
       rpcUrl: "ws://localhost:9944",
-      // rpcUrl: "wss://dev-node.substrate.dev:9944",
-      // const WS_PROVIDER = 'wss://dev-node.substrate.dev:9944';
-      // const WS_PROVIDER = 'wss://kusama-rpc.polkadot.io';
-      // const WS_PROVIDER = 'wss://westend-rpc.polkadot.io';
       type: "Substrate",
       nativeTokenSymbol: "DOT",
       deployedBlockNumber: 0,
       tokens: [
-        // TODO: get token data
+        {
+          address: "substrate-native",
+          name: "TOKEN",
+          symbol: "TOKEN",
+          resourceId: "substrate-native",
+        },
       ],
     },
   ],
-
-  // DEVNET
-  //   erc20ResourceId:
-  //   "0x00000000000000000000000021605f71845f372A9ed84253d2D024B7B10999f4",
-  // chains: [
-  // {
-  //   chainId: 1,
-  //   networkId: 5,
-  //   name: "Ethereum - A",
-  //   bridgeAddress: "0x62877dDCd49aD22f5eDfc6ac108e9a4b5D2bD88B",
-  //   erc20HandlerAddress: "0x3167776db165D8eA0f51790CA2bbf44Db5105ADF",
-  //   rpcUrl: "http://localhost:8545",
-  //   type: "Ethereum",
-  //   tokens: [
-  //     {
-  //       address: "0x21605f71845f372A9ed84253d2D024B7B10999f4",
-  //       name: "Test EthA",
-  //       symbol: "TESTA",
-  //       imageUri: ETHIcon,
-  //     },
-  //   ],
-  // },
-  // {
-  //   chainId: 2,
-  //   networkId: 6,
-  //   name: "Ethereum - B",
-  //   bridgeAddress: "0x62877dDCd49aD22f5eDfc6ac108e9a4b5D2bD88B",
-  //   erc20HandlerAddress: "0x3167776db165D8eA0f51790CA2bbf44Db5105ADF",
-  //   rpcUrl: "http://localhost:8546",
-  //   type: "Ethereum",
-  //   tokens: [
-  //     {
-  //       address: "0x21605f71845f372A9ed84253d2D024B7B10999f4",
-  //       name: "Test EthB",
-  //       symbol: "TESTB",
-  //       imageUri: ETHIcon,
-  //     },
-  //   ],
-  // },
-  // ]
 };