Skip to content

Commit 1e029a6

Browse files
Barbara Pericgitbook-bot
authored andcommitted
GITBOOK-58: change request with no subject merged in GitBook
1 parent 9f80eaf commit 1e029a6

File tree

5 files changed

+66
-109
lines changed

5 files changed

+66
-109
lines changed

.gitbook/assets/FilecoinDocs.png

1.65 MB
Loading

WELCOME.md

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
description: >-
3-
Filecoin is a decentralized, peer-to-peer network enabling anyone to store and retrieve data over the internet. Economic incentives are built in, ensuring files are stored and accessible reliably over time.
4-
cover: .gitbook/assets/home-hero-image-drives.png
5-
coverY: 171
3+
Filecoin is a decentralized, peer-to-peer network enabling anyone to store and
4+
retrieve data over the internet. Economic incentives are built in, ensuring
5+
files are stored and accessible reliably over
6+
cover: .gitbook/assets/FilecoinDocs.png
7+
coverY: 0
68
layout:
79
cover:
810
visible: true
@@ -19,45 +21,10 @@ layout:
1921
visible: true
2022
---
2123

22-
# Welcome to the Filecoin documentation
24+
# Welcome to Filecoin Docs
2325

2426
Choose your own path to start exploring Filecoin:
2527

26-
<table data-card-size="large" data-view="cards">
27-
<thead>
28-
<tr>
29-
<th></th>
30-
<th></th>
31-
<th></th>
32-
<th data-hidden data-card-target data-type="content-ref"></th>
33-
</tr>
34-
</thead>
35-
<tbody>
36-
<tr>
37-
<td>💡 <strong>Learn the basics</strong></td>
38-
<td>New to Filecoin and looking for foundational concepts? Start with the Basics section to understand the essentials and kick off your journey!</td>
39-
<td></td>
40-
<td><a href="basics/what-is-filecoin/">what-is-filecoin</a></td>
41-
</tr>
42-
<tr>
43-
<td>🔧 <strong>Build with Filecoin</strong></td>
44-
<td>Ready to develop on the Filecoin network? Head to the Developers section for guides and examples to help bring your project to life.</td>
45-
<td></td>
46-
<td><a href="smart-contracts/fundamentals/the-fvm.md">the-fvm.md</a></td>
47-
</tr>
48-
<tr>
49-
<td>🏗️ <strong>Become a Storage Provider</strong></td>
50-
<td>Thinking about running a provider node on Filecoin? Visit the Provider section for comprehensive guidance on getting started.</td>
51-
<td></td>
52-
<td><a href="storage-providers/basics/">basics</a></td>
53-
</tr>
54-
<tr>
55-
<td>📊 <strong>Store data</strong></td>
56-
<td>Looking to store large volumes of data? Explore the Store section to review the various storage options Filecoin offers.</td>
57-
<td></td>
58-
<td><a href="basics/what-is-filecoin/storage-model.md">storage-model.md</a></td>
59-
</tr>
60-
</tbody>
61-
</table>
28+
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>💡 <strong>Learn the basics</strong></td><td>New to Filecoin and looking for foundational concepts? Start with the Basics section to understand the essentials and kick off your journey!</td><td></td><td><a href="basics/what-is-filecoin/">what-is-filecoin</a></td></tr><tr><td>🔧 <strong>Build with Filecoin</strong></td><td>Ready to develop on the Filecoin network? Head to the Developers section for guides and examples to help bring your project to life.</td><td></td><td><a href="smart-contracts/fundamentals/the-fvm.md">the-fvm.md</a></td></tr><tr><td>🏗️ <strong>Become a Storage Provider</strong></td><td>Thinking about running a provider node on Filecoin? Visit the Provider section for comprehensive guidance on getting started.</td><td></td><td><a href="storage-providers/basics/">basics</a></td></tr><tr><td>📊 <strong>Store data</strong></td><td>Looking to store large volumes of data? Explore the Store section to review the various storage options Filecoin offers.</td><td></td><td><a href="basics/what-is-filecoin/storage-model.md">storage-model.md</a></td></tr></tbody></table>
6229

6330
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/)

