feat: rsk integration

Author: ahsan-javaiid

packages/bitcore-node/src/config.ts

@@ -62,7 +62,7 @@ const Config = function(): ConfigType {
     dbPass: process.env.DB_PASS || '',
     numWorkers: cpus().length,
     chains: {},
-    modules: ['./bitcoin', './bitcoin-cash', './ethereum'],
+    modules: ['./bitcoin', './bitcoin-cash', './ethereum', './rsk'],
     services: {
       api: {
         rateLimiter: {

packages/bitcore-node/src/modules/ethereum/api/csp.ts

@@ -89,7 +89,7 @@ export class ETHStateProvider extends InternalStateProvider implements IChainSta
   }
 
   async getERC20TokenInfo(network: string, tokenAddress: string) {
-    const token = await ETH.erc20For(network, tokenAddress);
+    const token = await this.erc20For(network, tokenAddress); // Use `this` rather than ETH to make it generic for other EVM compatible chains to facilitate the class based inheritance of ETHStateProvider
     const [name, decimals, symbol] = await Promise.all([
       token.methods.name().call(),
       token.methods.decimals().call(),
@@ -360,7 +360,7 @@ export class ETHStateProvider extends InternalStateProvider implements IChainSta
   async streamWalletTransactions(params: StreamWalletTransactionsParams) {
     const { network, wallet, res, args } = params;
     const { web3 } = await this.getWeb3(network);
-    const query = ETH.getWalletTransactionQuery(params);
+    const query = this.getWalletTransactionQuery(params); // Use this rather than ETH to make it generic for other EVM compatible chains to facilitate the class based inheritance of ETHStateProvider
 
     let transactionStream = new Readable({ objectMode: true });
     const walletAddresses = (await this.getWalletAddresses(wallet._id!)).map(waddres => waddres.address);
@@ -572,5 +572,11 @@ export class ETHStateProvider extends InternalStateProvider implements IChainSta
     };
   }
 }
-
-export const ETH = new ETHStateProvider();
+/*
+ * 
+ * Use the ETH implementation for RSK by inheriting the ETHStateProvider class rather than making its clone
+ * This will reduce lot of maintenance cost and avoid code duplication
+ * For other EVM compatible chains like RSK below export needs to be like new ETHStateProvider('RSK')
+ * It's just a suggestion to use process.env.chain evn variable untill bitpay team can make it more generic for other EVM like chains
+ */
+export const ETH = new ETHStateProvider(process.env.chain || 'ETH');

packages/bitcore-node/src/modules/index.ts

@@ -53,7 +53,8 @@ class ModuleManager extends BaseModule {
     BCH: './bitcoin-cash',
     DOGE: './dogecoin',
     LTC: './litecoin',
-    XRP: './ripple'
+    XRP: './ripple',
+    RSK: './rsk'
   };
 
   loadConfigured() {

packages/bitcore-node/src/modules/modules.md

@@ -12,6 +12,7 @@ The modules in this table will automatically register with `bitcore-node` if you
 | LTC            | litecoin       | ./litecoin     |
 | DOGE           | dogecoin       | ./dogecoin     |
 | XRP            | ripple         | ./ripple       |
+| RSK            | rsk            | ./rsk          |
 
 If there is a custom or third-party module you'd like to use, follow the example below.
 

packages/bitcore-node/src/modules/rsk/api/csp.ts

@@ -0,0 +1,18 @@
+import Config from '../../../config';
+import { ETHStateProvider } from '../../ethereum/api/csp';
+
+export { EventLog } from '../../ethereum/api/csp';
+export class RSKStateProvider extends ETHStateProvider {
+  /*
+   * Reusing ETHStateProvider class for RSK 
+   * Purpose is to avoid code duplication and reduce maintenance cost
+   */
+  constructor(public chain: string = 'RSK') {
+    super(chain);
+    this.config = Config.chains[this.chain];
+  }
+
+}
+
+export const RSK = new RSKStateProvider();
+

packages/bitcore-node/src/modules/rsk/api/rsk-routes.ts

@@ -0,0 +1,36 @@
+import { Router } from 'express';
+import logger from '../../../logger';
+import { RSK } from './csp';
+export const RskRoutes = Router();
+
+RskRoutes.get('/api/RSK/:network/address/:address/txs/count', async (req, res) => {
+  let { address, network } = req.params;
+  try {
+    const nonce = await RSK.getAccountNonce(network, address);
+    res.json({ nonce });
+  } catch (err) {
+    logger.error('Nonce Error::' + err);
+    res.status(500).send(err);
+  }
+});
+
+RskRoutes.post('/api/RSK/:network/gas', async (req, res) => {
+  const { from, to, value, data, gasPrice } = req.body;
+  const { network } = req.params;
+  try {
+    const gasLimit = await RSK.estimateGas({ network, from, to, value, data, gasPrice });
+    res.json(gasLimit);
+  } catch (err) {
+    res.status(500).send(err);
+  }
+});
+
+RskRoutes.get('/api/RSK/:network/token/:tokenAddress', async (req, res) => {
+  const { network, tokenAddress } = req.params;
+  try {
+    const tokenInfo = await RSK.getERC20TokenInfo(network, tokenAddress);
+    res.json(tokenInfo);
+  } catch (err) {
+    res.status(500).send(err);
+  }
+});

packages/bitcore-node/src/modules/rsk/index.ts

@@ -0,0 +1,15 @@
+import { BaseModule } from '..';
+import { RSKStateProvider } from './api/csp';
+import { RskRoutes } from './api/rsk-routes';
+import { RskP2pWorker } from './p2p/p2p';
+import { RskVerificationPeer } from './p2p/RskVerificationPeer';
+
+export default class RSKModule extends BaseModule {
+  constructor(services: BaseModule['bitcoreServices']) {
+    super(services);
+    services.P2P.register('RSK', RskP2pWorker);
+    services.CSP.registerService('RSK', new RSKStateProvider('RSK'));
+    services.Api.app.use(RskRoutes);
+    services.Verification.register('RSK', RskVerificationPeer);
+  }
+}

packages/bitcore-node/src/modules/rsk/p2p/RskVerificationPeer.ts

@@ -0,0 +1,8 @@
+import { EthVerificationPeer } from '../../ethereum/p2p/EthVerificationPeer';
+
+export class RskVerificationPeer extends EthVerificationPeer {
+  /*
+   * Reusing EthVerificationPeer class for RSK 
+   * Purpose is to avoid code duplication and reduce maintenance cost
+   */
+}

packages/bitcore-node/src/modules/rsk/p2p/p2p.ts

@@ -0,0 +1,12 @@
+import { EthP2pWorker  } from '../../ethereum/p2p/p2p';
+import { EthBlockStorage } from '../../ethereum/models/block';
+export class RskP2pWorker extends EthP2pWorker {
+  /*
+   * Reusing EthP2pWorker class for RSK 
+   * Purpose is to avoid code duplication and reduce maintenance cost
+   */
+  constructor({ chain, network, chainConfig, blockModel = EthBlockStorage}) {
+    super({ chain, network, chainConfig, blockModel });
+    this.chain = 'RSK';
+  }
+}

packages/bitcore-wallet-client/src/lib/api.ts

@@ -2964,7 +2964,9 @@ export class API extends EventEmitter {
         ['btc', 'livenet', true],
         ['bch', 'livenet', true],
         ['doge', 'livenet', true],
-        ['ltc', 'livenet', true]
+        ['ltc', 'livenet', true],
+        ['rsk', 'livenet'],
+        ['rbtc', 'livenet'],
       ];
       if (key.use44forMultisig) {
         //  testing old multi sig