From 1bc67054e0673735d459dbf174a209f2089aa723 Mon Sep 17 00:00:00 2001 From: johnnymatthews <9611008+johnnymatthews@users.noreply.github.com> Date: Wed, 6 Sep 2023 20:52:12 -0300 Subject: [PATCH 1/4] Fixes hardcoded links from pre-GB switch. --- basics/assets/metamask-setup.md | 2 +- basics/assets/transfer-fil.md | 5 +-- .../ways-to-contribute.md | 2 +- basics/the-blockchain/actors.md | 2 +- networks/calibration/explorers.md | 2 +- reference/built-in-actors/filecoin.sol.md | 32 +++++++++---------- reference/general/specifications.md | 2 -- .../filecoin-evm-runtime/filforwarder.md | 2 +- .../architecture/lotus-components.md | 14 ++++---- storage-providers/basics/quickstart-guide.md | 2 +- .../filecoin-deals/storage-deals.md | 2 +- 11 files changed, 31 insertions(+), 36 deletions(-) diff --git a/basics/assets/metamask-setup.md b/basics/assets/metamask-setup.md index 71aad2273..f689e57ab 100644 --- a/basics/assets/metamask-setup.md +++ b/basics/assets/metamask-setup.md @@ -85,7 +85,7 @@ The process for configuring MetaMask to use Filecoin is fairly simple but has so {% endtab %} {% endtabs %} -7. Pick one block explorer from the [Networks section](broken-reference/), and enter the URL into the **Block explorer (optional)** field. +7. Pick one block explorer from the [Networks section](../../networks/mainnet/README.md), and enter the URL into the **Block explorer (optional)** field. 8. Review the values in the fields and click **Save**. 9. The Filecoin network should now be shown in your MetaMask window. 10. Done! diff --git a/basics/assets/transfer-fil.md b/basics/assets/transfer-fil.md index 19a2dca62..158e00fc8 100644 --- a/basics/assets/transfer-fil.md +++ b/basics/assets/transfer-fil.md @@ -33,7 +33,7 @@ Apart from that, you just need to follow the standard process using your preferr ## 0x => f address -If you want to transfer FIL tokens from an Ethereum style `0x` address to another Filecoin address type, like an `f1` or `f3` address, follow the steps in [FilForwarder](https://docs.filecoin.io/smart-contracts/filecoin-evm-runtime/filforwader/) tutorial. +If you want to transfer FIL tokens from an Ethereum style `0x` address to another Filecoin address type, like an `f1` or `f3` address, follow the steps in [FilForwarder](../../smart-contracts/filecoin-evm-runtime/filforwarder.md) tutorial. ## f => 0x address @@ -100,9 +100,6 @@ If you want to transfer your FIL tokens from the `f1\f3` to the `0x` address, bu 6. From your main wallet account or exchange, transfer your FIL token to this address. 7. Connect to MetaMask and copy your `0x` address. 8. Once the funds appear in the burner wallet, click on **Send FIL**. - -![Send FIL](https://docs.filecoin.io/basics/assets/transfer-fil/sendFIL\_huba2822ca70a37641c4d623de30d9d397\_315407\_1000x0\_resize\_q75\_h2\_box\_3.webp) - 9. Enter the necessary information into the text fields: * In the **Recipient** field, enter your `0x` style address. GLIF automatically converts it to an `f4` address. diff --git a/basics/project-and-community/ways-to-contribute.md b/basics/project-and-community/ways-to-contribute.md index 31c178e8a..48fc0165b 100644 --- a/basics/project-and-community/ways-to-contribute.md +++ b/basics/project-and-community/ways-to-contribute.md @@ -208,7 +208,7 @@ How the Markdown syntax looks, and code formatting rules to follow. #### Syntax -The Filecoin Docs project follows the _GitHub Flavoured Markdown_ syntax for markdown. This way, all articles display properly within GitHub itself. This gives readers the option to view articles on [the docs website](http://localhost:5000/o/NNmD4UvLc26b1TmEYgzE/s/ljEfPn4P3ow2x1OCSoi4/) or [its GitHub repo](https://github.com/filecoin-project/filecoin-docs). +The Filecoin Docs project follows the _GitHub Flavoured Markdown_ syntax for markdown. This way, all articles display properly within GitHub itself. #### Rules diff --git a/basics/the-blockchain/actors.md b/basics/the-blockchain/actors.md index 57427440a..5205d9b1f 100644 --- a/basics/the-blockchain/actors.md +++ b/basics/the-blockchain/actors.md @@ -7,7 +7,7 @@ description: >- # Actors -For those familiar with the Ethereum virtual machine (EVM), _actors_ work similarly to [smart contracts](broken-reference). In the Filecoin network, there are two types of actors: +For those familiar with the Ethereum virtual machine (EVM), _actors_ work similarly to [smart contracts](../../smart-contracts/fundamentals/README.md). In the Filecoin network, there are two types of actors: * [_Built-in actors_](actors.md#built-in-actors): Hardcoded programs written ahead of time by network engineers that manage and orchestrate key subprocesses and subsystems in the Filecoin network. * [_User actors_](actors.md#user-actors-smart-contracts): Code implemented by **any developer** that interacts with the Filecoin Virtual Machine (FVM). diff --git a/networks/calibration/explorers.md b/networks/calibration/explorers.md index 96e82751c..0d2a6df99 100644 --- a/networks/calibration/explorers.md +++ b/networks/calibration/explorers.md @@ -12,7 +12,7 @@ description: >- ## Filfox -[calibration.filfox.info](https://calibration/filfox.info) +[calibration.filfox.info](https://calibration.filfox.info) ## Filscan diff --git a/reference/built-in-actors/filecoin.sol.md b/reference/built-in-actors/filecoin.sol.md index 6d616e42d..25a9b4e1d 100644 --- a/reference/built-in-actors/filecoin.sol.md +++ b/reference/built-in-actors/filecoin.sol.md @@ -4,30 +4,30 @@ description: This page covers the built-in actors Filecoin.sol API. # Filecoin.sol -For conceptual information on built-in actors, including their purposes, how they work and more, see the [conceptual guide](https://docs.filecoin.io/reference/built-in-actors/overview/). +For conceptual information on built-in actors, including their purposes, how they work and more, see the [conceptual guide](../../reference/built-in-actors/overview/). ## Prerequisites -Before you can call a built-in actor using the API, you must [import filecoin.solidity using one of the available methods](https://docs.filecoin.io/smart-contracts/developing-contracts/call-built-in-actors/#using-filecoinsolidity). +Before you can call a built-in actor using the API, you must [import filecoin.solidity using one of the available methods](../../smart-contracts/developing-contracts/call-built-in-actors/#using-filecoinsolidity). ## Call a built-in actor -For available actors and methods see [Available actors and methods](https://docs.filecoin.io/smart-contracts/developing-contracts/call-built-in-actors/#available-actors-and-methods). +For available actors and methods see [Available actors and methods](../../smart-contracts/developing-contracts/call-built-in-actors/#available-actors-and-methods). Once you’ve either imported particular contracts manually or simply installed `filecoin-solidity` using `npm`, create a callable method to access the built-in actor methods the way you normally would in a Solidity smart contract. Working examples of smart contracts that call built-in actor methods are available below. -* [Account](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-account-actor) -* [DataCap](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-datacap-actor) -* [Miner](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-miner-actor) -* [Storage market](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-storage-market-actor) -* [Storage power](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-storage-power-actor) -* [Verified registry](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-verified-registry-actor) +* [Account](../../reference/built-in-actors/filecoin-sol#call-the-account-actor) +* [DataCap](../../reference/built-in-actors/filecoin-sol#call-the-datacap-actor) +* [Miner](../../reference/built-in-actors/filecoin-sol#call-the-miner-actor) +* [Storage market](../../reference/built-in-actors/filecoin-sol#call-the-storage-market-actor) +* [Storage power](../../reference/built-in-actors/filecoin-sol#call-the-storage-power-actor) +* [Verified registry](../../reference/built-in-actors/filecoin-sol#call-the-verified-registry-actor) -For conceptual information on built-in actors, including their purposes, how they work and available types, see the [conceptual guide](https://docs.filecoin.io/reference/built-in-actors/overview/). +For conceptual information on built-in actors, including their purposes, how they work and available types, see the [conceptual guide](../../reference/built-in-actors/overview/). ### Call the account actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). ```solidity pragma solidity ^0.8.17; @@ -50,7 +50,7 @@ contract AccountApiTest { ### Call the DataCap actor -The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). +The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). ```solidity pragma solidity ^0.8.17; @@ -118,7 +118,7 @@ contract DataCapApiTest { ### Call the storage market actor -The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -187,7 +187,7 @@ contract MarketApiTest { ### Call the miner actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -264,7 +264,7 @@ contract MinerApiTest { ### Call the storage power actor -The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). +The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). ```solidity pragma solidity ^0.8.17; @@ -298,7 +298,7 @@ contract PowerApiTest { ### Call the verified registry actor -The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](https://docs.filecoin.io/reference/built-in-actors/filecoin-sol/#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). +The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). ```solidity pragma solidity ^0.8.17; diff --git a/reference/general/specifications.md b/reference/general/specifications.md index 8e9e1df1a..6c2662705 100644 --- a/reference/general/specifications.md +++ b/reference/general/specifications.md @@ -10,6 +10,4 @@ The Filecoin specification is the technical document that outlines the details o The Filecoin specification is a _living_ document, with frequent updates and changes as the Filecoin network grows. The specification is available to view at [specs.filecoin.io](https://spec.filecoin.io/). -

