-
Notifications
You must be signed in to change notification settings - Fork 16
docs: Add Introduction Section #331
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
21d1ba6
add intro section for the docs
longfeiWan9 9623707
Merge branch 'FilOzone:master' into docs/intro
longfeiWan9 0fc626e
Merge branch 'FilOzone:master' into docs/intro
longfeiWan9 ce861f1
Merge branch 'FilOzone:master' into docs/intro
longfeiWan9 75ade7b
address Tims comments
longfeiWan9 056d6fd
Merge branch 'master' of https://github.com/FIL-Builders/synapse-sdk β¦
longfeiWan9 a244828
Merge branch 'master' of https://github.com/FIL-Builders/synapse-sdk β¦
longfeiWan9 e631d1f
Merge branch 'FilOzone:master' into docs/intro
longfeiWan9 eb310d1
Merge branch 'master' of https://github.com/FIL-Builders/synapse-sdk β¦
longfeiWan9 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion
2
...rc/content/docs/intro/getting-started.mdx β ...t/docs/gettingStarted/getting-started.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
docs/src/content/docs/intro/components.mdx β docs/src/content/docs/guides/components.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
longfeiWan9 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
longfeiWan9 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: About Filecoin Onchain Cloud | ||
| description: Learn about Filecoin Onchain Cloud - a decentralized cloud platform built on Filecoin that enables smart-contract based storage and services. | ||
| sidebar: | ||
| order: 1 | ||
| --- | ||
|
|
||
| Since its launch, [**Filecoin Network**](https://filecoin.io/) has been the backbone for **decentralized data storage**, anchored by its *Proof-of-Replication (PoRep)* model that ensures the integrity of long-term, immutable data. However, as decentralized applications evolve, they demand **faster access, dynamic payments, and cryptographic verification** that can operate within smart contracts. | ||
|
|
||
| [**Filecoin Onchain Cloud (FOC)**](https://www.filecoin.cloud/) addresses this next-generation demand by reimagining storage as a **programmable cloud service layer** β where each capability (storage, retrieval, billing, verification) exists as a composable onchain module. These modules can be combined, forked, or extended, giving builders the flexibility to create customized decentralized applications and data-driven services. | ||
|
|
||
| Built on the **Filecoin Virtual Machine (FVM)** and powered by a distributed network of verifiable storage providers, Filecoin Onchain Cloud transforms the Filecoin Network from a large-scale cold storage layer into a programmable, service-based data infrastructure. | ||
|
|
||
| ## Architecture | ||
|
|
||
| FOC addresses this next-generation demand by creating composable onchain modules where each capability (storage, retrieval, billing, verification) can be combined, forked, or extended, giving developers the flexibility to create customized decentralized applications and data-driven services. It is built around four fundamental layers: | ||
|
|
||
| 1. **Warm Storage Services** β Provided by decentralized service providers using the Filecoin Warm Storage Service (FWSS), optimized for accessibility and speed through PDP proofs. | ||
| 2. **Payment & Settlement Layer** β Managed by Filecoin Pay, enabling flexible, auditable billing flows between clients and providers. | ||
| 3. **Retrieval Layer** β Powered by Filecoin Beam, enabling fast, CDN-like retrieval with verifiable delivery proofs and pay-per-byte billing. | ||
| 4. **Developer & Application Layer** β Powered by the Synapse SDK, which abstracts service contracts, data sets, and payment rails into simple APIs usable across web, node, and edge environments. | ||
|
|
||
|  | ||
|
|
||
| ### Key Properties | ||
|
|
||
| At its core, Filecoin Onchain Cloud delivers cloud-grade performance and usability with verifiable onchain properties: | ||
|
|
||
| - π **Ownership** β Data, payments, and service logic belong to users and developers, not intermediaries. | ||
| - π **Verifiability** β Every transaction, proof, and interaction is recorded, auditable, and cryptographically verifiable on the Filecoin blockchain. | ||
| - βοΈ **Programmability** β Services are governed by smart contracts that developers can compose, automate, or extend to suit diverse application needs. | ||
|
|
||
| This design allows Filecoin to move beyond static data storage β offering real-time data services, decentralized payment flows, and programmable access policies that any developer can integrate through a unified interface. | ||
|
|
||
| ### Core Components | ||
|
|
||
| The Filecoin Onchain Cloud services are built from foundational components that together create a verifiable, service-oriented cloud stack: | ||
|
|
||
| - [**Proof of Data Possession (PDP)**](https://github.com/FilOzone/pdp) β The cryptographic proof layer ensuring data storage integrity and retrievability. | ||
| - [**Filecoin Pay**](https://github.com/FilOzone/filecoin-pay) β The financial settlement engine that enables programmable payments for onchain services. | ||
| - [**Filecoin Beam**](https://docs.filbeam.com/) β The retrieval and delivery network that ensures global accessibility of stored data. | ||
| - [**Filecoin Warm Storage Service (FWSS)**](https://github.com/FilOzone/filecoin-services) β The operational layer providing fast, persistent, and verifiable data storage. | ||
|
|
||
| Each of these components works independently yet integrates seamlessly through onchain smart contracts and the [**Synapse SDK**](https://github.com/FilOzone/synapse-sdk), forming a cohesive, modular system. Together, they deliver the core properties of a next-generation decentralized cloud: verifiability, programmability, and composability. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Why Filecoin Onchain Cloud? | ||
| description: Learn about the key benefits and use cases of Filecoin Onchain Cloud for decentralized storage and services. | ||
| sidebar: | ||
| order: 2 | ||
| --- | ||
|
|
||
| Traditional cloud storage solutions present several challenges: | ||
|
|
||
| - **Centralized Control**: Data and services are controlled by a single provider | ||
| - **Limited Transparency**: Operations and pricing are opaque | ||
| - **Vendor Lock-in**: Difficult to migrate between providers | ||
| - **Trust Requirements**: Users must trust providers to handle data properly | ||
| - **Fixed Payment Models**: Inflexible billing tied to specific providers | ||
|
|
||
| ## The FOC Solution | ||
|
|
||
| Traditional cloud services offer performance and usability but lack transparency, auditability, and user ownership. **Filecoin Onchain Cloud** bridges this gap by introducing a **trustless execution layer** for decentralized services. Each service in the Onchain Cloud β from storage to payment β operates as a smart contract, ensuring that every action, transaction, and proof is **verifiable on the Filecoin blockchain**. | ||
|
|
||
| FOC is designed to: | ||
| - β **Enable hot and verifiable data storage and retrieval** with Proof of Data Possession (PDP) & Filecoin Beam | ||
| - π§© **Simplify developer integration** through the Synapse SDK β a TypeScript library for building Filecoin-native dApps | ||
longfeiWan9 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - π° **Power programmable payments** via Filecoin Pay β a token-agnostic payment rail for decentralized services | ||
| - π» **Provide programmable services** β Smart contract-based, composable service primitives on top of the Filecoin network | ||
| - π **Foster innovation** by letting teams build, fork, and combine services into new decentralized applications | ||
|
|
||
| ### Key Differentiators | ||
|
|
||
| | Feature | Traditional Cloud | Filecoin Onchain Cloud | | ||
| |---------|------------------|------------------------| | ||
| | Data Control | Provider controlled | User owned | | ||
| | Transparency | Limited | Full blockchain verification | | ||
| | Programmability | Provider APIs | Smart contracts | | ||
| | Payment Models | Fixed | Flexible & programmable | | ||
longfeiWan9 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | Trust Model | Provider trust | Cryptographic proofs | | ||
| | Vendor Lock-in | High | None | | ||
|
|
||
| ### Use Cases | ||
|
|
||
| Filecoin Onchain Cloud opens the door for new classes of verifiable applications: | ||
|
|
||
| - Decentralized data storage and pinning platforms (e.g., Filecoin Pin) | ||
| - AI and compute services tied to verifiable data pipelines | ||
| - Autonomous agents that own, store, and pay for their data | ||
| - Regulatory-compliant archiving systems with proof-of-retention | ||
| - Data DAOs and programmable marketplaces for shared datasets | ||
|
|
||
| By unifying data, payments, and verifiability, FOC provides the foundation for the next generation of decentralized applications β where storage is not just a service, but a verifiable primitive. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Ready to start building with Filecoin Onchain Cloud? Check out our [**Getting Started guide**](/docs/getting-started/) to learn how to integrate the Synapse SDK into your application. | ||
|
|
||
| The **Synapse SDK** provides a simple, familiar API that abstracts away the complexity of blockchain interactions, allowing you to focus on building your application while leveraging the power of decentralized storage. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.