feat: sdk extension for people to swap

[shoom3301]

README https://github.com/cowprotocol/cow-sdk/blob/feat/swap-for-people/src/trading/README.md

The shortest way to post an order

import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/sdk'

const sdk = new TradingSdk({
  chainId: SupportedChainId.SEPOLIA,
  signer: '<privateKeyOrEthersSigner>',
  appCode: '<YOUR_APP_CODE>',
})

const parameters: TradeParameters = {
  kind: OrderKind.BUY,
  sellToken: '0xfff9976782d46cc05630d1f6ebab18b2324d6b14',
  sellTokenDecimals: 18,
  buyToken: '0x0625afb445c3b6b7b929342a04a22599fd5dbb59',
  buyTokenDecimals: 18,
  amount: '120000000000000000'
}

const orderId = await sdk.postSwapOrder(parameters)

console.log('Order created, id: ', orderId)

Get quote -> confirm -> post order

import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/sdk'

const sdk = new TradingSdk({
  chainId: SupportedChainId.SEPOLIA,
  signer: '<privateKeyOrEthersSigner>',
  appCode: '<YOUR_APP_CODE>',
})

const parameters: TradeParameters = {
  kind: OrderKind.BUY,
  sellToken: '0xfff9976782d46cc05630d1f6ebab18b2324d6b14',
  sellTokenDecimals: 18,
  buyToken: '0x0625afb445c3b6b7b929342a04a22599fd5dbb59',
  buyTokenDecimals: 18,
  amount: '120000000000000000'
}

const { quoteResults, postSwapOrderFromQuote } = await sdk.getQuote(parameters)

const buyAmount = quoteResults.amountsAndCosts.afterSlippage.buyAmount

if (confirm(`You will get at least: ${buyAmount}, ok?`)) {
  const orderId = await postSwapOrderFromQuote()

  console.log('Order created, id: ', orderId)
}

[anxolin]

I like where this is going.

However, I imagined this differently.

Here you make a call to postSwapOrder once with the equivalent to what you input in the widget form, and it will post the order.

I think is great, but if someone needs to build a UI will need the quote information.

The problem I think is interesting to improve is, its freaking hard to come up with the parameters of the order as we send them to be signed.

This is why this should be broken in 2 steps:

• 1. Get order params
• 2. Post order

In (1) we will:

• Make a quote
• Take slippage into account
• prepare the app data
• handle eth flow
• return
  • order params, AS WE SHOULD SIGN THEM in the wallet
  • convenient info to show to the user
    • Mimum received
    • USD amounts
    • fee estimation
    • fee estimations in USD
    • slippage calculations
    • warnings of all sort! (let people to have good protection without effort)
    • etc

In essence, for me the great contribution is implementing this (1). Maybe this is herlpul:

• https://docs.google.com/document/d/1w1jxRUfSbQU-15FgC-sw85pY2Ep8-VDACEwzvndylvk/edit

For (2), we just need to pass the order params from (1) and pass them along the signer

Just some final 💡 I'd like to add. This logic will be made into a library, which we can reuse anywhere. I'd like to use it in BFF and implement a simple endpoint, so it allows non JS projects to easily get the trading parameters. This way, we make integrations dead simple

Here are some related notes on some similar idea:

https://www.notion.so/cownation/2023-10-Swap-as-Limit-orders-fee-0-5a00548015a14c9f939b934cb5e33309?pvs=4#2b4061efcce740bdb6c743ad269c5214

[anxolin]

I just want to add a plausible roadmap of this:

v1: Library
v2: Endpoint
v3: Using the same abstractions we can make the Swap Kit: https://www.notion.so/cownation/CoW-Swap-Kit-lib-623d1bbb4db2400b8db1d7ad44106c4d?pvs=4

This way we can provide "progressive integrations"
Widget --> Swap Kit --> Library / Endpoint --> You own thing (uses only blockchain)

Form left to right, you get more and more control. This way, we provide an easy way to start, and then ways to gain control

[socket-security]

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

[coveralls]

coverage: 72.791% (-6.8%) from 79.583%
when pulling 5639517 on feat/swap-for-people
into 97d0315 on main.

[coveralls]

coverage: 72.791% (-6.8%) from 79.583%
when pulling 5639517 on feat/swap-for-people
into 97d0315 on main.

[coveralls]

coverage: 78.378% (+0.3%) from 78.071%
when pulling eec09d4 on feat/swap-for-people
into 8a8ce30 on main.

[alfetopito]

Great job!

I have a couple of comments/questions/nitpicks

[alfetopito]

All good, just make sure the CI tasks are passing.
Unittests are currently failing.

[socket-security]

Report too large to display inline

View full report↗︎