From 4077921794f364fca37c14b7743d8419435f9a4c Mon Sep 17 00:00:00 2001 From: Denis Kirillov Date: Wed, 11 Jan 2023 10:52:06 +0300 Subject: [PATCH] [TrueCloudLab#3] *: Use frostfs in docs Signed-off-by: Denis Kirillov --- README.md | 23 ++++------------------- alphabet/config.yml | 2 +- alphabet/doc.go | 2 +- audit/config.yml | 2 +- audit/doc.go | 2 +- proxy/config.yml | 2 +- proxy/doc.go | 2 +- reputation/config.yml | 2 +- reputation/doc.go | 2 +- subnet/config.yml | 2 +- subnet/doc.go | 4 ++-- 11 files changed, 15 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 526c83e..f1cb808 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ are deployed both in the mainchain and the sidechain. Mainchain contracts: -- neofs +- frostfs - processing Sidechain contracts: @@ -24,7 +24,7 @@ Sidechain contracts: - audit - balance - container -- neofsid +- frostfsid - netmap - nns - 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 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 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 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 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 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 ``` @@ -77,21 +77,6 @@ $ make test 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 This project is licensed under the GPLv3 License - see the diff --git a/alphabet/config.yml b/alphabet/config.yml index c1efd04..3f8598b 100644 --- a/alphabet/config.yml +++ b/alphabet/config.yml @@ -1,4 +1,4 @@ -name: "NeoFS Alphabet" +name: "FrostFS Alphabet" safemethods: ["gas", "neo", "name", "version"] permissions: - methods: ["update", "transfer", "vote"] diff --git a/alphabet/doc.go b/alphabet/doc.go index ddd4fab..2571e6b 100644 --- a/alphabet/doc.go +++ b/alphabet/doc.go @@ -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 validators in the sidechain. NEO token is required to produce GAS and vote for diff --git a/audit/config.yml b/audit/config.yml index bc35cfb..db6f45c 100644 --- a/audit/config.yml +++ b/audit/config.yml @@ -1,4 +1,4 @@ -name: "NeoFS Audit" +name: "FrostFS Audit" safemethods: ["get", "list", "listByEpoch", "listByCID", "listByNode", "version"] permissions: - methods: ["update"] diff --git a/audit/doc.go b/audit/doc.go index fb3faf8..97acfee 100644 --- a/audit/doc.go +++ b/audit/doc.go @@ -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. If a container contains StorageGroup objects, an Inner Ring node initializes diff --git a/proxy/config.yml b/proxy/config.yml index 27edbaf..fc9d24a 100644 --- a/proxy/config.yml +++ b/proxy/config.yml @@ -1,4 +1,4 @@ -name: "NeoFS Notary Proxy" +name: "FrostFS Notary Proxy" safemethods: ["verify", "version"] permissions: - methods: ["update"] diff --git a/proxy/doc.go b/proxy/doc.go index 1d8d504..3201a92 100644 --- a/proxy/doc.go +++ b/proxy/doc.go @@ -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 service is enabled in the sidechain. Notary service prepares multisigned transactions, diff --git a/reputation/config.yml b/reputation/config.yml index ce8ded0..3885ecb 100644 --- a/reputation/config.yml +++ b/reputation/config.yml @@ -1,4 +1,4 @@ -name: "NeoFS Reputation" +name: "FrostFS Reputation" safemethods: ["get", "getByID", "listByEpoch"] permissions: - methods: ["update"] diff --git a/reputation/doc.go b/reputation/doc.go index 007720f..ad253af 100644 --- a/reputation/doc.go +++ b/reputation/doc.go @@ -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, nodes produce DataAuditResult structure that contains information about audit diff --git a/subnet/config.yml b/subnet/config.yml index a73f086..20370a4 100644 --- a/subnet/config.yml +++ b/subnet/config.yml @@ -1,4 +1,4 @@ -name: "NeoFS Subnet" +name: "FrostFS Subnet" safemethods: ["version"] permissions: - methods: ["update"] diff --git a/subnet/doc.go b/subnet/doc.go index b7b3ce7..1c8fdbc 100644 --- a/subnet/doc.go +++ b/subnet/doc.go @@ -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 Nodes that can be included in them.