@mintbase-js/rpc: add rpcUrl mandatory param (#521)

Co-authored-by: Benjamin Smith <bh2smith@users.noreply.github.com> Co-authored-by: mintbaseteam <eng@mintbase.io> Co-authored-by: Till <31419678+tifrel@users.noreply.github.com>
Mintbase · Aug 21, 2024 · f7538bb · f7538bb
1 parent c514a1e
commit f7538bb
Show file tree

Hide file tree

Showing 48 changed files with 2,845 additions and 5,732 deletions.
diff --git a/lerna.json b/lerna.json
@@ -5,4 +5,4 @@
   "packages": [
     "packages/*"
   ]
-}
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -69,13 +69,10 @@
     "eslint-plugin-simple-import-sort": "^5.0.3",
     "fetch-mock": "^9.11.0",
     "graphql": "^16.6.0",
-    "isomorphic-fetch": "^3.0.0",
     "jest": "^29.1.1",
     "jest-environment-jsdom": "^29.1.2",
-    "lerna": "^7.0.0",
+    "lerna": "^8.0.0",
     "lerna-jest": "^0.5.4",
-    "serve": "^14.0.1",
-    "superagent": "^8.0.3",
     "ts-jest": "^29.0.3",
     "typescript": "^4.8.4",
     "@near-wallet-selector/wallet-utils": "^8.9.7"

diff --git a/packages/data/src/api/tokenOwnersByMetadataId/tokenOwnersByMetadataId.mock.ts b/packages/data/src/api/tokenOwnersByMetadataId/tokenOwnersByMetadataId.mock.ts
@@ -15,4 +15,3 @@ export const tokenOwnersByMetadataIdMock = {
     },
   },
 };
-
diff --git a/packages/data/src/api/userMintedTokens/userMintedTokens.test.ts b/packages/data/src/api/userMintedTokens/userMintedTokens.test.ts
@@ -1,5 +1,5 @@
 import { META_SERVICE_HOST_TESTNET } from '../../constants';
-import { OWNED_MINTED_ORDER_BY, ParsedDataReturn, UserTokensFilter, UserTokensQueryResult } from '../../types';
+import { OWNED_MINTED_ORDER_BY, ParsedDataReturn, UserTokensQueryResult } from '../../types';
 import fetchMock from 'fetch-mock';
 import { Network, mbjs } from '@mintbase-js/sdk';
 import { getUserMintedTokens } from '../userMintedTokens/userMintedTokens';

diff --git a/packages/data/src/api/userOwnedTokens/userOwnedTokens.test.ts b/packages/data/src/api/userOwnedTokens/userOwnedTokens.test.ts
@@ -1,5 +1,5 @@
 import { META_SERVICE_HOST_TESTNET } from '../../constants';
-import { OWNED_MINTED_ORDER_BY, ParsedDataReturn, UserTokensFilter, UserTokensQueryResult } from '../../types';
+import { OWNED_MINTED_ORDER_BY, ParsedDataReturn, UserTokensQueryResult } from '../../types';
 
 import fetchMock from 'fetch-mock';
 import { Network, mbjs } from '@mintbase-js/sdk';

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -24,6 +24,7 @@
   },
   "dependencies": {
     "@mintbase-js/wallet": "0.6.1-update-packages-24058ee.0",
+    "@mintbase-js/data": "0.6.1-update-packages-24058ee.0",
     "@near-wallet-selector/core": "8.9.12",
     "@near-wallet-selector/here-wallet": "8.9.12",
     "@near-wallet-selector/meteor-wallet": "8.9.12",
@@ -32,4 +33,4 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   }
-}
+}
diff --git a/packages/react/src/MintbaseWalletContext.test.tsx b/packages/react/src/MintbaseWalletContext.test.tsx
@@ -3,7 +3,7 @@
  */
 // import { invokeContractMethod } from './transactions';
 import React from 'react';
