@asyncswap/eth-rpc 0.4.4 → 0.4.6

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @asyncswap/eth-rpc
 
+## 0.4.6
+
+### Patch Changes
+
+- 3d6ec6e: add clinet version spec
+
+## 0.4.5
+
+### Patch Changes
+
+- 0d1be5d: upgrade with parameter typing
+- Updated dependencies [882f94f]
+  - @asyncswap/jsonrpc@0.4.7
+
 ## 0.4.4
 
 ### Patch Changes

package/README.md

@@ -33,6 +33,21 @@ import { FlashbotsClient } from "@asyncswap/eth-rpc";
 
 const rpc = "https://relay.flashbots.net";
 const client = new FlashbotsClient(rpc);
+const bundle = {
+ txs: ["0x123abc", "0x456def..."] as Hex[],
+
+ blockNumber: "0xb63dcd" as Hex,
+ minTimestamp: 0,
+ maxTimestamp: 1615920932,
+};
+const body = client.rpc.buildRequest("eth_sendBundle", [bundle]);
+// const signature = wallet.sign(body)
+// const sender = wallet.address
+client
+ .setHeaders({
+  "X-Flashbots-Signature": `0x<sender>:0x<signature>`,
+ })
+ .eth_sendBundle(bundle);
 ```
 
 ### Engine API Client
@@ -42,14 +57,9 @@ import { EngineExecutionClient } from '@asyncswap/eth-rpc';
 
 const engineUrl = 'https://localhost:8551';
 const engine = new EngineExecutionClient(engineUrl, process.env.JWT_TOKEN!);
-const payload = engine.engine_getPayloadV1("0x1");
+const payload = await engine.engine_getPayloadV1("0x1");
 
 console.log(payload);
-
-import { FlashbotsClient } from '@asyncswap/eth-rpc';
-
-const rpc = 'https://relay.flashbots.net';
-const client = new FlashbotsClient(rpc);
 ```
 
 ## Error Handling

package/example.ts

@@ -13,7 +13,11 @@ import { EngineExecutionClient } from "./src";
 
 const engineUrl = "https://localhost:8551";
 const engine = new EngineExecutionClient(engineUrl, process.env.JWT_TOKEN!);
-const payload = await engine.engine_getPayloadV1("0x1");
+const payload = await engine
+	.setHeaders({
+		Authorization: `Bearer <jwt-token>`,
+	})
+	.engine_getPayloadV1("0x1");
 
 console.log(payload);
 
@@ -21,3 +25,18 @@ import { FlashbotsClient } from "./src";
 
 const rpc = "https://relay.flashbots.net";
 const client = new FlashbotsClient(rpc);
+const bundle = {
+	txs: ["0x123abc", "0x456def..."] as Hex[],
+
+	blockNumber: "0xb63dcd" as Hex,
+	minTimestamp: 0,
+	maxTimestamp: 1615920932,
+};
+const body = client.rpc.buildRequest("eth_sendBundle", [bundle]);
+// const signature = wallet.sign(body)
+// const sender = wallet.address
+client
+	.setHeaders({
+		"X-Flashbots-Signature": `0x<sender>:0x<signature>`,
+	})
+	.eth_sendBundle(bundle);

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@asyncswap/eth-rpc",
 	"description": "A library for ethereum execution clients apis.",
 	"author": "Meek Msaki",
-	"version": "0.4.4",
+	"version": "0.4.6",
 	"license": "MIT",
 	"type": "module",
 	"main": "dist/index.js",
@@ -41,6 +41,6 @@
 		"typescript": "^5"
 	},
 	"dependencies": {
-		"@asyncswap/jsonrpc": "^0.4.4"
+		"@asyncswap/jsonrpc": "^0.4.7"
 	}
 }

package/src/base.ts

@@ -0,0 +1,36 @@
+import { JsonRpcClient } from "@asyncswap/jsonrpc";
+
+export type RpcMethodSpec = {
+	params: readonly unknown[];
+	result: unknown;
+};
+export type RpcSpecBase = Record<string, RpcMethodSpec>;
+
+export abstract class BaseClient<MethodsSpec extends RpcSpecBase> {
+	rpc: JsonRpcClient<MethodsSpec>;
+	protected headers: Record<string, string> = {};
+
+	constructor(url: string) {
+		this.rpc = new JsonRpcClient(url);
+
+		return new Proxy(this, {
+			get: (_: this, prop: string | symbol) => {
+				if (typeof prop !== "string") return undefined;
+
+				const method = prop as keyof MethodsSpec;
+
+				return (
+					...params: MethodsSpec[typeof method]["params"]
+				): MethodsSpec[typeof method]["result"] =>
+					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
+			},
+		});
+	}
+
+	setHeaders(headers: Record<string, string>) {
+		this.headers = {
+			...headers,
+		};
+		return this;
+	}
+}

package/src/engine-api.ts

