Ethers Cfx Patch

Description

ethers-cfx-patch is used for compatiable ethers with conflux network. The purpose is to overwrite some methods to compatibale with cfx network, most are functions related address and transaction. And it will not break origin features.

Install

$ npm install ethers-cfx-patch

Usage

Overwrite methods

Load ethers-cfx-patch package in the head of your project. It will overwrite methods.

// load pacakge to overwrite methods
require("ethers-cfx-patch")
// your project
// ...

Use CFX proxy provider

We provide an JsonRpcProxy for adapter ethereum rpc to conflux rpc, use JsonRpcProxy to create an Web3Provider

const JsonRpcProxy = require("web3-provider-proxy");

const cfxProxy = new JsonRpcProxy("http://localhost:12537")
const povider = new ethers.providers.Web3Provider(cfxProxy)

Note

Auto setted fields

The JsonRpcProxy is a rpc proxy which adapt conflux rpc methods to ethereum rpc methods, and some concepts are auto handled for user, there are

rpc method cfx_sendTransaction

• storageLimit
• epochHeight

Difference with actual

All of fields block number in eth rpc request or response are correspending to epoch number in JsonRpcProxy, and sametime there also concept block number in conflux but is hidden in JsonRpcProxy, so if you use eth_getBlockNumber it will return epoch number of conflux, and currently could not get real block number use JsonRpcProxy.

So please don't use JsonRpcProxy to do bussiness dependencies block number. The bussiness dependencies Transaction and Events are not impacted.

CfxWallet

The CfxWallet is used for sign, sendTransaction, deploy contract in cfx format. It need one more param networkId which could access by provider.getNetowrk to create an instance.

let network = await provider.getNetwork()
let networkId = network.chainId
let signer = new CfxWallet("0x2139FB4C55CB9AF7F0086CD800962C2E9013E2292BAE77978A9209E3BEE71D49",p, networkId)
console.log("signer address", await signer.address)
console.log("sign message:", await signer.signMessage("hello"))
const txSended = await signer.sendTransaction({ ...tx, from: signer.address })
const receipt = await txSended.wait(1)
console.log("send tx by wallet", { txSended, receipt })

utils

There also provids some utils methods used for conflux network