-import { render, screen, act, waitFor } from '@testing-library/react';
+import { act, render, screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { useMbWallet, MintbaseWalletContextProvider } from './MintbaseWalletContext';
 import {

diff --git a/packages/react/src/hooks/methods/nearPrice.ts b/packages/react/src/hooks/methods/nearPrice.ts
diff --git a/packages/react/src/hooks/methods/nearPrice.types.ts b/packages/react/src/hooks/methods/nearPrice.types.ts
diff --git a/packages/react/src/hooks/useNearPrice.ts b/packages/react/src/hooks/useNearPrice.ts
@@ -1,5 +1,5 @@
 import { useEffect, useState } from 'react';
-import { nearPrice } from './methods/nearPrice';
+import { nearPrice } from '@mintbase-js/data';
 
 type UseNearPriceReturn = {
   nearPrice: number;

diff --git a/packages/rpc/README.md b/packages/rpc/README.md
@@ -11,31 +11,30 @@ This module provides a wrapper around common RPC calls used to fetch on-chain da
 
 ## Available Modules & Methods
 
-`type Network: 'testnet' | 'mainnet'`
+We now accepts rpcUrl on each method, so you can pass your own RPC regarding one of those on the list:
+https://docs.near.org/api/rpc/providers
 
-### `getBalance(account: string, network?: Network, rpc?: RPC_OPTIONS): BN`
+
+### `getBalance({account: string, rpcUrl: string}): BN`
 
 Fetches the balance of a NEAR account (in yocto) by address.
 
-### `getBlockHeight(network?: Network,  rpc?: RPC_OPTIONS): number`
+### `getBlockHeight({rpcUrl: string}): number`
 
 Returns the current block height for the configured network.
 
-### `getTxnStatus(txnHash: string, senderId: string,network?: Network,  rpc?: RPC_OPTIONS): TxnStatus`
+### `getTxnStatus({txnHash: string, senderId: string,rpcUrl: string}): TxnStatus`
 
 For a transaction hash, determine the status of a transaction on the configured network: `pending`, `success`, or `failure`
 
-### `payouts({ contractId, tokenId, network, rpc }): Promise<UiPayout>`
+### `payouts({ contractId, tokenId, rpcUrl }): Promise<UiPayout>`
 
 Calls a token contract in order to determine the percentage amounts paid out to royalty accounts.
 
-### `getAccessKeys(accountId: string, network?: Network,  rpc?: RPC_OPTIONS): Promise<AccessKey>`
+### `getAccessKeys({accountId: string,rpcUrl: string}): Promise<AccessKey>`
 
 Gets all access keys (public key and permissions object) for a given account.
 
-## Configuration
-
-Before calling these methods the near network should be configured using the [config SDK method](https://docs.mintbase.io/dev/mintbase-sdk-ref/sdk/config)
 
 ## Future
 

diff --git a/packages/rpc/package.json b/packages/rpc/package.json
@@ -20,7 +20,6 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@mintbase-js/sdk": "0.5.6-rpc-fix-1aec566.0",
     "@types/node": "18.11.9",
     "bn.js": "^5.2.1",
     "cross-fetch": "^4.0.0"

diff --git a/packages/rpc/src/index.ts b/packages/rpc/src/index.ts
@@ -11,3 +11,4 @@ export * from './methods/keys';
 export * from './methods/ftBalance';
 export * from './methods/ftStorageBalance';
 export * from './methods/ftMetadata';
+export * from './util';
diff --git a/packages/rpc/src/methods/account.test.ts b/packages/rpc/src/methods/account.test.ts
@@ -14,7 +14,7 @@ describe('accountExists', () => {
     });
 
     expect(
-      await accountExists('benipsen.near'),
+      await accountExists({accountId: 'root.near', rpcUrl: 'rpc'}),
     ).toBe(true);
   });
 
@@ -26,7 +26,7 @@ describe('accountExists', () => {
     });
 
     expect(
-      await accountExists('notreal.near'),
+      await accountExists({accountId: 'xyz&&&.near', rpcUrl: 'rpc'}),
     ).toBe(false);
   });
 });
diff --git a/packages/rpc/src/methods/account.ts b/packages/rpc/src/methods/account.ts
@@ -1,19 +1,18 @@
-import { Network } from '@mintbase-js/sdk';
-import { RPC_OPTIONS, requestFromNearRpc } from '../util';
+import { AccountParams } from '../types';
+import { callNearRpc } from '../util';
 