@@ -1,37 +1,19 @@
-import { JsonRpcClient } from "@asyncswap/jsonrpc";
-
-export type EngineRpcMethods<
-	T extends Record<string, { params: unknown[]; result: unknown }>,
-> = {
-		[K in keyof T]: (...params: T[K]["params"]) => Promise<T[K]["result"]>;
-	};
-
-export class EngineExecutionClient {
-	rpc: JsonRpcClient;
-	headers: Record<string, string>;
+import { BaseClient } from "./base";
 
+export class EngineExecutionClient extends BaseClient<EngineMethodsSpec> {
 	constructor(url: string, jwt_token: string) {
+		super(url);
 		this.headers = {
 			Authorization: `Bearer ${jwt_token}`,
 		};
-		this.rpc = new JsonRpcClient(url);
-
-		return new Proxy(this, {
-			get: (_, method: string) => {
-				return (...params: unknown[]) =>
-					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
-			},
-		});
-	}
-
-	setHeaders(headers: Record<string, string>) {
-		this.headers = {
-			...this.headers,
-			...headers,
-		};
-		return this;
 	}
 }
 
+export type EngineRpcMethods<
+	T extends Record<string, { params: unknown[]; result: unknown }>,
+> = {
+		[K in keyof T]: (...params: T[K]["params"]) => Promise<T[K]["result"]>;
+	};
+
 export interface EngineExecutionClient
 	extends EngineRpcMethods<EngineMethodsSpec> { }

package/src/eth-api.ts

@@ -1,4 +1,10 @@
-import { JsonRpcClient } from "@asyncswap/jsonrpc";
+import { BaseClient } from "./base";
+
+export class ExecutionClient extends BaseClient<EthMethodsSpec> {
+	constructor(url: string) {
+		super(url);
+	}
+}
 
 export type EthRpcMethods<
 	T extends Record<string, { params: unknown[]; result: unknown }>,
@@ -6,30 +12,6 @@ export type EthRpcMethods<
 		[K in keyof T]: (...params: T[K]["params"]) => Promise<T[K]["result"]>;
 	};
 
-export class ExecutionClient {
-	rpc: JsonRpcClient;
-	headers: Record<string, string> = {};
-
-	constructor(url: string) {
-		this.rpc = new JsonRpcClient(url);
-
-		return new Proxy(this, {
-			get: (_, method: string) => {
-				return (...params: unknown[]) =>
-					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
-			},
-		});
-	}
-
-	setAuth(headers: Record<string, string>) {
-		this.headers = {
-			...this.headers,
-			...headers,
-		};
-		return this;
-	}
-}
-
 export interface ExecutionClient extends EthRpcMethods<EthMethodsSpec> { }
 
 /**

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from "./base";
 export * from "./engine-api";
 export * from "./eth-api";
 export * from "./mev-api";

package/src/mev-api.ts

@@ -1,28 +1,17 @@
-import { JsonRpcClient } from "@asyncswap/jsonrpc";
-
-export type FlashbotsRpcMethods<
-	T extends Record<string, { params: unknown[]; result: unknown }>,
-> = {
-		[M in keyof T]: (...params: T[M]["params"]) => Promise<T[M]["result"]>;
-	};
-
-export class FlashbotsClient {
-	rpc: JsonRpcClient;
-	private headers: Record<string, string> = {};
+import { BaseClient } from "./base";
 
+export class FlashbotsClient extends BaseClient<FlashbotsMethodsSpec> {
 	constructor(url: string) {
-		this.rpc = new JsonRpcClient(url);
-
-		return new Proxy(this, {
-			get: (_, method: string) => {
-				return (...params: unknown[]) =>
-					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
-			},
-		});
+		super(url);
 	}
 
 	// "X-Flashbots-Signature": `${sender}:${signature}`,
 }
 
+export type FlashbotsRpcMethods<
+	T extends Record<string, { params: unknown[]; result: unknown }>,
+> = {
+		[M in keyof T]: (...params: T[M]["params"]) => Promise<T[M]["result"]>;
+	};
 export interface FlashbotsClient
 	extends FlashbotsRpcMethods<FlashbotsMethodsSpec> { }

package/src/types/engine/identification.d.ts

@@ -0,0 +1,24 @@
+declare global {
+	export type ClientVersionV1 = {
+		code: ClientCode;
+		name: string;
+		varsion: string;
+		commit: string;
+	};
+	export type ClientCode =
+		| "BU" // besu
+		| "EJ" // ethereumJs
+		| "EG" // erigon
+		| "GE" // go-ethereum
+		| "GR" // gradine
+		| "LH" // lighthouse
+		| "LS" // lodestar
+		| "NM" // nethermind
+		| "NB" // nimbus
+		| "TE" // thin-execution
+		| "TK" // teku
+		| "PM" // prysm
+		| "RH"; // reth
+}
+
+export { };

package/src/types/engine/methods.d.ts

@@ -1,5 +1,11 @@
 declare global {
 	export type EngineMethodsSpec = {
+		// identification
+		engine_getClientVersionV1: {
+			params: [ClientVersionV1];
+			result: ClientVersionV1[];
+		};
+		// share methods
 		eth_blockNumber: { params: []; result: Uint };
 		eth_call: {
 			params: [GenericTransaction, BlockNumberOrTagOrHash];