feat: sdk extension for people to swap #213

shoom3301 · 2024-06-26T13:19:01Z

See https://github.com/cowprotocol/cow-sdk/blob/56985986c7bf3585eed85d5b71e221f69ed763a2/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
1. 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 · 2024-06-26T15:46:22Z

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 · 2024-06-27T15:13:28Z

👍 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↗︎

…at/swap-for-people

coveralls · 2024-07-05T15:11:57Z

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

coveralls · 2024-07-05T15:11:57Z

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

…at/swap-for-people

coveralls · 2024-09-02T14:51:44Z

coverage: 78.814% (+0.6%) from 78.23%
when pulling 953f848 on feat/swap-for-people
into 5ad85a1 on main.

…at/swap-for-people # Conflicts: # src/index.ts

…at/swap-for-people

src/common/consts.ts

…at/swap-for-people # Conflicts: # src/cow-shed/CoWShedHooks.ts # src/cow-shed/contracts.ts

shoom3301 · 2024-11-08T12:41:28Z

@anxolin thanks for the feedback!

This is why this should be broken in 2 steps:

✅

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

✅

Mimum received

✅

USD amounts

❌

fee estimation

✅

fee estimations in USD

❌

slippage calculations

✅

warnings of all sort! (let people to have good protection without effort)

❌

Points that are not done (❌) - we discussed them and decided to not implement them right now.

anxolin

I'll continue reviewing in another moment cause I need to leave, so far looks great and easy to use.

anxolin · 2024-11-08T13:01:45Z

examples/vanilla/src/formState.ts

+}
+
+export const getFormState = (): FormState => {
+  return Object.fromEntries(new FormData(document.getElementById('form') as HTMLFormElement)) as unknown as FormState


Good old vanilla :)

anxolin · 2024-11-08T13:03:54Z

examples/vanilla/src/formState.ts

+  const buyToken = TOKENS[chainId].find((t) => t.address === _buyToken)
+  const decimals = isSell ? sellToken.decimals : buyToken.decimals
+  const multiplicator = decimals > 3 ? 3 : 0
+  const amount = BigInt(+_amount * 10 ** multiplicator) * BigInt(10 ** (decimals - multiplicator))


I didn't get what you want to do here

anxolin · 2024-11-08T13:09:10Z

package.json

@@ -27,10 +27,11 @@
    "prepare": "npm run build",
    "prepublishOnly": "npm test && npm run lint",
    "graphql:codegen": "graphql-codegen --config graphql-codegen.yml",
-    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/v2.281.0/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",
+    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/main/crates/orderbook/openapi.yml --output src/order-book/generated --exportServices false --exportCore false",


not sure @alfetopito will like this

anxolin · 2024-11-08T13:11:36Z

src/composable/ConditionalOrder.ts

