525 lines
21 KiB
JavaScript
525 lines
21 KiB
JavaScript
"use strict";
|
|
/**
|
|
* [[link-etherscan]] provides a third-party service for connecting to
|
|
* various blockchains over a combination of JSON-RPC and custom API
|
|
* endpoints.
|
|
*
|
|
* **Supported Networks**
|
|
*
|
|
* - Ethereum Mainnet (``mainnet``)
|
|
* - Goerli Testnet (``goerli``)
|
|
* - Sepolia Testnet (``sepolia``)
|
|
* - Arbitrum (``arbitrum``)
|
|
* - Arbitrum Goerli Testnet (``arbitrum-goerli``)
|
|
* - Optimism (``optimism``)
|
|
* - Optimism Goerli Testnet (``optimism-goerli``)
|
|
* - Polygon (``matic``)
|
|
* - Polygon Mumbai Testnet (``matic-mumbai``)
|
|
*
|
|
* @_subsection api/providers/thirdparty:Etherscan [providers-etherscan]
|
|
*/
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.EtherscanProvider = exports.EtherscanPlugin = void 0;
|
|
const index_js_1 = require("../abi/index.js");
|
|
const index_js_2 = require("../contract/index.js");
|
|
const index_js_3 = require("../transaction/index.js");
|
|
const index_js_4 = require("../utils/index.js");
|
|
const abstract_provider_js_1 = require("./abstract-provider.js");
|
|
const network_js_1 = require("./network.js");
|
|
const plugins_network_js_1 = require("./plugins-network.js");
|
|
const community_js_1 = require("./community.js");
|
|
const THROTTLE = 2000;
|
|
function isPromise(value) {
|
|
return (value && typeof (value.then) === "function");
|
|
}
|
|
const EtherscanPluginId = "org.ethers.plugins.provider.Etherscan";
|
|
/**
|
|
* A Network can include an **EtherscanPlugin** to provide
|
|
* a custom base URL.
|
|
*
|
|
* @_docloc: api/providers/thirdparty:Etherscan
|
|
*/
|
|
class EtherscanPlugin extends plugins_network_js_1.NetworkPlugin {
|
|
/**
|
|
* The Etherscan API base URL.
|
|
*/
|
|
baseUrl;
|
|
/**
|
|
* Creates a new **EtherscanProvider** which will use
|
|
* %%baseUrl%%.
|
|
*/
|
|
constructor(baseUrl) {
|
|
super(EtherscanPluginId);
|
|
(0, index_js_4.defineProperties)(this, { baseUrl });
|
|
}
|
|
clone() {
|
|
return new EtherscanPlugin(this.baseUrl);
|
|
}
|
|
}
|
|
exports.EtherscanPlugin = EtherscanPlugin;
|
|
const skipKeys = ["enableCcipRead"];
|
|
let nextId = 1;
|
|
/**
|
|
* The **EtherscanBaseProvider** is the super-class of
|
|
* [[EtherscanProvider]], which should generally be used instead.
|
|
*
|
|
* Since the **EtherscanProvider** includes additional code for
|
|
* [[Contract]] access, in //rare cases// that contracts are not
|
|
* used, this class can reduce code size.
|
|
*
|
|
* @_docloc: api/providers/thirdparty:Etherscan
|
|
*/
|
|
class EtherscanProvider extends abstract_provider_js_1.AbstractProvider {
|
|
/**
|
|
* The connected network.
|
|
*/
|
|
network;
|
|
/**
|
|
* The API key or null if using the community provided bandwidth.
|
|
*/
|
|
apiKey;
|
|
#plugin;
|
|
/**
|
|
* Creates a new **EtherscanBaseProvider**.
|
|
*/
|
|
constructor(_network, _apiKey) {
|
|
const apiKey = (_apiKey != null) ? _apiKey : null;
|
|
super();
|
|
const network = network_js_1.Network.from(_network);
|
|
this.#plugin = network.getPlugin(EtherscanPluginId);
|
|
(0, index_js_4.defineProperties)(this, { apiKey, network });
|
|
// Test that the network is supported by Etherscan
|
|
this.getBaseUrl();
|
|
}
|
|
/**
|
|
* Returns the base URL.
|
|
*
|
|
* If an [[EtherscanPlugin]] is configured on the
|
|
* [[EtherscanBaseProvider_network]], returns the plugin's
|
|
* baseUrl.
|
|
*/
|
|
getBaseUrl() {
|
|
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 "matic-mumbai":
|
|
return "https:/\/api-testnet.polygonscan.com";
|
|
case "optimism":
|
|
return "https:/\/api-optimistic.etherscan.io";
|
|
case "optimism-goerli":
|
|
return "https:/\/api-goerli-optimistic.etherscan.io";
|
|
case "bnb":
|
|
return "http:/\/api.bscscan.com";
|
|
case "bnbt":
|
|
return "http:/\/api-testnet.bscscan.com";
|
|
default:
|
|
}
|
|
(0, index_js_4.assertArgument)(false, "unsupported network", "network", this.network);
|
|
}
|
|
/**
|
|
* Returns the URL for the %%module%% and %%params%%.
|
|
*/
|
|
getUrl(module, params) {
|
|
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}`;
|
|
}
|
|
/**
|
|
* Returns the URL for using POST requests.
|
|
*/
|
|
getPostUrl() {
|
|
return `${this.getBaseUrl()}/api`;
|
|
}
|
|
/**
|
|
* Returns the parameters for using POST requests.
|
|
*/
|
|
getPostData(module, params) {
|
|
params.module = module;
|
|
params.apikey = this.apiKey;
|
|
return params;
|
|
}
|
|
async detectNetwork() {
|
|
return this.network;
|
|
}
|
|
/**
|
|
* Resolves to the result of calling %%module%% with %%params%%.
|
|
*
|
|
* If %%post%%, the request is made as a POST request.
|
|
*/
|
|
async fetch(module, params, post) {
|
|
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 index_js_4.FetchRequest(url);
|
|
request.setThrottleParams({ slotInterval: 1000 });
|
|
request.retryFunc = (req, resp, attempt) => {
|
|
if (this.isCommunityResource()) {
|
|
(0, community_js_1.showThrottleMessage)("Etherscan");
|
|
}
|
|
return Promise.resolve(true);
|
|
};
|
|
request.processFunc = async (request, response) => {
|
|
const result = response.hasBody() ? JSON.parse((0, index_js_4.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" });
|
|
(0, index_js_4.assert)(false, "response error", "SERVER_ERROR", { request, response });
|
|
}
|
|
if (!response.hasBody()) {
|
|
this.emit("debug", { action: "receiveError", id, error: "missing body", reason: "null body" });
|
|
(0, index_js_4.assert)(false, "missing response", "SERVER_ERROR", { request, response });
|
|
}
|
|
const result = JSON.parse((0, index_js_4.toUtf8String)(response.body));
|
|
if (module === "proxy") {
|
|
if (result.jsonrpc != "2.0") {
|
|
this.emit("debug", { action: "receiveError", id, result, reason: "invalid JSON-RPC" });
|
|
(0, index_js_4.assert)(false, "invalid JSON-RPC response (missing jsonrpc='2.0')", "SERVER_ERROR", { request, response, info: { result } });
|
|
}
|
|
if (result.error) {
|
|
this.emit("debug", { action: "receiveError", id, result, reason: "JSON-RPC error" });
|
|
(0, index_js_4.assert)(false, "error response", "SERVER_ERROR", { request, response, info: { result } });
|
|
}
|
|
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 });
|
|
(0, index_js_4.assert)(false, "error response", "SERVER_ERROR", { request, response, info: { result } });
|
|
}
|
|
this.emit("debug", { action: "receiveRequest", id, result });
|
|
return result.result;
|
|
}
|
|
}
|
|
/**
|
|
* Returns %%transaction%% normalized for the Etherscan API.
|
|
*/
|
|
_getTransactionPostData(transaction) {
|
|
const result = {};
|
|
for (let key in transaction) {
|
|
if (skipKeys.indexOf(key) >= 0) {
|
|
continue;
|
|
}
|
|
if (transaction[key] == null) {
|
|
continue;
|
|
}
|
|
let value = transaction[key];
|
|
if (key === "type" && value === 0) {
|
|
continue;
|
|
}
|
|
if (key === "blockTag" && value === "latest") {
|
|
continue;
|
|
}
|
|
// Quantity-types require no leading zero, unless 0
|
|
if ({ type: true, gasLimit: true, gasPrice: true, maxFeePerGs: true, maxPriorityFeePerGas: true, nonce: true, value: true }[key]) {
|
|
value = (0, index_js_4.toQuantity)(value);
|
|
}
|
|
else if (key === "accessList") {
|
|
value = "[" + (0, index_js_3.accessListify)(value).map((set) => {
|
|
return `{address:"${set.address}",storageKeys:["${set.storageKeys.join('","')}"]}`;
|
|
}).join(",") + "]";
|
|
}
|
|
else {
|
|
value = (0, index_js_4.hexlify)(value);
|
|
}
|
|
result[key] = value;
|
|
}
|
|
return result;
|
|
}
|
|
/**
|
|
* Throws the normalized Etherscan error.
|
|
*/
|
|
_checkError(req, error, transaction) {
|
|
// Pull any message out if, possible
|
|
let message = "";
|
|
if ((0, index_js_4.isError)(error, "SERVER_ERROR")) {
|
|
// Check for an error emitted by a proxy call
|
|
try {
|
|
message = error.info.result.error.message;
|
|
}
|
|
catch (e) { }
|
|
if (!message) {
|
|
try {
|
|
message = error.info.message;
|
|
}
|
|
catch (e) { }
|
|
}
|
|
}
|
|
if (req.method === "estimateGas") {
|
|
if (!message.match(/revert/i) && message.match(/insufficient funds/i)) {
|
|
(0, index_js_4.assert)(false, "insufficient funds", "INSUFFICIENT_FUNDS", {
|
|
transaction: req.transaction
|
|
});
|
|
}
|
|
}
|
|
if (req.method === "call" || req.method === "estimateGas") {
|
|
if (message.match(/execution reverted/i)) {
|
|
let data = "";
|
|
try {
|
|
data = error.info.result.error.data;
|
|
}
|
|
catch (error) { }
|
|
const e = index_js_1.AbiCoder.getBuiltinCallException(req.method, req.transaction, data);
|
|
e.info = { request: req, error };
|
|
throw e;
|
|
}
|
|
}
|
|
if (message) {
|
|
if (req.method === "broadcastTransaction") {
|
|
const transaction = index_js_3.Transaction.from(req.signedTransaction);
|
|
if (message.match(/replacement/i) && message.match(/underpriced/i)) {
|
|
(0, index_js_4.assert)(false, "replacement fee too low", "REPLACEMENT_UNDERPRICED", {
|
|
transaction
|
|
});
|
|
}
|
|
if (message.match(/insufficient funds/)) {
|
|
(0, index_js_4.assert)(false, "insufficient funds for intrinsic transaction cost", "INSUFFICIENT_FUNDS", {
|
|
transaction
|
|
});
|
|
}
|
|
if (message.match(/same hash was already imported|transaction nonce is too low|nonce too low/)) {
|
|
(0, index_js_4.assert)(false, "nonce has already been used", "NONCE_EXPIRED", {
|
|
transaction
|
|
});
|
|
}
|
|
}
|
|
}
|
|
// Something we could not process
|
|
throw error;
|
|
}
|
|
async _detectNetwork() {
|
|
return this.network;
|
|
}
|
|
async _perform(req) {
|
|
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, req.signedTransaction);
|
|
});
|
|
case "getBlock":
|
|
if ("blockTag" in req) {
|
|
return this.fetch("proxy", {
|
|
action: "eth_getBlockByNumber",
|
|
tag: req.blockTag,
|
|
boolean: (req.includeTransactions ? "true" : "false")
|
|
});
|
|
}
|
|
(0, index_js_4.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, 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, 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() {
|
|
return this.network;
|
|
}
|
|
/**
|
|
* Resolves to the current price of ether.
|
|
*
|
|
* This returns ``0`` on any network other than ``mainnet``.
|
|
*/
|
|
async getEtherPrice() {
|
|
if (this.network.name !== "mainnet") {
|
|
return 0.0;
|
|
}
|
|
return parseFloat((await this.fetch("stats", { action: "ethprice" })).ethusd);
|
|
}
|
|
/**
|
|
* Resolves to a [Contract]] for %%address%%, using the
|
|
* Etherscan API to retreive the Contract ABI.
|
|
*/
|
|
async getContract(_address) {
|
|
let address = this._getAddress(_address);
|
|
if (isPromise(address)) {
|
|
address = await address;
|
|
}
|
|
try {
|
|
const resp = await this.fetch("contract", {
|
|
action: "getabi", address
|
|
});
|
|
const abi = JSON.parse(resp);
|
|
return new index_js_2.Contract(address, abi, this);
|
|
}
|
|
catch (error) {
|
|
return null;
|
|
}
|
|
}
|
|
isCommunityResource() {
|
|
return (this.apiKey == null);
|
|
}
|
|
}
|
|
exports.EtherscanProvider = EtherscanProvider;
|
|
//# sourceMappingURL=provider-etherscan.js.map
|