PRO-2029 - PrimeSDK Code Refactor (#90)

CHANGELOG.md

@@ -1,4 +1,12 @@
 # Changelog
+## [1.4.0]
+### Breaking Changes
+- Changed the data service to initialise as a seperate entity independent of the primeSdk object
+- Removed unnecessary state variables and changed the walletAddress variable name to EOAAddress for better understanding
+- Optimised the fetching of accountAddress since before it was fetching from on chain for every request to getCounterFactualAddress from the rpc, now it stores the account address locally in the initialised PrimeSDK object
+- Fixed network state variable to output the network which it is connected to
+
+## [1.3.14]
 ### New
 - Added ability to override callDataLimit on estimate step by the user
 

examples/02-transfer-funds.ts

@@ -13,7 +13,7 @@ async function main() {
   // initializating sdk...
   const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key' })
 
-  console.log('address: ', primeSdk.state.walletAddress)
+  console.log('address: ', primeSdk.state.EOAAddress)
 
   // get address of EtherspotWallet...
   const address: string = await primeSdk.getCounterFactualAddress();

examples/03-transfer-erc20.ts

@@ -16,7 +16,7 @@ async function main() {
   // initializating sdk...
   const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key' })
 
-  console.log('address: ', primeSdk.state.walletAddress)
+  console.log('address: ', primeSdk.state.EOAAddress)
 
   // get address of EtherspotWallet...
   const address: string = await primeSdk.getCounterFactualAddress();

examples/04-transfer-nft.ts

@@ -15,7 +15,7 @@ async function main() {
   // initializating sdk...
   const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key' })
 
-  console.log('address: ', primeSdk.state.walletAddress)
+  console.log('address: ', primeSdk.state.EOAAddress)
 
   // get address of EtherspotWallet...
   const address: string = await primeSdk.getCounterFactualAddress();

examples/05-get-account-balances.ts

@@ -1,23 +1,19 @@
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 
 dotenv.config();
 
 async function main() {
-    // initializating sdk...
-    const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-        chainId: Number(process.env.CHAIN_ID),
-        projectKey: 'public-prime-testnet-key', // project key
-    });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
 
-    const balances = await primeSdk.getAccountBalances({
-        account: '', // account address
-        chainId: 1,
-    });
-    console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet balances:`, balances);
+  const balances = await dataService.getAccountBalances({
+    account: '', // address
+    chainId: 1,
+  });
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet balances:`, balances);
 }
 
 main()
   .catch(console.error)
   .finally(() => process.exit());
-

examples/06-transaction.ts

@@ -1,21 +1,17 @@
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 
 dotenv.config();
 
 async function main(): Promise<void> {
-  // initializating sdk...
-  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    projectKey: 'public-prime-testnet-key', // project key
-  });
-  const hash = '0xe6667a1185a6fd93cf082b96f78763514759041940e305da80224609bd1c6781';
-  const transaction = await primeSdk.getTransaction({ hash });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
+  const hash = '0x7f8633f21d0c0c71d248333a0a2b976495015109a270a6f8a51befe3baf6fb6e';
+  const transaction = await dataService.getTransaction({ hash, chainId: 80001 });
 
   console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet transaction:`, transaction);
 }
 
 main()
   .catch(console.error)
   .finally(() => process.exit());
-

examples/08-nft-list.ts

@@ -1,17 +1,14 @@
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 
 dotenv.config();
 
 async function main(): Promise<void> {
-  // initializating sdk...
-  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    projectKey: 'public-prime-testnet-key', // project key
-  });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
   const chainId = 137;
   const account = '';  // account address
-  const nfts = await primeSdk.getNftList({ chainId, account });
+  const nfts = await dataService.getNftList({ chainId, account });
 
   console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet nfts:`, nfts);
 }

examples/09-exchange.ts

@@ -1,24 +1,22 @@
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 import { BigNumber, constants } from 'ethers';
 
 dotenv.config();
 
 async function main(): Promise<void> {
-  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    projectKey: 'public-prime-testnet-key', // project key
-  });
-
-  const exchangeSupportedAssets = await primeSdk.getExchangeSupportedAssets({ page: 1, limit: 100 });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
+  const exchangeSupportedAssets = await dataService.getExchangeSupportedAssets({ page: 1, limit: 100, account: '', chainId: Number(process.env.CHAIN_ID) });
   console.log('\x1b[33m%s\x1b[0m', `Found exchange supported assets:`, exchangeSupportedAssets.items.length);
 
   const fromTokenAddress = '0xe3818504c1b32bf1557b16c238b2e01fd3149c17';
   const toTokenAddress = constants.AddressZero;
   const fromAmount = '1000000000000000000';
   const fromChainId = 1;
 
