search

yearn / yearn-sdk

🦧 SDK for the yearn.finance platform. WIP
https://npm.im/@yfi/sdk
MIT License
53 stars 56 forks source link

`disableAllowlist` was removed, creating a backwards incompatible change #242

Closed cjthompson closed 2 years ago

cjthompson commented 2 years ago

PR #220 removed the ContextValue property of disableAllowlist.

This change is backwards incompatible. This change was neither documented nor is there an explanation for people using <=1.0.30 on how to correctly change their code.

I discovered this after a dependency upgrade brought in the latest @yfi/sdk v1.1.1 and our build immediately failed with a TypeScript error referencing this property.

What is the correct way to change code that previously relied on disableAllowlist? Does just removing the use of property fix it, or is additional work required?

jstashh commented 2 years ago

@cjthompson sorry about that, we deliberated about how to handle the use of the allow list a lot, and I don't think we did it very well unfortunately, with a lot of back and forth. You should be able to remove it from the Context object - on versions >1.0.31 the allow list is always used, validating all writes made by the sdk on chain

We'll be more aware of breaking changes between versions in the future, and follow semver more accurately. We do document releases with a bit more info in the web channel of our discord

0xdef1cafe commented 2 years ago

@jstashh thanks for the info - please feel free to close as we've removed disableAllowList from where we use the constructor everywhere.