ethers.js/packages/providers/lib.esm/url-json-rpc-provider.js

92 lines
4.0 KiB
JavaScript
Raw Permalink Normal View History

"use strict";
2020-05-03 17:53:58 -04:00
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import { defineReadOnly, getStatic } from "@ethersproject/properties";
import { Logger } from "@ethersproject/logger";
import { version } from "./_version";
const logger = new Logger(version);
import { JsonRpcProvider } from "./json-rpc-provider";
2020-06-29 00:54:30 -04:00
// A StaticJsonRpcProvider is useful when you *know* for certain that
// the backend will never change, as it never calls eth_chainId to
// verify its backend. However, if the backend does change, the effects
// are undefined and may include:
// - inconsistent results
// - locking up the UI
// - block skew warnings
// - wrong results
2020-07-05 00:01:57 -04:00
// If the network is not explicit (i.e. auto-detection is expected), the
// node MUST be running and available to respond to requests BEFORE this
// is instantiated.
2020-06-29 00:54:30 -04:00
export class StaticJsonRpcProvider extends JsonRpcProvider {
detectNetwork() {
const _super = Object.create(null, {
2020-07-05 00:01:57 -04:00
detectNetwork: { get: () => super.detectNetwork }
2020-06-29 00:54:30 -04:00
});
return __awaiter(this, void 0, void 0, function* () {
let network = this.network;
if (network == null) {
2020-07-05 00:01:57 -04:00
network = yield _super.detectNetwork.call(this);
if (!network) {
logger.throwError("no network detected", Logger.errors.UNKNOWN_ERROR, {});
}
// If still not set, set it
if (this._network == null) {
// A static network does not support "any"
defineReadOnly(this, "_network", network);
this.emit("network", network, null);
}
2020-06-29 00:54:30 -04:00
}
return network;
});
}
}
export class UrlJsonRpcProvider extends StaticJsonRpcProvider {
constructor(network, apiKey) {
logger.checkAbstract(new.target, UrlJsonRpcProvider);
// Normalize the Network and API Key
2021-10-16 02:29:27 -04:00
network = getStatic(new.target, "getNetwork")(network);
apiKey = getStatic(new.target, "getApiKey")(apiKey);
const connection = getStatic(new.target, "getUrl")(network, apiKey);
2019-11-20 18:57:38 +09:00
super(connection, network);
if (typeof (apiKey) === "string") {
defineReadOnly(this, "apiKey", apiKey);
}
else if (apiKey != null) {
Object.keys(apiKey).forEach((key) => {
defineReadOnly(this, key, apiKey[key]);
});
}
}
_startPending() {
logger.warn("WARNING: API provider does not support pending filters");
}
2020-10-07 20:10:50 -04:00
isCommunityResource() {
return false;
}
getSigner(address) {
2019-11-20 18:57:38 +09:00
return logger.throwError("API provider does not support signing", Logger.errors.UNSUPPORTED_OPERATION, { operation: "getSigner" });
}
listAccounts() {
return Promise.resolve([]);
}
// Return a defaultApiKey if null, otherwise validate the API key
static getApiKey(apiKey) {
return apiKey;
}
2019-11-20 18:57:38 +09:00
// Returns the url or connection for the given network and API key. The
// API key will have been sanitized by the getApiKey first, so any validation
// or transformations can be done there.
static getUrl(network, apiKey) {
return logger.throwError("not implemented; sub-classes must override getUrl", Logger.errors.NOT_IMPLEMENTED, {
operation: "getUrl"
});
}
}
2020-07-13 08:03:56 -04:00
//# sourceMappingURL=url-json-rpc-provider.js.map