Merge pull request #15 from windingtree/refactor/new-offer

New offers types and structure

Author: kostysh

.gitignore

@@ -11,3 +11,4 @@ temp
 *.level
 coverage
 typedoc
+typechain

examples/client/package.json

@@ -9,16 +9,15 @@
     "preview": "vite preview"
   },
   "devDependencies": {
-    "@types/react": "^18.0.33",
-    "@types/react-dom": "^18.0.11",
-    "@vitejs/plugin-react": "^3.1.0",
+    "@types/react": "^18.2.6",
+    "@types/react-dom": "^18.2.4",
+    "@vitejs/plugin-react": "^4.0.0",
     "eslint-config-react-app": "^7.0.1",
-    "eslint-plugin-react-refresh": "^0.3.4",
+    "eslint-plugin-react-refresh": "^0.4.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "typescript": "^5.0.3",
-    "vite": "^4.2.1",
-    "@windingtree/sdk": "^0.1.0-beta.12"
+    "typescript": "^5.0.4",
+    "vite": "^4.3.4"
   },
   "eslintConfig": {
     "extends": [

examples/client/src/App.tsx

@@ -1,11 +1,13 @@
 import { useState, useEffect, useRef } from 'react';
+import { RequestQuery, OfferOptions, contractConfig, serverAddress } from '../../shared/index.js';
 import {
-  RequestQuery,
-  OfferOptions,
-  contractConfig,
-  serverAddress,
-} from '../../shared/index.js';
-import { Client, ClientOptions, RequestRecord, createClient, storage, utils } from '@windingtree/sdk';
+  Client,
+  ClientOptions,
+  RequestRecord,
+  createClient,
+  storage,
+  utils,
+} from '../../../src/index.js'; //@windingtree/sdk
 
 /** Default request expiration time */
 const defaultExpire = '30s';
@@ -146,9 +148,7 @@ export const Requests = ({ requests, subscribed, onClear, onCancel }: RequestsPr
 export const App = () => {
   const client = useRef<Client<RequestQuery, OfferOptions> | undefined>();
   const [connected, setConnected] = useState<boolean>(false);
-  const [requests, setRequests] = useState<RequestsRegistryRecord[]>(
-    [],
-  );
+  const [requests, setRequests] = useState<RequestsRegistryRecord[]>([]);
   const [error, setError] = useState<string | undefined>();
 
   /** This hook starts the client that will be available via `client.current` */
@@ -237,6 +237,7 @@ export const App = () => {
 
       client.current.requests.publish(request);
     } catch (error) {
+      console.log('@@@', error);
       setError((error as Error).message);
     }
   };

examples/client/vite.config.ts

@@ -7,4 +7,7 @@ export default defineConfig({
     /** @ignore */
     react(),
   ],
+  optimizeDeps: {
+    exclude: ['ethers'],
+  },
 });

examples/client/yarn.lock

@@ -2,18 +2,12 @@ import { EventHandler } from '@libp2p/interfaces/events';
 import { ZeroAddress } from 'ethers';
 import { DateTime } from 'luxon';
 import { RequestQuery, OfferOptions, contractConfig, serverAddress } from '../shared/index.js';
-import {
-  createNode,
-  Node,
-  NodeOptions,
-  Queue,
-  OfferData,
-  createJobHandler,
-} from '../../src/index.js';
+import { createNode, Node, NodeOptions, Queue, createJobHandler } from '../../src/index.js';
+import { OfferData } from '../../src/shared/types.js';
 import { noncePeriod } from '../../src/constants.js';
 import { memoryStorage } from '../../src/storage/index.js';
 import { nowSec, parseSeconds } from '../../src/utils/time.js';
-import { supplierId as generateSupplierId, randomSalt, simpleUid } from '../../src/utils/uid.js';
+import { supplierId as generateSupplierId, randomSalt } from '../../src/utils/uid.js';
 import { generateMnemonic, deriveAccount } from '../../src/utils/wallet.js';
 import { RequestEvent } from '../../src/node/requestManager.js';
 import { createLogger } from '../../src/utils/logger.js';
@@ -94,7 +88,7 @@ const createRequestsHandler =
          */
         payment: [
           {
-            id: simpleUid(),
+            id: randomSalt(),
             price: '1',
             asset: ZeroAddress,
           },
@@ -108,6 +102,7 @@ const createRequestsHandler =
         ],
         /** Check-in time */
         checkIn: nowSec() + 1000,
+        checkOut: nowSec() + 2000,
       });
 
       queue.addEventListener('expired', ({ detail: job }) => {
@@ -119,7 +114,7 @@ const createRequestsHandler =
        * So, we add a job for detection of deals
        */
       queue.addJob('deal', offer, {
-        expire: offer.expire,
+        expire: Number(offer.expire),
         every: 5000, // 5 sec
       });
     };
@@ -145,7 +140,7 @@ const main = async (): Promise<void> => {
     topics: ['hello'],
     contractConfig,
     serverAddress,
-    noncePeriod: parseSeconds(noncePeriod),
+    noncePeriod: Number(parseSeconds(noncePeriod)),
     supplierId,
     signerSeedPhrase: signerMnemonic,
   };

examples/node/index.ts

@@ -1,12 +1,12 @@
-import { GenericQuery, GenericOfferOptions } from '../../src/index.js';
+import { GenericQuery, GenericOfferOptions } from '../../src/shared/types.js';
 import { ContractConfig } from '../../src/utils/contract.js';
 
 export interface RequestQuery extends GenericQuery {
   greeting: string;
 }
 
 export interface OfferOptions extends GenericOfferOptions {
-  date: string;
+  date: string | null;
   buongiorno: boolean;
   buonasera: boolean;
 }

examples/shared/index.ts

@@ -25,25 +25,29 @@
   "type": "module",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "lib/*",
+        "lib/*/index"
+      ]
+    }
+  },
   "files": [
-    "lib/**/*",
+    "src",
+    "lib",
     "!**/*.tsbuildinfo"
   ],
