vsuharnikov-waves-protobuf-serialization

About

Waves protobuf schemas repository

How to use

Java

Add dependency to your pom.xml

<dependency>
    <groupId>com.wavesplatform</groupId>
    <artifactId>protobuf-schemas</artifactId>
    <version>{version}</version>
</dependency>

ScalaPB

1. Add dependency to your build.sbt:

libraryDependencies += "com.wavesplatform" % "protobuf-schemas" % "{version}" % "protobuf-src" intransitive()

1. Configure ScalaPB to compile external schemas with:

inConfig(Compile)(Seq(
   PB.protoSources in Compile := Seq(PB.externalIncludePath.value),
   includeFilter in PB.generate := new SimpleFileFilter((f: File) => f.getName.endsWith(".proto") && f.getParent.endsWith("waves")),
   PB.targets += scalapb.gen(flatPackage = true) -> sourceManaged.value
 ))

1. If you use SNAPSHOT version, add this line

resolvers += Resolver.sonatypeRepo("snapshots")

See ScalaPB docs for more info.

TypeScript / JavaScript

Npm package: @waves/protobuf-serialization.

It contains generated JavaScript classes, TypeScript definitions as well as raw proto files.

You could also make your own custom build from raw .proto files, for example, if you want to use only a subset of proto schemas or gRPC services. They can be found in @waves/protobuf-serialization/proto directory. long.js is used for 64-bit integers: int64, uint64, etc.

We bundle two versions of generated files:

• The first is generated by pbjs and used only for serialization
• The second is generated by proto-loader-gen-types and used with a conjunction of @grpc/grpc-js

pbjs

Example:

1. npm install --save @waves/protobuf-serialization
2. Default build usage

import { waves } from '@waves/protobuf-serialization';

const block = new waves.Block();
block.header = // ... set necessary fields

const buffer = waves.Block.encode(block);

const blockDecoded = waves.Block.decode(buffer);

proto-loader-gen-types

We use:

• @grpc/proto-loader to load proto-files and the embedded app proto-loader-gen-types to generate definitions;
• @grpc/grpc-js to request the data from Waves Node gRPC API;
• long.js to represent 64-bit integers: int64, uint64, etc.

Examples

1. npm install --save @wavesplatform/protobuf-schemas bs58 bs58 here for encoding and decoding addresses and ids.

2. A default usage with TypeScript looks like:

   import * as w from '@waves/protobuf-serialization/grpc'
   import b58 from 'bs58'
   
   const grpcChannel = w.grpc.mkDefaultChannel('grpc.wavesnodes.com:6870')
   
   // Node gRPC API - a streaming example
   const transactionsApi = w.api.waves.node.grpc.mkTransactionsApi(grpcChannel)
   const txnId = '287XcMXPDY7pnw2tECbV86TZetPi2x9JBg9BVUsGaSJx';
   transactionsApi
       .getTransactions({transactionIds: [b58.decode(txnId)]}) // see TransactionsRequest
       .on("data", (item: w.api.waves.node.grpc.TransactionResponse) => console.log(`[getTransactions] The transaction '${txnId}' was on height of ${item.height}`))
       .on("end", () => console.log("[getTransactions] Stream ended"))
       .on("error", (e: Error) => console.error("[getTransactions] Failed", e))
   
   // Node gRPC API - an one-shot example
   const accountsApi = w.api.waves.node.grpc.mkAccountsApi(grpcChannel)
   const alias = 'likli'
   accountsApi.resolveAlias(
       {value: alias}, // Accepts google.protobuf.StringValue, that has "value" field
       (error, response) => {
           if (error === null) {
               const addressBytes = response?.value || new Buffer(0);
               console.log(`[resolveAlias] The address of '${alias}' is ${b58.encode(addressBytes)}`)
           } else console.error(`[resolveAlias] Can't determine address of '${alias}'`, error)
       }
   )
   
   // Blokchain updates gRPC API example
   // Note, we have to do another connection
   const blockchainUpdatesChannel = w.grpc.mkDefaultChannel('grpc.wavesnodes.com:6881') // 6881 instead of 6870
     
   const blockchainUpdatesApi = w.api.waves.events.grpc.mkBlockchainUpdatesApi(blockchainUpdatesChannel)
   blockchainUpdatesApi.getBlockUpdate(
       {height: 1},
       (error, response) => {
           if (error === null) {
               const txnIds = (response?.update?.append?.transactionIds || []).map(x => b58.encode(x));
               console.log(`[getBlockUpdate] Transactions of block 1: ${txnIds.join(", ")}`)
           } else console.error(`[getBlockUpdate] Can't get transactions of block 1`, error)
       }
   )
   

   With JavaScript looks similar:

   const w = require('@waves/protobuf-serialization/grpc');
   const b58 = require('bs58');
   
   const channel = w.grpc.mkDefaultChannel('grpc.wavesnodes.com:6870')
   
   const transactionsApi = w.api.waves.node.grpc.mkTransactionsApi(channel)
   const txnId = '287XcMXPDY7pnw2tECbV86TZetPi2x9JBg9BVUsGaSJx';
   transactionsApi
       .getTransactions({transactionIds: [b58.decode(txnId)]})
       .on("data", (item) => console.log(`[getTransactions] The transaction '${txnId}' was on height of ${item.height}`))
       .on("end", () => console.log("[getTransactions] Stream ended"))
       .on("error", (e) => console.error("[getTransactions] Failed", e))
   

