@cowprotocol/cow-sdk 0.0.1 → 0.0.9

package/dist/utils/sign.d.ts

@@ -0,0 +1,54 @@
+import { Order, OrderCancellation as OrderCancellationGp, SigningScheme } from '@gnosis.pm/gp-v2-contracts';
+import { SupportedChainId as ChainId } from '../constants/chains';
+import { Signer } from '@ethersproject/abstract-signer';
+export declare type UnsignedOrder = Omit<Order, 'receiver'> & {
+    receiver: string;
+};
+export interface SignOrderParams {
+    chainId: ChainId;
+    signer: Signer;
+    order: UnsignedOrder;
+    signingScheme: SigningScheme;
+}
+export interface OrderCreation extends UnsignedOrder {
+    signingScheme: SigningScheme;
+    signature: string;
+}
+export interface SingOrderCancellationParams {
+    chainId: ChainId;
+    signer: Signer;
+    orderId: string;
+    signingScheme: SigningScheme;
+}
+export interface OrderCancellation extends OrderCancellationGp {
+    signature: string;
+    signingScheme: SigningScheme;
+}
+export declare type SigningSchemeValue = 'eip712' | 'ethsign' | 'eip1271' | 'presign';
+export declare function getSigningSchemeApiValue(ecdaSigningScheme: SigningScheme): string;
+export declare function getSigningSchemeLibValue(ecdaSigningScheme: SigningScheme): number;
+export declare type SigningResult = {
+    signature: string;
+    signingScheme: SigningScheme;
+};
+/**
+ * Returns the signature for the specified order with the signing scheme encoded
+ * into the signature.
+ * @export
+ * @param {UnsignedOrder} order The order to sign.
+ * @param {ChainId} chainId The chain Id
+ * @param {Signer} signer The owner for the order used to sign.
+ * @return {*} Encoded signature including signing scheme for the order.
+ */
+export declare function signOrder(order: UnsignedOrder, chainId: ChainId, signer: Signer): Promise<SigningResult>;
+/**
+ * Returns the signature for the Order Cancellation with the signing scheme encoded
+ * into the signature.
+ *
+ * @export
+ * @param {string} orderId The unique identifier of the order being cancelled.
+ * @param {ChainId} chainId The chain Id
+ * @param {Signer} signer The owner for the order used to sign.
+ * @return {*} Encoded signature including signing scheme for the order.
+ */
+export declare function signOrderCancellation(orderId: string, chainId: ChainId, signer: Signer): Promise<SigningResult>;

package/dist/utils/tokens.d.ts

@@ -0,0 +1,2 @@
+import { SupportedChainId as ChainId } from '../constants/chains';
+export declare function toErc20Address(tokenAddress: string, chainId: ChainId): string;

package/package.json

@@ -1,25 +1,70 @@
 {
   "name": "@cowprotocol/cow-sdk",
-  "version": "0.0.1",
-  "license": "MIT",
+  "version": "0.0.9",
+  "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.js"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "microbundle -f modern,esm,cjs",
+    "start": "microbundle -f modern,esm,cjs watch",
+    "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",
+    "prepublishOnly": "npm test && npm run lint",
+    "graphql:codegen": "graphql-codegen --config graphql-codegen.yml"
+  },
+  "dependencies": {
+    "@gnosis.pm/gp-v2-contracts": "^1.1.2",
+    "ajv": "^8.8.2",
+    "cross-fetch": "^3.1.5",
+    "ethers": "^5.5.3",
+    "graphql": "^16.3.0",
+    "graphql-request": "^4.1.0",
+    "loglevel": "^1.8.0",
+    "multiformats": "^9.6.4"
+  },
   "devDependencies": {
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.7",
     "@babel/preset-typescript": "^7.16.0",
+    "@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",
+    "coveralls": "^3.1.1",
+    "eslint": "^8.6.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "jest": "^27.3.1",
-    "microbundle": "^0.14.2"
+    "jest-fetch-mock": "^3.0.3",
+    "microbundle": "^0.14.2",
+    "prettier": "^2.5.1"
   },
-  "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"
+  "jest": {
+    "automock": false,
+    "resetMocks": false,
+    "setupFiles": [
+      "./setupTests.js"
+    ]
   },
-  "types": "dist/index.d.ts"
+  "keywords": [
+    "cow",
+    "cow-protocol",
+    "sdk",
+    "crypto",
+    "typescript",
+    "subgraph"
+  ]
 }

package/babel.config.js

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

package/src/CowSdk.ts

@@ -1,10 +0,0 @@
-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

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

package/src/schemas/appData.schema.json

@@ -1,86 +0,0 @@
-{
-  "$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

@@ -1,68 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

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