New SDK + API

[ArjunBhuptani]

SDK currently imports too many dependencies, resulting in a bloated bundle which can be untenable for integrators.

New SDK spec: https://www.notion.so/connext/Connext-New-SDK-Spec-fa52e9f465314102b47cf82f233013c3

[alexwhte]

now that we're relying a lot on SDK for integrations were starting to see some issues with it being bloated and pulling in a lot of deps which it doesnt need. i think its worth redesigning the SDK and deps from the ground up to make sure its super lightweight and works super well some dapps wont integrate us if the SDK is over a certain bundle size

https://discord.com/channels/992549151134982234/1083352842133319720

[alexwhte]

Work in #3749 is higher pri, this requires more scoping out

[rhlsthrm]

https://www.notion.so/connext/SDK-Optimization-3749cc1cd7824e568df5ca153fe351c8?pvs=4

Scoped here.

[alexwhte]

@just-a-node will add Chai stuff to the spec

[rodsouto]

Hi, I'm having this problem too. I just need to estimate the relayer fee, but installing the sdk increases the bundle size almost 2.5MB (a 3.4x increase compared to the previous size).

It would be great to have better tree shaking support to improve this.

[rhlsthrm]

Adding spec here:

Tasks:

• [ ] Remove fs and path dependencies. Likely requires creating a secondary package with only SDK-needed utils.
• [ ] Remove contracts dependency. Create a minimal contracts export which contains minimal contract addresses and ABIs. Might need to be manually generated for now.
• [ ] Tree shaking. Requires bundling with Webpack.
• [ ] Migrate from Ethers (large bundle size) to Viem which is fully optimized.

[alexwhte]

Complexity: 13 See the discussion in Backlog Prio 1

Powered by Parabol

[alexwhte]

Impact: 4 See the discussion in Backlog Prio 1

Powered by Parabol

[alexwhte]

Urgency: 3 See the discussion in Backlog Prio 1

Powered by Parabol

[alexwhte]

Complexity: 13 See the discussion in Sprint Poker #​​26

Powered by Parabol

[alexwhte]

Impact: 4 See the discussion in Sprint Poker #​​27

Powered by Parabol

[alexwhte]

Urgency: 4 See the discussion in Sprint Poker #​​27

Powered by Parabol

[alexwhte]

Complexity: 21 See the discussion in Sprint Poker #​​29

Powered by Parabol

[alexwhte]

Impact: 4 See the discussion in Sprint Poker #​​30

Powered by Parabol

[alexwhte]

Urgency: 3 See the discussion in Sprint Poker #​​30

Powered by Parabol

[alexwhte]

note: Max from LiFi complained about server issues last week. Doing this will enable us to move out of server to stop hosting SDK

[alexwhte]

note off of recent Socket issues:
Aggregator integrations can technically read pool contracts to see if there's enough liquidity. SDK could have helper functions to make that easier. But relying on that can run into issues with too many calls

consdier other iterations on docs to handle this instaed and focus on performance

[t0rbik]

Hey all, is there an ETA for the update? Thanks.

[just-a-node]

We'll be releasing an Everclear API so this will be sunset