ethers.js/lib.commonjs/providers/provider-jsonrpc.js

893 lines
36 KiB
JavaScript
Raw Permalink Normal View History

2022-09-05 16:57:11 -04:00
"use strict";
2022-11-30 15:44:23 -05:00
/**
* About JSON-RPC...
*
* @_section: api/providers/jsonrpc:JSON-RPC Provider [about-jsonrpcProvider]
*/
2022-09-05 16:57:11 -04:00
Object.defineProperty(exports, "__esModule", { value: true });
2022-10-20 05:03:32 -04:00
exports.JsonRpcProvider = exports.JsonRpcApiPollingProvider = exports.JsonRpcApiProvider = exports.JsonRpcSigner = void 0;
2022-11-30 15:44:23 -05:00
// @TODO:
// - Add the batching API
2022-09-05 16:57:11 -04:00
// https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/ethereum/eth1.0-apis/assembled-spec/openrpc.json&uiSchema%5BappBar%5D%5Bui:splitView%5D=true&uiSchema%5BappBar%5D%5Bui:input%5D=false&uiSchema%5BappBar%5D%5Bui:examplesDropdown%5D=false
2022-10-20 05:03:32 -04:00
const index_js_1 = require("../abi/index.js");
const index_js_2 = require("../address/index.js");
const index_js_3 = require("../hash/index.js");
const index_js_4 = require("../transaction/index.js");
const index_js_5 = require("../utils/index.js");
2022-09-05 16:57:11 -04:00
const abstract_provider_js_1 = require("./abstract-provider.js");
const abstract_signer_js_1 = require("./abstract-signer.js");
const network_js_1 = require("./network.js");
const subscriber_filterid_js_1 = require("./subscriber-filterid.js");
const Primitive = "bigint,boolean,function,number,string,symbol".split(/,/g);
//const Methods = "getAddress,then".split(/,/g);
function deepCopy(value) {
if (value == null || Primitive.indexOf(typeof (value)) >= 0) {
return value;
}
// Keep any Addressable
if (typeof (value.getAddress) === "function") {
return value;
}
if (Array.isArray(value)) {
return (value.map(deepCopy));
}
if (typeof (value) === "object") {
return Object.keys(value).reduce((accum, key) => {
accum[key] = value[key];
return accum;
}, {});
}
throw new Error(`should not happen: ${value} (${typeof (value)})`);
}
2022-09-27 03:45:27 -04:00
function stall(duration) {
return new Promise((resolve) => { setTimeout(resolve, duration); });
}
2022-09-05 16:57:11 -04:00
function getLowerCase(value) {
if (value) {
return value.toLowerCase();
}
return value;
}
function isPollable(value) {
return (value && typeof (value.pollingInterval) === "number");
}
const defaultOptions = {
polling: false,
staticNetwork: null,
batchStallTime: 10,
batchMaxSize: (1 << 20),
batchMaxCount: 100 // 100 requests
};
// @TODO: Unchecked Signers
class JsonRpcSigner extends abstract_signer_js_1.AbstractSigner {
address;
constructor(provider, address) {
super(provider);
2022-10-20 05:03:32 -04:00
(0, index_js_5.defineProperties)(this, { address });
2022-09-05 16:57:11 -04:00
}
connect(provider) {
2022-11-09 02:57:02 -05:00
(0, index_js_5.assert)(false, "cannot reconnect JsonRpcSigner", "UNSUPPORTED_OPERATION", {
2022-09-05 16:57:11 -04:00
operation: "signer.connect"
});
}
async getAddress() {
return this.address;
}
// JSON-RPC will automatially fill in nonce, etc. so we just check from
async populateTransaction(tx) {
return await this.populateCall(tx);
}
// Returns just the hash of the transaction after sent, which is what
// the bare JSON-RPC API does;
async sendUncheckedTransaction(_tx) {
const tx = deepCopy(_tx);
const promises = [];
// Make sure the from matches the sender
if (tx.from) {
const _from = tx.from;
promises.push((async () => {
2022-10-20 05:03:32 -04:00
const from = await (0, index_js_2.resolveAddress)(_from, this.provider);
2022-11-09 02:57:02 -05:00
(0, index_js_5.assertArgument)(from != null && from.toLowerCase() === this.address.toLowerCase(), "from address mismatch", "transaction", _tx);
2022-09-05 16:57:11 -04:00
tx.from = from;
})());
}
else {
tx.from = this.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 (tx.gasLimit == null) {
promises.push((async () => {
tx.gasLimit = await this.provider.estimateGas({ ...tx, from: this.address });
})());
}
// The address may be an ENS name or Addressable
if (tx.to != null) {
const _to = tx.to;
promises.push((async () => {
2022-10-20 05:03:32 -04:00
tx.to = await (0, index_js_2.resolveAddress)(_to, this.provider);
2022-09-05 16:57:11 -04:00
})());
}
// Wait until all of our properties are filled in
if (promises.length) {
await Promise.all(promises);
}
const hexTx = this.provider.getRpcTransaction(tx);
return this.provider.send("eth_sendTransaction", [hexTx]);
}
async sendTransaction(tx) {
// This cannot be mined any earlier than any recent block
const blockNumber = await this.provider.getBlockNumber();
// Send the transaction
const hash = await this.sendUncheckedTransaction(tx);
// Unfortunately, JSON-RPC only provides and opaque transaction hash
// for a response, and we need the actual transaction, so we poll
// for it; it should show up very quickly
return await (new Promise((resolve, reject) => {
const timeouts = [1000, 100];
const checkTx = async () => {
// Try getting the transaction
const tx = await this.provider.getTransaction(hash);
if (tx != null) {
2022-09-27 03:45:27 -04:00
resolve(tx.replaceableTransaction(blockNumber));
2022-09-05 16:57:11 -04:00
return;
}
// Wait another 4 seconds
this.provider._setTimeout(() => { checkTx(); }, timeouts.pop() || 4000);
};
checkTx();
}));
}
async signTransaction(_tx) {
const tx = deepCopy(_tx);
// Make sure the from matches the sender
if (tx.from) {
2022-10-20 05:03:32 -04:00
const from = await (0, index_js_2.resolveAddress)(tx.from, this.provider);
2022-11-09 02:57:02 -05:00
(0, index_js_5.assertArgument)(from != null && from.toLowerCase() === this.address.toLowerCase(), "from address mismatch", "transaction", _tx);
2022-09-05 16:57:11 -04:00
tx.from = from;
}
else {
tx.from = this.address;
}
const hexTx = this.provider.getRpcTransaction(tx);
2022-10-20 05:03:32 -04:00
return await this.provider.send("eth_signTransaction", [hexTx]);
2022-09-05 16:57:11 -04:00
}
async signMessage(_message) {
2022-10-20 05:03:32 -04:00
const message = ((typeof (_message) === "string") ? (0, index_js_5.toUtf8Bytes)(_message) : _message);
2022-09-05 16:57:11 -04:00
return await this.provider.send("personal_sign", [
2022-10-20 05:03:32 -04:00
(0, index_js_5.hexlify)(message), this.address.toLowerCase()
2022-09-05 16:57:11 -04:00
]);
}
async signTypedData(domain, types, _value) {
const value = deepCopy(_value);
// Populate any ENS names (in-place)
2022-10-20 05:03:32 -04:00
const populated = await index_js_3.TypedDataEncoder.resolveNames(domain, types, value, async (value) => {
const address = await (0, index_js_2.resolveAddress)(value);
2022-11-09 02:57:02 -05:00
(0, index_js_5.assertArgument)(address != null, "TypedData does not support null address", "value", value);
2022-09-05 16:57:11 -04:00
return address;
});
return await this.provider.send("eth_signTypedData_v4", [
this.address.toLowerCase(),
2022-10-20 05:03:32 -04:00
JSON.stringify(index_js_3.TypedDataEncoder.getPayload(populated.domain, types, populated.value))
2022-09-05 16:57:11 -04:00
]);
}
async unlock(password) {
return this.provider.send("personal_unlockAccount", [
this.address.toLowerCase(), password, null
]);
}
// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
async _legacySignMessage(_message) {
2022-10-20 05:03:32 -04:00
const message = ((typeof (_message) === "string") ? (0, index_js_5.toUtf8Bytes)(_message) : _message);
2022-09-05 16:57:11 -04:00
return await this.provider.send("eth_sign", [
2022-10-20 05:03:32 -04:00
this.address.toLowerCase(), (0, index_js_5.hexlify)(message)
2022-09-05 16:57:11 -04:00
]);
}
}
exports.JsonRpcSigner = JsonRpcSigner;
2022-09-15 22:58:45 -04:00
/**
* The JsonRpcApiProvider is an abstract class and **MUST** be
* sub-classed.
*
* It provides the base for all JSON-RPC-based Provider interaction.
2022-09-27 03:45:27 -04:00
*
* Sub-classing Notes:
* - a sub-class MUST override _send
* - a sub-class MUST call the `_start()` method once connected
2022-09-15 22:58:45 -04:00
*/
2022-09-05 16:57:11 -04:00
class JsonRpcApiProvider extends abstract_provider_js_1.AbstractProvider {
#options;
2022-09-29 22:57:27 -04:00
// The next ID to use for the JSON-RPC ID field
2022-09-05 16:57:11 -04:00
#nextId;
2022-09-29 22:57:27 -04:00
// Payloads are queued and triggered in batches using the drainTimer
2022-09-05 16:57:11 -04:00
#payloads;
#drainTimer;
2022-09-29 22:57:27 -04:00
#notReady;
2022-09-27 03:45:27 -04:00
#network;
2022-09-05 16:57:11 -04:00
#scheduleDrain() {
2022-09-29 22:57:27 -04:00
if (this.#drainTimer) {
2022-09-05 16:57:11 -04:00
return;
}
2022-09-15 22:58:45 -04:00
// If we aren't using batching, no hard in sending it immeidately
const stallTime = (this._getOption("batchMaxCount") === 1) ? 0 : this._getOption("batchStallTime");
2022-09-05 16:57:11 -04:00
this.#drainTimer = setTimeout(() => {
this.#drainTimer = null;
const payloads = this.#payloads;
this.#payloads = [];
while (payloads.length) {
// Create payload batches that satisfy our batch constraints
const batch = [(payloads.shift())];
while (payloads.length) {
if (batch.length === this.#options.batchMaxCount) {
break;
}
batch.push((payloads.shift()));
const bytes = JSON.stringify(batch.map((p) => p.payload));
if (bytes.length > this.#options.batchMaxSize) {
payloads.unshift((batch.pop()));
break;
}
}
// Process the result to each payload
(async () => {
const payload = ((batch.length === 1) ? batch[0].payload : batch.map((p) => p.payload));
this.emit("debug", { action: "sendRpcPayload", payload });
try {
const result = await this._send(payload);
this.emit("debug", { action: "receiveRpcResult", result });
// Process results in batch order
for (const { resolve, reject, payload } of batch) {
// Find the matching result
const resp = result.filter((r) => (r.id === payload.id))[0];
// No result; the node failed us in unexpected ways
if (resp == null) {
return reject(new Error("@TODO: no result"));
}
// The response is an error
if ("error" in resp) {
return reject(this.getRpcError(payload, resp));
}
// All good; send the result
resolve(resp.result);
}
}
catch (error) {
this.emit("debug", { action: "receiveRpcError", error });
for (const { reject } of batch) {
// @TODO: augment the error with the payload
reject(error);
}
}
})();
}
2022-09-15 22:58:45 -04:00
}, stallTime);
2022-09-05 16:57:11 -04:00
}
2022-09-29 22:57:27 -04:00
constructor(network, options) {
super(network);
this.#nextId = 1;
this.#options = Object.assign({}, defaultOptions, options || {});
this.#payloads = [];
this.#drainTimer = null;
this.#network = null;
{
let resolve = null;
const promise = new Promise((_resolve) => {
resolve = _resolve;
});
this.#notReady = { promise, resolve };
}
// This could be relaxed in the future to just check equivalent networks
const staticNetwork = this._getOption("staticNetwork");
if (staticNetwork) {
2022-11-09 02:57:02 -05:00
(0, index_js_5.assertArgument)(staticNetwork === network, "staticNetwork MUST match network object", "options", options);
2022-09-29 22:57:27 -04:00
this.#network = staticNetwork;
}
}
2022-09-15 22:58:45 -04:00
/**
2022-09-29 22:57:27 -04:00
* Returns the value associated with the option %%key%%.
2022-09-15 22:58:45 -04:00
*
2022-09-29 22:57:27 -04:00
* Sub-classes can use this to inquire about configuration options.
2022-09-15 22:58:45 -04:00
*/
2022-09-29 22:57:27 -04:00
_getOption(key) {
return this.#options[key];
}
/**
* Gets the [[Network]] this provider has committed to. On each call, the network
* is detected, and if it has changed, the call will reject.
*/
get _network() {
2022-11-09 02:57:02 -05:00
(0, index_js_5.assert)(this.#network, "network is not available yet", "NETWORK_ERROR");
2022-09-29 22:57:27 -04:00
return this.#network;
2022-09-05 16:57:11 -04:00
}
2022-11-30 15:44:23 -05:00
/*
{
assert(false, "sub-classes must override _send", "UNSUPPORTED_OPERATION", {
2022-09-05 16:57:11 -04:00
operation: "jsonRpcApiProvider._send"
});
}
2022-11-30 15:44:23 -05:00
*/
2022-09-15 22:58:45 -04:00
/**
2022-09-29 22:57:27 -04:00
* Resolves to the non-normalized value by performing %%req%%.
2022-09-15 22:58:45 -04:00
*
2022-09-29 22:57:27 -04:00
* Sub-classes may override this to modify behavior of actions,
* and should generally call ``super._perform`` as a fallback.
2022-09-15 22:58:45 -04:00
*/
2022-09-29 22:57:27 -04:00
async _perform(req) {
// Legacy networks do not like the type field being passed along (which
// is fair), so we delete type if it is 0 and a non-EIP-1559 network
if (req.method === "call" || req.method === "estimateGas") {
let tx = req.transaction;
2022-10-20 05:03:32 -04:00
if (tx && tx.type != null && (0, index_js_5.getBigInt)(tx.type)) {
2022-09-29 22:57:27 -04:00
// If there are no EIP-1559 properties, it might be non-EIP-a559
if (tx.maxFeePerGas == null && tx.maxPriorityFeePerGas == null) {
const feeData = await this.getFeeData();
if (feeData.maxFeePerGas == null && feeData.maxPriorityFeePerGas == null) {
// Network doesn't know about EIP-1559 (and hence type)
req = Object.assign({}, req, {
transaction: Object.assign({}, tx, { type: undefined })
});
}
}
2022-09-05 16:57:11 -04:00
}
}
2022-09-29 22:57:27 -04:00
const request = this.getRpcRequest(req);
if (request != null) {
return await this.send(request.method, request.args);
2022-09-05 16:57:11 -04:00
}
2022-09-29 22:57:27 -04:00
return super._perform(req);
2022-09-05 16:57:11 -04:00
}
2022-11-30 15:44:23 -05:00
/**
* Sub-classes may override this; it detects the *actual* network that
2022-09-27 03:45:27 -04:00
* we are **currently** connected to.
*
2022-09-29 22:57:27 -04:00
* Keep in mind that [[send]] may only be used once [[ready]], otherwise the
* _send primitive must be used instead.
2022-09-27 03:45:27 -04:00
*/
2022-09-05 16:57:11 -04:00
async _detectNetwork() {
const network = this._getOption("staticNetwork");
if (network) {
return network;
}
2022-09-27 03:45:27 -04:00
// If we are ready, use ``send``, which enabled requests to be batched
if (this.ready) {
2022-10-20 05:03:32 -04:00
return network_js_1.Network.from((0, index_js_5.getBigInt)(await this.send("eth_chainId", [])));
2022-09-27 03:45:27 -04:00
}
// We are not ready yet; use the primitive _send
const payload = {
id: this.#nextId++, method: "eth_chainId", params: [], jsonrpc: "2.0"
};
this.emit("debug", { action: "sendRpcPayload", payload });
2022-09-29 22:57:27 -04:00
let result;
try {
result = (await this._send(payload))[0];
}
catch (error) {
this.emit("debug", { action: "receiveRpcError", error });
throw error;
}
2022-09-27 03:45:27 -04:00
this.emit("debug", { action: "receiveRpcResult", result });
if ("result" in result) {
2022-10-20 05:03:32 -04:00
return network_js_1.Network.from((0, index_js_5.getBigInt)(result.result));
2022-09-27 03:45:27 -04:00
}
throw this.getRpcError(payload, result);
2022-09-15 22:58:45 -04:00
}
2022-09-29 22:57:27 -04:00
/**
* Sub-classes **MUST** call this. Until [[_start]] has been called, no calls
* will be passed to [[_send]] from [[send]]. If it is overridden, then
* ``super._start()`` **MUST** be called.
*
* Calling it multiple times is safe and has no effect.
*/
_start() {
if (this.#notReady == null || this.#notReady.resolve == null) {
return;
}
this.#notReady.resolve();
this.#notReady = null;
(async () => {
// Bootstrap the network
while (this.#network == null) {
try {
this.#network = await this._detectNetwork();
}
catch (error) {
console.log("JsonRpcProvider failed to startup; retry in 1s");
await stall(1000);
}
}
// Start dispatching requests
this.#scheduleDrain();
})();
}
/**
* Resolves once the [[_start]] has been called. This can be used in
* sub-classes to defer sending data until the connection has been
* established.
*/
async _waitUntilReady() {
if (this.#notReady == null) {
return;
}
return await this.#notReady.promise;
}
2022-09-15 22:58:45 -04:00
/**
* Return a Subscriber that will manage the %%sub%%.
*
2022-09-29 22:57:27 -04:00
* Sub-classes may override this to modify the behavior of
2022-09-15 22:58:45 -04:00
* subscription management.
*/
2022-09-05 16:57:11 -04:00
_getSubscriber(sub) {
// Pending Filters aren't availble via polling
if (sub.type === "pending") {
return new subscriber_filterid_js_1.FilterIdPendingSubscriber(this);
}
if (sub.type === "event") {
return new subscriber_filterid_js_1.FilterIdEventSubscriber(this, sub.filter);
}
// Orphaned Logs are handled automatically, by the filter, since
// logs with removed are emitted by it
if (sub.type === "orphan" && sub.filter.orphan === "drop-log") {
return new abstract_provider_js_1.UnmanagedSubscriber("orphan");
}
return super._getSubscriber(sub);
}
2022-09-29 22:57:27 -04:00
/**
* Returns true only if the [[_start]] has been called.
*/
get ready() { return this.#notReady == null; }
2022-09-15 22:58:45 -04:00
/**
* Returns %%tx%% as a normalized JSON-RPC transaction request,
* which has all values hexlified and any numeric values converted
* to Quantity values.
*/
2022-09-05 16:57:11 -04:00
getRpcTransaction(tx) {
const result = {};
// JSON-RPC now requires numeric values to be "quantity" values
["chainId", "gasLimit", "gasPrice", "type", "maxFeePerGas", "maxPriorityFeePerGas", "nonce", "value"].forEach((key) => {
if (tx[key] == null) {
return;
}
let dstKey = key;
if (key === "gasLimit") {
dstKey = "gas";
}
2022-10-20 05:03:32 -04:00
result[dstKey] = (0, index_js_5.toQuantity)((0, index_js_5.getBigInt)(tx[key], `tx.${key}`));
2022-09-05 16:57:11 -04:00
});
// Make sure addresses and data are lowercase
["from", "to", "data"].forEach((key) => {
if (tx[key] == null) {
return;
}
2022-10-20 05:03:32 -04:00
result[key] = (0, index_js_5.hexlify)(tx[key]);
2022-09-05 16:57:11 -04:00
});
// Normalize the access list object
if (tx.accessList) {
2022-10-20 05:03:32 -04:00
result["accessList"] = (0, index_js_4.accessListify)(tx.accessList);
2022-09-05 16:57:11 -04:00
}
return result;
}
2022-09-15 22:58:45 -04:00
/**
* Returns the request method and arguments required to perform
* %%req%%.
*/
2022-09-05 16:57:11 -04:00
getRpcRequest(req) {
switch (req.method) {
case "chainId":
return { method: "eth_chainId", args: [] };
case "getBlockNumber":
return { method: "eth_blockNumber", args: [] };
case "getGasPrice":
return { method: "eth_gasPrice", args: [] };
case "getBalance":
return {
method: "eth_getBalance",
args: [getLowerCase(req.address), req.blockTag]
};
case "getTransactionCount":
return {
method: "eth_getTransactionCount",
args: [getLowerCase(req.address), req.blockTag]
};
case "getCode":
return {
method: "eth_getCode",
args: [getLowerCase(req.address), req.blockTag]
};
2022-09-29 22:57:27 -04:00
case "getStorage":
2022-09-05 16:57:11 -04:00
return {
method: "eth_getStorageAt",
args: [
getLowerCase(req.address),
("0x" + req.position.toString(16)),
req.blockTag
]
};
case "broadcastTransaction":
return {
method: "eth_sendRawTransaction",
args: [req.signedTransaction]
};
case "getBlock":
if ("blockTag" in req) {
return {
method: "eth_getBlockByNumber",
args: [req.blockTag, !!req.includeTransactions]
};
}
else if ("blockHash" in req) {
return {
method: "eth_getBlockByHash",
args: [req.blockHash, !!req.includeTransactions]
};
}
break;
case "getTransaction":
return {
method: "eth_getTransactionByHash",
args: [req.hash]
};
case "getTransactionReceipt":
return {
method: "eth_getTransactionReceipt",
args: [req.hash]
};
case "call":
return {
method: "eth_call",
args: [this.getRpcTransaction(req.transaction), req.blockTag]
};
case "estimateGas": {
return {
method: "eth_estimateGas",
args: [this.getRpcTransaction(req.transaction)]
};
}
case "getLogs":
if (req.filter && req.filter.address != null) {
if (Array.isArray(req.filter.address)) {
req.filter.address = req.filter.address.map(getLowerCase);
}
else {
req.filter.address = getLowerCase(req.filter.address);
}
}
return { method: "eth_getLogs", args: [req.filter] };
}
return null;
}
2022-09-15 22:58:45 -04:00
/**
* Returns an ethers-style Error for the given JSON-RPC error
* %%payload%%, coalescing the various strings and error shapes
* that different nodes return, coercing them into a machine-readable
* standardized error.
*/
2022-10-20 05:03:32 -04:00
getRpcError(payload, _error) {
2022-09-15 22:58:45 -04:00
const { method } = payload;
2022-10-20 05:03:32 -04:00
const { error } = _error;
2023-01-27 18:34:03 -05:00
if (method === "eth_estimateGas" && error.message) {
const msg = error.message;
if (!msg.match(/revert/i) && msg.match(/insufficient funds/i)) {
return (0, index_js_5.makeError)("insufficient funds", "INSUFFICIENT_FUNDS", {
transaction: (payload.params[0]),
});
}
}
2022-10-20 05:03:32 -04:00
if (method === "eth_call" || method === "eth_estimateGas") {
2022-09-15 22:58:45 -04:00
const result = spelunkData(error);
2022-11-30 15:44:23 -05:00
const e = index_js_1.AbiCoder.getBuiltinCallException((method === "eth_call") ? "call" : "estimateGas", (payload.params[0]), (result ? result.data : null));
2022-10-20 05:03:32 -04:00
e.info = { error, payload };
return e;
/*
let message = "missing revert data during JSON-RPC call";
const action = <"call" | "estimateGas" | "unknown">(({ eth_call: "call", eth_estimateGas: "estimateGas" })[method] || "unknown");
let data: null | string = null;
let reason: null | string = null;
const transaction = <{ from: string, to: string, data: string }>((<any>payload).params[0]);
const invocation = null;
let revert: null | { signature: string, name: string, args: Array<any> } = null;
if (result) {
// @TODO: Extract errorSignature, errorName, errorArgs, reason if
// it is Error(string) or Panic(uint25)
message = "execution reverted during JSON-RPC call";
data = result.data;
let bytes = getBytes(data);
if (bytes.length % 32 !== 4) {
message += " (could not parse reason; invalid data length)";
} else if (data.substring(0, 10) === "0x08c379a0") {
// Error(string)
try {
if (bytes.length < 68) { throw new Error("bad length"); }
bytes = bytes.slice(4);
const pointer = getNumber(hexlify(bytes.slice(0, 32)));
bytes = bytes.slice(pointer);
if (bytes.length < 32) { throw new Error("overrun"); }
const length = getNumber(hexlify(bytes.slice(0, 32)));
bytes = bytes.slice(32);
if (bytes.length < length) { throw new Error("overrun"); }
reason = toUtf8String(bytes.slice(0, length));
revert = {
signature: "Error(string)",
name: "Error",
args: [ reason ]
};
message += `: ${ JSON.stringify(reason) }`;
} catch (error) {
console.log(error);
message += " (could not parse reason; invalid data length)";
}
} else if (data.substring(0, 10) === "0x4e487b71") {
// Panic(uint256)
try {
if (bytes.length !== 36) { throw new Error("bad length"); }
const arg = getNumber(hexlify(bytes.slice(4)));
revert = {
signature: "Panic(uint256)",
name: "Panic",
args: [ arg ]
};
reason = `Panic due to ${ PanicReasons.get(Number(arg)) || "UNKNOWN" }(${ arg })`;
message += `: ${ reason }`;
} catch (error) {
console.log(error);
message += " (could not parse panic reason)";
}
}
}
return makeError(message, "CALL_EXCEPTION", {
action, data, reason, transaction, invocation, revert,
info: { payload, error }
});
*/
2022-09-15 22:58:45 -04:00
}
2022-10-20 05:03:32 -04:00
// Only estimateGas and call can return arbitrary contract-defined text, so now we
// we can process text safely.
2022-09-15 22:58:45 -04:00
const message = JSON.stringify(spelunkMessage(error));
2022-10-20 05:03:32 -04:00
if (typeof (error.message) === "string" && error.message.match(/user denied|ethers-user-denied/i)) {
const actionMap = {
eth_sign: "signMessage",
personal_sign: "signMessage",
eth_signTypedData_v4: "signTypedData",
eth_signTransaction: "signTransaction",
eth_sendTransaction: "sendTransaction",
eth_requestAccounts: "requestAccess",
wallet_requestAccounts: "requestAccess",
};
return (0, index_js_5.makeError)(`user rejected action`, "ACTION_REJECTED", {
action: (actionMap[method] || "unknown"),
reason: "rejected",
info: { payload, error }
});
2022-09-15 22:58:45 -04:00
}
if (method === "eth_sendRawTransaction" || method === "eth_sendTransaction") {
const transaction = (payload.params[0]);
2022-12-30 16:35:04 -05:00
if (message.match(/insufficient funds|base fee exceeds gas limit/i)) {
2022-10-20 05:03:32 -04:00
return (0, index_js_5.makeError)("insufficient funds for intrinsic transaction cost", "INSUFFICIENT_FUNDS", {
2022-09-15 22:58:45 -04:00
transaction
2022-09-05 16:57:11 -04:00
});
}
2022-12-30 16:35:04 -05:00
if (message.match(/nonce/i) && message.match(/too low/i)) {
2022-10-20 05:03:32 -04:00
return (0, index_js_5.makeError)("nonce has already been used", "NONCE_EXPIRED", { transaction });
2022-09-05 16:57:11 -04:00
}
// "replacement transaction underpriced"
2022-12-30 16:35:04 -05:00
if (message.match(/replacement transaction/i) && message.match(/underpriced/i)) {
2022-10-20 05:03:32 -04:00
return (0, index_js_5.makeError)("replacement fee too low", "REPLACEMENT_UNDERPRICED", { transaction });
2022-09-05 16:57:11 -04:00
}
2022-12-30 16:35:04 -05:00
if (message.match(/only replay-protected/i)) {
2022-10-20 05:03:32 -04:00
return (0, index_js_5.makeError)("legacy pre-eip-155 transactions not supported", "UNSUPPORTED_OPERATION", {
2022-09-15 22:58:45 -04:00
operation: method, info: { transaction }
2022-09-05 16:57:11 -04:00
});
}
2022-09-15 22:58:45 -04:00
}
2022-10-20 05:03:32 -04:00
if (message.match(/the method .* does not exist/i)) {
return (0, index_js_5.makeError)("unsupported operation", "UNSUPPORTED_OPERATION", {
operation: payload.method
});
}
return (0, index_js_5.makeError)("could not coalesce error", "UNKNOWN_ERROR", { error });
2022-09-15 22:58:45 -04:00
}
/**
2022-09-29 22:57:27 -04:00
* Requests the %%method%% with %%params%% via the JSON-RPC protocol
* over the underlying channel. This can be used to call methods
* on the backend that do not have a high-level API within the Provider
* API.
2022-09-15 22:58:45 -04:00
*
2022-09-29 22:57:27 -04:00
* This method queues requests according to the batch constraints
* in the options, assigns the request a unique ID.
*
* **Do NOT override** this method in sub-classes; instead
* override [[_send]] or force the options values in the
* call to the constructor to modify this method's behavior.
2022-09-15 22:58:45 -04:00
*/
2022-09-29 22:57:27 -04:00
send(method, params) {
// @TODO: cache chainId?? purge on switch_networks
const id = this.#nextId++;
const promise = new Promise((resolve, reject) => {
this.#payloads.push({
resolve, reject,
payload: { method, params, id, jsonrpc: "2.0" }
});
});
// If there is not a pending drainTimer, set one
this.#scheduleDrain();
return promise;
}
/**
* Resolves to the [[Signer]] account for %%address%% managed by
* the client.
*
* If the %%address%% is a number, it is used as an index in the
* the accounts from [[listAccounts]].
*
* This can only be used on clients which manage accounts (such as
* Geth with imported account or MetaMask).
*
* Throws if the account doesn't exist.
*/
2022-11-30 15:44:23 -05:00
async getSigner(address) {
if (address == null) {
address = 0;
}
2022-09-29 22:57:27 -04:00
const accountsPromise = this.send("eth_accounts", []);
// Account index
if (typeof (address) === "number") {
const accounts = (await accountsPromise);
2022-10-20 05:03:32 -04:00
if (address >= accounts.length) {
2022-09-29 22:57:27 -04:00
throw new Error("no such account");
2022-09-05 16:57:11 -04:00
}
2022-09-29 22:57:27 -04:00
return new JsonRpcSigner(this, accounts[address]);
2022-09-05 16:57:11 -04:00
}
2022-10-20 05:03:32 -04:00
const { accounts } = await (0, index_js_5.resolveProperties)({
2022-09-29 22:57:27 -04:00
network: this.getNetwork(),
accounts: accountsPromise
});
// Account address
2022-10-20 05:03:32 -04:00
address = (0, index_js_2.getAddress)(address);
2022-09-29 22:57:27 -04:00
for (const account of accounts) {
2022-10-20 05:03:32 -04:00
if ((0, index_js_2.getAddress)(account) === account) {
2022-09-29 22:57:27 -04:00
return new JsonRpcSigner(this, account);
}
2022-09-05 16:57:11 -04:00
}
2022-09-29 22:57:27 -04:00
throw new Error("invalid account");
2022-09-05 16:57:11 -04:00
}
}
exports.JsonRpcApiProvider = JsonRpcApiProvider;
2022-10-20 05:03:32 -04:00
class JsonRpcApiPollingProvider extends JsonRpcApiProvider {
#pollingInterval;
constructor(network, options) {
super(network, options);
this.#pollingInterval = 4000;
}
_getSubscriber(sub) {
const subscriber = super._getSubscriber(sub);
if (isPollable(subscriber)) {
subscriber.pollingInterval = this.#pollingInterval;
}
return subscriber;
}
/**
* The polling interval (default: 4000 ms)
*/
get pollingInterval() { return this.#pollingInterval; }
set pollingInterval(value) {
if (!Number.isInteger(value) || value < 0) {
throw new Error("invalid interval");
}
this.#pollingInterval = value;
this._forEachSubscriber((sub) => {
if (isPollable(sub)) {
sub.pollingInterval = this.#pollingInterval;
}
});
}
}
exports.JsonRpcApiPollingProvider = JsonRpcApiPollingProvider;
2022-09-15 22:58:45 -04:00
/**
* The JsonRpcProvider is one of the most common Providers,
* which performs all operations over HTTP (or HTTPS) requests.
*
* Events are processed by polling the backend for the current block
* number; when it advances, all block-base events are then checked
* for updates.
*/
2022-10-20 05:03:32 -04:00
class JsonRpcProvider extends JsonRpcApiPollingProvider {
2022-09-05 16:57:11 -04:00
#connect;
constructor(url, network, options) {
if (url == null) {
url = "http:/\/localhost:8545";
}
super(network, options);
if (typeof (url) === "string") {
2022-10-20 05:03:32 -04:00
this.#connect = new index_js_5.FetchRequest(url);
2022-09-05 16:57:11 -04:00
}
else {
this.#connect = url.clone();
}
}
2022-09-29 22:57:27 -04:00
_getConnection() {
return this.#connect.clone();
}
2022-09-27 03:45:27 -04:00
async send(method, params) {
// All requests are over HTTP, so we can just start handling requests
// We do this here rather than the constructor so that we don't send any
2022-09-29 22:57:27 -04:00
// requests to the network (i.e. eth_chainId) until we absolutely have to.
2022-09-27 03:45:27 -04:00
await this._start();
return await super.send(method, params);
}
2022-09-05 16:57:11 -04:00
async _send(payload) {
// Configure a POST connection for the requested method
2022-09-29 22:57:27 -04:00
const request = this._getConnection();
2022-09-05 16:57:11 -04:00
request.body = JSON.stringify(payload);
2023-01-17 13:53:49 -05:00
request.setHeader("content-type", "application/json");
2022-09-05 16:57:11 -04:00
const response = await request.send();
response.assertOk();
let resp = response.bodyJson;
if (!Array.isArray(resp)) {
resp = [resp];
}
return resp;
}
}
exports.JsonRpcProvider = JsonRpcProvider;
2022-09-15 22:58:45 -04:00
function spelunkData(value) {
if (value == null) {
return null;
2022-09-05 16:57:11 -04:00
}
// These *are* the droids we're looking for.
2022-10-20 05:03:32 -04:00
if (typeof (value.message) === "string" && value.message.match("reverted") && (0, index_js_5.isHexString)(value.data)) {
2022-09-05 16:57:11 -04:00
return { message: value.message, data: value.data };
}
// Spelunk further...
2022-09-15 22:58:45 -04:00
if (typeof (value) === "object") {
2022-09-05 16:57:11 -04:00
for (const key in value) {
const result = spelunkData(value[key]);
2022-09-15 22:58:45 -04:00
if (result) {
return result;
}
2022-09-05 16:57:11 -04:00
}
return null;
}
// Might be a JSON string we can further descend...
2022-09-15 22:58:45 -04:00
if (typeof (value) === "string") {
2022-09-05 16:57:11 -04:00
try {
return spelunkData(JSON.parse(value));
2022-09-15 22:58:45 -04:00
}
catch (error) { }
2022-09-05 16:57:11 -04:00
}
return null;
}
2022-09-15 22:58:45 -04:00
function _spelunkMessage(value, result) {
if (value == null) {
return;
}
2022-09-05 16:57:11 -04:00
// These *are* the droids we're looking for.
2022-09-15 22:58:45 -04:00
if (typeof (value.message) === "string") {
2022-09-05 16:57:11 -04:00
result.push(value.message);
}
// Spelunk further...
2022-09-15 22:58:45 -04:00
if (typeof (value) === "object") {
2022-09-05 16:57:11 -04:00
for (const key in value) {
_spelunkMessage(value[key], result);
}
}
// Might be a JSON string we can further descend...
2022-09-15 22:58:45 -04:00
if (typeof (value) === "string") {
2022-09-05 16:57:11 -04:00
try {
return _spelunkMessage(JSON.parse(value), result);
2022-09-15 22:58:45 -04:00
}
catch (error) { }
2022-09-05 16:57:11 -04:00
}
}
2022-09-15 22:58:45 -04:00
function spelunkMessage(value) {
const result = [];
2022-09-05 16:57:11 -04:00
_spelunkMessage(value, result);
return result;
}
//# sourceMappingURL=provider-jsonrpc.js.map