Merge pull request #94 from CityOfZion/CU-86duf6rpu

CU-86duf6rpu - BSEthereum - Implement a new ExplorerService to NeoX u…

common/changes/@cityofzion/bs-ethereum/CU-86duf6rpu_2024-09-02-15-56.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/bs-ethereum",
+      "comment": "Added new explorer service to NeoX",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@cityofzion/bs-ethereum"
+}

packages/bs-ethereum/src/BSEthereum.ts

@@ -2,12 +2,14 @@ import {
   Account,
   AccountWithDerivationPath,
   BSCalculableFee,
+  BSWithExplorerService,
   BSWithLedger,
   BSWithNameService,
   BSWithNft,
   BlockchainDataService,
   BlockchainService,
   ExchangeDataService,
+  ExplorerService,
   Network,
   NftDataService,
   Token,
@@ -25,14 +27,16 @@ import { MoralisBDSEthereum } from './MoralisBDSEthereum'
 import { MoralisEDSEthereum } from './MoralisEDSEthereum'
 import { BlockscoutNeoXBDSEthereum } from './BlockscoutNeoXBDSEthereum'
 import { BlockscoutNeoXEDSEthereum } from './BlockscoutNeoXEDSEthereum'
+import { BlockscoutNeoXESEthereum } from './BlockscoutNeoXESEthereum'
 
 export class BSEthereum<BSCustomName extends string = string>
   implements
     BlockchainService<BSCustomName, BSEthereumNetworkId>,
     BSWithNft,
     BSWithNameService,
     BSCalculableFee,
-    BSWithLedger
+    BSWithLedger,
+    BSWithExplorerService
 {
   readonly blockchainName: BSCustomName
   readonly derivationPath: string
@@ -44,6 +48,7 @@ export class BSEthereum<BSCustomName extends string = string>
   tokens!: Token[]
   nftDataService!: NftDataService
   network!: Network<BSEthereumNetworkId>
+  explorerService!: ExplorerService
 
   constructor(
     blockchainName: BSCustomName,
@@ -129,6 +134,7 @@ export class BSEthereum<BSCustomName extends string = string>
     }
 
     this.nftDataService = new GhostMarketNDSEthereum(network)
+    this.explorerService = new BlockscoutNeoXESEthereum(network)
   }
 
   validateAddress(address: string): boolean {

packages/bs-ethereum/src/BlockscoutNeoXESEthereum.ts

@@ -0,0 +1,49 @@
+import { BuildNftUrlParams, ExplorerService, Network } from '@cityofzion/blockchain-service'
+import { BSEthereumNetworkId } from './BSEthereumHelper'
+
+export class BlockscoutNeoXESEthereum implements ExplorerService {
+  static BASE_URL_BY_CHAIN_ID: Partial<Record<BSEthereumNetworkId, string>> = {
+    '12227332': 'https://xt4scan.ngd.network',
+    '47763': 'https://xexplorer.neo.org',
+  }
+
+  static isSupported(network: Network<BSEthereumNetworkId>) {
+    return !!BlockscoutNeoXESEthereum.BASE_URL_BY_CHAIN_ID[network.id]
+  }
+
+  readonly #network: Network<BSEthereumNetworkId>
+
+  constructor(network: Network<BSEthereumNetworkId>) {
+    this.#network = network
+  }
+
+  buildTransactionUrl(hash: string): string {
+    if (!BlockscoutNeoXESEthereum.isSupported(this.#network)) {
+      throw new Error('Network not supported')
+    }
+
+    const baseURL = BlockscoutNeoXESEthereum.BASE_URL_BY_CHAIN_ID[this.#network.id]
+
+    return `${baseURL}/tx/${hash}`
+  }
+
+  buildContractUrl(contractHash: string): string {
+    if (!BlockscoutNeoXESEthereum.isSupported(this.#network)) {
+      throw new Error('Network not supported')
+    }
+
+    const baseURL = BlockscoutNeoXESEthereum.BASE_URL_BY_CHAIN_ID[this.#network.id]
+
+    return `${baseURL}/address/${contractHash}`
+  }
+
+  buildNftUrl(params: BuildNftUrlParams): string {
+    if (!BlockscoutNeoXESEthereum.isSupported(this.#network)) {
+      throw new Error('Network not supported')
+    }
+
+    const baseURL = BlockscoutNeoXESEthereum.BASE_URL_BY_CHAIN_ID[this.#network.id]
+
+    return `${baseURL}/token/${params.contractHash}/instance/${params.tokenId}`
+  }
+}