Skip to content

Commit 9877db2

Browse files
committed
Add: Readme template
1 parent 5c5d32f commit 9877db2

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Developers are turning to decentralized storage as a way to avoid censorship, server outages, and hacks. With decentralized systems, connections can dynamically find the most efficient pathway through the Internet and route around congestion or damage.
2+
3+
The Algorand blockchain provides a decentralized, scalable and secure protocol making it an excelent medium to share information, however the current maximum note size for an Algorand transaction is 1KB limiting the amount of transfered data.
4+
Large files cannot be efficiently stored on blockchains. On one hand side, the blockchain becomes bloated with data that has to be propagated within the blockchain network. On the other hand, since the blockchain is replicated on many nodes, a lot of storage space is required without serving an immediate purpose.
5+
6+
IPFS is a file sharing system that can be leveraged to more efficiently store and share large files. It relies on cryptographic hashes that can easily be stored on a blockchain. Nonetheless, IPFS does not permit users to share files with selected parties. This is necessary, if sensitive or personal data needs to be shared.
7+
8+
File-content encryption before uploading to IPFS protects sensitive data from unauthorized access.
9+
10+
Algorand blockchain technology is then utilized for keeping track of the filehashes and filenames, guaranteeing transparency and speed.
11+
12+
Algorand-IPFS integrations allow us to create decentralized applications with secure digital content.
13+
14+
[TOC]
15+
16+
# Requirements
17+
18+
* Basic working knoweldge of JavaScript (ES6 recommended)
19+
* A working [Node](https://nodejs.org/) installation
20+
* [JS Algorand-SDK V2](https://github.com/algorand/js-algorand-sdk)
21+
* A local client and indexer to connect to **or** a PureStake API key
22+
* For low-volume use, you can use the PureStake API service for [free](https://www.purestake.com/technology/algorand-api/).
23+
24+
# Overview
25+
26+
The Interplanetary File System (IPFS) is a peer-to-peer decentralized way of storing and referring to files by hashes. A client who wants to retrieve any of those files enjoys access to a nice abstraction layer where it simply needs to call the hash of the file it wants. IPFS then combs through the distributed nodes and supplies the client with the file.
27+
28+
The mechanism is to take a file, hash it cryptographically so you end up with a very small and secure representation of the file which ensures that someone can not just come up with another file that has the same hash and use that as the address.
29+
30+
As long as anyone has the hash of the PDF file, they can retrieve it from IPFS. So sensitive files are not well suited for IPFS in their native states. Unless we do something to these files, sharing sensitive files like health records or images is a poor fit for IPFS.
31+
32+
!!! note
33+
To keep this solution simpler, Algorand Standard Assets will be left out will be left as a later exercise.

0 commit comments

Comments
 (0)