利用Infura对接Filecoin区块链【教程】

蔚落 2022-08-29 05:49 168阅读 0赞

Infura以提供免费的以太坊Web3 API而闻名，随着Filecoin的流行，Infura也适时推出了Filecoin的 免费API，方便开发者无需搭建Filecoin节点就可以开发Filecoin应用。在这个教程中，我们将学习 如何利用Infura提供的Filecoin API来创建一个简单的Node.js程序来对接Filecoin区块链网络，例如 验证Filecoin地址并查询Filecoin地址余额等。

> 如果你的主力开发语言是PHP或Golang，那么可以使用以下开发包： [Filecoin.php][] | [Filecoin.go][]

## 1、Infura API ##

在访问Infura API之前，首先需要到Infura网站上注册。这是一个免费的API，只需注册电子邮件即可：

*  前往[infura.io][] 并登录。
 *  在侧栏中选择Filecoin，然后单击创建新项目。
 *  输入项目名称，例如：`Filecoin - Get Started`，然后单击创建。
 *  现在，你应该可以看到Project ID和Project Secret。记下这两个字段，我们稍后再使用。

结果看起来是这样：

![e9b43d913c0fc96ec355b471a9676040.png][]

接下来我们创建项目。

## 2、创建Filecoin对接项目 ##

出于简化考虑，让我们为项目创建一个新目录，并创建一个包含样板代码的文件：

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
</pre> </td> 
   <td> <pre>~$ mkdir ~/Code/filecoin-wallet-checker -p
~$ cd ~/Code/filecoin-wallet-checker
</pre> </td> 
  </tr> 
 </tbody> 
</table>

接下来在filecoin-wallet-checker目录下创建文件index.js并添加以下初始代码：

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
</pre> </td> 
   <td> <pre>let request = require('request')

// Call the Infura API and check that the address is valid.

request(options, (error, response, body) =&gt; {
  if (error) {
    console.error('Error: ', error)
  } else {
    console.log('Response: ', body)
  }
})
</pre> </td> 
  </tr> 
 </tbody> 
</table>

最后，别忘了将request包添加到该项目，因为在上面的代码中我们使用了它：

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
</pre> </td> 
   <td> <pre>~/filecoin-wallet-checker$ npm install request

&gt; ...
&gt; + request@2.88.2
&gt; added 47 packages from 58 contributors and audited 47 packages in 1.594s
&gt; ...
</pre> </td> 
  </tr> 
 </tbody> 
</table>

现在我们已经建立了一个项目，可以开始编写对接Filecoin区块链的JS程序了！

## 3、Filecoin对接JS代码编写 ##

我们已经建立了项目目录，并准备好了index.js文件。现在先创建一个基本的Filecoin API调用来充实程序。

作为回顾，这是我们的样板代码如下所示：

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
</pre> </td> 
   <td> <pre>let request = require('request')

// Call the Infura API and check that the address is valid.

request(options, (error, response, body) =&gt; {
  if (error) {
    console.error('Error: ', error)
  } else {
    console.log('Response: ', body)
  }
})
</pre> </td> 
  </tr> 
 </tbody> 
</table>

在注释下方创建一个名为`options`的对象，我们将利用这个对象声明request 请求的细节：

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
</pre> </td> 
   <td> <pre>// Call the Infura API and check that the address is valid.