-  const offers = await primeSdk.getExchangeOffers({
+  const offers = await dataService.getExchangeOffers({
+    fromAddress: '',
     fromChainId,
     fromTokenAddress,
     toTokenAddress,

examples/10-advance-routes-lifi.ts

@@ -1,35 +1,33 @@
 import { ethers, utils } from 'ethers';
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 dotenv.config();
 
 async function main(): Promise<void> {
-  // initializating sdk...
-  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    projectKey: 'public-prime-testnet-key', // project key
-  });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
 
   const fromChainId = 56;
   const toChainId = 137;
 
   const fromAmount = utils.parseUnits('1', 18);
 
   const quoteRequestPayload = {
+    fromAddress: '',
     fromChainId: fromChainId,
     toChainId: toChainId,
     fromTokenAddress: ethers.constants.AddressZero,
     toTokenAddress: ethers.constants.AddressZero,
     fromAmount: fromAmount,
   };
 
-  const quotes = await primeSdk.getAdvanceRoutesLiFi(quoteRequestPayload);
+  const quotes = await dataService.getAdvanceRoutesLiFi(quoteRequestPayload);
 
   console.log('\x1b[33m%s\x1b[0m', `Quotes:`, quotes.items);
 
   if (quotes.items.length > 0) {
     const quote = quotes.items[0]; // Selected the first route
-    const transactions = await primeSdk.getStepTransaction({ route: quote });
+    const transactions = await dataService.getStepTransaction({ route: quote, account: '' });
 
     console.log('\x1b[33m%s\x1b[0m', `transactions:`, transactions);
   }

examples/11-cross-chain-quotes.ts

@@ -1,15 +1,12 @@
 import { utils } from 'ethers';
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 import { BridgingQuotes, CrossChainServiceProvider } from '../src/sdk/data';
 dotenv.config();
 
 async function main(): Promise<void> {
-  // initializating sdk...
-  const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-    chainId: Number(process.env.CHAIN_ID),
-    projectKey: 'public-prime-testnet-key', // project key
-  });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
 
   const XdaiUSDC = '0xDDAfbb505ad214D7b80b1f830fcCc89B60fb7A83'; // Xdai - USDC
   const MaticUSDC = '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174'; // Matic - USDC
@@ -27,12 +24,12 @@ async function main(): Promise<void> {
     toChainId: toChainId,
     fromTokenAddress: fromTokenAddress,
     toTokenAddress: toTokenAddress,
-    fromAddress: '', // account address
+    fromAddress: '', // from address
     fromAmount: fromAmount,
     serviceProvider: CrossChainServiceProvider.LiFi, // Optional parameter
   };
 
-  const quotes: BridgingQuotes = await primeSdk.getCrossChainQuotes(quoteRequestPayload);
+  const quotes: BridgingQuotes = await dataService.getCrossChainQuotes(quoteRequestPayload);
 
   console.log('\x1b[33m%s\x1b[0m', `Quotes:`, quotes);
 }

examples/12-add-guardians.ts

@@ -13,7 +13,7 @@ async function main() {
     { chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key' },
   );
 
-  console.log('address: ', primeSdk.state.walletAddress);
+  console.log('address: ', primeSdk.state.EOAAddress);
 
   // get address of EtherspotWallet
   const address: string = await primeSdk.getCounterFactualAddress();

examples/13-paymaster.ts

@@ -16,7 +16,7 @@ async function main() {
     chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key',
   })
 
-  console.log('address: ', primeSdk.state.walletAddress)
+  console.log('address: ', primeSdk.state.EOAAddress)
 
   // get address of EtherspotWallet...
   const address: string = await primeSdk.getCounterFactualAddress();

examples/16-paymaster-arka.ts

@@ -20,7 +20,7 @@ async function main() {
     chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key',
   })
 
-  console.log('address: ', primeSdk.state.walletAddress)
+  console.log('address: ', primeSdk.state.EOAAddress)
 
   const entryPointAddress = '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789';
 

examples/17-token-list.ts

@@ -1,32 +1,29 @@
-import { PrimeSdk } from '../src';
+import { DataUtils, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 
 dotenv.config();
 
 async function main(): Promise<void> {
-    // initializating sdk...
-    const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-        chainId: Number(process.env.CHAIN_ID),
-        projectKey: 'public-prime-testnet-key',     // project key
-    });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
 
-    const tokenLists = await primeSdk.getTokenLists();
+  const tokenLists = await dataService.getTokenLists();
 
-    console.log('\x1b[33m%s\x1b[0m', `TokenLists:`, tokenLists);
+  console.log('\x1b[33m%s\x1b[0m', `TokenLists:`, tokenLists);
 
-    const { name } = tokenLists[0];
+  const { name } = tokenLists[0];
 
-    let tokenListTokens = await primeSdk.getTokenListTokens();
+  let tokenListTokens = await dataService.getTokenListTokens();
 
-    console.log('\x1b[33m%s\x1b[0m', `Default token list tokens length:`, tokenListTokens.length);
+  console.log('\x1b[33m%s\x1b[0m', `Default token list tokens length:`, tokenListTokens.length);
 
-    tokenListTokens = await primeSdk.getTokenListTokens({
-        name,
-    });
+  tokenListTokens = await dataService.getTokenListTokens({
+    name,
+  });
 
-    console.log('\x1b[33m%s\x1b[0m', `${name} token list tokens length:`, tokenListTokens.length);
+  console.log('\x1b[33m%s\x1b[0m', `${name} token list tokens length:`, tokenListTokens.length);
 }
 
 main()
-    .catch(console.error)
-    .finally(() => process.exit());
+  .catch(console.error)
+  .finally(() => process.exit());

examples/18-exchange-rates.ts

@@ -1,31 +1,28 @@
-import { PrimeSdk, RateData } from '../src';
+import { DataUtils, RateData, graphqlEndpoints } from '../src';
 import * as dotenv from 'dotenv';
 
 dotenv.config();
 
 async function main(): Promise<void> {
-    // initializating sdk...
-    const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, {
-        chainId: Number(process.env.CHAIN_ID),
-        projectKey: 'public-prime-testnet-key',     // project key
-    });
+  // initializating Data service...
+  const dataService = new DataUtils('public-prime-testnet-key', graphqlEndpoints.QA)
 
-    const ETH_AAVE_ADDR = '0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9';
-    const ETH_MATIC_ADDR = '0x7D1AfA7B718fb893dB30A3aBc0Cfc608AaCfeBB0';
-    const ETH_USDC_ADDR = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
-    const TOKEN_LIST = [ETH_AAVE_ADDR, ETH_MATIC_ADDR, ETH_USDC_ADDR];
-    const ETH_CHAIN_ID = 1;
+  const ETH_AAVE_ADDR = '0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9';
+  const ETH_MATIC_ADDR = '0x7D1AfA7B718fb893dB30A3aBc0Cfc608AaCfeBB0';
+  const ETH_USDC_ADDR = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
+  const TOKEN_LIST = [ETH_AAVE_ADDR, ETH_MATIC_ADDR, ETH_USDC_ADDR];
+  const ETH_CHAIN_ID = 1;
 
-    const requestPayload = {
-        tokens: TOKEN_LIST,
-        chainId: ETH_CHAIN_ID,
-    };
+  const requestPayload = {
+    tokens: TOKEN_LIST,
+    chainId: ETH_CHAIN_ID,
+  };
 
-    const rates: RateData = await primeSdk.fetchExchangeRates(requestPayload);
+  const rates: RateData = await dataService.fetchExchangeRates(requestPayload);
 
-    console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet Rates:`, rates);
+  console.log('\x1b[33m%s\x1b[0m', `EtherspotWallet Rates:`, rates);
 }
 
 main()
-    .catch(console.error)
-    .finally(() => process.exit());
+  .catch(console.error)
+  .finally(() => process.exit());

examples/19-paymaster-validUntil-validAfter.ts

@@ -19,7 +19,7 @@ async function main() {
         chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key',
     })
 
-    console.log('address: ', primeSdk.state.walletAddress)
+    console.log('address: ', primeSdk.state.EOAAddress)
 
     // get address of EtherspotWallet...
     const address: string = await primeSdk.getCounterFactualAddress();

examples/20-callDataLimit.ts

@@ -13,7 +13,7 @@ async function main() {
   // initializating sdk...
   const primeSdk = new PrimeSdk({ privateKey: process.env.WALLET_PRIVATE_KEY }, { chainId: Number(process.env.CHAIN_ID), projectKey: 'public-prime-testnet-key' })
 
-  console.log('address: ', primeSdk.state.walletAddress)
+  console.log('address: ', primeSdk.state.EOAAddress)
 
   // get address of EtherspotWallet...
   const address: string = await primeSdk.getCounterFactualAddress();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherspot/prime-sdk",
-  "version": "1.3.14",
+  "version": "1.4.0",
   "description": "Etherspot Prime (Account Abstraction) SDK",
   "keywords": [
     "ether",