feat(fluence-network-environment): Introduce fluence-network-environment package (#442)

* Introduce fluence-network-environment package

* Refactor types

* Fix type

* Remove BC

* Update CLI

* Remove fluence local up from CI

* Add configs

* Add type module

* Update e2e file

* Remove lock file

* Revert "Add configs"

This reverts commit ade4476.

* Revert "Remove fluence local up from CI"

This reverts commit 477a12d.

Author: Akim

.fluence/schemas/env.json

@@ -11,14 +11,13 @@
       "enum": [
         "dar",
         "stage",
-        "kras",
         "local",
         "custom"
       ],
       "nullable": true
     },
     "version": {
-      "type": "number",
+      "type": "integer",
       "const": 0
     }
   },

.github/release-please/config.json

@@ -13,6 +13,7 @@
     "packages/core/marine-worker": {},
     "packages/core/aqua-to-js": {},
     "packages/core/interfaces": {},
-    "packages/core/npm-aqua-compiler": {}
+    "packages/core/npm-aqua-compiler": {},
+    "packages/core/fluence-network-environment": {}
   }
 }

.github/release-please/manifest.json

@@ -4,5 +4,6 @@
   "packages/core/aqua-to-js": "0.3.13",
   "packages/core/js-client-isomorphic": "0.6.0",
   "packages/core/interfaces": "0.12.0",
-  "packages/core/npm-aqua-compiler": "0.0.3"
+  "packages/core/npm-aqua-compiler": "0.0.3",
+  "packages/core/fluence-network-environment": "1.1.2"
 }

.github/workflows/e2e.yml

@@ -43,10 +43,12 @@ jobs:
     uses: fluencelabs/aqua/.github/workflows/tests.yml@main
     with:
       js-client-snapshots: "${{ needs.js-client.outputs.js-client-snapshots }}"
+      nox-image: "docker.fluence.dev/nox:feat-vm-425-aquavm-mem-limits-from-config-2_5056_1"
   flox:
     needs:
       - js-client
 
     uses: fluencelabs/flox/.github/workflows/tests.yml@main
     with:
       js-client-snapshots: "${{ needs.js-client.outputs.js-client-snapshots }}"
+      nox-image: "docker.fluence.dev/nox:feat-vm-425-aquavm-mem-limits-from-config-2_5056_1"

.github/workflows/run-tests.yml

@@ -28,4 +28,4 @@ jobs:
     uses: ./.github/workflows/tests.yml
     with:
       ref: ${{ github.ref }}
-      nox-image: "docker.fluence.dev/nox:renovate-avm_4905_1"
+      nox-image: "docker.fluence.dev/nox:feat-vm-425-aquavm-mem-limits-from-config-2_5056_1"

.github/workflows/tests.yml

@@ -81,6 +81,8 @@ jobs:
 
       - name: Run nox network
         run: fluence local up
+        env:
+          FCLI_V_NOX: docker.fluence.dev/nox:feat-vm-425-aquavm-mem-limits-from-config-2_5056_1
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v2.2.4

packages/core/aqua-to-js/src/generate/service.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { JSONValue, ServiceDef } from "@fluencelabs/interfaces";
+import { ServiceDef } from "@fluencelabs/interfaces";
 
 import { recursiveRenameLaquaProps } from "../utils.js";
 
@@ -63,6 +63,6 @@ function generateRegisterServiceOverload(
 }
 
 function serviceToJson(service: ServiceDef): string {
-  const record: Record<never, JSONValue> = service;
+  const record: Record<never, unknown> = service;
   return JSON.stringify(recursiveRenameLaquaProps(record), null, 4);
 }

packages/core/aqua-to-js/src/utils.ts

@@ -20,7 +20,6 @@ import { join } from "path";
 import {
   ArrowType,
   ArrowWithoutCallbacks,
-  JSONValue,
   LabeledProductType,
   NilType,
   SimpleTypes,
@@ -67,7 +66,7 @@ export function getFuncArgs(
   }
 }
 
