@asyncswap/eth-rpc 0.4.1 → 0.4.3

package/CHANGELOG.md

@@ -1,12 +1,28 @@
 # @asyncswap/eth-rpc
 
-## 0.5.1
+## 0.4.3
+
+### Patch Changes
+
+- 7ae86a0: new refactor on methods as data
+- Updated dependencies [40a79dc]
+  - @asyncswap/jsonrpc@0.4.3
+
+## 0.4.2
+
+### Patch Changes
+
+- 9512db5: update documentation
+- Updated dependencies [9512db5]
+  - @asyncswap/jsonrpc@0.4.2
+
+## 0.4.1
 
 ### Patch Changes
 
 - 2598f09: updates docs
 
-## 0.5.0
+## 0.4.0
 
 ### Minor Changes
 

package/README.md

@@ -1,18 +1,18 @@
 # eth-rpc
 
-## `@asyncswap/eth-rpc`
+A comprehensive TypeScript client for Ethereum execution and engine APIs.
 
-A complete library for ethereum rpc clients apis.
+## Installation
 
-```sh
+```bash
 bun add @asyncswap/eth-rpc
 ```
 
-## Usage
+## Quick Start
 
-### Ethereum Execution Client Api
+### Execution API Client
 
-```ts
+```typescript
 import { EthExecutionClient } from '@asyncswap/eth-rpc';
 
 const url = 'http://localhost:8545'
@@ -24,7 +24,20 @@ const balance = await eth.eth_getBalance(
 );
 console.log("Balance:", balance);
 eth.eth_getTransactionCount("0x34", "safe");
+```
+
+### Flashbots Client API
+
+```ts
+import { FlashbotsClient } from "@asyncswap/eth-rpc";
 
+const rpc = "https://relay.flashbots.net";
+const client = new FlashbotsClient(rpc);
+```
+
+### Engine API Client
+
+```typescript
 import { EngineExecutionClient } from '@asyncswap/eth-rpc';
 
 const engineUrl = 'https://localhost:8551';
@@ -33,115 +46,33 @@ const payload = engine.engine_getPayloadV1("0x1");
 
 console.log(payload);
 
-import { EthFlashbotsClient } from '@asyncswap/eth-rpc';
+import { FlashbotsClient } from '@asyncswap/eth-rpc';
 
 const rpc = 'https://relay.flashbots.net';
-const client = new EthFlashbotsClient(rpc);
+const client = new FlashbotsClient(rpc);
 ```
 
-### Client RPC Methods implemented
-
-- [x] eth/transaction
-  - [x] eth_getTransactionByHash
-  - [x] eth_getTransactionByBlockHashAndIndex
-  - [x] eth_getTransactionReceipt
-- [x] eth/submit
-  - [x] eth_sendTransaction
-  - [x] eth_sendRawTransaction
-- [x] eth/state
-  - [x] eth_getBalance
-  - [x] eth_getStorageAt
-  - [x] eth_getTransactionCount
-  - [x] eth_getCode
-  - [x] eth_getProof
-- [x] eth/sign
-  - [x] eth_sign
-  - [x] eth_signTransaction
-- [x] eth/filter
-  - [x] eth_newFilter
-  - [x] eth_newBlockFilter
-  - [x] eth_newPendingTransactionFilter
-  - [x] eth_uninstallFilter
-  - [x] eth_getFilterChanges
-  - [x] eth_getFilterLogs
-  - [x] eth_getLogs
-- [x] eth/feeMarket
-  - [x] eth_gasPrice
-  - [x] eth_blobBaseFee
-  - [x] eth_maxPriorityFeePerGas
-  - [x] eth_feeHistory
-- [x] eth/execute
-  - [x] eth_call
-  - [x] eth_estimateGas
-  - [x] eth_createAccessList
-  - [x] eth_simulateV1
-- [x] eth/client
-  - [x] eth_chainId
-  - [x] eth_syncing
-  - [x] eth_coinbase
-  - [x] eth_accounts
-  - [x] eth_blockNumber
-  - [x] net_version
-- [x] eth/block
-  - [x] eth_getBlockByHash
-  - [x] eth_getBlockByNumber
-  - [x] eth_getBlockTransactionCountByHash
-  - [x] eth_getBlockTransactionCountByNumber
-  - [x] eth_getUncleCountByBlockHash
-  - [x] eth_getUncleCountByBlockNumber
-  - [x] eth_getBlockReceipts
-- [x] debug
-  - [x] debug_getRawHeader = "debug_getRawHeader",
-  - [x] debug_getRawBlock = "debug_getRawBlock",
-  - [x] debug_getRawTransaction = "debug_getRawTransaction",
-  - [x] debug_getRawReceipts = "debug_getRawReceipts",
-  - [x] debug_getBadBlocks = "debug_getBadBlocks",
-
-### Builtin flashbots MEV rpc methods
-
-- [x] eth_sendBundle
-- [x] mev_sendBundle
-- [x] eth_callBundle
-- [x] eth_cancelBundle
-- [x] mev_simBundle
-- [x] eth_sendPrivateTransaction
-- [x] eth_sendPrivateRawTransaction
-- [x] eth_cancelPrivateTransaction
-- [x] flashbots_getFeeRefundTotalsByRecipient
-- [x] flashbots_getFeeRefundsByRecipient
-- [x] flashbots_getFeeRefundsByBundle
-- [x] flashbots_getFeeRefundsByBlock
-- [x] flashbots_setFeeRefundRecipient
-- [x] buildernet_getDelayedRefunds
-- [x] buildernet_getDelayedRefundTotalsByRecipient
-- [x] flashbots_getMevRefundTotalByRecipient
-- [x] flashbots_getMevRefundTotalBySender
-
-### Engine RPC Methods Implemented
-
-- [x] engine/blob
-  - [x] engine_getBlobsV1
-  - [x] engine_getBlobsV2
-  - [x] engine_getBlobsV3
-- [x] engine/capabilities
-  - [x] engine_exchangeCapabilities
-- [x] engine/forkchoice
-  - [x] engine_forkchoiceUpdatedV1
-  - [x] engine_forkchoiceUpdatedV2
-  - [x] engine_forkchoiceUpdatedV3
-- [x] engine/payload
-  - [x] engine_newPayloadV1
-  - [x] engine_newPayloadV2
-  - [x] engine_newPayloadV3
-  - [x] engine_newPayloadV4
-  - [x] engine_getPayloadV1
-  - [x] engine_getPayloadV2
-  - [x] engine_getPayloadV3
-  - [x] engine_getPayloadV4
-  - [x] engine_getPayloadV5
-  - [x] engine_getPayloadBodiesByHashV1
-  - [x] engine_getPayloadBodiesByRangeV1
-  - [x] engine_newPayloadV5
-  - [x] engine_getPayloadV6
-- [x] engine/transition-configuration
-  - [x] engine_exchangeTransitionConfigurationV1
+## Error Handling
+
+All methods return typed responses. Handle errors appropriately:
+
+```typescript
+try {
+  const balance = await client.eth_getBalance(address, 'latest');
+  console.log('Balance:', balance);
+} catch (error) {
+  console.error('RPC Error:', error);
+}
+```
+
+## Type Safety
+
+Full TypeScript support with comprehensive type definitions for all RPC methods and responses.
+
+## Dependencies
+
+- `@asyncswap/jsonrpc` - JSON-RPC 2.0 client/server implementation
+
+## License
+
+MIT

package/example.ts

@@ -18,7 +18,9 @@ const payload = engine.engine_getPayloadV1("0x1");
 
 console.log(payload);
 
-import { EthFlashbotsClient } from "./src";
+import { FlashbotsClient } from "./src";
 
 const rpc = "https://relay.flashbots.net";
