@asyncswap/eth-rpc 0.4.5 → 0.4.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @asyncswap/eth-rpc
 
+## 0.4.6
+
+### Patch Changes
+
+- 3d6ec6e: add clinet version spec
+
 ## 0.4.5
 
 ### 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
@@ -45,11 +60,6 @@ const engine = new EngineExecutionClient(engineUrl, process.env.JWT_TOKEN!);
 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,23 +25,18 @@ import { FlashbotsClient } from "./src";
 
 const rpc = "https://relay.flashbots.net";
 const client = new FlashbotsClient(rpc);
-const body = client.rpc.buildRequest("eth_sendBundle", [
-	{
-		txs: ["0x123abc", "0x456def..."],
-		blockNumber: "0xb63dcd",
-		minTimestamp: 0,
-		maxTimestamp: 1615920932,
-	} as EthSendBundleParams,
-]);
+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 signature = wallet.address
+// const sender = wallet.address
 client
 	.setHeaders({
 		"X-Flashbots-Signature": `0x<sender>:0x<signature>`,
 	})
-	.eth_sendBundle({
-		txs: ["0x123abc...", "0x456def..."],
-		blockNumber: "0xb63dcd",
-		minTimestamp: 0,
-		maxTimestamp: 1615920932,
-	});
+	.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.5",
+	"version": "0.4.6",
 	"license": "MIT",
 	"type": "module",
 	"main": "dist/index.js",

package/src/base.ts

@@ -19,7 +19,9 @@ export abstract class BaseClient<MethodsSpec extends RpcSpecBase> {
 
 				const method = prop as keyof MethodsSpec;
 
-				return (...params: MethodsSpec[typeof method]["params"]) =>
+				return (
+					...params: MethodsSpec[typeof method]["params"]
+				): MethodsSpec[typeof method]["result"] =>
 					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
 			},
 		});

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];