smart-contracts/advanced/contract-automation.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
description: >-
3-
Smart contract automation enables decentralized applications (dapps) to interact with both on-chain and off-chain data in an automated and trustless manner. Automation tools allow developers to build smart contracts that execute predefined actions based on external triggers, eliminating the need for manual intervention while ensuring secure and reliable execution.
3+
Smart contract automation enables decentralized applications (dapps) to
4+
interact with both on-chain and off-chain data in an automated and trustless
5+
manner. Automation tools allow developers to build
46
---
57

6-
# Contract Automation
8+
# Contract automation
79

810
In the Filecoin network, smart contracts benefit from a secure, deterministic environment. While this ensures reliability, it also limits direct access to external data sources. However, developers can leverage automation services to seamlessly connect off-chain data with on-chain smart contracts. This unlocks advanced capabilities such as price feeds, data verification, and much more, empowering Filecoin dapps with dynamic, real-world functionality by integrating external data into on-chain logic.
911

@@ -17,35 +19,26 @@ Gelato's Web3 Functions is a powerful automation system designed to streamline a
1719

1820
Web3 Functions can be triggered by various events and allow developers to write both off-chain logic (TypeScript) and on-chain logic (Solidity). Once deployed, they handle automated smart contract interactions, providing real-time monitoring and flexibility.
1921

20-
**Off-chain Data or Computation?**
21-
Sometimes, automation tasks require data that isn't readily available on the blockchain, or they might need computations that are better performed off-chain. In such cases, Typescript Functions should be the choice.
22+
**Off-chain Data or Computation?** Sometimes, automation tasks require data that isn't readily available on the blockchain, or they might need computations that are better performed off-chain. In such cases, Typescript Functions should be the choice.
2223

23-
**All Checks On-chain?**
24-
If all the conditions necessary for your automation task can be directly verified on the blockchain, you have the option to select between Typescript Functions, Solidity Functions & Automated Transactions
24+
**All Checks On-chain?** If all the conditions necessary for your automation task can be directly verified on the blockchain, you have the option to select between Typescript Functions, Solidity Functions & Automated Transactions
2525

2626
## Triggers
2727

28-
1. Time Interval
29-
Use this trigger to execute tasks at regular intervals, e.g., every 10 minutes or once every 24 hours. It's like setting a straightforward, recurring alarm.
30-
2. Cron Expressions
31-
This offers a more refined control compared to the Time Interval. With cron expressions, you can set tasks to run at specific moments, such as "every Tuesday at 3 PM" or "on the 1st of every month". It gives you precision in task scheduling.
32-
3. On-Chain Event
33-
Ideal for those wanting their tasks to respond dynamically to blockchain activities. Whenever a specified event occurs on the blockchain, this trigger springs your task into action. It's like a vigilant watcher, always ready to act.
34-
4. Every Block
35-
This function operates with the rhythm of the blockchain itself, executing your chosen function each time a new block is created.
28+
1. Time Interval Use this trigger to execute tasks at regular intervals, e.g., every 10 minutes or once every 24 hours. It's like setting a straightforward, recurring alarm.
29+
2. Cron Expressions This offers a more refined control compared to the Time Interval. With cron expressions, you can set tasks to run at specific moments, such as "every Tuesday at 3 PM" or "on the 1st of every month". It gives you precision in task scheduling.
30+
3. On-Chain Event Ideal for those wanting their tasks to respond dynamically to blockchain activities. Whenever a specified event occurs on the blockchain, this trigger springs your task into action. It's like a vigilant watcher, always ready to act.
31+
4. Every Block This function operates with the rhythm of the blockchain itself, executing your chosen function each time a new block is created.
3632

3733
## What to Execute?
3834

39-
<!-- <Figure src={require('/docs/build/zkEVM/integrations/automation-off-chain/img/functions.png').default} width="100%" /> -->
40-
4135
### Typescript Functions
4236

4337
Typescript Functions are decentralized cloud functions that work similarly to AWS Lambda or Google Cloud, just for web3. They enable developers to execute on-chain transactions based on arbitrary off-chain data (APIs / subgraphs, etc) & computation. These functions are written in Typescript, stored on IPFS and run by Gelato.
4438

4539
### Solidity Functions
4640