-export const accountExists = async (accountId: string, network?: Network, rpc?: RPC_OPTIONS): Promise<boolean> => {
-  const response = await requestFromNearRpc({
-    jsonrpc: '2.0',
-    id: 'dontcare',
-    method: 'query',
+export const accountExists = async ({accountId, rpcUrl}: AccountParams): Promise<boolean> => {
+
+  const res = await callNearRpc({
     params: {
       request_type: 'view_account',
       finality: 'final',
       account_id: accountId,
     },
-  }, network, rpc);
+    method: 'query',
+    rpcUrl})
 
-  if (response?.error) {
+  if (res?.error) {
     return false;
   }
   return true;

diff --git a/packages/rpc/src/methods/balance.test.ts b/packages/rpc/src/methods/balance.test.ts
@@ -14,7 +14,7 @@ describe('getBalance', () => {
       }),
     });
 
-    const b = await getBalance('foo.near');
+    const b = await getBalance({accountId:'foo.near', rpcUrl:'rpcUrl'});
     expect(b instanceof BN).toBe(true);
     expect(b.eq(new BN(123))).toBe(true);
   });

diff --git a/packages/rpc/src/methods/balance.ts b/packages/rpc/src/methods/balance.ts
@@ -1,21 +1,23 @@
 import BN from 'bn.js';
-import { RPC_OPTIONS, requestFromNearRpc } from '../util';
-import { Network } from '@mintbase-js/sdk';
+import { callNearRpc,  } from '../util';
+import { AccountParams } from '../types';
 
-export const getBalance = async (accountId: string, network?: Network, rpc?: RPC_OPTIONS): Promise<BN> => {
-  const res = await requestFromNearRpc({
-    jsonrpc: '2.0',
-    id: 'dontcare',
-    method: 'query',
+export const getBalance = async ({ accountId, rpcUrl }: AccountParams): Promise<BN> => {
+
+  const res = await callNearRpc({
     params: {
-      request_type: 'view_account',
-      finality: 'final',
-      account_id: accountId,
-    },
-  }, network, rpc);
+    request_type: 'view_account',
+    finality: 'final',
+    account_id: accountId,
+   },
+    method:'query',
+    rpcUrl
+  })
+
   const balanceString = res?.result?.amount as string;
   if (!balanceString) {
     throw new Error(`Malformed response: ${JSON.stringify(res)}`);
   }
   return new BN(balanceString);
 };
+
diff --git a/packages/rpc/src/methods/blockheight.test.ts b/packages/rpc/src/methods/blockheight.test.ts
@@ -15,7 +15,7 @@ describe('getBlockHeight', () => {
       }),
     });
 
-    const h = await getBlockHeight();
+    const h = await getBlockHeight('https://rpc.testnet.near.org');
     expect(typeof h).toBe('number');
     expect(h > 0).toBe(true);
   });

diff --git a/packages/rpc/src/methods/blockheight.ts b/packages/rpc/src/methods/blockheight.ts
@@ -1,13 +1,12 @@
-import { Network } from '@mintbase-js/sdk';
-import { RPC_OPTIONS, requestFromNearRpc } from '../util';
+import { callNearRpc } from '../util';
 
