Merge pull request #13 from windingtree/develop

New types system

Author: kostysh

examples/client/package.json

@@ -18,8 +18,7 @@
     "react-dom": "^18.2.0",
     "typescript": "^5.0.3",
     "vite": "^4.2.1",
-    "zod": "^3.21.4",
-    "@windingtree/sdk": "0.1.0-beta.10"
+    "@windingtree/sdk": "0.1.0-beta.11"
   },
   "eslintConfig": {
     "extends": [

examples/client/src/App.tsx

@@ -1,12 +1,10 @@
 import { useState, useEffect, useRef } from 'react';
 import {
-  RequestQuerySchema,
   RequestQuery,
-  OfferOptionsSchema,
   OfferOptions,
   contractConfig,
   serverAddress,
-} from '../../shared/types.js';
+} from '../../shared/index.js';
 import { Client, ClientOptions, createClient, RequestRecord, storage, utils } from '../../../src/index.js';
 // import { Client, ClientOptions, RequestRecord, createClient, storage, utils } from '@windingtree/sdk';
 
@@ -160,9 +158,7 @@ export const App = () => {
       try {
         setError(undefined);
 
-        const options: ClientOptions<RequestQuery, OfferOptions> = {
-          querySchema: RequestQuerySchema,
-          offerOptionsSchema: OfferOptionsSchema,
+        const options: ClientOptions = {
           contractConfig,
           serverAddress,
           storageInitializer: storage.localStorage.createInitializer({

examples/client/yarn.lock

@@ -2177,10 +2177,10 @@
     magic-string "^0.27.0"
     react-refresh "^0.14.0"
 
-"@windingtree/[email protected].10":
-  version "0.1.0-beta.10"
-  resolved "https://registry.yarnpkg.com/@windingtree/sdk/-/sdk-0.1.0-beta.10.tgz#f2092903077a597ffb3c46a6af1fda25b8586bea"
-  integrity sha512-9CsUr+njuL71L0eHX9GmNuaTgauGHqJzsky/annmW7WDa/GJ5cFI6mowGSMRHeCIAhtOZEtMQUAlWrHRgk1TBQ==
+"@windingtree/[email protected].11":
+  version "0.1.0-beta.11"
+  resolved "https://registry.yarnpkg.com/@windingtree/sdk/-/sdk-0.1.0-beta.11.tgz#571129b5265649a780fd976a19fa98205dbee692"
+  integrity sha512-/5mwrss7eaXcJx6OtVQl3ZiO8o3F7VtMGmNN8i0P2yJMox85bJWj1ROXvSUjwJyD/rjlH1EVgnvDCCtm63RRKw==
   dependencies:
     "@chainsafe/libp2p-gossipsub" "^6.2.0"
     "@chainsafe/libp2p-noise" "^11.0.4"

examples/node/index.ts

@@ -1,14 +1,7 @@
 import { EventHandler } from '@libp2p/interfaces/events';
 import { ZeroAddress } from 'ethers';
 import { DateTime } from 'luxon';
-import {
-  RequestQuerySchema,
-  RequestQuery,
-  OfferOptionsSchema,
-  OfferOptions,
-  contractConfig,
-  serverAddress,
-} from '../shared/types.js';
+import { RequestQuery, OfferOptions, contractConfig, serverAddress } from '../shared/index.js';
 import {
   createNode,
   Node,
@@ -148,17 +141,15 @@ const main = async (): Promise<void> => {
     concurrentJobsNumber: 3,
   });
 
-  const options: NodeOptions<RequestQuery, OfferOptions> = {
-    querySchema: RequestQuerySchema,
-    offerOptionsSchema: OfferOptionsSchema,
+  const options: NodeOptions = {
     topics: ['hello'],
     contractConfig,
     serverAddress,
     noncePeriod: parseSeconds(noncePeriod),
     supplierId,
     signerSeedPhrase: signerMnemonic,
   };
-  const node = createNode(options);
+  const node = createNode<RequestQuery, OfferOptions>(options);
 
   queue.addJobHandler('deal', dealHandler({ node }));
 

examples/shared/index.ts

@@ -0,0 +1,22 @@
+import { GenericQuery, GenericOfferOptions } from '../../src/index.js';
+import { ContractConfig } from '../../src/utils/contract.js';
+
+export interface RequestQuery extends GenericQuery {
+  greeting: string;
+}
+
+export interface OfferOptions extends GenericOfferOptions {
+  date: string;
+  buongiorno: boolean;
+  buonasera: boolean;
+}
+
+export const contractConfig: ContractConfig = {
+  name: 'WtMarket',
+  version: '1',
+  chainId: '1',
+  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+};
+
+export const serverAddress =
+  '/ip4/127.0.0.1/tcp/33333/ws/p2p/QmcXbDrzUU5ERqRaronWmAJXwe6c7AEkS7qdcsjgEuWPCf';

examples/shared/types.ts

@@ -101,7 +101,6 @@
     "@libp2p/mplex": "^7.1.3",
     "@libp2p/websockets": "^5.0.8",
     "ethers": "^6.2.3",
-    "zod": "^3.21.4",
     "luxon": "^3.3.0",
     "h3-js": "^4.1.0",
     "debug": "^4.3.4"

package.json

@@ -9,17 +9,16 @@ 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 { z } from 'zod';
 import { centerSub, CenterSub } from '../shared/pubsub.js';
 import {
   buildRequest,
   BuildRequestOptions,
-  createOfferDataSchema,
+  OfferData,
   GenericOfferOptions,
   GenericQuery,
   RequestData,
 } from '../shared/messages.js';
-import { ClientOptions, createClientOptionsSchema } from '../shared/options.js';
+import { ClientOptions } from '../shared/options.js';
 import { RequestRecord, RequestsRegistry } from './requestsRegistry.js';
 import { decodeText } from '../utils/text.js';
 import { ContractConfig } from '../utils/contract.js';
@@ -210,35 +209,30 @@ export class Client<
   serverMultiaddr: Multiaddr;
   /** Server peer Id */
   serverPeerId: PeerId;
-  /** Request query validation schema */
-  querySchema: z.ZodType<CustomRequestQuery>;
-  /** Offer options validation schema */
-  offerOptionsSchema: z.ZodType<CustomOfferOptions>;
   /** Smart contract configuration */
   contractConfig: ContractConfig;
   /** Ethers.js provider instance */
   provider?: AbstractProvider;
+
   /**
    *Creates an instance of Client.
-   * @param {ClientOptions<CustomRequestQuery, CustomOfferOptions>} options
+   * @param {ClientOptions} options
    * @memberof Client
    */
-  constructor(options: ClientOptions<CustomRequestQuery, CustomOfferOptions>) {
+  constructor(options: ClientOptions) {
     super();
 
     const {
-      querySchema,
-      offerOptionsSchema,
       contractConfig,
       libp2p,
       provider,
       serverAddress,
       storageInitializer,
       requestRegistryPrefix,
-    } = createClientOptionsSchema<CustomRequestQuery, CustomOfferOptions>().parse(options);
+    } = options;
+
+    // @todo Validate ClientOptions
 
-    this.querySchema = querySchema;
-    this.offerOptionsSchema = offerOptionsSchema;
     this.contractConfig = contractConfig;
     this.libp2pInit = (libp2p ?? {}) as Libp2pOptions;
     this.provider = provider;
@@ -329,10 +323,13 @@ export class Client<
         }
 
         /** Check is the message is an offer */
-        const offer = createOfferDataSchema<CustomRequestQuery, CustomOfferOptions>(
-          this.querySchema,
-          this.offerOptionsSchema,
-        ).parse(JSON.parse(decodeText(detail.data)));
+        const offer = JSON.parse(decodeText(detail.data)) as OfferData<
+          CustomRequestQuery,
+          CustomOfferOptions
+        >;
+
+        // @todo Validate offer
+
         logger.trace('Offer received:', offer);
 
         // Verify the offer
@@ -459,10 +456,7 @@ export class Client<
       throw new Error('Client not initialized yet');
     }
 
-    return await buildRequest<CustomRequestQuery>({
-      ...requestOptions,
-      querySchema: this.querySchema,
-    } as BuildRequestOptions<CustomRequestQuery>);
+    return await buildRequest<CustomRequestQuery>(requestOptions);
   }
 
   /**
@@ -606,14 +600,14 @@ export class Client<
 /**
  * Creates client instance
  *
- * @param {ClientOptions<CustomRequestQuery, CustomOfferOptions>} options Client initialization options
+ * @param {ClientOptions} options Client initialization options
  * @returns {Client}
  */
 export const createClient = <
   CustomRequestQuery extends GenericQuery,
   CustomOfferOptions extends GenericOfferOptions,
 >(
-  options: ClientOptions<CustomRequestQuery, CustomOfferOptions>,
+  options: ClientOptions,
 ): Client<CustomRequestQuery, CustomOfferOptions> => {
   return new Client(options);
 };