ethers.js/packages/providers/lib.esm/pocket-provider.js

114 lines
4.7 KiB
JavaScript
Raw Permalink Normal View History

2020-10-18 23:19:16 -04:00
"use strict";
2021-02-02 17:32:11 -05:00
import { getStatic } from "@ethersproject/properties";
2020-10-18 23:19:16 -04:00
import { Logger } from "@ethersproject/logger";
import { version } from "./_version";
const logger = new Logger(version);
import { UrlJsonRpcProvider } from "./url-json-rpc-provider";
2021-02-02 17:32:11 -05:00
// These are load-balancer-based applicatoin IDs
const defaultApplicationIds = {
homestead: "6004bcd10040261633ade990",
ropsten: "6004bd4d0040261633ade991",
rinkeby: "6004bda20040261633ade994",
goerli: "6004bd860040261633ade992",
};
2020-10-18 23:19:16 -04:00
export class PocketProvider extends UrlJsonRpcProvider {
2021-02-02 17:32:11 -05:00
constructor(network, apiKey) {
// We need a bit of creativity in the constructor because
// Pocket uses different default API keys based on the network
if (apiKey == null) {
const n = getStatic((new.target), "getNetwork")(network);
if (n) {
const applicationId = defaultApplicationIds[n.name];
if (applicationId) {
apiKey = {
applicationId: applicationId,
loadBalancer: true
};
}
}
// If there was any issue above, we don't know this network
if (apiKey == null) {
logger.throwError("unsupported network", Logger.errors.INVALID_ARGUMENT, {
argument: "network",
value: network
});
}
}
super(network, apiKey);
}
2020-10-18 23:19:16 -04:00
static getApiKey(apiKey) {
2021-02-02 17:32:11 -05:00
// Most API Providers allow null to get the default configuration, but
// Pocket requires the network to decide the default provider, so we
// rely on hijacking the constructor to add a sensible default for us
if (apiKey == null) {
logger.throwArgumentError("PocketProvider.getApiKey does not support null apiKey", "apiKey", apiKey);
}
2020-10-18 23:19:16 -04:00
const apiKeyObj = {
2021-02-02 17:32:11 -05:00
applicationId: null,
loadBalancer: false,
2020-10-18 23:19:16 -04:00
applicationSecretKey: null
};
// Parse applicationId and applicationSecretKey
if (typeof (apiKey) === "string") {
apiKeyObj.applicationId = apiKey;
}
else if (apiKey.applicationSecretKey != null) {
logger.assertArgument((typeof (apiKey.applicationId) === "string"), "applicationSecretKey requires an applicationId", "applicationId", apiKey.applicationId);
logger.assertArgument((typeof (apiKey.applicationSecretKey) === "string"), "invalid applicationSecretKey", "applicationSecretKey", "[REDACTED]");
apiKeyObj.applicationId = apiKey.applicationId;
apiKeyObj.applicationSecretKey = apiKey.applicationSecretKey;
2021-02-02 17:32:11 -05:00
apiKeyObj.loadBalancer = !!apiKey.loadBalancer;
2020-10-18 23:19:16 -04:00
}
else if (apiKey.applicationId) {
2021-02-02 17:32:11 -05:00
logger.assertArgument((typeof (apiKey.applicationId) === "string"), "apiKey.applicationId must be a string", "apiKey.applicationId", apiKey.applicationId);
2020-10-18 23:19:16 -04:00
apiKeyObj.applicationId = apiKey.applicationId;
2021-02-02 17:32:11 -05:00
apiKeyObj.loadBalancer = !!apiKey.loadBalancer;
}
else {
logger.throwArgumentError("unsupported PocketProvider apiKey", "apiKey", apiKey);
2020-10-18 23:19:16 -04:00
}
return apiKeyObj;
}
static getUrl(network, apiKey) {
let host = null;
switch (network ? network.name : "unknown") {
case "homestead":
host = "eth-mainnet.gateway.pokt.network";
break;
2021-02-02 17:32:11 -05:00
case "ropsten":
host = "eth-ropsten.gateway.pokt.network";
break;
case "rinkeby":
host = "eth-rinkeby.gateway.pokt.network";
break;
case "goerli":
host = "eth-goerli.gateway.pokt.network";
break;
2020-10-18 23:19:16 -04:00
default:
logger.throwError("unsupported network", Logger.errors.INVALID_ARGUMENT, {
argument: "network",
value: network
});
}
2021-02-02 17:32:11 -05:00
let url = null;
if (apiKey.loadBalancer) {
url = `https:/\/${host}/v1/lb/${apiKey.applicationId}`;
}
else {
url = `https:/\/${host}/v1/${apiKey.applicationId}`;
}
const connection = { url };
2020-10-18 23:19:16 -04:00
// Initialize empty headers
connection.headers = {};
// Apply application secret key
if (apiKey.applicationSecretKey != null) {
connection.user = "";
connection.password = apiKey.applicationSecretKey;
}
return connection;
}
isCommunityResource() {
2021-02-02 17:32:11 -05:00
return (this.applicationId === defaultApplicationIds[this.network.name]);
2020-10-18 23:19:16 -04:00
}
}
//# sourceMappingURL=pocket-provider.js.map