-  "scripts": {
-    "clean": "rm -rf ./lib",
-    "build": "npm run clean && tsc -p ./tsconfig.build.json",
-    "test": "mocha -t 60000 --extension spec.ts",
-    "semantic-release": "semantic-release",
-    "prepack": "npm run build",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "eslint . --ext .ts --fix && prettier --write .",
-    "prepare": "husky install",
-    "commit": "git-cz -S",
-    "coverage": "c8 --all --exclude coverage --exclude lib --exclude test yarn test && c8 report --all --exclude coverage --exclude lib --exclude test -r html",
-    "example:server": "node --experimental-specifier-resolution=node --loader ts-node/esm ./examples/server/index.ts",
-    "example:client": "yarn --cwd ./examples/client dev",
-    "example:node": "node --experimental-specifier-resolution=node --loader ts-node/esm ./examples/node/index.ts",
-    "typedoc": "typedoc --options ./typedoc.json"
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    },
+    "./utils": {
+      "types": "./lib/utils/index.d.ts",
+      "import": "./lib/utils/index.js"
+    }
   },
   "release": {
     "branches": [
@@ -70,29 +74,29 @@
   "devDependencies": {
     "@types/node": "^18.15.11",
     "@types/mocha": "^10.0.1",
-    "@types/chai": "^4.3.4",
+    "@types/chai": "^4.3.5",
     "@types/debug": "^4.1.7",
     "@types/chai-as-promised": "^7.1.5",
-    "@types/luxon": "^3.2.0",
+    "@types/luxon": "^3.3.0",
     "mocha": "^10.2.0",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.3",
-    "semantic-release": "^21.0.1",
+    "typescript": "^5.0.4",
+    "semantic-release": "^21.0.2",
     "semantic-release-cli": "^5.4.4",
     "@semantic-release/changelog": "^6.0.3",
-    "eslint": "^8.37.0",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
-    "prettier": "^2.8.7",
+    "eslint": "^8.40.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "prettier": "^2.8.8",
     "husky": "^8.0.3",
     "git-cz": "^4.9.0",
-    "@commitlint/config-conventional": "^17.4.4",
-    "@commitlint/cli": "^17.5.1",
-    "lint-staged": "^13.2.0",
+    "@commitlint/config-conventional": "^17.6.3",
+    "@commitlint/cli": "^17.6.3",
+    "lint-staged": "^13.2.2",
     "c8": "^7.13.0",
-    "typedoc": "^0.24.0-beta.7"
+    "typedoc": "^0.24.7"
   },
   "dependencies": {
     "libp2p": "^0.43.3",
@@ -103,6 +107,22 @@
     "ethers": "^6.2.3",
     "luxon": "^3.3.0",
     "h3-js": "^4.1.0",
-    "debug": "^4.3.4"
+    "debug": "^4.3.4",
+    "@windingtree/contracts": "^1.0.0-beta.5"
+  },
+  "scripts": {
+    "clean": "rm -rf ./lib",
+    "build": "npm run clean && tsc -p ./tsconfig.build.json",
+    "test": "mocha -t 60000 --extension spec.ts",
+    "semantic-release": "semantic-release",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix && prettier --write .",
+    "prepare": "husky install",
+    "commit": "git-cz -S",
+    "coverage": "c8 --all --exclude coverage --exclude lib --exclude test yarn test && c8 report --all --exclude coverage --exclude lib --exclude test -r html",
+    "example:server": "node --experimental-specifier-resolution=node --loader ts-node/esm ./examples/server/index.ts",
+    "example:client": "yarn --cwd ./examples/client dev",
+    "example:node": "node --experimental-specifier-resolution=node --loader ts-node/esm ./examples/node/index.ts",
+    "typedoc": "typedoc --options ./typedoc.json"
   }
 }

package.json

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events';
 import { createLibp2p, Libp2pOptions, Libp2p } from 'libp2p';
 import { noise } from '@chainsafe/libp2p-noise';
@@ -9,15 +10,15 @@ import { peerIdFromString } from '@libp2p/peer-id';
 import { PeerId } from '@libp2p/interface-peer-id';
 import { OPEN } from '@libp2p/interface-connection/status';
 import { AbstractProvider } from 'ethers';
-import { centerSub, CenterSub } from '../shared/pubsub.js';
 import {
-  buildRequest,
   BuildRequestOptions,
   OfferData,
   GenericOfferOptions,
   GenericQuery,
   RequestData,
-} from '../shared/messages.js';
+} from '../shared/types.js';
+import { centerSub, CenterSub } from '../shared/pubsub.js';
+import { buildRequest } from '../shared/messages.js';
 import { ClientOptions } from '../shared/options.js';
 import { RequestRecord, RequestsRegistry } from './requestsRegistry.js';
 import { decodeText } from '../utils/text.js';

