GITBOOK-162: ravish's Jan 25 changes

Author: nandit123

SUMMARY.md

@@ -41,8 +41,8 @@
 
 ## 💾 Filecoin Virtual Machine
 
-* [⬆ Upload, PoDSI, and Deal-Making](filecoin-virtual-machine/section-a.md)
-* [👷♂ Attaching RaaS (renew, repair, replication) Worker](filecoin-virtual-machine/section-b.md)
+* [⬆ Upload, PoDSI, and Deal-Making via SDK](filecoin-virtual-machine/section-a.md)
+* [👷♂ RaaS (renew, repair, replication) Smart Contracts](filecoin-virtual-machine/section-b.md)
 * [📖 PoDSI](filecoin-virtual-machine/podsi.md)
 * [✅ Deal Verification](filecoin-virtual-machine/deal-verification.md)
 * [👮♀ Self Hosted RaaS](filecoin-virtual-machine/self-hosted-raas.md)

filecoin-virtual-machine/deal-verification.md

@@ -8,15 +8,33 @@ Deals and file inclusion can be verified using the following steps.
 the successful return of calling `complete` (i.e. the call doesn’t revert) means that the deal’s proof is verified successfully by the smart contract and the mapping of the deals between cid and (miner\_id, deal\_id) are updated in the smart contract 
 {% endhint %}
 
-* You can call the **complete function** located here: `0x6ec8722e6543fB5976a547434c8644b51e24785b` to verify the successful inclusion of your in the live filecoin deal. Code for this smart contract can be found [here](https://github.com/lighthouse-web3/raas-starter-kit/blob/main/contracts/DealStatus.sol)
-* Submit your proof details, specifically: proofSubtree, proofIndex, and verifierData. <mark style="background-color:yellow;">\[Todo: add code here calling dealstatus.complete () contract function here and show actual response commP and that its not reverting in response]</mark>
-* What you'll get in return are two things: "commPa" and "sizePa". Think of these as your file's unique fingerprints.
-* These fingerprints (pieceCID and pieceSize) might look like regular text. You'll need to change them into a code-like format, known as hex, before you compare.
+* You can call the **complete function** located here: \
+  `0x4015c3E5453d38Df71539C0F7440603C69784d7a` to verify the successful inclusion of your in the live filecoin deal. Code for this smart contract can be found [here](https://github.com/lighthouse-web3/raas-starter-kit/blob/main/contracts/DealStatus.sol)
 
 {% hint style="info" %}
-Use the Bearer Authorization token (signed message) for authenticating API requests. Always renew the signed message if it expires or is invalidated.
+Lighthouse currently calls this complete function in calibration testnet for all the files submitted through `submitRaaS` function of our deployed contract.
 {% endhint %}
 
+* Submit your proof details, specifically: proofSubtree, proofIndex, and verifierData.&#x20;
+
+```javascript
+//sample pseudocode for testnet
+let response = await axios.get("https://api.lighthouse.storage/api/lighthouse/get_proof", {
+    params: {
+        cid: lighthouse_cid,
+        network: "testnet" // Change the network to mainnet when ready
+    }
+})
+const responseBody = response.body.data.dealInfo;
+// contractInstance is the address of the contract you deployed or the aggregator-hosted RaaS address above.
+const dealStatus = await ethers.getContractAt("DealStatus", contractInstance);
+//Call complete function for the file you want to upload to the Filecoin network in the following way.
+await dealStatus.complete(transactionId, responseBody.dealId, "t017840", responseBody.proof.inclusionProof, responseBody.proof.verifierData);
+```
+
+* Complete function would emit event with two things: "commPa" and "sizePa". Think of these as your file's unique fingerprints.
+* These fingerprints (pieceCID and pieceSize) might look like regular text. You'll need to change them into a code-like format, known as hex, before you compare.
+
 #### Step 2: Double-Check Your File's Data:
 
 * This verifier data is like a mixed salad of your file combined with others. The first step confirmed that the salad has the right ingredients.
@@ -25,4 +43,4 @@ Use the Bearer Authorization token (signed message) for authenticating API reque
 #### Step 3: Check Live Deal on Explorer:
 
 * You're almost done! You've just ensured your file is part of a bigger bundle handed to a miner.
-* Need more peace of mind? Head on over to [FilFox](https://calibration.filfox.info/en/deal/133652). Here, make sure the package's unique tag (the piece cid) aligns with what you've been provided earlier.
+* Need more peace of mind? Head on over to [FilFox](https://calibration.filfox.info/en/deal/133652). Here, make sure the `dealId` you received is live 🚀

filecoin-virtual-machine/section-a.md

@@ -1,19 +1,14 @@
-# ⬆ Upload, PoDSI, and Deal-Making
+# ⬆ Upload, PoDSI, and Deal-Making via SDK
 
-In this **Section A**, we will discuss the following
+In this **Section A**, we will discuss the following steps
 
-1. [Upload via Lighthouse SDK](section-a.md#1-upload-via-lighthouse-sdk)
-   1. [Upload your first file](section-a.md#step-1-upload-your-first-file-using-lighthouse-sdk) 
-   2. [Set deal parameters](section-a.md#step-2-set-deal-parameters)
-   3. [Understanding PoDSI: Getting the PoDSI for your file](section-a.md#step-3-understanding-podsi-getting-the-podsi-for-your-file)
-   4. [Get your deal ID from your upload](section-a.md#step-4-get-your-deal-id-from-your-upload)
-   5. [Download your file using the file’s CID](section-a.md#step-5-download-your-file-using-the-files-cid)
-2. [Upload via Lighthouse Smart Contract Interaction](section-a.md#2-upload-via-lighthouse-smart-contract)
-   1. [Attach Raas Workers (discussed in Section B)](section-b.md)
+1. [Upload your first file](section-a.md#step-1-upload-your-first-file-using-lighthouse-sdk) 
+2. [Set deal parameters](section-a.md#step-2-set-deal-parameters)
+3. [Understanding PoDSI: Getting the PoDSI for your file](section-a.md#step-3-understanding-podsi-getting-the-podsi-for-your-file)
+4. [Get your deal ID from your upload](section-a.md#step-4-get-your-deal-id-from-your-upload)
+5. [Download your file using the file’s CID](section-a.md#step-5-download-your-file-using-the-files-cid)
 
-<figure><picture><source srcset="../.gitbook/assets/Group 1707478179.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/CID deal.png" alt=""></picture><figcaption></figcaption></figure>
 
-## <mark style="color:blue;">1) Upload via Lighthouse SDK</mark>
 
 ### Step 1: Upload your first file using Lighthouse SDK
 
@@ -172,70 +167,87 @@ The response, an example of a PoDSI proof on Calibration, should look something
 {% code title="PoDSI response" lineNumbers="true" %}
 ```json
 {
-    "pieceCID": "baga6ea4seaqgbiszkxkzmaxio5zjucpg2sd4n6abvmcsenah27g4xtjszxtzmia",
-    "pieceSize": 4194304,
-    "carFileSize": 4161536,
-    "proof": {
-        "pieceCID": "baga6ea4seaqn6s6n3irnz2ewfwlybhpjzrg6i57fzuwletj5sxcv7hz5rauewli",
-        "id": "19845d2a-4fae-426c-893d-491770c317e8",
-        "lastUpdate": 1692888301,
-        "fileProof": {
-            "verifierData": {
-                "commPc": "0181e203922020df4bcdda22dce8962d97809de9cc4de477e5cd2cb24d3d95c55f9f3d88284b2d",
-                "sizePc": "200000"
+    pieceCID:
+      'baga6ea4seaqn6s6n3irnz2ewfwlybhpjzrg6i57fzuwletj5sxcv7hz5rauewli',
+    dealInfo: [
+      {
+        dealId: 53078591,
+        storageProvider: 'f02620',
+        proof: {
+          inclusionProof: {
+            proofIndex: {
+              index: '1ffc08fd',
+              path: [
+                '624c730d13648b9d386948925afbad6980b3a08dd9db7d8d156ffd0d15f1f724',
+                '6f980e8fd5af43732faf137ff24808dc42f15ec07b5671f9c85c899550d7790a',
+                'a2f5e3c55a9ff784cc5f39b63846914caf3f0556a65ef6df5847c69df7f30200',
+                'a46614cbaee2e1c7ed71e43d3f6d8e9ed0ff4e42422f4347fc1ffd0700e24017',
+                'e919844c2aafbfe63ef9dae0990980c66d3f2548b6b3781445055b9221142901',
+                'ecbe60a5baf21f07d8f9ae98805149c6e595d7413fc591a86b06e00a0317fc22',
+                '7455143f0a3424fab9bc576ace3b6fa95bba4ea59e270fc0a1ed06381ddc9e0b',
+                '356e98673a0f1457e405ebe8bb4564cd6b537fde6e22d75d4b986abf2807be05',
+                'd29ee6aca59e9b005e74defa05e3edb54e8ecd448b2834635edb3252b516d122',
+                '77871a87f00a1d260af0050586833a209ce84fce0f783486a2a64a838abebd03',
+                '6eb665702e7b642b5cc4447b6ad5ca7eedb1de773862ca126ad7cc1a81a7fc16',
+                'aba5c7451052da6de12715f3f7943a0c65171cd405f296cfdc689f0ae0da950f',
+                '98d4f4a746d58a5b14be5ec1ed24f99fe25a7caa55769e6abe88f12bdbb79116',
+                '0c90015fc0e88c578510b0be936618deda2cf6e06f41b4f8d386defc6bf39f16',
+                'd99887b973573a96e11393645236c17b1f4c7034d723c7a99f709bb4da61162b',
+                'd0b530dbb0b4f25c5d2f2a28dfee808b53412a02931f18c499f5a254086b1326',
+                '84c0421ba0685a01bf795a2344064fe424bd52a9d24377b394ff4c4b4568e811',
+                '65f29e5d98d246c38b388cfc06db1f6b021303c5a289000bdce832a9c3ec421c',
+                'a2247508285850965b7e334b3127b0c042b1d046dc54402137627cd8799ce13a',
+                'dafdab6da9364453c26d33726b9fefe343be8f81649ec009aad3faff50617508',
+                'd941d5e0d6314a995c33ffbd4fbe69118d73d4e5fd2cd31f0f7c86ebdd14e706',
+                '514c435c3d04d349a5365fbd59ffc713629111785991c1a3c53af22079741a2f',
+                'ad06853969d37d34ff08e09f56930a4ad19a89def60cbfee7e1d3381c1e71c37',
+                '39560e7b13a93b07a243fd2720ffa7cb3e1d2e505ab3629e79f46313512cda06',
+                'ccc3c012f5b05e811a2bbfdd0f6833b84275b47bf229c0052a82484f3c1a5b3d',
+                '7df29b69773199e8f2b40b77919d048509eed768e2c7297b1f1437034fc3c62c',
+                'fa668a0a32942239e35c880bc01f031e87d3dd3d5088a325959ef00a2fe4ed00',
+                '4c4000f3b62fd9999516e7869f3d3e0c7ca983c0749c8b52f702fb1dae87692f',
+                'ec3b81a302915954112ec8a6d455751469252e0ca21319e7215b43d13c7c311c',
+              ],
             },
-            "inclusionProof": {
-                "proofIndex": {
-                    "index": "ffe0",
-                    "path": [
-                        "f5a5fd42d16a20302798ef6ed309979b43003d2320d9f0e8ea9831a92759fb0b",
-                        "3731bb99ac689f66eef5973e4a94da188f4ddcae580724fc6f3fd60dfd488333",
-                        "642a607ef886b004bf2c1978463ae1d4693ac0f410eb2d1b7a47fe205e5e750f",
-                        "57a2381a28652bf47f6bef7aca679be4aede5871ab5cf3eb2c08114488cb8526",
-                        "1f7ac9595510e09ea41c460b176430bb322cd6fb412ec57cb17d989a4310372f",
-                        "fc7e928296e516faade986b28f92d44a4f24b935485223376a799027bc18f833",
-                        "08c47b38ee13bc43f41b915c0eed9911a26086b3ed62401bf9d58b8d19dff624",
-                        "b2e47bfb11facd941f62af5c750f3ea5cc4df517d5c4f16db2b4d77baec1a32f",
-                        "f9226160c8f927bfdcc418cdf203493146008eaefb7d02194d5e548189005108",
-                        "2c1a964bb90b59ebfe0f6da29ad65ae3e417724a8f7c11745a40cac1e5e74011",
-                        "fee378cef16404b199ede0b13e11b624ff9d784fbbed878d83297e795e024f02",
-                        "8e9e2403fa884cf6237f60df25f83ee40dca9ed879eb6f6352d15084f5ad0d3f",
-                        "752d9693fa167524395476e317a98580f00947afb7a30540d625a9291cc12a07",
-                        "7022f60f7ef6adfa17117a52619e30cea82c68075adf1c667786ec506eef2d19",
-                        "d99887b973573a96e11393645236c17b1f4c7034d723c7a99f709bb4da61162b",
-                        "df4bcdda22dce8962d97809de9cc4de477e5cd2cb24d3d95c55f9f3d88284b2d"
-                    ]
-                },
-                "proofSubtree": {
-                    "index": "0",
-                    "path": [
-                        "83ccb895e53b292546ccda9c45017c247ffa54b406f492605c9148e09aa2f208"
-                    ]
-                }
+            proofSubtree: {
+              index: '9e3',
+              path: [
+                '1a70519a83a389da68342023f94c0b15bc6f6648bad14e4e27fc2c2d125d3f20',
+                'a3c0174ed523fe92d9ddde004b2edfed748160d039246b3d74afccb9a0b0c519',
+                'dc478492b1d8a2b1ccc39814ab5015f24b7e3a0fc942a3d48dabda78e1ab2a3f',
+                'e3e9663d7b67090385ff0732e29fd20c663e0815c25a11d10da506b248532012',
+                'dafdab6da9364453c26d33726b9fefe343be8f81649ec009aad3faff50617508',
+                'a77eff48b3368c4d75808dcbc0caf1d403abdd8954aeb643fed17527b557ce24',
+                '055300ed6b6526d89f2dcfaf9f59b893bc6cd53c3eaa27876db80830e85b443e',
+                '38c3e42a3376c26ea82e920e5e5b052f712ad376ef7999e9d8af035c55bcf20f',
+                '4b5cbc0110eb00a5fc1722a2f7a474b619df9c498bb80622f879b6471345521b',
+                'db084639887800382d080d44a0fd9818b0344da75a66599e1fc42887ab777035',
+                '08ca66a143b334d38a8829247688e45548bf26005401ba9e6350267fb6a7b424',
+                '60414c8e87371715a022a4f5928d898a19ced0133b90fe3b8b32726334a24b18',
+                'e671e3b30d01a29b2d05632592b36541fa221cb14d9205253896b40b7bcc1700',
+                '07406022b338845ccc7a8750cb2e927c5f2c671cae07897f5deab2e4f1bf8905',
+              ],
             },
-            "indexRecord": {
-                "checksum": "4a8e39cfd5af583596f54f95954a991b",
-                "proofIndex": "df4bcdda22dce8962d97809de9cc4de477e5cd2cb24d3d95c55f9f3d88284b2d",
-                "proofSubtree": 0,
-                "size": 2097152
-            }
-        }
-    },
-    "dealInfo": [
-        {
-            "dealUUID": "f064d4d5-7b35-4647-8df7-91fb8fb99f23",
-            "dealId": 13279,
-            "storageProvider": "t017840"
+          },
+          verifierData: {
+            commPc:
+              '0181e203922020df4bcdda22dce8962d97809de9cc4de477e5cd2cb24d3d95c55f9f3d88284b2d',
+            sizePc: '200000',
+          },
+          indexRecord: {
+            checksum: '2dd9de62dd6433725d537f8c43941a1b',
+            proofIndex:
+              'df4bcdda22dce8962d97809de9cc4de477e5cd2cb24d3d95c55f9f3d88284b2d',
+            proofSubtree: 5307891712,
+            size: 2097152,
+          },
         },
-        {
-            "dealUUID": "ae8f6709-5ca0-4944-abb1-cd04cf05e0c3",
-            "dealId": null,
-            "storageProvider": "t017819"
-        }
+        aggPieceCID:
+          'baga6ea4seaqgcyx3xz23psubfg2c6qzhffa4fuchmydcwzamtpaf5ct46l5nola',
+        aggPieceSize: 34359738368,
+        aggCarFileSize: 34091302912,
+      },
     ],
-    "previousAggregates": [
-        "975afcd3-ff3e-4395-a50e-24500ca0bfb7"
-    ]
 }
 ```
 {% endcode %}
@@ -307,72 +319,4 @@ saveResponseToFile(response, filePath) {
 
 ***
 
-## <mark style="color:blue;">2) Upload via Lighthouse Smart Contract</mark>
-
-In this method, we will pass a cid to Lighthouse Smart Contract deployed on the following address
-
-* **Mainnet:** `0xd928b92E6028463910b2005d118C2edE16C38a2a`
-* **Calibration Testnet**: `0x01ccBC72B2f0Ac91B79Ff7D2280d79e25f745960`
-
-The source code for this contract can be found [here](https://github.com/lighthouse-web3/raas-starter-kit/blob/main/contracts/DealStatus.sol)
-
-### Smart Contract Interface
-
-Within the smart contract interface, some important features are critical to the RaaS service. These include:
-
-<table><thead><tr><th width="59">#</th><th width="178">Function Name</th><th width="233">Purpose</th><th width="229">Key Parameters</th><th>Outcome</th></tr></thead><tbody><tr><td>1</td><td><code>submit</code></td><td>Function that submits a new deal request to the oracle and will creates a new deal. By default, there will be no renewals and replications for this deal</td><td><code>_cid</code></td><td><code>Event: SubmitAggregatorRequest</code></td></tr><tr><td>2</td><td><code>submitRaaS</code></td><td>Function that submits a new deal request to the oracle and will creates a new deal. Here user can define deal parameters.</td><td><code>_cid,</code><br><code>_replication_target,</code><br><code>_repair_threshold,</code><br><code>_renew_threshold</code></td><td><code>Event:SubmitAggregatorRequestWithRaaS</code></td></tr><tr><td>3</td><td><code>getAllDeals</code></td><td>Get all deal IDs for a specified cid</td><td><code>_cid</code></td><td><code>Deal[]</code></td></tr><tr><td>4</td><td><code>getActiveDeals</code></td><td>return all the _cid's active dealIds. Critical for replication deals.</td><td><code>_cid</code></td><td><code>Deal[]</code></td></tr><tr><td>5</td><td><code>getExpiringDeals</code></td><td>return all the deals' dealIds if they are expiring within <code>epochs</code>. Critical for renewal and repair jobs.</td><td><code>_cid, epochs</code></td><td><code>Deal[]</code></td></tr></tbody></table>
-
-### Calling SubmitRaaS Function
-
-You can interact with the smart contract by submitting a CID of your choice to the `submit` function. This will create a new deal request that the Lighthouse RaaS Worker will pick up when attached as discussed in [Section B](section-b.md).
-
-{% code lineNumbers="true" %}
-```javascript
-// contractInstance is the address of the contract you deployed or the aggregator-hosted RaaS address above.
-const dealStatus = await ethers.getContractAt("DealStatus", contractInstance);
-// Submit the CID of the file you want to upload to the Filecoin network in the following way.
-await dealStatus.submitRaaS(ethers.utils.toUtf8Bytes(newJob.cid), 2, 4, 40);
-```
-{% endcode %}
-
-{% hint style="warning" %}
-Upload with the submit function will not start deal-making by default on the Filecoin network. To start deal-making for the cid passed through the submit function, refer to [Section B](section-b.md) of Attaching RaaS (renew, repair, replication) Worker
-{% endhint %}
-
-***
-
-## <mark style="color:blue;">3) Why does all this matter?</mark>
-
-We see a bright future in enabling programmable, immutable, decentralized data storage for developers.
-
-Lighthouse SDK is designed to be simple and easy to use. We hope that this will enable developers to easily integrate the Filecoin network as the primary data storage layer for their applications.
-
-More importantly, this enables developers to build novel applications. Imagine a dapp or DAO that can be built to incentivize, analyze and store upload metadata on-chain. There are a couple of examples of this:
-
-* Rewarding $TOKEN based on the upload of a particular file and their CID.
-* Being able to track CIDs and deal IDs onchain for verification and airdropping.
-* Building more advanced, robust DataDAOs (check out the starter kit [here](https://github.com/filecoin-project/fevm-data-dao-kit)!)
-
-For your consideration, here's some pseudocode of how you could build a simple dapp that rewards users for uploading files to the Filecoin network:
-
-```solidity
-function uploadFile(bytes32 fileCID) public {
-    // Check if the file has already been uploaded
-    require(!fileExists(fileCID), "File already exists");
-
-    // Check if the user's file contains the correct data
-    // The logic in verifyPoDSI() depends on your specific application
-    // Check out the various possibilities here https://docs.filecoin.io/smart-contracts/developing-contracts/solidity-libraries/
-    require(verifyPoDSI(fileCID), "File does not contain the correct data");
-
-    // Save the file's CID to prevent against replay attacks
-    saveFile(fileCID);
-
-    // Reward the user for uploading the file
-    // You can mint them a token or send them some $FIL 
-    // Read more here: https://docs.filecoin.io/smart-contracts/developing-contracts/ethereum-libraries/#example-using-an-erc20-contract
-    rewardUser(msg.sender);
-}
-```
-
-***
+You can also work with PODSI, and deal making on-chain with help of smart contracts which we will discuss thoroughly in [next section](section-b.md).