eteres 0.0.1-security → 6.7.1

package/src.ts/providers/provider-infura.ts

@@ -0,0 +1,190 @@
+/**
+ *  [[link-infura]] provides a third-party service for connecting to
+ *  various blockchains over JSON-RPC.
+ *
+ *  **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:INFURA  [providers-infura]
+ */
+import {
+    defineProperties, FetchRequest, assert, assertArgument
+} from "../utils/index.js";
+
+import { showThrottleMessage } from "./community.js";
+import { Network } from "./network.js";
+import { JsonRpcProvider } from "./provider-jsonrpc.js";
+import { WebSocketProvider } from "./provider-websocket.js";
+
+import type { AbstractProvider } from "./abstract-provider.js";
+import type { CommunityResourcable } from "./community.js";
+import type { Networkish } from "./network.js";
+
+
+const defaultProjectId = "84842078b09946638c03157f83405213";
+
+function getHost(name: string): string {
+    switch(name) {
+        case "mainnet":
+            return "mainnet.infura.io";
+        case "goerli":
+            return "goerli.infura.io";
+        case "sepolia":
+            return "sepolia.infura.io";
+
+        case "arbitrum":
+            return "arbitrum-mainnet.infura.io";
+        case "arbitrum-goerli":
+            return "arbitrum-goerli.infura.io";
+        case "linea":
+            return "linea-mainnet.infura.io";
+        case "linea-goerli":
+            return "linea-goerli.infura.io";
+        case "matic":
+            return "polygon-mainnet.infura.io";
+        case "matic-mumbai":
+            return "polygon-mumbai.infura.io";
+        case "optimism":
+            return "optimism-mainnet.infura.io";
+        case "optimism-goerli":
+            return "optimism-goerli.infura.io";
+    }
+
+    assertArgument(false, "unsupported network", "network", name);
+}
+
+/**
+ *  The **InfuraWebSocketProvider** connects to the [[link-infura]]
+ *  WebSocket end-points.
+ *
+ *  By default, a highly-throttled API key is used, which is
+ *  appropriate for quick prototypes and simple scripts. To
+ *  gain access to an increased rate-limit, it is highly
+ *  recommended to [sign up here](link-infura-signup).
+ */
+export class InfuraWebSocketProvider extends WebSocketProvider implements CommunityResourcable {
+
+    /**
+     *  The Project ID for the INFURA connection.
+     */
+    readonly projectId!: string;
+
+    /**
+     *  The Project Secret.
+     *
+     *  If null, no authenticated requests are made. This should not
+     *  be used outside of private contexts.
+     */
+    readonly projectSecret!: null | string;
+
+    /**
+     *  Creates a new **InfuraWebSocketProvider**.
+     */
+    constructor(network?: Networkish, projectId?: string) {
+        const provider = new InfuraProvider(network, projectId);
+
+        const req = provider._getConnection();
+        assert(!req.credentials, "INFURA WebSocket project secrets unsupported",
+            "UNSUPPORTED_OPERATION", { operation: "InfuraProvider.getWebSocketProvider()" });
+
+        const url = req.url.replace(/^http/i, "ws").replace("/v3/", "/ws/v3/");
+        super(url, network);
+
+        defineProperties<InfuraWebSocketProvider>(this, {
+            projectId: provider.projectId,
+            projectSecret: provider.projectSecret
+        });
+    }
+
+    isCommunityResource(): boolean {
+        return (this.projectId === defaultProjectId);
+    }
+}
+
+/**
+ *  The **InfuraProvider** connects to the [[link-infura]]
+ *  JSON-RPC end-points.
+ *
+ *  By default, a highly-throttled API key is used, which is
+ *  appropriate for quick prototypes and simple scripts. To
+ *  gain access to an increased rate-limit, it is highly
+ *  recommended to [sign up here](link-infura-signup).
+ */
+export class InfuraProvider extends JsonRpcProvider implements CommunityResourcable {
+    /**
+     *  The Project ID for the INFURA connection.
+     */
+    readonly projectId!: string;
+
+    /**
+     *  The Project Secret.
+     *
+     *  If null, no authenticated requests are made. This should not
+     *  be used outside of private contexts.
+     */
+    readonly projectSecret!: null | string;
+
+    /**
+     *  Creates a new **InfuraProvider**.
+     */
+    constructor(_network?: Networkish, projectId?: null | string, projectSecret?: null | string) {
+        if (_network == null) { _network = "mainnet"; }
+        const network = Network.from(_network);
+        if (projectId == null) { projectId = defaultProjectId; }
+        if (projectSecret == null) { projectSecret = null; }
+
+        const request = InfuraProvider.getRequest(network, projectId, projectSecret);
+        super(request, network, { staticNetwork: network });
+
+        defineProperties<InfuraProvider>(this, { projectId, projectSecret });
+    }
+
+    _getProvider(chainId: number): AbstractProvider {
+        try {
+            return new InfuraProvider(chainId, this.projectId, this.projectSecret);
+        } catch (error) { }
+        return super._getProvider(chainId);
+    }
+
+    isCommunityResource(): boolean {
+        return (this.projectId === defaultProjectId);
+    }
+
+    /**
+     *  Creates a new **InfuraWebSocketProvider**.
+     */
+    static getWebSocketProvider(network?: Networkish, projectId?: string): InfuraWebSocketProvider {
+        return new InfuraWebSocketProvider(network, projectId);
+    }
+
+    /**
+     *  Returns a prepared request for connecting to %%network%%
+     *  with %%projectId%% and %%projectSecret%%.
+     */
+    static getRequest(network: Network, projectId?: null | string, projectSecret?: null | string): FetchRequest {
+        if (projectId == null) { projectId = defaultProjectId; }
+        if (projectSecret == null) { projectSecret = null; }
+
+        const request = new FetchRequest(`https:/\/${ getHost(network.name) }/v3/${ projectId }`);
+        request.allowGzip = true;
+        if (projectSecret) { request.setCredentials("", projectSecret); }
+
+        if (projectId === defaultProjectId) {
+            request.retryFunc = async (request, response, attempt) => {
+                showThrottleMessage("InfuraProvider");
+                return true;
+            };
+        }
+
+        return request;
+    }
+}

