feat(js-client)!: Remove getter for secret key (#416)

Akim · web-flow · commit 15f96dc5f786 · 2024-01-12T08:25:45.000Z
* Remove secret key

* Node -&gt; Relay

* Fix doc
diff --git a/README.md b/README.md
@@ -33,10 +33,6 @@ Here is an example using the JSDELIVR CDN:
 ```html
 <head>
   <title>Cool App</title>
-  <script
-    type="module"
-    src="https://cdn.jsdelivr.net/npm/@fluencelabs/js-client/dist/browser/index.min.js"
-  ></script>
   <script type="module">
     import {
       Fluence,
diff --git a/packages/core/js-client/src/clientPeer/ClientPeer.ts b/packages/core/js-client/src/clientPeer/ClientPeer.ts
@@ -90,10 +90,6 @@ export class ClientPeer extends FluencePeer implements IFluenceClient {
     );
   }
 
-  getPeerSecretKey(): Uint8Array {
-    return this.keyPair.toEd25519PrivateKey();
-  }
-
   connectionState: ConnectionState = "disconnected";
   connectionStateChangeHandler: (state: ConnectionState) => void = () => {};
 
diff --git a/packages/core/js-client/src/clientPeer/types.ts b/packages/core/js-client/src/clientPeer/types.ts
@@ -21,29 +21,25 @@ import { z } from "zod";
  */
 export type PeerIdB58 = string;
 
+const relaySchema = z.object({
+  peerId: z.string(),
+  multiaddr: z.string(),
+});
+
 /**
- * Node of the Fluence network specified as a pair of node's multiaddr and it's peer id
+ * Relay of the Fluence network specified as a pair of node's multiaddr and it's peer id
  */
-export type Node = {
-  peerId: PeerIdB58;
-  multiaddr: string;
-};
-
-export const relaySchema = z.union([
-  z.string(),
-  z.object({
-    peerId: z.string(),
-    multiaddr: z.string(),
-  }),
-]);
+export type Relay = z.infer<typeof relaySchema>;
+
+export const relayOptionsSchema = z.union([z.string(), relaySchema]);
 
 /**
- * A node in Fluence network a client can connect to.
+ * A relay in Fluence network a client can connect to.
  * Can be in the form of:
  * - string: multiaddr in string format
- * - Node: node structure, @see Node
+ * - Relay: relay structure, @see Relay
  */
-export type RelayOptions = z.infer<typeof relaySchema>;
+export type RelayOptions = z.infer<typeof relayOptionsSchema>;
 
 /**
  * Fluence Peer's key pair types
@@ -102,11 +98,6 @@ export interface IFluenceClient {
     handler: (state: ConnectionState) => void,
   ): ConnectionState;
 
-  /**
-   * Return peer's secret key as byte array.
-   */
-  getPeerSecretKey(): Uint8Array;
-
   /**
    * Return peer's public key as a base58 string (multihash/CIDv0).
    */
diff --git a/packages/core/js-client/src/index.ts b/packages/core/js-client/src/index.ts
@@ -22,7 +22,7 @@ import {
   configSchema,
   ConnectionState,
   RelayOptions,
-  relaySchema,
+  relayOptionsSchema,
 } from "./clientPeer/types.js";
 import { callAquaFunction } from "./compilerSupport/callFunction.js";
 import { registerService } from "./compilerSupport/registerService.js";
@@ -36,7 +36,7 @@ const createClient = async (
   config: ClientConfig = {},
 ): Promise<ClientPeer> => {
   try {
-    relay = relaySchema.parse(relay);
+    relay = relayOptionsSchema.parse(relay);
     config = configSchema.parse(config);
   } catch (e) {
     if (e instanceof ZodError) {
@@ -125,6 +125,7 @@ export type {
   ClientConfig,
   IFluenceClient,
   ConnectionState,
+  Relay,
   RelayOptions,
   KeyPairOptions,
 } from "./clientPeer/types.js";

Original file line number	Diff line number	Diff line change
`@@ -90,10 +90,6 @@ export class ClientPeer extends FluencePeer implements IFluenceClient {`
`90`	`90`	`);`
`91`	`91`	`}`
`92`	`92`
`93`		`- getPeerSecretKey(): Uint8Array {`
`94`		`- return this.keyPair.toEd25519PrivateKey();`
`95`		`- }`
`96`		`-`
`97`	`93`	`connectionState: ConnectionState = "disconnected";`
`98`	`94`	`connectionStateChangeHandler: (state: ConnectionState) => void = () => {};`
`99`	`95`