-export function recursiveRenameLaquaProps(obj: JSONValue): unknown {
+export function recursiveRenameLaquaProps(obj: unknown): unknown {
   if (typeof obj !== "object" || obj === null) {
     return obj;
   }
@@ -78,7 +77,9 @@ export function recursiveRenameLaquaProps(obj: JSONValue): unknown {
     });
   }
 
-  return Object.getOwnPropertyNames(obj).reduce((acc, prop) => {
+  const objType: Record<never, unknown> = obj;
+
+  return Object.getOwnPropertyNames(objType).reduce((acc, prop) => {
     let accessProp = prop;
 
     if (prop.includes("Laqua_js")) {
@@ -89,12 +90,14 @@ export function recursiveRenameLaquaProps(obj: JSONValue): unknown {
         throw new Error(`Bad property name: ${prop}.`);
       }
 
-      if (refinedProperty in obj) {
+      if (refinedProperty in objType) {
         accessProp = refinedProperty;
       }
     }
 
-    const laquaProp = obj[accessProp];
+    const accessObj: Record<string, unknown> = objType;
+
+    const laquaProp = accessObj[accessProp];
 
     if (laquaProp === undefined) {
       return acc;

packages/core/fluence-network-environment/.gitignore

@@ -0,0 +1,16 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+bundle/
+dist/
+
+# Dependency directories
+node_modules/
+jspm_packages/

packages/core/fluence-network-environment/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## [1.1.2](https://github.com/fluencelabs/fluence-network-environment/compare/fluence-network-environment-v1.1.1...fluence-network-environment-v1.1.2) (2023-07-05)
+
+
+### Bug Fixes
+
+* Update DNS records after kras migration to Nomad ([#11](https://github.com/fluencelabs/fluence-network-environment/issues/11)) ([446df4f](https://github.com/fluencelabs/fluence-network-environment/commit/446df4f5eaa64d8d5b803e23f73b8cf8e4331d2e))
+
+## [1.1.1](https://github.com/fluencelabs/fluence-network-environment/compare/fluence-network-environment-v1.1.0...fluence-network-environment-v1.1.1) (2023-07-03)
+
+
+### Bug Fixes
+
+* Actually build package ([#9](https://github.com/fluencelabs/fluence-network-environment/issues/9)) ([25ef57e](https://github.com/fluencelabs/fluence-network-environment/commit/25ef57e061d75abaa08d58a4fef89e71d9cfb4da))
+
+## [1.1.0](https://github.com/fluencelabs/fluence-network-environment/compare/fluence-network-environment-v1.0.14...fluence-network-environment-v1.1.0) (2023-06-19)
+
+
+### Features
+
+* Rename krasnodar to kras. Add functions to pick random nodes ([#4](https://github.com/fluencelabs/fluence-network-environment/issues/4)) ([a65217f](https://github.com/fluencelabs/fluence-network-environment/commit/a65217fd2e0d3c65f4ae54105b54018af778e92d))
+* Update stage multiaddr ([#7](https://github.com/fluencelabs/fluence-network-environment/issues/7)) ([3c0f1f8](https://github.com/fluencelabs/fluence-network-environment/commit/3c0f1f89a5f713e94ee0104bcf0fa9b66f8a5cca))
+
+
+### Bug Fixes
+
+* Update testnet DNS records ([#8](https://github.com/fluencelabs/fluence-network-environment/issues/8)) ([2ed6209](https://github.com/fluencelabs/fluence-network-environment/commit/2ed6209c9c122fe2cd2b7811379c97163c64db88))

packages/core/fluence-network-environment/README.md

@@ -0,0 +1,65 @@
+# Fluence network environment
+
+[![npm](https://img.shields.io/npm/v/@fluencelabs/fluence-network-environment)](https://www.npmjs.com/package/@fluencelabs/fluence-network-environment)
+
+Maintained list of well-known Fluence network nodes. The package is meant to be used in combination with [Fluence JS SDK](https://github.com/fluencelabs/fluence-js).
+
+## Installation
+
+With npm
+
+```bash
+npm install @fluencelabs/fluence-network-environment
+```
+
+With yarn
+
+```bash
+yarn add @fluencelabs/fluence-network-environment
+```
+
+## Usage
+
+Pick a node to connect to the Fluence network.
+
+```typescript
+import { testNet } from "@fluencelabs/fluence-network-environment";
+
+export const relayNode = testNet[0];
+```
+
+Which can be used to initialize the Fluence client (see [Fluence JS SDK](https://github.com/fluencelabs/fluence-js).)
+
+```typescript
+import { FluencePeer } from "@fluencelabs/fluence";
+
+const peer = new FluencePeer();
+await peer.start({ connectTo: relayNode });
+```
+
+## Known networks
+
+- stage - unstable network for development tests; low capacity
+- TestNet - more stable network, used for QA of new releases; higher capacity
+- Kras - stable network, has the highest load capacity
+
+All 3 networks are connected, i.e. any node can be discovered from every other. They're open and permissionless, meaning that anyone can use any node for bootstrapping.
+
+## Fluence Stack
+
+|         Layer         |                                                               Tech                                                                |              Scale               |               State               |                                                   Based on                                                    |
+| :-------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :------------------------------: | :-------------------------------: | :-----------------------------------------------------------------------------------------------------------: |
+|       Execution       |                                          [Marine](https://github.com/fluencelabs/marine)                                          |           Single peer            | Disk, network, external processes | Wasm, [IT](https://github.com/fluencelabs/interface-types), [Wasmer\*](https://github.com/fluencelabs/wasmer) |
+|      Composition      |                                            [Aqua](https://github.com/fluencelabs/aqua)                                            |          Involved peers          |      Results and signatures       |                                                 ⇅, π-calculus                                                 |
+|       Topology        | [TrustGraph](https://github.com/fluencelabs/fluence/tree/master/trust-graph), [DHT\*](https://github.com/fluencelabs/rust-libp2p) | Distributed with Kademlia\* algo |    Actual state of the network    |                                [libp2p](https://github.com/libp2p/rust-libp2p)                                |
+| Security & Accounting |                                                            Blockchain                                                             |          Whole network           |        Licenses & payments        |                                                  substrate?                                                   |
+
+<br/>
+
+<p width="100%">
+<img alt="aquamarine scheme" align="center" src="doc/image.png"/>
+</p>
+
+## License
+
+[Apache 2.0](https://github.com/fluencelabs/fluence/blob/trustless_computing/LICENSE.md)

packages/core/fluence-network-environment/doc/image.png

@@ -0,0 +1,17 @@
+{
+  "type": "module",
+  "name": "@fluencelabs/fluence-network-environment",
+  "version": "1.1.2",
+  "description": "Fluence network environments addresses",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": "https://github.com/fluencelabs/fluence-network-environment",
+  "author": "Fluence Labs",
+  "license": "Apache-2.0"
+}

packages/core/fluence-network-environment/package.json

@@ -165,23 +165,24 @@ export const kras: Relay[] = [
   },
 ];
 
-export const randomKras = (): Relay => {
+// for backward compatibility
+export const krasnodar = kras;
+
+export const randomKras = () => {
   return randomItem(kras);
 };
 
-export const randomTestNet = (): Relay => {
+export const randomTestNet = () => {
   return randomItem(testNet);
 };
 
-export const randomStage = (): Relay => {
+export const randomStage = () => {
   return randomItem(stage);
 };
 
-function randomItem(arr: Relay[]): Relay {
+function randomItem(arr: Relay[]) {
   const index = randomInt(0, arr.length);
-  // This array access always defined
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-  return arr[index] as Relay;
+  return arr[index];
 }
 
 function randomInt(min: number, max: number) {

packages/core/js-client/src/network.ts renamed to packages/core/fluence-network-environment/src/index.ts

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

packages/core/fluence-network-environment/tsconfig.json

@@ -15,5 +15,4 @@
  */
 
 export * from "./compilerSupport/aquaTypeDefinitions.js";
-export * from "./commonTypes.js";
 export * from "./future.js";

packages/core/interfaces/src/index.ts

@@ -35,6 +35,7 @@
     "@fluencelabs/avm": "0.62.0",
     "@fluencelabs/interfaces": "workspace:*",
     "@fluencelabs/js-client-isomorphic": "workspace:*",
+    "@fluencelabs/fluence-network-environment": "workspace:*",
     "@fluencelabs/marine-worker": "0.6.0",
     "@fluencelabs/threads": "^2.0.0",
     "@libp2p/crypto": "4.0.1",

packages/core/js-client/package.json

@@ -17,7 +17,6 @@
 import type {
   ArrowWithoutCallbacks,
   FunctionCallDef,
-  JSONValue,
   ServiceDef,
   SimpleTypes,
 } from "@fluencelabs/interfaces";
@@ -32,6 +31,7 @@ import {
 } from "./compilerSupport/conversions.js";
 import { ServiceImpl, UserServiceImpl } from "./compilerSupport/types.js";
 import { FluencePeer } from "./jsPeer/FluencePeer.js";
+import type { JSONValue } from "./util/types.js";
 import { zip } from "./util/utils.js";
 
 import { callAquaFunction, Fluence, registerService } from "./index.js";

packages/core/js-client/src/api.ts

@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-import { JSONValue } from "@fluencelabs/interfaces";
 import { it, describe, expect, assert } from "vitest";
 
 import { ExpirationError } from "../../jsPeer/errors.js";
 import { CallServiceData } from "../../jsServiceHost/interfaces.js";
 import { handleTimeout } from "../../particle/Particle.js";
 import { registerHandlersHelper, withClient } from "../../util/testUtils.js";
+import type { JSONValue } from "../../util/types.js";
 import { checkConnection } from "../checkConnection.js";
 
 import { nodes, RELAY } from "./connection.js";

packages/core/js-client/src/clientPeer/__test__/client.spec.ts

@@ -14,11 +14,10 @@
  * limitations under the License.
  */
 
-import { JSONValue } from "@fluencelabs/interfaces";
-
 import { WrapFnIntoServiceCall } from "../jsServiceHost/serviceUtils.js";
 import { handleTimeout } from "../particle/Particle.js";
 import { logger } from "../util/logger.js";
+import type { JSONValue } from "../util/types.js";
 
 import { ClientPeer } from "./ClientPeer.js";
 

packages/core/js-client/src/clientPeer/checkConnection.ts

@@ -16,11 +16,6 @@
 
 import { z } from "zod";
 
-/**
- * Peer ID's id as a base58 string (multihash/CIDv0).
- */
-export type PeerIdB58 = string;
-
 const relaySchema = z.object({
   peerId: z.string(),
   multiaddr: z.string(),

packages/core/js-client/src/clientPeer/types.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
-import { JSONValue, NonArrowSimpleType } from "@fluencelabs/interfaces";
+import { NonArrowSimpleType } from "@fluencelabs/interfaces";
 import { it, describe, expect, test } from "vitest";
 
+import type { JSONValue } from "../../util/types.js";
 import { aqua2js, js2aqua } from "../conversions.js";
 
 const i32 = { tag: "scalar", name: "i32" } as const;

packages/core/js-client/src/compilerSupport/__test__/conversion.spec.ts

@@ -14,11 +14,10 @@
  * limitations under the License.
  */
 
-import { JSONValue } from "@fluencelabs/interfaces";
-
 import { FluencePeer } from "../jsPeer/FluencePeer.js";
 import { logger } from "../util/logger.js";
 import { ArgCallbackFunction } from "../util/testUtils.js";
+import type { JSONValue } from "../util/types.js";
 
 import {
   errorHandlingService,