Merge pull request #14 from windingtree/docs/sync-refactor

Docs/sync refactor

Author: kostysh

docs/docs/clients.md

@@ -5,10 +5,17 @@
 More about the client configuration options is [here](./index.md#client-node).
 
 ```typescript
-import { ClientOptions, createClient } from '@windingtree/sdk';
-import { RequestQuery, OfferOptions } from './config.js';
+import { GenericQuery, GenericOfferOptions, ClientOptions, createClient } from '@windingtree/sdk';
 
-const options: ClientOptions<RequestQuery, OfferOptions> = {
+export interface RequestQuery extends GenericQuery {
+  /** your custom request interface */
+}
+
+export interface OfferOptions extends GenericOfferOptions {
+  /** suppliers' offer options interface */
+}
+
+const options: ClientOptions = {
   /*...*/
 };
 
@@ -54,6 +61,8 @@ client.addEventListener('stop', () => {
 Every request structure must follow the generic message data structure proposed by the protocol.
 
 ```typescript
+import { GenericQuery, GenericOfferOptions } from '@windingtree/sdk';
+
 type GenericQuery = Record<string, unknown>;
 
 /**
@@ -77,40 +86,6 @@ interface RequestData<RequestQuery extends GenericQuery> extends GenericMessage
 }
 ```
 
-The protocol SDK uses the `zod` library for data structures validation. Ready-made data structures validation schemes and static typescript types can be imported from the SDK module.
-
-```typescript
-import { z } from 'zod';
-import { GenericQuerySchema, createRequestDataSchema, RequestData } from '@windingtree/sdk';
-
-/**
- * Custom query schema
- */
-const MyCustomRequestQuerySchema = GenericQuerySchema.extend({
-  howMuch: z.number(),
-});
-
-type MyCustomRequestQuery = z.infer<typeof MyCustomRequestQuerySchema>;
-
-const request: RequestData<MyCustomRequestQuery> = {
-  /** ... */
-  query: {
-    howMuch: 10,
-  },
-};
-
-const requestSchema = createRequestDataSchema<typeof MyCustomRequestQuerySchema>(
-  MyCustomRequestQuerySchema,
-);
-
-// the `parse` method of schema is validating an object according to the schema rules
-const { query } = requestSchema.parse(request);
-console.log(query);
-// {
-//   howMuch: 10,
-// }
-```
-
 To build a request you can use the `requests.create` method of the client instance.
 
 ```typescript
@@ -181,7 +156,10 @@ type RequestRecord<RequestQuery, OfferOptions> = {
 const requestRecord = await client.request.get(request.id);
 ```
 
-- `getAll`: Returns an array of all registered request records
+- `create`: Creates the request
+- `publish`: Publishes the request
+- `get`: Returns a request from the client registry
+- `getAll`: Returns an array of all registered request records from the client registry
 - `cancel`: Cancels the request subscription. Offers for this request will not be accepted.
 - `delete`: Removes the request from the client registry
 - `clear`: Removes all requests from the registry

docs/docs/coordinator.md

@@ -5,13 +5,26 @@
 More about the server configuration options is [here](./index.md#coordination-server).
 
 ```typescript
-import { ServerOptions, createServer } from '@windingtree/sdk';
+import { ServerOptions, createServer, storage } from '@windingtree/sdk';
 
 const options: ServerOptions = {
-  /*...*/
+  messagesStorageInit: storage['YOUR_STORAGE_OPTION']
+    .createInitializer
+    /** Your storage configuration */
+    (),
+  /** Other server configuration options */
 };
 
 const server = createServer(options);
+
+server.addEventListener('start', () => {
+  logger.trace('🚀 Server started at', new Date().toISOString());
+});
+
+server.addEventListener('stop', () => {
+  logger.trace('👋 Server stopped at:', new Date().toISOString());
+});
+
 await server.start(); // Start the server
 await server.stop(); // Stop the server
 ```

docs/docs/index.md

@@ -33,7 +33,7 @@ yarn add @windingtree/sdk ethers
 The peer key is part of p2p security schema. It uses for peer identification and establishing secured connections between peers.
 
 ```typescript
-import { generatePeerKey } from '@windingtree.sdk';
+import { generatePeerKey } from '@windingtree/sdk';
 
 await generatePeerKey();
 /*
@@ -74,7 +74,7 @@ const options: ServerOptions = {
   address: '0.0.0.0',
   port: 33333,
   peerKey,
-  messagesStorageInit: storage.memoryStorage.init(),
+  messagesStorageInit: storage.memoryStorage.createInitializer(),
 };
 ```
 
@@ -83,19 +83,23 @@ const options: ServerOptions = {
 A base options type definitions:
 
 ```typescript
-type NodeOptions<
-  CustomRequestQuery extends GenericQuery,
-  CustomOfferOptions extends GenericOfferOptions,
-> = {
+/** smart contract configuration */
+interface ContractConfig {
+  /** Smart contract name */
+  name: string;
+  /** Internal smart contract version */
+  version: string;
+  /** Chain Id */
+  chainId: BigNumberish;
+  /** Smart contract address */
+  address: string;
+}
+
+type NodeOptions = {
   /** Period while the node waits and accepting requests with the same Id */
   noncePeriod: number;
   /** The protocol smart contract configuration */
-  contractConfig: {
-    address: string;
-    name: string;
-    version: string;
-    chainId: string | number | bigint;
-  };
+  contractConfig: ContractConfig;
   /** Multiaddr of the coordination server */
   serverAddress: string;
   /** Seed phrase of the node signer wallet */
@@ -104,14 +108,10 @@ type NodeOptions<
   topics: string[];
   /** Unique supplier Id */
   supplierId: string;
-  /** Query validation schema */
-  querySchema: ZodType<CustomRequestQuery>;
-  /** Offer options validation schema instance */
-  offerOptionsSchema: ZodType<CustomOfferOptions>;
   /** Ethers.js provider instance */
-  provider?: AbstractProvider | undefined;
+  provider?: AbstractProvider;
   /** Additional Libp2p initialization options */
-  libp2p?: Libp2pOptions | undefined;
+  libp2p?: Libp2pInit;
 };
 ```
 
@@ -120,19 +120,9 @@ Here is an example of a supplier node configuration:
 ```typescript
 import { NodeOptions } from '@windingtree/sdk';
 import { latLngToCell } from '@windingtree/sdk/utils';
-import {
-  RequestQuerySchema,
-  OfferOptionsSchema,
-  RequestQuery,
-  OfferOptions,
-  supplierId,
-  signerSeedPhrase,
-  coordinates,
-} from './config.js';
+import { supplierId, signerSeedPhrase, coordinates } from './config.js';
 
-const options: NodeOptions<RequestQuery, OfferOptions> = {
-  querySchema: RequestQuerySchema, // zod schema
-  offerOptionsSchema: OfferOptionsSchema, // zod schema
+const options: NodeOptions = {
   topics: ['hello', latLngToCell(coordinates)],
   contractConfig: {
     name: 'WtMarket',
@@ -150,31 +140,19 @@ const options: NodeOptions<RequestQuery, OfferOptions> = {
 ### Client node
 
 ```typescript
-type ClientOptionsClientOptions<
-  CustomRequestQuery extends GenericQuery,
-  CustomOfferOptions extends GenericOfferOptions,
-> = {
+type ClientOptions = {
   /** The protocol smart contract configuration */
-  contractConfig: {
-    address: string;
-    name: string;
-    version: string;
-    chainId: string | number | bigint;
-  };
+  contractConfig: ContractConfig; // See details in the supplier node section
   /** Multiaddr of the coordination server */
   serverAddress: string;
-  /** Query validation schema */
-  querySchema: ZodType<CustomRequestQuery>;
-  /** Offer options validation schema instance */
-  offerOptionsSchema: ZodType<CustomOfferOptions>;
   /** Client key-value storage initializer */
   storageInitializer: (...args: unknown[]) => Promise<Storage>;
   /** Request registry keys prefix */
   requestRegistryPrefix: string;
   /** Ethers.js provider instance */
-  provider?: AbstractProvider | undefined;
+  provider?: AbstractProvider;
   /** Additional Libp2p initialization options */
-  libp2p?: Libp2pOptions | undefined;
+  libp2p?: Libp2pInit;
 };
 ```
 
@@ -183,19 +161,16 @@ Here is an example of a client configuration:
 ```typescript
 import { Wallet } from 'ethers';
 import { ClientOptions, storage } from '@windingtree/sdk';
-import { RequestQuerySchema, OfferOptionsSchema, RequestQuery, OfferOptions } from './config.js';
 
-const options: ClientOptions<RequestQuery, OfferOptions> = {
-  querySchema: RequestQuerySchema,
-  offerOptionsSchema: OfferOptionsSchema,
+const options: ClientOptions = {
   contractConfig: {
     name: 'WtMarket',
     version: '1',
     chainId: '1',
     address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
   },
   serverAddress: '/ip4/127.0.0.1/tcp/33333/ws/p2p/QmcXbDr...jgEuWPCf',
-  storageInitializer: storage.localStorage.init({
+  storageInitializer: storage.localStorage.createInitializer({
     session: true,
   }),
   requestRegistryPrefix: 'requestsRegistry',
@@ -204,6 +179,6 @@ const options: ClientOptions<RequestQuery, OfferOptions> = {
 
 ## SDK development
 
-- WindingTree Discord server, [developers channel](https://discord.com/channels/898350336069218334/956614058323370014)
+- [WindingTree protocol discussions](https://github.com/windingtree/sdk/discussions)
 - Bug tracker: [https://github.com/windingtree/sdk/issues](https://github.com/windingtree/sdk/issues)
 - [Contribution](/docs/contribution.md)