Types and API clients correlates with a structure of proto-files. For example:

• waves/node/grpc/transactions_api.proto relates to waves.node.grpc:

  package waves.node.grpc;
  

• It has the TransactionResponse message:

  // waves/node/grpc/transactions_api.proto
  message TransactionResponse {
  

• So we have waves.node.grpc.TransactionResponse;
• We used w.api.waves.node.grpc.TransactionResponse in the example.

If you want to create a client of API that isn't listed in the example, you need:

1. Find it among proto-files
2. Write w.api.{here.is.a.namespace.of.your.api}mk{Api name}
3. Then look at a method you are interested in: a. If you see stream in the response like:

   rpc GetTransactions (TransactionsRequest) returns (stream TransactionResponse)
   

   Then you need to register an event handler for "data" event (see the "Streaming" example) b. Otherwise, you need to provide only a callback (see the "One-shot" example)

C#

1. Add App.config, packages.config to your C# solution
2. Add

  <ItemGroup>
    <Protobuf Include="proto\waves\*.proto" OutputDir="waves\%(RelativePath)" GrpcServices="None" />
    <Protobuf Include="proto\waves\events\*.proto" OutputDir="waves\events\%(RelativePath)" GrpcServices="None" />
    <Protobuf Include="proto\waves\node\grpc\*.proto" OutputDir="waves\node\grpc\%(RelativePath)" GrpcServices="Both" />
  </ItemGroup>

to your .csproj file. After this just build your project.

or as alternative you can use util protoc, for example: protoc --csharp_out=RelativePath --proto_path=RelativePathToProtoDir RelativePathToProtoFile

Also there is a NuGet package WavesPlatform.ProtobufSchema with this project.

Rust

Add dependency to your Cargo.toml

[dependencies]
waves-protobuf-schemas = { git = "https://github.com/wavesplatform/protobuf-schemas" }

How to generate sources locally

Java

Use mvn package to create JAR artifacts:

1. protobuf-schemas-{version}-protobuf-src.jar - raw .proto files
2. protobuf-schemas-{version}.jar - protoc-generated Java classes

Python

Generating python sources requires python 3 or later. Run the following commands from the root of this repository to generate python sources in /target/python:

python3 -m venv .venv
. .venv/bin/activate
pip install grpcio grpcio-tools base58
git clone https://github.com/wavesplatform/protobuf-schemas.git
python -m grpc_tools.protoc --proto_path=./protobuf-schemas/proto --python_out=. --python_grpc_out=. `find ./protobuf-schemas/proto -type f`

Tweak --python_out and --python_grpc_out parameters to generate files elsewhere. Target path should likely be absolute. Now you can use generated classes:

import grpc
from waves.events.grpc.blockchain_updates_pb2_grpc import BlockchainUpdatesApiStub
from waves.events.grpc.blockchain_updates_pb2 import SubscribeRequest
from base58 import b58encode, b58decode

def asset_id(asset_id_bytes):
    return len(asset_id_bytes) > 0 and b58encode(asset_id_bytes) or 'WAVES'

def print_update(update):
    update_id = b58encode(update.id)
    print(f'block {update_id}:')
    for (tx_id, tx_state_update) in zip(update.append.transaction_ids, update.append.transaction_state_updates):
        print(f'  tx {b58encode(tx_id)}:')
        for balance in tx_state_update.balances:
            print(f'    {b58encode(balance.address)}: {balance.amount_before} -> {balance.amount_after.amount} [{asset_id(balance.amount_after.asset_id)}]')

with grpc.insecure_channel('grpc.wavesnodes.com:6881') as channel:
    for block in BlockchainUpdatesApiStub(channel).Subscribe(SubscribeRequest(from_height=3135450, to_height=3135470)):
        print_update(block.update)