[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

@@ -73,7 +73,6 @@ The next sections will guide you through the process of creating a valid order.
 > For a quick snippet with the full process on posting an order see the [Post an Order Example](./docs/post-order-example.ts).
 
 ### 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.
 
@@ -92,23 +91,24 @@ import { CowSdk, OrderKind } from '@cowprotocol/cow-sdk'
 
 const mnemonic = 'fall dirt bread cactus...'
 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
+
+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.
-  - 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.
-  - This fee is never charged if you don't trade.
+  * 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.
+    * 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.
+    * This fee is never charged if you don't trade.
 
 To get the quote, you simply specify the trade you intent to do:
 
@@ -192,7 +192,6 @@ 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.
 
 One easy is to check in the CoW Explorer. You can create a CoW Explorer link if you have the `orderId`:
@@ -321,7 +320,6 @@ 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`
 
 ```js

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