Core Lightning项目gRPC接口开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00632/article/details/148756052

Core Lightning项目gRPC接口开发指南

lightning Core Lightning — Lightning Network implementation focusing on spec compliance and performance 项目地址: https://gitcode.com/gh_mirrors/li/lightning

概述

Core Lightning（CLN）作为一款高性能的闪电网络实现，从v0.11.0版本开始引入了一个重要的新特性——基于gRPC的远程接口。这个名为cln-grpc的插件为开发者提供了一种标准化、安全的方式与CLN节点进行交互。

gRPC接口的优势

与传统的JSON-RPC接口相比，gRPC接口具有以下显著优势：

网络访问能力：原生支持远程访问，不再局限于本地Unix域套接字
高效编码：使用Protocol Buffers二进制编码，传输效率更高
安全认证：内置mTLS（双向TLS）认证机制
自动生成：API直接从现有JSON-RPC接口生成，保持功能一致性
多语言支持：支持生成多种编程语言的客户端代码

快速入门

启用gRPC插件

启用gRPC接口非常简单，只需在启动lightningd时添加--grpc-port参数即可：

lightningd --grpc-port=50051

启动后，插件会自动生成所需的证书文件，包括CA证书、服务器证书和客户端证书。

证书文件说明

插件生成的证书文件包括：

ca.pem和ca-key.pem：证书颁发机构(CA)的证书和私钥
server.pem和server-key.pem：服务器身份证书和私钥
client.pem和client-key.pem：客户端示例证书和私钥

这些证书使用合理的默认值生成，开发者可以根据需要自定义生成。

开发实战：Python客户端

准备工作

首先需要安装必要的Python依赖：

pip install grpcio-tools

生成客户端代码

使用protobuf定义文件生成Python客户端代码：

python -m grpc_tools.protoc \
  -I path/to/cln-grpc/proto \
  path/to/cln-grpc/proto/node.proto \
  --python_out=. \
  --grpc_python_out=. \
  --experimental_allow_proto3_optional

此命令会生成两个关键文件：

node_pb2.py：协议缓冲区消息定义
node_pb2_grpc.py：gRPC服务存根

实现客户端连接

以下是完整的Python客户端示例代码：

from pathlib import Path
from node_pb2_grpc import NodeStub
import node_pb2
import grpc

# 证书路径配置
cert_path = Path("client.pem")
key_path = Path("client-key.pem")
ca_cert_path = Path("ca.pem")

# 创建凭证
creds = grpc.ssl_channel_credentials(
    root_certificates=ca_cert_path.read_bytes(),
    private_key=key_path.read_bytes(),
    certificate_chain=cert_path.read_bytes()
)

# 建立安全通道
channel = grpc.secure_channel(
    "localhost:50051",  # 替换为实际的gRPC端口
    creds,
    options=(('grpc.ssl_target_name_override', 'cln'),)
)

# 创建服务存根
stub = NodeStub(channel)

# 调用Getinfo方法
response = stub.Getinfo(node_pb2.GetinfoRequest())
print(response)

高级配置：自定义证书

生成服务器证书

如果需要使用自定义域名，可以按照以下步骤生成服务器证书：

生成私钥：

openssl genrsa -out server-key.pem 2048

创建证书签名请求(CSR)：

openssl req -key server-key.pem -new -out server.csr

使用CA签名生成证书：

openssl x509 -req -CA ca.pem -CAkey ca-key.pem \
  -in server.csr \
  -out server.pem \
  -days 365 -CAcreateserial

支持SANs(主题备用名称)

对于更复杂的场景（如Tor访问），可以创建包含SANs的证书：

创建配置文件cln-csr.conf：

[req]
default_bits = 2048
distinguished_name = req_distinguished_name
req_extensions = req_ext

[req_distinguished_name]
CN = "cln gRPC server"

[req_ext]
subjectAltName = @alt_names

[alt_names]
IP.1 = 127.0.0.1
DNS.1 = localhost
DNS.2 = cln
DNS.3 = your.custom.domain

生成CSR：

openssl req -new -key server-key.pem -out server.csr -config cln-csr.conf

生成证书：

openssl x509 -req -CA ca.pem -CAkey ca-key.pem \
  -in server.csr -out server.pem \
  -days 365 -CAcreateserial \
  -extensions req_ext -extfile cln-csr.conf