[SDK dogfooding] Refactoring, split API's, new assembling, Swagger

.eslintrc.json

@@ -11,5 +11,5 @@
     "prettier/prettier": "error"
   },
 
-  "ignorePatterns": ["dist", "node_modules", "src/api/cow-subgraph/graphql.ts"]
+  "ignorePatterns": ["dist", "node_modules", "src/subgraph/graphql.ts"]
 }

.github/workflows/build.yml

@@ -12,6 +12,9 @@ on:
   release:
     types: [published]
 
+env:
+  NODE_VERSION: lts/gallium
+
 jobs:
   build:
     name: Build Package
@@ -30,7 +33,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 14
+          node-version: ${{ env.NODE_VERSION }}
 
       - uses: actions/cache@v2
         with:
@@ -45,6 +48,6 @@ jobs:
           yarn install --cache-folder ./.yarncache --frozen-lockfile
           rm -rf .yarncache
           yarn cache clean
-          
+
       - name: Build app
         run: yarn build

.github/workflows/publish.yml

@@ -4,17 +4,20 @@ on:
   release:
     types: [published]
 
+env:
+  NODE_VERSION: lts/gallium
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: ${{ env.NODE_VERSION }}
           registry-url: 'https://registry.npmjs.org'
           scope: '@cowprotocol'
       - run: yarn --frozen-lockfile
-      - run: bash src/workflows/publish.sh
+      - run: bash workflows/publish.sh
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}

.github/workflows/test.yml

@@ -2,6 +2,7 @@ name: Unit tests & Coverage
 on: [push, pull_request]
 
 env:
+  NODE_VERSION: lts/gallium
   COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
 
 jobs:
@@ -19,7 +20,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 14
+          node-version: ${{ env.NODE_VERSION }}
 
       - name: Yarn cache
         uses: actions/cache@v2

.prettierignore

@@ -1,2 +1,3 @@
 dist/
-src/api/cow-subgraph/graphql.ts
+src/subgraph/graphql.ts
+src/order-book/generated

README.md

@@ -56,7 +56,7 @@ console.log(trades)
 ## Sign and Post orders
 In order to trade, you will need to create a valid order first.
 
-On the contraty to other decentralised exchanges, creating orders is free in CoW Protocol. This is because, one of the 
+On the contraty to other decentralised exchanges, creating orders is free in CoW Protocol. This is because, one of the
 most common ways to do it is by created offchain signed messages (meta-transactions, uses `EIP-712` or `EIP-1271`).
 
 Posting orders is a three steps process:
@@ -71,9 +71,9 @@ The next sections will guide you through the process of creating a valid order.
 
 ### Enable tokens (token approval)
 Because of the use of off-chain signing (meta-transactions), users will need to **Enable the sell token**  before signed
-orders can be considered as valid ones. 
+orders can be considered as valid ones.
 
-This enabling is technically an `ERC-20` approval, and is something that needs to be done only once. After this all 
+This enabling is technically an `ERC-20` approval, and is something that needs to be done only once. After this all
 order creation can be done for free using offchain signing.
 
 > For more details see https://docs.cow.fi/tutorials/how-to-submit-orders-via-the-api/1.-set-allowance-for-the-sell-token
