黎跃春区块链博客


黎跃春,江湖人称春哥,孔壹学院、 链乎创始人,区块链职业教育布道师,通信和信息技术培养工程区块链高级授课专家。


链乎问答社区
链乎公众号

Nebulas 101 - 05 通过RPC接口与星云链交互

整理:黎跃春

博客:http://liyuechun.org

官网:http://kongyixueyuan.com

进微信群请添加微信:liyc1215

星云链节点启动后可以通过RPC远程控制访问。星云链提供了一系列API来获取节点的信息,账号余额,发送交易和部署调用智能合约。

星云链的远程访问是GRPC实现的,通过代理(GRPC Gateway)也可以通过HTTP访问。HTTP访问是RESTful实现的接口,参数与GRPC的调用接口参数相同。

API

我们已经在每个星云节点中实现了RPC服务器和HTTP服务器,提供给用户丰富的接口来与星云节点交互。

接口模块

现在,星云节点的所有的接口被分为两个模块:API和Admin。

  • API:提供所有和用户私钥无关的接口
  • Admin:提供所有和用户私钥相关的接口

建议星云节点对外提供服务时,可以把API接口开放给公众,而将Admin接口开放给授权用户。

配置文件

星云节点中的RPC服务器和HTTP服务器都可以在节点的配置中配置对应的端口,以及开放的模块。

# 用户与节点交互的服务配置,同一台机器启动多个时注意修改端口防止占用
rpc {
    # gRPC API服务端口
    rpc_listen: ["127.0.0.1:8684"]
    # HTTP API服务端口
    http_listen: ["127.0.0.1:8685"]
    # 开放可对外提供http服务的模块
    http_module: ["api","admin"]
}

使用实例

HTTP

通过HTTP接口和星云节点交互。

GetNebState

我们可以调用API模块中的GetNebState接口来获取节点当前状态,包括所在链ID,最新区块,协议版本等等。

> curl -i -H Accept:application/json -X GET http://localhost:8685/v1/user/nebstate

{"result":{"chain_id":100,"tail":"0aa1cceb7801b110fdd5217ba0a4356780c940133924d1c1a4eb60336934dab1","lib":"0000000000000000000000000000000000000000000000000000000000000000","height":"479","protocol_version":"/neb/1.0.0","synchronized":false,"version":"0.7.0"}}
UnlockAccount

我们可以调用Admin模块中的UnlockAccount接口来在节点内存中解锁一个账户。所有解锁的账户都可以被用来直接发送交易,而不需要密码。

> curl -i -H 'Content-Type: application/json' -X POST http://localhost:8685/v1/admin/account/unlock -d '{"address":"n1NrMKTYESZRCwPFDLFKiKREzZKaN1nhQvz", "passphrase": "passphrase"}'

{"result":{"result":true}}

RPC

RPC服务器基于GRPC实现. GRPC的基于Protocol Buffers来做序列化,你可以在星云RPC Protobuf文件夹下找到所有的RPC相关的Proto文件定义。

这里有一些使用golang调用RPC接口的实例。

GetNebState

我们可以使用API模块中的GetNebState接口来获取节点当前状态。

import(
    "github.com/nebulasio/go-nebulas/rpc"
    "github.com/nebulasio/go-nebulas/rpc/pb"
)

// GRPC server connection address configuration
addr := fmt.Sprintf("127.0.0.1:%d",uint32(8684))
conn, err := grpc.Dial(addr, grpc.WithInsecure())
if err != nil {
    log.Warn("rpc.Dial() failed:", err)
}
defer conn.Close()

// API interface to access node status information
api := rpcpb.NewAPIServiceClient(conn)
resp, err := ac.GetNebState(context.Background(), & rpcpb.GetNebStateRequest {})
if err != nil {
    log.Println("GetNebState", "failed", err)
} else {
    log.Println("GetNebState tail", resp)
}
LockAccount

我们已经在之前使用HTTP接口把账户n1NrMKTYESZRCwPFDLFKiKREzZKaN1nhQvz解锁了。 我们可以调用Admin模块中的LockAccount再次锁定它。

import(
    "github.com/nebulasio/go-nebulas/rpc"
    "github.com/nebulasio/go-nebulas/rpc/pb"
)

// GRPC server connection address configuration
addr := fmt.Sprintf("127.0.0.1:%d",uint32(8684))
conn, err := grpc.Dial(addr, grpc.WithInsecure())
if err != nil {
    log.Warn("rpc.Dial() failed:", err)
}
defer conn.Close()

// Admin interface to access, lock account address
admin := rpcpb.NewAdminServiceClient(conn)
from := "n1NrMKTYESZRCwPFDLFKiKREzZKaN1nhQvz"
resp, err = management.LockAccount(context.Background(), & rpcpb.LockAccountRequest {Address: from})
if err != nil {
    log.Println("LockAccount", from, "failed", err)
} else {
    log.Println("LockAccount", from, "result", resp)
}

接口列表

更多的接口列表请参考官方文档。

完成

恭喜你成功走完了整个教程! 欢迎阅读下列指南来加入官方的测试网和主网,探索更加广阔的区块链世界。

Join to Testnet Join to Mainnet

版权声明:博客中的文章版权归博主所有,未经授权,禁止转载,转载请注明出处,合作请联系:liyc1215(微信)

打赏一个呗

取消

感谢您的支持,我会继续努力的!

扫码支持
扫码支持
扫码打赏,你说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