Last modified: Fri Aug 16 2019 11:27:04 GMT+0000 (Coordinated Universal Time)
How to pick an appropriate off-chain storage
In this tutorial, you will learn about storage options in Winding Tree ecosystem.
- Get yourself familiar with the architecture
Step by step
When you are uploading inventory to Winding Tree ecosystem, you have to pick where your data will be stored. This is due to the nature of Ethereum blockchain, where storing large chunks of data is expensive. Another problem is, that even the smallest change in data results in the need of a transaction which might get costly and kind of slow.
That's why the majority of data (typically ORG.JSON) in Winding Tree is stored elsewhere, in a so called off-chain storage. And there are multiple options, and as it goes each one has its pros and cons.
Also, because of the Winding Tree Data Model designed as a tree of documents interlinked by URIs, you are able to combine multiple types of storages: Just pick a different storage for each document.
On the source code level, every storage type can be added to Winding Tree ecosystem as an adapter. They are used for both reading and writing and our sample tooling in the form of both Write API and Read API is using them.
For a robust storage system, we support serving the documents via good old HTTPS. This allows you to even serve the documents dynamically from your existing backend. You then only need to make sure that your API speaks the proper data format such as ORG.JSON.
The biggest disadvantage is that you need to host your data somewhere. There are plethora of services for this, you just need to make sure that you have the proper access control of your data.
While setting up your server, don't forget about proper Cross-origin resource sharing (CORS) setup.
Swarm is a decentralized storage developed alongside Ethereum. It is still in its alpha stage and is quite unstable and highly experimental. Use it at your own risk.
Its main advantage is the decentralization aspect - you don't need to manage your own servers. However, there are quite a few disadvantages:
- Still an alpha phase - data can get lost or may become unavailable
- Content hash based addressing - even the smallest change in the data means that it will get a new address.
As the documents in the tree are linked with URIs with each other, every change will get propagated upwards and will result into an on-chain transaction.
Swarm is great for rapid prototyping and testing, but due to its alpha nature I wouldn't use it in production just yet. The addressing issue can be mitigated by using Swarm feeds which we want to support eventually.
There are of course plenty of options available, some more mature than others. In our older blogpost, we discuss a lot of them and our reasoning for choosing Swarm and HTTPS in more detail.
If you'd like to use a so far unsupported storage option, we welcome any third party contribution. Thank you!