ALL-4895 - Add Cronos subscriptions (#1079)

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [4.2.16] - 2024.2.15
+
+### Added
+
+- Added support for Cronos and Cronos testnet subscriptions.
+
 ## [4.2.15] - 2024.3.11
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tatumio/tatum",
-  "version": "4.2.15",
+  "version": "4.2.16",
   "description": "Tatum JS SDK",
   "author": "Tatum",
   "repository": "https://github.com/tatumio/tatum-js",

src/connector/tatum.connector.ts

@@ -106,7 +106,11 @@ export class TatumConnector {
         if (isDownload) {
           return await res.blob()
         }
-        return await res.json()
+        const response = await res.json()
+        if (response?.error) {
+          return await this.retry(url, request, res, retry)
+        }
+        return response
       }
 
       // Retry only in case of 5xx error

src/dto/AddressEventNotificationChain.ts

@@ -15,4 +15,5 @@ export enum AddressEventNotificationChain {
   EON = 'EON',
   CHZ = 'CHZ',
   FLR = 'FLR',
+  CRO = 'CRO',
 }

src/dto/Network.ts

@@ -822,11 +822,13 @@ export const NETWORK_METADATA: Record<Network, NetworkMetadata> = {
     currency: Currency.CRO,
     testnet: false,
     chainId: 25,
+    defaultMainnet: true,
   },
   [Network.CRONOS_TESTNET]: {
     currency: Currency.CRO,
     testnet: true,
     chainId: 338,
+    defaultTestnet: true,
   },
   [Network.KUCOIN]: {
     currency: Currency.KCS,

src/dto/rpc/EvmBasedRpcInterface.ts

@@ -275,6 +275,7 @@ export interface ValidatorQuery extends StateQuery {
 
 export interface EvmBeaconV1Interface {
   getGenesis(): Promise<EvmBeaconResponse<any>>
+  getNodeVersion(): Promise<EvmBeaconResponse<any>>
   getBlockHeaders(query?: { slot?: string; parentRoot?: string }): Promise<EvmBeaconResponse<any>>
   getBlockHeader(query: BlockQuery): Promise<EvmBeaconResponse<any>>
   getBlockRoot(query: BlockQuery): Promise<EvmBeaconResponse<any>>

src/e2e/e2e.constant.ts

@@ -33,6 +33,11 @@ export const AddressEventNetworks = [
   Network.XRP_TESTNET,
   Network.TEZOS,
   Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const IncomingNativeTxNetworks = [
@@ -62,6 +67,12 @@ export const IncomingNativeTxNetworks = [
   Network.XRP,
   Network.XRP_TESTNET,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const OutgoingNativeTxNetworks = [
@@ -89,6 +100,12 @@ export const OutgoingNativeTxNetworks = [
   Network.XRP,
   Network.XRP_TESTNET,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const OutgoingFailedNetworks = [
@@ -104,6 +121,12 @@ export const OutgoingFailedNetworks = [
   Network.KLAYTN,
   Network.KLAYTN_BAOBAB,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const PaidFeeNetworks = [
@@ -123,6 +146,12 @@ export const PaidFeeNetworks = [
   Network.XRP,
   Network.XRP_TESTNET,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const FungibleTxNetworks = [
@@ -142,6 +171,12 @@ export const FungibleTxNetworks = [
   Network.SOLANA,
   Network.SOLANA_DEVNET,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const NftNetworks = [
@@ -161,6 +196,12 @@ export const NftNetworks = [
   Network.SOLANA,
   Network.SOLANA_DEVNET,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const MultitokenNetworks = [
@@ -175,6 +216,12 @@ export const MultitokenNetworks = [
   Network.BINANCE_SMART_CHAIN_TESTNET,
   Network.KLAYTN,
   Network.KLAYTN_BAOBAB,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const FailedTxPerBlockNetworks = [
@@ -194,6 +241,12 @@ export const FailedTxPerBlockNetworks = [
   Network.SOLANA,
   Network.SOLANA_DEVNET,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
+  Network.CRONOS,
+  Network.CRONOS_TESTNET,
 ]
 
 export const ContractAddressLogEventNetworks = [
@@ -208,6 +261,10 @@ export const ContractAddressLogEventNetworks = [
   Network.BINANCE_SMART_CHAIN_TESTNET,
   Network.KLAYTN,
   Network.KLAYTN_BAOBAB,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
 ]
 
 export const InternalTxNetworks = [
@@ -217,4 +274,8 @@ export const InternalTxNetworks = [
   Network.CELO,
   Network.CELO_ALFAJORES,
   Network.TEZOS,
+  Network.FLARE,
+  Network.FLARE_COSTON,
+  Network.FLARE_COSTON_2,
+  Network.FLARE_SONGBIRD,
 ]

src/e2e/e2e.util.ts

@@ -7,6 +7,7 @@ import {
   ContractBasedNotificationDetail,
   FullSdk,
   Network,
+  NotificationSubscription,
 } from '../service'
 import { ResponseDto } from '../util'
 import { NetworkUtils } from '../util/network.utils'
@@ -32,11 +33,13 @@ export const e2eUtil = {
         case Network.FLARE_COSTON:
         case Network.FLARE_COSTON_2:
         case Network.FLARE_SONGBIRD:
+        case Network.CRONOS:
+        case Network.CRONOS_TESTNET:
           return '0xdb4C3b4350EE869F2D0a2F43ce0292865E2Aa149'
         case Network.CELO_ALFAJORES:
           return '0xdf083B077F1FD890fC71feCaBbd3F68F94cD21Bf'
         case Network.POLYGON_MUMBAI:
-          return '0xd608d48c6ddB41254d73ec0619FE31B254Fb5ab8'
+          return '0xcf3c930601111c216fc0232d32cf5c2a86f107da'
         case Network.KLAYTN_BAOBAB:
           return '0xdc7Dfb8Aa86D41b7e39441711Fe1669f2d843C06'
         case Network.BINANCE_SMART_CHAIN_TESTNET:
@@ -91,6 +94,7 @@ export const e2eUtil = {
         addressBasedNotificationDetail: AddressBasedNotificationDetail,
       ) => Promise<ResponseDto<AddressBasedNotification>>,
     ) => {
+      await e2eUtil.flushSubscriptions(tatum)
       const url = 'https://webhook.site/'
       const { data, error } = await func({
         url,
@@ -116,6 +120,7 @@ export const e2eUtil = {
         contractBasedNotificationDetail: ContractBasedNotificationDetail,
       ) => Promise<ResponseDto<ContractBasedNotification>>,
     ) => {
+      await e2eUtil.flushSubscriptions(tatum)
       const url = 'https://webhook.site/'
       const event = '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef'
       const { data, error } = await func({
@@ -144,6 +149,7 @@ export const e2eUtil = {
         blockBasedNotificationDetail: BlockBasedNotificationDetail,
       ) => Promise<ResponseDto<BlockBasedNotification>>,
     ) => {
+      await e2eUtil.flushSubscriptions(tatum)
       const url = 'https://webhook.site/'
 
       const { data, error } = await func({
@@ -157,4 +163,18 @@ export const e2eUtil = {
     },
   },
   isVerbose: process.env.E2E_VERBOSE === 'true',
+  flushSubscriptions: async (tatum: FullSdk) => {
+    try {
+      const notifications = await tatum.notification.getAll()
+
+      if (notifications?.data?.length > 0) {
+        for (const notification of notifications.data as NotificationSubscription[]) {
+          await tatum.notification.unsubscribe(notification.id)
+        }
+      }
+    } catch (e) {
+      console.error('Error flushing subscriptions')
+      console.error(e)
+    }
+  },
 }

src/e2e/rpc/evm/eth/tatum.rpc.beacon.spec.ts

@@ -7,6 +7,13 @@ describe('Beacon', () => {
     const networks = [Network.ETHEREUM_HOLESKY, Network.ETHEREUM_SEPOLIA, Network.ETHEREUM]
 
     describe.each(networks)('%s', (network) => {
+      it('should get node version', async () => {
+        const tatum = await EvmE2eUtils.initTatum<Ethereum>(network, process.env.V4_API_KEY_TESTNET)
+        const { data } = await tatum.rpc.beacon.v1.getNodeVersion()
+        await tatum.destroy()
+        expect(data).toBeDefined()
+      })
+
       it('should get genesis', async () => {
         const tatum = await EvmE2eUtils.initTatum<Ethereum>(network, process.env.V4_API_KEY_TESTNET)
         const { data } = await tatum.rpc.beacon.v1.getGenesis()

src/e2e/rpc/other/tatum.rpc.xrp.spec.ts

@@ -5,11 +5,6 @@ const getXrpRpc = async (testnet?: boolean) =>
   await TatumSDK.init<Xrp>(e2eUtil.initConfig(testnet ? Network.XRP_TESTNET : Network.XRP))
 
 describe('RPCs', () => {
-  afterEach(async () => {
-    // wait for 200ms to avoid rate limit
-    await new Promise((resolve) => setTimeout(resolve, 100))
-  })
-
   describe('XRP', () => {
     describe('testnet', () => {
       it('ping', async () => {
@@ -18,6 +13,20 @@ describe('RPCs', () => {
         await tatum.destroy()
         expect(result.status).toBe('success')
       })
+
+      it('ledger_closed', async () => {
+        const tatum = await getXrpRpc(true)
+        const { result } = await tatum.rpc.ledgerClosed()
+        await tatum.destroy()
+        expect(result.ledger_index).toBeGreaterThan(0)
+      })
+
+      it('fee', async () => {
+        const tatum = await getXrpRpc(true)
+        const { result } = await tatum.rpc.fee()
+        await tatum.destroy()
+        expect(result.ledger_current_index).toBeGreaterThan(0)
+      })
     })
   })
   describe('XRP', () => {

src/e2e/tatum.notification.spec.ts

@@ -17,19 +17,7 @@ import {
 } from './e2e.constant'
 import { e2eUtil } from './e2e.util'
 
-// TODO pipeline dont work with API keys
-
 describe('notification', () => {
-  beforeAll(async () => {
-    const tatum = await TatumSDK.init<Ethereum>(e2eUtil.initConfig(Network.ETHEREUM))
-    const notifications = await tatum.notification.getAll()
-
-    if (notifications?.data?.length > 0) {
-      for (const notification of notifications.data as NotificationSubscription[]) {
-        await tatum.notification.unsubscribe(notification.id)
-      }
-    }
-  })
   describe('createSubscription', () => {
     describe('IP auth', () => {
       describe('Address Event', () => {

src/service/rpc/evm/AbstractBeaconV1EvmRpc.ts

@@ -17,8 +17,12 @@ import { Constant, Utils } from '../../../util'
 export abstract class AbstractBeaconV1EvmRpc implements EvmBeaconV1Interface {
   protected abstract get<T>(get: GetI): Promise<T>
 
-  private sendGet<T>(path: string, params: QueryParams): Promise<T> {
-    const fullPath = Utils.addQueryParams(`${Constant.BEACON_PREFIX}/${path}`, Utils.camelToSnakeCase, params)
+  private sendGet<T>(path: string, params: QueryParams, prefix?: string): Promise<T> {
+    const fullPath = Utils.addQueryParams(
+      `${prefix ?? Constant.BEACON_PREFIX}/${path}`,
+      Utils.camelToSnakeCase,
+      params,
+    )
     return this.get({ path: fullPath })
   }
 
@@ -80,4 +84,8 @@ export abstract class AbstractBeaconV1EvmRpc implements EvmBeaconV1Interface {
   getStateValidators({ stateId, ...rest }: ValidatorsQuery): Promise<EvmBeaconResponse<any>> {
     return this.sendGet(`states/${stateId}/validators`, rest)
   }
+
+  getNodeVersion(): Promise<EvmBeaconResponse<any>> {
+    return this.sendGet('node/version', {}, Constant.BEACON_BASE_PREFIX)
+  }
 }

src/service/rpc/generic/LoadBalancer.ts

@@ -104,7 +104,7 @@ export class LoadBalancer implements AbstractRpcInterface {
 
     if (config.rpc?.oneTimeLoadBalancing) {
       Utils.log({ id: this.id, message: 'oneTimeLoadBalancing enabled' })
-      setTimeout(() => this.checkStatuses(), Constant.OPEN_RPC.LB_INTERVAL)
+      await this.checkStatuses()
     } else {
       this.interval = setInterval(() => this.checkStatuses(), Constant.OPEN_RPC.LB_INTERVAL)
     }

src/service/tatum/tatum.evm.ts

@@ -53,7 +53,7 @@ export class ArbitrumNova extends BaseEvm {}
 export class ArbitrumOne extends BaseEvm {}
 export class Aurora extends BaseEvm {}
 export class AvalancheC extends BaseEvm {}
-export class Cronos extends BaseEvm {}
+export class Cronos extends NotificationEvm {}
 export class EthereumClassic extends BaseEvm {}
 export class Fantom extends BaseEvm {}
 export class Gnosis extends BaseEvm {}

src/util/constant.ts

@@ -314,4 +314,5 @@ export const Constant = {
   },
   EOS_PREFIX: 'v1/chain/',
   BEACON_PREFIX: '/eth/v1/beacon',
+  BEACON_BASE_PREFIX: '/eth/v1',
 }