517 lines
19 KiB
TypeScript
517 lines
19 KiB
TypeScript
import { getBuiltinCallException } from "../abi/index.js";
|
|
import { accessListify } from "../transaction/index.js";
|
|
import {
|
|
defineProperties,
|
|
hexlify, toQuantity,
|
|
FetchRequest,
|
|
assert, assertArgument,
|
|
toUtf8String
|
|
} from "../utils/index.js";
|
|
|
|
import { AbstractProvider } from "./abstract-provider.js";
|
|
import { Network } from "./network.js";
|
|
import { NetworkPlugin } from "./plugins-network.js";
|
|
import { showThrottleMessage } from "./community.js";
|
|
|
|
import { PerformActionRequest } from "./abstract-provider.js";
|
|
import type { Networkish } from "./network.js";
|
|
//import type { } from "./pagination";
|
|
import type { TransactionRequest } from "./provider.js";
|
|
|
|
const THROTTLE = 2000;
|
|
|
|
export type DebugEventEtherscanProvider = {
|
|
action: "sendRequest",
|
|
id: number,
|
|
url: string,
|
|
payload: Record<string, any>
|
|
} | {
|
|
action: "receiveRequest",
|
|
id: number,
|
|
result: any
|
|
} | {
|
|
action: "receiveError",
|
|
id: number,
|
|
error: any
|
|
};
|
|
|
|
const EtherscanPluginId = "org.ethers.plugins.etherscan";
|
|
|
|
export class EtherscanPlugin extends NetworkPlugin {
|
|
readonly baseUrl!: string;
|
|
readonly communityApiKey!: string;
|
|
|
|
constructor(baseUrl: string, communityApiKey: string) {
|
|
super(EtherscanPluginId);
|
|
//if (communityApiKey == null) { communityApiKey = null; }
|
|
defineProperties<EtherscanPlugin>(this, { baseUrl, communityApiKey });
|
|
}
|
|
|
|
clone(): EtherscanPlugin {
|
|
return new EtherscanPlugin(this.baseUrl, this.communityApiKey);
|
|
}
|
|
}
|
|
|
|
let nextId = 1;
|
|
|
|
export class BaseEtherscanProvider extends AbstractProvider {
|
|
readonly network!: Network;
|
|
readonly apiKey!: string;
|
|
|
|
readonly #plugin: null | EtherscanPlugin;
|
|
|
|
constructor(_network?: Networkish, apiKey?: string) {
|
|
super();
|
|
|
|
const network = Network.from(_network);
|
|
|
|
this.#plugin = network.getPlugin<EtherscanPlugin>(EtherscanPluginId);
|
|
|
|
if (apiKey == null && this.#plugin) {
|
|
apiKey = this.#plugin.communityApiKey;
|
|
}
|
|
|
|
defineProperties<BaseEtherscanProvider>(this, { apiKey, network });
|
|
|
|
// Test that the network is supported by Etherscan
|
|
this.getBaseUrl();
|
|
}
|
|
|
|
getBaseUrl(): string {
|
|
if (this.#plugin) { return this.#plugin.baseUrl; }
|
|
|
|
switch(this.network.name) {
|
|
case "mainnet":
|
|
return "https:/\/api.etherscan.io";
|
|
case "goerli":
|
|
return "https:/\/api-goerli.etherscan.io";
|
|
case "sepolia":
|
|
return "https:/\/api-sepolia.etherscan.io";
|
|
|
|
case "arbitrum":
|
|
return "https:/\/api.arbiscan.io";
|
|
case "arbitrum-goerli":
|
|
return "https:/\/api-goerli.arbiscan.io";
|
|
case "matic":
|
|
return "https:/\/api.polygonscan.com";
|
|
case "maticmum":
|
|
return "https:/\/api-testnet.polygonscan.com";
|
|
case "optimism":
|
|
return "https:/\/api-optimistic.etherscan.io";
|
|
case "optimism-goerli":
|
|
return "https:/\/api-goerli-optimistic.etherscan.io";
|
|
default:
|
|
}
|
|
|
|
assertArgument(false, "unsupported network", "network", this.network);
|
|
}
|
|
|
|
getUrl(module: string, params: Record<string, string>): string {
|
|
const query = Object.keys(params).reduce((accum, key) => {
|
|
const value = params[key];
|
|
if (value != null) {
|
|
accum += `&${ key }=${ value }`
|
|
}
|
|
return accum
|
|
}, "");
|
|
const apiKey = ((this.apiKey) ? `&apikey=${ this.apiKey }`: "");
|
|
return `${ this.getBaseUrl() }/api?module=${ module }${ query }${ apiKey }`;
|
|
}
|
|
|
|
getPostUrl(): string {
|
|
return `${ this.getBaseUrl() }/api`;
|
|
}
|
|
|
|
getPostData(module: string, params: Record<string, any>): Record<string, any> {
|
|
params.module = module;
|
|
params.apikey = this.apiKey;
|
|
return params;
|
|
}
|
|
|
|
async detectNetwork(): Promise<Network> {
|
|
return this.network;
|
|
}
|
|
|
|
async fetch(module: string, params: Record<string, any>, post?: boolean): Promise<any> {
|
|
const id = nextId++;
|
|
|
|
const url = (post ? this.getPostUrl(): this.getUrl(module, params));
|
|
const payload = (post ? this.getPostData(module, params): null);
|
|
|
|
this.emit("debug", { action: "sendRequest", id, url, payload: payload });
|
|
|
|
const request = new FetchRequest(url);
|
|
request.setThrottleParams({ slotInterval: 1000 });
|
|
request.retryFunc = (req, resp, attempt: number) => {
|
|
if (this.isCommunityResource()) {
|
|
showThrottleMessage("Etherscan");
|
|
}
|
|
return Promise.resolve(true);
|
|
};
|
|
request.processFunc = async (request, response) => {
|
|
const result = response.hasBody() ? JSON.parse(toUtf8String(response.body)): { };
|
|
const throttle = ((typeof(result.result) === "string") ? result.result: "").toLowerCase().indexOf("rate limit") >= 0;
|
|
if (module === "proxy") {
|
|
// This JSON response indicates we are being throttled
|
|
if (result && result.status == 0 && result.message == "NOTOK" && throttle) {
|
|
this.emit("debug", { action: "receiveError", id, reason: "proxy-NOTOK", error: result });
|
|
response.throwThrottleError(result.result, THROTTLE);
|
|
}
|
|
} else {
|
|
if (throttle) {
|
|
this.emit("debug", { action: "receiveError", id, reason: "null result", error: result.result });
|
|
response.throwThrottleError(result.result, THROTTLE);
|
|
}
|
|
}
|
|
return response;
|
|
};
|
|
|
|
if (payload) {
|
|
request.setHeader("content-type", "application/x-www-form-urlencoded; charset=UTF-8");
|
|
request.body = Object.keys(payload).map((k) => `${ k }=${ payload[k] }`).join("&");
|
|
}
|
|
|
|
const response = await request.send();
|
|
try {
|
|
response.assertOk();
|
|
} catch (error) {
|
|
this.emit("debug", { action: "receiveError", id, error, reason: "assertOk" });
|
|
}
|
|
|
|
if (!response.hasBody()) {
|
|
this.emit("debug", { action: "receiveError", id, error: "missing body", reason: "null body" });
|
|
throw new Error();
|
|
}
|
|
|
|
const result = JSON.parse(toUtf8String(response.body));
|
|
|
|
if (module === "proxy") {
|
|
if (result.jsonrpc != "2.0") {
|
|
this.emit("debug", { action: "receiveError", id, result, reason: "invalid JSON-RPC" });
|
|
|
|
const error: any = new Error("invalid response");
|
|
error.result = JSON.stringify(result);
|
|
throw error;
|
|
}
|
|
|
|
if (result.error) {
|
|
this.emit("debug", { action: "receiveError", id, result, reason: "JSON-RPC error" });
|
|
|
|
const error: any = new Error(result.error.message || "unknown error");
|
|
if (result.error.code) { error.code = result.error.code; }
|
|
if (result.error.data) { error.data = result.error.data; }
|
|
throw error;
|
|
}
|
|
|
|
this.emit("debug", { action: "receiveRequest", id, result });
|
|
|
|
return result.result;
|
|
|
|
} else {
|
|
// getLogs, getHistory have weird success responses
|
|
if (result.status == 0 && (result.message === "No records found" || result.message === "No transactions found")) {
|
|
this.emit("debug", { action: "receiveRequest", id, result });
|
|
return result.result;
|
|
}
|
|
|
|
if (result.status != 1 || (typeof(result.message) === "string" && !result.message.match(/^OK/))) {
|
|
this.emit("debug", { action: "receiveError", id, result });
|
|
|
|
const error: any = new Error("invalid response");
|
|
error.result = JSON.stringify(result);
|
|
// if ((result.result || "").toLowerCase().indexOf("rate limit") >= 0) {
|
|
// error.throttleRetry = true;
|
|
// }
|
|
throw error;
|
|
}
|
|
|
|
this.emit("debug", { action: "receiveRequest", id, result });
|
|
|
|
return result.result;
|
|
}
|
|
}
|
|
|
|
// The transaction has already been sanitized by the calls in Provider
|
|
_getTransactionPostData(transaction: TransactionRequest): Record<string, string> {
|
|
const result: Record<string, string> = { };
|
|
for (let key in transaction) {
|
|
if ((<any>transaction)[key] == null) { continue; }
|
|
let value = (<any>transaction)[key];
|
|
if (key === "type" && value === 0) { continue; }
|
|
|
|
// Quantity-types require no leading zero, unless 0
|
|
if ((<any>{ type: true, gasLimit: true, gasPrice: true, maxFeePerGs: true, maxPriorityFeePerGas: true, nonce: true, value: true })[key]) {
|
|
value = toQuantity(hexlify(value));
|
|
} else if (key === "accessList") {
|
|
value = "[" + accessListify(value).map((set) => {
|
|
return `{address:"${ set.address }",storageKeys:["${ set.storageKeys.join('","') }"]}`;
|
|
}).join(",") + "]";
|
|
} else {
|
|
value = hexlify(value);
|
|
}
|
|
result[key] = value;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
|
|
_checkError(req: PerformActionRequest, error: Error, transaction: any): never {
|
|
if (req.method === "call" || req.method === "estimateGas") {
|
|
if (error.message.match(/execution reverted/i)) {
|
|
const e = getBuiltinCallException(req.method, <any>req.transaction, (<any>error).data);
|
|
e.info = { request: req, error }
|
|
throw e;
|
|
}
|
|
}
|
|
/*
|
|
let body = "";
|
|
if (isError(error, Logger.Errors.SERVER_ERROR) && error.response && error.response.hasBody()) {
|
|
body = toUtf8String(error.response.body);
|
|
}
|
|
console.log(body);
|
|
|
|
// Undo the "convenience" some nodes are attempting to prevent backwards
|
|
// incompatibility; maybe for v6 consider forwarding reverts as errors
|
|
if (method === "call" && body) {
|
|
|
|
// Etherscan keeps changing their string
|
|
if (body.match(/reverted/i) || body.match(/VM execution error/i)) {
|
|
|
|
// Etherscan prefixes the data like "Reverted 0x1234"
|
|
let data = e.data;
|
|
if (data) { data = "0x" + data.replace(/^.*0x/i, ""); }
|
|
if (!isHexString(data)) { data = "0x"; }
|
|
|
|
logger.throwError("call exception", Logger.Errors.CALL_EXCEPTION, {
|
|
error, data
|
|
});
|
|
}
|
|
}
|
|
|
|
// Get the message from any nested error structure
|
|
let message = error.message;
|
|
if (isError(error, Logger.Errors.SERVER_ERROR)) {
|
|
if (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();
|
|
|
|
// "Insufficient funds. The account you tried to send transaction from
|
|
// does not have enough funds. Required 21464000000000 and got: 0"
|
|
if (message.match(/insufficient funds/)) {
|
|
logger.throwError("insufficient funds for intrinsic transaction cost", Logger.Errors.INSUFFICIENT_FUNDS, {
|
|
error, transaction, info: { method }
|
|
});
|
|
}
|
|
|
|
// "Transaction with the same hash was already imported."
|
|
if (message.match(/same hash was already imported|transaction nonce is too low|nonce too low/)) {
|
|
logger.throwError("nonce has already been used", Logger.Errors.NONCE_EXPIRED, {
|
|
error, transaction, info: { method }
|
|
});
|
|
}
|
|
|
|
// "Transaction gas price is too low. There is another transaction with
|
|
// same nonce in the queue. Try increasing the gas price or incrementing the nonce."
|
|
if (message.match(/another transaction with same nonce/)) {
|
|
logger.throwError("replacement fee too low", Logger.Errors.REPLACEMENT_UNDERPRICED, {
|
|
error, transaction, info: { method }
|
|
});
|
|
}
|
|
|
|
if (message.match(/execution failed due to an exception|execution reverted/)) {
|
|
logger.throwError("cannot estimate gas; transaction may fail or may require manual gas limit", Logger.Errors.UNPREDICTABLE_GAS_LIMIT, {
|
|
error, transaction, info: { method }
|
|
});
|
|
}
|
|
*/
|
|
throw error;
|
|
}
|
|
|
|
async _detectNetwork(): Promise<Network> {
|
|
return this.network;
|
|
}
|
|
|
|
async _perform(req: PerformActionRequest): Promise<any> {
|
|
switch (req.method) {
|
|
case "chainId":
|
|
return this.network.chainId;
|
|
|
|
case "getBlockNumber":
|
|
return this.fetch("proxy", { action: "eth_blockNumber" });
|
|
|
|
case "getGasPrice":
|
|
return this.fetch("proxy", { action: "eth_gasPrice" });
|
|
|
|
case "getBalance":
|
|
// Returns base-10 result
|
|
return this.fetch("account", {
|
|
action: "balance",
|
|
address: req.address,
|
|
tag: req.blockTag
|
|
});
|
|
|
|
case "getTransactionCount":
|
|
return this.fetch("proxy", {
|
|
action: "eth_getTransactionCount",
|
|
address: req.address,
|
|
tag: req.blockTag
|
|
});
|
|
|
|
case "getCode":
|
|
return this.fetch("proxy", {
|
|
action: "eth_getCode",
|
|
address: req.address,
|
|
tag: req.blockTag
|
|
});
|
|
|
|
case "getStorage":
|
|
return this.fetch("proxy", {
|
|
action: "eth_getStorageAt",
|
|
address: req.address,
|
|
position: req.position,
|
|
tag: req.blockTag
|
|
});
|
|
|
|
case "broadcastTransaction":
|
|
return this.fetch("proxy", {
|
|
action: "eth_sendRawTransaction",
|
|
hex: req.signedTransaction
|
|
}, true).catch((error) => {
|
|
return this._checkError(req, <Error>error, req.signedTransaction);
|
|
});
|
|
|
|
case "getBlock":
|
|
if ("blockTag" in req) {
|
|
return this.fetch("proxy", {
|
|
action: "eth_getBlockByNumber",
|
|
tag: req.blockTag,
|
|
boolean: (req.includeTransactions ? "true": "false")
|
|
});
|
|
}
|
|
|
|
assert(false, "getBlock by blockHash not supported by Etherscan", "UNSUPPORTED_OPERATION", {
|
|
operation: "getBlock(blockHash)"
|
|
});
|
|
|
|
case "getTransaction":
|
|
return this.fetch("proxy", {
|
|
action: "eth_getTransactionByHash",
|
|
txhash: req.hash
|
|
});
|
|
|
|
case "getTransactionReceipt":
|
|
return this.fetch("proxy", {
|
|
action: "eth_getTransactionReceipt",
|
|
txhash: req.hash
|
|
});
|
|
|
|
case "call": {
|
|
if (req.blockTag !== "latest") {
|
|
throw new Error("EtherscanProvider does not support blockTag for call");
|
|
}
|
|
|
|
const postData = this._getTransactionPostData(req.transaction);
|
|
postData.module = "proxy";
|
|
postData.action = "eth_call";
|
|
|
|
try {
|
|
return await this.fetch("proxy", postData, true);
|
|
} catch (error) {
|
|
return this._checkError(req, <Error>error, req.transaction);
|
|
}
|
|
}
|
|
|
|
case "estimateGas": {
|
|
const postData = this._getTransactionPostData(req.transaction);
|
|
postData.module = "proxy";
|
|
postData.action = "eth_estimateGas";
|
|
|
|
try {
|
|
return await this.fetch("proxy", postData, true);
|
|
} catch (error) {
|
|
return this._checkError(req, <Error>error, req.transaction);
|
|
}
|
|
}
|
|
/*
|
|
case "getLogs": {
|
|
// Needs to complain if more than one address is passed in
|
|
const args: Record<string, any> = { action: "getLogs" }
|
|
|
|
if (params.filter.fromBlock) {
|
|
args.fromBlock = checkLogTag(params.filter.fromBlock);
|
|
}
|
|
|
|
if (params.filter.toBlock) {
|
|
args.toBlock = checkLogTag(params.filter.toBlock);
|
|
}
|
|
|
|
if (params.filter.address) {
|
|
args.address = params.filter.address;
|
|
}
|
|
|
|
// @TODO: We can handle slightly more complicated logs using the logs API
|
|
if (params.filter.topics && params.filter.topics.length > 0) {
|
|
if (params.filter.topics.length > 1) {
|
|
logger.throwError("unsupported topic count", Logger.Errors.UNSUPPORTED_OPERATION, { topics: params.filter.topics });
|
|
}
|
|
if (params.filter.topics.length === 1) {
|
|
const topic0 = params.filter.topics[0];
|
|
if (typeof(topic0) !== "string" || topic0.length !== 66) {
|
|
logger.throwError("unsupported topic format", Logger.Errors.UNSUPPORTED_OPERATION, { topic0: topic0 });
|
|
}
|
|
args.topic0 = topic0;
|
|
}
|
|
}
|
|
|
|
const logs: Array<any> = await this.fetch("logs", args);
|
|
|
|
// Cache txHash => blockHash
|
|
let blocks: { [tag: string]: string } = {};
|
|
|
|
// Add any missing blockHash to the logs
|
|
for (let i = 0; i < logs.length; i++) {
|
|
const log = logs[i];
|
|
if (log.blockHash != null) { continue; }
|
|
if (blocks[log.blockNumber] == null) {
|
|
const block = await this.getBlock(log.blockNumber);
|
|
if (block) {
|
|
blocks[log.blockNumber] = block.hash;
|
|
}
|
|
}
|
|
|
|
log.blockHash = blocks[log.blockNumber];
|
|
}
|
|
|
|
return logs;
|
|
}
|
|
*/
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return super._perform(req);
|
|
}
|
|
|
|
async getNetwork(): Promise<Network> {
|
|
return this.network;
|
|
}
|
|
|
|
async getEtherPrice(): Promise<number> {
|
|
if (this.network.name !== "mainnet") { return 0.0; }
|
|
return parseFloat((await this.fetch("stats", { action: "ethprice" })).ethusd);
|
|
}
|
|
|
|
isCommunityResource(): boolean {
|
|
const plugin = this.network.getPlugin<EtherscanPlugin>(EtherscanPluginId);
|
|
if (plugin) { return (plugin.communityApiKey === this.apiKey); }
|
|
|
|
return (this.apiKey == null);
|
|
}
|
|
}
|