evm-blockchain-tools/src/gateways/bsc-ws-gateway.ts

This is a collection of resuseable tools to support development for EVM-powered blockchains

import { ethers, Signer, Wallet } from "ethers";
import Ws from "ws";
import { hashMessage } from "@ethersproject/hash";
import ReconnectingWebSocket from "reconnecting-websocket";

import {
  BscWsGatewayConfig,
  IWeb3Gateway,
  WsGatewayConfig,
} from "../common/interfaces";
import { APP_NETWORK, NETWORK_IDS } from "../common/constants";
import { isValidEvmTxFormat } from "../utils";

export class BscWsGateway implements IWeb3Gateway {
  public provider: ethers.providers.WebSocketProvider;
  public wallet: Wallet;
  public network = APP_NETWORK.BINANCE;

  constructor(protected config: WsGatewayConfig & BscWsGatewayConfig) {
    this.connect();
  }

  protected get networkName() {
    return this.config.network === APP_NETWORK.BINANCE
      ? APP_NETWORK.BINANCE
      : APP_NETWORK.BINANCE_TESTNET;
  }

  protected get chainId() {
    return this.config.network === APP_NETWORK.BINANCE
      ? NETWORK_IDS.BINANCE
      : NETWORK_IDS.BINANCE_TESTNET;
  }

  public connect(): void {
    const wsClient = new ReconnectingWebSocket(this.config.wsUrl, [], {
      WebSocket: Ws,
      ...(this.config.options || {}),
    });

    this.provider = new ethers.providers.WebSocketProvider(wsClient, {
      name: this.network,
      chainId: this.chainId,
    });
  }

  public async getGasPrice(): Promise<string> {
    const gasPrice = await this.provider.getGasPrice();

    return gasPrice.toString();
  }

  public isValidTxFormat(txHash: string): boolean {
    return isValidEvmTxFormat(txHash);
  }

  public get signer(): Promise<Signer> {
    return Promise.resolve(
      new ethers.Wallet(this.config.privateKey, this.provider)
    );
  }

  public async getBlock(blockNumber: number): Promise<any> {
    const block = await this.provider.getBlock(blockNumber);

    return block;
  }

  public async recoverSigner(
    message: string,
    signedMessage: string
  ): Promise<string> {
    return ethers.utils.recoverAddress(hashMessage(message), signedMessage);
  }

  public getCurrentBlock(): Promise<number> {
    return this.provider.getBlockNumber();
  }

  public async getSignerAddress(): Promise<string> {
    const signer = await this.signer;

    return signer.getAddress();
  }

  public getTransactionByID(txID: string): Promise<any> {
    return this.provider.getTransaction(txID);
  }
}