frostfs-node

FrostFS is a decentralized distributed object storage integrated with the NEO Blockchain.

Overview

FrostFS Nodes are organized in a peer-to-peer network that takes care of storing and distributing user's data. Any Neo user may participate in the network and get paid for providing storage resources to other users or store their data in FrostFS and pay a competitive price for it.

Users can reliably store object data in the FrostFS network and have a transparent data placement process due to a decentralized architecture and flexible storage policies. Each node is responsible for executing the storage policies that the users select for geographical location, reliability level, number of nodes, type of disks, capacity, etc. Thus, FrostFS gives full control over data to users.

Deep Neo Blockchain integration allows FrostFS to be used by dApps directly from NeoVM on the Smart Contract code level. This way dApps are not limited to on-chain storage and can manipulate large amounts of data without paying a prohibitive price.

FrostFS has a native gRPC API and has protocol gateways for popular protocols such as AWS S3, HTTP, FUSE and sFTP allowing developers to integrate applications without rewriting their code.

Supported platforms

Now, we only support GNU/Linux on amd64 CPUs with AVX/AVX2 instructions. More platforms will be officially supported after release 1.0.

The latest version of frostfs-node works with frostfs-contract v0.19.2.

Building

To make all binaries you need Go 1.22+ and make:

make all

The resulting binaries will appear in bin/ folder.

To make a specific binary use:

make bin/frostfs-<name>

See the list of all available commands in the cmd folder.

Building with Docker

Building can also be performed in a container:

make docker/all                     # build all binaries
make docker/bin/frostfs-<name> # build a specific binary

Docker images

To make docker images suitable for use in frostfs-dev-env use:

make images

Debugging

VSCode

To run and debug single node cluster with VSCode:

1. Clone and build frostfs-contract repository to the same directory level as frostfs-node. For example:

/
├── src
    ├── frostfs-node
    └── frostfs-contract

See frostfs-contract's README.md for build instructions.

1. Copy launch.json and tasks.json from dev/.vscode-example directory to .vscode directory. If you already have such files in .vscode directory, then merge them manually.

2. Go to Run and Debug (Ctrl+Shift+D) and start IR+Storage node configuration.

3. To create container and put object into it run (container and object IDs will be different):

./bin/frostfs-adm morph ape add-rule-chain -c dev/adm/frostfs-adm.yml --target-type namespace --target-name="" --rule "allow Container.* *" --rule "allow Object.* *"  --chain-id 1111

subj_key=`docker container exec -it neo-go neo-go wallet dump-keys -w /wallets/wallet.json | tail -1 | tr -d ' \r\n'` \
                && echo "Subject key: $subj_key"

./bin/frostfs-adm morph frostfsid create-subject \
--subject-key KEY FROM ABOVE \
--subject-name test \
--rpc-endpoint http://127.0.0.1:30333 \
--alphabet-wallets ./dev/ir

Enter password: one

./bin/frostfs-cli container create -r 127.0.0.1:8080 --wallet ./dev/wallet.json --policy "REP 1 IN X CBF 1 SELECT 1 FROM * AS X" --await
Enter password >  <- press ENTER, the is no password for wallet
CID: CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju

./bin/frostfs-cli object put -r 127.0.0.1:8080 --wallet ./dev/wallet.json --file README.md --cid CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju
Enter password >
 4300 / 4300 [===========================================================================================================================================================================================================] 100.00% 0s
[README.md] Object successfully stored
  OID: 78sohnudVMnPsczXqsTUcvezosan2YDNVZwDE8Kq5YwU
  CID: CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju

./bin/frostfs-cli object get -r 127.0.0.1:8080 --wallet ./dev/wallet.json --cid CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju --oid 78sohnudVMnPsczXqsTUcvezosan2YDNVZwDE8Kq5YwU
...

Contributing

Feel free to contribute to this project after reading the contributing guidelines.

Before starting to work on a certain topic, create a new issue first, describing the feature/topic you are going to implement.

Credits

FrostFS is maintained by True Cloud Lab with the help and contributions from community members.

Please see CREDITS for details.

License

• GNU General Public License v3.0