fluencelabs/fluence-network-environment
1
0
Fork 0
mirror of https://github.com/fluencelabs/fluence-network-environment synced 2025-04-25 16:42:19 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
folex 2021-11-30 16:47:25 +03:00 committed by GitHub
parent 1c05902376
commit 1776619cee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -2,7 +2,7 @@
[![npm](https://img.shields.io/npm/v/@fluencelabs/fluence-network-environment)](https://www.npmjs.com/package/@fluencelabs/fluence-network-environment) [![npm](https://img.shields.io/npm/v/@fluencelabs/fluence-network-environment)](https://www.npmjs.com/package/@fluencelabs/fluence-network-environment)
Officially 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). 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 ## Installation
@ -23,32 +23,27 @@ yarn add @fluencelabs/fluence-network-environment
Pick a node to connect to the Fluence network. Pick a node to connect to the Fluence network.
```typescript ```typescript
import { dev } from '@fluencelabs/fluence-network-environment'; import { testNet } from '@fluencelabs/fluence-network-environment';
export const relayNode = dev[0]; export const relayNode = testNet[0];
``` ```
Which can be used to initialize the Fluence client (see [Fluence JS SDK](https://github.com/fluencelabs/fluence-js).) Which can be used to initialize the Fluence client (see [Fluence JS SDK](https://github.com/fluencelabs/fluence-js).)
```typescript ```typescript
import { createClient } from '@fluencelabs/fluence'; import { FluencePeer } from '@fluencelabs/fluence';
const client = await createClient(relayNode); const peer = new FluencePeer;
await peer.start({ connectTo: relayNode });
``` ```
## Known networks ## Known networks
### dev - stage - unstable network for development tests; low capacity
- TestNet - more stable network, used for QA of new releases; higher capacity
- Krasnodar - stable network, has the highest load capacity
**Unstable** Several nodes running on the same physical host. Used a lot to test things out. 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.
### stage
Environment primarily used for staging deployments of various Fluence services.
### TestNet
The main Fluence network. It consists of a ten nodes each running on a separate physical host.
## About Fluence ## About Fluence