@@ -95,7 +96,7 @@ export abstract class ConditionalOrder<D, S> {
  assertIsValid(): void {
    const isValidResult = this.isValid()
    if (!isValidResult.isValid) {
-      throw new Error(`Invalid order: ${isValidResult.reason}`)
+      throw new Error(`Invalid order: ${(isValidResult as IsNotValid).reason}`)


Probably this cast has to be done cause we didn't use type assertions. Not from this PR though

anxolin · 2024-11-08T13:13:20Z

src/order-signing/utils.ts

+ * @param {Order} order order to sign
+ * @param {Pick<OrderUidParams, 'owner'>} params order unique identifier parameters.
+ */
+export async function generateOrderId(


I would swear we had already one piece of code doing this. I remember in the watch-tower and SDK deriving the orderId form the order data

This is what I meant:

cow-sdk/src/composable/ConditionalOrder.ts

Line 286 in 97d0315

const orderUid = await computeOrderUid(chainId, owner, fromStructToOrder(order))

socket-security · 2024-11-12T04:54:00Z

Report too large to display inline

View full report↗︎

shoom3301 added 2 commits June 26, 2024 18:18

feat: SDK extension for people to swap

6788008

feat: SDK extension for people to trade

e8927e2

anxolin reviewed Jun 26, 2024

View reviewed changes

refactor: move files to trading dir

59f550b

feat: js example for trade-sdk

ee092bb

shoom3301 force-pushed the feat/swap-for-people branch from 6fab215 to ee092bb Compare June 27, 2024 15:38

chore: trade sdk examples

775e687

cowprotocol deleted a comment from socket-security bot Jun 28, 2024

docs: trading SDK docs

bbece96

shoom3301 requested a review from a team July 5, 2024 14:53

shoom3301 marked this pull request as ready for review July 5, 2024 14:53

shoom3301 added 4 commits July 5, 2024 20:04

chore: encapsulate networkCostsAmount

f27a94d

Merge branch 'main' of https://github.com/cowprotocol/cow-sdk into fe…

d98230a

…at/swap-for-people

chore: fix build

f82841d

chore: fix build

5639517

Merge branch 'main' of https://github.com/cowprotocol/cow-sdk into fe…

92c7d14

…at/swap-for-people

cowprotocol deleted a comment from socket-security bot Sep 5, 2024

shoom3301 added 7 commits November 5, 2024 13:44

Merge branch 'main' of https://github.com/cowprotocol/cow-sdk into fe…

6896b20

…at/swap-for-people # Conflicts: # src/index.ts

chore: make networkCostsAmount optional

94b21ff

feat: calculate unique OrderId util

bf87d83

feat: support on-chain trades

9c23fae

chore: reduce getOrderToSign parameters

6fcff58

Merge branch 'main' of https://github.com/cowprotocol/cow-sdk into fe…

490e7d4

…at/swap-for-people

feat: support on-chain orders

4a1f35e

alfetopito reviewed Nov 7, 2024

View reviewed changes

src/common/consts.ts Outdated Show resolved Hide resolved

shoom3301 added 9 commits November 7, 2024 17:04

test: app data utils

240ebfb

test: test calculateUniqueOrderId

a8d1ec9

test: test getOrderToSign

59fd04b

test: test getQuote

6351ae7

test: test postCoWProtocolTrade

56692ab

test: test postLimitOrder

9d828bf

test: test postOnChainTrade

f106189

docs: docs for postOnChainTrade

99a1cad

Merge branch 'main' of https://github.com/cowprotocol/cow-sdk into fe…

5698598

…at/swap-for-people # Conflicts: # src/cow-shed/CoWShedHooks.ts # src/cow-shed/contracts.ts

shoom3301 requested a review from a team November 8, 2024 12:30

shoom3301 self-assigned this Nov 8, 2024

shoom3301 added 2 commits November 8, 2024 17:32

chore: up docs

03d212e

fix: update eth-flow addresses

867b05e

shoom3301 changed the title ~~feat: SDK extension for people to swap~~ feat: sdk extension for people to swap Nov 8, 2024

shoom3301 added 2 commits November 8, 2024 17:46

chore: fix tests

62ee519

chore: export helpers

4f788ed

anxolin reviewed Nov 8, 2024

View reviewed changes

chore: rc version

953f848

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: sdk extension for people to swap #213

feat: sdk extension for people to swap #213

shoom3301 commented Jun 26, 2024 •

edited

Loading

anxolin left a comment •

edited

Loading

anxolin commented Jun 26, 2024

socket-security bot commented Jun 27, 2024 •

edited

Loading

coveralls commented Jul 5, 2024

coveralls commented Jul 5, 2024

coveralls commented Sep 2, 2024 •

edited

Loading

shoom3301 commented Nov 8, 2024

anxolin left a comment

anxolin Nov 8, 2024

anxolin Nov 8, 2024

anxolin Nov 8, 2024

anxolin Nov 8, 2024

anxolin Nov 8, 2024

anxolin Nov 8, 2024

socket-security bot commented Nov 12, 2024

feat: sdk extension for people to swap #213

Are you sure you want to change the base?

feat: sdk extension for people to swap #213

Conversation

shoom3301 commented Jun 26, 2024 • edited Loading

The shortest way to post an order

Get quote -> confirm -> post order

anxolin left a comment • edited Loading

Choose a reason for hiding this comment

anxolin commented Jun 26, 2024

socket-security bot commented Jun 27, 2024 • edited Loading

coveralls commented Jul 5, 2024

coveralls commented Jul 5, 2024

coveralls commented Sep 2, 2024 • edited Loading

shoom3301 commented Nov 8, 2024

anxolin left a comment

Choose a reason for hiding this comment

anxolin Nov 8, 2024

Choose a reason for hiding this comment

anxolin Nov 8, 2024

Choose a reason for hiding this comment

anxolin Nov 8, 2024

Choose a reason for hiding this comment

anxolin Nov 8, 2024

Choose a reason for hiding this comment

anxolin Nov 8, 2024

Choose a reason for hiding this comment

anxolin Nov 8, 2024

Choose a reason for hiding this comment

socket-security bot commented Nov 12, 2024

shoom3301 commented Jun 26, 2024 •

edited

Loading

anxolin left a comment •

edited

Loading

socket-security bot commented Jun 27, 2024 •

edited

Loading

coveralls commented Sep 2, 2024 •

edited

Loading