Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rename morph to fschain #3038

Merged
merged 1 commit into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli-adm.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ credentials: # passwords for consensus node / alphabet wallets
zhivete: password7
```

### Morph
### FS chain

#### Network deployment

Expand Down
12 changes: 6 additions & 6 deletions docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ wallets will be used for Alphabet nodes. Make sure, that dir for alphabet
wallets already exists.

```
$ neofs-adm -c foo.network.yml morph generate-alphabet --size 1
$ neofs-adm -c foo.network.yml fschain generate-alphabet --size 1
size: 1
alphabet-wallets: /home/user/deploy/alphabet-wallets
wallet[0]: hunter2
Expand Down Expand Up @@ -119,7 +119,7 @@ Use archive with compiled NeoFS contracts to initialize the sidechain.
```
$ tar -xzvf neofs-contract-v0.11.0.tar.gz

$ ./neofs-adm -c foo.network.yml morph init --contracts ./neofs-contract-v0.11.0
$ ./neofs-adm -c foo.network.yml fschain init --contracts ./neofs-contract-v0.11.0
Stage 1: transfer GAS to alphabet nodes.
Waiting for transactions to persist...
Stage 2: set notary and alphabet nodes in designate contract.
Expand Down Expand Up @@ -150,7 +150,7 @@ Waiting for transactions to persist...
## Step 4: Launch Alphabet nodes

Configure Alphabet nodes with the wallets generated in step 1. For
`morph.validators` use a list of public keys from
`fschain.validators` use a list of public keys from
`ProtocolConfiguration.StandbyCommittee`.

```yaml
Expand All @@ -159,7 +159,7 @@ wallet:
password: "hunter2"
account: "NitdS4k4f1Hh5mbLJhAswBK3WC2gQgPN1o"

morph:
fschain:
validators:
- 02c1cc85f9c856dbe2d02017349bcb7b4e5defa78b8056a09b3240ba2a8c078869
```
Expand All @@ -169,7 +169,7 @@ morph:
Generate a new wallet for a Storage node.

```
$ neofs-adm -c foo.network.yml morph generate-storage-wallet --storage-wallet ./sn01.json --initial-gas 10.0
$ neofs-adm -c foo.network.yml fschain generate-storage-wallet --storage-wallet ./sn01.json --initial-gas 10.0
New password >
Waiting for transactions to persist...

Expand All @@ -192,7 +192,7 @@ The storage node will be included in the network map in the next NeoFS epoch. To
speed up this process, you can increment epoch counter immediately.

```
$ neofs-adm -c foo.network.yml morph force-new-epoch
$ neofs-adm -c foo.network.yml fschain force-new-epoch
Current epoch: 8, increase to 9.
Waiting for transactions to persist...
```
Expand Down
2 changes: 1 addition & 1 deletion docs/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Maintenance mode allowed: true

To toggle the setting in the running NeoFS Sidechain, exec:
```shell
$ neofs-adm morph set-config MaintenanceModeAllowed=true|false
$ neofs-adm fschain set-config MaintenanceModeAllowed=true|false
```

To switch the node to MM, exec:
Expand Down
2 changes: 1 addition & 1 deletion docs/sighup.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ comparing paths from `shard.blobstor` section. After this we have 3 sets:
|-----------------|----------------------------------------------------------------------------------------------------------------------|
| `path` | If `path` is different, metabase is closed and opened with a new path. All other configuration will also be updated. |

### Morph
### FS chain

