Skip to content

Commit

Permalink
Merge pull request #182 from lidofinance/feature/si-1649-support-widg…
Browse files Browse the repository at this point in the history
…et-functional

Docs
  • Loading branch information
Jeday authored Dec 10, 2024
2 parents 3e79845 + 86700bc commit 077a4e5
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 1,394 deletions.
8 changes: 8 additions & 0 deletions docs/sdk/changelog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
sidebar_position: 4
title: Changelog
---

import Changelog from '../../packages/sdk/CHANGELOG.md';

<Changelog />
8 changes: 8 additions & 0 deletions docs/sdk/migration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
sidebar_position: 5
title: Migration Guide
---

import Migration from '../../packages/sdk/MIGRATION.md';

<Migration />
23 changes: 23 additions & 0 deletions packages/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
# 4.1.0

## SDK

### Added

- `TransactionCallback` can be async and are now awaited
- `TransactionCallbackStage.SIGN` stage in callback can now return custom gas limit that overrides estimated one
- `estimateTransfer` and `estimateApprove` for all (w)stETH instances
- `LidoSDKL2` now has `approveWstethForWrapEstimateGas`, `wrapWstethToStethEstimateGas`,`unwrapStethEstimateGas` helpers
- `LidoSDKStake` now has `stakeEthEstimateGas` helper
- `LidoSDKWrap` now has `wrapStethEstimateGas`, `approveStethForWrapEstimateGas` and `unwrapEstimateGas` helpers
- `LidoSDKWithdraw.claim` now has `claimRequestsEstimateGas` helper
- `LidoSDKWithdraw.request` now has `requestWithdrawalEstimateGas`,`requestWithdrawalWithPermitEstimateGas` helpers
- `LidoSDKWithdraw.request.requestWithdrawalWithPermit` now accepts custom `deadline` prop for permit signature

### Fixed

- `LIDO_CONTRACT_NAMES`, `LIDO_L2_CONTRACT_NAMES`, `LIDO_L2_CONTRACT_NAMES` can now be used directly as non-const enums
- `LidoLocatorAbi` is now exported from `core`
- `PopulatedTransaction` that is returned from `populateTX` helpers now only has relevant fields
- `LidoSDKWrap.wrapEthEstimateGas`now applies correct gas limit

# 4.0.1

## SDK
Expand Down
6 changes: 3 additions & 3 deletions packages/sdk/MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ Internal utilities:
## Events

- `getRebaseEventsByDays` was removed
- `getRebaseEvents` arguments signature was changed to fit wide range of use-cases, [see docs](./README.md#`getRebaseEvents`)
- `getRebaseEvents` arguments signature was changed to fit wide range of use-cases, [see docs](https://lidofinance.github.io/lido-ethereum-sdk/modules/lido-events#getrebaseevents)
- `getLastRebaseEvents` covers previous use case of `getRebaseEvents`

## Rewards

`getRewards...` props signature changed to fit wide range of use cases [see docs](./README.md#Rewards)
`getRewards...` props signature changed to fit wide range of use cases [see docs](https://lidofinance.github.io/lido-ethereum-sdk/modules/rewards)

Props:

- `to`, `from`, `back` props, [see docs](./README.md#Rewards).
- `to`, `from`, `back` props, [see docs](https://lidofinance.github.io/lido-ethereum-sdk/modules/reward).
- `step` prop was removed due to conflicting defaults. Replaced with `stepEntities`(defaults 1000) and `stepBlocks`(defaults 50000) for subgraph and chain methods accordingly.
- `getSubgraphUrl` now can receive subgraph id `null` for chains where it is not available

Expand Down
Loading

0 comments on commit 077a4e5

Please sign in to comment.