tron-protocol-node

Tron Node Protocol

This npm package contains the compiled to node.js tron protocol gRPC API code. The code was compiled from https://github.com/tronprotocol/protocol

Introduction

Tron protocol offers two ways to communicate with nodes : http and gRPC API. The gRPC API is specified with google protobuf, which is a mechanism for serializing structured data and an Interface Description Language. Google Protobuf code can be compiled to different languages - C++, Java, Node.js, etc. This package is a compiled to Node.js google protobuf code.

The exact steps to replicate the compilation process from protobuf code to node.js code for each file is as follows :

1. git clone https://github.com/tronprotocol/protocol.git && cd protocol/

• Download the latest version of the protocol

1. ./install-googleapis.sh

• Install google apis required for the compilation process

1. mkdir node-protocol/

• Create a folder which will contain the artifacts from the compilation

1. npm i -g grpc-tools

• Install grpc compilation tools

1. protoc --js_out=import_style=commonjs,binary:node-protocol/ --grpc_out=node-protocol/ --plugin=protoc-gen-grpc=which grpc_tools_node_protoc_plugin api/api.proto

• Run the compilation command for protocol/api/ files (artifacts are in node-protocol/api -> api_pb.js and api_grpc_pb.js)

1. protoc --js_out=import_style=commonjs,binary:node-protocol/ core/*

• Run the compilation command for protocol/core/ files (artifacts are in node-protocol/core)