# FilSwan 概览 FilSwan is a layer-2 cross-chain solution that helps Web3 projects to integrate data, computing, storage, and payment into one suite. ## Edge Storage and Computing on Web 3.0 ![ ](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Fq2XLdHtNTjZxiBkhDozx%2Fimage.png?alt=media\&token=c16dcee7-6c92-42e8-a5f0-33c767b7258c) FilSwan offers a complete solution that enables web3 developers to integrate decentralized storage, edge computing, and payment across multiple chains with ease. Since 2018, FilSwan has been dedicated to decentralized storage and computing solutions. Those services are enhanced by edge computing, IPFS/Filecoin, and decentralized ledger technologies. We are building the largest fog computing network in the Metaverse. Our products are adopted by world-renowned universities, the VR/AR industry, and many other high-performance computing companies. ### Turn-key solutions for web3 Developers * FilSwan offers cutting-edge blockchain storage and computing solutions for web3 decentralized data needs. * FilSwan reduces queuing time by automatically matching web3 providers and users in need. * FilSwan offers an alternative to the current mainstream cloud storage that bridges Filecoin and S3. * FilSwan migrates petabytes of data while ensuring efficiency and cost-effectiveness. {% embed url="" %} ## Core Product {% content-ref url="/pages/4TGJ5Jqyc5TEkJZXb5gl" %} [Filswan Platform](/filswan-platform/overview) {% endcontent-ref %} {% content-ref url="/pages/fS2ap3oINhwnDekfz6C4" %} [FS3](/fs3/overview) {% endcontent-ref %} {% content-ref url="/pages/lkH44AE3h8QK6QkBeT6t" %} [Multichain.Storage](/multichain.storage/overview) {% endcontent-ref %} # 协议栈 # 跨链共识层 # Peer-to-Peer (P2P) 网络 # 支付频道 # Service Discovery # 数据市场 # 索引和缓存市场 # Web3 任务bid市场 # 存储层 # 计算层 # CDN 层 # 治理 # 联系我们 # 社交账号&社区 Discord: Telegram: Medium: Twitter: Facebook: YouTube: # 商业合作 ## Partnership If you want your logo shown as FilSwan's ecosystem partner and client, please submit the form below: [Apply to be a partner or client](https://docs.google.com/forms/d/1ysOaN0LH0go32fETBEKDvX2b8VaG_Wxv2sehdwGcYro/viewform) Please don't email us to apply - we only respond to applications via the application form. ### How long will it take to get a response? We aim to respond to applications within a week, but due to the large number of requests, we’re unable to respond to every single applicant. # 概览 FilSwan Platform is a hosted platform for enterprises to integrate their business workflow with the Filecoin network. ![FilSwan Business Solution](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FQYoNvw69f6psMkg3rB4D%2Fimage.png?alt=media\&token=919555f8-e09a-4d55-89fe-c95f664ce37b) # FilSwan 竞价系统 ## Introduction to FilSwan Auction System Filecoin users need to find suitable storage providers in the first instance. They need to actively seek providers, bargain offline, send data files, lock fees, and proceed with payment once file storage is completed as requested. **Over the course, there remain several key questions:** 1\. Users can't fully understand the specific service quality of storage providers because of limited information available. 2\. The lack of in-depth matching functionality, and diverse data storage needs are making the dealer market opaque. 3\. There are not enough choices available for beginners. It is time-consuming as well as costly to find and compare storage providers that will work best for them. In this context, having an open and transparent matching system is necessary. FilSwan's auction system is optimal for simplifying data storage through matching providers and users in need automatically, thereby reducing the learning cost for users. #### Manual bid vs Auto-bid **Manual Bid** There are two types of bids in the FilSwan system. One is manual bid, and the other is auto-bid. Manual bidding is a system designed for users who are actively involved in the bidding. When bidding manually, users select providers in accordance with their bandwidth, storage capacity, geographic location, and daily processing ability. Similarly, users compare and filter attributes of assorted products on shopping platforms. Users cannot avoid other users’ interactions because they need to know who they expect to take the deal. Afterward, users can send the deal. It consists of two steps: the first step is to open the deal bid, and the second step is to assign the bid. Users assign transactions to different storage providers to solicit public bids. Providers then store the data as requested after winning the bid. Since this step is open to the public, we call it an “open public deal”, which means that anybody in the system can compete for it. After several satisfying bids, the user may be willing to build long-term private cooperation with the storage provider. So, they may skip the bidding process and send deals directly to each other in the future. We call this case a “private deal”. One advantage of the manual bid system is that tipping the tasks makes it more flexible while bidding. **Autobid** ![Autobid System](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FVfsDI8D8sERRqDwL7oOc%2Fimage.png?alt=media\&token=87aed05c-1231-4f52-b228-900183e40fe4) The auto bidding system is a reputation-based system. When users sign up as a storage provider, they will be rated based on the data they processed. The more data they process, the higher score they will achieve. In the auto-bidding system, users are free from hassles like choosing storage providers. The system selects providers automatically while ensuring fairness. When a user sends out a deal to the auto bidding pool, the storage provider will be assigned the deal based on their reputation score. The higher score you have, the more likely they will win a bid. The FileSwan bidding system is a matching platform that enables convenient transactions between users and providers. In the era of decentralized storage, FilSwan ensures a quick pair of users and storage providers for the sake of time-efficient storage and backup services regardless of data scales. The FilSwan bidding system increases the earnings of real data storage. It additionally reduces the leverage difficulty to attract more novice users. The market matcher program distributes the order following a lambda distribution, which means that even if the storage provider scores low, he is still able to get some deals. **Task** It is of great importance to conceptualize "task" in the FilSwan system. A task consists of several deals. Currently, Filecoin only accepts deals of specified sizes, eg., a maximum of 32 gigabytes or 64 gigabytes. If you want to store a data more than one terabyte or 10 terabytes, you need to split it to different deals manually to send them. This could make deal management daunting. In order to batch send deals, we have created a conception called “tasks”. A task is a combination of deals. Users can name it, label it, and define the curated dataset type for future usage. **Swan Provider** The Swan Provider runs on the same node as the lotus miner nodes run, and assists lotus miners to process deals. In order to better share the information with the Flilswan client, [authentication](https://github.com/filswan/gitbook/blob/main/run-swan-provider/broken-reference/README.md) from the Filswan platform is required. Swan provider also keeps your status up to date. With the Swan platform, your client can get your shared information about the file sealing life cycle. We also provide the Restful API interface for developers to integrate the Swan Provider into their own system. Read more: # Web3自动交易匹配 Web3 Automated Market Match # 信誉系统 ## Reputation Score ### Methodology #### Reputation Score = Time-based Reachability + Regional Weighted Adjusted Power + General Deals and Verified-Storage Provider Deals ### Reputation Score Formula: The reputation system can conduct a comprehensive evaluation of various parameters of the nodes. It integrates running time, geographical location, regional influence, quantity, packet loss rate, failure rate, and real-time transaction to perform mathematical weighting. Afterward, it will generate an overall ranking and a quantitative evaluation of storage provider nodes. Growing data storage tasks received by top providers can lead to a more stable running system. Meanwhile, the reputation system ensures a focus on node operation and maintenance, thereby promoting the security and stability of the Filecoin storage network. It keeps users away from the hassle of seeking service providers. * The max score that the storage providers can have is 100 points. * The score is based on 3 main sets of metrics, each set with a different weight in the total score: * Time-based Reachability - 30% weight * Regional Weighted Adjusted Power - 10% weight * General Deals and Verified-Storage Provider Deals - 60% weight ### 1. Time-based Reachability: Time-based reachability measures the times of successful and failed requests when storage providers are scanned. The ratio of successful request count to total request count (successful request plus failed request) is the key metric used here. Request Successful (reachable) = 1 Request Failed (unreachable) = 0 Success Rate = reachable count/ total count In addition to the overall request success ratio, the latest request performance of storage providers in the recent few scans will be considered. The reason is that the system rewards storage providers based on their recent performances. The ratio of successful request count and total request count during the last 10 scans is calculated to represent the recent behavior. The weight of online reachability of all time and online reachability in the latest scans are 0.7 and 0.3, respectively. The Reachability score is calculated with the following mathematical formula: {% hint style="info" %} Time-based Reachability Score = 30 \* (0.7 \* Online Reachability Total Success Rate + 0.3 \* Online Reachability Top10 Success rate) {% endhint %} ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FeJ0JA1tybKLgJDueeDln%2Fimage.png?alt=media\&token=b4758e65-4287-4c81-936d-a4fb906e654c) ### **2. Regional Weighted Adjust Power:** The regional committed sector proof score is designed to measure the total committed capacity of the miner. The bigger the miner is the more collateral is required, and the technical support effort also increased. The importance of a miner in the region is inversely proportional to the total number of miners in the region, e. g. a miner in a 1-miner region is 10x more important than a miner in a 10-miner region since it is the only service provider. To emphasize the importance of the miner of the region, we use the regional weighted adjust power to show the weight of the miner in the region. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FGDF28cJwLJjeU9YbxTiI%2F1.png?alt=media\&token=0751fb70-3690-4300-aabf-27921a7ce576) The weighted adjust power is calculated with the following mathematical formula: *Location Weight = 0.5 + 0.5 \* exp( -1 \* number of miners in its continents)* *Number Weight = 0.5+ 0.5 \* exp( -1 \* total adjusted power in its continents / total adjusted power worldwide)* *Weighted adjust power = Location Weight \* Number Weight \* adjusted power* After adjusting the power by the location, the weighted adjusted power is then transformed by a log transformation so that the distribution of log weighed adjusted power is closer to a normal distribution. Then the log weighted adjusted power is normalized using min-max normalization approach. The normalized log weighted adjust power is calculated with the following mathematical formula: *Normalized Log Weighted Adjusted Power = norm \[log (Weighed Adjusted Power)]* The normalized result is a number in the interval \[0,1] where 1 is the maximum score. A miner that has a score of 1 is rewarded with 30 reputation points. The Reachability score is calculated with the following mathematical formula: {% hint style="info" %} *Committed Sectors Proof Score = 10\* Normalized Log Weighted Adjusted Power* {% endhint %} ### 3. General Deals and Verified-Storage Provider Deals: The 3rd component of the score reflects the proportion in which the Web3 Storage Provider (W3SP) has successfully run the storage deals. Making storage deals is the core of a Web3 Storage Provider (W3SP) and thus this component has the biggest weight in the score. The deals considered here involve both internal deals (swan deals) and external deals (general deals). The Web3 Storage Provider (W3SP) active rate accounts for the key parameter, defined as the ratio of the number of active deals divided by the number of total deals. The active rate for external deals is set to 1 for now and will be updated later on. A verified Web3 Storage Provider (W3SP) is a Web3 Storage Provider (W3SP) who signed with their Web3 Storage Provider (W3SP)’s signature and email address, they usually also update their contact information in Swan or other platforms. The deals considered here involve both verified-Storage Provider deals and external deals (general deals). The Web3 Storage Provider (W3SP) active rate accounts for the key parameter, defined as the ratio of the number of active deals divided by the number of total deals. The active rate for external deals is set to 1 for now and will be updated later on. The verified-Storage Provider active rate is calculated with the following mathematical formula: Verified-Storage Provider Active Deal Rate = the number of active deals/numbers of total deals After Web3 Storage Providers (W3SP) are ranked by the calculated verified Web3 Storage Provider (W3SP) active rate in increasing order with the method set to "max". In other words, the records that have the same values are ranked using the highest rank (e.g.: If ‘Tom’ and ‘Jerry' are tied in the 2nd and 3rd position with the same value, rank 3 is assigned to them both). ![](https://console.filswan.com/static/img/Methodology3.905c15e.png) This max ranking method guarantees a base score for each Web3 Storage Provider (W3SP) and leverages more to the Web3 Storage Providers (W3SP) having a larger number of verified-Storage Provider active deals. The verified-Storage Provider active rate rank is then normalized by the division of the number of Web3 Storage Providers (W3SP). The normalized verified-Storage Provider active rate rank is calculated with the following mathematical formula: Normalized verified-Storage Provider Active Deal Rate Rank = norm \[Rank\_Max (Verified-Storage Provider Active Rate)] The normalized verified-Storage Provider active rate is then weighted by another parameter, the sector faculty rate. Deals that fall into faults for some reason will lose weight and Web3 Storage Providers (W3SP) that have fewer faults are assigned more weight. In this scenario, the sector faulty rate is calculated as the ratio of the number of faults divided by the number of total live deals. The sector faulty rate is calculated with the following mathematical formula: Sector Faulty Rate = number of fault deals/number of live deals Thus, the deals score is the weighted sum of verified-Storage Provider deals and external deals with faulty rates considered. The General deals and verified-Storage Provider deals score is calculated with the following mathematical formula: General Deals and verified-Storage Provider Deals Score = 60 \* \[0.3 \* 1 + 0.7 \* (1 - Sector Faulty Rate) \* (Normalized verified-Storage Provider Active Rank)] ## **Blacklist Rule** ### Introduction Miner will be evaluated not only on its reputation score, but also on its recent deal rejection history. If a miner rejected a large number of deals over a long period of time, its score will be conducted deduction. The deduction is possible to put the miner on the blacklist and unable it to take more deals. ### Methodology The miner's blacklist status is related to a blacklist score (as the **score** in the rest of the document). The score will be deducted when miners reject deals without a satisfying reason. Each newly registered miner will start from 100 scores. And miner will lose scores on certain rejections (With a threshold of 5 points per day). This makes sure that inactive miners will not receive deals, and reduce the probability of unsuccessful deals occurring. There are the rejection responses lead to score deduction: * Filswan being blacklisted: -1 * Unidentified rejection: -0.5 * Unqualified deal: -0.3 * Error message: -0.1 * Deal time out: -0.05 After a miner's score is below 30, the miner will be automatically put on the blacklist. #### Score recovery For miners on the blacklist, their score can be recovered by being active. For each day the miner's heartbeat status is **Online**, the miner will gain 1 score until the score reaches 30, and the miner will be removed from the blacklist. #### Scanning The miner's deal history will be automatic review each day. Offline deals that are rejected will be scanned for score deduction purposes. And the score will be updated afterwards. # 主要功能 # 任务管理 # 创建新任务 1. To create a task, go to either **Browse Tasks** or **My Task** and click on the yellow button that says “**Create Task**.” ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FSwrubUzxAJ3lFR8aFBVG%2Fimage.png?alt=media\&token=9d15d88e-6e06-48aa-9653-57e6fdb2d600) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FVGp5q6FVgwyW46eI4pvP%2Fimage.png?alt=media\&token=9d15d88e-6e06-48aa-9653-57e6fdb2d600) 2\. When creating a task: * **Task name**. We suggest creating a task name that is descriptive of the task. In the example below, the task name is “Swan Team 5\*32GB verified Task.” Swan Team alerts storage providers that this task is an official deal that is coming from FilSwan and 5\*32G indicates the amount of storage needed for this task. * **Task description.** Where clients can indicate certain attributes they are looking for when selecting a storage provider and describes to storage providers what the task entails. In the example below, one of the requirements is that the client wants their data to be stored somewhere in Europe. * **Tags**. Adding tags to the task will help interested storage providers find your task. Tags can be up to 14 characters long and there is a maximum of 5 tags that can be attached to a task. * **Type**. Select whether your deals are Regular or Verified. * **Upload CSV**. Upload the CSV file which contains information of the data that you want to be stored by a storage provider. * **Curated Dataset.** It indicates the source of data that you desired to store in Filecoin network. * **Open bid**. Determine if the task will be open bid by selecting yes or no. * By selecting “Yes,” the task will open bid and all storage providers on the FilSwan platform will be able to view your task in Browse Tasks. * If “No” is selected, then a box will appear for you to type in a storage provider ID. This task would then be sent to that specific storage provider and would not be available to other storage providers. * \*\*Expected time. \*\*Indicate how many days you expect the storage provider to take to complete the task. When storage providers bid on the task, they will indicate if they can complete it by the desired deadline or sooner. * **Estimated budget**. Estimate a maximum and a minimum amount that you would be willing to pay in FIL to a storage provider for storing your data. 3\. Click the submit button to send out the task to the FilSwan market or a specific storage provider. ![Example of Creating a Task](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FgrTRwJH3XJ7KK5bOgpN2%2Fimage.png?alt=media\&token=1db01456-a59d-4c00-a502-2b6c79b6b5b1) # Navigate Tasks **Browse Tasks** shows all available tasks that are open for bids on FilSwan. * If you are a miner looking for tasks to bid on, this would be the place to look. * As a client, after you create a task that is open for bids, it will be displayed on Browse Tasks. ![Example of a task that is open for bids on Browse Tasks](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Faz2wwUAbJ5GMThKolusi%2Fimage.png?alt=media\&token=ba2f1f24-ce6b-499c-a62c-cbecb1dbfc22) **My Task** displays all tasks that only you have created as a client or tasks you have completed as a miner. To switch between client and miner, click on the "**As Client**" or "**As Miner**" buttons at the top of the page. ![Example of previous tasks created as a client](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Few8vNShIPTjFrH1NBoVY%2Fimage.png?alt=media\&token=e0cb72a2-6d39-4780-87ce-533dd3c88545) # 更新任务 ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Fe2vteQxXPOsPTY15dVGg%2Fimage.png?alt=media\&token=7f7c5daf-9a2e-4313-92a3-3acf323e08a8) # 分配任务 **Reviewing & Assigning Bids** After an open bid task has been created, miners will submit bids to obtain that data storage deal. You can review these bids by going to “My Tasks” and clicking on the task name, which is in blue. This will bring you a page with a more detailed layout of that task. To view that task’s bids, click on the bids button at the top of the page. ![](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MauK7Ig3eWeXC35bZV7%2Fuploads%2FmctH3UxZT5eSnOgXZrp1%2Ffile.png?alt=media) All bids will be displayed here. Bids can vary, not all will be identical. When reviewing the bids, the proposal, price, completion rate, and days to complete are shown. To see more information about the miner, you can hover your cursor over the miner ID or click on the miner ID to view their profile. ![Example of Bids](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MauK7Ig3eWeXC35bZV7%2Fuploads%2F1C32IgBYep4Fqkvh95UJ%2Ffile.png?alt=media) Click on the bright green “Assign” button next to the miner you have selected for the task. After clicking on the “Assign” button, a pop-up will appear as shown below. This pop-up will ask for the designated miner’s ID and to upload the CSV file that you want to be stored. ![Example of Pop-up asking to select miner ID and re-upload CSV](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MauK7Ig3eWeXC35bZV7%2Fuploads%2FzFY2JDpCDnmKGRVcvqbQ%2Ffile.png?alt=media) The reason for re-uploading the CSV file is because when creating a task, anyone can view that task’s CSV file. To prevent anyone and everyone on FilSwan from accessing your data file, you can upload a dummy CSV file when creating the task. Then you upload the real CSV file after you have selected a miner and the pop-up above appears. # 我的资料 # 注册成为存储提供商 #### To register as a FilSwan storage provider. 1. Go to **My Profile** and select the **As Storage Provider** tab on the top of your avatar. 2. At the bottom of profile information section, you could find a **Your Swan Storage Providers** section. 3. Click on the yellow button that says **Manage**. Three blue buttons **Add, Delete, Refresh** will show up. 4. Click on the blue button that says **Add**. Enter your storage provider ID, choose wether you Accept Offline Deal, select where your storage provider is located. Then click the button says **Validation**. *Note: the default setting of Accept Offline Deal is OFF. Please switch it to ON if you do accept offline deals. This affects your eligibility to AutoBid.* 5. Then, A **Signature verification** section will show up. Please sign the following message and submit the signature. This ensures authenticity and security for each storage provider owners. *Tips: To get the Signature, you can run `lotus wallet sign {address} {message}` on a lotus node.* 6. Once the Signature is provided, click the blue button says **Submit**. Your storage provider will be successfully registered as a FilSwan storage provider. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FIh4uDU9kkMn0dyzv5PTL%2Fimage.png?alt=media\&token=2b0395a6-3f3d-4d27-ab00-41dfb105acb1) #### To modify your FilSwan storage provider. 1. At the same place where the yellow button **Manage** located. 2. Click on the **Manage** button. Then, in your storage provider list, the two columns "OFFLINE DEALS" and "LOCATION" will become modifiable. 3. To modify wether your storage provider accept offline deals, click on the **Yes/No** button(the blue one is your current setting); to modify your storage provider location, select the region in the drop-down list. 4. Click the blue button says **Save** to save all your modifications. #### To Delete your FilSwan storage provider 1. At the same place where the yellow button **Manage** located. 2. Click on the **Manage** button. Then clicking on the row of the target storage provider to select the storage provider which you would like to delete. 3. Click the blue button **Delete** which is in the middle of Add and Refresh button. 4. A confirmation pop-up window will show up. 5. Click on the blue button **OK**. Your storage provider will be successfully deleted. # 寻找存储提供商 On the Dashboard, type in a W3SS ID into the search bar to search for a specific storage provider’s profile. Always click on the W3SS ID to view their profile. The storage provider's profile will provide additional information about their data storage capabilities. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FPPHVL3XLxp8b7rznXaDe%2Fimage.png?alt=media\&token=14d848ae-830f-4281-b936-3c9f1df8c6c8) To search for the storage provider’s status (active or offline), you can use the drop-down box to the left of the W3SS ID search bar. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FgCyXtr38Tb11cVrdH40r%2Fimage.png?alt=media\&token=6746ff16-93cb-40b5-89ea-7ca8bbca9866) There is another dropdown box to filter storage providers by their location. The available location options are Asia, Africa, North America, South America, Europe, Oceania, and Global. Storage providers who have listed their location as Global have no fixed location for storing your data. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FesEhTQe3bWyVPdbgVjAQ%2Fimage.png?alt=media\&token=53d0bc3c-8b2c-4805-a73b-6ebbbfe43cce) All of the storage provider’s information categories are displayed on the Dashboard and can be viewed by scrolling to the right. However, if you are only interested in viewing certain categories, you can use the filter function to view certain columns. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FxWX8oIdkA30eXh4aPYqu%2Fimage.png?alt=media\&token=2ba92e36-0d07-4dbc-8617-fb756591b672) Below are all the available categories that can be displayed on the Dashboard when you click on the filter function. You can select the boxes to display the categories relevant to you. The default setting of the Dashboard will be to always display all the categories. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FCAeON4su25H7N5pU09jX%2Fimage.png?alt=media\&token=0cd3059b-ea96-4ea1-995a-98aa13c47bd4) # 存储提供商详情 To view a storage provider’s profile, go to the dashboard and click on the storage provider ID, which is in blue text. \*\*Storage Provider Profile \*\* The storage provider profile provides more background information to a storage provider. Profile Header and Summary are two sections of the profile that does not appear on the Dashboard. Profile headline is a section you can use to highlight a distinguishing feature of yourself as a storage provider. In the example below, the highlighted feature is “10TB daily sealing power.” Following the Profile Headline is the Summary, which is used to go further into detail about your capabilities as a miner, such as sealing power, location, fiber and, etc. Contact Info is used to contact the storage provider if any problems arise during the data storage deal. Users can put any contact method, but most users put their slack username or email. The more detailed you can be on your profile the more you differentiate yourself from other storage providers. Clients can make better informed decisions with the more volunteered information they have access to. ![Example of Storage Provider Profile](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MauK7Ig3eWeXC35bZV7%2Fuploads%2Fzb9xcmv2GMq9XUOdhL4m%2Ffile.png?alt=media) **Storage Provider** \*\*Data \*\* Storage Provider Data shows all the information that is displayed on the Dashboard. Mining Data history can be shown for the past 24 hours, 7 days, 30 days, and 1 year. The past 24 hours are always the default data. To view past data, select the desired time frame that’s listed next to Mining Data. Hovering or clicking on the question mark adjacent to the “Score” will provide more information about how a miner’s score is calculated. The score is calculated using a reputation system. ![Example of Mining Data](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MauK7Ig3eWeXC35bZV7%2Fuploads%2FguMM5vFuygaH3KbtBHvG%2Ffile.png?alt=media) \*\*Graphs \*\* The graphs in Storage Provider Details give a visual representation of the changes in a Storage Provider Score, Adjusted Storage Power, and Adjusted Storage Growth. The Adjusted Storage Power Growth is often found on the x-axis of the Power Change graph. The graphs display up to one month of changes. ![Example of Miner Graphs](https://firebasestorage.googleapis.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MauK7Ig3eWeXC35bZV7%2Fuploads%2FgeFcW9DqwqBDua3hvk5X%2Ffile.png?alt=media) # DataCap订单续期服务 为了保证有效数据的持续存储，Swan推出Datacap 订单续期服务：[Extend DataCap Terms](https://datacap.swanchain.io/)。该服务将有助于存储提供商保持其10倍算力，延长扇区的到期时间。
所有从[ ](https://console.filswan.com/) [Swan Platform](https://console.swanchain.io/dashboard) 收到的Deals都可以通过这项服务进行DataCap订单续期。 ### 要求: 在使用 [Extend DataCap Terms ](https://datacap.swanchain.io/)服务之前，请确保您符合以下要求： 1. 扇区必须处于激活状态； 2. 交易必须来自 [Swan Platform](https://console.swanchain.io/dashboard) 平台； 3. 扇区的校验时间必须在 V17（2383680，2022-11-30 140000 UTC）之后； 4. 确保已安装 `lotus-miner` 1.23.0 或更高版本。 ### 延长期限: 1. 扇区的期限时间可延长 180 天、360 天或 540 天。 2. 扇区的最大期限时间不能超过 540 天。 ### 如何延长: 根据 [FIP0045](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0045.md), 如果要延长 DataCap 扇区的有效期，需要两个步骤: #### **第一步:** **Client**需要更新DataCap扇区中每笔交易的 Claim `TermMax`: ``` lotus send --from --method 11 --params-json '{"Terms":[{"Provider":1836766,"ClaimID":13847890,"TermMax":3680640}]}' f06 0 ``` #### **第二步:** **存储提供商**需要完成扇区续期操作: ``` lotus-miner sectors extend --extension=1555200 --really-do-it=true --drop-claims=true --sector-file=[sector_file] ``` Swan 的 [Extend Datacap Terms Service ](https://datacap.swanchain.io/)可帮助您完成[第一步](#di-yi-bu)，而供应商需要执行[第二步](#di-er-bu)。 ### 续期教程： 1. 访问 [Extend Datacap Terms Service](https://datacap.swanchain.io/) ； 2. 填写您的存储提供商 ID 并上传您要续期的扇区列表； 3. 选择续期时间并选择要延期的Claim； 4. 支付完成后，提供您的电子邮件和交易 CID提出申请； 5. 申请成功后，您将收到一封确认邮件； 6. FilSwan 团队在确认了支付状态后，将完成DataCap订单续期，并通过电子邮件回复相应的扇区信息； 7. 存储提供商下载扇区文件并自行完成扇区续期。 ``` lotus-miner sectors extend --extension=518400 --really-do-it=true --drop-claims=true --sector-file=[sector_file] ``` **The extension days:** | Days | Epoch | | ---- | ------- | | 180 | 518400 | | 360 | 1036800 | | 540 | 1555200 | # 概览 A smart contract-based cross-chain storage gateway. ### **Introduction** Multi-Chain storage (MCS) is a smart-contract-based cross-chain storage gateway that is integrated with oracle technology. It accelerates the mass adoption of decentralized storage by bridging multiple blockchain networks. MCS enables users to pay for Filecoin storage with stable coins and other Mainnet tokens while maintaining data security. Users will also obtain the payment transaction and IPFS information with Filecoin deal ID for future reference. ### **Functions** MCS is a cutting-edge blockchain storage solution providing a data cache and presidency layer for decentralized data storage needs. With MCS, users can * Upload any data to the Filecoin network and IPFS. * Pay for storage with stable coins like USDC and other mainnet tokens. * Mint NFTs directly to OpenSea. * Access services by connecting a third-party wallet (MetaMask) * Sent or get deals automatically through the build-in auto-bid system. * Merge small files to a large CAR file. * Support to multiple miners for storage. ### **Advantages** Filecoin is an open-source, public cryptocurrency and digital payment system intended to be a blockchain-based cooperative digital storage and data retrieval method. As a powerful and dynamic distributed cloud storage network, Filecoin is adopted by multiple blockchain projects like Near and Polygon. However, those individual chains or projects each operate in isolation and can hardly communicate with the others. Global users are consequently facing a large number of networks with different algorithms, transaction types, rules, etc. It prevents users from enjoying the full potential of blockchain technology. **That is why MCS is working to guarantee the seamless interoperability of blockchains.** Since its launch, MCS has been dedicated to closing the gap by allowing users to swap other tokens to Fil to pay for data storage. MCS will bring data storage to the next level of security, decentralization, and democratization. {% embed url="" %} # Flink A data provider DAO offers Chainlink Oracle service for Filecoin Network ### Introduction Flink is a data provider DAO aiming at offering Chainlink Oracle service for the Filecoin Network. Flink offers deal information on multi chains for users who want to store their data on Filecoin. ### **What is Filecoin - Chainlink Data Provider** Filecoin is the best option for users from blockchains like Ethereum, BSC, and Polygon to store large-scale data off-chain. Users can upload and retrieve data from the Filecoin network via sending deals. However, how to generate a cross-chain proof remains unresolved and has created a gap between users' storage needs and the Fileocin storage solution. [An External adapter](https://docs.chain.link/docs/external-adapters) can allow access to high-quality data and enable extreme flexibility to connect smart contracts to premium web APIs. With Chainlink external adapter, user can check their deal information on oracle node operators. {% embed url="" %} ### **Sample Use Case** **Polygon NFTs USDC payment for Filecoin storage** The general process of saving NFTs on the Filecoin network is: * Lock a payment on the Polygon network * Swap tokens to Filecoin agent * Filecoin agents send NFT in deals to Filecoin storage providers * Get an on-chain deal ID * Chainlink oracle broadcasts the proof to Polygon network * Storage DAO notaries sign the data based on the deal info provided by Chainlink oracle * NFT payment unlocked to the Filecoin agent ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2F8s2rfZVt4p0WziXJt1Pt%2Fflink%20image.png?alt=media\&token=813dc140-9e34-4c71-a68b-14b35c22d97c) ### **Design Structure** **Three must-haves to work as a Flink data provider:** * Data aggregator * Chainlink external adapter * Data DAO notary Several blockchain scanners will first aggregate the data to a unified data provider. Then the chainlink eternal adapter with oracle smart contracts will broadcast the proof to the targeted blockchain network. Afterward, Data notaries will sign the transaction based on the on-chain oracle data. The payment will be triggered once the on-chain proof is relayed from Chainlink oracles. ### **Data aggregator** When a FIlecoin agent sends the data to a storage provider, the data storage process starts. The storage provider needs to accept the deal and upload an on-chain deal acceptance confirmation, which means the deal is in progress and a deal id will be generated on the Filecoin network. The data aggregator will scan the Filecoin deal information from different data sources and send the information as an API interface. Check the [data](https://github.com/filswan/flink/blob/main/data) directory for the scan-related code. Typical deal info is in this format: > ``` //{ "status": "success", "data": { "deal": { "deal_id": 5210178, "deal_cid": "", "message_cid": "bafy2bzaceaotial6pogwzvm7woh5pf37sivrzm3fmp5teao365jl22z5q4pfc", "height": 1697382, "piece_cid": "baga6ea4seaqjffbc2mmed2piulix5qfppyuhbqumnppme5ngj3q2ol4udijjqbq", "verified_deal": true, "storage_price_per_epoch": 0, "signature": "", "signature_type": "", "created_at": 1649227860, "piece_size": "1073741824", "start_height": 1701360, "end_height": 3234661, "client": "f1g463yb4ok3lq3tffkvvfmfyngcagpx4kg7c7rei", "client_collateral_format": "000000000000000000", "provider": "f067375", "provider_tag": "", "verified_provider": 0, "provider_collateral_format": "000000000000000000", "status": 0, "network_name": "filecoin_mainnet", "storage_price": 0 } } } ``` ### **Chainlink External Adapter - DATA DAO** After the data aggregator gets the deal information, an External adapter is needed for offering API access for data DAO notaries in the next step. For detailed information about how to build and deployed External Adapter, please check the code in [the adapter](https://github.com/filswan/flink/blob/main/adapter) ### **Data DAO Notary** Data DAO notary is in charge of signing the multi-sig wallet for unlocking the fund to Filecoin agents. The DAO contract allows the community to add or remove notaries from the DAO. The DAO notaries will follow these steps before signing: * get deal\_id by proposal\_cid * get deal\_id from Chainlink Filecoin adapter * if matches trigger DAO signature * match client\_address * match deal\_cid (proposal\_cid) * otherwise, waiting for the next check cycle ### **Roadmap** * March 14th,2022: The mainnet launch with the Polygon network * June 6th, 2022: Notary DAO setup # Multichain.Storage 用户指南 ## Requirements Before you begin this guide, complete the following tasks to make sure you have all of the tools that you need: * Complete the [Beginner Walkthrough](/multichain.storage/mcp-user-guide/public-testnet) to set up [MetaMask wallet](/multichain.storage/mcp-user-guide/setup-metamask). * You can obtain Testnet USDC and MATIC from several[ faucets.](/kai-fa-zi-yuan/swan-token-contract) MCS use both **MATIC** and **USDC** for uploading files to polygon network. We strongly suggest you testing with Testnet first. ## **Instruction** ### **1. Connect to your MetaMask wallet on Mumbai Testnet** Go to MCS: . Click on the **Connect Wallet** button to connect your MetaMask wallet, and make sure to select the corresponding network on the MetaMask wallet. (Currently, we only support the Polygon Mumbai Testnet. In the future, it will be officially launched into the Polygon Mainnet. And we also planned to add other main networks such as Ethereum, BSC, Fantom, etc.) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Fi2du4U7tUm2pCyX6sndE%2F1.png?alt=media\&token=96b713fd-4729-40ae-abb0-50b0a5a133df) ### 2. Upload file **to IPFS** * Click the button of **Upload More** . * Choose the file you would like to backup to Filecoin Network. The file name and file size will be displayed below upload button. * An estimated storage cost will be calculated according to the file size, the duration , and the average provider price. * Based on the real-time DeFi exchange rate which got from Sushi Swap, three lock funds plans are provided to our users. The more funds are locked, the sooner your file will be stored on the Filecoin network. Any overpaid funds will be automatically refunded to users after the deal is on chain and contract collects enough DAO signatures. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FPo5JNnpAbgdccUiROJd2%2F2.png?alt=media\&token=c2fd8921-99e9-4ea5-9679-e565ffc3fb62) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FRFolm4MFBvPIRaBOOvHR%2F3.png?alt=media\&token=ad8e270d-a125-4cf8-b9db-864568f22d3a) After Submitting your request, an uploading window will show up. Uploading time varies depends on the size of your file. Please keep the window open until uploading completes. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FWCzpk9tGdOWxtFn8xso9%2F4.png?alt=media\&token=3add2c9e-f1b8-4102-9fba-e1b4c316b0be) ### **3. Lock fund with MetaMask** After the file has been successfully uploaded to IPFS, the next step is Lock funds to the smart contract, using the currency we support. For now, it is 'USDC' token. Waiting time varies depends on the blockchain congestion. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FfOwnVZrl0K3he3SO7TAy%2F5.png?alt=media\&token=42ec5721-eb3d-4bf2-a708-1b9c86625987) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FP5hy8iPkLaCOkU8SUb4Z%2F6.png?alt=media\&token=a434e05a-7e18-4158-99f4-751da9b5d567) While the payment is completed, a pop-up window with the transaction link shows up. You can either click on the link or check your MetaMask activity to see the transaction at the block explorer. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FDqyEU4hRO3wIGhRrJ9Mb%2F7.png?alt=media\&token=2a3d9ac9-e325-49b5-bd6d-e299bd57aaee) {% hint style="info" %} **TIPS:** If you changed your mind and wanted to select another plan? No worries, as long as you didn't confirm your payment on MetaMask. Firstly, you need to reject the transaction on MetaMask. Then, go to the 'My Files' page, you will find a PAY button to the corresponding file. By clicking the **PAY** button, you can also complete your payment. {% endhint %} ### **4. View your files.** By clicking the **Close** button, it will automatically turn to **My Files** page. On this page, you can find all the files you have uploaded. It provides you some frequently used informations, such as the file name, status, data cid, provider id, and payment button, etc. {% hint style="info" %} **TIPS:** With the mouse is hovering over the provider id, it shows you the real-time deal status from blockchain. {% endhint %} {% hint style="success" %} **GOOD TO KNOW:** In order to improve the efficiency, MCS system is using FilSwan's AutoBid function. A qualified and optimal provider will be automatically assigned to your deal. The storage provider will complete following backup procedure, and synchronize the 'Deal status' to our platform. {% endhint %} ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2F3WHx36PMGftRhld7CGBb%2F8.png?alt=media\&token=0071378b-d9a8-4bb9-b777-ab1f6d81565e) {% hint style="info" %} **TIPS:** A search bar is provided on the top of file list. You can search your file by partial file name. {% endhint %} To view more details, simply click on the **file name**. You can find all the related information on this page, including the IPFS download link, the retrieval from Filecoin Network command, and DAO signature information and status. You won't need to bother to check the deal with a blockchain explorer.:smile: ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FmGdLUcMS0CQb1dPmmdGI%2F9.gif?alt=media\&token=32f6b60f-7dc9-4e66-b7ae-068af2536793) #### DAO Signature Process: * When the user's deal is successfully published on blockchain, the deal will be scanned by the DAO organization. * Then, DAO members will sign to agree to unlock the user's funds. * If a specified number of signatures from DAO are collected, the smart contract will unlock the funds. * Part of the locked funds will be used to pay the storage fee, and the remaining will be refunded to user's wallet. {% hint style="info" %} **NOTE:** An expire date is set when locking fund to smart contract, the default is 6 days. If the storage failed while the contract expired, you just need to simply hit the REFUND button, the locked fund will be refunded to users in full. {% endhint %} ### 5. NFT Within MCS, you will be able to use the files you uploaded to mint NFTs if you like. The only requirement is that you have locked fund for the file to the smart contract. To mint a NFT. You just need to click on the **MINT** button of the corresponding file. A windows will pop up with some pre-generated info, such as IPFS url, file size and lock fund transaction hash. The default NFT name will be the same as the file name, but you can always customize it, and fill in the description at will. By clicking on the **Mint NFT** button, a MetaMask window will popup for authorization purpose. A little bit gas fee will be consumed to confirm this mint transaction. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FIA3nGfSkXQtaq04kMhY6%2F12.gif?alt=media\&token=15532d1b-2acb-4b46-bf9f-d8196efae21c) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FfiOATZ33HiQBTdnEfZGH%2F14.png?alt=media\&token=b76d0305-88fc-4952-bff0-c0635fa1be04) Once the mint process is completed, a View Your NFT window will popup. The transaction hash and a link to view your NFT on OpenSea are provided. You can click on the transaction has and OpenSea links to view more details. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FoJYaB9lEXtPGYoW22Qal%2F12.png?alt=media\&token=0385c5f8-5c2f-49eb-a25e-237ed6c47f71) ### 6. Billing History Users can view the billing history of all deals in 'Billing history' page. It covers all the information about the order such as the transaction hash, amount, unlock amount, token, data CID, wallet address, etc. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Fy066pKOpT8Oe3OSbGBuk%2F10.png?alt=media\&token=5ccc7b5f-2f09-4774-8bc6-45ed5aa6d18b) # 公链测试网 ## Public Testnet Guide In order to make it easy for people to get started using Multi-Chain Storage, we've launched our MCS on the Mumbai testnet. ### Connecting to the chain If you're using Metamask, add a custom RPC network to connect your wallet account to the Mumbai Testnet. [Click here to view more info](/multichain.storage/mcp-user-guide/setup-metamask) ### Observing transactions If you'd like to see your transactions in action, please check out [block explorer](https://mumbai.polygonscan.com/)! At there you'll be able to see all the transactions being executed in MCS and also see exactly how much Gas each transaction uses. #### Important Addresses * priceFeedOracleAddress = “”; * swanOracleAddress = “”; * swanPaymentAddress = “0x12EDC75CE16d778Dc450960d5f1a744477ee49a0”; * usdcAddress = “0xe11A86849d99F524cAC3E7A0Ec1241828e332C62"; * wFilAddress = “”; * pairAddress = “"; # 设置MetaMask MetaMask ### 1. Download MetaMask Click the link to install MetaMask for your browser. {% hint style="info" %} **Note:** Depends on if you have a private key or not, you can either import the private key to create a wallet; or, you can create a wallet directly. It's very important to remember the mnemonic and private key. If you lost it, you can also enter the wallet and export the private key. {% endhint %} ### 2. Add Mumbai Testnet Add a custom RPC network to connect your wallet account to the Mumbai Testnet, configure Mumbai Testnet parameters as follow:
ParametersValue
Network NameMumbai Testnet
RPC URL

Chrome browser

https://rpc-mumbai.matic.today or
https://matic-mumbai.chainstacklabs.com or
https://rpc-mumbai.maticvigil.com or
https://matic-testnet-archive-rpc.bwarelabs.com

Firefox browser:

https://rpc-mumbai.matic.today or

https://matic-mumbai.chainstacklabs.com

ChainID80001
SymbolMATIC
Block Explorer URLhttps://mumbai.polygonscan.com/
![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FoDre7kb29xojH49HPLut%2Fimage.png?alt=media\&token=d33907b8-82d7-4c3f-9a15-7c4f2e672037) After the parameters are configured, click 'Save' button below and successfully add Mumbai Testnet. If you want to add more wallet accounts, you can create them by importing the private key of your existing other wallets; or, you can directly click Create Account, and remember to save the private key after creation. ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Fzk819F6s8K6UHXlLalvq%2Fimage.png?alt=media\&token=71a17f47-27b7-4365-9f2c-4bc1c0af978f) *Reference:* [*https://docs.polygon.technology/docs/develop/network-details/network/*](https://docs.polygon.technology/docs/develop/network-details/network/) # 用Alchemy RPC URL配置MetaMask ### **1. List your test networks in your Metamask Network List** This setting is off by default. To turn it on, navigate to Settings > Advanced > Show test networks ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2Fmy4F6wDvzcMW3nRFCJNb%2F2.png?alt=media\&token=5f35e0d9-d0d1-4059-8e54-96a2769b7a0a) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2F7fz1Sllwu5dwPNy2yZaG%2F1.png?alt=media\&token=06c22892-740f-4976-9068-722402a656d2) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FGHvBKGMhC16RAeiVxQnu%2F3.png?alt=media\&token=df52ec75-8d13-49e7-9bc0-af6db111c857) ### **2. Create Alchemy Mumbai Polygon RPC** First, you will need to create an account on [Alchemy](https://dashboard.alchemyapi.io). On the Dashboard page, click "+ CREATE APP", configure the app to be on "Polygon Mumbai" ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FMecuEAGX5O3DP1UzHzKw%2F4.png?alt=media\&token=6a7fa8aa-1e28-40e8-8437-1fe2d12effef) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FNHTwnJGFxPKob0jZBL5r%2F5.png?alt=media\&token=15c14974-3d4b-4c03-a2a3-d5aced89448f) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FaqeHKhhLRBYshr7SYNZL%2F6.png?alt=media\&token=c14adb49-99e4-43b0-a1cf-481408ee3d12) ### 3. Add the HTTP URL to Metamask On your Alchemy dashboard, click the "VIEW KEY" button to view the RPC URL of your Mumbai node and copy the HTTP. Configure a new Mumbai network on Metamask * Network Name: Polygon Mumbai (Alchemy Node) * New RPC URL: *Paste your HTTP from Alchemy Here* * Chain ID: 80001 * Currency Symbol: MATIC * Blockchain Explorer URL: ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FJh1UNzoMFmjw0jJGetp6%2F7.png?alt=media\&token=539a61c0-5eb2-45b4-87b1-199ffda1e14e) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FLik5hbCLXLf870AcCwyr%2F8.png?alt=media\&token=81f4d81d-a887-45e1-b6c3-9a9ce45d5e66) ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FM7xae5Pt9SUkXvb7t9Ap%2F9.png?alt=media\&token=179771c6-b9a9-4cb2-b15f-30517d04f016) # 开发人员快速入门 Multi-Chain Storage (hereinafter called the 'MCS') is a suite of Ethereum scaling solutions that enables high-throughput, low cost smart contracts while remaining trustworthy secure. The following documentation describes how to use MCS, which is currently live on Polygon Mumbai Testnet. Whether you're a developer that just wants to start building or you're curious into digging deeper into the internals of MCS and how it works, this site is the right place for you. ## System Design ![](https://462127002-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fge3NMJs0WFB5ALcsdmfX%2Fuploads%2FoLl8rq5a7vvUQfYNgOTJ%2FWID.png?alt=media\&token=dbcbdda8-88a8-48cb-b763-c319e44b71eb) ## How does MCS work? If you're looking to discover how MCS works, the best place to begin is by the [User Guide](/multichain.storage/mcp-user-guide) section, which gives a high level overview of MCS's internals. From there, you can jump into more detailed explainers on various components of the system. ## Modules **Token Swap:** Token Swap module is in charge of swap the user's token to wrapped token, it can be USDC or other tokens. 1. Users pay USDC or other tokens, which are called user tokens, when uploading a file. 2. MCS uses FIL, which is called wrapped token, to pay when store data to Filecoin network. 3. User tokens should be changed to wrapped token by this module and this step is called token exchange(swap). 4. Token exchange(swap) is done through Sushi Swap which is a DEX. #### Payment Module: 1. After a file is uploaded, the money to be paid is estimated based on the * the average price of all the swan miners; * file size; * duration; Then the estimated amount of money will be locked to the payment contract address, see [Configuration](https://github.com/filswan/multi-chain-payment#Configuration). 2. In unlock step, the amount pay to Filecoin network by swan platform FIL wallet, will be transferred to MCS payment receiver address, see [Configuration](https://github.com/filswan/multi-chain-payment#Configuration). 3. In refund step, the overpayment part that is locked will be returned to user wallet **Swan Client API:** More information can be found [here](https://github.com/filswan/go-swan-client). **DAO Signature:** If DAO detects that the file uploaded has been chained, it will trigger a signature operation **Data DAO:** More information can be found at [Flink](https://github.com/filswan/flink). **IPFS:** More information can be found [here](https://docs.ipfs.io/). **Filecoin Storage:** More information can be found [here](https://lotus.filecoin.io/docs/set-up/install/). ## How Can I Start Building ### Prerequisites * OS: Ubuntu 20.04 LTS * Mysql5.5+ * [Lotus Node](https://github.com/filswan/multi-chain-payment#Lotus-Node) * [IPFS Client](https://docs.ipfs.io/install/) #### Lotus Node * Lotus node is used for making car files and sending offline deals. * Install lotus node or louts lite node in the same machine as MCS. * Lotus full node is too heavy compared with lotus lite node, so lotus lite node is preferred. * Lotus lite node depends on a lotus node, so ensure that a lotus node exists somewhere when using lotus lite node. **Option1️⃣** [**install a lotus full node**](https://lotus.filecoin.io/docs/set-up/install/) **Option2️⃣** [**install a lotus lite node**](https://lotus.filecoin.io/docs/set-up/lotus-lite/#amd-and-intel-based-computers) ### Installation #### Option1️⃣ **Prebuilt package**: See [release assets](https://github.com/filswan/multi-chain-payment/releases) ``` wget https://github.com/filswan/multi-chain-payment/releases/tag/v1.0.1/install.sh ./install.sh ``` #### Option2️⃣ Source Code 🔔**go 1.16+** is required ``` git clone https://github.com/filswan/multi-chain-payment.git cd multi-chain-payment git checkout ./build_from_source.sh ``` ### After Installation * Before executing, you should check your configuration in `~/.swan/mcp/config.toml` to ensure it is right. ``` vi ~/.swan/mcp/config.toml ``` * Before executing, you should check your enviornment variable in `~/.swan/mcp/.env` to ensure it is right. ``` vi ~/.swan/mcp/.env ``` * After set your config and env variable in the related files, you can run `multi-chain-payment` in `./build` directory. ``` ./build/multi-chain-payment ``` #### Note * Logs are in directory `./logs` * You can add `nohup` before `./multi-chain-payment` to ignore the HUP (hangup) signal and therefore avoid stop when you log out. * You can add `>> mcp.log` in the command to let all the logs output to `mcp.log`. * You can add `&` at the end of the command to let the program run in background. * Such as: ``` nohup ./multi-chain-payment-0.2.1-rc1-unix >> mcp.log & #After installation from Option 1 nohup ./build/multi-chain-payment >> ./build/mcp.log & #After installation from Option 2 ``` ### Configuration You need to modify the config file and input your config params, the configuration items will be introduced below: #### config.toml * **port**: Web api port. * **release**: When work in release mode: set this to true, otherwise to false and environment. variable GIN\_MODE not to release. * **swan\_platform\_fil\_wallet**: The wallet address used to pay on the Filecoin network. * **filink\_url**: Deals data can be searched from here. **\[lotus]** * **client\_api\_url**: URL of lotus client web api, such as: `http://[ip]:[port]/rpc/v0`, generally the `[port]` is `1234`. See [Lotus API](https://docs.filecoin.io/reference/lotus-api/#features) * **client\_access\_token**: Access token of lotus client web api. It should have admin access right. You can get it from your lotus node machine using command `lotus auth create-token --perm admin`. See [Obtaining Tokens](https://docs.filecoin.io/build/lotus/api-tokens/#obtaining-tokens) **\[ipfs\_server]** * **download\_url\_prefix**: IPFS server url prefix, such as: `http://[ip]:[port]`. Store car files for downloading by storage provider. Car file url will be `[download_url_prefix]/ipfs/[file_hash]` * **upload\_url\_prefix**: IPFS server url for uploading files, such as `http://[ip]:[port]` **\[swan\_task]** * **dir\_deal**: Output directory for saving generated Car files and CSVs. * **verified\_deal**: \[true/false] Whether deals in this task are going to be sent as verified. * **fast\_retrieval**: \[true/false] Indicates that data should be available for fast retrieval. * **start\_epoch\_hours**: start\_epoch for deals in hours from current time. * **expired\_days**: expected completion days for storage provider sealing data. * **max\_price**: Max price willing to pay per GiB/epoch for offline deal. * **generate\_md5**: \[true/false] Whether to generate MD5 for each car file, note: this is a resource consuming action. **\[polygon]** * **rpc\_url**: your polygon network RPC URL. * **payment\_contract\_address**: swan payment gateway address on polygon to lock money. * **sushi\_dex\_address**: sushi address on polygon. * **usdc\_wFil\_pool\_contract**: address to get exchange rate between USDC and wFil from sushi on polygon. * **dao\_contract\_address**: swan DAO address on polygon, to receive DAO signatures. * **mcp\_payment\_receiver\_address**: MCS wallet address to receive money from unlock operation. * **gas\_limit**: gas limit for transaction. * **unlock\_interval\_minute**: unlock interval in minutes between 2 unlock operations, in cannot be less than 1. #### .env * **privateKeyOnPolygon**: private key of the wallet used to execute contract methods on the polygon network and pay for gas. **Want to learn more? Check out the** [**open source code**](https://github.com/filswan/payment-bridge) **and** [**API**](https://docs.filswan.com/development-resource/mcp-api-1)**. Join the team on** [**Discord**](https://discord.gg/djsVYe4b)**.** ### ### # SDK ## Introduction MCS SDK is the development kit for Swan MCS developers, providing a convenient interface for working with the MCS API. * **Zero Cost, Free to Use** * **Access by Wallet (Metamask)** * **Seamless Integration, Easy to Implement** ### Current Supported Languages: * [Javascript](/multichain.storage/developer-quickstart/sdk/js-mcs-sdk) ## Use Case ### Decentralized File Storage (Filecoin) Files are uploaded using the [IPFS](https://docs.ipfs.io/concepts/what-is-ipfs/) protocol, and are accessible through peers located anywhere in the world. IPFS knows how to find what you ask for using its content address rather than its location (HTTP) address. These uploaded files persist on the [Filecoin](https://filecoin.io/) network thanks to storage providers. IPFS addresses and moves content, while Filecoin is an incentive layer to persist data. Although your files may be stored by various storage providers, MCS provides a convenient interface to view all your uploaded files. ### Multi-Chain Payment Solution MCS enables users to pay for Filecoin storage with stable coins and other Mainnet tokens while maintaining data security. Users will also obtain the payment transaction and IPFS information with Filecoin deal ID for future reference. ### Mint Files as NFTs After your file is uploaded to MCS, your assets can simply be minted as viewable NFTs on Opensea (NFT marketplace). Just give your NFT a name (descriptions are optional) and it will be added to the MCS NFT collection on Opensea! ### Building Using this SDK, the developers will have more control using the API than they would have using the MCS website. Scripts can be written to upload many files at once, mint multiple NFTs, etc. Developers can create dApps on top of MCS, the possibilities are endless! # js mcs SDK https\://github.com/filswan/js-mcs-sdk js-mcs-sdk is a javascript software development kit for the MCS service. It provides a convenient interface for working with the MCS API from a web browser or Node.js. The SDK has the following functionalities: * POST upload file to FilSwan IPFS gateway * POST make payment to Swan Filecoin storage gateway * POST mint asset as NFT * GET list of files uploaded * GET files by CID * GET storage status from Filecoin {% embed url="" %} ### Sponsors This project is sponsored by Filecoin Foundation [Flink SDK - A data provider offers Chainlink Oracle service for Filecoin Network](https://github.com/filecoin-project/devgrants/issues/463) [![](https://github.com/filswan/flink/raw/main/filecoin.png)](https://github.com/filswan/flink/blob/main/filecoin.png) # 开始 This guide will explain how to install the js-mcs-sdk and its basic usage ## Prerequisites * [Node.js](https://nodejs.org/en/) - This SDK was built using version v16.13.0 (npm v8.1.0) * Polygon Mumbai Testnet Wallet - [Metamask Tutorial](/multichain.storage/mcp-user-guide/setup-metamask) * Polygon Mumbai Testnet Alchemy RPC - [Alchemy Tutorial](https://docs-cn.filswan.com/multichain.storage/developer-quickstart/sdk/js-mcs-sdk/pages/UNtBNqqwgnrbBqCGTaew#alchemypolygontometamaskinstructions-2.createalchemymumbaipolygonrpc) Mumbai Testnet USDC and MATIC funds are also necessary - [Swan Faucet Tutorial](/kai-fa-zi-yuan/swan-token-contract/acquire-testnet-usdc-and-matic-tokens) ## Installation Install the package using npm. It is recommended to create a new directory for a new project. Run the init command to setup a package.json file ``` npm init -y npm install js-mcs-sdk ``` ## Environment Variables Once you have your Mumbai wallet and RPC URL, create a file named `.env` in your project directory and store your wallet's private key and the RPC URL. ``` PRIVATE_KEY= RPC_URL=https://polygon-mumbai.g.alchemy.com/v2/ ``` {% hint style="info" %} Be careful not to expose this information! \ Revealing your private key to others will give them access to your wallet. {% endhint %} ## Writing SDK Scripts To begin writing a script utilizing the SDK, create a new `.js` file. Let's create a file named `demo.js` At the top of this file, require the necessary packages for the script. ``` // demo.js require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') ``` * `require('donenv').config()` will add the variables in your `.env` file to `process.env` * `const { mcsSDK } = require('js-mcs-sdk')` will require the SDK Next, after requiring the SDK, we still need to initialize it ``` require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') // set up js-mcs-sdk const mcs = new mcsSDK({ privateKey: process.env.PRIVATE_KEY, rpcUrl: process.env.RPC_URL, }) ``` Now we can begin using the SDK methods. Since these functions are [asynchronous](https://javascript.info/async-await), we will need to create an `async` function to run the SDK methods. ``` require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') // set up js-mcs-sdk const mcs = new mcsSDK({ privateKey: process.env.PRIVATE_KEY, rpcUrl: process.env.RPC_URL, }) async function main() { // code snippets found in the documentation go here } main() ``` {% hint style="info" %} This is the boilerplate code for all snippets found in the SDK documentation {% endhint %} ## Upload File Example Here is a simple example to upload a single file to MCS. Made a new file named `upload.js` ``` require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') // set up js-mcs-sdk const mcs = new mcsSDK({ privateKey: process.env.PRIVATE_KEY, rpcUrl: process.env.RPC_URL, }) async function main() { const testFile = JSON.stringify({ address: mcs.publicKey }) const fileArray = [{ fileName: `${mcs.publicKey}.txt`, file: testFile }] const uploadResponse = await mcs.upload(fileArray) console.log(uploadResponse) } main() ``` Use the command `node upload.js` to run the code. This snippet creates the MCS SDK instance, creates a JSON file with your wallet address, and uploads the file to MCS. # 上传文件 Upload file(s) to MCS using the MCS SDK `upload(fileArray, options)` You can use the upload function to upload an array of file(s) to FilSwan IPFS gateway. The array holds a list of objects, and returns an array of response objects. Using `fs` is a simple way to read the file data. The options object is also optional to customize the upload. ``` require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') const fs = require('fs') // used to read files // set up js-mcs-sdk const mcs = new mcsSDK({ privateKey: process.env.PRIVATE_KEY, rpcUrl: process.env.RPC_URL, }) async function main() { // ENTER PARAMETERS const PATH_1 = '' const PATH_2 = '' const fileArray = [ { fileName: 'file1', file: fs.createReadStream(PATH_1) }, { fileName: 'file2', file: fs.createReadStream(PATH_2) }, ] //optional, showing default options const options = { delay: 1000, // delay between upload API calls for each file. May need to be raised for larger files duration: 525, // the number of days to store the file on the Filecoin network. fileType: 0, // set to 1 for nft metadata files. type 1 files will not show on the UI. } const uploadResponses = await mcs.upload(fileArray, options) console.log(uploadResponses) } main() ``` ### Parameters * **fileArray**: array of objects * **fileName**: name of file * **file**: file contents (using `fs` is a simple way to get the file contents) * **options**: an optional object can also be passed to specify certain parameters: * **delay**: delay in milliseconds between upload API calls. Default is 1000, but may need to be increased for many larger files * **duration**: Number of days to store your file on the Filecoin network. (default 525) * **fileType**: Files of type one will be hidden from the upload list and the UI. NFT metadata files are type 1. (default 0) ### Return This function returns an array of the upload API responses. ``` [ { status: 'success', data: { source_file_upload_id: , payload_cid: <'Qm...'>, ipfs_url: <'https://calibration-ipfs.filswan.com/ipfs/Qm...'>, file_size: , w_cid: } }, ... ] ``` # 支付存储费用 Pay for storage on MCS `makePayment(wCid, minAmount, fileSize)` After a file is uploaded, the file can be paid for by its payload cid. The method takes the w\_payload cid as the first parameter and the minimum amount as the second. ``` require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') // set up js-mcs-sdk const mcs = new mcsSDK({ privateKey: process.env.PRIVATE_KEY, rpcUrl: process.env.RPC_URL, }) async function main() { // ENTER PARAMETERS const W_CID = '' const MIN_AMOUNT = '1' const FILE_SIZE = '' const tx = await mcs.makePayment(W_CID, MIN_AMOUNT, FILE_SIZE) console.log(tx.transactionHash) } main() ``` ### Parameters * **wCid**: unique payload cid of the file * **minAmount**: minimum amount to pay for the file (in USDC). String value to avoid Big Number precision errors. If minAmount is set to empty string or '0', it will default to calculate and use the average storage price * **fileSize**: the size of the file ### Return Returns a web3.js receipt object. In the example above, only the transaction hash from this object is printed. # 铸造NFT Mint NFT to MCS Opensea Collection `mintAsset(sourceFileUploadId, nftObject)` The following code example mints an uploaded file as a NFT viewable on Opensea. Create an NFT object and provide the payload\_cid of the file. The NFT object follows the [Opensea metadata standards](https://docs.opensea.io/docs/metadata-standards). ``` require('dotenv').config() const { mcsSDK } = require('js-mcs-sdk') // set up js-mcs-sdk const mcs = new mcsSDK({ privateKey: process.env.PRIVATE_KEY, rpcUrl: process.env.RPC_URL, }) async function main() { // ENTER PARAMETERS const SOURCE_FILE_UPLOAD_ID = 0 const IPFS_URL = '' const NFT_NAME = '' const NFT_DESCRIPTION = '' // optional const nft = { name: NFT_NAME, // the name of your NFT image: IPFS_URL, // asset URI, images will render on Opensea external_url: IPFS_URL, // Opensea will provide a link to view the source description: NFT_DESCRIPTION, // description of your NFT attributes: [], // NFT attributes displayed on Opensea } const mintTx = await mcs.mintAsset(SOURCE_FILE_UPLOAD_ID, nft) console.log(mintTx) } main() ``` The NFT smart contract can be found in the GitHub repository below: {% embed url="" %} ### Parameters * **sourceFileUploadId**: upload Id of the file * **nftObject**: object following Opensea Metadata Standards * **name**: name of your NFT (required) * **image**: IPFS URL of your file (required) * **description**: description of your NFT * **external\_url**: viewable link on Opensea UI * **attributes**: array of attribute objects you wish to show on Opensea ### Return Returns the response from the `/mint/info` API ``` { status: 'success', data: { id: , source_file_upload_id: , nft_tx_hash: <'0x...'>, mint_address: '0x1A1e5AC88C493e0608C84c60b7bb5f04D9cF50B3', token_id: '', create_at: