@asyncswap/eth-rpc 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @asyncswap/eth-rpc
 
+## 0.4.2
+
+### Patch Changes
+
+- 9512db5: update documentation
+- Updated dependencies [9512db5]
+  - @asyncswap/jsonrpc@0.4.2
+
+## 0.5.1
+
+### Patch Changes
+
+- 2598f09: updates docs
+
+## 0.5.0
+
+### Minor Changes
+
+- fd79ea3: updates api for eth-client and adds flasbots methods and headers
+
+### Patch Changes
+
+- Updated dependencies [43de065]
+- Updated dependencies [7e8300c]
+- Updated dependencies [7126afa]
+  - @asyncswap/jsonrpc@0.5.0
+
 ## 0.3.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'
@@ -22,37 +22,48 @@ const balance = await eth.eth_getBalance(
   "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
   "latest"
 );
-console.log('Balance:', balance);
+console.log("Balance:", balance);
+eth.eth_getTransactionCount("0x34", "safe");
 ```
 
-### Ethereum Engine Api
+### Engine API Client
 
-```ts
-import { EngineExecutionClient } from "@asyncswap/eth-rpc";
+```typescript
+import { EngineExecutionClient } from '@asyncswap/eth-rpc';
 
-const engineUrl = "https://localhost:8551";
+const engineUrl = 'https://localhost:8551';
 const engine = new EngineExecutionClient(engineUrl, process.env.JWT_TOKEN!);
 const payload = engine.engine_getPayloadV1("0x1");
 
 console.log(payload);
+
+import { EthFlashbotsClient } from '@asyncswap/eth-rpc';
+
+const rpc = 'https://relay.flashbots.net';
+const client = new EthFlashbotsClient(rpc);
+```
+
+## 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);
+}
 ```
 
-## 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
+## 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/package.json

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

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

@@ -19,6 +19,7 @@ declare global {
 		flashbots_getMevRefundTotalByRecipient = "flashbots_getMevRefundTotalByRecipient",
 		flashbots_getMevRefundTotalBySender = "flashbots_getMevRefundTotalBySender",
 	}
+
 	export enum BuilderNetMethods {
 		eth_sendBundle = "eth_sendBundle",
 		eth_sendRawTransaction = "eth_sendRawTransaction",