feat: add a function to retrieve current network information (#14)

Author: jinoosss

README.md

@@ -136,6 +136,18 @@ adenaSDK.getAccount().then((account) => {
 });
 ```
 
+### `getNetwork`
+
+Retrieves network information from the connected wallet.
+
+**Example:**
+
+```
+adenaSDK.getNetwork().then((network) => {
+  console.log('Network:', network);
+});
+```
+
 ### `switchNetwork`
 
 Switches the wallet to a different network.

packages/sdk/src/core/__mocks__/mock-wallet-provider.ts

@@ -17,6 +17,7 @@ export const mockWalletProvider: jest.Mocked<WalletProvider> = {
   isConnected: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.CONNECTION_SUCCESS)),
   addEstablish: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.CONNECTION_SUCCESS)),
   getAccount: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.GET_ACCOUNT_SUCCESS)),
+  getNetwork: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.GET_NETWORK_SUCCESS)),
   switchNetwork: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.SWITCH_NETWORK_SUCCESS)),
   addNetwork: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.ADD_NETWORK_SUCCESS)),
   signTransaction: jest.fn().mockResolvedValue(makeResponseMessage(WalletResponseSuccessType.SIGN_SUCCESS)),
@@ -41,6 +42,8 @@ export const addEstablishRejectMock = makeResponseMessage(WalletResponseRejectTy
 
 export const getAccountSuccessMock = makeResponseMessage(WalletResponseSuccessType.GET_ACCOUNT_SUCCESS);
 
+export const getNetworkSuccessMock = makeResponseMessage(WalletResponseSuccessType.GET_NETWORK_SUCCESS);
+
 export const switchNetworkSuccessMock = makeResponseMessage(WalletResponseSuccessType.SWITCH_NETWORK_SUCCESS);
 
 export const addNetworkSuccessMock = makeResponseMessage<void>(WalletResponseSuccessType.ADD_NETWORK_SUCCESS);

packages/sdk/src/core/__tests__/methods/get-network.test.ts

@@ -0,0 +1,35 @@
+import { mockWalletProvider } from '../../__mocks__/mock-wallet-provider';
+import { getNetwork } from '../../methods';
+import { WalletResponseSuccessType } from '../../types';
+import { GetNetworkResponse } from '../../types/methods';
+import { makeResponseMessage } from '../../utils';
+
+describe('getNetwork', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should call getNetwork and return the response', async () => {
+    const mockResponse: GetNetworkResponse = makeResponseMessage(WalletResponseSuccessType.GET_NETWORK_SUCCESS, {
+      chainId: 'chainId',
+      networkName: 'networkName',
+      addressPrefix: 'g',
+      rpcUrl: 'rpcUrl',
+      indexerUrl: null,
+    });
+
+    mockWalletProvider.getNetwork.mockResolvedValue(mockResponse);
+
+    const response = await getNetwork(mockWalletProvider);
+
+    expect(mockWalletProvider.getNetwork).toHaveBeenCalled();
+    expect(response).toEqual(mockResponse);
+  });
+
+  it('should handle errors when getNetwork fails', async () => {
+    const mockError = new Error('Failed to get network');
+    mockWalletProvider.getNetwork.mockRejectedValue(mockError);
+
+    await expect(getNetwork(mockWalletProvider)).rejects.toThrow('Failed to get network');
+  });
+});

packages/sdk/src/core/methods/get-network.ts

@@ -0,0 +1,6 @@
+import { WalletProvider } from '../providers';
+import { GetNetworkResponse } from '../types/methods';
+
+export const getNetwork = (walletProvider: WalletProvider): Promise<GetNetworkResponse> => {
+  return walletProvider.getNetwork();
+};

packages/sdk/src/core/methods/index.ts

@@ -5,6 +5,7 @@ export * from './connect';
 export * from './disconnect';
 export * from './get-account';
 export * from './get-connection-state';
+export * from './get-network';
 export * from './is-connected';
 export * from './off-connection-change';
 export * from './on-change-account';

packages/sdk/src/core/providers/wallet.ts

@@ -6,6 +6,7 @@ import {
   BroadcastTransactionOptions,
   BroadcastTransactionResponse,
   GetAccountResponse,
+  GetNetworkResponse,
   IsConnectedResponse,
   OnChangeAccountOptions,
   OnChangeAccountResponse,
@@ -34,6 +35,13 @@ export interface WalletProvider {
    */
   getAccount: () => Promise<GetAccountResponse>;
 
+  /**
+   * Fetch information about the current connected network
+   * @async
+   * @returns Original Adena response with the network information
+   */
+  getNetwork: () => Promise<GetNetworkResponse>;
+
   /**
    * Switches the Adena network to the given chain ID
    * @async

packages/sdk/src/core/types/index.ts

@@ -1,4 +1,5 @@
 export * from './account.types';
 export * from './config.types';
+export * from './network.types';
 export * from './transaction.types';
 export * from './wallet.types';

packages/sdk/src/core/types/methods/get-network.types.ts

@@ -0,0 +1,4 @@
+import { NetworkInfo } from '../network.types';
+import { WalletResponse } from '../wallet.types';
+
+export type GetNetworkResponse = WalletResponse<NetworkInfo>;

packages/sdk/src/core/types/methods/index.ts

@@ -4,6 +4,7 @@ export * from './broadcast-transaction.types';
 export * from './connect.types';
 export * from './disconnect.types';
 export * from './get-account.types';
+export * from './get-network.types';
 export * from './is-connected.types';
 export * from './off-connection-change';
 export * from './on-change-account.types';

packages/sdk/src/core/types/network.types.ts

@@ -0,0 +1,7 @@
+export type NetworkInfo = {
+  chainId: string;
+  networkName: string;
+  addressPrefix: string;
+  rpcUrl: string;
+  indexerUrl: string | null;
+};