@@ -90,18 +90,18 @@ const wallet = Wallet.fromMnemonic(mnemonic)
 const cowSdk = new CowSdk(
   100, {            // Leaving chainId empty will default to MAINNET
   signer: wallet  // Provide a signer, so you can sign order
-  }) 
+  })
 ```
 
 ### STEP 1: Get Market Price
 To create an order, you need to get a price/fee quote first:
 
   * The SDK will give you easy access to the API, which returns the `Market Price` and the `Fee` for any given trade you intent to do.
-  * The returned `Market Price` is not strictly needed, you can use your own pricing logic. 
+  * The returned `Market Price` is not strictly needed, you can use your own pricing logic.
     * You can choose a price that is below this Market price (**Market Order**), or above Market Price (**Limit Order**).
-  * The `Fee` however is very important. 
-    * It is the required amount in sell token the trader agrees on paying for executing the order onchain. 
-    * Normally, its value is proportional to the current Gas Price of the network. 
+  * The `Fee` however is very important.
+    * It is the required amount in sell token the trader agrees on paying for executing the order onchain.
+    * Normally, its value is proportional to the current Gas Price of the network.
     * This fee is never charged if you don't trade.
 
 To get the quote, you simply specify the trade you intent to do:
@@ -133,7 +133,7 @@ const { sellToken, buyToken, validTo, buyAmount, sellAmount, receiver, feeAmount
 
 // Prepare the RAW order
 const order = {
-  kind: OrderKind.SELL, // SELL || BUY  
+  kind: OrderKind.SELL, // SELL || BUY
   receiver, // Your account or any other
   sellToken,
   buyToken,
@@ -144,10 +144,10 @@ const order = {
   validTo,
 
   // Limit Price
-  //    You can apply some slippage tolerance here to make sure the trade is executed. 
+  //    You can apply some slippage tolerance here to make sure the trade is executed.
   //    CoW protocol protects from MEV, so it can work with higher slippages
   sellAmount,
-  buyAmount, 
+  buyAmount,
 
   // Use the fee you received from the API
   feeAmount,
@@ -162,8 +162,8 @@ const signedOrder = await cowSdk.signOrder(order)
 
 At this point, you have a signed order. So next step will be to post it to the API so it's considered by the solvers and executed.
 
-  
-## STEP 3: **Post the signed order to the API**: 
+
+## STEP 3: **Post the signed order to the API**:
 Once you have a signed order, last step is to send it to the API.
   * The API will accept the order if its correctly signed, the deadline is correct, and the fee is enough to settle it
   * Once accepted, the order will be `OPEN` until the specified `validTo` date (expiration)
@@ -187,7 +187,7 @@ const orderId = await cowSdk.cowApi.sendOrder({
 
 
 ### BONUS: Show link to Explorer
-Once the order is posted, its good to allow to check the state of it. 
+Once the order is posted, its good to allow to check the state of it.
 
 One easy is to check in the CoW Explorer. You can create a CoW Explorer link if you have the `orderId`:
 
@@ -216,7 +216,7 @@ This will create a document similar to:
   "version": "0.4.0",
   "appCode": "YourApp",
   "metadata": {}
-} 
+}
 ```
 
 After creating the most basic document, you can see how to attach additional meta-data items.
