FrostFS smart-contract
 
 
Go to file
Evgenii Stratonikov dd583e0d1c [#137] Makefile: add missing .PHONY targets
Signed-off-by: Evgenii Stratonikov <evgeniy@nspcc.ru>
2021-10-05 10:01:27 +03:00
.github [#18] Update README file 2020-10-27 17:33:56 +03:00
alphabet [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
audit [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
balance [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
common Release v0.11.0 - Mungapdo (문갑도, 文甲島) 2021-09-22 19:01:25 +03:00
container [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
neofs [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
neofsid [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
netmap [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
nns [#137] nns: remove unused function 2021-10-05 10:01:27 +03:00
processing [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
proxy [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
reputation [#107] Remove contract owner argument at contract deploy 2021-09-22 11:06:48 +03:00
tests [#137] tests: implement contract testing framework 2021-10-05 10:01:27 +03:00
.gitignore [#25] Update gitignore 2021-03-05 17:13:49 +03:00
CHANGELOG.md Release v0.11.0 - Mungapdo (문갑도, 文甲島) 2021-09-22 19:01:25 +03:00
LICENSE.md init commit 2020-04-01 19:27:29 +03:00
Makefile [#137] Makefile: add missing .PHONY targets 2021-10-05 10:01:27 +03:00
README.md [#137] Makefile: add target for testing 2021-10-05 10:01:27 +03:00
go.mod [#137] tests: implement contract testing framework 2021-10-05 10:01:27 +03:00
go.sum [#137] tests: implement contract testing framework 2021-10-05 10:01:27 +03:00

README.md

NeoFS

NeoFS related smart contracts.


Overview

NeoFS-Contract contains all NeoFS related contracts written for neo-go compiler. These contracts are deployed both in main chain and side chain.

Main chain contracts:

  • neofs
  • processing

Side chain contracts:

  • alphabet
  • audit
  • balance
  • container
  • neofsid
  • netmap
  • nns
  • proxy
  • reputation

Getting started

Prerequisites

To compile smart contracts you need:

Compilation

To build and compile smart contract run make all command. Compiled contracts *_contract.nef and manifest config.json files are placed in the corresponding directories.

$ make all
neo-go contract compile -i alphabet -c alphabet/config.yml -m alphabet/config.json -o alphabet/alphabet_contract.nef
neo-go contract compile -i audit -c audit/config.yml -m audit/config.json -o audit/audit_contract.nef
neo-go contract compile -i balance -c balance/config.yml -m balance/config.json -o balance/balance_contract.nef
neo-go contract compile -i container -c container/config.yml -m container/config.json -o container/container_contract.nef
neo-go contract compile -i neofsid -c neofsid/config.yml -m neofsid/config.json -o neofsid/neofsid_contract.nef
neo-go contract compile -i netmap -c netmap/config.yml -m netmap/config.json -o netmap/netmap_contract.nef
neo-go contract compile -i proxy -c proxy/config.yml -m proxy/config.json -o proxy/proxy_contract.nef
neo-go contract compile -i reputation -c reputation/config.yml -m reputation/config.json -o reputation/reputation_contract.nef
neo-go contract compile -i nns -c nns/config.yml -m nns/config.json -o nns/nns_contract.nef
neo-go contract compile -i neofs -c neofs/config.yml -m neofs/config.json -o neofs/neofs_contract.nef
neo-go contract compile -i processing -c processing/config.yml -m processing/config.json -o processing/processing_contract.nef

You can specify path to the neo-go binary with NEOGO environment variable:

$ NEOGO=/home/user/neo-go/bin/neo-go make all

Remove compiled files with make clean or make mr_proper command.

Testing

Smartcontract tests reside in tests/ directory. To execute test suite after applying changes simply run make test.

$ make test
ok      github.com/nspcc-dev/neofs-contract/tests       0.462s

NeoFS API compatibility

neofs-contract version supported NeoFS API versions
v0.9.x v2.7.0, v2.8.0
v0.10.x v2.7.0, v2.8.0
v0.11.x v2.7.0, v2.8.0, v2.9.0

License

This project is licensed under the GPLv3 License - see the LICENSE.md file for details