47-
Solidity Functions are crucial for making on-chain tasks automatic and more efficient. They connect set conditions with specific actions in a smart contract, providing a straightforward method to turn user needs into automated processes.
48-
Consider them as a set of "if-then" rules: If certain conditions are met on the blockchain, then a specific function gets executed. This level of automation ensures that the decentralized application can operate with minimal manual intervention, providing a seamless user experience.
41+
Solidity Functions are crucial for making on-chain tasks automatic and more efficient. They connect set conditions with specific actions in a smart contract, providing a straightforward method to turn user needs into automated processes. Consider them as a set of "if-then" rules: If certain conditions are met on the blockchain, then a specific function gets executed. This level of automation ensures that the decentralized application can operate with minimal manual intervention, providing a seamless user experience.
4942

5043
### Automated Transaction
5144

@@ -125,7 +118,7 @@ For a detailed guide on creating and deploying Web3 Functions, including setting
125118

126119
#### **Further Resources**
127120

128-
- [Gelato Web3 Functions Docs](https://docs.gelato.network/web3-services/web3-functions)
129-
- [What is 1Balance?](https://docs.gelato.network/web3-services/1balance)
130-
- [Github Repository](https://github.com/gelatodigital/how-tos-3-w3f-triggers)
131-
- [YouTube - How to write Event driven Web3 Functions](https://www.youtube.com/watch?v=7UpqGsANsBQ&ab_channel=JavierDonoso)
121+
* [Gelato Web3 Functions Docs](https://docs.gelato.network/web3-services/web3-functions)
122+
* [What is 1Balance?](https://docs.gelato.network/web3-services/1balance)
123+
* [Github Repository](https://github.com/gelatodigital/how-tos-3-w3f-triggers)
124+
* [YouTube - How to write Event driven Web3 Functions](https://www.youtube.com/watch?v=7UpqGsANsBQ\&ab_channel=JavierDonoso)

smart-contracts/advanced/fevm-indexers.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
22
description: >-
3-
FEVM Indexers allow users and developers to query Filecoin chain data in an extremely quick manner. Learn what FEVM indexers are available on Filecoin and how to use them through existing data providers.
3+
FEVM Indexers allow users and developers to query Filecoin chain data in an
4+
extremely quick manner. Learn what FEVM indexers are available on Filecoin and
5+
how to use them through existing data provide
46
---
57

6-
# FEVM Blockchain Indexers
7-
> *Not to be confused with [IPNI Indexer](https://docs.filecoin.io/storage-providers/architecture/network-indexer)*
8+
# FEVM Indexers
9+
10+
> _Not to be confused with_ [_IPNI Indexer_](https://docs.filecoin.io/storage-providers/architecture/network-indexer)
811
912
Blockchain indexers are used for accessing blockchain data efficiently. They process and organize storage-optimized raw blockchain data into retrieve-optimized and well-queryable formats. This benefits developers and users looking to retrieve specific information because they don't need to:
1013

@@ -22,8 +25,8 @@ Additionally, blockchain indexers provide a better developer experience by lever
2225

2326
#### Glossary
2427

25-
- **Subgraphs**: Customizable schemas that define how to index data from specific blockchain smart contracts and events.
26-
- **GraphQL**: A query language that allows clients to request exactly the data they need, making data fetching more efficient.
28+
* **Subgraphs**: Customizable schemas that define how to index data from specific blockchain smart contracts and events.
29+
* **GraphQL**: A query language that allows clients to request exactly the data they need, making data fetching more efficient.
2730

2831
#### Querying Subgraphs on Filecoin FEVM
2932

@@ -42,40 +45,37 @@ Just as with database data queried through SQL, subgraphs have to be stored some
4245
[Protofire (aka Glif Nodes)](https://api.node.glif.io) offers public access to The Graph services, simplifying the process of deploying and managing subgraphs.
4346

4447
1. **Connect Your Wallet**
45-
- On the [Protofire (Glif Nodes) platform - SUBGRAPHS](https://api.node.glif.io/graph), connect your [Filecoin-compatible wallet](https://docs.filecoin.io/basics/assets/wallets).
46-
48+
* On the [Protofire (Glif Nodes) platform - SUBGRAPHS](https://api.node.glif.io/graph), connect your [Filecoin-compatible wallet](https://docs.filecoin.io/basics/assets/wallets).
4749
2. **Create an API Key**
48-
- Choose the **API keys** tab.
49-
- Click **Create new key**.
50-
- Generate an API key to authenticate your requests.
51-
50+
* Choose the **API keys** tab.
51+
* Click **Create new key**.
52+
* Generate an API key to authenticate your requests.
5253
3. **Activate Your Free Subscription**
53-
- Go to the **Subscription** tab.
54-
- If you have created a key, you will see one The Graph subscription pending.
55-
- Click **Pay** and proceed with providing your credit card details to activate a free subscription.
54+
* Go to the **Subscription** tab.
55+
* If you have created a key, you will see one The Graph subscription pending.
56+
* Click **Pay** and proceed with providing your credit card details to activate a free subscription.
5657

5758
{% hint style="warning" %}
5859
Glif Nodes currently offers this service completely **free of charge**. If this ever changes, you will be notified at least one month in advance. It is recommended to provide your contact details on the Glif Nodes website to receive updates. Credit card details are used solely for DDoS protection. No charges will be made without prior notification.
5960
{% endhint %}
6061

6162
4. **Create a Subgraph**
62-
- Switch back to the **Subgraphs** tab.
63-
- Click on **Create a New Subgraph** to set up a new subgraph instance.
64-
63+
* Switch back to the **Subgraphs** tab.
64+
* Click on **Create a New Subgraph** to set up a new subgraph instance.
6565
5. **Manage Your Subgraphs**
66-
- Select **MY** in the subgraphs switcher.
67-
- Select the subgraph you just created to access deployment instructions and endpoints.
68-
- Should you have any additional inquiries, do not hesitate to contact the Glif Nodes team through the **Contact us** button in the website header.
66+
* Select **MY** in the subgraphs switcher.
67+
* Select the subgraph you just created to access deployment instructions and endpoints.
68+
* Should you have any additional inquiries, do not hesitate to contact the Glif Nodes team through the **Contact us** button in the website header.
6969

7070
### Querying Existing Subgraphs
7171

7272
One of the popular subgraphs is a subgraph containing information about all the blocks on the network, essentially providing an alternative to the `eth_getBlock...` subset of commands. Let's see how we can query the `eth_getBlockByNumber` using the Linux command-line interface and the Protofire (Glif Nodes) platform.
7373

74-
- Visit the [Protofire (Glif Nodes) platform](https://api.node.glif.io).
75-
- Navigate to the **SUBGRAPHS** tab.
76-
- Select the **[blocks](https://api.node.glif.io/graph/21/mainnet%2Fblocks)** subgraph.
77-
- In the opened **Playground** tab, click the **Show GraphiQL Explorer** button (folder icon, 3rd from the top in the left bar) to verify the subgraph schema.
78-
- Click the elements that you are looking to query and adjust the query if necessary. For the sake of this example, let's query the first block this subgraph supports (#2867000). The resulting query should look like the following:
74+
* Visit the [Protofire (Glif Nodes) platform](https://api.node.glif.io).
75+
* Navigate to the **SUBGRAPHS** tab.
76+
* Select the [**blocks**](https://api.node.glif.io/graph/21/mainnet%2Fblocks) subgraph.
77+
* In the opened **Playground** tab, click the **Show GraphiQL Explorer** button (folder icon, 3rd from the top in the left bar) to verify the subgraph schema.
78+
* Click the elements that you are looking to query and adjust the query if necessary. For the sake of this example, let's query the first block this subgraph supports (#2867000). The resulting query should look like the following:
7979

8080
```graphql
8181
query MyQuery {
@@ -88,8 +88,7 @@ One of the popular subgraphs is a subgraph containing information about all the
8888
}
8989
}
9090
```
91-
92-
- Click **Execute query** (alternatively Ctrl+Enter, the icon with white triangle in the red square) and adjust query if needed.
91+
* Click **Execute query** (alternatively Ctrl+Enter, the icon with white triangle in the red square) and adjust query if needed.
9392

9493
```json
9594
{
@@ -106,6 +105,4 @@ One of the popular subgraphs is a subgraph containing information about all the
106105
}
107106
}
108107
```
109-
110-
- Copy **Queries (HTTP)** URL on the top of the Playground as well as resulting query to your code. The subgraph querying is free so far, although it requires an API key.
111-
108+
* Copy **Queries (HTTP)** URL on the top of the Playground as well as resulting query to your code. The subgraph querying is free so far, although it requires an API key.

0 commit comments

Comments
 (0)