@@ -264,7 +264,7 @@ You can calculate the `AppData` Hex, and its corresponding `cidV0` using the SDK
 const { appDataHash, cidv0 } = await cowSdk.metadataApi.calculateAppDataHash(appDataDoc)
 ```
 
-Note how this operation is deterministic, so given the same document, it will always generate the same hash. 
+Note how this operation is deterministic, so given the same document, it will always generate the same hash.
 
 This method can be used to calculate the actual hash before uploading the document to IPFS.
 
@@ -299,8 +299,8 @@ Alternatively, you can upload the document on your own using any other service.
 ```js
 // Make sure you provide the IPFS params when instantiating the SDK
 const cowSdk = new CowSdk(100, {
-  ipfs: { 
-    pinataApiKey: 'YOUR_PINATA_API_KEY', 
+  ipfs: {
+    pinataApiKey: 'YOUR_PINATA_API_KEY',
     pinataApiSecret: 'YOUR_PINATA_API_SECRET'
   },
 })
@@ -310,7 +310,7 @@ const uploadedAppDataHash = await cowSdk.metadataApi.uploadMetadataDocToIpfs(app
 ```
 
 ## Convert IPFS CIDv0 to AppData (and back)
-Given an IPFS CIDv0 you can convert it to an `AppData` 
+Given an IPFS CIDv0 you can convert it to an `AppData`
 
 ```js
 const decodedAppDataHex = await cowSdk.metadataApi.cidToAppDataHex('QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs')

graphql-codegen.yml

@@ -1,8 +1,8 @@
 overwrite: true
 schema: "https://api.thegraph.com/subgraphs/name/cowprotocol/cow"
-documents: './src/api/cow-subgraph/queries.ts'
+documents: './src/subgraph/queries.ts'
 generates:
-  src/api/cow-subgraph/graphql.ts:
+  src/subgraph/graphql.ts:
     plugins:
       - "typescript"
       - "typescript-operations"

package.json

@@ -2,27 +2,24 @@
   "name": "@cowprotocol/cow-sdk",
   "version": "1.0.2-RC.0",
   "license": "(MIT OR Apache-2.0)",
-  "source": "src/index.ts",
-  "main": "./dist/index.js",
-  "module": "./dist/index.module.js",
-  "exports": {
-    "require": "./dist/index.js",
-    "default": "./dist/index.modern.mjs"
-  },
-  "types": "dist/index.d.ts",
   "files": [
     "/dist"
   ],
   "scripts": {
-    "build": "microbundle -f modern,esm,cjs",
-    "start": "microbundle -f modern,esm,cjs watch",
+    "prebuild": "rm -rf dist && yarn run codegen",
+    "build": "tsc --module commonjs",
+    "postbuild": "cp package.json dist && cp README.md dist",
+    "start:metadata": "tsc-watch --noClear -p ./tsconfig.json --onSuccess \"node ./dist/metadata/index.js\"",
+    "start:order-book": "tsc-watch --noClear -p ./tsconfig.json --onSuccess \"node ./dist/order-book/index.js\"",
+    "start:subgraph": "tsc-watch --noClear -p ./tsconfig.json --onSuccess \"node ./dist/subgraph/index.js\"",
     "lint": "eslint src",
     "format": "prettier --write \"src/**/*.+(ts|json)\"",
     "test": "jest",
     "test:coverage": "jest --coverage --json --outputFile=jest.results.json && cat ./coverage/lcov.info | coveralls",
-    "prepare": "npm run build && npm run graphql:codegen",
+    "codegen": "npm run graphql:codegen && npm run swagger:codegen",
     "prepublishOnly": "npm test && npm run lint",
-    "graphql:codegen": "graphql-codegen --config graphql-codegen.yml"
+    "graphql:codegen": "graphql-codegen --config graphql-codegen.yml",
+    "swagger:codegen": " openapi --input https://raw.githubusercontent.com/cowprotocol/services/fix/orderbook-openapi/crates/orderbook/openapi.yml --output src/order-book/generated --client fetch --name OrderBookClient"
   },
   "dependencies": {
     "@cowprotocol/app-data": "^0.0.3-RC.0",
@@ -32,30 +29,31 @@
     "graphql": "^16.3.0",
     "graphql-request": "^4.3.0",
     "ipfs-only-hash": "^4.0.0",
-    "loglevel": "^1.8.0",
-    "multiformats": "^9.6.4",
-    "paraswap": "^5.2.0",
-    "paraswap-core": "^1.0.2"
+    "multiformats": "^9.6.4"
   },
   "devDependencies": {
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
     "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
-    "@graphql-codegen/cli": "2.6.2",
-    "@graphql-codegen/typescript": "2.4.8",
-    "@graphql-codegen/typescript-operations": "^2.3.5",
-    "@types/jest": "^27.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.9.0",
-    "@typescript-eslint/parser": "^5.9.0",
+    "@graphql-codegen/cli": "3.0.0",
+    "@graphql-codegen/typescript": "3.0.0",
+    "@graphql-codegen/typescript-operations": "^3.0.0",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
     "babel-plugin-inline-import": "^3.0.0",
     "coveralls": "^3.1.1",
-    "eslint": "^8.6.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.3.1",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.4.2",
     "jest-fetch-mock": "^3.0.3",
-    "microbundle": "^0.15.0",
-    "prettier": "^2.5.1"
+    "openapi-typescript-codegen": "^0.23.0",
+    "prettier": "^2.5.1",
+    "tsc-watch": "^6.0.0",
+    "typescript": "^4.9.5"
   },
   "jest": {
     "automock": false,
@@ -64,8 +62,7 @@
       "./setupTests.js"
     ],
     "collectCoverageFrom": [
-      "src/**/*.{ts,tsx}",
-      "!src/api/cow/errors/*.{ts,tsx}"
+      "src/**/*.{ts,tsx}"
     ]
   },
   "keywords": [

setupTests.js

@@ -1,13 +1,7 @@
 import fetchMock from 'jest-fetch-mock'
-import log from 'loglevel'
 
 fetchMock.enableMocks()
 
 jest.setMock('cross-fetch', fetchMock)
 
 global.window = global
-
-log.info = jest.fn
-log.debug = jest.fn
-log.error = jest.fn
-log.setLevel = jest.fn