https://github.com/hairyf/ethers-batch-request

https://github.com/hairyf/ethers-batch-request

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hairyf/ethers-batch-request
• Owner: hairyf
• License: mit
• Created: 2024-02-02T03:48:27.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-07-20T02:57:19.000Z (5 months ago)
• Last Synced: 2024-09-20T05:51:01.988Z (3 months ago)
• Language: TypeScript
• Size: 103 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# ethers-batch-request

HTTP batch request is a feature most Ethereum clients support, for example, [Geth](https://geth.ethereum.org/docs/interacting-with-geth/rpc/batch). With batch requests enabled, multiple HTTP requests can be packaged into one single request and sent to the server. Server process this bulk request and returns a bulk result. All of these are done in a single round trip.

This feature can be useful for reducing the load on the server and improving the performance to a certain extent.

15 measurements were averaged, which shows the performance of batch request > Multicall > normal request. Compared with sending single requests in parallel, batch request reduces 38% of the total request time, and multicall reduces 18% of the total request time.

Data source: [HTTP batch request VS multicall contract](https://docs.chainstack.com/docs/http-batch-request-vs-multicall-contract)

`ethers-batch-request` will automatically process the queue and return the correct value:

```sh

# with pnpm

pnpm add ethers-batch-request

# with yarn

yarn add ethers-batch-request

```

```ts

import { BatchContract } from 'ethers-batch-request'

import { providers } from 'ethers'

// BatchContract works the same way as ethers' Contract

const provider = new providers.JsonRpcProvider('https://...')

const contract = new BatchContract('0x...', interface, provider)

// BatchContract will automatically package into an HTTP request

// When there are no new queries, it sends a batch request and returns all the values

const owners = await Promise.all([

  contract.ownerOf(0),

  contract.ownerOf(1),

  contract.ownerOf(2),

  contract.ownerOf(3),

  contract.ownerOf(4),

  contract.ownerOf(5),

])

```

 

> Currently, batch querying is only supported for the Contract.

## Precautions

Requests in a batch request are executed in order, which means if a new block is received during execution, the subsequent results are likely to be different.

Both batch request and multicall contract return multiple results in a single response. Both of them require much more computational resources. They can easily trigger “request timeout” errors and “response size too big” errors, which makes them not suitable for complex calls.

## License

[MIT](./LICENSE) License © 2023-PRESENT [Hairyf](https://github.com/hairyf)