基于星云链的智能合约与Dapp（六）——通过RPC接口与星云链交互

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

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

API

每个星云节点实现了RPC服务器和HTTP服务器，提供给用户丰富的接口来与星云节点交互。

接口模块

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

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

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

提示：星云官方的testnet及mainnet的admin相关api不支持远程访问

配置文件

星云节点中的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
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Origin
Date: Mon, 09 Jul 2018 13:16:00 GMT
Content-Length: 261

{
    "result":{
        "chain_id":100,
        "tail":"8da4f9edcc7bbd49db89881257d9958a741fe2497ae052a9badca1977bb2b05d",
        "lib":"0000000000000000000000000000000000000000000000000000000000000000",
        "height":"3266",
        "protocol_version":"/neb/1.0.0",
        "synchronized":false,
        "version":"1.0.1"
    }
}

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

curl -i -H 'Content-Type: application/json' -X POST http://localhost:8685/v1/admin/account/unlock -d '{"address":"n1NrMKTYESZRCwPFDLFKiKREzZKaN1nhQvz", "passphrase": "passphrase"}'
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Origin
Date: Mon, 09 Jul 2018 13:18:08 GMT
Content-Length: 26

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

RPC

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

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

package main

import (
    "github.com/nebulasio/go-nebulas/rpc"
    //"google.golang.org/grpc"
    "log"
    "context"
    "fmt"
    "github.com/nebulasio/go-nebulas/rpc/pb"
)

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

    // API interface to access node status information

    //ac := rpcpb.NewAPIServiceClient(conn)
    ac := rpcpb.NewApiServiceClient(conn)
    resp, err := ac.GetNebState(context.Background(), &rpcpb.NonParamsRequest{})
    if err != nil {
        log.Println("GetNebState", "failed", err)
    } else {
        log.Println("GetNebState tail", resp)
    }
}

运行结果如下：

GetNebState tail chain_id:100 tail:"40cde02530ea90617837f99d36e7201a18da1fdfced695c3e057cacd90fcca9b" lib:"0000000000000000000000000000000000000000000000000000000000000000" height:3279 protocol_version:"/neb/1.0.0" version:"1.0.1"

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

import (
    "log"
    "github.com/nebulasio/go-nebulas/rpc/pb"
    "fmt"
    "github.com/nebulasio/go-nebulas/rpc"
    "golang.org/x/net/context"
)

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

    // Admin interface to access, lock account address
    admin := rpcpb.NewAdminServiceClient(conn)
    from := "n1NrMKTYESZRCwPFDLFKiKREzZKaN1nhQvz"

    msg, err := admin.LockAccount(context.Background(), &rpcpb.LockAccountRequest{Address: from})
    if err != nil {
        log.Println("LockAccount", from, "failed", err)
    } else {
        log.Println("LockAccount", from, "result", msg)
    }
}

运行结果如下：

LockAccount n1NrMKTYESZRCwPFDLFKiKREzZKaN1nhQvz result result:true

接口列表

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

API Module
Admin Module