-const client = new EthFlashbotsClient(rpc);
+const client = new FlashbotsClient(rpc);
+const body = client.rpc.buildRequest("eth_sendBundle", []);
+client.eth_accounts();

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.1",
+	"version": "0.4.3",
 	"license": "MIT",
 	"type": "module",
 	"main": "dist/index.js",
@@ -41,6 +41,6 @@
 		"typescript": "^5"
 	},
 	"dependencies": {
-		"@asyncswap/jsonrpc": "^0.4.0"
+		"@asyncswap/jsonrpc": "^0.4.3"
 	}
 }

package/src/engine-api.ts

@@ -1,320 +1,37 @@
 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 {
-	private client: JsonRpcClient;
-	private headers: Record<string, string>;
+	rpc: JsonRpcClient;
+	headers: Record<string, string>;
 
 	constructor(url: string, jwt_token: string) {
 		this.headers = {
 			Authorization: `Bearer ${jwt_token}`,
 		};
-		this.client = new JsonRpcClient(url);
-	}
+		this.rpc = new JsonRpcClient(url);
 
-	// eth/transaction
-	async eth_sendRawTransaction(transaction: Bytes): Promise<Hash32> {
-		return await this.client.call(
-			EngineMethods.eth_sendRawTransaction,
-			[transaction],
-			this.headers,
-		);
-	}
-	// eth/state
-	async eth_getCode(
-		address: Address,
-		block: BlockNumberOrTagOrHash,
-	): Promise<Bytes> {
-		return await this.client.call(
-			EngineMethods.eth_getCode,
-			[address, block],
-			this.headers,
-		);
-	}
-	async eth_getLogs(filter: Filter): Promise<FilterResults> {
-		return await this.client.call(
-			EngineMethods.eth_getLogs,
-			[filter],
-			this.headers,
-		);
-	}
-	// eth/execute
-	async eth_call(
-		transaction: GenericTransaction,
-		block: BlockNumberOrTagOrHash,
-	): Promise<Bytes> {
-		return this.client.call(
-			EngineMethods.eth_call,
-			[transaction, block],
-			this.headers,
-		);
-	}
-	// eth/client
-	async eth_chainId(): Promise<Uint> {
-		return await this.client.call(EngineMethods.eth_chainId, [], this.headers);
-	}
-	async eth_syncing(): Promise<SyncingStatus> {
-		return await this.client.call(EngineMethods.eth_syncing, [], this.headers);
-	}
-	async eth_blockNumber(): Promise<Uint> {
-		return await this.client.call(
-			EngineMethods.eth_blockNumber,
-			[],
-			this.headers,
-		);
-	}
-	// eth/block
-	async eth_getBlockByHash(
-		blockHash: Hash32,
-		hydratedTransactions: boolean,
-	): Promise<NotFound | Block> {
-		return await this.client.call(
-			EngineMethods.eth_getBlockByHash,
-			[blockHash, hydratedTransactions],
-			this.headers,
-		);
-	}
-	async eth_getBlockByNumber(
-		block: BlockNumberOrTag,
-		hydratedTransactions: boolean,
-	): Promise<NotFound | Block> {
-		return await this.client.call(
-			EngineMethods.eth_getBlockByNumber,
-			[block, hydratedTransactions],
-			this.headers,
-		);
-	}
-	// engine/blob
-	async engine_getBlobsV1(
-		blobedVersionedHashes: Hash32[],
-	): Promise<BlobAndProofV1[]> {
-		return await this.client.call(
-			EngineMethods.engine_getBlobsV1,
-			[blobedVersionedHashes],
-			this.headers,
-		);
-	}
-	async engine_getBlobsV2(
-		blobedVersionedHashes: Hash32[],
-	): Promise<BlobAndProofV2[]> {
-		return await this.client.call(
-			EngineMethods.engine_getBlobsV2,
-			[blobedVersionedHashes],
-			this.headers,
-		);
-	}
-	async engine_getBlobsV3(
-		blobedVersionedHashes: Hash32[],
-	): Promise<Array<BlobAndProofV2[] | null> | null> {
-		return await this.client.call(
-			EngineMethods.engine_getBlobsV3,
-			[blobedVersionedHashes],
-			this.headers,
-		);
-	}
-	// engine/capabilities
-	async engine_exchangeCapabilities(
-		consensusClientMethods: string[],
-	): Promise<string[]> {
-		return await this.client.call(
-			EngineMethods.engine_exchangeCapabilities,
-			[consensusClientMethods],
-			this.headers,
-		);
-	}
-	// engine/forkchoice
-	async engine_forkchoiceUpdatedV1(
-		forkchoiceState: ForkchoiceStateV1,
-		payloadAttribute: PayloadAttributesV1,
-	): Promise<ForkchoiceUpdatedResponseV1> {
-		return await this.client.call(
-			EngineMethods.engine_forkchoiceUpdatedV1,
-			[forkchoiceState, payloadAttribute],
-			this.headers,
-		);
-	}
-	async engine_forkchoiceUpdatedV2(
-		forkchoiceState: ForkchoiceStateV1,
-		payloadAttribute: PayloadAttributesV2,
-	): Promise<ForkchoiceUpdatedResponseV1> {
-		return await this.client.call(
-			EngineMethods.engine_forkchoiceUpdatedV2,
-			[forkchoiceState, payloadAttribute],
-			this.headers,
-		);
-	}
-	async engine_forkchoiceUpdatedV3(
-		forkchoiceState: ForkchoiceStateV1,
-		payloadAttribute: PayloadAttributesV3,
-	): Promise<ForkchoiceUpdatedResponseV1> {
-		return await this.client.call(
-			EngineMethods.engine_forkchoiceUpdatedV3,
-			[forkchoiceState, payloadAttribute],
-			this.headers,
-		);
+		return new Proxy(this, {
+			get: (_, method: string) => {
+				return (...params: unknown[]) =>
+					this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
+			},
+		});
 	}
-	// engine/payload
-	async engine_newPayloadV1(
-		executionPayload: ExecutionPayloadV1,
-	): Promise<PayloadStatusV1> {
-		return await this.client.call(
-			EngineMethods.engine_newPayloadV1,
-			[executionPayload],
-			this.headers,
-		);
-	}
-	async engine_newPayloadV2(
-		executionPayload: ExecutionPayloadV1 | ExecutionPayloadV2,
-	): Promise<PayloadStatusNoInvalidBlockHash> {
-		return await this.client.call(
-			EngineMethods.engine_newPayloadV2,
-			[executionPayload],
-			this.headers,
-		);
-	}
-	async engine_newPayloadV3(
-		executionPayload: ExecutionPayloadV3,
-		expectedBlobVersionedHashes: Hash32[],
-		rootOfTheParentBeaconBlock: Hash32,
-	): Promise<PayloadStatusNoInvalidBlockHash> {
-		return await this.client.call(
-			EngineMethods.engine_newPayloadV3,
-			[
-				executionPayload,
-				expectedBlobVersionedHashes,
-				rootOfTheParentBeaconBlock,
-			],
-			this.headers,
-		);
-	}
-	async engine_newPayloadV4(
-		executionPayload: ExecutionPayloadV3,
-		expectedBlobVersionedHashes: Hash32[],
-		rootOfTheParentBeaconBlock: Hash32,
-		executionRequests: Bytes[],
-	): Promise<PayloadStatusNoInvalidBlockHash> {
-		return await this.client.call(
-			EngineMethods.engine_newPayloadV4,
-			[
-				executionPayload,
-				expectedBlobVersionedHashes,
-				rootOfTheParentBeaconBlock,
-				executionRequests,
-			],
-			this.headers,
-		);
-	}
-	async engine_getPayloadV1(payloadId: Bytes8): Promise<ExecutionPayloadV1> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadV1,
-			[payloadId],
-			this.headers,
-		);
-	}
-	async engine_getPayloadV2(payloadId: Bytes8): Promise<{
-		executionPayload: ExecutionPayloadV1 | ExecutionPayloadV2;
-		blockValue: Uint256;
-	}> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadV2,
-			[payloadId],
-			this.headers,
-		);
-	}
-	async engine_getPayloadV3(payloadId: Bytes8): Promise<{
-		executionPayload: ExecutionPayloadV3;
-		blockValue: Uint256;
-		blobsBundle: BlobsBundleV1;
-		shouldOverrideBuilder: boolean;
-	}> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadV3,
-			[payloadId],
-			this.headers,
-		);
-	}
-	async engine_getPayloadV4(payloadId: Bytes8): Promise<{
-		executionPayload: ExecutionPayloadV3;
-		blockValue: Uint256;
-		blobsBundle: BlobsBundleV1;
-		shouldOverrideBuilder: boolean;
-		executionRequests: Bytes[];
-	}> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadV4,
-			[payloadId],
-			this.headers,
-		);
-	}
-	async engine_getPayloadV5(payloadId: Bytes8): Promise<{
-		executionPayload: ExecutionPayloadV3;
-		blockValue: Uint256;
-		blobsBundle: BlobsBundleV2;
-		shouldOverrideBuilder: boolean;
-		executionRequests: Bytes[];
-	}> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadV5,
-			[payloadId],
-			this.headers,
-		);
-	}
-	async engine_getPayloadBodiesByHashV1(
-		arrayOfBlockHashes: Hash32[],
-	): Promise<ExecutionPayloadBodyV1[]> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadBodiesByHashV1,
-			[arrayOfBlockHashes],
-			this.headers,
-		);
-	}
-	async engine_getPayloadBodiesByRangeV1(
-		startingBlockNumber: Uint64,
-		numberOfBlocksToReturn: Uint64,
-	): Promise<ExecutionPayloadBodyV1[]> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadBodiesByRangeV1,
-			[startingBlockNumber, numberOfBlocksToReturn],
-			this.headers,
-		);
-	}
-	async engine_newPayloadV5(
-		executionPayload: ExecutionPayloadV4,
-		expectedBlobVersionedHashes: Hash32[],
-		parentBeaconBlockRoot: Hash32,
-		executionRequests: Bytes[],
-	): Promise<PayloadStatusNoInvalidBlockHash> {
-		return await this.client.call(
-			EngineMethods.engine_newPayloadV5,
-			[
-				executionPayload,
-				expectedBlobVersionedHashes,
-				parentBeaconBlockRoot,
-				executionRequests,
-			],
-			this.headers,
-		);
-	}
-	async engine_getPayloadV6(payloadId: Bytes8): Promise<{
-		executionPayload: ExecutionPayloadV4;
-		blockValue: Uint256;
-		blobsBundle: BlobsBundleV2;
-		shouldOverrideBuilder: boolean;
-		executionRequests: Bytes[];
-	}> {
-		return await this.client.call(
-			EngineMethods.engine_getPayloadV6,
-			[payloadId],
-			this.headers,
-		);
-	}
-	// engine/transition-configuration
-	async engine_exchangeTransitionConfigurationV1(
-		consensusClientConfiguration: TransitionConfigurationV1,
-	): Promise<TransitionConfigurationV1> {
-		return await this.client.call(
-			EngineMethods.engine_exchangeTransitionConfigurationV1,
-			[consensusClientConfiguration],
-			this.headers,
-		);
+
+	setHeaders(headers: Record<string, string>) {
+		this.headers = {
+			...this.headers,
+			...headers,
+		};
+		return this;
 	}
 }
+
+export interface EngineExecutionClient
+	extends EngineRpcMethods<EngineMethodsSpec> { }