We are excited to announce the release of Version 2 of the Immutable Typescript SDK. This major update migrates the SDK to use the latest version of Ethers.js v6 and introduces several improvements in performance, compatibility, and developer experience. Whether you're building a new application or maintaining an existing one, V2 offers compelling reasons to upgrade.
New Features
Enhanced Performance and Smaller Bundle Size
Impacted Users: DevelopersGame StudiosWe've significantly optimized the SDK's bundle size and performance:
- Smaller Bundle Size: The impact of the SDK's bundle size has been reduced by approximately 300-400kb in most web applications
- Faster Installation: The SDK's footprint in your
node_moduleshas been reduced by 8x, from 75.1MB to just 9MB - Universal Compatibility: Improved bundling with proper ESM and CommonJS support for both Node.js and browser environments
These improvements mean faster builds, quicker deployments, and better performance for your applications.
Simplified Development Experience
Impacted Users: DevelopersWe've made several improvements to improve the developer experience and streamline the integration process:
- No More Configuration Overrides: Complex polyfills and browser configurations are no longer needed
- Universal Compatibility: Works out of the box in all environments including browsers, Node.js, and various bundlers
- Enhanced Package Security: All packages now include NPM package provenance for enhanced security
Breaking Changes and Migration Guide
Impacted Users: DevelopersThe V2 release includes some breaking changes that you'll need to be aware of when upgrading:
- Ethers.js v6 Update: The SDK now uses Ethers.js v6, requiring updates to any Ethers.js v5 code in your application
- New Checkout SDK Provider: A new
WrappedBrowserProviderclass has been introduced for Checkout SDK interactions - Passport ConnectEVM Changes: The
connectEvmmethod is now asynchronous and returns a promise
For a detailed migration guide and help with upgrading, check out our V1 to V2 Migration Guide.
Getting Started with V2
To get started with the V2 SDK, you'll first need to install the latest version of the sdk, and if used in your project, the latest version of Ethers.js:
- npm
- yarn
- pnpm
npm install @imtbl/sdk@latest
# if necessary, install Ethers.js v6
npm install ethers@6
yarn add @imtbl/sdk@latest
# if necessary, install Ethers.js v6
yarn add ethers@6
pnpm add @imtbl/sdk@latest
# if necessary, install Ethers.js v6
pnpm add ethers@6
For detailed installation instructions and usage examples, visit our SDK Documentation.
Upcoming Features
We're continuing to improve the SDK and have some exciting features in the pipeline:
- Additional performance optimizations and bundle size reductions
- Enhanced developer tooling and debugging capabilities
- Expanded documentation and examples
- And more!
Stay tuned for more updates and as always, happy building!