@asyncswap/eth-rpc 0.4.1 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @asyncswap/eth-rpc
 
+## 0.4.2
+
+### Patch Changes
+
+- 9512db5: update documentation
+- Updated dependencies [9512db5]
+  - @asyncswap/jsonrpc@0.4.2
+
 ## 0.5.1
 
 ### Patch 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,11 @@ const balance = await eth.eth_getBalance(
 );
 console.log("Balance:", balance);
 eth.eth_getTransactionCount("0x34", "safe");
+```
+
+### Engine API Client
 
+```typescript
 import { EngineExecutionClient } from '@asyncswap/eth-rpc';
 
 const engineUrl = 'https://localhost:8551';
@@ -39,109 +43,27 @@ const rpc = 'https://relay.flashbots.net';
 const client = new EthFlashbotsClient(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/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.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"
 	}
 }