| Changed section | Actions |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
20 changes: 10 additions & 10 deletions docs/storage-node-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ There are some custom types used for brevity:
| `prometheus` | [Prometheus metrics configuration](#prometheus-section) |
| `control` | [Control service configuration](#control-section) |
| `contracts` | [Override NeoFS contracts hashes](#contracts-section) |
| `morph` | [N3 blockchain client configuration](#morph-section) |
| `fschain` | [N3 blockchain client configuration](#fschain-section) |
| `apiclient` | [NeoFS API client configuration](#apiclient-section) |
| `policer` | [Policer service configuration](#policer-section) |
| `replicator` | [Replicator service configuration](#replicator-section) |
Expand Down Expand Up @@ -130,24 +130,24 @@ contracts:
| `netmap` | `hash160` | | Netmap contract hash. |
| `reputation` | `hash160` | | Reputation contract hash. |

# `morph` section
# `fschain` section

```yaml
morph:
fschain:
dial_timeout: 30s
cache_ttl: 15s
endpoints:
- wss://rpc1.morph.fs.neo.org:40341/ws
- wss://rpc2.morph.fs.neo.org:40341/ws
```

| Parameter | Type | Default value | Description |
|------------------------|------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dial_timeout` | `duration` | `1m` | Timeout for dialing connections to N3 RPCs. |
| `cache_ttl` | `duration` | Morph block time | Sidechain cache TTL value (min interval between similar calls).<br/>Negative value disables caching.<br/>Cached entities: containers, container lists, eACL tables. |
| `endpoints` | `[]string` | | Ordered array of _webSocket_ N3 endpoint. Only one is connected at a time, the others are for a fallback if any network error appears. |
| `reconnections_number` | `int` | `5` | Number of reconnection attempts (through the full list provided via `endpoints`) before RPC connection is considered lost. Non-positive values make no retries. |
| `reconnections_delay` | `duration` | `5s` | Time interval between attempts to reconnect an RPC node from `endpoints` if the connection has been lost. |
| Parameter | Type | Default value | Description |
|------------------------|------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dial_timeout` | `duration` | `1m` | Timeout for dialing connections to N3 RPCs. |
| `cache_ttl` | `duration` | FS chain block time | Sidechain cache TTL value (min interval between similar calls).<br/>Negative value disables caching.<br/>Cached entities: containers, container lists, eACL tables. |
| `endpoints` | `[]string` | | Ordered array of _webSocket_ N3 endpoint. Only one is connected at a time, the others are for a fallback if any network error appears. |
| `reconnections_number` | `int` | `5` | Number of reconnection attempts (through the full list provided via `endpoints`) before RPC connection is considered lost. Non-positive values make no retries. |
| `reconnections_delay` | `duration` | `5s` | Time interval between attempts to reconnect an RPC node from `endpoints` if the connection has been lost. |

# `storage` section

Expand Down
12 changes: 6 additions & 6 deletions docs/verified-node-domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ For each public key, a record is created - a structure with at least 3 fields:

NeoFS ADM tool may be used to work with verified nodes' domains from command line.
```
$ neofs-adm morph verified-nodes-domain
$ neofs-adm fschain verified-nodes-domain
```

#### Get access list

List allowed storage nodes:
```
$ neofs-adm morph verified-nodes-domain access-list -r https://rpc1.morph.t5.fs.neo.org:51331 \
$ neofs-adm fschain verified-nodes-domain access-list -r https://rpc1.morph.t5.fs.neo.org:51331 \
-d nodes.some-org.neofs
NZ1czz5gkEDamTg6Tiw6cxqp9Me1KLs8ae
NfMvD6WmBiCr4erfEnFFLs7jdj4Y5CM7nN
Expand All @@ -50,14 +50,14 @@ where `-r` is the NeoFS Sidechain network endpoint.

See command help for details
```
$ neofs-adm morph verified-nodes-domain access-list -h
$ neofs-adm fschain verified-nodes-domain access-list -h
```

#### Set access list

Set list of Neo addresses of the allowed storage nodes:
```
$ neofs-adm morph verified-nodes-domain set-access-list -r https://rpc1.morph.t5.fs.neo.org:51331 \
$ neofs-adm fschain verified-nodes-domain set-access-list -r https://rpc1.morph.t5.fs.neo.org:51331 \
-d nodes.some-org.neofs --alphabet-wallets ./ \
--neo-addresses NZ1czz5gkEDamTg6Tiw6cxqp9Me1KLs8ae \
--neo-addresses NfMvD6WmBiCr4erfEnFFLs7jdj4Y5CM7nN
Expand All @@ -70,7 +70,7 @@ files `az.json`, `buky.json`, etc.

Auxiliary flag `--public-keys` allows you to specify public keys instead of addresses:
```
$ neofs-adm morph verified-nodes-domain set-access-list -r https://rpc1.morph.t5.fs.neo.org:51331 \
$ neofs-adm fschain verified-nodes-domain set-access-list -r https://rpc1.morph.t5.fs.neo.org:51331 \
-d nodes.some-org.neofs --alphabet-wallets ./ \
--public-keys 02b3622bf4017bdfe317c58aed5f4c753f206b7db896046fa7d774bbc4bf7f8dc2 \
--public-keys 02103a7f7dd016558597f7960d27c516a4394fd968b9e65155eb4b013e4040406e
Expand All @@ -81,7 +81,7 @@ $ Access list has been successfully updated.

See command help for details:
```
$ neofs-adm morph verified-nodes-domain set-access-list -h
$ neofs-adm fschain verified-nodes-domain set-access-list -h
```

## Private subnet entrance
Expand Down
Loading