Merge pull request #21 from windingtree/refactor/thin-node

Node class refactoring and Improving NodeRequestManager

Author: kostysh

.prettierrc

@@ -2,6 +2,6 @@
   "semi": true,
   "trailingComma": "all",
   "singleQuote": true,
-  "printWidth": 100,
+  "printWidth": 80,
   "tabWidth": 2
 }

docs/docs/clients.md

@@ -5,7 +5,12 @@
 More about the client configuration options is [here](./index.md#client-node).
 
 ```typescript
-import { GenericQuery, GenericOfferOptions, ClientOptions, createClient } from '@windingtree/sdk';
+import {
+  GenericQuery,
+  GenericOfferOptions,
+  ClientOptions,
+  createClient,
+} from '@windingtree/sdk';
 
 export interface RequestQuery extends GenericQuery {
   /** your custom request interface */
@@ -80,7 +85,8 @@ interface GenericMessage {
 /**
  * Request data structure
  */
-interface RequestData<RequestQuery extends GenericQuery> extends GenericMessage {
+interface RequestData<RequestQuery extends GenericQuery>
+  extends GenericMessage {
   /** Industry specific query type */
   query: RequestQuery;
 }
@@ -182,13 +188,19 @@ Every time a new offer is received the client emits a `request:offer` event. You
 ```typescript
 import { useEffect, useRef } from 'react';
 
-const OffersList = ({ client }: { client: Client<RequestQuery, OfferOptions> }) => {
+const OffersList = ({
+  client,
+}: {
+  client: Client<RequestQuery, OfferOptions>;
+}) => {
   const offers = useRef();
 
   useEffect(() => {
     /** Initialization of the component */
     offers.current = new Map<string, OfferData<RequestQuery, OfferOptions>>(
-      client.requests.getAll().reduce((a, v) => [...a, [v.data.id, v.offers]], []),
+      client.requests
+        .getAll()
+        .reduce((a, v) => [...a, [v.data.id, v.offers]], []),
     );
 
     /** Manage up-to-date state */

docs/docs/nodes.md

@@ -84,7 +84,12 @@ function lifDepositWithdraw(uint256 amount) external;
 More about the node configuration options is [here](./index.md#supplier-node).
 
 ```typescript
-import { GenericQuery, GenericOfferOptions, NodeOptions, createNode } from '@windingtree/sdk';
+import {
+  GenericQuery,
+  GenericOfferOptions,
+  NodeOptions,
+  createNode,
+} from '@windingtree/sdk';
 
 export interface RequestQuery extends GenericQuery {
   /** your custom request interface */
@@ -186,12 +191,13 @@ interface RequestHandlerOptions {
 /**
  * Handler should be created using createJobHandler factory function
  */
-const requestsHandler = createJobHandler<RequestData<CustomRequestQuery>, RequestHandlerOptions>(
-  async (data, options) => {
-    // data - raw request
-    // options - object with everything else you want pass into the handler at run time
-  },
-);
+const requestsHandler = createJobHandler<
+  RequestData<CustomRequestQuery>,
+  RequestHandlerOptions
+>(async (data, options) => {
+  // data - raw request
+  // options - object with everything else you want pass into the handler at run time
+});
 
 /**
  * Registering of the request handler in the queue

docs/docs/storage.md

@@ -6,10 +6,17 @@ The WindingTree market protocol SDK was developed as a cross-platform solution.
 
 ```typescript
 abstract class Storage {
-  abstract set<CustomValueType = unknown>(key: string, value: CustomValueType): Promise<void>;
-  abstract get<CustomValueType = unknown>(key: string): Promise<CustomValueType | undefined>;
+  abstract set<CustomValueType = unknown>(
+    key: string,
+    value: CustomValueType,
+  ): Promise<void>;
+  abstract get<CustomValueType = unknown>(
+    key: string,
+  ): Promise<CustomValueType | undefined>;
   abstract delete(key: string): Promise<boolean>;
-  abstract entries<CustomValueType = unknown>(): IterableIterator<[string, CustomValueType]>;
+  abstract entries<CustomValueType = unknown>(): IterableIterator<
+    [string, CustomValueType]
+  >;
 }
 ```
 
@@ -20,7 +27,9 @@ Every storage connector has `createInitializer` function that is a factory that
 ```typescript
 type StorageInitializer = () => Promise<Storage>;
 
-type StorageInitializerFunction = (options?: GenericStorageOptions) => StorageInitializer;
+type StorageInitializerFunction = (
+  options?: GenericStorageOptions,
+) => StorageInitializer;
 ```
 
 ```typescript

docs/index.html

@@ -5,10 +5,22 @@
     <title>WindingTree Market Protocol SDK</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
     <link rel="icon" href="build/favicon.png" />
-    <meta name="description" content="WindingTree Market Protocol SDK Documentation Site" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0" />
-    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" />
-    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css" />
+    <meta
+      name="description"
+      content="WindingTree Market Protocol SDK Documentation Site"
+    />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css"
+    />
     <!-- Google Tag Manager -->
     <script>
       (function (w, d, s, l, i) {
@@ -54,7 +66,9 @@
             code: function (code, lang) {
               if (lang === 'mermaid') {
                 return (
-                  '<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + '</div>'
+                  '<div class="mermaid">' +
+                  mermaid.render('mermaid-svg-' + num++, code) +
+                  '</div>'
                 );
               }
               return this.origin.code.apply(this, arguments);

examples/client/src/App.tsx

@@ -1,7 +1,17 @@
 import { useState, useEffect, useRef } from 'react';
 import { hardhat, polygonZkEvmTestnet } from 'viem/chains';
-import { Client, ClientOptions, createClient, storage } from '../../../src/index.js'; // @windingtree/sdk
-import { RequestQuery, OfferOptions, contractsConfig, serverAddress } from '../../shared/index.js';
+import {
+  Client,
+  ClientOptions,
+  createClient,
+  storage,
+} from '../../../src/index.js'; // @windingtree/sdk
+import {
+  RequestQuery,
+  OfferOptions,
+  contractsConfig,
+  serverAddress,
+} from '../../shared/index.js';
 import { OfferData } from '../../../src/shared/types.js';
 import { useWallet } from './providers/WalletProvider/WalletProviderContext.js';
 import { AccountWidget } from './providers/WalletProvider/AccountWidget.js';
@@ -13,7 +23,8 @@ import { Offers } from './components/Offers.js';
 import { Deals, DealsRegistryRecord } from './components/Deals.js';
 
 /** Target chain config */
-const chain = import.meta.env.LOCAL_NODE === 'true' ? hardhat : polygonZkEvmTestnet;
+const chain =
+  import.meta.env.LOCAL_NODE === 'true' ? hardhat : polygonZkEvmTestnet;
 
 /** Default request expiration time */
 const defaultExpire = '30s';
@@ -31,8 +42,12 @@ export const App = () => {
   const [selectedTab, setSelectedTab] = useState<number>(0);
   const [requests, setRequests] = useState<RequestsRegistryRecord[]>([]);
   const [deals, setDeals] = useState<DealsRegistryRecord[]>([]);
-  const [offers, setOffers] = useState<OfferData<RequestQuery, OfferOptions>[] | undefined>();
-  const [offer, setOffer] = useState<OfferData<RequestQuery, OfferOptions> | undefined>();
+  const [offers, setOffers] = useState<
+    OfferData<RequestQuery, OfferOptions>[] | undefined
+  >();
+  const [offer, setOffer] = useState<
+    OfferData<RequestQuery, OfferOptions> | undefined
+  >();
   const [error, setError] = useState<string | undefined>();
 
   /** This hook starts the client that will be available via `client.current` */
@@ -60,9 +75,12 @@ export const App = () => {
 
         const updateDeals = () => {
           if (client.current) {
-            client.current.deals.getAll().then((newDeals) => {
-              setDeals(newDeals);
-            }).catch(console.error);
+            client.current.deals
+              .getAll()
+              .then((newDeals) => {
+                setDeals(newDeals);
+              })
+              .catch(console.error);
           }
         };
 
@@ -80,12 +98,18 @@ export const App = () => {
 
         client.current.addEventListener('connected', () => {
           setConnected(true);
-          console.log('🔗 Client connected to server at:', new Date().toISOString());
+          console.log(
+            '🔗 Client connected to server at:',
+            new Date().toISOString(),
+          );
         });
 
         client.current.addEventListener('disconnected', () => {
           setConnected(false);
-          console.log('🔌 Client disconnected from server at:', new Date().toISOString());
+          console.log(
+            '🔌 Client disconnected from server at:',
+            new Date().toISOString(),
+          );
         });
 
         /** Listening for requests events and update tables */
@@ -137,15 +161,21 @@ export const App = () => {
 
   return (
     <>
-      <div style={{ display: 'flex', flexDirection: 'row', alignItems: 'center' }}>
+      <div
+        style={{ display: 'flex', flexDirection: 'row', alignItems: 'center' }}
+      >
         <div style={{ flex: 1 }}>
           <h1>Client</h1>
         </div>
         <AccountWidget />
       </div>
       {client.current && <div>✅ Client started</div>}
       {connected && <div>✅ Connected to the coordination server</div>}
-      <RequestForm connected={connected} onSubmit={sendRequest} defaultTopic={defaultTopic} />
+      <RequestForm
+        connected={connected}
+        onSubmit={sendRequest}
+        defaultTopic={defaultTopic}
+      />
       <Tabs
         tabs={[
           {