0d0bb48a0c
* Upgrade crust-pin to Crust Mainnet * Update yarn lock * Files Module (#6) * Describe file's README * Change Endpoint name and location * Update file's README * Add locales for files * Files Module (#6) * Describe file's README * Change Endpoint name and location * Update file's README * Add locales for files * Update yarn locks file * Update Crust Pinner to bearer authorization (#7) * Fix yarn lock * Add folder support (#8) * Add folder support * Fix * Fix files download * Fix translation * Upgrade react component * Fix ipfs gateway (#9) * Fix yarnlock * Upgrade metadata * Resolve polkadot-js version * Change copyright * Fix lint(copyright) Co-authored-by: Eericxu <2681350846@qq.com> Co-authored-by: Gavin Fu <gavfu@outlook.com> Co-authored-by: Yashiro <51014425+yuhui1208@users.noreply.github.com>
27 lines
1.9 KiB
Markdown
27 lines
1.9 KiB
Markdown
# @polkadot/app-files
|
|
|
|
## Description
|
|
|
|
***Substrate Files*** is a decentralized storage module which allows substrate-based chains(including `Polkadot/Kusama/Crust/Acala/Clover/Moonbeam/Astar/Phala/...`) users upload their files to [IPFS W3Auth Gateway](https://wiki.crust.network/docs/en/buildIPFSWeb3AuthGW) and decentralized pin their files on [Crust Network](https://crust.network) by using the standard [IPFS W3Auth Pinning Service](https://wiki.crust.network/docs/en/buildIPFSW3AuthPin). This module is a 100% IPFS compatible file storage module, users can pin **NFT files**, host **DApps** or store **on-chain data** in totally DECENTRALIZED way(`guaranteed by Crust protocol`).
|
|
Also, the Pinning Service is compatible with several Platforms like `Ethereum`, `Polygon`, `Solana` and `Near`, and funded by [Decentralized Cloud Foundation](https://decloudf.com/). So currently, `Substrate Files` is FREE for all the substrate-based chains!
|
|
|
|
## Features
|
|
|
|
Basically, the function is simple, it consist with 2 major parts: `Upload File` and `Manage File Directory`.
|
|
|
|
### Upload File
|
|
|
|
Upload files with substrate-based chains account, you can also copy the cid to [Crust Apps](https://apps.crust.network/?rpc=wss%3A%2F%2Frpc.crust.network#/storage) to see how many IPFS replicas of your file.
|
|
|
|
### Manage files directory
|
|
|
|
Because the whole files module is decentralized, so your file directory is cached in browser, but you can export and import your file directory info.
|
|
|
|
## References
|
|
|
|
- [Crust Network](https://crust.network)
|
|
- [IPFS Web3 Authentication Gateway](https://wiki.crust.network/docs/en/buildIPFSWeb3AuthGW)
|
|
- [IPFS Web3 Authentication Pinning Service](https://wiki.crust.network/docs/en/buildIPFSW3AuthPin)
|
|
- [IPFS Public Gateway](https://docs.ipfs.io/concepts/ipfs-gateway/)
|
|
- [IPFS Pinning Service](https://docs.ipfs.io/how-to/work-with-pinning-services/#use-an-existing-pinning-service)
|