specs.filecoin.io

- You can suggest changes to the specification [over on GitHub](https://github.com/filecoin-project/specs). diff --git a/smart-contracts/filecoin-evm-runtime/filforwarder.md b/smart-contracts/filecoin-evm-runtime/filforwarder.md index 3dfd6979c..f178782cf 100644 --- a/smart-contracts/filecoin-evm-runtime/filforwarder.md +++ b/smart-contracts/filecoin-evm-runtime/filforwarder.md @@ -108,7 +108,7 @@ Always be careful when dealing with your private key. Double-check that you’re #### **Invoke the contract** -The contract is deterministically deployed on all Filecoin networks at `0x2b3ef6906429b580b7b2080de5ca893bc282c225`. Any contract claiming to be a FilForwarder that does not reside at this address should not be trusted. Any dApp can connect to the wallet and use the ABI in this repository to call this method using any frontend. See the [Glif section](https://docs.filecoin.io/smart-contracts/filecoin-evm-runtime/filforwader/#glifio) above for steps on using a GUI. +The contract is deterministically deployed on all Filecoin networks at `0x2b3ef6906429b580b7b2080de5ca893bc282c225`. Any contract claiming to be a FilForwarder that does not reside at this address should not be trusted. Any dApp can connect to the wallet and use the ABI in this repository to call this method using any frontend. See the [Glif section](../../smart-contracts/filecoin-evm-runtime/filforwarder.md) above for steps on using a GUI. Inside this repository is a Hardhat task called `forward`. This task will use the private key to send funds using the contract. This task uses the `fil-forwarder-{CHAIN_ID}.json` file to determine the deployed contract address for a given network. These addresses should always be the same, but these files prevent you from having to specify it each time. diff --git a/storage-providers/architecture/lotus-components.md b/storage-providers/architecture/lotus-components.md index 64247f4ac..fb179806e 100644 --- a/storage-providers/architecture/lotus-components.md +++ b/storage-providers/architecture/lotus-components.md @@ -13,10 +13,10 @@ The diagram below shows the major components of Lotus: The following components are the most important to understand: -* [Lotus daemon](broken-reference) -* [Lotus miner](broken-reference) -* [Lotus worker](broken-reference) -* [Boost](broken-reference) +* Lotus daemon +* Lotus miner +* Lotus worker +* Boost [Click here](https://boost.filecoin.io/getting-started) for a compatibility matrix of the different components and the required Golang version. @@ -41,9 +41,9 @@ Another important consideration is the size of the file system and available fre #### Holding wallets -Another key role of the Lotus daemon is to host the Filecoin wallets that are required to run a storage provider (SP). As an SP, you will need a minimum of 2 wallets: an _owner wallet_ and a _worker wallet_. A third wallet called the [_control_ wallet](broken-reference) is required to scale your operations in a production environment. +Another key role of the Lotus daemon is to host the Filecoin wallets that are required to run a storage provider (SP). As an SP, you will need a minimum of 2 wallets: an _owner wallet_ and a _worker wallet_. A third wallet called the _control_ wallet) is required to scale your operations in a production environment. -To keep wallets safe, providers should consider physical access, network access, software security, and secure backups. As with any cryptocurrency wallet, access to the private key means access to your funds. Lotus supports [Ledger hardware wallets](https://lotus.filecoin.io/lotus/manage/ledger/), the use of which is recommended, or remote wallets with `lotus-wallet` on a remote machine (see [remote lotus wallet](https://lotus.filecoin.io/tutorials/lotus/remote-lotus-wallet/) for instructions). The worker and control wallets can not be kept on a hardware device because Lotus requires frequent access to those types of wallets. For instance, Lotus may require access to a worker or control wallet to send [WindowPoSt](broken-reference) proofs on-chain. +To keep wallets safe, providers should consider physical access, network access, software security, and secure backups. As with any cryptocurrency wallet, access to the private key means access to your funds. Lotus supports [Ledger hardware wallets](https://lotus.filecoin.io/lotus/manage/ledger/), the use of which is recommended, or remote wallets with `lotus-wallet` on a remote machine (see [remote lotus wallet](https://lotus.filecoin.io/tutorials/lotus/remote-lotus-wallet/) for instructions). The worker and control wallets can not be kept on a hardware device because Lotus requires frequent access to those types of wallets. For instance, Lotus may require access to a worker or control wallet to send WindowPoSt proofs on-chain. **Control wallets** @@ -94,7 +94,7 @@ Another key responsibility of the Lotus Miner is the scheduling of jobs for the One of the most important roles of `lotus-miner` is the Storage proving. Both [WindowPoSt](https://docs.filecoin.io/reference/general/glossary/#window-proof-of-spacetime-windowpost) and [WinningPoSt](https://docs.filecoin.io/reference/general/glossary/#winning-proof-of-spacetime-winningpost) processes are usually handled by the `lotus-miner` process. For scalability and reliability purposes it is now also possible to run these proving processes on dedicated servers (proving workers) instead of using the Lotus miner. -The proving processes require low-latency access to sealed sectors. The proving challenge requires a GPU to run on. The resulting `zkProof` will be sent to the chain in a message. Messages must arrive within 30 minutes for WindowPoSt, and 30 seconds for WinningPoSt. It is extremely important that providers properly size and configure the proving workers, whether they are using just the Lotus miner or separate workers. Additionally, dedicated wallets, described in [Control wallets](broken-reference), should be set up for these processes. +The proving processes require low-latency access to sealed sectors. The proving challenge requires a GPU to run on. The resulting `zkProof` will be sent to the chain in a message. Messages must arrive within 30 minutes for WindowPoSt, and 30 seconds for WinningPoSt. It is extremely important that providers properly size and configure the proving workers, whether they are using just the Lotus miner or separate workers. Additionally, dedicated wallets, described in Control wallets, should be set up for these processes. Always check if there are upcoming proving deadlines before halting any services for maintenance. For detailed instructions, refer to the [Lotus maintenance guide](https://lotus.filecoin.io/storage-providers/operate/maintenance/). diff --git a/storage-providers/basics/quickstart-guide.md b/storage-providers/basics/quickstart-guide.md index ace262dd6..6c8a4d896 100644 --- a/storage-providers/basics/quickstart-guide.md +++ b/storage-providers/basics/quickstart-guide.md @@ -8,7 +8,7 @@ description: >- ## Explore the storage provider documentation -Get ready to dive into the valuable resources of the [storage provider documentation](broken-reference/). This comprehensive guide offers a wealth of information about the role of storage providers in the Filecoin ecosystem, including insights into the economic aspects. You’ll also gain knowledge about the software architecture, hardware infrastructure, and the necessary skills for success. +Get ready to dive into the valuable resources of the storage provider documentation](../../storage-providers/basics/README.md). This comprehensive guide offers a wealth of information about the role of storage providers in the Filecoin ecosystem, including insights into the economic aspects. You’ll also gain knowledge about the software architecture, hardware infrastructure, and the necessary skills for success. ## Gain insights into ROI and collateral’s role diff --git a/storage-providers/filecoin-deals/storage-deals.md b/storage-providers/filecoin-deals/storage-deals.md index f52b4829e..7ac1d3767 100644 --- a/storage-providers/filecoin-deals/storage-deals.md +++ b/storage-providers/filecoin-deals/storage-deals.md @@ -15,7 +15,7 @@ Data preparation, which includes packaging files into size appropriate CAR files Data preparation can be done in various ways, depending on your use-case. Here are some valuable sources of information: * The [data-prep-tools repo](https://github.com/filecoin-project/data-prep-tools) has a set of CLI tools for more specific use-cases. -* [Singularity](https://github.com/tech-greedy/singularity) is a command-line tool to put data into CAR files, create [CIDs](../../reference/general/glossary/#content-identifier-cid), and even initiate deals with storage providers. +* [Singularity](https://github.com/tech-greedy/singularity) is a command-line tool to put data into CAR files, create [CIDs](../../reference/general/glossary#content-identifier-cid), and even initiate deals with storage providers. See the following video for a demonstration on Singularity: From e5ce8b15e52b54def2715e3f8e5819bd8426dab5 Mon Sep 17 00:00:00 2001 From: johnnymatthews <9611008+johnnymatthews@users.noreply.github.com> Date: Wed, 6 Sep 2023 20:59:02 -0300 Subject: [PATCH 2/4] Fixes some more links that I missed. --- README.md | 2 +- basics/project-and-community/social-media.md | 4 ++-- reference/built-in-actors/filecoin.sol.md | 20 +++++++++---------- .../filecoin-deals/storage-deals.md | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9dd62ac2d..4ae3531bb 100644 --- a/README.md +++ b/README.md @@ -35,4 +35,4 @@ This site [docs.filecoin.io](https://docs.filecoin.io) will continue to be updat ## Choose your own adventure -

💡 Learn the basics

Want to understand the fundamental concepts of Filecoin, but aren't sure where to start? The Basics section is the perfect place to begin your journey!what-is-filecoin

🔧 Build with Filecoin

Eager to build on top of the Filecoin network but aren't sure how to begin? Head over to the Developers section to find examples and guides to help build your project!the-fvm.md

🏗 Become a provider

Starting up a provider node on the Filecoin network can be a daunting task. Head over to the Provider section to find out everything you need to know.Broken link

📊 Store data

Want to store large amount of data on the Filecoin network? There are plenty of storage options that you can choose from! Check out the Store section for more information!storage-model.md
+

💡 Learn the basics

Want to understand the fundamental concepts of Filecoin, but aren't sure where to start? The Basics section is the perfect place to begin your journey!what-is-filecoin

🔧 Build with Filecoin

Eager to build on top of the Filecoin network but aren't sure how to begin? Head over to the Developers section to find examples and guides to help build your project!the-fvm.md

🏗 Become a provider

Starting up a provider node on the Filecoin network can be a daunting task. Head over to the Provider section to find out everything you need to know.Broken link

📊 Store data

Want to store large amount of data on the Filecoin network? There are plenty of storage options that you can choose from! Check out the Store section for more information!storage-model.md
diff --git a/basics/project-and-community/social-media.md b/basics/project-and-community/social-media.md index 90355343e..52dea894a 100644 --- a/basics/project-and-community/social-media.md +++ b/basics/project-and-community/social-media.md @@ -22,8 +22,8 @@ Subscribe to the [Filecoin newsletter](https://filecoin.io/build/#events) for of Get your Filecoin news in tweet-sized bites. Follow these accounts for the latest: -* [`@Filecoin`](https://twitter.com/filecoin) for news and other updates from the Filecoin project -* [`@ProtoSchool`](https://twitter.com/protoschool) for updates on ProtoSchool workshops and tutorials +* `@Filecoin` for news and other updates from the Filecoin project +* `@ProtoSchool` for updates on ProtoSchool workshops and tutorials ### WeChat diff --git a/reference/built-in-actors/filecoin.sol.md b/reference/built-in-actors/filecoin.sol.md index 25a9b4e1d..57e086b18 100644 --- a/reference/built-in-actors/filecoin.sol.md +++ b/reference/built-in-actors/filecoin.sol.md @@ -4,15 +4,15 @@ description: This page covers the built-in actors Filecoin.sol API. # Filecoin.sol -For conceptual information on built-in actors, including their purposes, how they work and more, see the [conceptual guide](../../reference/built-in-actors/overview/). +For conceptual information on built-in actors, including their purposes, how they work and more, see the [conceptual guide](../../reference/built-in-actors/README.md). ## Prerequisites -Before you can call a built-in actor using the API, you must [import filecoin.solidity using one of the available methods](../../smart-contracts/developing-contracts/call-built-in-actors/#using-filecoinsolidity). +Before you can call a built-in actor using the API, you must [import filecoin.solidity using one of the available methods](../../smart-contracts/developing-contracts#call-built-in-actors/#using-filecoinsolidity). ## Call a built-in actor -For available actors and methods see [Available actors and methods](../../smart-contracts/developing-contracts/call-built-in-actors/#available-actors-and-methods). +For available actors and methods see [Available actors and methods](../../smart-contracts/developing-contracts#call-built-in-actors/#available-actors-and-methods). Once you’ve either imported particular contracts manually or simply installed `filecoin-solidity` using `npm`, create a callable method to access the built-in actor methods the way you normally would in a Solidity smart contract. Working examples of smart contracts that call built-in actor methods are available below. @@ -23,11 +23,11 @@ Once you’ve either imported particular contracts manually or simply installed * [Storage power](../../reference/built-in-actors/filecoin-sol#call-the-storage-power-actor) * [Verified registry](../../reference/built-in-actors/filecoin-sol#call-the-verified-registry-actor) -For conceptual information on built-in actors, including their purposes, how they work and available types, see the [conceptual guide](../../reference/built-in-actors/overview/). +For conceptual information on built-in actors, including their purposes, how they work and available types, see the [conceptual guide](../../reference/built-in-actors/README.md/). ### Call the account actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). ```solidity pragma solidity ^0.8.17; @@ -50,7 +50,7 @@ contract AccountApiTest { ### Call the DataCap actor -The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). +The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). ```solidity pragma solidity ^0.8.17; @@ -118,7 +118,7 @@ contract DataCapApiTest { ### Call the storage market actor -The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -187,7 +187,7 @@ contract MarketApiTest { ### Call the miner actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -264,7 +264,7 @@ contract MinerApiTest { ### Call the storage power actor -The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). +The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). ```solidity pragma solidity ^0.8.17; @@ -298,7 +298,7 @@ contract PowerApiTest { ### Call the verified registry actor -The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol/#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). +The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). ```solidity pragma solidity ^0.8.17; diff --git a/storage-providers/filecoin-deals/storage-deals.md b/storage-providers/filecoin-deals/storage-deals.md index 7ac1d3767..bf45c2afa 100644 --- a/storage-providers/filecoin-deals/storage-deals.md +++ b/storage-providers/filecoin-deals/storage-deals.md @@ -15,7 +15,7 @@ Data preparation, which includes packaging files into size appropriate CAR files Data preparation can be done in various ways, depending on your use-case. Here are some valuable sources of information: * The [data-prep-tools repo](https://github.com/filecoin-project/data-prep-tools) has a set of CLI tools for more specific use-cases. -* [Singularity](https://github.com/tech-greedy/singularity) is a command-line tool to put data into CAR files, create [CIDs](../../reference/general/glossary#content-identifier-cid), and even initiate deals with storage providers. +* [Singularity](https://github.com/tech-greedy/singularity) is a command-line tool to put data into CAR files, create [CIDs](../../reference/general/glossary.md), and even initiate deals with storage providers. See the following video for a demonstration on Singularity: From 8565502c739c59fc9a9547aabf95ebfb227596ca Mon Sep 17 00:00:00 2001 From: johnnymatthews <9611008+johnnymatthews@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:01:40 -0300 Subject: [PATCH 3/4] Fixes filecoin-sol.md links. --- reference/built-in-actors/filecoin.sol.md | 24 +++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/reference/built-in-actors/filecoin.sol.md b/reference/built-in-actors/filecoin.sol.md index 57e086b18..fe05ac2bb 100644 --- a/reference/built-in-actors/filecoin.sol.md +++ b/reference/built-in-actors/filecoin.sol.md @@ -16,18 +16,18 @@ For available actors and methods see [Available actors and methods](../../smart- Once you’ve either imported particular contracts manually or simply installed `filecoin-solidity` using `npm`, create a callable method to access the built-in actor methods the way you normally would in a Solidity smart contract. Working examples of smart contracts that call built-in actor methods are available below. -* [Account](../../reference/built-in-actors/filecoin-sol#call-the-account-actor) -* [DataCap](../../reference/built-in-actors/filecoin-sol#call-the-datacap-actor) -* [Miner](../../reference/built-in-actors/filecoin-sol#call-the-miner-actor) -* [Storage market](../../reference/built-in-actors/filecoin-sol#call-the-storage-market-actor) -* [Storage power](../../reference/built-in-actors/filecoin-sol#call-the-storage-power-actor) -* [Verified registry](../../reference/built-in-actors/filecoin-sol#call-the-verified-registry-actor) +* [Account](../../reference/built-in-actors/filecoin-sol.md#call-the-account-actor) +* [DataCap](../../reference/built-in-actors/filecoin-sol.md#call-the-datacap-actor) +* [Miner](../../reference/built-in-actors/filecoin-sol.md#call-the-miner-actor) +* [Storage market](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-market-actor) +* [Storage power](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-power-actor) +* [Verified registry](../../reference/built-in-actors/filecoin-sol.md#call-the-verified-registry-actor) For conceptual information on built-in actors, including their purposes, how they work and available types, see the [conceptual guide](../../reference/built-in-actors/README.md/). ### Call the account actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). ```solidity pragma solidity ^0.8.17; @@ -50,7 +50,7 @@ contract AccountApiTest { ### Call the DataCap actor -The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). +The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). ```solidity pragma solidity ^0.8.17; @@ -118,7 +118,7 @@ contract DataCapApiTest { ### Call the storage market actor -The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -187,7 +187,7 @@ contract MarketApiTest { ### Call the miner actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -264,7 +264,7 @@ contract MinerApiTest { ### Call the storage power actor -The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). +The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). ```solidity pragma solidity ^0.8.17; @@ -298,7 +298,7 @@ contract PowerApiTest { ### Call the verified registry actor -The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). +The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). ```solidity pragma solidity ^0.8.17; From 25a5b89388a672bd2f3e3e53118d9436dcd4d560 Mon Sep 17 00:00:00 2001 From: johnnymatthews <9611008+johnnymatthews@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:03:38 -0300 Subject: [PATCH 4/4] Fixes filecoin-sol.md links. --- reference/built-in-actors/filecoin.sol.md | 24 +++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/reference/built-in-actors/filecoin.sol.md b/reference/built-in-actors/filecoin.sol.md index fe05ac2bb..4005636a5 100644 --- a/reference/built-in-actors/filecoin.sol.md +++ b/reference/built-in-actors/filecoin.sol.md @@ -16,18 +16,18 @@ For available actors and methods see [Available actors and methods](../../smart- Once you’ve either imported particular contracts manually or simply installed `filecoin-solidity` using `npm`, create a callable method to access the built-in actor methods the way you normally would in a Solidity smart contract. Working examples of smart contracts that call built-in actor methods are available below. -* [Account](../../reference/built-in-actors/filecoin-sol.md#call-the-account-actor) -* [DataCap](../../reference/built-in-actors/filecoin-sol.md#call-the-datacap-actor) -* [Miner](../../reference/built-in-actors/filecoin-sol.md#call-the-miner-actor) -* [Storage market](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-market-actor) -* [Storage power](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-power-actor) -* [Verified registry](../../reference/built-in-actors/filecoin-sol.md#call-the-verified-registry-actor) +* [Account](../../reference/built-in-actors/filecoin.sol.md#call-the-account-actor) +* [DataCap](../../reference/built-in-actors/filecoin.sol.md#call-the-datacap-actor) +* [Miner](../../reference/built-in-actors/filecoin.sol.md#call-the-miner-actor) +* [Storage market](../../reference/built-in-actors/filecoin.sol.md#call-the-storage-market-actor) +* [Storage power](../../reference/built-in-actors/filecoin.sol.md#call-the-storage-power-actor) +* [Verified registry](../../reference/built-in-actors/filecoin.sol.md#call-the-verified-registry-actor) For conceptual information on built-in actors, including their purposes, how they work and available types, see the [conceptual guide](../../reference/built-in-actors/README.md/). ### Call the account actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin.sol.md#call-the-account-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/account.test.sol). ```solidity pragma solidity ^0.8.17; @@ -50,7 +50,7 @@ contract AccountApiTest { ### Call the DataCap actor -The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). +The following example imports the DataCap actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin.sol.md#call-the-datacap-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/datacap.test.sol). ```solidity pragma solidity ^0.8.17; @@ -118,7 +118,7 @@ contract DataCapApiTest { ### Call the storage market actor -The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Storage market actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin.sol.md#call-the-storage-market-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -187,7 +187,7 @@ contract MarketApiTest { ### Call the miner actor -The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). +The following example imports the Account actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin.sol.md#call-the-miner-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/miner.test.sol). ```solidity pragma solidity ^0.8.17; @@ -264,7 +264,7 @@ contract MinerApiTest { ### Call the storage power actor -The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). +The following example imports the Storage power actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin.sol.md#call-the-storage-power-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/power.test.sol). ```solidity pragma solidity ^0.8.17; @@ -298,7 +298,7 @@ contract PowerApiTest { ### Call the verified registry actor -The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin-sol.md#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). +The following example imports the verified registry actor library and creates a callable method for each of the [available actor methods](../../reference/built-in-actors/filecoin.sol.md#call-the-verified-registry-actor). For the full code, see [the GitHub repository](https://github.com/filecoin-project/filecoin-solidity/blob/master/contracts/v0.8/tests/verifreg.test.sol). ```solidity pragma solidity ^0.8.17;