@cowprotocol/cow-sdk 0.0.1

package/README.md

@@ -0,0 +1,30 @@
+# CoW protocol SDK
+<p align="center">
+  <img width="400" src="docs/images/CoW.png">
+</p>
+
+
+### Install Dependencies
+
+```bash
+yarn
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Run
+
+```bash
+yarn start
+```
+
+### Unit testing
+
+```bash
+yarn test
+```
+

package/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', {targets: {node: 'current'}}],
+    '@babel/preset-typescript',
+  ],
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@cowprotocol/cow-sdk",
+  "version": "0.0.1",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.16.0",
+    "@types/jest": "^27.0.3",
+    "jest": "^27.3.1",
+    "microbundle": "^0.14.2"
+  },
+  "source": "src/index.ts",
+  "exports": {
+    "require": "./dist/cow-sdk.cjs",
+    "default": "./dist/cow-sdk.modern.js"
+  },
+  "main": "./dist/cow-sdk.cjs",
+  "module": "./dist/cow-sdk.module.js",
+  "unpkg": "./dist/cow-sdk.umd.js",
+  "scripts": {
+    "build": "microbundle",
+    "start": "microbundle watch",
+    "test": "jest"
+  },
+  "types": "dist/index.d.ts"
+}

package/src/CowSdk.ts

@@ -0,0 +1,10 @@
+import { version as SDK_VERSION } from '../package.json'
+import { validateAppDataDocument } from './utils/appData'
+
+export class CowSdk {
+  static version = SDK_VERSION
+
+  validateAppDataDocument = validateAppDataDocument
+}
+
+export default CowSdk

package/src/index.ts

@@ -0,0 +1 @@
+export * from './CowSdk'

package/src/schemas/appData.schema.json

@@ -0,0 +1,86 @@
+{
+  "$id": "https://cowswap.exchange/appdata.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "description": "Metadata JSON document for adding information to orders.",
+  "required": [
+    "version",
+    "metadata"
+  ],
+  "title": "AppData Root Schema",
+  "type": "object",
+  "properties": {
+    "version": {
+      "$id": "#/properties/version",
+      "description": "Semantic versioning of document",
+      "examples": [
+        "1.0.0",
+        "1.2.3"
+      ],
+      "title": "Semantic Versioning",
+      "type": "string"
+    },
+    "appCode": {
+      "$id": "#/properties/appCode",
+      "description": "The code identifying the CLI, UI, service generating the order.",
+      "examples": [
+        "CowSwap"
+      ],
+      "title": "App Code",
+      "type": "string"
+    },
+    "metadata": {
+      "$id": "#/properties/metadata",
+      "default": {},
+      "description": "Each metadata will specify one aspect of the order.",
+      "required": [],
+      "title": "Metadata descriptors",
+      "type": "object",
+      "properties": {
+        "referrer": {
+          "$ref": "#/definitions/kindMetadata/referrer"
+        }
+      }
+    }
+  },
+  "definitions": {
+    "version": {
+      "$id": "#/definitions/version",
+      "description": "Semantic versioning of document",
+      "examples": [
+        "1.0.0",
+        "1.2.3"
+      ],
+      "title": "Semantic Versioning",
+      "type": "string"
+    },
+    "ethereumAddress": {
+      "$id": "#/definitions/ethereumAddress",
+      "pattern": "^0x[a-fA-F0-9]{40}$",
+      "title": "Ethereum compatible address",
+      "examples": [
+        "0xb6BAd41ae76A11D10f7b0E664C5007b908bC77C9"
+      ],
+      "type": "string"
+    },
+    "kindMetadata": {
+      "referrer": {
+        "$id": "#/definitions/referrer",
+        "required": [
+          "version",
+          "address"
+        ],
+        "title": "Referrer",
+        "type": "object",
+        "properties": {
+          "version": {
+            "$ref": "#/definitions/version"
+          },
+          "address": {
+            "$ref": "#/definitions/ethereumAddress",
+            "title": "Referrer address"
+          }
+        }
+      }
+    }
+  }
+}

package/src/utils/appData.spec.ts

@@ -0,0 +1,68 @@
+import {validateAppDataDocument } from './appData'
+
+const VALID_RESULT = { 
+  result: true,
+}
+
+test('Valid minimal document', async () => {
+  const validation = await validateAppDataDocument({
+    "version": "0.1.0",
+    "metadata": {}
+  })
+  expect(validation).toEqual(VALID_RESULT);
+});
+
+test('Valid minimal document + appCode', async () => {
+  const validation = await validateAppDataDocument({
+    "version": "0.1.0",
+    "appCode": "MyApp",
+    "metadata": {}
+  })
+  expect(validation).toEqual(VALID_RESULT);
+});
+
+
+test('Valid minimal document + appCode + referrer', async () => {
+  const validation = await validateAppDataDocument({
+    "version": "0.1.0",
+    "appCode": "MyApp",
+    "metadata": {
+      "referrer": {
+        "version": "0.1.0",
+        "address": "0xFEB4acf3df3cDEA7399794D0869ef76A6EfAff52"
+      }
+    }
+  })
+  expect(validation).toEqual(VALID_RESULT);
+});
+
+test('Invalid: Bad referrer', async () => {
+  const validation = await validateAppDataDocument({
+    "version": "0.1.0",
+    "appCode": "MyApp",
+    "metadata": {
+      "referrer": {
+        "version": "0.1.0",
+        "address": "this is not an ethereum address"
+      }
+    }
+  })
+  expect(validation.result).toBeFalsy();
+});
+
+test('Invalid: No version', async () => {
+  const validation = await validateAppDataDocument({
+    "appCode": "MyApp",
+    "metadata": {}
+  })
+  expect(validation.result).toBeFalsy();
+});
+
+
+test('Invalid: No metadata', async () => {
+  const validation = await validateAppDataDocument({
+    "version": "0.1.0",
+    "appCode": "MyApp",
+  })
+  expect(validation.result).toBeFalsy();
+});

package/src/utils/appData.ts

@@ -0,0 +1,34 @@
+import Ajv from 'ajv'
+
+let validate: Ajv.ValidateFunction | undefined
+let ajv: Ajv.Ajv
+
+interface ValidationResult {
+  result: boolean,
+  errors?: Ajv.ErrorObject[]
+}
+
+async function getValidator(): Promise<{ ajv: Ajv.Ajv, validate: Ajv.ValidateFunction }> {  
+  if (!ajv) {
+    ajv = new Ajv()  
+  }
+
+  if (!validate) {
+    const appDataSchema = await import('../schemas/appData.schema.json');
+    validate = ajv.compile(appDataSchema)
+  }
+  
+
+  return { ajv, validate }
+}
+
+export async function validateAppDataDocument(appDataDocument: any): Promise<ValidationResult>{
+  const { ajv, validate } = await getValidator()
+  const result = !!(await validate(appDataDocument))
+
+
+  return {
+    result,
+    errors: ajv.errors ?? undefined
+  }
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "module": "ESNext",
+    "target": "ESNext",
+    "strict": true,
+    "alwaysStrict": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true
+  },
+}