"use strict"; // See: https://github.com/ethereum/wiki/wiki/JSON-RPC import { Provider, TransactionRequest, TransactionResponse } from "@ethersproject/abstract-provider"; import { Signer, TypedDataDomain, TypedDataField, TypedDataSigner } from "@ethersproject/abstract-signer"; import { BigNumber } from "@ethersproject/bignumber"; import { Bytes, hexlify, hexValue, isHexString } from "@ethersproject/bytes"; import { _TypedDataEncoder } from "@ethersproject/hash"; import { Network, Networkish } from "@ethersproject/networks"; import { checkProperties, deepCopy, Deferrable, defineReadOnly, getStatic, resolveProperties, shallowCopy } from "@ethersproject/properties"; import { toUtf8Bytes } from "@ethersproject/strings"; import { AccessList, accessListify } from "@ethersproject/transactions"; import { ConnectionInfo, fetchJson, poll } from "@ethersproject/web"; import { Logger } from "@ethersproject/logger"; import { version } from "./_version"; const logger = new Logger(version); import { BaseProvider, Event } from "./base-provider"; const errorGas = [ "call", "estimateGas" ]; function checkError(method: string, error: any, params: any): any { // Undo the "convenience" some nodes are attempting to prevent backwards // incompatibility; maybe for v6 consider forwarding reverts as errors if (method === "call" && error.code === Logger.errors.SERVER_ERROR) { const e = error.error; if (e && e.message.match("reverted") && isHexString(e.data)) { return e.data; } } let message = error.message; if (error.code === Logger.errors.SERVER_ERROR && error.error && typeof(error.error.message) === "string") { message = error.error.message; } else if (typeof(error.body) === "string") { message = error.body; } else if (typeof(error.responseText) === "string") { message = error.responseText; } message = (message || "").toLowerCase(); const transaction = params.transaction || params.signedTransaction; // "insufficient funds for gas * price + value + cost(data)" if (message.match(/insufficient funds/)) { logger.throwError("insufficient funds for intrinsic transaction cost", Logger.errors.INSUFFICIENT_FUNDS, { error, method, transaction }); } // "nonce too low" if (message.match(/nonce too low/)) { logger.throwError("nonce has already been used", Logger.errors.NONCE_EXPIRED, { error, method, transaction }); } // "replacement transaction underpriced" if (message.match(/replacement transaction underpriced/)) { logger.throwError("replacement fee too low", Logger.errors.REPLACEMENT_UNDERPRICED, { error, method, transaction }); } // "replacement transaction underpriced" if (message.match(/only replay-protected/)) { logger.throwError("legacy pre-eip-155 transactions not supported", Logger.errors.UNSUPPORTED_OPERATION, { error, method, transaction }); } if (errorGas.indexOf(method) >= 0 && message.match(/gas required exceeds allowance|always failing transaction|execution reverted/)) { logger.throwError("cannot estimate gas; transaction may fail or may require manual gas limit", Logger.errors.UNPREDICTABLE_GAS_LIMIT, { error, method, transaction }); } throw error; } function timer(timeout: number): Promise { return new Promise(function(resolve) { setTimeout(resolve, timeout); }); } function getResult(payload: { error?: { code?: number, data?: any, message?: string }, result?: any }): any { if (payload.error) { // @TODO: not any const error: any = new Error(payload.error.message); error.code = payload.error.code; error.data = payload.error.data; throw error; } return payload.result; } function getLowerCase(value: string): string { if (value) { return value.toLowerCase(); } return value; } const _constructorGuard = {}; export class JsonRpcSigner extends Signer implements TypedDataSigner { readonly provider: JsonRpcProvider; _index: number; _address: string; constructor(constructorGuard: any, provider: JsonRpcProvider, addressOrIndex?: string | number) { logger.checkNew(new.target, JsonRpcSigner); super(); if (constructorGuard !== _constructorGuard) { throw new Error("do not call the JsonRpcSigner constructor directly; use provider.getSigner"); } defineReadOnly(this, "provider", provider); if (addressOrIndex == null) { addressOrIndex = 0; } if (typeof(addressOrIndex) === "string") { defineReadOnly(this, "_address", this.provider.formatter.address(addressOrIndex)); defineReadOnly(this, "_index", null); } else if (typeof(addressOrIndex) === "number") { defineReadOnly(this, "_index", addressOrIndex); defineReadOnly(this, "_address", null); } else { logger.throwArgumentError("invalid address or index", "addressOrIndex", addressOrIndex); } } connect(provider: Provider): JsonRpcSigner { return logger.throwError("cannot alter JSON-RPC Signer connection", Logger.errors.UNSUPPORTED_OPERATION, { operation: "connect" }); } connectUnchecked(): JsonRpcSigner { return new UncheckedJsonRpcSigner(_constructorGuard, this.provider, this._address || this._index); } getAddress(): Promise { if (this._address) { return Promise.resolve(this._address); } return this.provider.send("eth_accounts", []).then((accounts) => { if (accounts.length <= this._index) { logger.throwError("unknown account #" + this._index, Logger.errors.UNSUPPORTED_OPERATION, { operation: "getAddress" }); } return this.provider.formatter.address(accounts[this._index]) }); } sendUncheckedTransaction(transaction: Deferrable): Promise { transaction = shallowCopy(transaction); const fromAddress = this.getAddress().then((address) => { if (address) { address = address.toLowerCase(); } return address; }); // The JSON-RPC for eth_sendTransaction uses 90000 gas; if the user // wishes to use this, it is easy to specify explicitly, otherwise // we look it up for them. if (transaction.gasLimit == null) { const estimate = shallowCopy(transaction); estimate.from = fromAddress; transaction.gasLimit = this.provider.estimateGas(estimate); } return resolveProperties({ tx: resolveProperties(transaction), sender: fromAddress }).then(({ tx, sender }) => { if (tx.from != null) { if (tx.from.toLowerCase() !== sender) { logger.throwArgumentError("from address mismatch", "transaction", transaction); } } else { tx.from = sender; } const hexTx = (this.provider.constructor).hexlifyTransaction(tx, { from: true }); return this.provider.send("eth_sendTransaction", [ hexTx ]).then((hash) => { return hash; }, (error) => { return checkError("sendTransaction", error, hexTx); }); }); } signTransaction(transaction: Deferrable): Promise { return logger.throwError("signing transactions is unsupported", Logger.errors.UNSUPPORTED_OPERATION, { operation: "signTransaction" }); } sendTransaction(transaction: Deferrable): Promise { return this.sendUncheckedTransaction(transaction).then((hash) => { return poll(() => { return this.provider.getTransaction(hash).then((tx: TransactionResponse) => { if (tx === null) { return undefined; } return this.provider._wrapTransaction(tx, hash); }); }, { oncePoll: this.provider }).catch((error: Error) => { (error).transactionHash = hash; throw error; }); }); } async signMessage(message: Bytes | string): Promise { const data = ((typeof(message) === "string") ? toUtf8Bytes(message): message); const address = await this.getAddress(); // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign return await this.provider.send("eth_sign", [ address.toLowerCase(), hexlify(data) ]); } async _signTypedData(domain: TypedDataDomain, types: Record>, value: Record): Promise { // Populate any ENS names (in-place) const populated = await _TypedDataEncoder.resolveNames(domain, types, value, (name: string) => { return this.provider.resolveName(name); }); const address = await this.getAddress(); return await this.provider.send("eth_signTypedData_v4", [ address.toLowerCase(), JSON.stringify(_TypedDataEncoder.getPayload(populated.domain, types, populated.value)) ]); } async unlock(password: string): Promise { const provider = this.provider; const address = await this.getAddress(); return provider.send("personal_unlockAccount", [ address.toLowerCase(), password, null ]); } } class UncheckedJsonRpcSigner extends JsonRpcSigner { sendTransaction(transaction: Deferrable): Promise { return this.sendUncheckedTransaction(transaction).then((hash) => { return { hash: hash, nonce: null, gasLimit: null, gasPrice: null, data: null, value: null, chainId: null, confirmations: 0, from: null, wait: (confirmations?: number) => { return this.provider.waitForTransaction(hash, confirmations); } }; }); } } const allowedTransactionKeys: { [ key: string ]: boolean } = { chainId: true, data: true, gasLimit: true, gasPrice:true, nonce: true, to: true, value: true, type: true, accessList: true } export class JsonRpcProvider extends BaseProvider { readonly connection: ConnectionInfo; _pendingFilter: Promise; _nextId: number; // During any given event loop, the results for a given call will // all be the same, so we can dedup the calls to save requests and // bandwidth. @TODO: Try out generalizing this against send? _eventLoopCache: Record>; get _cache(): Record> { if (this._eventLoopCache == null) { this._eventLoopCache = { }; } return this._eventLoopCache; } constructor(url?: ConnectionInfo | string, network?: Networkish) { logger.checkNew(new.target, JsonRpcProvider); let networkOrReady: Networkish | Promise = network; // The network is unknown, query the JSON-RPC for it if (networkOrReady == null) { networkOrReady = new Promise((resolve, reject) => { setTimeout(() => { this.detectNetwork().then((network) => { resolve(network); }, (error) => { reject(error); }); }, 0); }); } super(networkOrReady); // Default URL if (!url) { url = getStatic<() => string>(this.constructor, "defaultUrl")(); } if (typeof(url) === "string") { defineReadOnly(this, "connection",Object.freeze({ url: url })); } else { defineReadOnly(this, "connection", Object.freeze(shallowCopy(url))); } this._nextId = 42; } static defaultUrl(): string { return "http:/\/localhost:8545"; } detectNetwork(): Promise { if (!this._cache["detectNetwork"]) { this._cache["detectNetwork"] = this._uncachedDetectNetwork(); // Clear this cache at the beginning of the next event loop setTimeout(() => { this._cache["detectNetwork"] = null; }, 0); } return this._cache["detectNetwork"]; } async _uncachedDetectNetwork(): Promise { await timer(0); let chainId = null; try { chainId = await this.send("eth_chainId", [ ]); } catch (error) { try { chainId = await this.send("net_version", [ ]); } catch (error) { } } if (chainId != null) { const getNetwork = getStatic<(network: Networkish) => Network>(this.constructor, "getNetwork"); try { return getNetwork(BigNumber.from(chainId).toNumber()); } catch (error) { return logger.throwError("could not detect network", Logger.errors.NETWORK_ERROR, { chainId: chainId, event: "invalidNetwork", serverError: error }); } } return logger.throwError("could not detect network", Logger.errors.NETWORK_ERROR, { event: "noNetwork" }); } getSigner(addressOrIndex?: string | number): JsonRpcSigner { return new JsonRpcSigner(_constructorGuard, this, addressOrIndex); } getUncheckedSigner(addressOrIndex?: string | number): UncheckedJsonRpcSigner { return this.getSigner(addressOrIndex).connectUnchecked(); } listAccounts(): Promise> { return this.send("eth_accounts", []).then((accounts: Array) => { return accounts.map((a) => this.formatter.address(a)); }); } send(method: string, params: Array): Promise { const request = { method: method, params: params, id: (this._nextId++), jsonrpc: "2.0" }; this.emit("debug", { action: "request", request: deepCopy(request), provider: this }); // We can expand this in the future to any call, but for now these // are the biggest wins and do not require any serializing parameters. const cache = ([ "eth_chainId", "eth_blockNumber" ].indexOf(method) >= 0); if (cache && this._cache[method]) { return this._cache[method]; } const result = fetchJson(this.connection, JSON.stringify(request), getResult).then((result) => { this.emit("debug", { action: "response", request: request, response: result, provider: this }); return result; }, (error) => { this.emit("debug", { action: "response", error: error, request: request, provider: this }); throw error; }); // Cache the fetch, but clear it on the next event loop if (cache) { this._cache[method] = result; setTimeout(() => { this._cache[method] = null; }, 0); } return result; } prepareRequest(method: string, params: any): [ string, Array ] { switch (method) { case "getBlockNumber": return [ "eth_blockNumber", [] ]; case "getGasPrice": return [ "eth_gasPrice", [] ]; case "getBalance": return [ "eth_getBalance", [ getLowerCase(params.address), params.blockTag ] ]; case "getTransactionCount": return [ "eth_getTransactionCount", [ getLowerCase(params.address), params.blockTag ] ]; case "getCode": return [ "eth_getCode", [ getLowerCase(params.address), params.blockTag ] ]; case "getStorageAt": return [ "eth_getStorageAt", [ getLowerCase(params.address), params.position, params.blockTag ] ]; case "sendTransaction": return [ "eth_sendRawTransaction", [ params.signedTransaction ] ] case "getBlock": if (params.blockTag) { return [ "eth_getBlockByNumber", [ params.blockTag, !!params.includeTransactions ] ]; } else if (params.blockHash) { return [ "eth_getBlockByHash", [ params.blockHash, !!params.includeTransactions ] ]; } return null; case "getTransaction": return [ "eth_getTransactionByHash", [ params.transactionHash ] ]; case "getTransactionReceipt": return [ "eth_getTransactionReceipt", [ params.transactionHash ] ]; case "call": { const hexlifyTransaction = getStatic<(t: TransactionRequest, a?: { [key: string]: boolean }) => { [key: string]: string }>(this.constructor, "hexlifyTransaction"); return [ "eth_call", [ hexlifyTransaction(params.transaction, { from: true }), params.blockTag ] ]; } case "estimateGas": { const hexlifyTransaction = getStatic<(t: TransactionRequest, a?: { [key: string]: boolean }) => { [key: string]: string }>(this.constructor, "hexlifyTransaction"); return [ "eth_estimateGas", [ hexlifyTransaction(params.transaction, { from: true }) ] ]; } case "getLogs": if (params.filter && params.filter.address != null) { params.filter.address = getLowerCase(params.filter.address); } return [ "eth_getLogs", [ params.filter ] ]; default: break; } return null; } async perform(method: string, params: any): Promise { const args = this.prepareRequest(method, params); if (args == null) { logger.throwError(method + " not implemented", Logger.errors.NOT_IMPLEMENTED, { operation: method }); } try { return await this.send(args[0], args[1]) } catch (error) { return checkError(method, error, params); } } _startEvent(event: Event): void { if (event.tag === "pending") { this._startPending(); } super._startEvent(event); } _startPending(): void { if (this._pendingFilter != null) { return; } const self = this; const pendingFilter: Promise = this.send("eth_newPendingTransactionFilter", []); this._pendingFilter = pendingFilter; pendingFilter.then(function(filterId) { function poll() { self.send("eth_getFilterChanges", [ filterId ]).then(function(hashes: Array) { if (self._pendingFilter != pendingFilter) { return null; } let seq = Promise.resolve(); hashes.forEach(function(hash) { // @TODO: This should be garbage collected at some point... How? When? self._emitted["t:" + hash.toLowerCase()] = "pending"; seq = seq.then(function() { return self.getTransaction(hash).then(function(tx) { self.emit("pending", tx); return null; }); }); }); return seq.then(function() { return timer(1000); }); }).then(function() { if (self._pendingFilter != pendingFilter) { self.send("eth_uninstallFilter", [ filterId ]); return; } setTimeout(function() { poll(); }, 0); return null; }).catch((error: Error) => { }); } poll(); return filterId; }).catch((error: Error) => { }); } _stopEvent(event: Event): void { if (event.tag === "pending" && this.listenerCount("pending") === 0) { this._pendingFilter = null; } super._stopEvent(event); } // Convert an ethers.js transaction into a JSON-RPC transaction // - gasLimit => gas // - All values hexlified // - All numeric values zero-striped // - All addresses are lowercased // NOTE: This allows a TransactionRequest, but all values should be resolved // before this is called // @TODO: This will likely be removed in future versions and prepareRequest // will be the preferred method for this. static hexlifyTransaction(transaction: TransactionRequest, allowExtra?: { [key: string]: boolean }): { [key: string]: string | AccessList } { // Check only allowed properties are given const allowed = shallowCopy(allowedTransactionKeys); if (allowExtra) { for (const key in allowExtra) { if (allowExtra[key]) { allowed[key] = true; } } } checkProperties(transaction, allowed); const result: { [key: string]: string | AccessList } = {}; // Some nodes (INFURA ropsten; INFURA mainnet is fine) do not like leading zeros. ["gasLimit", "gasPrice", "type", "nonce", "value"].forEach(function(key) { if ((transaction)[key] == null) { return; } const value = hexValue((transaction)[key]); if (key === "gasLimit") { key = "gas"; } result[key] = value; }); ["from", "to", "data"].forEach(function(key) { if ((transaction)[key] == null) { return; } result[key] = hexlify((transaction)[key]); }); if ((transaction).accessList) { result["accessList"] = accessListify((transaction).accessList); } return result; } }