Withdrawals API

The Withdrawals API service offers an utility for estimating the waiting time for withdrawals within the Lido protocol on Ethereum.

The service is helpful for stakers, providing insights from the moment of withdrawal request placement to its finalization when the request becomes claimable.

Use Cases

• Estimation before request: users can estimate the waiting time before placing a withdrawal request.
• Tracking the existing request: users can track the estimated waiting time for the already placed request.

ℹ️ See also the detailed explanation of the estimation algorithm.

Prerequisites

• Node.js (version 20.0 or higher)
• Yarn (version 1.22 or higher)

Installation

$ yarn install

Configuration

# Edit the newly created `.env` file to populate with proper values.
$ cp sample.env .env

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn build
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

Release flow

To create a new release:

1. Merge all changes to the main branch.
2. After the merge, the Prepare release draft action will run automatically. When the action is complete, a release draft is created.
3. When you need to release, go to Repo → Releases.
4. Publish the desired release draft manually by clicking the edit button - this release is now the Latest Published.
5. After publication, the action to create a release bump will be triggered automatically.

License

Withdawals API is MIT licensed.