GitBook: [2.0.0] 31 pages and 15 assets modified

js-sdk/3_in_depth.md

@@ -1,10 +1,12 @@
 # In-depth
 
-# Intro
+## In-depth
+
+## Intro
 
 In this section we will cover the JS SDK in-depth.
 
-# FluencePeer class
+## FluencePeer class
 
 The overall workflow with the `FluencePeer` is the following:
 
@@ -19,7 +21,7 @@ To create a new peer simple instantiate the `FluencePeer` class:
 const peer = new FluencePeer();
 ```
 
-The constructor simply creates a new object and does not initialize any workflow. The `init` function starts the Aqua VM, initializes the default call service handlers and (optionally) connect to the Fluence network. The function takes an optional object specifying additonal peer configuration. On option you will be using a lot is `connectTo`. It tells the peer to connect to a relay. For example:
+The constructor simply creates a new object and does not initialize any workflow. The `init` function starts the Aqua VM, initializes the default call service handlers and \(optionally\) connect to the Fluence network. The function takes an optional object specifying additonal peer configuration. On option you will be using a lot is `connectTo`. It tells the peer to connect to a relay. For example:
 
 ```typescript
 await peer.init({
@@ -27,7 +29,7 @@ await peer.init({
 });
 ```
 
-connects the first node of the Kranodar network. You can find the officially maintained list networks in the `@fluencelabs/fluence-network-environment` package. The full list of supported options is described in the [API reference](js-sdk/6_reference/modules.md)
+connects the first node of the Kranodar network. You can find the officially maintained list networks in the `@fluencelabs/fluence-network-environment` package. The full list of supported options is described in the [API reference](https://github.com/fluencelabs/gitbook-docs/tree/77344eb147c2ce17fe1c0f37013082fc85c1ffa3/js-sdk/js-sdk/6_reference/modules.md)
 
 Most of the time a single peer is enough for the whole application. For these use cases`FluncePeer` class contains the default instance which can be accessed with the corresponding property:
 
@@ -35,7 +37,7 @@ Most of the time a single peer is enough for the whole application. For these us
 await FluencePeer.default.init();
 ```
 
-The peer by itself does not do any useful work. You should take advantage of functions generated by the Aqua compiler. You can use them both with a single peer or in muliple peers scenario. If you are using the default peer for your application you don't need to explicitly pass it: the compiled functions will use the `default` instance in that case (see "Using multiple peers in one applicaton")
+The peer by itself does not do any useful work. You should take advantage of functions generated by the Aqua compiler. You can use them both with a single peer or in muliple peers scenario. If you are using the default peer for your application you don't need to explicitly pass it: the compiled functions will use the `default` instance in that case \(see "Using multiple peers in one applicaton"\)
 
 To uninitialize the peer simply call `uninit` method. It will disconnect from the network and stop the Aqua vm,
 
@@ -43,7 +45,7 @@ To uninitialize the peer simply call `uninit` method. It will disconnect from th
 await peer.unint();
 ```
 
-# Using multiple peers in one applicaton
+## Using multiple peers in one applicaton
 
 In most cases using a single peer is enough. However sometimes you might need to run multiple peers inside the same JS environment. When using a single peer you should initialize the `FluencePeer.default` and call Aqua compiler-generated functions without passing any peer. For example:
 
@@ -149,7 +151,7 @@ It is possible to combine usage of the default peer with another one. Pay close
   });
 ```
 
-# Understanding the Aqua compiler output
+## Understanding the Aqua compiler output
 
 Aqua compiler emits TypeScript or JavaScript which in turn can be called from a js-based environemt. The compiler outputs code for the following entities:
 
@@ -157,20 +159,19 @@ Aqua compiler emits TypeScript or JavaScript which in turn can be called from a
 2. Exported `service` declarations are turned into functions which register callback handler in a typed manner
 3. For every exported `service` the compiler generated it's interface under the name `{serviceName}Def`
 
-## Function definitions
+### Function definitions
 
 For every exported function definition in aqua the compiler generated two overloads. One accepting the `FluencePeer` instance as the first argument, and one without it. Otherwise arguments are the same and correspond to the arguments of aqua functions. The last argument is always an optional config object with the following properties:
 
-- `ttl`: Optional parameter which specify TTL (time to live) of particle with execution logic for the function
+* `ttl`: Optional parameter which specify TTL \(time to live\) of particle with execution logic for the function
 
 The return type is always a promise of the aqua function return type. If the function does not return anything, the return type will be `Promise<void>`.
 
 Consider the following example:
 
-```
+```text
 func myFunc(arg0: string, arg1: string):
     -- implementation
-
 ```
 
 The compiler will generate the following overloads:
@@ -190,7 +191,7 @@ export async function callMeBack(
 ): Promise<void>;
 ```
 
-## Service definitions
+### Service definitions
 
 For every exported `service` declaration the compiler will generate two entities: service interface under the name `{serviceName}Def` and a function named `register{serviceName}` with several overloads. First let's describe the most complete one using the following example:
 
@@ -206,9 +207,9 @@ export function registerStringExtra(
 ): void;
 ```
 
-- `peer` - the Fluence Peer instance where the handler should be registered. The peer can be ommited. In that case the `FluencePeer.default` will be used instead
-- `serviceId` - the name of the service id. If the service was defined with the default service id in aqua code, this argument can be ommited.
-- `service` - the handler for the service.
+* `peer` - the Fluence Peer instance where the handler should be registered. The peer can be ommited. In that case the `FluencePeer.default` will be used instead
+* `serviceId` - the name of the service id. If the service was defined with the default service id in aqua code, this argument can be ommited.
+* `service` - the handler for the service.
 
 Depending on whether or not the services was defined with the default id the number of overloads will be different. In the case it **is defined**, there would be four overloads:
 
@@ -264,11 +265,11 @@ export function registerStringExtra(
 1. Uses `FluencePeer.default` and specifies the service id explicitly
 2. Specifying both peer and the service id.
 
-## Service interface
+### Service interface
 
-The service interface type follows closely the definition in aqua code. It has the form of the object which keys correspond to the names of service members and the values are functions of the type translated from aqua definition (see Type convertion). For example, for the following aqua definition:
+The service interface type follows closely the definition in aqua code. It has the form of the object which keys correspond to the names of service members and the values are functions of the type translated from aqua definition \(see Type convertion\). For example, for the following aqua definition:
 
-```
+```text
 service Calc("calc"):
     add(n: f32)
     subtract(n: f32)
@@ -293,19 +294,19 @@ export interface CalcDef {
 
 `CallParams` will be described later in the section
 
-## Type convertion
+### Type convertion
 
 Basic types convertion is pretty much straightforward:
 
-- `string` is converted to `string` in typescript
-- `bool` is converted to `boolean` in typescript
-- All number types (`u8`, `u16`, `u32`, `u64`, `s8`, `s16`, `s32`, `s64`, `f32`, `f64`) are converted to `number` in typescript
+* `string` is converted to `string` in typescript
+* `bool` is converted to `boolean` in typescript
+* All number types \(`u8`, `u16`, `u32`, `u64`, `s8`, `s16`, `s32`, `s64`, `f32`, `f64`\) are converted to `number` in typescript
 
 Arrow types translate to functions in typescript which have their arguments translated to typescript types. In addition to arguments defined in aqua, typescript counterparts have an additional argument for call params. For the majority of use cases this parameter is not needed and can be ommited.
 
 The type convertion works the same way for `service` and `func` definitions. For example a `func` with a callback might look like this:
 
-```
+```text
 func callMeBack(callback: string, i32 -> ()):
     callback("hello, world", 42)
 ```
@@ -316,9 +317,9 @@ The type for `callback` argument will be:
 callback: (arg0: string, arg1: number, callParams: CallParams<'arg0' | 'arg1'>) => void,
 ```
 
-For the service definitions arguments are named (see calc example above)
+For the service definitions arguments are named \(see calc example above\)
 
-## Call params and tetraplets
+### Call params and tetraplets
 
 Each service call is accompanied by additional information specific to Fluence Protocol. Including `initPeerId` - the peer which initiated the particle execution, particle signature and most importantly security tetraplets. All this data is contained inside the last `callParams` argument in every generated function definition. These data is passed to the handler on each function call can be used in the application.
 
@@ -332,6 +333,7 @@ Tetraplets have the form of:
 }
 ```
 
-To learn more about tetraplets and application security see [Security](knowledge_security.md)
+To learn more about tetraplets and application security see [Security](https://github.com/fluencelabs/gitbook-docs/tree/77344eb147c2ce17fe1c0f37013082fc85c1ffa3/js-sdk/knowledge_security.md)
+
+To see full specification of `CallParms` type see [Api reference](https://github.com/fluencelabs/gitbook-docs/tree/77344eb147c2ce17fe1c0f37013082fc85c1ffa3/js-sdk/js-sdk/6_reference/modules.md)
 
-To see full specification of `CallParms` type see [Api reference](js-sdk/6_reference/modules.md)

js-sdk/4_run_in_browser-1.md

@@ -1 +1,4 @@
-You can use the JS SDK with any framework (or even without it). Just follow the steps from the previous sections. FluentPad is an example application written in React: https://github.com/fluencelabs/fluent-pad
+# Running app in browser
+
+You can use the JS SDK with any framework \(or even without it\). Just follow the steps from the previous sections. FluentPad is an example application written in React: [https://github.com/fluencelabs/fluent-pad](https://github.com/fluencelabs/fluent-pad)
+

js-sdk/5_run_in_node.md

@@ -1,21 +1,23 @@
-# Intro
+# Running app in nodejs
+
+## Intro
 
 JS SDK makes it easy to run applications in NodeJS environment. You can take full advantage of the javascript ecosystem and at the save time expose service to the Fluence Network. That makes is an excellent choice for quick prototyping of applications for Fluence Stack.
 
-# Calc app example
+## Calc app example
 
 Lets implement a very simple app which simulates a desk calculator. The calculator has internal memory and implements the following set of operations:
 
-- Add a number
-- Subtract a number
-- Multiply by a number
-- Divide by a number
-- Get the current memory state
-- Reset the memory state to 0.0
+* Add a number
+* Subtract a number
+* Multiply by a number
+* Divide by a number
+* Get the current memory state
+* Reset the memory state to 0.0
 
 First, let's write the service definition in aqua:
 
-```
+```text
 -- service definition
 service Calc("calc"):
     add(n: f32)
@@ -104,7 +106,6 @@ application started
 peer id is:  12D3KooWLBkw4Tz8bRoSriy5WEpHyWfU11jEK3b5yCa7FBRDRWH3
 relay is:  12D3KooWSD5PToNiLQwKDXsu8JSysCwUt8BVUJEqCHcDe7P5h45e
 press any key to continue
-
 ```
 
 And the service can be called from aqua. For example:
@@ -122,3 +123,4 @@ func demoCalculation() -> f32:
         res <- Calc.getResult()
     <- res
 ```
+

quick-start/3.-browser-to-service.md

@@ -14,9 +14,9 @@ And run the application with:
 npm start
 ```
 
-Which will open a new browser tab at `http://localhost:3000` . Following the instructions, we connect to any one of the displayed relay ids, open another browser tab also at  `http://localhost:3000`, select a relay and copy and  paste the client peer id and relay id into corresponding fields in the first tab and press the `say hello` button.
+Which will open a new browser tab at `http://localhost:3000` . Following the instructions, we connect to any one of the displayed relay ids, open another browser tab also at `http://localhost:3000`, select a relay and copy and paste the client peer id and relay id into corresponding fields in the first tab and press the `say hello` button.
 
-![Browser To Service Implementation](../.gitbook/assets/image%20%2838%29%20%281%29.png)
+![Browser To Service Implementation](../.gitbook/assets/image%20%2838%29.png)
 
 The result looks familiar, so what's different? Let's have a look at the Aqua file. Navigate to the `aqua/getting_started.aqua` file in your IDE:
 
@@ -35,7 +35,7 @@ Before we dive into the `sayHello` function, let's look at why we still need a l
 
 * The function signature \(18\) takes two arguments: `targetPeerId`, which is the client peer id of the other browser and  the `targetelayPeerId`, which is the relay id -- both parameters are the values  you copy and pasted from the second browser tab into the first browser tab
 * The first step is to call on the hosted service `HelloWorld` on the host peer `helloWorldPeerId` , which we specified in line 1
-  * We bind the `HelloWorld` interface, on the  peer `helloWorldPeerId`, i.e.,`12D3KooWFEwNWcHqi9rtsmDhsYcDbRUCDXH84RC4FW6UfsFWaoHi`, to the  service id of the hosted service `helloWorldServiceId` , i.e. `1e740ce4-81f6-4dd4-9bed-8d86e9c2fa50`, which takes the %init\__peer\__id%  parameter, i.e., the peer id of the peer that initiated the request, and pushes the result into `comp`  \(20-22\)
+  * We bind the `HelloWorld` interface, on the  peer `helloWorldPeerId`, i.e.,`12D3KooWFEwNWcHqi9rtsmDhsYcDbRUCDXH84RC4FW6UfsFWaoHi`, to the  service id of the hosted service `helloWorldServiceId` , i.e. `1e740ce4-81f6-4dd4-9bed-8d86e9c2fa50`, which takes the %init\_\_peer\_\_id%  parameter, i.e., the peer id of the peer that initiated the request, and pushes the result into `comp`  \(20-22\)
   * We now want to send a result back to the target browser \(peer\) \(25-26\) using the local service via the `targetRelayPeerId` in the background as a `co` routine.
   * Finally, we send the `comp` result to the initiating browser
 

quick-start/README.md

@@ -39,7 +39,7 @@ With Docker and VSCode in place:
 * When asked for volume, press enter \(unique\)
 * Open Terminal in VSCode \(ctrl-\`\)
 
-![Installed And Ready Devcontainer in VSCode](../.gitbook/assets/image%20%2818%29.png)
+![Installed And Ready Devcontainer in VSCode](../.gitbook/assets/image%20%2818%29%20%281%29.png)
 
 Congratulations, you now have a fully functional Fluence development environment. For a variety of container management options, click on the `Dev Container: Fluence` button in the lower left of your tool bar: