adding cheqd connection fallback (#454)

Author: maycon-mello

integration-tests/cheqd-blockchain.test.ts

@@ -0,0 +1,40 @@
+import {
+    closeWallet,
+    getWallet,
+  } from './helpers';
+import { blockchainService } from '@docknetwork/wallet-sdk-wasm/src/services/blockchain';
+import { BLOCKCHAIN_NETWORKS } from '@docknetwork/wallet-sdk-wasm/src/modules/network-manager';
+
+describe('Test cheqd blockchain connection', () => {
+  beforeEach(() => getWallet());
+
+  it('should use fallback blockchain network if the first one is not working', async () => {
+    const result = await blockchainService.init({
+      cheqdApiUrl: [
+        'https://some-invalid-network.local',
+        ...BLOCKCHAIN_NETWORKS.mainnet.cheqdApiUrl,
+      ],
+      networkId: 'mainnet',
+    })
+    expect(result).toBe(true);
+  });
+
+  it('should be able to connect to cheqd mainnet', async () => {
+    const result = await blockchainService.init({
+      cheqdApiUrl: BLOCKCHAIN_NETWORKS.mainnet.cheqdApiUrl,
+      networkId: 'mainnet',
+    })
+    expect(result).toBe(true);
+  });
+
+  it('should be able to connect to cheqd testnet', async () => {
+    const result = await blockchainService.init({
+      cheqdApiUrl: BLOCKCHAIN_NETWORKS.testnet.cheqdApiUrl,
+      networkId: 'testnet',
+    })
+    expect(result).toBe(true);
+  });
+
+  afterAll(() => closeWallet());
+});
+  

integration-tests/custom-networks.test.ts

@@ -12,7 +12,6 @@ describe('Custom networks', () => {
       credentialHostnames: ['creds.polygon.com'],
       id: 'polygon',
       configs: {
-        addressPrefix: 21,
         cheqdApiUrl: 'https://testnet.cheqd.docknode.io/',
       },
     },
@@ -21,7 +20,6 @@ describe('Custom networks', () => {
       credentialHostnames: ['creds.mumbai.polygon.com'],
       id: 'mumbai',
       configs: {
-        addressPrefix: 21,
         cheqdApiUrl: 'https://testnet.cheqd.docknode.io/',
       },
     },

packages/core/src/wallet-wasm.ts

@@ -5,20 +5,20 @@ import { captureException } from './helpers';
 import { IWallet, WalletEvents } from './types';
 
 function isBlockchainNetwork(network: Network) {
-  return !!(network.configs.substrateUrl || network.configs.cheqdApiUrl);
+  return !!(network.configs.cheqdApiUrl);
 }
 
 /**
- * Update existing substrate network connection
- * Compare connected substrate connection with the current walle network
+ * Update existing blockchain network connection
+ * Compare connected blockchain connection with the current walle network
  * Disconnect and Establish a new connection if the network is different
  */
 export async function handleBlockchainNetworkChange(
   wallet: IWallet,
 ): Promise<void> {
   const currentAddress = await blockchainService.getAddress();
   const networkId = wallet.dataStore.networks.find(
-    network => network.configs.substrateUrl === currentAddress || network.configs.cheqdApiUrl === currentAddress,
+    network => network.configs.cheqdApiUrl === currentAddress,
   )?.id;
   const currentNetworkId = wallet.dataStore.network?.id;
 
@@ -60,7 +60,6 @@ export async function setBlockchainNetwork(wallet: IWallet) {
 
     blockchainService
       .init({
-        substrateUrl: networkConfigs.substrateUrl,
         cheqdApiUrl: networkConfigs.cheqdApiUrl,
         networkId: network.id,
         cheqdMnemonic: cheqdMnemonicDoc.value,

packages/data-store/src/configs.ts

@@ -1,4 +1,4 @@
-import {SUBSTRATE_NETWORKS} from '@docknetwork/wallet-sdk-wasm/src/modules/network-manager';
+import {BLOCKCHAIN_NETWORKS} from '@docknetwork/wallet-sdk-wasm/src/modules/network-manager';
 import {DataStoreConfigs} from './types';
 import {genericDocumentNetworkResolver} from './document-network-resolver';
 
@@ -11,13 +11,13 @@ export const DEFAULT_CONFIGS: DataStoreConfigs = {
       name: 'Mainnet',
       id: 'mainnet',
       credentialHostnames: [/creds\..*\.io/],
-      configs: SUBSTRATE_NETWORKS.mainnet,
+      configs: BLOCKCHAIN_NETWORKS.mainnet,
     },
     {
       name: 'Testnet',
       id: 'testnet',
       credentialHostnames: [/creds-.*\.*\.io/],
-      configs: SUBSTRATE_NETWORKS.testnet,
+      configs: BLOCKCHAIN_NETWORKS.testnet,
     },
   ],
 };

packages/wasm/src/modules/network-manager.ts

@@ -3,35 +3,36 @@ import assert from 'assert';
 
 export type NetworkInfo = {
   name: string,
-  substrateUrl: string | string[],
-  addressPrefix: number,
-  cheqdApiUrl: string,
+  cheqdApiUrl: string | string[],
 };
 
 export type NetworkId = 'mainnet' | 'testnet' | 'local' | 'custom';
 
-export const SUBSTRATE_NETWORKS : Record<NetworkId, NetworkInfo> = {
+export const BLOCKCHAIN_NETWORKS : Record<NetworkId, NetworkInfo> = {
   mainnet: {
     name: 'Cheqd Mainnet',
-    substrateUrl: null,
-    addressPrefix: 22,
-    cheqdApiUrl: 'https://mainnet.cheqd.docknode.io',
+    cheqdApiUrl: [
+      'https://mainnet.cheqd.docknode.io',
+      'https://rpc.cheqd.net',
+    ],
   },
   testnet: {
     name: 'Cheqd Testnet',
-    substrateUrl: null,
-    addressPrefix: 21,
-    cheqdApiUrl: 'https://testnet.cheqd.docknode.io',
+    cheqdApiUrl: [
+      'https://testnet.cheqd.docknode.io',
+      'https://api.cheqd.network',
+    ],
   },
   local: {
     name: 'Local Node',
-    substrateUrl: 'ws://127.0.0.1:9944',
-    addressPrefix: 21,
+    cheqdApiUrl: [
+      'http://localhost:8080',
+    ],
   },
 };
 
 function getNetworkInfo(networkId): NetworkInfo {
-  const networkInfo = SUBSTRATE_NETWORKS[networkId];
+  const networkInfo = BLOCKCHAIN_NETWORKS[networkId];
 
   assert(!!networkInfo, `Network ${networkId} not found`);
 
@@ -57,7 +58,7 @@ export class NetworkManager {
    * @param {string} networkId
    */
   setNetworkId(networkId: NetworkId) {
-    assert(!!SUBSTRATE_NETWORKS[networkId], `invalid networkId ${networkId}`);
+    assert(!!BLOCKCHAIN_NETWORKS[networkId], `invalid networkId ${networkId}`);
 
     this.networkId = networkId;
   }

packages/wasm/src/services/blockchain/configs.ts

@@ -4,8 +4,7 @@ import assert from 'assert';
 export const validation = {};
 
 export type InitParams = {
-  substrateUrl: string,
-  cheqdApiUrl?: string,
+  cheqdApiUrl?: string | string[],
   networkId?: string,
   cheqdMnemonic?: string,
 };

packages/wasm/src/services/blockchain/service.ts

@@ -231,11 +231,12 @@ export class BlockchainService {
     try {
       await this.cheqdApi.init({
         wallet,
-        url: checkdApiUrl,
+        urls: Array.isArray(checkdApiUrl) ? checkdApiUrl : [checkdApiUrl],
         network: cheqdNetworkId,
       });
       Logger.info(`Cheqd initialized at: ${checkdApiUrl}`);
     } catch (err) {
+      debugger
       Logger.error(`Failed to initialize cheqd at: ${checkdApiUrl}`, err);
     }
 
@@ -314,7 +315,7 @@ export class BlockchainService {
    * @example
    * const apiUrl = await blockchainService.getAddress();
    */
-  async getAddress() {
+  async getAddress(): Promise<string | string[]> {
     return this.cheqdApiUrl;
   }