DAPI 地球资源保护方案
分散 API GRPC 定义文件和生成的客户端
目录
安装
确保您有最新的 节点JS 已安装.
从仓库
克隆还原器 :
git clone https://github.com/dashevo/dapi-grpc
安装 npm 包 :
npm install
国家预防机制
npm install @dashevo/dapi-grpc
使用量
节点用户可以通过在v0属性下要求它们来访问导出元素.
核心客户端
提供客户端执行核心请求.
const {
v0: {
CorePromiseClient,
},
} = require('@dashevo/dapi-grpc');
const client = new CorePromiseClient(url);
提供的方法允许通过通过特定请求参数执行请求(见下文实例). 所有方法共用相同的 API :
- 第一个参数期望一个请求类(如GetBrock Request,GetTransaction Request)的特定请求实例.
- 第二个参数是元数据对象的可选参数.
- 第三个参数是选项的可选参数.
以下是一个用例
const {
v0: {
CorePromiseClient,
GetBlockRequest,
GetBlockResponse,
},
} = require('@dashevo/dapi-grpc');
const client = new CorePromiseClient(url);
async function getBlockByHash(hash, options = {}) {
const getBlockRequest = new GetBlockRequest();
getBlockRequest.setHash(hash);
const response = await client.getBlock(
getBlockRequest,
{},
options,
);
const blockBinaryArray = response.getBlock();
return Buffer.from(blockBinaryArray);
}
可用方法:
- 获取状态
- 获取锁定
- 传输
- 获取交易
- 获得估计的交易费
- 订阅 ChanLocks 的 Block 标题
- 订阅 TRActions with proofs
对于流, 如订阅ToTransactions With Proofs和订阅ToBlock Headers With ChainLocks, a grpc- 网络流 将返回. 有关其使用情况的更多信息可以从其存储处读取.
平台客户端
提供客户端执行平台请求. 方法的API和用法与CorePromiseClient相似.
const {
v0: {
PlatformPromiseClient,
},
} = require('@dashevo/dapi-grpc');
const client = new PlatformPromiseClient(url);
可用方法:
- 过渡
- 获取身份
- 获取数据合同
- 获取文档
- 获取身份
- 等待状态转换
- 获取共识
- 设定协议版本
维护者
捐款
随便下潜吧! 打开一个问题 或者提交公关.
许可证
麻省理工学院 达什核心小组股份有限公司.
建设生成的客户端
从"平台"起,运行 yarn install,然后提供本地人
一次客户端生成器 :
python3 packages/dapi-grpc/scripts/setup-codegen.py --install
yarn workspace @dashevo/dapi-grpc build
安装需要 Python 3.12 或更新,CMake 和一个 C++ 编译器. 它会建立
校验和验证源输入您的用户缓存, 不包含sudo 或 Docker 。 链接
运行图像在 /opt/client-codegen设置
DAPI_GRPC_TOOLCHAIN 使用明确规定的装置; 缺失或
不匹配的安装失败, 而不是默默地选择不同的原型 .
codegen.json 将食谱和本地生成器版本标出。 客户端编译器
刻意与 Rust 建筑的原型分离 32.0: 现有客户端
输出使用原生起泡 3.18.1, gRPC 1.46.3, gRPC Java 1.4.2.1 和 Yrn-clock
ts-protoc-gen 0.15.0. 更新食谱、平台锁和跑道要求
和生成输出兼容性检查。 普通建筑从不
安装系统包或启动容器.
在替换所有语言之前先进行生成阶段 clients/插件失败
保留上一个输出。 Java,目标-C和Python 生成用于
国家防范机制的档案继续将他们排除在外
节点和网络客户端. 安装工具后运行生成回归 :
yarn workspace @dashevo/dapi-grpc exec python3 -m unittest discover -s tests/codegen -v