在这个教程中,我们将学习如何为DeFi协议Compound的智能合约创建一个可以通过HTTP访问的API开发接口,并学习如何使用Infura作为以太坊网络和应用之间的桥梁。
Compound是一个基于以太坊的数字资产借贷利率协议。Infura是以太坊和IPFS网络API提供商。下面是我们的Web API实现架构图:
用自己熟悉的语言学习 以太坊DApp开发 : Java | Php | Python | .Net / C# | Golang | Node.JS | Flutter / Dart
1、Compound协议的HTTP API设计
在创建访问以太坊智能合约的API之前,我们可以先实现一个可以处理客户端HTTP请求的web应用。
下面是API可能的访问端结点,这些API允许用户从Compound协议存入或赎回加密资产。你可以为Compound协议支持的以太坊ERC-20代币创建更多的访问端结点。
A1、钱包账户ETH余额API :返回钱包中的以太币数量。
GET /wallet-balance/eth/
A2、钱包账户cETH余额API :返回钱包中的cETH代币数量。
GET /wallet-balance/ceth/
A3、Compound协议余额API : 返回钱包已存入Compund协议的以太币数量。
GET /protocol-balance/eth/
A4、Compound协议存款API : 向Compound协议存入以太币,得到cETH代币。
GET /supply/eth/{amount}
URL参数:
- amount:要存入Compound协议的以太币数量
返回值:操作成功时返回状态码200
A5、Compound协议存款赎回API : 使用cETH代币赎回存入Compound协议的以太币。
GET /redeem/eth/{cTokenAmount}
URL参数:
- cTokenAmount:要赎回的cETH代币数量
返回值:操作成功时返回状态码200
2、Compound协议的HTTP API的Node.JS实现
利用Node.js和Express实现上述API很简单:
3、使用Infura节点初始化Web3.js
Node.js有一个非常稳定的Web3开发库即web3.js。web3.js不仅支持利用钱包私钥签名请求,它还提供了面向对象的类,这使得开发者可以编写干净整洁的代码来访问以太坊区块链。
把下面代码添加到前面实现的代码的开头部分。在Web3对象初始化时,我们传入Infura的API的URL,这样下面就可以调用以太坊的JSON RPC API开发接口了。我们使用一个已有的保存在环境变量中的以太坊钱包私钥来初始化账号。接下来使用Compound智能合约的地址和ABI来初始化合约对象。
4、Compound协议HTTP API的以太坊交互实现
在我们使用Infura的JSON RPC API访问以太坊区块链之前,让我们先简单回顾一下将要用到的调用类型:
Call - 这种类型的调用只读取区块链状态,它不会修改或写入区块链, 执行时也不需要gas手续费
Send - 这种调用将修改区块链,其执行需要使用以太币支付gas手续费, 具体手续费的数量取决于操作深度以及交易执行时的网络状况
下面每个操作都可以使用Infura的API进行调用。如果你使用的开发语言没有稳定的Web3库那就会麻烦一些。
钱包cETH余额API 实现代码如下,它采用Call类型的调用:
Compound协议存入API 使用Send类型的调用,它实际调用Compound合约的mint 方法向Compound协议存入以太币,同时gas手续费也是使用以太币支付的:
完整的代码可以从 这里 获得,下面是API调用的示例输出:
钱包里的以太币余额最后要少于开始时的余额,因为有些以太币被用来支付gas手续费了。我们存入Compound协议的以太币得到的利息收入还不足以支付整个过程消耗掉的gas成本,因为存入的时间太短了。