let options = {}
``` 
    
在options对象中设置url、method和headers参数：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

// Call the Infura API and check that the address is valid. let options = \{ url: ‘https://filecoin.infura.io’, method: ‘post’, headers: \{ ‘content-type’: ‘application/json’ \} \}

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
</pre> </td> 
   <td> <pre>    
容易理解上面这些参数的含义，因此不再赘述。我们更感兴趣的两个参数是`body`和`auth`。

现在添加auth参数对象：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
</pre> </td> 
   <td> <pre>     
Infura API将使用auth参数的内容来验证请求。

将你的Infura项目ID和项目密钥添加到user和pass字段：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
</pre> </td> 
   <td> <pre>    
在user字段中输入Infura项目ID ，然后在pass字段中输入Infura项目密码。你可以转到
`infura.io/dashboard/filecoin`，选择具体项目并转到设置标签来找到这些信息。

我们需要添加到options对象中的最后一个参数是body。该对象用来声明API端点要使用的ID、JSON RPC版本
以及要调用的方法等。设置id为0和jsonrpc为2.0：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
</pre> </td> 
   <td> <pre>     
最后设置要调用的method为[Filecoin.ChainHead](http://cw.hubwiz.com/card/c/filecoin-lotus-rpc/1/2/12/)：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

// Call the Infura API and check that the address is valid. let options = \{ url: ‘https://filecoin.infura.io’, method: ‘post’, headers: \{ ‘content-type’: ‘application/json’ \}, auth: \{ user: ‘1nO7B…’, pass: ‘bda4a…’ \}, body: `{ "jsonrpc": "2.0", "id": 0, "method": "Filecoin.ChainHead" }` \}

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
</pre> </td> 
   <td> <pre> 
`Filecoin.ChainHead`方法返回Filecoin区块链的当前链头数据。虽然这不是我们要使用的最终方法，但它是
测试我们的js程序是否正常工作的好方法。

## 4、测试Filecoin对接程序的运行

我们的js程序已经实现了对接Filecoin区块链的基本功能，现在进行测试运行以确保其正常工作！

在项目目录中，使用node执行对接程序：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

node index.js

> Post successful: response: \{“jsonrpc”:”2.0”,”result”:\{“Cids”:\[\{“/“:”bafy2bzaceamdit67mnlyozufeaptmhmti6dv …
> 
> <table> 
>  <tbody> 
>   <tr> 
>    <td> <pre>1
> 2
> 3
> 4
> 5
> 6
> 7
> 8
> 9
> </pre> </td> 
>    <td> <pre>     
> 优秀！Infura API收到了我们的请求，并向我们发送了最新的链头信息。但是我们对链头数据并不感兴趣，
> 我们想获取有关地址的信息！
> 
> ## 5、验证Filecoin地址是否有效
> 
> 现在让我们如何利用Infura的Filecoin API来验证指定的字符串是否是有效的Filecoin地址。
> 
> 在options对象的body参数内，将method改为[Filecoin.WalletValidateAddress](http://cw.hubwiz.com/card/c/filecoin-lotus-rpc/1/13/12/)：
> </pre> </td> 
>   </tr> 
>  </tbody> 
> </table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
</pre> </td> 
   <td> <pre>    
如果我们现在运行程序，Infura API会返回错误，因为WalletValidateAddress方法需要至少一个字符串作为参数。

在body对象中添加一个名为params的数组：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
</pre> </td> 
   <td> <pre>    
在params数组内，添加要检查的地址：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
</pre> </td> 
   <td> <pre>    
本示例使用`f1ydrwynitbbfs5ckb7c3qna5cu25la2agmapkchi`作为要验证的字符串。

让我们重新运行js程序以查看得到的响应：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

node index.js

> Response: \{“jsonrpc”:”2.0”,”result”:”f1ydrwynitbbfs5ckb7c3qna5cu25la2agmapkchi”,”id”:0\}
> 
> <table> 
>  <tbody> 
>   <tr> 
>    <td> <pre>1
> 2
> </pre> </td> 
>    <td> <pre>    
> 棒极了！在result中出现地址意味着我们的地址有效。如果我们发送了一个无效的地址，我们将得到如下信息：
> </pre> </td> 
>   </tr> 
>  </tbody> 
> </table>

Response: \{“jsonrpc”:”2.0”,”id”:0,”error”:\{“code”:1,”message”:”invalid address payload”\}\}

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
</pre> </td> 
   <td> <pre>## 6、查看Filecoin地址余额

在前一个示例中，我们的JS程序可以检查给定的字符串是否是有效的Filecoin地址。现在让我们
实现检查Filecoin地址余额的功能。

我们要做的唯一的修改，就是将请求方法改成[WalletBalance](http://cw.hubwiz.com/card/c/filecoin-lotus-rpc/1/13/1/)：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
</pre> </td> 
   <td> <pre>    
Infura API将让我们知道余额：
</pre> </td> 
  </tr> 
 </tbody> 
</table>

node index.js

> ADDRESS: \{“jsonrpc”:”2.0”,”result”:”7182015146934547358774”,”id”:0\}
> 
> <table> 
>  <tbody> 
>   <tr> 
>    <td> <pre>1
> 2
> 3
> 4
> 5
> 6
> </pre> </td> 
>    <td> <pre>    
> Infura API返回结果中的余额单位为`attoFIL`。如果请求的地址没有余额，则Infura的响应将为空白。
> 
> ## 7、完整的Filecoin对接JS程序代码
> 
> 到目前为止，我们的对接Filecoin的js程序代码如下，你可以在此基础上继续完善：
> </pre> </td> 
>   </tr> 
>  </tbody> 
> </table>

let request = require(‘request’)

request(options, (error, response, body) => \{ if (error) \{ console.error(‘Error: ‘, error) \} else \{ console.log(‘Response: ‘, body) \} \}) `` ` ``

--------------------

原文链接：[Filecoin Get Started][]

[Filecoin.php]: http://sc.hubwiz.com/codebag/filecoin-php-lib/
[Filecoin.go]: http://sc.hubwiz.com/codebag/filecoin-go-lib/
[infura.io]: https://infura.io/
[e9b43d913c0fc96ec355b471a9676040.png]: /images/20220829/ab82e1f4959e4112889f928f5fee3a05.png
[Filecoin Get Started]: https://docs.filecoin.io/build/get-started/