src/client/index.ts

@@ -1,10 +1,11 @@
 import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events';
 import { Client } from '../index.js';
-import { GenericOfferOptions, GenericQuery, RequestData, OfferData } from '../shared/messages.js';
+import { GenericOfferOptions, GenericQuery, RequestData, OfferData } from '../shared/types.js';
 import { Storage } from '../storage/index.js';
 import { createLogger } from '../utils/logger.js';
 import { encodeText } from '../utils/text.js';
 import { nowSec } from '../utils/time.js';
+import { stringify } from '../utils/hash.js';
 
 const logger = createLogger('RequestsRegistry');
 
@@ -272,9 +273,9 @@ export class RequestsRegistry<
       throw new Error('Client not connected to the coordination server yet');
     }
 
-    const now = nowSec();
+    const now = BigInt(nowSec());
 
-    if (record.data.expire < nowSec() || record.cancelled) {
+    if (BigInt(record.data.expire) < nowSec() || record.cancelled) {
       return;
     }
 
@@ -288,7 +289,7 @@ export class RequestsRegistry<
           }),
         );
         this._unsubscribe(record.data.id);
-      }, (record.data.expire - now) * 1000),
+      }, Number((BigInt(record.data.expire) - now) * BigInt(1000))),
     );
     this.dispatchEvent(
       new CustomEvent<string>('subscribe', {
@@ -339,7 +340,7 @@ export class RequestsRegistry<
     this._subscribe(requestRecord);
 
     this.client.libp2p.pubsub
-      .publish(request.topic, encodeText(JSON.stringify(request)))
+      .publish(request.topic, encodeText(stringify(request)))
       .then(() => {
         this.dispatchEvent(
           new CustomEvent<string>('published', {