[TrueCloudLab#3] *: Use frostfs in docs

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2023-01-11 10:52:06 +03:00 committed by fyrchik
parent 0c5723964f
commit 4077921794
11 changed files with 15 additions and 30 deletions

View file

@ -15,7 +15,7 @@ are deployed both in the mainchain and the sidechain.
Mainchain contracts: Mainchain contracts:
- neofs - frostfs
- processing - processing
Sidechain contracts: Sidechain contracts:
@ -24,7 +24,7 @@ Sidechain contracts:
- audit - audit
- balance - balance
- container - container
- neofsid - frostfsid
- netmap - netmap
- nns - nns
- proxy - proxy
@ -51,13 +51,13 @@ $ make all
/home/user/go/bin/cli contract compile -i audit -c audit/config.yml -m audit/config.json -o audit/audit_contract.nef /home/user/go/bin/cli contract compile -i audit -c audit/config.yml -m audit/config.json -o audit/audit_contract.nef
/home/user/go/bin/cli contract compile -i balance -c balance/config.yml -m balance/config.json -o balance/balance_contract.nef /home/user/go/bin/cli contract compile -i balance -c balance/config.yml -m balance/config.json -o balance/balance_contract.nef
/home/user/go/bin/cli contract compile -i container -c container/config.yml -m container/config.json -o container/container_contract.nef /home/user/go/bin/cli contract compile -i container -c container/config.yml -m container/config.json -o container/container_contract.nef
/home/user/go/bin/cli contract compile -i neofsid -c neofsid/config.yml -m neofsid/config.json -o neofsid/neofsid_contract.nef /home/user/go/bin/cli contract compile -i frostfsid -c frostfsid/config.yml -m frostfsid/config.json -o frostfsid/frostfsid_contract.nef
/home/user/go/bin/cli contract compile -i netmap -c netmap/config.yml -m netmap/config.json -o netmap/netmap_contract.nef /home/user/go/bin/cli contract compile -i netmap -c netmap/config.yml -m netmap/config.json -o netmap/netmap_contract.nef
/home/user/go/bin/cli contract compile -i proxy -c proxy/config.yml -m proxy/config.json -o proxy/proxy_contract.nef /home/user/go/bin/cli contract compile -i proxy -c proxy/config.yml -m proxy/config.json -o proxy/proxy_contract.nef
/home/user/go/bin/cli contract compile -i reputation -c reputation/config.yml -m reputation/config.json -o reputation/reputation_contract.nef /home/user/go/bin/cli contract compile -i reputation -c reputation/config.yml -m reputation/config.json -o reputation/reputation_contract.nef
/home/user/go/bin/cli contract compile -i subnet -c subnet/config.yml -m subnet/config.json -o subnet/subnet_contract.nef /home/user/go/bin/cli contract compile -i subnet -c subnet/config.yml -m subnet/config.json -o subnet/subnet_contract.nef
/home/user/go/bin/cli contract compile -i nns -c nns/config.yml -m nns/config.json -o nns/nns_contract.nef /home/user/go/bin/cli contract compile -i nns -c nns/config.yml -m nns/config.json -o nns/nns_contract.nef
/home/user/go/bin/cli contract compile -i neofs -c neofs/config.yml -m neofs/config.json -o neofs/neofs_contract.nef /home/user/go/bin/cli contract compile -i frostfs -c frostfs/config.yml -m frostfs/config.json -o frostfs/frostfs_contract.nef
/home/user/go/bin/cli contract compile -i processing -c processing/config.yml -m processing/config.json -o processing/processing_contract.nef /home/user/go/bin/cli contract compile -i processing -c processing/config.yml -m processing/config.json -o processing/processing_contract.nef
``` ```
@ -77,21 +77,6 @@ $ make test
ok github.com/TrueCloudLab/frostfs-contract/tests 0.462s ok github.com/TrueCloudLab/frostfs-contract/tests 0.462s
``` ```
# FrostFS API compatibility
| neofs-contract version | supported FrostFS API versions |
|:----------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| v0.9.x | [v2.7.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.7.0), [v2.8.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.8.0) |
| v0.10.x | [v2.7.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.7.0), [v2.8.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.8.0) |
| v0.11.x | [v2.7.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.7.0), [v2.8.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.8.0), [v2.9.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.9.0) |
| v0.12.x | [v2.10.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.10.0) |
| v0.13.x | [v2.11.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.11.0) |
| v0.14.x | [v2.11.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.11.0) |
| v0.15.x | [v2.11.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.11.0), [v2.12.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.12.0) |
| v0.15.x | [v2.11.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.11.0), [v2.12.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.12.0) |
| v0.16.x | [v2.14.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.14.0) |
# License # License
This project is licensed under the GPLv3 License - see the This project is licensed under the GPLv3 License - see the

View file

@ -1,4 +1,4 @@
name: "NeoFS Alphabet" name: "FrostFS Alphabet"
safemethods: ["gas", "neo", "name", "version"] safemethods: ["gas", "neo", "name", "version"]
permissions: permissions:
- methods: ["update", "transfer", "vote"] - methods: ["update", "transfer", "vote"]

View file

@ -1,5 +1,5 @@
/* /*
Alphabet contract is a contract deployed in NeoFS sidechain. Alphabet contract is a contract deployed in FrostFS sidechain.
Alphabet contract is designed to support GAS production and vote for new Alphabet contract is designed to support GAS production and vote for new
validators in the sidechain. NEO token is required to produce GAS and vote for validators in the sidechain. NEO token is required to produce GAS and vote for

View file

@ -1,4 +1,4 @@
name: "NeoFS Audit" name: "FrostFS Audit"
safemethods: ["get", "list", "listByEpoch", "listByCID", "listByNode", "version"] safemethods: ["get", "list", "listByEpoch", "listByCID", "listByNode", "version"]
permissions: permissions:
- methods: ["update"] - methods: ["update"]

View file

@ -1,5 +1,5 @@
/* /*
Audit contract is a contract deployed in NeoFS sidechain. Audit contract is a contract deployed in FrostFS sidechain.
Inner Ring nodes perform audit of the registered containers during every epoch. Inner Ring nodes perform audit of the registered containers during every epoch.
If a container contains StorageGroup objects, an Inner Ring node initializes If a container contains StorageGroup objects, an Inner Ring node initializes

View file

@ -1,4 +1,4 @@
name: "NeoFS Notary Proxy" name: "FrostFS Notary Proxy"
safemethods: ["verify", "version"] safemethods: ["verify", "version"]
permissions: permissions:
- methods: ["update"] - methods: ["update"]

View file

@ -1,5 +1,5 @@
/* /*
Proxy contract is a contract deployed in NeoFS sidechain. Proxy contract is a contract deployed in FrostFS sidechain.
Proxy contract pays for all multisignature transaction executions when notary Proxy contract pays for all multisignature transaction executions when notary
service is enabled in the sidechain. Notary service prepares multisigned transactions, service is enabled in the sidechain. Notary service prepares multisigned transactions,

View file

@ -1,4 +1,4 @@
name: "NeoFS Reputation" name: "FrostFS Reputation"
safemethods: ["get", "getByID", "listByEpoch"] safemethods: ["get", "getByID", "listByEpoch"]
permissions: permissions:
- methods: ["update"] - methods: ["update"]

View file

@ -1,5 +1,5 @@
/* /*
Reputation contract is a contract deployed in NeoFS sidechain. Reputation contract is a contract deployed in FrostFS sidechain.
Inner Ring nodes produce data audit for each container during each epoch. In the end, Inner Ring nodes produce data audit for each container during each epoch. In the end,
nodes produce DataAuditResult structure that contains information about audit nodes produce DataAuditResult structure that contains information about audit

View file

@ -1,4 +1,4 @@
name: "NeoFS Subnet" name: "FrostFS Subnet"
safemethods: ["version"] safemethods: ["version"]
permissions: permissions:
- methods: ["update"] - methods: ["update"]

View file

@ -1,7 +1,7 @@
/* /*
Subnet contract is a contract deployed in NeoFS sidechain. Subnet contract is a contract deployed in FrostFS sidechain.
Subnet contract stores and manages NeoFS subnetwork states. It allows registering Subnet contract stores and manages FrostFS subnetwork states. It allows registering
and deleting subnetworks, limiting access to them, and defining a list of the Storage and deleting subnetworks, limiting access to them, and defining a list of the Storage
Nodes that can be included in them. Nodes that can be included in them.