-export const getBlockHeight = async (network?: Network,  rpc?: RPC_OPTIONS): Promise<number> => {
-  const res = await requestFromNearRpc({
-    jsonrpc: '2.0',
-    id: 'dontcare',
-    method: 'status',
+export const getBlockHeight = async (rpcUrl: string): Promise<number> => {
+
+  const res = await callNearRpc({
     params: [],
-  }, network, rpc);
+    method: 'status',
+    rpcUrl})
+
   const blockHeight = (res?.result?.sync_info as {latest_block_height: number})?.latest_block_height;
   if (!blockHeight) {
     throw new Error(`Malformed response: ${JSON.stringify(res)}`);

diff --git a/packages/rpc/src/methods/ftBalance.ts b/packages/rpc/src/methods/ftBalance.ts
@@ -1,19 +1,11 @@
-import { Network } from '@mintbase-js/sdk';
-import { RPC_OPTIONS, callViewMethod } from '../util';
+import { FTParams } from '../types';
+import { callViewMethod } from '../util';
 
-interface FTBalanceProps {
-  contractId: string;
-  accountId: string;
-  network?: Network;
-  rpc?: RPC_OPTIONS;
-}
-
-export const ftBalance = async ({ contractId, accountId, network, rpc }: FTBalanceProps): Promise<string> => {
+export const ftBalance = async ({ contractId, accountId, rpcUrl }: FTParams): Promise<string> => {
   return callViewMethod<string>({
     contractId,
     method: 'ft_balance_of',
     args: { account_id: accountId },
-    network: network,
-    rpc,
+    rpcUrl,
   });
 };
diff --git a/packages/rpc/src/methods/ftMetadata.ts b/packages/rpc/src/methods/ftMetadata.ts
@@ -1,5 +1,4 @@
-import { Network } from '@mintbase-js/sdk';
-import { RPC_OPTIONS, callViewMethod } from '../util';
+import { callViewMethod } from '../util';
 
 export type FtMetadata = {
   spec: string;
@@ -14,8 +13,7 @@ export type FtMetadata = {
 
 interface FtMetadataProps {
   contractId: string;
-  network?: Network;
-  rpc?: RPC_OPTIONS;
+  rpcUrl?: string
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -52,12 +50,11 @@ function isStringOrNull(x: any): x is string | null {
   return false;
 }
 
-export const ftMetadata = async ({ contractId, network, rpc }: FtMetadataProps): Promise<FtMetadata | null> => {
+export const ftMetadata = async ({ contractId, rpcUrl }: FtMetadataProps): Promise<FtMetadata | null> => {
   const res = callViewMethod<FtMetadata>({
     contractId,
     method: 'ft_metadata',
-    network: network,
-    rpc: rpc,
+    rpcUrl,
   });
 
   return isFtMetadata(res) ? res : null;

diff --git a/packages/rpc/src/methods/ftStorageBalance.ts b/packages/rpc/src/methods/ftStorageBalance.ts
@@ -1,20 +1,12 @@
-import { Network } from '@mintbase-js/sdk';
-import { RPC_OPTIONS, callViewMethod } from '../util';
+import { FTParams } from '../types';
+import { callViewMethod } from '../util';
 
-interface FTStorageProps {
-  contractId: string;
-  accountId: string;
-  network?: Network;
-  rpc?: RPC_OPTIONS;
-}
-
-export const ftStorageBalance = async ({ contractId, accountId, network, rpc }: FTStorageProps): Promise<string | null> => {
+export const ftStorageBalance = async ({ contractId, accountId,  rpcUrl }: FTParams): Promise<string | null> => {
   const balance = await callViewMethod<{ total: string; available: string } | null>({
     contractId,
     method: 'storage_balance_of',
     args: { account_id: accountId },
-    network: network,
-    rpc: rpc,
+    rpcUrl,
   });
 
   return balance?.total || null;

diff --git a/packages/rpc/src/methods/getBlockHash.ts b/packages/rpc/src/methods/getBlockHash.ts
@@ -1,16 +1,17 @@
-import { Network } from '@mintbase-js/sdk';
-import { RPC_OPTIONS, requestFromNearRpc } from '../util';
+import { callNearRpc } from '../util';
 
-export const getBlockHash = async (network?: Network,  rpc?: RPC_OPTIONS): Promise<string> => {
-  const res = await requestFromNearRpc({
-    jsonrpc: '2.0',
-    id: 'dontcare',
+export const getBlockHash = async (rpcUrl: string): Promise<string> => {
+  const res = await callNearRpc({
     method: 'status',
     params: [],
-  }, network, rpc);
+    rpcUrl
+  }, );
+
   const blockHash = (res?.result?.sync_info as {latest_block_hash: string})?.latest_block_hash;
+
   if (!blockHash) {
     throw new Error(`Malformed response: ${JSON.stringify(res)}`);
   }
+
   return blockHash;
 };