package/src.ts/providers/provider-ipcsocket-browser.ts

@@ -0,0 +1,3 @@
+const IpcSocketProvider = undefined;
+
+export { IpcSocketProvider };

package/src.ts/providers/provider-ipcsocket.ts

@@ -0,0 +1,78 @@
+
+import { connect } from "net";
+import { SocketProvider } from "./provider-socket.js";
+
+import type { Socket } from "net";
+import type { Networkish } from "./network.js";
+
+
+// @TODO: Is this sufficient? Is this robust? Will newlines occur between
+// all payloads and only between payloads?
+function splitBuffer(data: Buffer): { messages: Array<string>, remaining: Buffer } {
+    const messages: Array<string> = [ ];
+
+    let lastStart = 0;
+    while (true) {
+        const nl = data.indexOf(10, lastStart);
+        if (nl === -1) { break; }
+        messages.push(data.subarray(lastStart, nl).toString().trim());
+        lastStart = nl + 1;
+    }
+
+    return { messages, remaining: data.subarray(lastStart) };
+}
+
+/**
+ *  An **IpcSocketProvider** connects over an IPC socket on the host
+ *  which provides fast access to the node, but requires the node and
+ *  the script run on the same machine.
+ */
+export class IpcSocketProvider extends SocketProvider {
+    #socket: Socket;
+
+    /**
+     *  The connected socket.
+     */
+    get socket(): Socket { return this.#socket; }
+
+    constructor(path: string, network?: Networkish) {
+        super(network);
+        this.#socket = connect(path);
+
+        this.socket.on("ready", async () => {
+            try {
+                await this._start();
+            } catch (error) {
+                console.log("failed to start IpcSocketProvider", error);
+                // @TODO: Now what? Restart?
+            }
+        });
+
+        let response = Buffer.alloc(0);
+        this.socket.on("data", (data) => {
+            response = Buffer.concat([ response, data ]);
+            const { messages, remaining } = splitBuffer(response);
+            messages.forEach((message) => {
+                this._processMessage(message);
+            });
+            response = remaining;
+        });
+
+        this.socket.on("end", () => {
+            this.emit("close");
+            this.socket.destroy();
+            this.socket.end();
+        });
+    }
+
+    destroy(): void {
+        this.socket.destroy();
+        this.socket.end();
+
+        super.destroy();
+    }
+
+    async _write(message: string): Promise<void> {
+        this.socket.write(message);
+    }
+}